patternfly / patternfly/patternfly-org
Add a11y docs for Icon
Open
Nobody has claimed this yet.
A11y
PF Team
- Dominant language
- JavaScript
- Stars
- 74
- Forks
- 147
- Avg merge
- 4d 11h
- Merged PRs (30d)
- 2
Description
We should be sure to include documentation as to when aria-hidden="true" should be passed into an Icon's child as well as if/when an aria-label should be passed.
Jira Issue: PF-1967
Contributor guide
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 Icon documentation in this repository and review how accessibility guidance is currently presented. Add guidance covering when an Icon child should receive aria-hidden="true" and when an aria-label should be supplied; the documentation is done when both cases are clearly explained.
Written by the indexing model from the issue text.
Assessment
- Domain
- accessibility, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 52/100