1.0.3 • Published 2 years ago
gatsby-plugin-axe-core-react v1.0.3
gatsby-plugin-axe-core-react
A Gatsby plugin to add @axe-core/react
accessibility testing to Gatsby markup.
Install
yarn add @axe-core/react axe-core gatsby-plugin-axe-core-react --dev
How to use
// In your gatsby-config.js
plugins: [`gatsby-plugin-axe-core-react`]
or
// 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. 🎉
Configuration options
You can use the following options if you wish to to override the default config.
The configuration object for axe-core.
Used to specify which element should and which should not be tested.
The number of milliseconds to wait for component updates to cease before performing an analysis of all the changes.