JedWatson / JedWatson/react-select

Group titles do not get passed to accessible announcements

Open
#6,047 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

issue/bug-unconfirmed
Dominant language
TypeScript
Stars
28k
Forks
4.1k
PR merge metrics
No merged PRs in 30d

Description

When Groups are used to group options in the Select, these groupings are not announced to screen reader users. This is because the announcements screen reader users hear are controlled by the LiveRegion component, and no information about an option's Group is passed to that LiveRegion.

For example, when using the arrow keys to "focus" an option in a group, we would expect to hear something like "[option name], option, not selected, [group name], group" from screen readers. Instead, we don't hear any information about the group name or group role. Currently, there is no good way for React Select users to customize the LiveRegion content to change this read out unless we completely overwrite the LiveRegion content using ariaLiveMessages.

React Select should pass on Grouping information to the LiveRegion component so that it can be announced to screen reader users. Here is a codesandbox instance with an example of grouped options: https://codesandbox.io/p/devbox/react-select-v5-sandbox-forked-9zwtgv

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 at the LiveRegion component and trace how grouped options reach its announcements, using the ariaLiveMessages customization described in the issue as context. Verify the result with grouped options like those in the linked CodeSandbox: screen readers should announce the option name, selection state, group name, and group role without requiring users to replace the entire LiveRegion content.

Written by the indexing model from the issue text.

Assessment

Tech stack
react, typescript
Domain
accessibility, frontend
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.