accessibilityLabel

Adds a label to the view that describes its contents.

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.

React
compose().accessibilityLabel(label: string)
Swift
@export(implementation) nonisolated func accessibilityLabel(
    _ label: LocalizedStringResource
) -> ModifiedContent<Self, AccessibilityAttachmentModifier>
3 more Swift overloads share this form
Swift
nonisolated func accessibilityLabel(
    _ labelKey: LocalizedStringKey
) -> ModifiedContent<Self, AccessibilityAttachmentModifier>
Swift
nonisolated func accessibilityLabel(
    _ label: Text
) -> ModifiedContent<Self, AccessibilityAttachmentModifier>
Swift
nonisolated func accessibilityLabel<S>(
    _ label: S
) -> ModifiedContent<Self, AccessibilityAttachmentModifier>
where S : StringProtocol

Parameters

  • 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.