@guidepup/playwright

Guidepup Playwright

Screen-reader driver for Playwright.

Providing a reliable set of APIs to automate your screen-reader a11y workflows in Playwright.

Getting Started 🦮

Install @guidepup/playwright to your project:

npm install --save-dev @guidepup/playwright

And get cracking with your first screen-reader tests in Playwright! 🚀

import { voTest as test } from "@guidepup/playwright";
import { expect } from "@playwright/test";

test.describe("Playwright VoiceOver", () => {
  test("I can navigate the Playwright website using VoiceOver", async ({
    page,
    vo,
  }) => {
    // Navigate to Playwright website 🎉
    await page.goto("https://playwright.dev/", {
      waitUntil: "domcontentloaded",
    });

    // Interact with the page 🙌
    await vo.interact();

    // Move across the navigation menu to the search bar using VoiceOver 🔎
    while (!(await vo.lastSpokenPhrase())?.startsWith("Search")) {
      await vo.next();
    }

    // Search for Safari 👀
    await vo.type("Safari");
    await vo.press("ArrowDown");
    await vo.press("ArrowUp");
    await Promise.all([page.waitForNavigation(), vo.act()]);
    expect(page.url()).toBe("https://playwright.dev/docs/browsers#webkit");
  });
});

Playwright Config 🐕‍🦺

In your playwright.config.ts add the following for the best results with Guidepup for VoiceOver automation. 💥

import { devices, PlaywrightTestConfig } from "@playwright/test";
import { voConfig } from "@guidepup/playwright";

const config: PlaywrightTestConfig = {
  ...voConfig,
  
  // Your custom config ...
};

export default config;

Check out the configuration this adds in the voConfig.ts file. 👀

Environment Setup 🐾

Setup your environment for screen-read automation with @guidepup/setup:

npx @guidepup/setup

If you are using GitHub Actions, check out the dedicated guidepup/setup-action:

- name: Setup Environment
  uses: guidepup/setup-action@0.1.3

See Also 🐶

Checkout the core @guidepup/guidepup project to learn more about how you can automate your screen-reader workflows using Guidepup.

License 🐩

MIT