accessibilityDragPoint

The point an assistive technology should use to begin a drag interaction.

View ModifieriOS 16.0+macOS 13.0+

Overloads

2 ways to call compose().accessibilityDragPoint(). Each is one SwiftUI overload, picked by the arguments you pass.

React
compose().accessibilityDragPoint(
  point: SwiftUI.UnitPoint,
  options: {
    description: string;
  }
)
Swift
@export(implementation) nonisolated func accessibilityDragPoint(
    _ point: UnitPoint,
    description: LocalizedStringResource
) -> ModifiedContent<Self, AccessibilityAttachmentModifier>
3 more Swift overloads share this form
Swift
nonisolated func accessibilityDragPoint(
    _ point: UnitPoint,
    description: LocalizedStringKey
) -> ModifiedContent<Self, AccessibilityAttachmentModifier>
Swift
nonisolated func accessibilityDragPoint(
    _ point: UnitPoint,
    description: Text
) -> ModifiedContent<Self, AccessibilityAttachmentModifier>
Swift
nonisolated func accessibilityDragPoint<S>(
    _ point: UnitPoint,
    description: S
) -> ModifiedContent<Self, AccessibilityAttachmentModifier>
where S : StringProtocol

Parameters

Discussion

Use this modifier when you need to provide a description to users when prompted begin a drag interaction.

struct FileView: View {
    var filename: String

    var body: some View {
        FileIcon(filename: filename)
            .accessibilityDragPoint(.center, description: "Move \(filename)")
    }
}

By default, if an accessible view or its subtree has drag and/or drop interactions, they will be automatically exposed by assistive technologies. However, if there is more than one such interaction, each drag or drop should have a description to disambiguate it and give a good user experience.

See also

More in Accessibility.