accessibilityRepresentation
Replaces one or more accessibility elements for this view with new accessibility elements.
Declaration
compose().accessibilityRepresentation({
representation: ReactNode,
})nonisolated func accessibilityRepresentation<V>(
@ContentBuilder representation: () -> V
) -> some View
where V : ViewParameters
options.representation*ReactNodeA hidden view that the accessibility system uses to generate accessibility elements.
Discussion
You can make controls accessible by using a custom style. For example, a custom
ToggleStyle that you create inherits the accessibility features of Toggle
automatically. When you can't use the parent view's accessibility elements, use the
accessibilityRepresentation(representation:)
modifier instead. This modifier replaces default accessibility elements with different accessibility
elements that you provide. You use synthetic, non-visual accessibility elements to represent
what the view displays.
The example below makes a custom adjustable control accessible by explicitly
defining the representation of its step increments using a Slider:
var body: some View {
VStack {
SliderTrack(...) // Custom slider implementation.
}
.accessibilityRepresentation {
Slider(value: $value, in: 0...100) {
Text("Label")
}
}
}SwiftUI hides the view that you provide in the representation closure
and makes it non-interactive. The framework uses it only to
generate accessibility elements.
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.