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:
- guidepup.macOSActivate
- guidepup.MacOSApplications
- guidepup.MacOSKeyCodes
- guidepup.MacOSModifiers
- guidepup.macOSQuit
- guidepup.macOSRecord
- guidepup.nvda
- guidepup.nvdaKeyCodeCommands
- guidepup.voiceOver
- guidepup.VoiceOverCommanderCommands
- guidepup.voiceOverKeyCodeCommands
- guidepup.windowsOSActivate
- guidepup.WindowsKeyCodes
- guidepup.WindowsModifiers
- guidepup.windowsQuit
guidepup.macOSActivate
Type: <macOSActivate>
Opens a MacOS application if not already open, and focuses the application.
guidepup.MacOSApplications
Type: <MacOSApplications>
Identifiers for standard applications available on MacOS.
guidepup.MacOSKeyCodes
Type: <MacOSKeyCodes>
Key codes for MacOS.
guidepup.MacOSModifiers
Type: <MacOSModifiers>
Modifier keys for MacOS.
guidepup.macOSQuit
Type: <macOSQuit>
Quits a MacOS application if running.
guidepup.macOSRecord
Type: <macOSRecord>
Start a screen recording.
guidepup.nvda
Type: <NVDA>
This object can be used to launch and control NVDA.
guidepup.NVDAKeyCodeCommands
Type: <NVDAKeyCodeCommands>
Key code commands for the NVDA screen reader on Windows.
guidepup.voiceOver
Type: <VoiceOver>
This object can be used to launch and control VoiceOver.
guidepup.VoiceOverCommanderCommands
Type: <VoiceOverCommanderCommands>
VoiceOver Commander commands.
guidepup.voiceOverKeyCodeCommands
Type: <voiceOverKeyCodeCommands>
Key code commands for the VoiceOver screen reader on MacOS.
guidepup.windowsActivate
Type: <windowsActivate>
Opens a Windows application if not already open, and focuses the application.
guidepup.WindowsKeyCodes
Type: <WindowsKeyCodes>
Key codes for Windows.
guidepup.WindowsModifiers
Type: <WindowsModifiers>
Modifier keys for Windows.
guidepup.windowsQuit
Type: <windowsQuit>
Quits a Windows application if running.