ComboboxControl: Fix accessible association of help text#76761
Open
ComboboxControl: Fix accessible association of help text#76761
help text#76761Conversation
mirka
added
[Type] Bug
mirka
commented
Mar 23, 2026
Comment on lines
-110
to
-113
| expect( label ).toHaveAttribute( | ||
| 'data-wp-component', | ||
| 'VisuallyHidden' | ||
| ); |
Member
Author
There was a problem hiding this comment.
Removed for testing implementation details.
| onChange={ onInputChange } | ||
| aria-describedby={ | ||
| help | ||
| ? `components-form-token-input-${ instanceId }__help` |
Member
Author
There was a problem hiding this comment.
Ideally, TokenInput wouldn't hardcode any IDs internally and would instead receive id, aria-owns, aria-describedby, etc. from its parent. That refactor would make this kind of fix trivial, but it touches both consumers (ComboboxControl and FormTokenField) plus SuggestionsList, so it's out of scope here.
Contributor
There was a problem hiding this comment.
Yeah, this is not ideal but I understand that the proper fix would be more involved ( I can see that you had initiall tried useBaseControlProps but then reverted to straight aria-describedby). Should we at least add an inline comment to note the tradeoff ?
|
Size Change: +24 B (0%) Total Size: 7.66 MB
ℹ️ View Unchanged
|
|
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message. To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
|
Flaky tests detected in 0cf3b88. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/23436566986
|
aduth
reviewed
Mar 25, 2026
ciampo
approved these changes
Mar 26, 2026
Contributor
ciampo
left a comment
ciampo
left a comment
There was a problem hiding this comment.
Pre-approving, we can merge once feedback is addressed 🚀
| __next40pxDefaultSize: true, | ||
| label: 'Select a country', | ||
| options: countryOptions, | ||
| help: 'Select the country you currently reside in.', |
Contributor
There was a problem hiding this comment.
Is this just for testing purpose, or do we want to change the default story? Alternatively, we could have a WithHelpText separate story.
| onChange={ onInputChange } | ||
| aria-describedby={ | ||
| help | ||
| ? `components-form-token-input-${ instanceId }__help` |
Contributor
There was a problem hiding this comment.
Yeah, this is not ideal but I understand that the proper fix would be more involved ( I can see that you had initiall tried useBaseControlProps but then reverted to straight aria-describedby). Should we at least add an inline comment to note the tradeoff ?
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What?
Fix the
helpprop onComboboxControlso that it is programmatically associated with the combobox input viaaria-describedby.Why?
The
helptext was being rendered visually (viaBaseControl) but had noaria-describedbylinking it to the combobox input. Screen reader users would not hear the help text when interacting with the control.How?
ComboboxControl, passaria-describedbypointing to theBaseControl-rendered help element toTokenInputwhenhelpis provided.TokenInput, merge any externally passedaria-describedbywith the existing howto description ID, so both are present on the input.Also adds
helptext to the default Storybook story.Testing Instructions
npm run storybook:devand navigate to theComboboxControldefault story.aria-describedbyreferencing the help text element'sid.Use of AI Tools
Authored with Cursor (Claude).