accessibilityLabeledPair
Pairs an accessibility element representing a label with the element for the matching content.
View ModifieriOS 14.0+macOS 11.0+tvOS 14.0+watchOS 7.0+accessibilityLabeledPair(role:id:in:) in SwiftUI
Declaration
compose().accessibilityLabeledPair<ID>({
role: SwiftUI.AccessibilityLabeledPairRole,
id: ID,
in: string,
})nonisolated func accessibilityLabeledPair<ID>(
role: AccessibilityLabeledPairRole,
id: ID,
in namespace: Namespace.ID
) -> some View
where ID : HashableParameters
options.role*SwiftUI.AccessibilityLabeledPairRoleDetermines whether this element should be used as the label in the pair, or the content in the pair.
options.id*IDThe identifier for the label / content pair. Elements with matching identifiers within the same namespace will be paired together.
options.in*string
Discussion
Use accessibilityLabeledPair with a role of AccessibilityLabeledPairRole.label
to identify the label, and a role of AccessibilityLabeledPairRole.content
to identify the content.
This improves the behavior of accessibility features such as VoiceOver
when navigating such elements, allowing users to better understand the
relationship between them.
See also
More in Accessibility.
- accessibilityActionAdds an accessibility action to the view. Actions allow assistive technologies, such as the VoiceOver, to interact with the view by invoking the action.
- accessibilityActionsAdds multiple accessibility actions to the view.
- accessibilityActivationPointThe activation point for an element is the location assistive technologies use to initiate gestures.
- accessibilityAddTraitsAdds the given traits to the view.
- accessibilityAdjustableActionAdds an accessibility adjustable action to the view. Actions allow assistive technologies, such as the VoiceOver, to interact with the view by invoking the action.
- accessibilityChildrenReplaces the existing accessibility element's children with one or more new synthetic accessibility elements.
- accessibilityCustomContentAdd additional accessibility information to the view.
- accessibilityDefaultFocusDefines a region in which default accessibility focus is evaluated by assigning a value to a given accessibility focus state binding.
- accessibilityDirectTouchExplicitly set whether this accessibility element is a direct touch area. Direct touch areas passthrough touch events to the app rather than being handled through an assistive technology, such as VoiceOver. The modifier accepts an optional AccessibilityDirectTouchOptions option set to customize the functionality of the direct touch area.
- accessibilityDragPointThe point an assistive technology should use to begin a drag interaction.
- accessibilityDropPointThe point an assistive technology should use to end a drag interaction.
- accessibilityElementCreates a new accessibility element, or modifies the AccessibilityChildBehavior of the existing accessibility element.