Package Exports

@guidepup/guidepup
@guidepup/guidepup/lib/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@guidepup/guidepup) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Guidepup

Screen reader driver for test automation.

Providing a reliable set of APIs to automate your screen reader a11y workflows through JavaScript.

Getting Started

Setup 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 function run(): Promise<void> {
  // 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());

  await voiceOver.stop();
}

run();

Guides

Check out these fab guides on how to set up your local or CI environments for using Guidepup.

Examples

Check out these awesome examples to learn how you could use Guidepup in your projects.

API Documentation

The API documentation has all the information you need to write fantastic screen reader driven workflows.

Roadmap

Screen reader support:

VoiceOver on MacOS - Done
NVDA on Windows - WIP
VoiceOver on iOS - TBD
Talkback on Android - TBD

Building on the shoulders of giants!

Here are some related projects:

License

MIT

@guidepup/guidepup