Update HeightControl component to label inputs #63761
Merged
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 Unlinked AccountsThe following contributors have not linked their GitHub and WordPress.org accounts: @andrew-palapa. Contributors, please read how to link your accounts to ensure your work is properly credited in WordPress releases. 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. |
|
Hey folks, while going through my old notifications I found #48498, which was approved but never got merged. I made a clone of it, so that we can take another look and merge if necessary. Not sure if @alexstine is still around to confirm his original approving review — tagging also @WordPress/gutenberg-components @afercia and @joedolson for some feedback |
ciampo
added
[Package] Components
|
Size Change: +84 B (0%) Total Size: 1.75 MB
ℹ️ View Unchanged
|
tyxla
approved these changes
Jul 19, 2024
| function useUniqueId( idProp?: string ) { | ||
| const id = useInstanceId( | ||
| UnforwardedRangeControl, | ||
| 'inspector-range-control' |
There was a problem hiding this comment.
I wonder what this component has to do with inspector though. Maybe not much anymore.
There was a problem hiding this comment.
I think that's the instance ID prefix that many components in the package adopt 😓 Not sure how easy it would be to refactor away from it, but probably not in the scope for this PR ('inspector-range-control' is already used in trunk and in this PR it was moved to the useUniqueId function)
| 'inspector-range-control' | ||
| ); | ||
|
|
||
| return idProp || id; |
There was a problem hiding this comment.
I had that same question when reviewing the original PR, and at the time we agreed that || was a good choice because empty strings would not make a good id. #48498 (comment)
There was a problem hiding this comment.
Also, reminder that the useInstanceId() util supports preferredId as the third argument. (I guess it didn't before, hence the custom logic like this in some of these older components.)
There was a problem hiding this comment.
I forgot about it — thank you for pointing it out!
The current method of using a fieldset for the HeightControl inputs leaves neither of them with a functioning accessible name. This change ensures both the text field and the range slider are named, and semantically linked (with the caveat that aria-controls has little support as of now).
ciampo
force-pushed
the
fix/change-height-control-labelling
branch
from
4f55a17 to
9a97781
Compare
|
@ciampo I was just testing this PR while it was merged. I'm a little confused, what I see now is:
In the screenshot below I made the visually hidden labels visible to better illustrate:
The range input has now: an aria-labelledby, an aria-label, and an associated label element; Aria-labelledby overrides the other twos so the accessible name is not doubled. But 3 labeling are a bit redundant:
On trunk, I don't see missing labeling; Boht controls have a
Maybe a source of confusion is that a fieldset legend is not meant to label the input fields. It's meant to label the group reprezented by the fieldset. |
afercia
reviewed
Jul 22, 2024
| <fieldset className="block-editor-height-control"> | ||
| <BaseControl.VisualLabel as="legend"> | ||
| <div className="block-editor-height-control" id={ id }> | ||
| <BaseControl.VisualLabel as="label" for={ inputId } id={ labelId }> |
There was a problem hiding this comment.
I guess this for should have been htmlFor. Getting this in the condole:
Warning: Invalid DOM property `for`. Did you mean `htmlFor`?
at label
at div
at HeightControl
etc...
There was a problem hiding this comment.
Yup - I must have let my guard down knowing that this PR had been reviewed before. Thank you for pointing it out
|
Came here to report the same warning. |
|
Revert PR ready #63839 The original PR had been approved and never merged, and so I thought it would been good to go. I'm fine just reverting and keeping things as before, for the time being. |
|
Thanks for reporting, folks, I missed the warning initially 🤔 . Fine with reverting for now. |
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.
This is a copy of #48498 from @andrewhayward , moved to a branch on this repo (instead than a fork).
What?
Adds accessible names to both inputs in the
HeightControlcomponent, replacing thefieldsetwrapper and usingaria-controlsinstead.Why?
Currently,
HeightControluses a<fieldset>to label the input fields, but this doesn't provide an accessible name for either. Both fields should have an appropriate name.How?
RangeControlcomponent to accept an optional ID.<fieldset>/<legend>combination with a<label>, pointing at the text input, to ensure it has an accessible name.<label>with anaria-labelledbyto get its own accessible name.aria-controlsattribute, pointing at the text input (while acknowledging thataria-controlshas little support at the time of writing).Testing Instructions
npm run storybook:devHeightControlcomponentTesting Instructions for Keyboard
Nothing has functionally changed, so both inputs should remain as expected