View ModifieriOS 13.0+macOS 10.15+tvOS 13.0+watchOS 6.0+
Overloads
3 ways to call compose().gesture(). Each is one SwiftUI overload, picked by the arguments you pass.
compose().gesture(
gesture: SwiftUI.Gesture,
options?: {
including?: SwiftUI.GestureMask;
}
)nonisolated func gesture<T>(
_ gesture: T,
including mask: GestureMask = .all
) -> some View
where T : GestureParameters
gesture*SwiftUI.GestureA gesture to attach to the view.
options.includingSwiftUI.GestureMask
Discussion
Use this method when you need to attach a gesture to a view. The
example below defines a custom gesture that prints a message to the
console and attaches it to the view's VStack. Inside the VStack
a red heart Image defines its own TapGesture
handler that also prints a message to the console, and blue rectangle
with no custom gesture handlers. Tapping or clicking the image
prints a message to the console from the tap gesture handler on the
image, while tapping or clicking the rectangle inside the VStack
prints a message in the console from the enclosing vertical stack
gesture handler.
struct GestureExample: View {
@State private var message = "Message"
let newGesture = TapGesture().onEnded {
print("Tap on VStack.")
}
var body: some View {
VStack(spacing:25) {
Image(systemName: "heart.fill")
.resizable()
.frame(width: 75, height: 75)
.padding()
.foregroundColor(.red)
.onTapGesture {
print("Tap on image.")
}
Rectangle()
.fill(Color.blue)
}
.gesture(newGesture)
.frame(width: 200, height: 200)
.border(Color.purple)
}
}See also
More in Gestures and input.
- defaultHoverEffectSets the default hover effect to use for views within this view.
- defersSystemGesturesSets the screen edge from which you want your gesture to take precedence over the system gesture.
- dragConfigurationConfigures a drag session.
- dragContainerA container with draggable views. The drag payload is identifiable. To form the payload, use the identifier of the dragged view inside the container.
- dragContainerSelectionProvides multiple item selection support for drag containers.
- handGestureShortcutAssigns a hand gesture shortcut to the modified control.
- highPriorityGestureAttaches a gesture to the view with a higher precedence than gestures defined by the view.
- hoverEffectApplies a hover effect to this view.
- hoverEffectDisabledAdds a condition that controls whether this view can display hover effects.
- presentationDragIndicatorSets the visibility of the drag indicator on top of a sheet.
- simultaneousGestureAttaches a gesture to the view to process simultaneously with gestures defined by the view.