@area17/fractal-axe-a11y
v1.0.1
Published
A Fractal add on to test your components for accessibility issues using Axe
Downloads
41
Keywords
Readme
fractal-axe-a11y
This addon adds accessibility testing to your Fractal components using Axe.
Installation
To install Fractal Axe A11y to your Fractal instance use:
npm install @area17/fractal-axe-a11y
Configuration
- Add the following lines to your
fractal.config.js
project configuration:
// require fractal theme
const mandelbrot = require('@frctl/mandelbrot');
const axeA11y = require('@area17/fractal-axe-a11y');
// configure theme
const theme = mandelbrot({ ... })
// Update theme config with a11y panel
axeA11y(theme);
// init theme
fractal.web.theme(theme);
- Include
preview-a11y.js
in Fractalpreview
template:
<script src="{{ path '/axe-a11y/a11y.js' }}"></script>
- Optionally - To test just the component and not the entire preview page, add a data attribute of
data-axe-test-target
to yourpreview
template to the container of your main yield:
<main data-axe-test-target>
{{{ yield }}}
</main>