New
Storybook for full-stack developersAutomate with Chromatic
Star75,295
Back to integrations
Add your integration
Categories
  • ⭐️ Popular
  • 🧩 Essentials
  • 🛠 Code
  • ⚡️ Data & state
  • ✅ Test
  • 💅 Style
  • 🎨 Design
  • ⚙️ Appearance
  • 🗄 Organize
How to install addons Create an addon
storybook-a11y-report
CLI tool for storybook-addon-a11y.
npm install storybook-a11y-report
Last updated about 1 month ago
2.9k
Downloads per week
Readme View on GitHub

storybook-a11y-report

CLI tool for storybook-addon-a11y.

Report Example

Report examples

Getting Started

Prerequisites

If you are already developing in Storybook and storybook-addon-a11y is working, this module will work. If storybook-addon-a11y is not installed, start with this guide.

Installing / Getting started

# Locally in your project.
npm install -D storybook-a11y-report

# Or globally.
npm install -g storybook-a11y-report

# You will need to start Storybook before running this command.
npx storybook-a11y-report

Options

--include, -i   Name of stories to narrow down (supports minimatch)
--exclude, -e   Name of stories to ignore (supports minimatch)
--filter, -f    ID of A11y to narrow down
--omit, -o      ID of A11y to ignore
--exit, -q      The process will be terminated abnormally, if there is an a11y violation in the report result (mainly for CI)
--storybookUrl  URL of Storybook (default: 'http://localhost:6006')
--outDir        Directory to output the report file (default: '__report__')
--outputFormat  Format of the output report, supports md or html (default: md)

Built With

License

This project is licensed under the MIT License - see the LICENSE file for details.

Join the community
5,867 developers and counting
WhyWhy StorybookComponent-driven UI
Open source software
Storybook

Maintained by
Chromatic
Special thanks to Netlify and CircleCI