@stark-lab-inc/storybook-addon-stark
v1.2.0
Published
Use Stark to check your storybook's accessibility.
Readme
Installation
yarn add -D storybook-addon-starknpm install -D storybook-addon-starkIn your .storybook/main.ts file, add the following:
// .storybook/main.ts
export default {
addons: ["storybook-addon-stark"],
};Usage
There's two main ways to use the Stark addon:
Vision Simulator
- 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 Simulation from the dropdown.
WCAG Audit Panel
- In the Storybook Panels, select Stark.
- Stark will automatically audit the Storybook preview frame for accessibility issues.
- Change between Violations, Potentials, and Passed using the tabs at the top.
- More information on how to fix issues can be used by clicking the WCAG explained links below the code blocks.
