The Accessibility Engine for automated testing of HTML-based user interfaces. Drop the aXe on your accessibility defects!
We believe that automated testing has an important role to play in achieving digital equality and that in order to do that, it must achieve mainstream adoption by professional web developers. That means that the tests must inspire trust, must be fast, must work everywhere and must be available everywhere.
aXe is the third generation of accessibility rules for HTML-based user interfaces that differentiates itself from other approaches and rules repositories in the following ways:
First download the package:
npm install axe-core --save-dev
Now insert calls at each point in your tests where a new piece of UI becomes visible or exposed:
The aXe API supports the following browsers:
The complete list of rules run by axe-core can be found in doc/rule-descriptions.md.
The aXe API package consists of:
axe.min.js- a minified version of the above file
Axe can be built using your local language. To do so, a localization file must be added to the
./locales directory. This file must have be named in the following manner:
<langcode>.json. To build aXe using this locale, instead of the default, run aXe with the
--lang flag, like so:
grunt build --lang=nl
This will create a new build for aXe, called
axe.<lang>.min.js. If you want to build localized versions, simply pass in
To create a new translation for aXe, start by running
grunt translate --lang=<langcode>. This will create a json file fin the
./locales directory, with the default English text in it for you to translate. We welcome any localization for axe-core. For details on how to contribute, see the Contributing section below.
Read the Proposing Axe-core Rules guide
Read the documentation on the architecture
Read the documentation on contributing