accessibilityDefaultFocus
Defines a region in which default accessibility focus is evaluated by assigning a value to a given accessibility focus state binding.
Declaration
compose().accessibilityDefaultFocus<Value>(
binding: SwiftUI.AccessibilityFocusStateBinding,
value: Value
)nonisolated func accessibilityDefaultFocus<Value>(
_ binding: AccessibilityFocusState<Value>.Binding,
_ value: Value
) -> some View
where Value : HashableParameters
An accessibility focus state binding to update when evaluating default accessibility focus.
value*ValueThe value to set the binding to during evaluation.
Discussion
Accessibility default focus is evaluated when a scene appears and an accessibility technology like VoiceOver focuses on its content, when an accessibility focus state binding update moves focus automatically, and when the layout of a scene changes and the accessibility technology must refocus on new content.
In the following example, an accessibility technology, like VoiceOver, automatically lands on the title of the playlist as the most important view to initially have focus on, rather than navigating through all controls to understand what the primary content of the view is.
var body: some View {
VStack {
PlayerControls(currentSong: $currentSong)
Text(playlist.title)
.font(.title)
.accessibilityFocused($focusedField, equals: .title)
PlaylistEntries(entries: playlist.entries)
}
.accessibilityDefaultFocus($focusedField, .title)
}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.
- 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.
- accessibilityFocusedModifies this view by binding its accessibility element's focus state to the given boolean state value.