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

Testing accessibility for all components #1148

Open
23 tasks done
mayank99 opened this issue Mar 20, 2023 · 4 comments · Fixed by #1352
Open
23 tasks done

Testing accessibility for all components #1148

mayank99 opened this issue Mar 20, 2023 · 4 comments · Fixed by #1352
Assignees
Labels
a11y Accessibility issues (keyboard navigation, color contrast, assistive technologies, semantics, etc)

Comments

@mayank99
Copy link
Contributor

mayank99 commented Mar 20, 2023

All components, especially the more complex ones, need to be tested for accessibility. The most basic form of this involves running automated tools (like axe) which could even be made of part of CI. A more useful form of this will involve testing with (at least) NVDA+Firefox/Chrome on Windows and VoiceOver+Safari on macOS, and also with Talkback+Android and VoiceOver+iOS where possible.

This issue can be used as a checklist to track the status of all components.

Status

Automated (using axe)

(already passing if not mentioned)

Manual accessibility audit

Pending.

Automated screen-reader testing

Pending.

See guidepup.

@mayank99 mayank99 added the a11y Accessibility issues (keyboard navigation, color contrast, assistive technologies, semantics, etc) label Mar 20, 2023
@maliksenpai
Copy link

Currently I'm working on it. I'm doing this tests with this library, is it okay? https://github.com/nickcolley/jest-axe @mayank99

@mayank99
Copy link
Contributor Author

I'm doing this tests with this library, is it okay? nickcolley/jest-axe

jest-axe is okay, but the problem is it runs in jsdom, so it won't be able to catch many of the issues such as color contrast. A better option would be to run aXe inside cypress/playwright or through storybook.

And of course that is only the first step. After that, we also need to do manual testing and document the results.

@maliksenpai
Copy link

maliksenpai commented Apr 17, 2023

So I will do it with jest-axe firstly, after that I will add more test with cypress.

jest-axe does not guarantee that what you build is accessible but still jest-axe is good. @mayank99

@mayank99
Copy link
Contributor Author

mayank99 commented Jul 5, 2023

cypress-axe was correctly set up in #1352.

Next steps:

  1. fix reported violations in all examples; some might require component changes.
  2. manually audit all examples and document+fix any found issues.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
a11y Accessibility issues (keyboard navigation, color contrast, assistive technologies, semantics, etc)
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants