accessibilityDefaultFocus

Defines a region in which default accessibility focus is evaluated by assigning a value to a given accessibility focus state binding.

View ModifieriOS 26.0+macOS 26.0+tvOS 26.0+watchOS 26.0+visionOS 26.0+accessibilityDefaultFocus(_:_:) in SwiftUI

Declaration

React
compose().accessibilityDefaultFocus<Value>(
  binding: SwiftUI.AccessibilityFocusStateBinding,
  value: Value
)
Swift
nonisolated func accessibilityDefaultFocus<Value>(
    _ binding: AccessibilityFocusState<Value>.Binding,
    _ value: Value
) -> some View
where Value : Hashable

Parameters

  • An accessibility focus state binding to update when evaluating default accessibility focus.

  • value*Value

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