https://github.com/ahmadnassri/node-nightwatch-accessibility
Nightwatch.js utility assertion for accessibility testing with aXe
https://github.com/ahmadnassri/node-nightwatch-accessibility
axe lib nightwatch node
Last synced: 10 days ago
JSON representation
Nightwatch.js utility assertion for accessibility testing with aXe
- Host: GitHub
- URL: https://github.com/ahmadnassri/node-nightwatch-accessibility
- Owner: ahmadnassri
- License: mit
- Created: 2017-07-26T06:40:13.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2025-01-07T20:53:44.000Z (4 months ago)
- Last Synced: 2025-05-08T21:14:21.566Z (10 days ago)
- Topics: axe, lib, nightwatch, node
- Language: JavaScript
- Homepage:
- Size: 890 KB
- Stars: 18
- Watchers: 2
- Forks: 5
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Nightwatch Accessibility
Nightwatch.js utility assertion for accessibility testing with aXe.
[![license][license-img]][license-url]
[![release][release-img]][release-url]
[![semantic][semantic-img]][semantic-url]
## Install
``` bash
npm install nightwatch-accessibility
```
## Usage
### Nightwatch \>= 2.x
add `nightwatch-accessibility` to the plugins array
``` js
{
plugins: ['nightwatch-accessibility']
}
```
### Nightwatch \<= 1.x
``` js
{
custom_commands_path: ["./node_modules/nightwatch-accessibility/nightwatch/commands"],
custom_assertions_path: ["./node_modules/nightwatch-accessibility/nightwatch/assertions"]
}
```
Use in your tests:
``` js
module.exports = {
'Test': function (browser) {
browser
// initiate aXe
.initAccessibility()
// execute accessibility check
.assert.accessibility('#app', {
verbose: true,
rules: {
'color-contrast': { enabled: false }
}
})
}
}
```
## API
### `browser.initAccessibility()`
Injects the [`aXe`][] library into the current test page.
### `browser.assert.accessibility(context, options)`
Analyzes the defined `context` against applied `aXe` rules
| Name | Type | Default | Description |
|---------------|----------|----------|---------------------------|
| **`context`** | `String` | `'html'` | [aXe Context][] Parameter |
| **`options`** | `Object` | `null` | [aXe Options][] Parameter |
> In addition to the standard `options`:
- `options.verbose` set to `true` will log all successful `aXe` tests.
- `options.timeout` configures the nightwatch timeout, default value is `500 milliseconds`
[`aXe`]: https://www.npmjs.com/package/axe-core
[aXe Context]: https://github.com/dequelabs/axe-core/blob/master/doc/API.md#context-parameter
[aXe Options]: https://github.com/dequelabs/axe-core/blob/master/doc/API.md#options-parameter
----
> Author: [Ahmad Nassri](https://www.ahmadnassri.com/) •
> Twitter: [@AhmadNassri](https://twitter.com/AhmadNassri)
[license-url]: LICENSE
[license-img]: https://badgen.net/github/license/ahmadnassri/node-nightwatch-accessibility
[release-url]: https://github.com/ahmadnassri/node-nightwatch-accessibility/releases
[release-img]: https://badgen.net/github/release/ahmadnassri/node-nightwatch-accessibility
[semantic-url]: https://github.com/ahmadnassri/node-nightwatch-accessibility/actions?query=workflow%3Arelease
[semantic-img]: https://badgen.net/badge/📦/semantically%20released/blue