@proof-ui/a11y-plugin NPM | npm.io

0.3.6 • Published 2 years ago

Install

Weekly downloads

323

License

MIT

Repository

Last release

2 years ago

@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

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

Usage

// proof.config.js
import A11yPlugin from '@proof-ui/a11y-plugin';

export default {
  plugins: [
    new A11yPlugin({
      // Configuration
    })
  ]
};

# Command Line Usage
proof --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

@infinitebrahmanuniverse/nolb-_proo @everything-registry/sub-chunk-741 @design-systems/proof

2 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

5 years ago

5 years ago

5 years ago

0.1.5-canary.efb04f2.0

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

0.1.1-canary.4e2c7d1.0

5 years ago

0.1.1-canary.f192017.0

5 years ago

0.1.1-canary.72bc6e7.0

5 years ago

5 years ago

0.0.21-canary.b590b95.0

5 years ago

5 years ago

0.0.21-canary.cc0b70d.0

5 years ago

0.0.21-canary.ee83862.0

5 years ago

5 years ago

5 years ago

5 years ago

0.0.17-canary.f8c715b.0

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

0.0.13-canary.551ab9f.0

6 years ago

0.0.13-canary.c812565.0

6 years ago

1.0.0-canary.b17b5d2.0

6 years ago

6 years ago

6 years ago

6 years ago

0.0.10-canary.93d69a7.0

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

0.0.6-canary.2be36f4.0

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

0.0.2-canary.6dcb54a.0

6 years ago

0.0.2-canary.4785d27.0

6 years ago

6 years ago

0.0.1-canary.342bc4e.0

6 years ago