UIAccessibility

A set of methods that provides accessibility information about views and controls in an app's user interface.

Overview 概要

The UIAccessibility informal protocol provides accessibility information about an app’s user interface elements. Assistive apps, such as VoiceOver, convey this information to users with disabilities to help them use the app.

Standard UIKit controls and views implement the UIAccessibility methods and are accessible to assistive apps by default. This means that if your app uses only standard controls and views, such as UIButton, UISegmentedControl, and UITableView, you need only supply app-specific details when the default values are incomplete. You can do this by setting these values in Interface Builder or by setting the properties in this informal protocol.

The UIAccessibilityElement class, which represents custom user interface objects, also implements the UIAccessibility informal protocol. If you create a completely custom UIView subclass, you might need to create an instance of UIAccessibilityElement to represent it. In this case, you would support all the UIAccessibility properties to correctly set and return the accessibility element’s properties.

Topics 話題

Supporting Basic Accessibility

var isAccessibilityElement: Bool

A Boolean value that indicates whether the element is an accessibility element that an assistive app can access.

var accessibilityLabel: String?

A succinct label in a localized string that identifies the accessibility element.

var accessibilityValue: String?

A localized string that contains the value of the accessibility element.

var accessibilityHint: String?

A localized string that contains a brief description of the result of performing an action on the accessibility element.

var accessibilityTraits: UIAccessibilityTraits

The combination of accessibility traits that best characterizes the accessibility element.

struct UIAccessibilityTraits

Constants that describe how an accessibility element behaves.

Defining Accessibility Text and Language

Speech Attributes for Attributed Strings

Apply attributes to text in an attributed string to modify the pronunciation of that text.

Text Attributes for Attributed Strings

Apply attributes to text in an attributed string to convey extra information about the text.

var accessibilityHeaderElements: [Any]?

An array of elements that serves as the headers for the accessibility element.

var accessibilityAttributedHint: NSAttributedString?

The underlying attributed version of the accessibility hint.

var accessibilityAttributedLabel: NSAttributedString?

The underlying attributed version of the accessibility label.

var accessibilityLanguage: String?

The language to use when speaking the accessibility element's label, value, and hint.

var accessibilityTextualContext: UIAccessibilityTextualContext?

A named context that helps identify and classify the type of text inside an element.

var accessibilityUserInputLabels: [String]!

An array of localized labels the user provides to refer to the accessibility element.

var accessibilityAttributedUserInputLabels: [NSAttributedString]!

The underlying attributed versions of the accessibility user input labels.

var accessibilityAttributedValue: NSAttributedString?

The underlying attributed version of the accessibility value.

Configuring Behavior

var accessibilityCustomRotors: [UIAccessibilityCustomRotor]?

An array of custom rotors for the current accessibility element.

var accessibilityElementsHidden: Bool

A Boolean value that indicates whether to hide the accessibility elements.

var accessibilityRespondsToUserInteraction: Bool

A Boolean value that indicates whether the accessibility element performs an action due to user interaction.

var accessibilityViewIsModal: Bool

A Boolean value that indicates whether VoiceOver ignores the accessibility elements within views that are siblings of the element.

var shouldGroupAccessibilityChildren: Bool

A Boolean value that indicates whether VoiceOver groups the accessibility elements that are children of the element, regardless of their positions on the screen.