storybook-a11y-report
Advanced tools
Readme
CLI tool for storybook-addon-a11y.
The storybook-a11y-report project is now discontinued. Please switch to the Storybook test runner and axe-playwright for accessibility testing. We thank everyone who supported storybook-a11y-report throughout its journey.
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.
# 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
--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)
This project is licensed under the MIT License - see the LICENSE file for details.
FAQs
CLI tool for storybook-addon-a11y.
The npm package storybook-a11y-report receives a total of 1,377 weekly downloads. As such, storybook-a11y-report popularity was classified as popular.
We found that storybook-a11y-report demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.