View ModifieriOS 16.0+macOS 13.0+tvOS 16.0+watchOS 9.0+
Overloads
3 ways to call compose().accessibilityLabel(). Each is one SwiftUI overload, picked by the arguments you pass.
compose().accessibilityLabel(label: string)@export(implementation) nonisolated func accessibilityLabel(
_ label: LocalizedStringResource
) -> ModifiedContent<Self, AccessibilityAttachmentModifier>3 more Swift overloads share this form
nonisolated func accessibilityLabel(
_ labelKey: LocalizedStringKey
) -> ModifiedContent<Self, AccessibilityAttachmentModifier>nonisolated func accessibilityLabel(
_ label: Text
) -> ModifiedContent<Self, AccessibilityAttachmentModifier>nonisolated func accessibilityLabel<S>(
_ label: S
) -> ModifiedContent<Self, AccessibilityAttachmentModifier>
where S : StringProtocolParameters
label*string
Discussion
Use this method to provide an accessibility label for a view that doesn't display text, like an icon. For example, you could use this method to label a button that plays music with the text "Play". Don't include text in the label that repeats information that users already have. For example, don't use the label "Play button" because a button already has a trait that identifies it as a button.
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.