@proof-ui/a11y-plugin

Uses axe to scan each story against accessibility rules. Violatons are printed to the console, and included in any reports.

Installation

1yarn add -D @proof-ui/a11y-plugin

Usage

1// proof.config.js
2import A11yPlugin from '@proof-ui/a11y-plugin';
3
4export default {
5  plugins: [
6    new A11yPlugin({
7      // Configuration
8    })
9  ]
10};

1# Command Line Usage
2proof --a11y

Options

You can configure the A11yPlugin through some options in it's constructor:

Property	Description	Type	Default
config	The AXE rule configuration to use when testing a story	object (see axe.Spec)
root	A selector for the root context when checking for violations	string	'#root'

Related

• add-all-plugin
• skip-tests-plugin