RealityFoundation · IOS API REFERENCE

AccessibilityComponent

struct · iOS 17.0+ · SDK 27.1

struct AccessibilityComponent

A component that stores accessibility information for an entity. Add an `AccessibilityComponent` to entities to provide accessibility information to the system, such as the entity's name which VoiceOver says aloud when it describes the entity. See <doc:improving-the-accessibility-of-realitykit-apps> for more information.

Members (13)

get · iOS 17.0+

isAccessibilityElement

TypeScript

get isAccessibilityElement(): boolean

Swift declaration

var isAccessibilityElement: Bool

A Boolean value indicating whether the receiver is an accessibility entity that an assistive application can access.

set · iOS 17.0+

isAccessibilityElement

TypeScript

set isAccessibilityElement(value: boolean)

Swift declaration

var isAccessibilityElement: Bool

A Boolean value indicating whether the receiver is an accessibility entity that an assistive application can access.

get · iOS 17.0+

customActions

TypeScript

get customActions(): Array<_Foundation_LocalizedStringResource>

Swift declaration

var customActions: [LocalizedStringResource]

An array of custom actions supported by the entity, identified by their localized string key.

set · iOS 17.0+

customActions

TypeScript

set customActions(value: Array<_Foundation_LocalizedStringResource>)

Swift declaration

var customActions: [LocalizedStringResource]

An array of custom actions supported by the entity, identified by their localized string key.

get · iOS 17.0+

customContent

TypeScript

get customContent(): Array<AccessibilityComponent_CustomContent>

Swift declaration

var customContent: [AccessibilityComponent.CustomContent]

An array of custom content objects that deliver accessibility information. Use the Custom Content API to leverage assistive technologies to deliver complex data sets to users in measured portions when they need it.

set · iOS 17.0+

customContent

TypeScript

set customContent(value: Array<AccessibilityComponent_CustomContent>)

Swift declaration

var customContent: [AccessibilityComponent.CustomContent]

get · iOS 17.0+

systemActions

TypeScript

get systemActions(): AccessibilityComponent_SupportedActions

Swift declaration

var systemActions: AccessibilityComponent.SupportedActions

The set of supported accessibility actions.

set · iOS 17.0+

systemActions

TypeScript

set systemActions(value: AccessibilityComponent_SupportedActions)

Swift declaration

var systemActions: AccessibilityComponent.SupportedActions

The set of supported accessibility actions.

get · iOS 17.0+

label

TypeScript

get label(): (_Foundation_LocalizedStringResource) | null

Swift declaration

var label: LocalizedStringResource?

A succinct label that identifies the entity, in a localized string key.

set · iOS 17.0+

label

TypeScript

set label(value: (_Foundation_LocalizedStringResource) | null)

Swift declaration

var label: LocalizedStringResource?

A succinct label that identifies the entity, in a localized string key.

get · iOS 17.0+

value

TypeScript

get value(): (_Foundation_LocalizedStringResource) | null

Swift declaration

var value: LocalizedStringResource?

A localized string key that represents the current value of the entity.

set · iOS 17.0+

value

TypeScript

set value(value: (_Foundation_LocalizedStringResource) | null)

Swift declaration

var value: LocalizedStringResource?

A localized string key that represents the current value of the entity.

init · iOS 17.0+

init

TypeScript

static init(): AccessibilityComponent

Swift declaration

init()

Creates a new accessibility component with default values.

Skipped declarations

No declarations were skipped in this snapshot.

All RealityFoundation types →