Repolode
dequelabs

dequelabs/axe-core-npm

A set of npm packages that wire the axe accessibility engine into CLI tools, browser automation frameworks, React, and WebDriver test suites.

Stars
731
Forks
80
Open issues
103
Last commit
11 hours ago

What is it?

axe-core-npm is a monorepo of seven npm packages that run automated accessibility checks powered by the axe-core engine. Each package targets a different place where web tests already run, so accessibility rules can be executed alongside existing end-to-end or component tests.

The packages cover a command-line runner (@axe-core/cli), integrations for Playwright, Puppeteer, WebDriverIO and WebdriverJS, a React helper that reports violations during development, and an EARL reporter for structured output. Developers install the package that matches their tooling and call axe from their test code instead of wiring the engine up by hand.

The project is maintained by Deque Systems and is developed with pnpm, with lint and format scripts at the repository root. Installation, usage and configuration details live in each package's own README.

Key features

  • 01Runs axe-core accessibility rules inside Playwright, Puppeteer, WebDriverIO and WebdriverJS tests.
  • 02Provides a CLI for checking pages directly from the command line.
  • 03Includes a React integration that surfaces accessibility violations during development.
  • 04Offers an EARL reporter for structured accessibility results.

Use cases

  • Adding accessibility assertions to an existing Playwright or Puppeteer end-to-end test suite.
  • Scanning pages from a CI script using the command-line runner.
  • Catching accessibility regressions in React components during local development.

Quick start

  1. 1

    Install dependencies for the monorepo with pnpm

    pnpm install
  2. 2

    Run the linter

    pnpm run lint
  3. 3

    Run the code formatter

    pnpm run fmt
  4. 4

    Follow the README of the specific package you need for installation and usage

Things to know

  • This is a monorepo of wrapper packages, so you must install the separate package that matches your tool.
  • Requires the pnpm package manager for local development.

In collections

Topics

FAQ

What is axe-core-npm?
A set of npm packages that wire the axe accessibility engine into CLI tools, browser automation frameworks, React, and WebDriver test suites. axe-core-npm is a monorepo of seven npm packages that run automated accessibility checks powered by the axe-core engine. Each package targets a different place where web tests already run, so accessibility rules can be executed alongside existing end-to-end or component tests.
Is axe-core-npm free to use? What license does it have?
axe-core-npm is open source under the MPL-2.0 license. Check the license terms before using it in commercial products.
Is axe-core-npm still maintained?
Actively maintained. The last commit to axe-core-npm was on Nov 6, 2026.
What can I use axe-core-npm for?
Adding accessibility assertions to an existing Playwright or Puppeteer end-to-end test suite. Scanning pages from a CI script using the command-line runner. Catching accessibility regressions in React components during local development.
How do I install axe-core-npm?
Install dependencies for the monorepo with pnpm: pnpm install Run the linter: pnpm run lint Run the code formatter: pnpm run fmt Follow the README of the specific package you need for installation and usage
Where can I get axe-core-npm?
The source code and installation instructions are on GitHub: https://github.com/dequelabs/axe-core-npm

Summary generated by AI from the project's README. GitHub stats refresh daily.

Related projects