Pa11y

Pa11y is your automated accessibility testing pal. It runs accessibility tests on your pages via the command line or Node.js, so you can automate your testing process.

On the command line:

1pa11y https://example.com

In JavaScript:

1const pa11y = require('pa11y');
2
3pa11y('https://example.com').then((results) => {
4    // Use the results
5});

Requirements

Pa11y 8 requires Node.js 18 or 20. An older version of Node.js can be used with Pa11y 6 or below.

Linux and macOS

To install Node.js you can use nvm. For example, to install with nvm with Homebrew, and then install the latest version of Node:

1brew install nvm
2nvm install node
3nvm install-latest-npm

Alternatively, download a pre-built package from the Node.js website for your operating system.

Windows

On Windows 10, download a pre-built package from the Node.js website. Pa11y will be usable via the bundled Node.js application as well as the Windows command prompt.

Command-line interface

Install Pa11y globally with npm:

1npm install -g pa11y

1$ pa11y --help
2
3Usage: pa11y [options] <url>
4
5  Options:
6
7    -V, --version                  output the version number
8    -n, --environment              output details about the environment Pa11y will run in
9    -s, --standard <name>          the accessibility standard to use: WCAG2A, WCAG2AA (default), WCAG2AAA – only used by htmlcs runner
10    -r, --reporter <reporter>      the reporter to use: cli (default), csv, json
11    -e, --runner <runner>          the test runners to use: htmlcs (default), axe
12    -l, --level <level>            the level of issue to fail on (exit with code 2): error, warning, notice
13    -T, --threshold <number>       permit this number of errors, warnings, or notices, otherwise fail with exit code 2
14    -i, --ignore <ignore>          types and codes of issues to ignore, a repeatable value or separated by semi-colons
15    --include-notices              Include notices in the report
16    --include-warnings             Include warnings in the report
17    -R, --root-element <selector>  a CSS selector used to limit which part of a page is tested
18    -E, --hide-elements <hide>     a CSS selector to hide elements from testing, selectors can be comma separated
19    -c, --config <path>            a JSON or JavaScript config file
20    -t, --timeout <ms>             the timeout in milliseconds
21    -w, --wait <ms>                the time to wait before running tests in milliseconds
22    -d, --debug                    output debug messages
23    -S, --screen-capture <path>    a path to save a screen capture of the page to
24    -A, --add-rule <rule>          WCAG 2.1 rules to include, a repeatable value or separated by semi-colons – only used by htmlcs runner
25    -h, --help                     output usage information

Testing with pa11y

Find accessibility issues at a URL:

1pa11y https://example.com

The default test runner is HTML_CodeSniffer, but axe is also supported. To use axe:

1pa11y https://example.com --runner axe

Use both axe and HTML_CodeSniffer in the same run:

1pa11y https://example.com --runner axe --runner htmlcs

Generate results in CSV format, and output to a file, report.csv:

1pa11y https://example.com > report.csv --reporter csv 

Find accessibility issues in a local HTML file (absolute paths only, not relative):

1pa11y ./path/to/your/file.html

Exit codes

The command-line tool uses the following exit codes:

• 0: Pa11y ran successfully, and there are no errors
• 1: Pa11y failed run due to a technical fault
• 2: Pa11y ran successfully but there are errors in the page

By default, only accessibility issues with a type of error will exit with a code of 2. This is configurable with the --level flag which can be set to one of the following:

• error: exit with a code of 2 on errors only, exit with a code of 0 on warnings and notices
• warning: exit with a code of 2 on errors and warnings, exit with a code of 0 on notices
• notice: exit with a code of 2 on errors, warnings, and notices
• none: always exit with a code of 0

Command-line configuration

The command-line tool can be configured with a JSON file as well as arguments. By default it will look for a pa11y.json file in the current directory, but you can change this with the --config flag:

1pa11y https://example.com --config ./path/to/config.json 

If any configuration is set both in a configuration file and also as a command-line option, the value set in the latter will take priority.

For more information on configuring Pa11y, see the configuration documentation.

Ignoring

The ignore flag can be used in several different ways. Separated by semi-colons:

1pa11y https://example.com --ignore "issue-code-1;issue-code-2" 

or by using the flag multiple times:

1pa11y https://example.com --ignore issue-code-1 --ignore issue-code-2 

Pa11y can also ignore notices, warnings, and errors up to a threshold number. This might be useful if you're using CI and don't want to break your build. The following example will return exit code 0 on a page with 9 errors, and return exit code 2 on a page with 10 or more errors.

1pa11y https://example.com --threshold 10 

Reporters

The command-line tool can provide test results in a few different ways using the --reporter flag. The built-in reporters are:

• cli: output test results in a human-readable format
• csv: output test results as comma-separated values
• html: output test results as an HTML page
• json: output test results as a JSON array
• tsv: output test results as tab-separated values

You can also write and publish your own reporters. Pa11y looks for reporters in your node_modules folder (with a naming pattern), and the current working directory. The first reporter found will be loaded. So with this command:

1pa11y https://example.com --reporter rainbows 

The following locations will be checked:

1<cwd>/node_modules/pa11y-reporter-rainbows
2<cwd>/rainbows

A Pa11y reporter must export a string property named supports. This is a semver range which indicates which versions of Pa11y the reporter supports:

1exports.supports = '^8.0.0';

A reporter should export the following methods, each returning one string. If your reporter needs to perform asynchronous operations, then it may return a promise which resolves to a string:

1begin(); // Called when pa11y starts
2error(message); // Called when a technical error is reported
3debug(message); // Called when a debug message is reported
4info(message); // Called when an information message is reported
5results(results); // Called with a test run's results

JavaScript interface

Add Pa11y to your project with npm, most commonly as a development dependency:

1npm install pa11y --save-dev

Require Pa11y:

1const pa11y = require('pa11y');

Run Pa11y against a URL, the pa11y function returns a Promise:

1pa11y(url).then((results) => {
2    // Use the results
3});

Pa11y can also be run with options:

1const options = { /* ... */ };
2pa11y(url, options)).then((results) => {
3    // Use the results
4});

Pa11y resolves with a results object, containing details about the page, and an array of accessibility issues found by the test runner:

1{
2    pageUrl: 'The tested URL',
3    documentTitle: 'Title of the page under test',
4    issues: [
5        {
6            code: 'WCAG2AA.Principle1.Guideline1_1.1_1_1.H30.2',
7            context: '<a href="https://example.com/"><img src="example.jpg" alt=""/></a>',
8            message: 'Img element is the only content of the link, but is missing alt text. The alt text should describe the purpose of the link.',
9            selector: 'html > body > p:nth-child(1) > a',
10            type: 'error',
11            typeCode: 1
12        }
13    ]
14}

Transforming the results

If you wish to transform these results with a command-line reporter, require it into your code. The csv, tsv, html, json, and markdown reporters each expose a method process:

1// Assuming you've already run tests, and the results
2// are available in a `results` variable:
3const htmlReporter = require('pa11y/lib/reporters/html');
4const html = await htmlReporter.results(results);

async/await

Pa11y uses promises, so you can use async functions and the await keyword:

1async function runPa11y() {
2    try {
3        const results = await pa11y(url);
4        // Use the results
5    }
6    catch (error) {
7        // Handle error
8    }
9}
10
11runPa11y();

Callback interface

For those who prefer callbacks to promises:

1pa11y(url, (error, results) => {
2    // Use results, handle error
3});

Validating actions

Pa11y's isValidAction function can be used to validate an action string ahead of its use:

1pa11y.isValidAction('click element #submit');  // true
2pa11y.isValidAction('open the pod bay doors'); // false

Configuration

Pa11y has lots of options you can use to change the way Headless Chrome runs, or the way your page is loaded. Options can be set either as a parameter on the pa11y function or in a JSON configuration file. Some are also available directly as command-line options.

Below is a reference of all the options that are available:

actions (array)

Actions to be run before Pa11y tests the page. There are quite a few different actions available in Pa11y, the Actions documentation outlines each of them.

1pa11y(url, {
2    actions: [
3        'set field #username to exampleUser',
4        'set field #password to password1234',
5        'click element #submit',
6        'wait for path to be /myaccount'
7    ]
8});

Defaults to an empty array.

browser (Browser) and page (Page)

A Puppeteer Browser instance which will be used in the test run. Optionally you may also supply a Puppeteer Page instance, but this cannot be used between test runs as event listeners would be bound multiple times.

If either of these options are provided then there are several things you need to consider:

1. Pa11y's chromeLaunchConfig option will be ignored, you'll need to pass this configuration in when you create your Browser instance
2. Pa11y will not automatically close the Browser when the tests have finished running, you will need to do this yourself if you need the Node.js process to exit
3. It's important that you use a version of Puppeteer that meets the range specified in Pa11y's package.json
4. You cannot reuse page instances between multiple test runs, doing so will result in an error. The page option allows you to do things like take screen-shots on a Pa11y failure or execute your own JavaScript before Pa11y

Note: This is an advanced option. If you're using this, please mention in any issues you open on Pa11y and double-check that the Puppeteer version you're using matches Pa11y's.

1const browser = await puppeteer.launch({
2    ignoreHTTPSErrors: true
3});
4
5pa11y(url, {
6    browser: browser
7});
8
9browser.close();

A more complete example can be found in the puppeteer examples.

Defaults to null.

chromeLaunchConfig (object)

Launch options for the Headless Chrome instance. See the Puppeteer documentation for more information.

1pa11y(url, {
2    chromeLaunchConfig: {
3        executablePath: '/path/to/Chrome',
4        ignoreHTTPSErrors: false
5    }
6});

Defaults to:

1{
2    ignoreHTTPSErrors: true
3}

headers (object)

A key-value map of request headers to send when testing a web page.

1pa11y(url, {
2    headers: {
3        Cookie: 'foo=bar'
4    }
5});

Defaults to an empty object.

hideElements (string)

A CSS selector to hide elements from testing, selectors can be comma separated. Elements matching this selector will be hidden from testing by styling them with visibility: hidden.

1pa11y(url, {
2    hideElements: '.advert, #modal, div[aria-role=presentation]'
3});

ignore (array)

An array of result codes and types that you'd like to ignore. You can find the codes for each rule in the console output and the types are error, warning, and notice. Note: warning and notice messages are ignored by default.

1pa11y(url, {
2    ignore: [
3        'WCAG2AA.Principle3.Guideline3_1.3_1_1.H57.2'
4    ]
5});

Defaults to an empty array.

ignoreUrl (boolean)

Whether to use the provided Puppeteer Page instance as is or use the provided url. Both the Puppeteer Page instance and the Puppeteer Browser instance are required alongside ignoreUrl.

1const browser = await puppeteer.launch();
2const page = await browser.newPage();
3
4pa11y(url, {
5    ignoreUrl: true,
6    page: page,
7    browser: browser
8});

Defaults to false.

includeNotices (boolean)

Whether to include results with a type of notice in the Pa11y report. Issues with a type of notice are not directly actionable and so they are excluded by default. You can include them by using this option:

1pa11y(url, {
2    includeNotices: true
3});

Defaults to false.

includeWarnings (boolean)

Whether to include results with a type of warning in the Pa11y report. Issues with a type of warning are not directly actionable and so they are excluded by default. You can include them by using this option:

1pa11y(url, {
2    includeWarnings: true
3});

Defaults to false.

level (string)

The level of issue which can fail the test (and cause it to exit with code 2) when running via the CLI. This should be one of error (the default), warning, or notice.

1{
2    "level": "warning"
3}

Defaults to error. Note this configuration is only available when using Pa11y on the command line, not via the JavaScript Interface.

log (object)

An object which implements the methods debug, error, and info which will be used to report errors and test information.

1pa11y(url, {
2    log: {
3        debug: console.log,
4        error: console.error,
5        info: console.info
6    }
7});

Each of these defaults to an empty function.

method (string)

The HTTP method to use when running Pa11y.

1pa11y(url, {
2    method: 'POST'
3});

Defaults to GET.

postData (string)

The HTTP POST data to send when running Pa11y. This should be combined with a Content-Type header. E.g to send form data:

1pa11y(url, {
2    headers: {
3        'Content-Type': 'application/x-www-form-urlencoded'
4    },
5    method: 'POST',
6    postData: 'foo=bar&bar=baz'
7});

Or to send JSON data:

1pa11y(url, {
2    headers: {
3        'Content-Type': 'application/json'
4    },
5    method: 'POST',
6    postData: '{"foo": "bar", "bar": "baz"}'
7});

Defaults to null.

reporter (string)

The reporter to use while running the test via the CLI. More about reporters.

1{
2    "reporter": "json"
3}

Defaults to cli. Note this configuration is only available when using Pa11y on the command line, not via the JavaScript Interface.

rootElement (element)

The root element for testing a subset of the page opposed to the full document.

1pa11y(url, {
2    rootElement: '#main'
3});

Defaults to null, meaning the full document will be tested. If the specified root element isn't found, the full document will be tested.

runners (array)

An array of runner names which correspond to existing and installed Pa11y runners. If a runner is not found then Pa11y will error.

1pa11y(url, {
2    runners: [
3        'axe',
4        'htmlcs'
5    ]
6});

Defaults to:

1[
2    'htmlcs'
3]

rules (array)

An array of WCAG 2.1 guidelines that you'd like to include to the current standard. You can find the codes for each guideline in the HTML Code Sniffer WCAG2AAA ruleset. Note: only used by htmlcs runner.

1pa11y(url, {
2    rules: [
3        'Principle1.Guideline1_3.1_3_1_AAA'
4    ]
5});

screenCapture (string)

A file path to save a screen capture of the tested page to. The screen will be captured immediately after the Pa11y tests have run so that you can verify that the expected page was tested.

1pa11y(url, {
2    screenCapture: `${__dirname}/my-screen-capture.png`
3});

Defaults to null, meaning the screen will not be captured. Note the directory part of this path must be an existing directory in the file system – Pa11y will not create this for you.

standard (string)

The accessibility standard to use when testing pages. This should be one of WCAG2A, WCAG2AA, or WCAG2AAA. Note: only used by htmlcs runner.

1pa11y(url, {
2    standard: 'WCAG2A'
3});

Defaults to WCAG2AA.

threshold (number)

The number of errors, warnings, or notices to permit before the test is considered to have failed (with exit code 2) when running via the CLI.

1{
2    "threshold": 9
3}

Defaults to 0. Note this configuration is only available when using Pa11y on the command line, not via the JavaScript Interface.

timeout (number)

The time in milliseconds that a test should be allowed to run before calling back with a timeout error.

Please note that this is the timeout for the entire test run (including time to initialise Chrome, load the page, and run the tests).

1pa11y(url, {
2    timeout: 500
3});

Defaults to 30000.

userAgent (string)

The User-Agent header to send with Pa11y requests. This is helpful to identify Pa11y in your logs.

1pa11y(url, {
2    userAgent: 'A11Y TESTS'
3});

Defaults to pa11y/<version>.

viewport (object)

The viewport configuration. This can have any of the properties supported by the puppeteer setViewport method.

1pa11y(url, {
2    viewport: {
3        width: 320,
4        height: 480,
5        deviceScaleFactor: 2,
6        isMobile: true
7    }
8});

Defaults to:

1{
2    width: 1280,
3    height: 1024
4}

wait (number)

The time in milliseconds to wait before running HTML_CodeSniffer on the page.

1pa11y(url, {
2    wait: 500
3});

Defaults to 0.

Actions

Actions are additional interactions that you can make Pa11y perform before the tests are run. They allow you to do things like click on a button, enter a value in a form, wait for a redirect, or wait for the URL fragment to change:

1pa11y(url, {
2    actions: [
3        'click element #tab-1',
4        'wait for element #tab-1-content to be visible',
5        'set field #fullname to John Doe',
6        'clear field #middlename',
7        'check field #terms-and-conditions',
8        'uncheck field #subscribe-to-marketing',
9        'screen capture example.png',
10        'wait for fragment to be #page-2',
11        'wait for path to not be /login',
12        'wait for url to be https://example.com/',
13        'wait for #my-image to emit load',
14        'navigate to https://another-example.com/'
15    ]
16});

Below is a reference of all the available actions and what they do on the page. Some of these take time to complete so you may need to increase the timeout option if you have a large set of actions.

click element <selector>

Clicks an element:

1pa11y(url, {
2    actions: [
3        'click element #tab-1'
4    ]
5});

You can use any valid query selector, including classes and types.

set field <selector> to <value>

Sets the value of a text-based input or select:

1pa11y(url, {
2    actions: [
3        'set field #fullname to John Doe'
4    ]
5});

clear field <selector>

Clears the value of a text-based input or select:

1pa11y(url, {
2    actions: [
3        'clear field #middlename'
4    ]
5});

check field <selector>, uncheck field <selector>

Checks/unchecks an input of type radio or checkbox:

1pa11y(url, {
2    actions: [
3        'check field #terms-and-conditions',
4        'uncheck field #subscribe-to-marketing'
5    ]
6});

screen capture <to-file-path.png>

Captures the screen, saving the image to a file, which can be useful between actions for debugging, or just for visual reassurance:

1pa11y(url, {
2    actions: [
3        'screen capture example.png'
4    ]
5});

wait for

wait for <fragment|path|url>

This allows you to pause the test until a condition is met, and the page has either a given fragment, path, or URL. This will wait until Pa11y times out so it should be used after another action that would trigger the change in state. You can also wait until the page does not have a given fragment, path, or URL using the to not be syntax. This action takes one of the forms:

• wait for fragment to be <fragment> (including the preceding #)
• wait for fragment to not be <fragment> (including the preceding #)
• wait for path to be <path> (including the preceding /)
• wait for path to not be <path> (including the preceding /)
• wait for url to be <url>
• wait for url to not be <url>

E.g.

1pa11y(url, {
2    actions: [
3        'click element #login-link',
4        'wait for path to be /login'
5    ]
6});

wait for element's state

This allows you to pause the test until an element on the page (matching a CSS selector) is either added, removed, visible, or hidden. This will wait until Pa11y times out so it should be used after another action that would trigger the change in state. This action takes one of the forms:

• wait for element <selector> to be added
• wait for element <selector> to be removed
• wait for element <selector> to be visible
• wait for element <selector> to be hidden

E.g.

1pa11y(url, {
2    actions: [
3        'click element #tab-2',
4        'wait for element #tab-1 to be hidden'
5    ]
6});

wait for element's event

This allows you to pause the test until an element on the page (matching a CSS selector) emits an event. This will wait until Pa11y times out so it should be used after another action that would trigger the event. This action takes the form wait for element <selector> to emit <event-type>. E.g.

1pa11y(url, {
2    actions: [
3        'click element #tab-2',
4        'wait for element #tab-panel-to to emit content-loaded'
5    ]
6});

navigate to <url>

This action allows you to navigate to a new URL if, for example, the URL is inaccessible using other methods. This action takes the form navigate to <url>. E.g.

1pa11y(url, {
2    actions: [
3        'navigate to https://another-example.com'
4    ]
5});

Runners

Pa11y supports multiple test runners which return different results. The built-in options are:

• axe: run tests using axe-core.
• htmlcs (default): run tests using HTML_CodeSniffer

You can also write and publish your own runners. Pa11y looks for runners in your node_modules folder (with a naming pattern), and the current working directory. The first runner found will be loaded. So with this command:

1pa11y https://example.com --runner custom-tool

The following locations will be checked:

1<cwd>/node_modules/pa11y-runner-custom-tool
2<cwd>/node_modules/custom-tool
3<cwd>/custom-tool

A Pa11y runner must export a string property named supports. This is a semver range which indicates which versions of Pa11y the runner supports:

1exports.supports = '^8.0.0';

A Pa11y runner must export a property named scripts. This is an array of strings which are paths to scripts which need to load before the tests can be run. This may be empty:

1exports.scripts = [
2    `${__dirname}/vendor/example.js`
3];

A runner must export a run method, which returns a promise that resolves with test results (it's advisable to use an async function). The run method is evaluated in a browser context and so has access to a global window object.

The run method must not use anything that's been imported using require, as it's run in a browser context. Doing so will error.

The run method is called with two arguments:

• options: Options specified in the test runner
• pa11y: The Pa11y test runner, which includes some helper methods:
  • pa11y.getElementContext(element): Get a short HTML context snippet for an element
  • pa11y.getElementSelector(element): Get a unique selector with which you can select this element in a page

The run method must resolve with an array of Pa11y issues. These follow the format:

1{
2    code: '123', // An identifier for this error
3    element: {}, // The HTML element this issue relates to; `null` if no element is involved
4    message: 'example', // A description of the issue
5    type: 'error', // 'error', 'warning', or 'notice'
6    runnerExtras: {} // Additional data a runner is free to provide; unused by Pa11y itself
7}

Examples

Basic example

Run Pa11y on a URL and output the results. See the example.

Multiple URLs example

Run Pa11y on multiple URLs at once and output the results. See the example.

Actions example

Step through some actions before Pa11y runs. This example logs into a fictional site then waits until the account page has loaded before running Pa11y. See the example.

Puppeteer example

Pass in pre-created Puppeteer browser and page instances so that you can reuse them between tests. See the example.

Common questions and troubleshooting

See our Troubleshooting guide to get the answers to common questions about Pa11y, along with some ideas to help you troubleshoot any problems.

Tutorials and articles

You can find some useful tutorials and articles in the Tutorials section of pa11y.org.

Contributing

There are many ways to contribute to Pa11y, some of which we describe in the contributing guide for this repo.

If you're ready to contribute some code, clone this repo, commit your code to a new branch, then create a pull request to bring your changes into main. If you're an external contributor, fork this repo first, then follow the same process.

Please write unit tests for your code, and check that everything works by running the following before opening a pull request:

1npm run lint                # Lint the code
2npm test                    # Run every test, reporting coverage

You can also run test suites individually:

1npm run test-unit           # Run the unit tests alone
2npm run test-integration    # Run the integration tests alone
3npm run test-coverage       # Run the unit tests alone, reporting coverage

Support and migration

[!TIP] We maintain a migration guide to help you migrate between major versions.

When we release a new major version we will continue to support the previous major version for 6 months. This support will be limited to fixes for critical bugs and security issues. If you're opening an issue related to this project, please mention the specific version that the issue affects.

The following table lists the major versions available and, for each previous major version, its end-of-support date, and its final minor version released.

Major version	Final minor version	Node.js support	Puppeteer version	Support end date
8		18, 20	^22	✅ Current major version
7	7.0	18, 20	^20	October 2024
6	6.2	12, 14, 16	~9.1	July 2024
5	5.3	8, 10, 12	^1	2021-11-25
4	4.13	4, 6, 8		2018-08-15
3	3.8	0.12, 4		2016-12-05
2	2.4	0.10, 0.12		2016-10-16
1	1.7	0.10		2016-06-08

License

Pa11y is licensed under the Lesser General Public License (LGPL-3.0-only).
Copyright © 2013-2024, Team Pa11y and contributors