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

React
compose().accessibilityScrollStatus(
  status: string,
  options?: {
    isEnabled?: boolean;
  }
)
Swift
@export(implementation) nonisolated func accessibilityScrollStatus(
    _ status: LocalizedStringResource,
    isEnabled: Bool = true
) -> ModifiedContent<Self, AccessibilityAttachmentModifier>
3 more Swift overloads share this form
Swift
nonisolated func accessibilityScrollStatus(
    _ statusKey: LocalizedStringKey,
    isEnabled: Bool = true
) -> ModifiedContent<Self, AccessibilityAttachmentModifier>
Swift
nonisolated func accessibilityScrollStatus(
    _ status: Text,
    isEnabled: Bool = true
) -> ModifiedContent<Self, AccessibilityAttachmentModifier>
Swift
nonisolated func accessibilityScrollStatus(
    _ status: some StringProtocol,
    isEnabled: Bool = true
) -> ModifiedContent<Self, AccessibilityAttachmentModifier>

Parameters

  • status*string

    The current status of the scroll view.

  • options.isEnabledboolean

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