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

[material-ui][docs] Add Accessibility section to all component demo pages #20600

Open
1 task done
nspaeth opened this issue Apr 16, 2020 · 7 comments
Open
1 task done
Labels
accessibility a11y docs Improvements or additions to the documentation enhancement This is not a bug, nor a new feature package: material-ui Specific to @mui/material

Comments

@nspaeth
Copy link

nspaeth commented Apr 16, 2020

  • I have searched the issues of this repository and believe that this is not a duplicate.

Summary 💡

Many components' documentation contains an Accessibility section that tells you how to make sure your components are Accessible, but some components don't contain this section.

For the sections that don't contain Accessibility, it isn't clear if that means that the component is accessible without any special measures, or if it isn't accessible at all.

It would be helpful if each component had an Accessibility section that says which is the case:

  • Component is accessible without extra work.
  • Component requires special measures to make accessible.
  • Component is not accessible.

Examples 🌈

See
https://material-ui.com/components/tables/#accessibility
vs
https://material-ui.com/components/popper/

Motivation 🔦

I want to make sure I only use accessible components in my development.

@eps1lon
Copy link
Member

eps1lon commented Apr 16, 2020

Thanks for opening this issue.

So far we've added a guide if questions came up. So if you have specific pages with open questions then feel free to ask. The Popper is a pretty generic component. What makes it accessible or not depends on the use case.

My preferred version has a11y sections that address WCAG success criteria directly. For some components an a11y section doesn't make much sense (because components aren't "accessible or not"). Or would at least require full blown guides e.g. https://material-ui.com/components/cards/ which has no a11y concerns that are specific to Material Cards.

We'll probably add a general a11y page that includes an a11y statement including the targetted WCAG version.

@eps1lon eps1lon added the accessibility a11y label Apr 16, 2020
@nspaeth
Copy link
Author

nspaeth commented Apr 16, 2020

My preferred version has a11y sections that address WCAG success criteria directly.

That would be great!

The Popper is a pretty generic component. What makes it accessible or not depends on the use case.

This doesn't seem completely right to me. For example, in all uses of the Popper I would want to know where that content was inserted into the document flow and, if it contains links, where those links would be in the focus order. Does it require any kind of labeled-by attribute in order to indicate what element it is 'popping over' and relevant to, or should I manage that with the content of the popper? Or, should a popper not contain any interactive elements?

@oliviertassinari oliviertassinari added the docs Improvements or additions to the documentation label Apr 17, 2020
@oliviertassinari oliviertassinari changed the title Some components don't contain an Accessibility section [docs] Some components don't contain an Accessibility section Apr 17, 2020
@oliviertassinari
Copy link
Member

oliviertassinari commented Apr 17, 2020

@nspaeth Regarding the Popper, It seems that they are a lot of possible cases. I'm not sure how far we can cover them. If you could list all the pages that could benefit from a new accessibility section it would be 💯.

@nspaeth
Copy link
Author

nspaeth commented Apr 18, 2020

Here's a list of the components that I would be most concerned about using and don't currently have A11y info. I think, largely, they have similar behavior as Popper.

@eps1lon eps1lon linked a pull request May 9, 2020 that will close this issue
@eps1lon eps1lon removed a link to a pull request May 9, 2020
@eps1lon
Copy link
Member

eps1lon commented May 12, 2020

Added section for tabs. Will be part of the next release.

@oliviertassinari oliviertassinari changed the title [docs] Some components don't contain an Accessibility section [docs] Add Accessibility section to all the components Apr 25, 2021
@bmccarthyco
Copy link

bmccarthyco commented Jan 25, 2022

Reviewed list above to current docs and these components now have Accessibility sections and can likely be checked off:

@samuelsycamore
Copy link
Contributor

This is something to keep in mind for #35158

@samuelsycamore samuelsycamore changed the title [docs] Add Accessibility section to all the components [material-ui][docs] Add Accessibility section to all component demo pages Dec 1, 2023
@samuelsycamore samuelsycamore added package: material-ui Specific to @mui/material enhancement This is not a bug, nor a new feature labels Dec 1, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
accessibility a11y docs Improvements or additions to the documentation enhancement This is not a bug, nor a new feature package: material-ui Specific to @mui/material
Projects
None yet
Development

No branches or pull requests

5 participants