BaseControl: Add convenience hook to generate id-related props #46170
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
We can't put this here because the prop description will be reused in child components like TextControl, where the hook stuff is irrelevant.
|
Size Change: +1.59 kB (0%) Total Size: 1.32 MB
ℹ️ View Unchanged
|
mirka
requested review from
tellthemachines,
ciampo,
aaronrobertshaw,
brookewp and
chad1008
aaronrobertshaw
approved these changes
Dec 1, 2022
There was a problem hiding this comment.
This looks like a handy addition. Thanks @mirka 👍
✅ Unit tests pass
✅ Storybook examples work as expected
✅ Components leveraging BaseControl continue to render help text appropriately
✅ Existing controls in the editor are unaffected
✅ Readme and types match
LGTM! 🚢
mpkelly
pushed a commit
to mpkelly/gutenberg
that referenced
this pull request
Dec 7, 2022
…ress#46170) * Add recommendations to `help` docs * Add `useBaseControlProps` hook to simplify usage * Pass all props through hook * Update docs * Export hook * Update stories * Remove hook details from `help` docs We can't put this here because the prop description will be reused in child components like TextControl, where the hook stuff is irrelevant. * Add jsdoc to hook * Add changelog
This was referenced Apr 29, 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.
Follow-up to #45931
What?
Adds a
useBaseControlPropsto help generate id-related props for both the BaseControl and the inner control itself.See the updated docs for how it's supposed to be used.
Why?
Right now, consumers of BaseControl are forced to generate their own unique ids, and associate the
helptext manually witharia-describedbyin a way that depends on an internal implementation detail (i.e. that thehelpelement has an${id}__helpid).I feel like the only clean way to address this would be to provide a convenience hook that would be responsible for these things. Obviously the manual way would still work, but it would be easier and less hacky if you use this hook instead.
The hook also includes the conditional logic to switch between
aria-describedbyandaria-detailsdepending on thehelpvalue.Next steps
It isn't super high priority to migrate all the existing usage, but it would be nice to use this hook in new components, or when adding better
helpsemantics to existing components that don't add anaria-describedbyat the moment (e.g. ToggleGroupControl).Testing Instructions