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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add accessibility report for all Chakra components #88

Closed
codebender828 opened this issue Mar 31, 2020 · 2 comments
Closed

Add accessibility report for all Chakra components #88

codebender828 opened this issue Mar 31, 2020 · 2 comments
Labels
status: assigned 鉃★笍 status: work in progress 馃悳 topic: accessibility (A11y) 鈾匡笍 type: documentation 馃摎

Comments

@codebender828
Copy link
Member

@codebender828 codebender828 commented Mar 31, 2020

Is your feature request related to a problem? Please describe.
Because accessibility is a Chakra UI fundamental concept, I feel that it would be a great idea to document for consumers who answers to the following questions:

"Huh? 馃槖 How is this button accessible?! Looks pretty alright to me!"

"Also what do you mean this modal is accessible? Hmm? How do I know it is? 馃暤馃徑鈥嶁檪锔"

"I'm a Vue developer building a website for a specific group of people and I need to find a component library that supports accessibility and allows me to work fast! Can I use Chakra UI Vue for my end users?"

This aims to describe the supported WAI-ARIA guidelines for all Chakra components. For the sake of of people who might consider accessibility as a core criterium for choosing a component library for an application, I feel that to ease the burden of inspecting the source code, we should briefly document how each component is built support accessibility.

If the Chakra component is a custom/authored component, we should use WAI-ARIA guidelines as a benchmark.

This will also a be a useful resource for developers who would like to know about authoring accessible javascript applications.

Describe the solution you'd like
In each Chakra component folder, we can create an accessibility.md file and describe the component's accessibility there. We can then link to it from the official docs for those who would like to know more.

Ideas and contributions are welcome! 馃榿

@codebender828 codebender828 added good first issue 馃尞 topic: accessibility (A11y) 鈾匡笍 type: documentation 馃摎 status: work in progress 馃悳 labels Mar 31, 2020
@codebender828 codebender828 removed the good first issue 馃尞 label Apr 8, 2020
@codebender828 codebender828 added the status: assigned 鉃★笍 label Jul 18, 2020
@codebender828
Copy link
Member Author

@codebender828 codebender828 commented Jul 18, 2020

For the record, this issue has been assigned to @saptaksengupta

@saptaksengupta
Copy link
Contributor

@saptaksengupta saptaksengupta commented Jul 18, 2020

@codebender828 I have started working on it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status: assigned 鉃★笍 status: work in progress 馃悳 topic: accessibility (A11y) 鈾匡笍 type: documentation 馃摎
Projects
None yet
2 participants