Skip to main content

Class: AriaNarrator

Defined in: src/a11y/ariaNarration.ts:98

Announces scene and mobject descriptions through an ARIA live region.

Constructors​

Constructor​

new AriaNarrator(options): AriaNarrator

Defined in: src/a11y/ariaNarration.ts:101

Parameters​

options​

LiveRegionOptions = {}

Returns​

AriaNarrator

Accessors​

available​

Get Signature​

get available(): boolean

Defined in: src/a11y/ariaNarration.ts:106

Whether a live region exists (false in a non-DOM environment).

Returns​

boolean

Methods​

announce()​

announce(message): void

Defined in: src/a11y/ariaNarration.ts:115

Announce message to screen readers. Clears the region first so an identical consecutive message is still re-announced. No-op when unavailable.

Parameters​

message​

string

Returns​

void

clear()​

clear(): void

Defined in: src/a11y/ariaNarration.ts:122

Clear the region text. No-op when unavailable.

Returns​

void

destroy()​

destroy(): void

Defined in: src/a11y/ariaNarration.ts:129

Remove the region from the document. The narrator becomes unavailable.

Returns​

void