Accessibility

Make your app more accessible to users with disabilities.

Topics

First Steps

UIAccessibility

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

UIAccessibilityContainer

A set of methods that view subclasses use to make subcomponents accessible as separate elements.

Behaviors

UIAccessibilityFocus

An informal protocol that provides a way to find out whether an assistive technology, such as VoiceOver, is focused on an accessible element.

protocol UIAccessibilityIdentification

Methods that associate a unique identifier with elements in your user interface.

protocol UIAccessibilityReadingContent

Methods to implement on an object that represents content that is intended to be read by users, such as a book or an article.

protocol UIAccessibilityContentSizeCategoryImageAdjusting

Methods to determine when to adjust images for different content size categories.

Actions

UIAccessibilityAction

A set of methods that accessibility elements can use to support specific actions.

class UIAccessibilityCustomAction

A custom action to be performed on an accessible object.

Delivering an Exceptional Accessibility Experience

Make improvements to your app’s interaction model to support assistive technologies such as VoiceOver.

Elements

class UIAccessibilityElement

Encapsulates information about an item that should be accessible to users with disabilities, but that isn’t accessible by default.

protocol UIScrollViewAccessibilityDelegate

A set of methods you can implement to provide accessibility information for a scroll view.

protocol UIPickerViewAccessibilityDelegate

A set of methods you can implement to provide accessibility information for individual components of a picker view.

Containers

protocol UIAccessibilityContainerDataTable

Methods that convey information about the contents of a table.

protocol UIAccessibilityContainerDataTableCell

Methods that provide the location of a cell in a table.

enum UIAccessibilityContainerType

Constants indicating the type of content stored in a data-based container.

Navigation

class UIAccessibilityCustomRotor

A context-sensitive function that helps Voice Over users find the next instance of a related element.

class UIAccessibilityCustomRotorItemResult

A target element referenced by a custom rotor.

class UIAccessibilityCustomRotorSearchPredicate

The search parameters that help determine the next matching custom rotor item result.

Drag and Drop Support

class UIAccessibilityLocationDescriptor

An accessibility descriptor for a specific geometric point of interest within a view, for use by assistive technologies.

Notifications

static func post(notification: UIAccessibility.Notification, argument: Any?)

Posts a notification to assistive applications.

Notification Names

Contains the names of notifications generated by the accessibility system.

Conversions

static func convertToScreenCoordinates(CGRect, in: UIView) -> CGRect

Converts the specified rectangle from view coordinates to screen coordinates.

static func convertToScreenCoordinates(UIBezierPath, in: UIView) -> UIBezierPath

Converts the specified path object to screen coordinates and returns a new path object with the results.

static let voiceOverStatusDidChangeNotification: NSNotification.Name

Convenience Functions

static func focusedElement(using: UIAccessibility.AssistiveTechnologyIdentifier?) -> Any?

Returns the element that is currently focused by the specified assistive technology.

static var hearingDevicePairedEar: UIAccessibility.HearingDeviceEar

Returns the current pairing status of MFi hearing aids.

struct UIAccessibility.HearingDeviceEar

Constants that specify how a hearing device is being used.

static func registerGestureConflictWithZoom()

Warns users that application-specific gestures conflict with the system-defined Zoom accessibility gestures.

static func requestGuidedAccessSession(enabled: Bool, completionHandler: (Bool) -> Void)

Transitions the app to or from Single App mode asynchronously.

static func zoomFocusChanged(zoomType: UIAccessibility.ZoomType, toFrame: CGRect, in: UIView)

Notifies the system that the app’s focus has changed to a new location.

Capabilities

static var isAssistiveTouchRunning: Bool

Returns a Boolean value indicating whether the system preference for AssistiveTouch is enabled.

static var isVoiceOverRunning: Bool

Returns a Boolean value indicating whether VoiceOver is running.

static var isSwitchControlRunning: Bool

Returns a Boolean value indicating whether Switch Control is enabled.

static var isShakeToUndoEnabled: Bool

Returns a Boolean value indicating whether the system preference for Shake to Undo is enabled.

static var isClosedCaptioningEnabled: Bool

Returns a Boolean value indicating whether closed captioning is enabled.

static var isBoldTextEnabled: Bool

Returns a Boolean value indicating whether bold text is enabled.

static var isDarkerSystemColorsEnabled: Bool

Returns a Boolean value indicating whether darken colors is enabled.

static var isGrayscaleEnabled: Bool

Returns a Boolean value indicating whether grayscale is enabled.

static var isGuidedAccessEnabled: Bool

Returns a Boolean value indicating whether the app is running in Guided Access mode.

static var isInvertColorsEnabled: Bool

Returns a Boolean value indicating whether inverted colors is enabled.

static var isMonoAudioEnabled: Bool

Returns a Boolean value indicating whether system audio is set to mono.

static var isReduceMotionEnabled: Bool

Returns a Boolean value indicating whether reduce motion is enabled.

static var isReduceTransparencyEnabled: Bool

Returns a Boolean value indicating whether reduce transparency is enabled.

static var isSpeakScreenEnabled: Bool

Returns a Boolean value indicating whether speaking the screen is enabled.

static var isSpeakSelectionEnabled: Bool

Returns a Boolean value indicating whether speaking the selection is enabled.