components: Expose TS types of props for public components #72831
Conversation
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
|
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. |
|
Size Change: 0 B Total Size: 2.38 MB ℹ️ View Unchanged
|
aduth
requested changes
Nov 4, 2025
Member
aduth
left a comment
There was a problem hiding this comment.
This is documented as an intentional decision to not export these types, and instead encourage React.ComponentProps for accessing the types.
gutenberg/packages/components/README.md
Lines 60 to 62 in 3be8bb2
Member
|
Proposing an alternative fix in #72979 |
Member
Author
|
Closing in favour of the proposed alternative - #72979 |
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?
As a part of #72032, we have added the
exportsfield to many packages includingcomponents. This prevents what was previously possible, i.e. to import component types from/build-typessub-path. But, once you defineexportsfor a package, you can't import from the sub-paths that are not defined inexportsfield, thus making it impossible to import type, should you need them.So, to ensure that any consumer component is able to import and use the types for component props, we are exposing them from the root.
Why?
To allow importing of TS types for component props.
How?
export * from '...')types.tsfilesBadge,DateCalendar, etc,Testing Instructions
Just verify that only the public components are exposed.
Testing Instructions for Keyboard
Screenshots or screencast