Input and Event Modifiers

Supply actions for a view to perform in response to user input and system events. アクションをビューに提供して、ユーザ入力とシステムイベントに応答して実行します。

Overview 概要

Use input and event modifiers to configure and provide handlers for a wide variety of user inputs or system events. For example, you can detect and control focus, respond to life cycle events like view appearance and disappearance, manage keyboard shortcuts, and much more.

Topics 話題

Interactivity

func disabled(Bool) -> some View
Adds a condition that controls whether users can interact with this view. ある条件を加えます、それはユーザがこのビューと相互作用できるかどうかを制御します。
func handlesExternalEvents(preferring: Set<String>, allowing: Set<String>) -> some View
Specifies a modifier indicating the Scene this View is in can handle matching incoming External Events. このViewが中に入っているSceneは合致しているやってくるExternal Eventそれらを取り扱い可能であると指し示しているある修飾子を指定します。

Swipe Actions

func swipeActions<T>(edge: HorizontalEdge, allowsFullSwipe: Bool, content: () -> T) -> some View
Adds custom swipe actions to a row in a list.

Refresh Controls

func refreshable(action: () async -> Void) -> some View
Marks this view as refreshable.

Taps and Gestures

func onTapGesture(count: Int, perform: () -> Void) -> some View
Adds an action to perform when this view recognizes a tap gesture. このビューがタップジェスチャを認識する時に実行するアクションを加えます。
func onLongPressGesture(minimumDuration: Double, maximumDistance: CGFloat, perform: () -> Void, onPressingChanged: ((Bool) -> Void)?) -> some View
Adds an action to perform when this view recognizes a long press gesture. このビューが長押しジェスチャを認識する時に実行するアクションを加えます。
func onLongPressGesture(minimumDuration: Double, perform: () -> Void, onPressingChanged: ((Bool) -> Void)?) -> some View
Adds an action to perform when this view recognizes a long press gesture. このビューが長押しジェスチャを認識する時に実行するアクションを加えます。
func onLongPressGesture(minimumDuration: Double, pressing: ((Bool) -> Void)?, perform: () -> Void) -> some View
Adds an action to perform when this view recognizes a long press gesture. このビューが長押しジェスチャを認識する時に実行するアクションを加えます。
Deprecated 非推奨
func gesture<T>(T, including: GestureMask) -> some View
Attaches a gesture to the view with a lower precedence than gestures defined by the view. ジェスチャをビューに添付します、ビューによって定義されるジェスチャより低い優先度で。
func highPriorityGesture<T>(T, including: GestureMask) -> some View
Attaches a gesture to the view with a higher precedence than gestures defined by the view. ジェスチャをビューに添付します、ビューによって定義されるジェスチャより高い優先度で。
func simultaneousGesture<T>(T, including: GestureMask) -> some View
Attaches a gesture to the view to process simultaneously with gestures defined by the view. ジェスチャをビューに添付します、ビューによって定義されるジェスチャと同期的に処理することになります。

Keyboard Shortcuts

func keyboardShortcut(KeyboardShortcut) -> some View
Assigns a keyboard shortcut to the modified control.
func keyboardShortcut(KeyboardShortcut?) -> some View
Assigns an optional keyboard shortcut to the modified control.
func keyboardShortcut(KeyEquivalent, modifiers: EventModifiers) -> some View
Defines a keyboard shortcut and assigns it to the modified control.
func keyboardShortcut(KeyEquivalent, modifiers: EventModifiers, localization: KeyboardShortcut.Localization) -> some View
Defines a keyboard shortcut and assigns it to the modified control.

Hover

func onHover(perform: (Bool) -> Void) -> some View
Adds an action to perform when the user moves the pointer over or away from the view’s frame. ユーザがポインタをビューのもつフレームに重ねるまたは遠ざける時に実行するアクションを加えます。
func hoverEffect(HoverEffect) -> some View
Applies a pointer hover effect to the view. あるポインタホバー効果をビューに適用します。

Focus

func focused<Value>(FocusState<Value>.Binding, equals: Value) -> some View
Modifies this view by binding its focus state to the given state value.
func focused(FocusState<Bool>.Binding) -> some View
Modifies this view by binding its focus state to the given Boolean state value.
func focusedValue<Value>(WritableKeyPath<FocusedValues, Value?>, Value) -> some View
Modifies this view by injecting a value that you provide for use by other views whose state depends on the focused view hierarchy. このビューを修正します、フォーカスされたビュー階層にそれの状態が依存する他のビューで使うためにあなたが提供するある値を注入することによって。
func focusedSceneValue<T>(WritableKeyPath<FocusedValues, T?>, T) -> some View
Modifies this view by injecting a value that you provide for use by other views whose state depends on the focused scene.
func prefersDefaultFocus(Bool, in: Namespace.ID) -> some View
Indicates that the view should receive focus by default for a given namespace.
func focusScope(Namespace.ID) -> some View
Creates a focus scope that SwiftUI uses to limit default focus preferences.
func focusSection() -> some View
Indicates that the view’s frame and cohort of focusable descendants should be used to guide focus movement.
func focusable(Bool) -> some View
Specifies if the view is focusable.

Copy and Paste

func onCopyCommand(perform: (() -> [NSItemProvider])?) -> some View
Adds an action to perform in response to the system’s Copy command. システムのもつ「コピー」コマンドに答えて実行するアクションを加えます。
func onCutCommand(perform: (() -> [NSItemProvider])?) -> some View
Adds an action to perform in response to the system’s Cut command. システムのもつ「カット」コマンドに答えて実行するアクションを加えます。
func onPasteCommand(of: [UTType], perform: ([NSItemProvider]) -> Void) -> some View
Adds an action to perform in response to the system’s Paste command. システムのもつ「ペースト」コマンドに答えて実行するアクションを加えます。
func onPasteCommand<Payload>(of: [UTType], validator: ([NSItemProvider]) -> Payload?, perform: (Payload) -> Void) -> some View
Adds an action to perform in response to the system’s Paste command with items that you validate. あなたが妥当と認める項目をもつシステム「ペースト」コマンドに答えて実行するあるアクションを加えます。

Drag and Drop

func onDrag<V>(() -> NSItemProvider, preview: () -> V) -> some View
Activates this view as the source of a drag and drop operation. このビューをドラッグアンドドロップ操作のソースとして活動させます。
func onDrag(() -> NSItemProvider) -> some View
Activates this view as the source of a drag and drop operation. このビューをドラッグアンドドロップ操作のソースとして活動させます。
func itemProvider(Optional<() -> NSItemProvider?>) -> some View
Provides a closure that vends the drag representation to be used for a particular data element. あるクロージャを提供します、それはドラッグ表現を製造販売して、特定のデータ要素に対して使われるようにします。
func onDrop(of: [UTType], isTargeted: Binding<Bool>?, perform: ([NSItemProvider]) -> Bool) -> some View
Defines the destination of a drag-and-drop operation that handles the dropped content with a closure that you specify. あるドラッグアンドドロップ操作の行き先を定義します、それはドロップされた内容をあなた指定のクロージャで取り扱うものです。
func onDrop(of: [UTType], isTargeted: Binding<Bool>?, perform: ([NSItemProvider], CGPoint) -> Bool) -> some View
Defines the destination of a drag and drop operation that handles the dropped content with a closure that you specify. あるドラッグアンドドロップ操作の行き先を定義します、それはドロップされた内容をあなた指定のクロージャで取り扱うものです。
func onDrop(of: [UTType], delegate: DropDelegate) -> some View
Defines the destination of a drag and drop operation using behavior controlled by the delegate that you provide. ドラッグアンドドロップ操作の行き先を定義します、あなたが提供する委任先によって制御された挙動を使って。

Submission

func onSubmit(of: SubmitTriggers, (() -> Void)) -> some View
Adds an action to perform when the user submits a value to this view.
func submitScope(Bool) -> some View
Prevents submission triggers originating from this view to invoke a submission action configured by a submission modifier higher up in the view hierarchy.
func submitLabel(SubmitLabel) -> some View
Sets the submit label for this view.

Movement

func onMoveCommand(perform: ((MoveCommandDirection) -> Void)?) -> some View
Adds an action to perform in response to a move command, like when the user presses an arrow key on a Mac keyboard, or taps the edge of the Siri Remote when controlling an Apple TV. ユーザが矢印キーをMacキーボード上で押す時のような、またはApple TVを制御している時にSir Remoteの縁をタップするような、移動コマンドに答えて実行するアクションを加えます。
func moveDisabled(Bool) -> some View
Adds a condition for whether the view’s view hierarchy is movable. ビューのもつビュー階層が移動可能であるかどうかに対するある条件を加えます。

Deletion

func onDeleteCommand(perform: (() -> Void)?) -> some View
Adds an action to perform in response to the system’s Delete command, or pressing either the ⌫ (backspace) or ⌦ (forward delete) keys while the view has focus.
func deleteDisabled(Bool) -> some View
Adds a condition for whether the view’s view hierarchy is deletable. ビューのもつビュー階層が削除可能であるかどうかに対するある条件を加えます。

Commands

func pageCommand<V>(value: Binding<V>, in: ClosedRange<V>, step: V) -> some View
Steps a value through a range in response to page up or page down commands.
func onExitCommand(perform: (() -> Void)?) -> some View
Sets up an action that triggers in response to receiving the exit command while the view has focus. ビューがフォーカスを持つ間に退出命令を受け取ることに答えて引き起こされるアクションを準備します。
func onPlayPauseCommand(perform: (() -> Void)?) -> some View
Adds an action to perform in response to the system’s Play/Pause command. システムのもつ「再生／一時停止」コマンドに答えて実行するアクションを加えます。
func onCommand(Selector, perform: (() -> Void)?) -> some View
Adds an action to perform in response to the given selector. 与えられたセレクタに答えて実行するあるアクションを加えます。

Digital Crown Rotation

func digitalCrownRotation<V>(Binding<V>) -> some View
Tracks Digital Crown rotations by updating the specified binding. 「デジタルクラウン」の回転をこの指定されたバインディングを更新することによって追跡します。
func digitalCrownRotation<V>(Binding<V>, from: V, through: V, by: V.Stride?, sensitivity: DigitalCrownRotationalSensitivity, isContinuous: Bool, isHapticFeedbackEnabled: Bool) -> some View
Tracks Digital Crown rotations by updating the specified binding. 「デジタルクラウン」の回転をこの指定されたバインディングを更新することによって追跡します。

User Activities

Restoring Your App’s State with SwiftUI
Provide app continuity for users by preserving their current activities.
func userActivity<P>(String, element: P?, (P, NSUserActivity) -> ()) -> some View
Advertises a user activity type. あるユーザアクティビティ型を広告します。
func userActivity(String, isActive: Bool, (NSUserActivity) -> ()) -> some View
Advertises a user activity type. あるユーザアクティビティ型を広告します。
func onContinueUserActivity(String, perform: (NSUserActivity) -> ()) -> some View
Registers a handler to invoke when the view receives the specified activity type for the scene or window the view is in. あるハンドラを登録して、ビューがこの指定されたアクティビティ型を、その中にビューが入っているシーンまたはウインドウに対して受け取る時に発動します。

View Life Cycle

func onAppear(perform: (() -> Void)?) -> some View
Adds an action to perform when this view appears. あるアクションを加えて、このビューが現れる時に実行します。
func onDisappear(perform: (() -> Void)?) -> some View
Adds an action to perform when this view disappears. あるアクションを加えて、このビューが姿を消す時に実行します。
func onChange<V>(of: V, perform: (V) -> Void) -> some View
Adds a modifier for this view that fires an action when a specific value changes. ある修飾子をこのビューに対して加えます、それはあるアクションをある特定の値が変化する時に開始します。
func task(priority: TaskPriority, () async -> Void) -> some View
Adds an asynchronous task to perform when this view appears.
func task<T>(id: T, priority: TaskPriority, () async -> Void) -> some View
Adds a task to perform when this view appears or when a specified value changes.

URLs

func onOpenURL(perform: (URL) -> ()) -> some View
Registers a handler to invoke when the view receives a url for the scene or window the view is in. あるハンドラを登録して、ビューがURLを、その中にビューが入っているシーンまたはウインドウに対して受け取る時に発動します。
func widgetURL(URL?) -> some View
Sets the URL to open in the containing app when the user clicks the widget.

Publisher Events

func onReceive<P>(P, perform: (P.Output) -> Void) -> some View
Adds an action to perform when this view detects data emitted by the given publisher. 与えられたパブリッシャーによって発布されたデータをこのビューが検出する時に実行するアクションを加えます。

Hit Testing

func allowsHitTesting(Bool) -> some View
Configures whether this view participates in hit test operations. このビューがヒットテスト演算に参加するかどうかを構成設定します。

Content Shape

func contentShape<S>(S, eoFill: Bool) -> some View
Defines the content shape for hit testing. ヒットテストするためのコンテンツシェープ（内容形状）を定義します。
func contentShape<S>(ContentShapeKinds, S, eoFill: Bool) -> some View
Sets the content shape for this view.

Import and Export

func exportsItemProviders([UTType], onExport: () -> [NSItemProvider]) -> some View
Exports a read-only item provider for consumption by shortcuts, quick actions, and services.
func exportsItemProviders([UTType], onExport: () -> [NSItemProvider], onEdit: ([NSItemProvider]) -> Bool) -> some View
Exports a read-write item provider for consumption by shortcuts, quick actions, and services.
func importsItemProviders([UTType], onImport: ([NSItemProvider]) -> Bool) -> some View
Enables importing item providers from services, such as Continuity Camera on macOS.

See Also 参照

Providing Interactivity 相互作用性を提供する

Presentation Modifiers
Define additional views for the view to present under specified conditions. 追加のビューをビューに対して定義して、指定された条件の下で提示します。
State Modifiers
Access storage and provide child views with configuration data.