Heading: Complete TypeScript migration of component #41921
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
|
There was a problem hiding this comment.
Thanks for the continued efforts typing the components package @walbo 🙇
This is looking pretty good.
While testing the component in the Storybook I noticed that the variant control is a radio button. This means you can't toggle off the muted variant once it's clicked. We should probably tweak that while we're here.
Not sure if a check or select control might be better options. If using a check control the example markup may show variant={[]} when you toggle muted on then off. We could even switch the control to boolean and set the variant prop to muted based on that being set.
Example diff demonstrating toggle control for variant etc.
diff --git a/packages/components/src/heading/stories/index.tsx b/packages/components/src/heading/stories/index.tsx
index f25b21728e..1cc78538ac 100644
--- a/packages/components/src/heading/stories/index.tsx
+++ b/packages/components/src/heading/stories/index.tsx
@@ -19,7 +19,7 @@ const meta: ComponentMeta< typeof Heading > = {
letterSpacing: { control: { type: 'text' } },
lineHeight: { control: { type: 'text' } },
optimizeReadabilityFor: { control: { type: 'color' } },
- variant: { control: { type: 'radio' }, options: [ 'muted' ] },
+ variant: { control: { type: 'boolean' } },
weight: { control: { type: 'text' } },
},
parameters: {
@@ -30,8 +30,9 @@ const meta: ComponentMeta< typeof Heading > = {
export default meta;
export const Default: ComponentStory< typeof Heading > = ( props ) => (
- <Heading { ...props } />
+ <Heading { ...props } variant={ props.variant ? 'muted' : undefined } />
);
Default.args = {
children: 'Heading',
+ level: '3',
};
Also, it might be beneficial to demonstrate the level prop's use within the default story.
Other than that, I left a couple of other very minor comments inline as well.
✅ No typing errors
✅ Unit tests pass
✅ Code changes make sense
✅ Has changelog & readme props and types pretty much match
✅ Component functions correctly in both Storybook and editors
✅ Auto-generated docs in Storybook are meaningful
❔ Storybook example has appropriate controls
I don't feel super strongly about it, but for context, here are the pros/cons that were discussed: #38842 (comment) If y'all think it's worth addressing, another way to go might be: variant: {
control: { type: 'radio' },
options: [ 'undefined', 'muted' ],
mapping: { undefined, muted: 'muted' },
}, |
Implemented the |
aaronrobertshaw
approved these changes
Jun 28, 2022
There was a problem hiding this comment.
Thanks for the updates!
LGTM 🚢
✅ No typing errors
✅ Unit tests pass
✅ Code changes make sense
✅ Has changelog & readme props and types match
✅ Component functions correctly in both Storybook and editors
✅ Auto-generated docs in Storybook are meaningful
✅ Storybook example has appropriate controls
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
Headingcomponent to TypeScript.Why?
Part of the @wordpress/components's TypeScript migration (#35744).
How?
types.jsTesting Instructions
Headingcontinues to function as expected