Accessibility Modifiers

Make your SwiftUI apps accessible to everyone, including people with disabilities.

Overview 概要

Like all Apple UI frameworks, SwiftUI comes with built-in accessibility support. The framework introspects common elements like navigation views, lists, text fields, sliders, buttons, and so on, and provides basic accessibility labels and values by default. You don’t have to do any extra work to enable these standard accessibility features.

SwiftUI also provides tools to help you enhance the accessibility of your app. To find out what enhancements you need, try using your app with accessibility features like VoiceOver, Voice Control, and Switch Control, or get feedback from users of your app that regularly use these features. Then use the accessibility view modifiers that SwiftUI provides to improve the experience. For example, you can explicitly add accessibility labels to elements in your UI using the accessibilityLabel(_:) or the accessibilityValue(_:) view modifier.

Customize your use of accessibility modifiers for all the platforms that your app runs on. For example, you may need to adjust the accessibility elements for a companion Apple Watch app that shares a common code base with an iOS app. If you integrate AppKit or UIKit controls in SwiftUI, expose any accessibility labels and make them accessible from your NSViewRepresentable or UIViewRepresentable views, or provide custom accessibility information if the underlying accessibility labels aren’t available.

For more information about creating a great experience for all users, see Accessibility.

Topics 話題

Essentials 要点

Creating Accessible Views アクセシブルビューを作成する
Make your app accessible to everyone by applying accessibility modifiers to your SwiftUI views. あなたのアプリを誰もがアクセス可能なものにしてください、アクセスビリティ修飾子をあなたのSwiftUIビューに加えることによって。

Technologies

struct AccessibilityTechnologies
Accessibility technologies available to the system.

Labels

func accessibilityLabel<S>(S) -> ModifiedContent<Self, AccessibilityAttachmentModifier>
Adds a label to the view that describes its contents. ビューにそれの内容を記述するラベルを加えます。
func accessibilityLabel(Text) -> ModifiedContent<Self, AccessibilityAttachmentModifier>
Adds a label to the view that describes its contents. ビューにそれの内容を記述するラベルを加えます。
func accessibilityLabel(LocalizedStringKey) -> ModifiedContent<Self, AccessibilityAttachmentModifier>
Adds a label to the view that describes its contents. ビューにそれの内容を記述するラベルを加えます。
func accessibilityInputLabels([LocalizedStringKey]) -> ModifiedContent<Self, AccessibilityAttachmentModifier>
Sets alternate input labels with which users identify a view. それでユーザがあるビューを識別するところの代替の入力ラベルを設定します。
func accessibilityInputLabels<S>([S]) -> ModifiedContent<Self, AccessibilityAttachmentModifier>
Sets alternate input labels with which users identify a view. それでユーザがあるビューを識別するところの代替の入力ラベルを設定します。
func accessibilityInputLabels([Text]) -> ModifiedContent<Self, AccessibilityAttachmentModifier>
Sets alternate input labels with which users identify a view. それでユーザがあるビューを識別するところの代替の入力ラベルを設定します。
func accessibilityLabeledPair<ID>(role: AccessibilityLabeledPairRole, id: ID, in: Namespace.ID) -> some View
Pairs an accessibility element representing a label with the element for the matching content. ラベルを表しているあるアクセシビリティ要素をその合致している内容に対する要素と対にします。
enum AccessibilityLabeledPairRole

Values 値

func accessibilityValue<S>(S) -> ModifiedContent<Self, AccessibilityAttachmentModifier>
Adds a textual description of the value that the view contains. ビューのテキスト記述を加えます、それはビューが含みます。
func accessibilityValue(LocalizedStringKey) -> ModifiedContent<Self, AccessibilityAttachmentModifier>
Adds a textual description of the value that the view contains. ビューのテキスト記述を加えます、それはビューが含みます。
func accessibilityValue(Text) -> ModifiedContent<Self, AccessibilityAttachmentModifier>
Adds a textual description of the value that the view contains. ビューのテキスト記述を加えます、それはビューが含みます。

Hints

func accessibilityHint(LocalizedStringKey) -> ModifiedContent<Self, AccessibilityAttachmentModifier>
Communicates to the user what happens after performing the view’s action. ビューのもつアクションを実行する後に何が起こるかユーザに伝えます。
func accessibilityHint(Text) -> ModifiedContent<Self, AccessibilityAttachmentModifier>
Communicates to the user what happens after performing the view’s action. ビューのもつアクションを実行する後に何が起こるかユーザに伝えます。
func accessibilityHint<S>(S) -> ModifiedContent<Self, AccessibilityAttachmentModifier>
Communicates to the user what happens after performing the view’s action. ビューのもつアクションを実行する後に何が起こるかユーザに伝えます。

Actions

func accessibilityAction(AccessibilityActionKind, () -> Void) -> ModifiedContent<Self, AccessibilityAttachmentModifier>
Adds an accessibility action to the view. Actions allow assistive technologies, such as the VoiceOver, to interact with the view by invoking the action.
func accessibilityAction(named: Text, () -> Void) -> ModifiedContent<Self, AccessibilityAttachmentModifier>
Adds an accessibility action to the view. Actions allow assistive technologies, such as the VoiceOver, to interact with the view by invoking the action.
func accessibilityAction<S>(named: S, () -> Void) -> ModifiedContent<Self, AccessibilityAttachmentModifier>
Adds an accessibility action to the view. Actions allow assistive technologies, such as the VoiceOver, to interact with the view by invoking the action.
func accessibilityAction(named: LocalizedStringKey, () -> Void) -> ModifiedContent<Self, AccessibilityAttachmentModifier>
Adds an accessibility action to the view. Actions allow assistive technologies, such as the VoiceOver, to interact with the view by invoking the action.
func accessibilityAction<Label>(action: () -> Void, label: () -> Label) -> some View
Adds an accessibility action to the view. Actions allow assistive technologies, such as the VoiceOver, to interact with the view by invoking the action.
func accessibilityAdjustableAction((AccessibilityAdjustmentDirection) -> Void) -> ModifiedContent<Self, AccessibilityAttachmentModifier>
Adds an accessibility adjustable action to the view. アクセシビリティ調節可能アクションをこのビューに加えます。 Actions allow assistive technologies, such as the VoiceOver, to interact with the view by invoking the action.
func accessibilityScrollAction((Edge) -> Void) -> ModifiedContent<Self, AccessibilityAttachmentModifier>
Adds an accessibility scroll action to the view. アクセシビリティスクロールアクションをこのビューに加えます。 Actions allow assistive technologies, such as the VoiceOver, to interact with the view by invoking the action.
struct AccessibilityActionKind
The structure that defines the kinds of available accessibility actions.
enum AccessibilityAdjustmentDirection
A directional indicator you use when making an accessibility adjustment. アクセシビリティを調整する場合にあなたが使う方向指示子。

Activation Point

func accessibilityActivationPoint(CGPoint) -> ModifiedContent<Self, AccessibilityAttachmentModifier>
Specifies the point where activations occur in the view. アクティベーションがビューの中で発生するところの地点を指定します。
func accessibilityActivationPoint(UnitPoint) -> ModifiedContent<Self, AccessibilityAttachmentModifier>
Specifies the unit point where activations occur in the view. アクティベーションがビューの中で発生するところの単位点を指定します。

Elements

func accessibilityElement(children: AccessibilityChildBehavior) -> some View
Creates a new accessibility element, or modifies the AccessibilityChildBehavior of the existing accessibility element.
func accessibilityChildren<V>(children: () -> V) -> some View
Replaces the existing accessibility element’s children with one or more new synthetic accessibility elements.
func accessibilityHidden(Bool) -> ModifiedContent<Self, AccessibilityAttachmentModifier>
Specifies whether to hide this view from system accessibility features. このビューをシステムアクセシビリティ機能から隠すべきかどうかを指定します。
struct AccessibilityChildBehavior

Custom Controls

func accessibilityRepresentation<V>(representation: () -> V) -> some View
Replaces one or more accessibility elements for this view with new accessibility elements.
func accessibilityRespondsToUserInteraction(Bool) -> ModifiedContent<Self, AccessibilityAttachmentModifier>
Explicitly set whether this Accessibility element responds to user interaction and would thus be interacted with by technologies such as Switch Control, Voice Control or Full Keyboard Access.

Custom Content

func accessibilityCustomContent(AccessibilityCustomContentKey, LocalizedStringKey, importance: AXCustomContent.Importance) -> ModifiedContent<Self, AccessibilityAttachmentModifier>
Add additional accessibility information to the view.
func accessibilityCustomContent(AccessibilityCustomContentKey, Text?, importance: AXCustomContent.Importance) -> ModifiedContent<Self, AccessibilityAttachmentModifier>
Add additional accessibility information to the view.
func accessibilityCustomContent<V>(LocalizedStringKey, V, importance: AXCustomContent.Importance) -> ModifiedContent<Self, AccessibilityAttachmentModifier>
Add additional accessibility information to the view.
func accessibilityCustomContent(Text, Text, importance: AXCustomContent.Importance) -> ModifiedContent<Self, AccessibilityAttachmentModifier>
Add additional accessibility information to the view.
func accessibilityCustomContent(LocalizedStringKey, LocalizedStringKey, importance: AXCustomContent.Importance) -> ModifiedContent<Self, AccessibilityAttachmentModifier>
Add additional accessibility information to the view.
func accessibilityCustomContent<V>(AccessibilityCustomContentKey, V, importance: AXCustomContent.Importance) -> ModifiedContent<Self, AccessibilityAttachmentModifier>
Add additional accessibility information to the view.
func accessibilityCustomContent(LocalizedStringKey, Text, importance: AXCustomContent.Importance) -> ModifiedContent<Self, AccessibilityAttachmentModifier>
Add additional accessibility information to the view.
struct AccessibilityCustomContentKey
Key used to specify the identifier and label associated with an entry of additional accessibility information.

Rotors

Accessible Navigation
Enable users to navigate to specific user interface elements.

Focus

func accessibilityFocused(AccessibilityFocusState<Bool>.Binding) -> some View
Modifies this view by binding its accessibility element’s focus state to the given boolean state value.
func accessibilityFocused<Value>(AccessibilityFocusState<Value>.Binding, equals: Value) -> some View
Modifies this view by binding its accessibility element’s focus state to the given state value.
struct AccessibilityFocusState
A property wrapper type that can read and write a value that SwiftUI updates as the focus of any active accessibility technology, such as VoiceOver, changes.

Traits

func accessibilityAddTraits(AccessibilityTraits) -> ModifiedContent<Self, AccessibilityAttachmentModifier>
Adds the given traits to the view. 与えられた特徴をビューに加えます。
func accessibilityRemoveTraits(AccessibilityTraits) -> ModifiedContent<Self, AccessibilityAttachmentModifier>
Removes the given traits from this view. 与えられた特徴をビューから取り除きます。
struct AccessibilityTraits
A set of accessibility traits that describe how an element behaves. 一揃いのアクセシビリティ特徴（トレイト）、それはどのように要素が振舞うかを記述します。

Identity

func accessibilityIdentifier(String) -> ModifiedContent<Self, AccessibilityAttachmentModifier>
Uses the string you specify to identify the view.

Color Inversion

func accessibilityIgnoresInvertColors(Bool) -> some View
Sets whether this view should ignore the system Smart Invert setting. このビューがシステムのSmart Invert設定を無視すべきかどうかを設定します。

Content Descriptions

func accessibilityTextContentType(AccessibilityTextContentType) -> ModifiedContent<Self, AccessibilityAttachmentModifier>
Sets an accessibility text content type.
func accessibilityHeading(AccessibilityHeadingLevel) -> ModifiedContent<Self, AccessibilityAttachmentModifier>
Sets the accessibility level of this heading.
enum AccessibilityHeadingLevel
The hierarchy of a heading in relation other headings.
struct AccessibilityTextContentType
Textual context that assistive technologies can use to improve the presentation of spoken text.

VoiceOver

func speechAdjustedPitch(Double) -> some View
Raises or lowers the pitch of spoken text.
func speechAlwaysIncludesPunctuation(Bool) -> some View
Sets whether VoiceOver should always speak all punctuation in the text view.
func speechAnnouncementsQueued(Bool) -> some View
Controls whether to queue pending announcements behind existing speech rather than interrupting speech in progress.
func speechSpellsOutCharacters(Bool) -> some View
Sets whether VoiceOver should speak the contents of the text view character by character.

Charts

func accessibilityChartDescriptor<R>(R) -> some View
Adds a descriptor to a View that represents a chart to make the chart’s contents accessible to all users.
protocol AXChartDescriptorRepresentable
A type to generate an AXChartDescriptor object that you use to provide information about a chart and its data for an accessible experience in VoiceOver or other assistive technologies.

Large Content

func accessibilityShowsLargeContentViewer() -> some View
Adds a default large content view to be shown by the large content viewer.
func accessibilityShowsLargeContentViewer<V>(() -> V) -> some View
Adds a custom large content view to be shown by the large content viewer.

Supporting Types 支援を行う型

struct AccessibilityAttachmentModifier
A view modifier that adds accessibility properties to the view

See Also 参照

Configuring View Elements

Appearance Modifiers
Configure a view’s foreground and background styles, controls, and visibility.
Text and Symbol Modifiers
Manage the rendering, selection, and entry of text in your view.
Auxiliary View Modifiers
Add and configure supporting views, like toolbars and context menus.