Skip to content
Sid Vishnoi edited this page Mar 7, 2020 · 13 revisions

Lints for accessibility issues using axe-core.

This feature is intended to be used while editing specs locally. Using this on hosted documents will slow down the rendering and may make the page unresponsive.

Example of usage

// basic example, runs all default plugins with a exception of a few slow ones
var respecConfig = {
  a11y: true,
};
// example with configuration
// see options at https://github.com/dequelabs/axe-core/blob/develop/doc/API.md#options-parameter
var respecConfig = {
  a11y: {
    runOnly: ['image-alt', 'link-name'],
  },
};

Example output

If the document has accessibility issues, they will show up as ReSpec warnings:

Accessibility warnings in ReSpec

Guides

Configuration options

W3C Configuration options

Linter rules

Internal properties

Handled by ReSpec for you.

Special <section> IDs

HTML elements

Custom Elements

WebIDL

HTML attributes

CSS Classes

Special properties

Clone this wiki locally