accessibilityScrollStatus
Changes the announcement provided by accessibility technologies when a user scrolls a scroll view within this view.
View ModifieriOS 26.0+macOS 26.0+tvOS 26.0+watchOS 26.0+visionOS 26.0+accessibilityScrollStatus(_:isEnabled:) in SwiftUI
Declaration
compose().accessibilityScrollStatus(
status: string,
options?: {
isEnabled?: boolean;
}
)@export(implementation) nonisolated func accessibilityScrollStatus(
_ status: LocalizedStringResource,
isEnabled: Bool = true
) -> ModifiedContent<Self, AccessibilityAttachmentModifier>3 more Swift overloads share this form
nonisolated func accessibilityScrollStatus(
_ statusKey: LocalizedStringKey,
isEnabled: Bool = true
) -> ModifiedContent<Self, AccessibilityAttachmentModifier>nonisolated func accessibilityScrollStatus(
_ status: Text,
isEnabled: Bool = true
) -> ModifiedContent<Self, AccessibilityAttachmentModifier>nonisolated func accessibilityScrollStatus(
_ status: some StringProtocol,
isEnabled: Bool = true
) -> ModifiedContent<Self, AccessibilityAttachmentModifier>Parameters
status*stringThe current status of the scroll view.
options.isEnabledbooleanIf true the accessibility scroll status is applied; otherwise the accessibility scroll status is unchanged.
Discussion
Use this modifier to provide a description of the content at the current position in the scroll view. For example, you could use this modifier to announce the current month being scrolled to in a view that contains a calendar.
@State private var position = ScrollPosition(idType: Month.ID.self)
ScrollView {
LazyVStack {
ForEach(months) { months in
MonthView(month: months)
}
}
.scrollTargetLayout()
}
.scrollPosition($position)
.accessibilityScrollStatus("\(months.name(position.viewID)) \(year)")By default, VoiceOver announces "Page X of Y" while scrolling.
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.