IScreenReader

Abstract base interface for screen reader classes.

See also:

• ScreenReader
• NVDA
• Virtual
• VoiceOver

Contents:

• screenReader.name
• screenReader.version
• screenReader.act([options])
• screenReader.clearItemTextLog()
• screenReader.clearSpokenPhraseLog()
• screenReader.click([options])
• screenReader.default()
• screenReader.detect()
• screenReader.getSetting(key)
• screenReader.getSettings()
• screenReader.interact([options])
• screenReader.itemText()
• screenReader.itemTextLog()
• screenReader.lastSpokenPhrase()
• screenReader.next([options])
• screenReader.nextHeading([options])
• screenReader.nextLandmark([options])
• screenReader.nextLink([options])
• screenReader.perform(command, [options])
• screenReader.press(key, [options])
• screenReader.previous([options])
• screenReader.previousHeading([options])
• screenReader.previousLandmark([options])
• screenReader.previousLink([options])
• screenReader.spokenPhraseLog()
• screenReader.start([options])
• screenReader.stop([options])
• screenReader.stopInteracting([options])
• screenReader.type(text[, options])

screenReader.name

Getter for the screen reader name.

Returns: string

screenReader.version

Getter for the screen reader version.

Returns: string

screenReader.act([options])

Perform the default action for the item in the screen reader cursor.

Parameters:

• Optional: options CommandOptions Additional options.

Returns: Promise<void>

screenReader.clearItemTextLog()

Clear the log of all visited item text for this screen reader instance.

Returns: Promise<void>

screenReader.clearSpokenPhraseLog()

Clear the log of all spoken phrases for this screen reader instance.

Returns: Promise<void>

screenReader.click([options])

Click the mouse.

Parameters:

• Optional: options ClickOptions Click options.

Returns: Promise<void>

screenReader.default()

Detect whether the screen reader is the default screen reader for the current OS.

Returns: boolean

screenReader.detect()

Detect whether the screen reader is supported for the current OS.

Returns: boolean

screenReader.getSetting(key)

Returns the value of a setting for this screen reader instance.

Parameters:

• key string The setting name.

Returns: unknown The setting value.

screenReader.getSettings()

Returns all the current settings for this screen reader instance.

Returns: Record<string, unknown> Current settings values.

screenReader.interact([options])

Interact with the item under the screen reader cursor.

Parameters:

• Optional: options CommandOptions Additional options.

Returns: Promise<void>

screenReader.itemText()

Get the text of the item in the screen reader cursor.

Returns: Promise<string> The item's text.

screenReader.itemTextLog()

Get the log of all visited item text for this screen reader instance.

Returns: Promise<Array<string>> The item text log.

screenReader.lastSpokenPhrase()

Get the last spoken phrase.

Returns: Promise<string> The last spoken phrase.

screenReader.next([options])

Move the screen reader cursor to the next location.

Parameters:

• Optional: options CommandOptions Additional options.

Returns: Promise<void>

screenReader.nextHeading([options])

Move the screen reader cursor to the next heading.

Parameters:

• Optional: options CommandOptions Additional options.

Returns: Promise<void>

screenReader.nextLandmark([options])

Move the screen reader cursor to the next landmark.

Parameters:

• Optional: options CommandOptions Additional options.

Returns: Promise<void>

screenReader.nextLink([options])

Move the screen reader cursor to the next link.

Parameters:

• Optional: options CommandOptions Additional options.

Returns: Promise<void>

screenReader.perform(command[, options])

Perform a screen reader command.

Parameters:

• command any Screen reader command to execute.
• Optional: options CommandOptions Additional options.

Returns: Promise<void>

screenReader.press(key[, options])

Press a key on the focused item.

key can specify the intended keyboardEvent.key value or a single character to generate the text for. A superset of the key values can be found on the MDN key values page. Examples of the keys are:

F1 - F20, Digit0 - Digit9, KeyA - KeyZ, Backquote, Minus, Equal, Backslash, Backspace, Tab, Delete, Escape, ArrowDown, End, Enter, Home, Insert, PageDown, PageUp, ArrowRight, ArrowUp, etc.

Following modification shortcuts are also supported: Shift, Control, Alt, Meta.

Holding down Shift will type the text that corresponds to the key in the upper case.

If key is a single character, it is case-sensitive, so the values a and A will generate different respective texts.

Shortcuts such as key: "Control+f" or key: "Control+Shift+f" are supported as well. When specified with the modifier, modifier is pressed and being held while the subsequent key is being pressed.

Parameters:

• key string Name of the key to press or a character to generate, such as ArrowLeft or a.
• Optional: options KeyboardOptions Additional options.

Returns: Promise<void>

screenReader.previous([options])

Move the screen reader cursor to the previous location.

Parameters:

• Optional: options CommandOptions Additional options.

Returns: Promise<void>

screenReader.previousHeading([options])

Move the screen reader cursor to the previous heading.

Parameters:

• Optional: options CommandOptions Additional options.

Returns: Promise<void>

screenReader.previousLandmark([options])

Move the screen reader cursor to the previous landmark.

Parameters:

• Optional: options CommandOptions Additional options.

Returns: Promise<void>

screenReader.previousLink([options])

Move the screen reader cursor to the previous link.

Parameters:

• Optional: options CommandOptions Additional options.

Returns: Promise<void>

screenReader.spokenPhraseLog()

Get the log of all spoken phrases for this screen reader instance.

Returns: Promise<Array<string>> The spoken phrase log.

screenReader.start([options])

Turn the screen reader on.

Parameters:

• Optional: options StartOptions Additional options.

Returns: Promise<void>

screenReader.stop([options])

Turn the screen reader off.

Parameters:

• Optional: options CommandOptions Additional options.

Returns: Promise<void>

screenReader.stopInteracting([options])

Stop interacting with the current item.

Parameters:

• Optional: options CommandOptions Additional options.

Returns: Promise<void>

screenReader.type(text[, options])

Type text into the focused item.

To press a special key, like Control or ArrowDown, use screenReader.press(key[, options]).

Parameters:

• text string Text to type into the focused item.
• Optional: options CommandOptions Additional options.

Returns: Promise<void>