mui / mui/material-ui

[docs] shouldn't Skeleton's doc adopt same ARIA guidelines as Circular Progress ?

Open
#26,930 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

accessibility docs scope: skeleton
Dominant language
JavaScript
Stars
99.1k
Forks
32.5k
Avg merge
2d 17h
Merged PRs (30d)
106

Description

  • 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.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by comparing the Skeleton API documentation with the Circular Progress API guidance quoted in the issue, then review the linked accessible-skeletons article for relevant ARIA recommendations. Done means the Skeleton documentation clearly explains the applicable accessibility guidance and is consistent with Circular Progress where appropriate.

Written by the indexing model from the issue text.

Assessment

Tech stack
react
Domain
accessibility, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.