docs(README): Update a11y recipe #186
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ascendantofrain
approved these changes
Aug 30, 2022
yannbf
added
documentation
|
Thank you so much @nagisaando for all your great contributions! |
yannbf
approved these changes
Sep 5, 2022
yannbf
changed the title
Merged
|
🚀 PR was released in |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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