patternfly / patternfly/patternfly
MenuToggle - add aria attributes to documentation
Nobody has claimed this yet.
- Dominant language
- SCSS
- Stars
- 817
- Forks
- 116
- Avg merge
- 4d 11h
- Merged PRs (30d)
- 14
Description
Describe the problem
This is an issue with
- Patternfly 5
- Patternfly 6
- other
Based on an accessibility review by @adamjohnson and myself, we are concerned that menu toggle does not give sufficient examples or advice on how to implement it with the element it toggles in an accessible way. Specifically, that it requires the following:
- An
aria-controlsproperty that includes the IDREF of the element it expanded - An
aria-haspopupproperty that indicates the type of popup - That the
aria-expandedproperty changes when the toggled element is visible.
How do you reproduce the problem?
- Go to menu toggle docs.
- Note that there are no examples of how a menu-toggle interacts with the object it toggles.
Expected behavior
See the WAI ARIA Authoring Practice Guide's navigation menu button example for correct usage so that users are less likely to make accessibility errors.
Is this issue blocking you?
No
Any other information?
Without documenting how to use this button correctly the docs themselves fail to meet ATAG Principle B2, so the docs in their current state are an accessibility issue.
cc/ @markcaron
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
Open the linked menu toggle documentation and compare its guidance with the WAI-ARIA menu button example. Add examples and advice covering aria-controls, aria-haspopup, and aria-expanded for the toggled element. Done means users can follow the page to implement the interaction accessibly.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- html
- Domain
- accessibility, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100