Guidepup Library

Guidepup provides a reliable set of APIs to automate real screen readers through JavaScript.

Guidepup current supports the following screen readers:

VoiceOver for MacOS
NVDA for Windows

Here's a typical example:

import { voiceOver } from "@guidepup/guidepup";

(async () => {
  // Start VoiceOver.
  await voiceOver.start();

  // Move to the next item.
  await voiceOver.next();

  // ... perform some commands.

  // Stop VoiceOver.
  await voiceOver.stop();
})();

Contents:

macOSActivate

See: macOSActivate

Opens a MacOS application if not already open, and focuses the application.

MacOSApplications

Type: MacOSApplications

Identifiers for standard applications available on MacOS.

MacOSKeyCodes

Type: MacOSKeyCodes

Key codes for MacOS.

MacOSModifiers

Type: MacOSModifiers

Modifier keys for MacOS.

macOSQuit

See: macOSQuit

Quits a MacOS application if running.

nvda

Type: NVDA

This object can be used to launch and control NVDA.

Here's a typical example:

import { nvda } from "@guidepup/guidepup";

(async () => {
  // Start NVDA.
  await nvda.start();

  // Move to the next item.
  await nvda.next();

  // ... perform some commands.

  // Stop NVDA.
  await nvda.stop();
})();

NVDAKeyCodeCommands

Type: NVDAKeyCodeCommands

Key code commands for the NVDA screen reader on Windows.

voiceOver

Type: VoiceOver

This object can be used to launch and control VoiceOver.

Here's a typical example:

import { voiceOver } from "@guidepup/guidepup";

(async () => {
  // Start VoiceOver.
  await voiceOver.start();

  // Move to the next item.
  await voiceOver.next();

  // ... perform some commands.

  // Stop VoiceOver.
  await voiceOver.stop();
})();