@guidepup/guidepup
Advanced tools
Screen reader driver for test automation.
Reliable automation for your screen reader a11y workflows through JavaScript supporting:
A11y static analysis tools only cover 25% of WCAG and don't assure on the quality of the user experience for screen reader users. This means teams need to perform lots of manual tests with multiple screen readers to ensure great UX which can take a lot of time... not anymore!
With Guidepup you can automate your screen reader test workflows the same you as would for mouse or keyboard based scenarios, no sweat!
Set up your environment for screen reader automation with @guidepup/setup:
npx @guidepup/setup
Install Guidepup to your project:
npm install @guidepup/guidepup
And get cracking with your first screen reader automation code!
import { voiceOver } from "@guidepup/guidepup";
(async () => {
// Start your screen reader instance
await voiceOver.start();
// Navigate your environment with screen readers just as your users do
await voiceOver.next();
// Assert on what your users really see and hear when using screen readers
console.log(await voiceOver.lastSpokenPhrase());
// Stop your screen reader instance
await voiceOver.stop();
})();
Head over to the Guidepup Website for guides, real world examples, environment setup, and complete API documentation with examples.
Alternatively, you can also check out the typedoc API documentation.
Check out these awesome examples to learn how you could use Guidepup in your projects.
Alternatively check out this project to check out the Guidepup compatibility against https://github.com/w3c/aria-at test suite.
Check out some of the other Guidepup modules:
@guidepup/setup - set up your local or CI environment for screen reader test automation.@guidepup/playwright - seemless integration of Guidepup with Playwright.@guidepup/virtual-screen-reader - reliable unit testing for your screen reader a11y workflows.@guidepup/jest - jest matchers for reliable unit testing of your screen reader a11y workflows.If you are using GitHub Actions, check out the dedicated guidepup/setup-action to set up your CI ready for screen reader automation.
- name: Set Up Environment
uses: guidepup/setup-action
Full support is available for:
Here are some similar unaffiliated projects:
@accesslint/voiceoverscreen-reader-readerweb-test-runner-voiceovernvda-testing-driverassistive-webdriverscreen-reader-testing-libraryFAQs
Screen reader driver for test automation.
The npm package @guidepup/guidepup receives a total of 3,039 weekly downloads. As such, @guidepup/guidepup popularity was classified as popular.
We found that @guidepup/guidepup demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Critics call the Node.js EOL CVE a misuse of the system, sparking debate over CVE standards and the growing noise in vulnerability databases.
Security News
cURL and Go security teams are publicly rejecting CVSS as flawed for assessing vulnerabilities and are calling for more accurate, context-aware approaches.
Security News
Bun 1.2 enhances its JavaScript runtime with 90% Node.js compatibility, built-in S3 and Postgres support, HTML Imports, and faster, cloud-first performance.