@axe-core/Playwright
Official Axe integration packages for automated accessibility testing in Playwright, Puppeteer, React, WebdriverIO, and CLI.
What is @axe-core/Playwright?
axe-core-npm is a collection of official npm packages that integrate the axe-core accessibility testing engine with popular web development and testing frameworks like Playwright, Puppeteer, React, and WebdriverIO. It enables automated accessibility testing to identify and fix accessibility issues in web applications during development and testing phases.
Web developers, QA engineers, and accessibility specialists who use modern testing frameworks like Playwright, Puppeteer, React, or WebdriverIO and want to incorporate automated accessibility checks into their workflows.
Developers choose axe-core-npm because it provides official, maintained integrations with leading testing frameworks, ensuring reliable and consistent accessibility testing that aligns with axe-core's zero false-positive philosophy and supports mainstream adoption of accessibility practices.
Overview
axe-core-npm is a collection of official npm packages that integrate the axe-core accessibility testing engine with popular web development and testing frameworks. It enables developers to incorporate automated accessibility checks directly into their testing workflows, helping to identify and fix accessibility issues early in the development process.
Key Features
- Playwright Integration — Run axe-core accessibility tests within Playwright test suites.
- Puppeteer Integration — Integrate accessibility testing into Puppeteer automation scripts.
- React Integration — Test React components for accessibility violations during development.
- WebdriverIO Integration — Add accessibility checks to WebdriverIO end-to-end tests.
- CLI Tool — Run accessibility tests from the command line on live websites or static files.
- Earl Reporter — Generate EARL (Evaluation and Report Language) reports for standardized accessibility test results.
- WebdriverJS Support — Legacy integration for WebDriverJS-based testing frameworks.
Philosophy
The project believes automated accessibility testing must achieve mainstream adoption by being trustworthy, fast, universally compatible, and widely available to promote digital equality.
Use Cases
Best For
- Adding automated accessibility tests to Playwright test suites
- Integrating accessibility checks into Puppeteer automation scripts
- Testing React components for accessibility violations during development
- Running accessibility tests from the command line on websites
- Incorporating accessibility testing into WebdriverIO end-to-end tests
- Generating standardized EARL reports for accessibility test results
Not Ideal For
- Projects using testing frameworks not directly supported, such as Cypress or Selenium without WebdriverIO
- Teams requiring comprehensive accessibility audits that include manual or visual testing, as this is purely automated
- Environments where false positives are acceptable or preferred for exploratory testing, due to axe-core's strict zero false-positive rule
- Developers seeking an all-in-one tool with unified documentation, since setup requires referring to multiple package-specific READMEs
Pros & Cons
Pros
Provides maintained npm packages for popular tools like Playwright, Puppeteer, React, and WebdriverIO, ensuring reliability and compatibility as listed in the README.
Adheres to a manifesto with a zero false positive rate, making automated tests trustworthy and reducing noise in development workflows.
Designed to work in all modern browsers, supporting universal testing as stated in the project philosophy for mainstream adoption.
Built to be performant with lightweight rules, enabling seamless integration into testing suites without significant slowdowns.
Includes an EARL reporter for generating Evaluation and Report Language outputs, facilitating consistent accessibility test results.
Cons
Limited to specific frameworks like Playwright and React, missing direct integrations for others such as Vue.js or Angular, which may require custom setups.
The main README points to separate READMEs for each package, making it harder to find consolidated installation and usage information.
Cannot catch all accessibility issues, such as those requiring user interaction or visual context, potentially leading to over-reliance without manual audits.
Each integration requires individual setup and configuration, adding complexity compared to more unified testing solutions.
Frequently Asked Questions
Related Projects
artillery-engine-playwrightThe complete load testing platform. Everything you need for production-grade load tests. Serverless & distributed. Load test with Playwright. Load test HTTP APIs, GraphQL, WebSocket, and more. Use any Node.js module.
CodeceptJSSupercharged End 2 End Testing Framework for NodeJS
playwright-bddBDD testing with Playwright runner
Playwright CRXPlaywright for chrome extensions
Found a gem we're missing?
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.