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

$3

add nightwatch-accessibility to the plugins array

` js
{
plugins: ['nightwatch-accessibility']
}
`

$3

` 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

$3

Injects the [aXe][] library into the current test page.

$3

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 •
> Twitter: @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