ItemGroup: migrate Storybook to controls, refactor to TypeScript #46945
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
ciampo
added
[Type] Code Quality
ciampo
changed the title
ItemGroup: migrate Storybook to controls, refactor to TypeScript
ciampo
commented
Jan 6, 2023
| <ItemGroup { ...props } /> | ||
| ); | ||
|
|
||
| export const Default: ComponentStory< typeof ItemGroup > = Template.bind( {} ); |
There was a problem hiding this comment.
Previously, ItemGroup's stories were much more complex, and involved many other components in an effort to showcase how the component could be used:
- in combination with
Dropdown - for more "complex" layouts (i.e. the ones used in Global Styles sidebar)
For now, I've decided not to convert those examples to TypeScript/controls because I feel like we've been recently trying to keep Storybook examples closer to the component they represent.
What do folks think?
There was a problem hiding this comment.
Yes, I agree the previous stories were a bit much.
Though, I wasn't familiar with this component and my first impression when seeing the new default story was that I couldn't understand what the component was supposed to be used for. Would it be more straightforward if we just had a group of three clickable Items? I'm assuming that is the main use case because I had a hard time finding an example in the Gutenberg app where there were unclickable items.
And if we want to highlight other usages like unclickable items, different padding sizes, borders, etc. we could do that in separate stories (doesn't have to be in this PR).
There was a problem hiding this comment.
Pushed some changes in 6623d9b — let me know if they look good to you (if they're not, I can open a follow-up)
ciampo
commented
Jan 6, 2023
| <ItemGroup { ...props } /> | ||
| ); | ||
|
|
||
| export const Default: ComponentStory< typeof ItemGroup > = Template.bind( {} ); |
There was a problem hiding this comment.
Also, note that I removed the hardcoded max-width from the component, since we can now leverage some custom Storybook tools to change the container's width
ciampo
commented
Jan 6, 2023
| @@ -33,6 +33,7 @@ export const itemWrapper = css` | |||
| `; | |||
|
|
|||
| export const item = css` | |||
| box-sizing: border-box; | |||
There was a problem hiding this comment.
This change was necessary to fix an issue with the separators overflowing the parent ItemGroup wrapper:
|
Size Change: +5 B (0%) Total Size: 1.32 MB
ℹ️ View Unchanged
|
|
Flaky tests detected in a947ad9. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/3876020347
|
mirka
approved these changes
Jan 6, 2023
| @@ -33,6 +33,7 @@ export const itemWrapper = css` | |||
| `; | |||
|
|
|||
| export const item = css` | |||
| box-sizing: border-box; | |||
| <ItemGroup { ...props } /> | ||
| ); | ||
|
|
||
| export const Default: ComponentStory< typeof ItemGroup > = Template.bind( {} ); |
There was a problem hiding this comment.
Yes, I agree the previous stories were a bit much.
Though, I wasn't familiar with this component and my first impression when seeing the new default story was that I couldn't understand what the component was supposed to be used for. Would it be more straightforward if we just had a group of three clickable Items? I'm assuming that is the main use case because I had a hard time finding an example in the Gutenberg app where there were unclickable items.
And if we want to highlight other usages like unclickable items, different padding sizes, borders, etc. we could do that in separate stories (doesn't have to be in this PR).
ciampo
force-pushed
the
feature/components-item-group-typescript-knobs
branch
from
5896305 to
6623d9b
Compare
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?
Related to #46443
Part of #35744
Migrate
ItemGroup's Storybook examples to controls instead of knobs, and rewrite in TypeScriptWhy?
Knobs are deprecated
How?
Leveraging TypeScript to generate docs and controls, so that knobs are not necessary
Testing Instructions
Open Storybook, make sure that the
ItemGroupexample works and feels good