siteKiosk.accessibility.screenReader

Properties

isActive speakSpeed type

Methods

focusElementAsync onScreenReaderStateChanged onSpeakSpeedChanged

Properties

isActive

isActive: boolean

Gets or sets the current screen reader state.

speakSpeed

speakSpeed: SpeakSpeed

Gets or sets the speak speed of the screen reader.

Readonly type

type: ScreenReaderType

The type of the screen reader. (SiteKiosk, JAWS, NVDA, Narrator, TalkBack)

Methods

focusElementAsync

  • Changes the screen reader focus to the specified element. When providing an HTMLElement, the elements id will be used.

    Parameters

    • elementOrId: string | HTMLElement

      The element or id to focus.

    Returns Promise<void>

onScreenReaderStateChanged

  • Returns

    An event subscription which can be used to unsubscribe from the event.

    Parameters

    • callback: ((isActive: boolean) => void)

      The callback which will be called when the screen reader state changes.

        • (isActive: boolean): void

        • Parameters

          • isActive: boolean

          Returns void

    Returns EventSubscription

onSpeakSpeedChanged

  • Registers a callback which will be called when the speak speed changes.

    Returns

    An event subscription which can be used to unsubscribe from the event.

    Parameters

    • callback: ((speed: SpeakSpeed) => void)

      The callback which will be called with the new speak speed.

    Returns EventSubscription

Generated using TypeDoc