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 automation testing.

Guidepup aims to provide a reliable set of APIs to allow users to automate the usage of screen-readers through JavaScript.

Getting Started

import { VoiceOver } from "@guidepup/guidepup";

async function run(): Promise<void> {
  const vo = new VoiceOver();
  await vo.start();
  await vo.moveNext();
  console.log(await vo.getLastSpokenPhrase());
  await vo.stop();
}

run();

Installation

Install Guidepup with npm or yarn:

# npm
npm install @guidepup/guidepup

# yarn
yarn add @guidepup/guidepup

Guides

API Documentation

Examples

Roadmap

Screen-reader support:

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

Environment support:

MacOS local machine
MacOS virtual machine
Windows local machine
Windows virtual machine

Building on the shoulders of giants!

Here are some related projects:

License

MIT

@guidepup/guidepup