Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(README): Update a11y recipe #186

Conversation

nagisaando
Copy link

Added code example in Readme of Global utility functions.
The reason is that when a11y rule is configured on story level, the rules are applied in the local Storybook instance but when run test-storybook in command line, those rules are ignored and throws violations i. e.g.) Disabling some rules using rule ID.

Because of that, we need to configure configureAxe() and before a11y test runs.

I added the example since there is no documentation for the configuration, and I belive there would be a common configuration case if developers override a11y rules on story base.

This is the discussion about the case. https://discord.com/channels/486522875931656193/580149748225409024/1007635983707156571

@yannbf yannbf added documentation Changes only affect the documentation skip-release Preserve the current version when merged labels Sep 5, 2022
@yannbf
Copy link
Member

yannbf commented Sep 5, 2022

Thank you so much @nagisaando for all your great contributions!

@yannbf yannbf changed the title doc:modified Global utility functions section docs(README): Update a11y recipe Sep 5, 2022
@yannbf yannbf merged commit ee31263 into storybookjs:next Sep 5, 2022
@yannbf yannbf mentioned this pull request Sep 6, 2022
@github-actions
Copy link

🚀 PR was released in v0.7.2-next.0 🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Changes only affect the documentation prerelease released skip-release Preserve the current version when merged
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants