Divider: Complete TypeScript migration of component #41991
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
walbo
added
[Feature] UI Components
|
Size Change: 0 B Total Size: 1.25 MB ℹ️ View Unchanged
|
walbo
commented
Jun 28, 2022
ciampo
approved these changes
Jul 1, 2022
There was a problem hiding this comment.
Code changes LGTM 🚀
The only aspect that I don't really like is that, in Storybook, the margin, marginStart and marginEnd props are shown with a type of SpaceInput, which isn't quite clean to the end user — although this behavior is already present on trunk and, more generally, it is a known limitation of Storybook's docgen.
Maybe we could add more details to the prop descriptions? (related to #41882)
ciampo
reviewed
Jul 1, 2022
Yes. I can add a more detailed description. |
It definitely improves the user experience when browsing Storybook, but at the same time it means that change to the original TypeScript type won't be reflected automatically in Storybook — @mirka, do you have a preference on which compromise feels better? Maybe we could just make the JSDoc comment more detailed, e.g. by adding "This prop accepts both numbers and strings. When using numbers, they will be interpreted as multiples of the space grid used across the library; when using strings, they should be valid values for the CSS WDYT ? |
Agreed. I proposed #42376 to address this issue more broadly 👍 @walbo I think we can merge this PR without the change in b227e8e, and we'll take care of it in #42376. |
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?
Completes the migration of
Dividercomponent to TypeScript.Why?
Part of the @wordpress/components's TypeScript migration (#35744).
How?
Testing Instructions
Dividercontinues to function as expected