CustomSelectControl V2: fix labelling with a visually hidden label #63137
Conversation
This file contains 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
|
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. |
ciampo
added
[Type] Bug
This was referenced Jul 4, 2024
|
Size Change: +11 B (0%) Total Size: 1.76 MB
ℹ️ View Unchanged
|
|
Flaky tests detected in f606ee9. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/9797481030
|
mirka
reviewed
Jul 4, 2024
Not really, my initial fix focused on using the components that were already being used (and that made me miss the |
ciampo
force-pushed
the
fix/custom-select-control-v2-combobox-hidden-label
branch
from
f606ee9
to
c2aa264
Compare
|
@mirka since I don't think it would be possible to use I also had to allow The only visible difference is that the label now renders a tiny gap above itself, due to the fact that
|
ciampo
commented
Jul 5, 2024
| @@ -55,7 +55,6 @@ WithHelpText.args = { | |||
| * otherwise use if the `label` prop was passed. | |||
| */ | |||
| export const WithVisualLabel: StoryFn< typeof BaseControl > = ( props ) => { | |||
| // @ts-expect-error - Unclear how to fix, see also https://github.com/WordPress/gutenberg/pull/39468#discussion_r827150516 | |||
There was a problem hiding this comment.
Well, it looks like the way to fix it was to allow ref forwarding 🤷♂️
ciampo
commented
Jul 5, 2024
Comment on lines
+120
to
+124
| // @ts-expect-error `children` are passed via the render prop | ||
| <VisuallyHidden /> | ||
| ) : ( | ||
| // @ts-expect-error `children` are passed via the render prop | ||
| <BaseControl.VisualLabel as="div" /> |
There was a problem hiding this comment.
Using the label HTML element is not correct in this case, as also confirmed by the ariakit docs:
Since it's not a native select element, we can't use the native label element.
There was a problem hiding this comment.
Interesting! I played around and confirmed that although a native label will work as expected in Chrome, it behaves differently in Firefox and Safari. Clicking on the label not only focuses but clicks the "select button", expanding the dropdown. So yeah, I guess it does need special handling 🫤
There was a problem hiding this comment.
Yup, that's part of what Ariakit.SelectLabel does under the hood
|
I extracted the Once merged, I'll rebase and remove those same changes from this PR. |
This was referenced Jul 5, 2024
Furthermore, this visual difference won't manifest in a wp-admin context because |
ciampo
force-pushed
the
fix/custom-select-control-v2-combobox-hidden-label
branch
from
ea8afa5
to
7424442
Compare
I agree that it would be risky — let's leave as-is. In the long term, I'd like to re-think I merged #63169 and rebased this PR. It should be ready for a last round of review |
tyxla
reviewed
Jul 5, 2024
| @@ -436,4 +436,14 @@ describe.each( [ | |||
| } ) | |||
| ).toBeVisible(); | |||
| } ); | |||
|
|
|||
| it( 'Should label the component correctly even when the label is not visible', () => { | |||
huubl
pushed a commit
to huubl/gutenberg
that referenced
this pull request
Jul 10, 2024
…ess#63137) * Add unit tests * Use ariakit's labelling logic even when the label is visually hidden * CHANGELOG * Use BaseControl.VisualLabel
carstingaxion
pushed a commit
to carstingaxion/gutenberg
that referenced
this pull request
Jul 18, 2024
…ess#63137) * Add unit tests * Use ariakit's labelling logic even when the label is visually hidden * CHANGELOG * Use BaseControl.VisualLabel
This was referenced Jul 24, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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?
Part of #55023
Requires #63169
Fix a bug in the V2 implementation where the component wouldn't be labelled property to assistive technology when the label is hidden visually via the
hideLabelFromVisionprop.Why?
Making sure that controls are properly labelled is essential to ensure a good experience for all users.
How?
I refactored the code and made it so that the internal implementation of
CustomSelectControlV2always relies on theAriakit.SelectLabelcomponent even when thehideLabelFromVisionistrue, which takes care of setting the correct attributes necessary for the control labeling. I was able to do so by leveraging therenderprop (see docs).Testing Instructions
trunk)hideLabelFromVisionprop:trunkrole="combobox"is correctly labeled by the hiddenlabel