MenuToggle - Update a11y docs to include mention dynamic toggle label + aria attributes

Open Beginner friendly
#4,596 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

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

Research direction

Start by locating the MenuToggle accessibility documentation and review the guidance referenced by issue 6562. Update the documentation to cover a static label for dynamic toggle content and when aria-invalid="true" and aria-autocomplete="list" apply. Done means all three cases are clearly documented in the relevant MenuToggle a11y section.

Written by the indexing model from the issue text.

Description

A11y Documentation PF Team

Per https://github.com/patternfly/patternfly/issues/6562#issuecomment-2839684312, we should update MenuToggle a11y docs to mention that when the toggle content is expected or intended to be dynamic (such as when used for a Select, where a selected option might become the toggle content), there should also be a static label for the toggle.

Additionally, we should mention when aria-invalid="true" and aria-autocomplete="list" should be applied (the former whenever status is danger, the latter for typeahead toggles only)

Dominant language
JavaScript
Stars
74
Forks
147
Avg merge
4d 11h
Merged PRs (30d)
2

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.

More from patternfly/patternfly-org

All issues in patternfly/patternfly-org

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.