Using the Storybook Addon (beta)
Get Stark's comprehensive WCAG Audit right in your Storybook panel.
With Stark's Storybook Addon, you can quickly run WCAG Audits right from within your Storybook panels, and test your designs against all of Stark's vision simulations.
Installing the Add-on
Run the following command to install the addon in your Storybook repo:
npm install -D storybook-addon-stark
Then include Stark's Storybook Addon in your addons list:
// .storybook/main.ts
export default {
addons: ["storybook-addon-stark"],
};
Using the Addon
There are two main ways to use the Stark addon:
- At the top of the Storybook preview, click the Stark logo and select a Vision Simulation from the dropdown.
- To remove the simulation, simply select
Reset Vision Simulationfrom the dropdown.
- In the Storybook Panels, select
Stark. - Stark will automatically audit the Storybook preview frame for accessibility issues.
- Change between Violations, Potentials, and Passed test results by using the tabs at the top.
- More information on how to fix issues can be found by clicking the "WCAG Explained" links below each code block.
Have any questions about using our Storybook Addon? Suggestions or feedback? Don’t hesitate to reach out to us at support@getstark.co.