@guidepup/guidepup

screen-reader driver for automation testing

0.9.1
Source
npm

Version published: 3 years ago

Maintainers: 1

Created: 3 years ago

Source

Guidepup

Screen-reader driver for automation.

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

Getting Started

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> {
  // Construct and start your screen-reader instance 🎉
  const vo = new VoiceOver();
  await vo.start();

  // Navigate your environment with screen-readers just as your users do 🏎
  await vo.moveNext();

  // Assert on what your users really see and hear when using screen-readers 👂
  console.log(await vo.getLastSpokenPhrase());

  await vo.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

Want to dive in? 🤿

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

Roadmap

Screen-reader support:

VoiceOver on MacOS
NVDA on Windows (WIP)
VoiceOver on iOS
Talkback on Android

Environment support:

Building on the shoulders of giants! 🙌

Here are some related projects:

License

MIT

Keywords

FAQs

What is @guidepup/guidepup?

Is @guidepup/guidepup well maintained?

Package last updated on 08 Jan 2022

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.

Install