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(a11y): add information on enabling this addon globally for all stories #11102

Closed

Conversation

gaurav5430
Copy link

@gaurav5430 gaurav5430 commented Jun 9, 2020

Issue:
README was lacking information on how to enable this addon. This adds documentation related to #9471

What I did

Added information to README.md for a11y addon, to include information on how to enable this addon globally.

How to test

Preview the md file

  • Is this testable with Jest or Chromatic screenshots? No
  • Does this need a new example in the kitchen sink apps? No
  • Does this need an update to the documentation? This is an update to the documentation

If your answer is yes to any of these, please make sure to include it in your PR.

@gaurav5430 gaurav5430 force-pushed the a11y-docs-global-enable branch from 0e49715 to 516483c Compare June 9, 2020 17:57
@gaurav5430 gaurav5430 changed the title docs(a11y): add information on enabling this addon globally for all s… docs(a11y): add information on enabling this addon globally for all stories Jun 9, 2020
@gaurav5430
Copy link
Author

Not sure why Danger JS is failing with
Request failed [403]: https://api.github.com/repos/storybookjs/storybook/issues/11102/comments

@tooppaaa
Copy link
Contributor

tooppaaa commented Jun 9, 2020

@gaurav5430 withA11Y has been deprecated in 6.0. You can check the migration guide https://github.com/storybookjs/storybook/blob/next/MIGRATION.md#removed-witha11y-decorator

The only thing you need to do is to include the @storybook/addon-a11y in your main.js

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants