pa11y is your automated accessibility testing pal
pa11y is your automated accessibility testing pal. It runs HTML CodeSniffer from the command line for programmatic accessibility reporting.
On the command line:
var pa11y = require'pa11y';var test = pa11yoptions;testrun'nature.com'/* ... */;
✨ 🔜 ✨ The Pa11y team is very excited to announce plans for the successor to pa11y-dashboard and pa11y-webservice, codename "Sidekick". Help us define the features that you want to see by visiting the proposal. ✨
On a Mac, you can install the required dependencies with Homebrew:
$ brew install node$ brew install phantomjs
Depending on your flavour of Linux, you should be able to use a package manager to install the required dependencies. Alternatively download pre-built packages from the Node.js and PhantomJS websites.
Windows users approach with caution – we've been able to get pa11y running (Windows 7, Node 0.12) but only after installing Visual Studio and the Windows SDK (as well as Git, Python and PhantomJS). The Windows installation instructions for node-gyp are a good place to start.
If you run into following error:
Error: spawn phantomjs ENOENTat exports._errnoException (util.js:874:11)at Process.ChildProcess._handle.onexit (internal/child_process.js:178:32)at onErrorNT (internal/child_process.js:344:16)at doNTCallback2 (node.js:439:9)at process._tickCallback (node.js:353:17)at Function.Module.runMain (module.js:469:11)at startup (node.js:134:18)at node.js:961:3
follow these steps:
Install PhantomJS@v2.0 via npm
npm install -g phantomjs2
%APPDATA%\AppData\Roaming\npm\node_modules\phantomjs2\lib\phantom\bin and copy
Install pa11y globally with npm:
npm install -g pa11y
This installs the
pa11y command-line tool:
Run an accessibility test against a URL:
Run an accessibility test against a file:
Run a test with CSV reporting and save to a file:
pa11y --reporter csv nature.com > report.csv
Run pa11y with the Section508 ruleset:
pa11y --standard Section508 nature.com
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
2on errors only, exit with a code of
0on warnings and notices
warning: exit with a code of
2on errors and warnings, exit with a code of
notice: exit with a code of
2on errors, warnings, and notices
none: always exit with a code of
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
pa11y --config ./path/to/config.json nature.com
For more information on configuring pa11y, see the configuration documentation.
The ignore flag can be used in several different ways. Seperated by semi-colons:
pa11y --ignore "warning;notice" nature.com
or by using the flag mutiple times:
pa11y --ignore warning --ignore notice nature.com
The command-line tool can report 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 document
json: output test results as a JSON array
markdown: output test results as a Markdown document
You can also write and publish your own reporters. Pa11y looks for reporters in the core library, your
node_modules folder (with a naming pattern), and the current working directory. The first reporter found will be loaded. So with this command:
pa11y --reporter rainbows nature.com
The following locations will be checked:
A pa11y reporter should export the following methods, and these should make use of
console to send output:
beginurl; // Called when pa11y startserrormessage; // Called when a technical error is reporteddebugmessage; // Called when a debug message is reportedinfomessage; // Called when an information message is reportedresultsresultsArray url; // Called with the results of a test run
Reporters may also optionally export a
process method. This should accept the same arguments as the
results method but return the processed results rather than outputting them:
processresultsArray url; // Called with results by a user
You may find the following reporters useful:
1.0-json: output test results in the pa11y 1.0 JSON format
Install pa11y with npm or add to your
npm install pa11y
var pa11y = require'pa11y';
Create a tester by initialising pa11y with some options:
var test = pa11yoptions;
test.run function can then be used to run your test function against a URL:
The results that get passed into your test callback come from HTML CodeSniffer, and look like this:
code: 'WCAG2AA.Principle1.Guideline1_1.1_1_1.H30.2'context: '<a href=""><img src="example.jpg" alt=""/></a>'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.'selector: 'html > body > p:nth-child(1) > a'type: 'error'typeCode: 1code: 'WCAG2AA.Principle1.Guideline1_3.1_3_1.H49.B'context: '<b>Hello World!</b>'message: 'Semantic markup should be used to mark emphasised or special text so that it can be programmatically determined.'selector: '#content > b:nth-child(4)'type: 'warning'typeCode: 2code: 'WCAG2AA.Principle2.Guideline2_4.2_4_4.H77,H78,H79,H80,H81'context: '<a href="">Hello World!</a>'message: 'Check that the link text combined with programmatically determined link context identifies the purpose of the link.'selector: 'html > body > ul > li:nth-child(2) > a'type: 'notice'typeCode: 3
If you wish to transform these results with the command-line reporters, then you can do so in your code by requiring them in. The
markdown reporters all expose a
// Assuming you've already run tests, and the results// are available in a `results` variable:var htmlReporter = require'pa11y/reporter/html';var html = htmlReporterprocessresults url;
pa11y has lots of options you can use to change the way PhantomJS runs, or the way your page is loaded. Options can be set either on the pa11y instance when it's created or the individual test runs. This allows you to set some defaults which can be overridden per-test:
// Set the default Foo header to "bar"var test = pa11ypage:headers:Foo: 'bar';// Run a test with the Foo header set to "bar"testrun'' /* ... */ ;// Run a test with the Foo header overriddentestrun''page:headers:Foo: 'hello'/* ... */ ;
Below is a reference of all the options that are available:
The accessibility standards that are allowed to be used. This can be modified to allow for custom HTML CodeSniffer standards.
pa11yallowedStandards: 'WCAG2AA' 'My Custom Standard';
A function to be run before pa11y tests the page. The function accepts three parameters;
pageis the phantomjs page object, documentation for the phantom bridge can be found here
optionsis the finished options object used to configure pa11y
nextis a callback function
pa11y// Make changes to the page// When finished call next to continue running pa11y testsnext;;
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
pa11yhideElements: '.advert, #modal, div[aria-role=presentation]';
The path or URL to source HTML CodeSniffer from.
Defaults to a local copy of HTML CodeSniffer, found in lib/vendor/HTMLCS.js.
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
Defaults to an empty array.
An object which implements the methods
info which will be used to report errors and test information.
pa11ylog:debug: console.logbindconsoleerror: console.errorbindconsoleinfo: console.infobindconsole;
Each of these defaults to an empty function.
A key-value map of request headers to send when testing a web page.
Defaults to an empty object.
A key-value map of settings to add to the PhantomJS page. For a full list of available settings, see the PhantomJS page settings documentation.
pa11ypage:settings:loadImages: falseuserName: 'nature'password: 'say the magic word';
userAgent: 'pa11y/<version> (truffler/<version>)'
The viewport width and height in pixels. The
viewport object must have both
pa11ypage:viewport:width: 320height: 480;
width: 1024height: 768
A key-value map of settings to initialise PhantomJS with. This is passed directly into the
phantom module – documentation can be found here. You can pass PhantomJS command-line parameters in the
phantom.parameters option as key-value pairs.
pa11yphantom:port: 1234parameters:'ignore-ssl-errors': 'false''ssl-protocol': 'tlsv1';
phantom.port is not specified, a random available port will be used.
The root element for testing a subset of the page opposed to the full document.
null, meaning the full document will be tested.
The accessibility standard to use when testing pages. This should be one of
WCAG2AAA (or match one of the standards in the
The time in milliseconds that a test should be allowed to run before calling back with a timeout error.
The time in milliseconds to wait before running HTML CodeSniffer on the page.
Run pa11y on a URL and output the results. See the example, or run it with:
Inject a script before pa11y runs. This example logs into a fictional site then waits until the account page has loaded before running pa11y. See the example.
Common questions about pa11y are answered here.
page.headers option either in your JS code or in your config file:
page.settings option either in your JS code or in your config file to set a username and password:
pa11ypage:settings:userName: 'nature'password: 'say the magic word';
beforeScript option either in your JS code or in your config file to input login details and submit the form.
Once the form has been submitted you will also have to wait until the page you want to test has loaded before calling
next to run pa11y.
pa11yvarpageevaluateconditionif result || retries < 1waitOver;elseretries -= 1;setTimeoutwaitUntilcondition retries waitOver;200;;;pageevaluatevar user = documentquerySelector'#username';var password = documentquerySelector'#password';var submit = documentquerySelector'#submit';uservalue = 'exampleUser';passwordvalue = 'password1234';submitclick;waitUntilreturn windowlocationhref === '';20 next;;;
phantom.parameters option either in your JS code or in your config file:
pa11yphantom:parameters:'proxy': '188.8.131.52:8080''proxy-type': 'http''proxy-auth': 'username:password';
These match PhantomJS command-line parameters.
proxy-type can be set to
beforeScript option either in your JS code or in your config file to simulate the interactions before running pa11y.
In this example, additional content is loaded via ajax when a button is clicked.
Once the content is loaded the
aria-hidden atrribute switches from
pa11yvarpageevaluateconditionif result || retries < 1waitOver;elseretries -= 1;setTimeoutwaitUntilcondition retries waitOver;200;;;pageevaluatevar ajaxButton = documentquerySelector'#loadContent';var dynamicContent = documentquerySelector'#content';ajaxButtonclick;waitUntilreturn dynamicContentgetAttribute'aria-hidden' === 'false';20 next;;;
To contribute to pa11y, clone this repo locally and commit your code on a separate branch.
Please write unit tests for your code, and check that everything works by running the following before opening a pull-request:
Pa11y major versions are normally supported for 6 months after their last minor release. This means that patch-level changes will be added and bugs will be fixed. The table below outlines the end-of-support dates for major versions, and the last minor release for that version.
We also maintain a migration guide to help you migrate.
|❔||Major Version||Last Minor Release||Node.js Versions||Support End Date|
If you're opening issues related to these, please mention the version that the issue relates to.
pa11y is licensed under the Lesser General Public License (LGPL-3.0).
Copyright © 2016, Springer Nature