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] shouldn't Skeleton's doc adopt same ARIA guidelines as Circular Progress ? #26930

Open
1 task done
liitfr opened this issue Jun 24, 2021 · 1 comment
Open
1 task done
Labels
accessibility a11y component: skeleton This is the name of the generic UI component, not the React module! docs Improvements or additions to the documentation ready to take Help wanted. Guidance available. There is a high chance the change will be accepted

Comments

@liitfr
Copy link

liitfr commented Jun 24, 2021

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

Summary 💡

First of all, I don't know many things about ARIA best practices, so please forgive me if this issue isn't relevant.

I've read following ARIA suggestion in Circular Progress API :

If the progress bar is describing the loading progress of a particular region of a page, you should use aria-describedby to point to the progress bar, and set the aria-busy attribute to true on that region until it has finished loading.

Typically, it looks like the same use case as when one uses Skeletons before displaying desired content.
So, for sake of consistency, shouldn't we add same guideline for Skeleton API doc ?

Thank you for your consideration

Examples 🌈

In depth reflexion can be found here : https://adrianroselli.com/2020/11/more-accessible-skeletons.html

Motivation 🔦

Consistency in documentation to increase accessibility best practices in people's app.

@liitfr liitfr added the status: waiting for maintainer These issues haven't been looked at yet by a maintainer label Jun 24, 2021
@oliviertassinari oliviertassinari added component: skeleton This is the name of the generic UI component, not the React module! accessibility a11y status: waiting for maintainer These issues haven't been looked at yet by a maintainer and removed status: waiting for maintainer These issues haven't been looked at yet by a maintainer labels Jun 27, 2021
@oliviertassinari
Copy link
Member

oliviertassinari commented Jun 27, 2021

Thanks for opening the issue. We currently display nothing https://mui.com/components/skeleton/#aria however, it does sound like there is work to do.

From what I understand, the implementation of the component is correct, attributes should be handled userland, the Skeleton being too low level, but we can improve the documentation by doing the a11y correctly:

  1. I have linked this issue to [material-ui][docs] Add Accessibility section to all component demo pages #20600 (comment), where we track the progress on the a11y of the docs.
  2. Vuetify talks about a similar problem: [Bug Report] Skeleton loaders should not have aria-busy and alert role vuetifyjs/vuetify#10999 (comment)
  3. We can describe the aria-busy trick for the region that is loading.

@oliviertassinari oliviertassinari added ready to take Help wanted. Guidance available. There is a high chance the change will be accepted OCD21 and removed status: waiting for maintainer These issues haven't been looked at yet by a maintainer ready to take Help wanted. Guidance available. There is a high chance the change will be accepted labels Jun 27, 2021
@oliviertassinari oliviertassinari added the ready to take Help wanted. Guidance available. There is a high chance the change will be accepted label Jul 16, 2021
@mnajdova mnajdova removed the OCD21 label Aug 24, 2021
@oliviertassinari oliviertassinari added the docs Improvements or additions to the documentation label Aug 30, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
accessibility a11y component: skeleton This is the name of the generic UI component, not the React module! docs Improvements or additions to the documentation ready to take Help wanted. Guidance available. There is a high chance the change will be accepted
Projects
None yet
Development

No branches or pull requests

3 participants