Interface ScreenReaderKeyboardShortcut

Configuration for a screen reader keyboard shortcut.

Hierarchy

  • ScreenReaderKeyboardShortcut

Properties

actions deviceIdentifiers? eatAllKeys keys needsScreenReaderKey requiresScreenReaderActive?

Properties

actions

actions: ExecuteActionConfig[]

List of actions to perform.

Optional deviceIdentifiers

deviceIdentifiers?: string[]

When set to a non empty array, this shortcut will only be triggered by keyboard input from the devices with the given identifiers. This value and the keyboardDeviceIndentifiers values will be combined.

eatAllKeys

eatAllKeys: boolean

True when pressing any key in this shortcut should eat the pressed/released key, eaten keys will not send to the system.

keys

keys: VirtualKey[]

A list of VirtualKey keys which should trigger the shortcut.

needsScreenReaderKey

needsScreenReaderKey: boolean

True when the currently set screenreader key should be added to the list of keys.

Optional requiresScreenReaderActive

requiresScreenReaderActive?: boolean

When true, this shortcut will only be registered while the screen reader is active. When the screen reader is deactivated, the shortcut will be removed.

Generated using TypeDoc