AccessibilityRotorEntry

アクセシビリティローター内のエントリを表す構造体。

iOS 15.0+ iPadOS 15.0+ macOS 12.0+ Mac Catalyst 15.0+

tvOS 15.0+ watchOS 8.0+ visionOS 1.0+ Beta

struct AccessibilityRotorEntry<ID> where ID : Hashable

概観

アクセシビリティローターは、ユーザがユーザインターフェイスの特定の要素にすばやくナビゲートしたり、必要に応じてそれらの要素内の特定の範囲のテキストにナビゲートできるようにするショートカットです。

ローター内のエントリには、ユーザに対してエントリを識別するためのラベル、ローターエントリがどのアクセシビリティー要素にナビゲートするかを決定するために使用される識別子(ID)、および関連するアクセシビリティ要素のテキスト内の特定の位置にナビゲートするエントリーに使用されるオプションの範囲が含まれる場合があります。エントリはまた、アクセシビリティ要素をスクリーン上に表示するために必要な手動作業を行うために、エントリにナビゲートする前に呼び出されるハンドラを指定することもできます。

以下の例では、メッセージアプリケーションがローターを作成し、ユーザが特に VIP から発信されたメッセージにナビゲートできるようにします。

// `messages` is a list of `Identifiable` `Message`s.
ScrollView {
LazyVStack {
ForEach(messages) { message in
MessageView(message)
}
}
}
.accessibilityElement(children: .contain)
.accessibilityRotor("VIPs") {
// Not all the `MessageView`s are generated at once, but the model
// knows about all the messages.
ForEach(messages) { message in
// If the Message is from a VIP, make a Rotor entry for it.
if message.isVIP {
AccessibilityRotorEntry(message.subject, id: message.id)
}
}
}

ForEach 繰り返し内に複数の Accessibility 要素がある場合、または ScrollView が存在しない状況では、optional の名前空間を使用してエントリを作成することもできます。この場合、ScrollViewReader を使用して要素を所定の位置にスクロールするには、prepare クロージャが必要になります。同じ名前空間を accessibilityRotorEntry(id:in:) の呼び出しに渡して、このエントリに関連した Accessibility 要素にタグを付ける必要があります。

以下の例では、メッセージアプリケーションがローターを作成し、ユーザが特に VIP から発信されたメッセージにナビゲートできるようにします。ローターエントリは、メッセージのコンテンツテキストに関連していますが、これは、Accessibility 要素を生成する ForEach 内の 2 つのビューの 1 つです。そのビューには、AccessibilityRotorEntry(id:in:) のタグが付けられているため、AccessibilityRotorEntry で見つける事ができ、ScrollViewReader が prepare クロージャとともに使用されて、ビューを所定の位置にスクロールします。