Skip to content

UI: Use string label type for form controls #77860

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mirka merged 3 commits into from
May 5, 2026
Merged

UI: Use string label type for form controls #77860

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b8f8594
ui: Use string label type for form controls
mirka Apr 30, 2026
ace5a27
Add changelog
mirka Apr 30, 2026
797a29d
Merge branch 'trunk' into try/ui-control-label-string
mirka May 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions packages/ui/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

## Unreleased

### Breaking Changes

- `InputControl`: Narrow the TypeScript type of the `label` prop to plain strings ([#77860](https://github.com/WordPress/gutenberg/pull/77860)).

### Bug Fixes

- `Drawer`: Restore the slide-out animation when the popup closes ([#77800](https://github.com/WordPress/gutenberg/pull/77800)).
Expand Down
2 changes: 1 addition & 1 deletion packages/ui/src/form/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ export type ControlProps = {
/**
* The accessible label. All controls must be labeled.

@ciampo ciampo May 5, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In the PR description you mention "Rich label content is still possible through the lower-level Field.Label primitive" — should we add a similar sentence to the JSDoc for this label prop and/or the JSDoc of the higher-level form components and/or create an Overview Storybook page for the higher-level form components (since we already have one for the lower-level ones?)

@mirka mirka May 5, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wouldn't say it's particularly useful information for consumers, since it's not like "rich label content is possible" means "feel free to put links and buttons in the label" which is almost always what people are trying to do 😅

*/
label: React.ComponentProps< typeof Field.Label >[ 'children' ];
label: string;
/**
* The accessible description, associated using `aria-describedby`.
*
Expand Down
Loading