Instance Property

accessibilityLabel

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

Declaration

var accessibilityLabel: String? { get set }

Discussion

The default value for this property is nil unless the receiver is a UIKit control, in which case the value is a label derived from the control’s title.

If you implement a custom control or view or if you display a custom icon on a UIKit control, set this property to make sure your accessibility elements have appropriate labels. If an accessibility element does not display a descriptive label, set this property to supply a short, localized label that succinctly identifies the element. For example, a “Play music” button might display an icon that shows sighted users what it does. To be accessible, however, the button should have the accessibility label “Play” or “Play music” so that an assistive application can provide this information to users with disabilities. Note, however, that the label should never include the control type (such as “button”) because this information is contained in the traits associated with the accessibility element.

See Also

Defining Accessibility Text and Language

Speech Attributes for Attributed Strings

Apply attributes to text in an attributed string to modify how that text is pronounced.

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 considered to be the headers for this element.

var accessibilityAttributedHint: NSAttributedString?

The underlying attributed version of the accessibility hint.

var accessibilityHint: String?

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

var accessibilityAttributedLabel: NSAttributedString?

The underlying attributed version of the accessibility label.

var accessibilityLanguage: String?

The language in which to speak 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 accessibilityAttributedUserInputLabels: [NSAttributedString]!

The underlying attributed versions of the accessibility user input labels.

var accessibilityUserInputLabels: [String]!

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

var accessibilityAttributedValue: NSAttributedString?

The underlying attributed version of the accessibility value.

var accessibilityValue: String?

The value of the accessibility element, in a localized string.