Support matrix
Guidepup currently supports the following screen readers:
- NVDA for Windows
- Orca for Linux
- VoiceOver for macOS
- Virtual Screen Reader for DOM environments (when using the
@guidepup/virtual-screen-readerpackage)
Runtime compatibility
Each release of @guidepup/guidepup includes a manifest.json that specifies the screen reader assets it supports. The npx @guidepup/setup install command reads the manifest from your installed package and selects the correct asset for the runner it is executing on.
The current manifest supports:
| Screen reader | Platform | Supported versions |
|---|---|---|
| NVDA | Windows | The manifest provides default NVDA assets for Windows. |
| Orca | Linux | The manifest provides default Orca assets for Linux. Linux kernel version 7, Ubuntu 26.04 and Debian 13. |
| VoiceOver | macOS | macOS 12 (Monterey), macOS 13 (Ventura), macOS 14 (Sonoma), macOS 15 (Sequoia), macOS 26 (Tahoe), macOS 27 (Golden Gate). |
The manifest changes with Guidepup releases. After upgrading @guidepup/guidepup, rerun npx @guidepup/setup install to download the assets supported by that release.
NVDA
NVDA allows blind and vision impaired people to access and interact with the Windows operating system and many third party applications.
Please refer to the NVDA User Guide system requirements to ensure your system can support the application.
To learn NVDA commands please refer to the following popular guides:
- NVDA 2026.1 Commands Quick Reference
- WebAIM Keyboard Shortcuts for NVDA
- Deque University NVDA Keyboard Shortcuts
Orca
Orca is the free, open-source screen reader for the GNOME desktop.
To learn Orca commands please refer to GNOME Orca screen reader help website.
VoiceOver
VoiceOver is an advanced screen-reading technology integrated into the Mac OS X operating system. VoiceOver enables users with visual disabilities to control their computer using a rich set of keyboard commands and gestures. This chapter provides an overview of VoiceOver and key topics such as the VoiceOver cursor and current focus, keyboard shortcuts, and using function keys on some keyboards.
To learn VoiceOver commands please refer to the following popular guides:
Virtual Screen Reader
The Guidepup Virtual Screen Reader is a headless screen reader for unit test automation.
- Mirrors Screen Reader Functionality - simulate and assert on what users can do when using screen readers.
- Test Framework Agnostic - run with Jest, Vitest, Web Test Runner, in Storybook, as an independent script, no vendor lock-in.
- UI Framework Agnostic - want to use React, Vue, Solid, Svelte, etc.? All good here! Works with any UI framework, and plays nicely with the Testing Library suite.
- Fast Feedback - avoid the cumbersome overhead of running an e2e test with a real screen reader by running virtually over the provided DOM.
Important
This package should not replace but augment your screen reader testing, there is no substitute for testing with real screen readers and with real users.