accessibilityValue

Adds a textual description of the value that the view contains.

View ModifieriOS 16.0+macOS 13.0+tvOS 16.0+watchOS 9.0+

Overloads

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

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

Parameters

  • valueResource*string

Discussion

Use this method to describe the value represented by a view, but only if that's different than the view's label. For example, for a slider that you label as "Volume" using accessibilityLabel(), you can provide the current volume setting, like "60%", using accessibilityValue().

See also

More in Accessibility.