A Gatsby plugin that checks @axe-core/react rules against Gatsby markup for accessibility testing
npm install gatsby-plugin-axe-core-reactA Gatsby plugin to add @axe-core/react accessibility testing to Gatsby markup.
``shell`
yarn add @axe-core/react axe-core gatsby-plugin-axe-core-react --dev
`javascript
// In your gatsby-config.js
plugins: [gatsby-plugin-axe-core-react]`
or
`javascript
// In your gatsby-config.js
plugins: [
{
resolve: 'gatsby-plugin-axe-core-react',
options: {
axeConfig,
axeContext,
debounce,
},
},
]
`
React-axe will now print a11y warnings to your browser's console. 🎉
axeConfig [object][optional]
The configuration object for axe-core.
axeContext [object][optional]
Used to specify which element should and which should not be tested.
debounce` [number][optional][default: 1000]
The number of milliseconds to wait for component updates to cease before performing an analysis of all the changes.