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

chore: add a11y checks to test pipeline #1937

Merged
merged 2 commits into from
May 25, 2021
Merged

Conversation

karrui
Copy link
Contributor

@karrui karrui commented May 20, 2021

Problem

We can currently see a11y compliance via Storybook's a11y addon, but the addon itself will not throw any errors even if there are a11y violations. When multiple developers are working on several components, it is easy to overlook those a11y warnings (or even ignore them).

Thus, this PR adds an a11y check to the frontend tests pipeline to ensure that our rendered components are somewhat accessible, using @storybook/addon-storyshots-puppeteer which uses axe under the hood to catch the most common a11y violations.

Also clean up Storybook versions to use the stable version and clean up s ome storybook configuration.

(Also also to experiment with this for the a11y talk I'm about to start writing)

Solution

Features:

  • set up a11y testing with storyshots-puppeteer

Improvements:

  • remove all generated ChakraUI props docs in components stories

@karrui karrui added the react label May 20, 2021
Copy link
Contributor

@mantariksh mantariksh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

image

@karrui karrui merged commit 95a9a35 into form-v2/develop May 25, 2021
@karrui karrui deleted the form-v2/add-storyshots branch May 25, 2021 02:21
@mantariksh mantariksh restored the form-v2/add-storyshots branch May 27, 2021 02:25
@mantariksh mantariksh deleted the form-v2/add-storyshots branch May 27, 2021 02:26
karrui added a commit that referenced this pull request Jun 9, 2021
* fix: remove all ChakraUI props from Chakra extended components

* chore: set up a11y testing with storyshots-puppeteer
karrui added a commit that referenced this pull request Jun 24, 2021
* fix: remove all ChakraUI props from Chakra extended components

* chore: set up a11y testing with storyshots-puppeteer
@justynoh justynoh mentioned this pull request Oct 5, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants