Improve MasterDetailLayout samples for a11y
Open
Nobody has claimed this yet.
a11y
design system
- Dominant language
- AsciiDoc
- Stars
- 38
- Forks
- 225
- Avg merge
- 1d 4h
- Merged PRs (30d)
- 170
Description
Remember to provide instructions for screen reader support:
- Mark up master and especially details as
<section>/role="region" - Use appropriate headings for each area (detail level +1 level compared to master; maybe also
aria-labelledbyshould be used to associate each area with their titles – not sure if necessary) - Maybe show how to generate announcement when contents of details changes?
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the existing MasterDetailLayout samples in the documentation and review how their master and detail areas are currently presented. Update the samples to demonstrate semantic regions, appropriate heading levels, optional aria-labelledby associations, and announcements when detail content changes; done means the requested screen-reader guidance is shown clearly in the examples.
Written by the indexing model from the issue text.
Assessment
- Domain
- accessibility, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100