DropdownMenu: convert Storybook examples from knobs to controls #47149
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
commented
Jan 13, 2023
| @@ -14,6 +14,8 @@ | |||
| - `SandBox`: Convert to TypeScript ([#46478](https://github.com/WordPress/gutenberg/pull/46478)). | |||
| - `ResponsiveWrapper`: Convert to TypeScript ([#46480](https://github.com/WordPress/gutenberg/pull/46480)). | |||
| - `ItemGroup`: migrate Storybook to controls, refactor to TypeScript ([46945](https://github.com/WordPress/gutenberg/pull/46945)). | |||
| - `Toolbar`: unify Storybook examples under one file, migrate from knobs to controls ([47117](https://github.com/WordPress/gutenberg/pull/47117)). | |||
There was a problem hiding this comment.
Forgot to add an entry in #47117, adding it here
|
Size Change: 0 B Total Size: 1.33 MB ℹ️ View Unchanged
|
|
Flaky tests detected in 8bfdf6f. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/3913278425
|
mirka
reviewed
Jan 16, 2023
Comment on lines
66
to
68
| toggleProps: { | ||
| showTooltip: true, | ||
| }, |
There was a problem hiding this comment.
Noting that showTooltip = true seems to be the default behavior:
There was a problem hiding this comment.
Yup, done in f8747ec
| 'Show tooltip on a toggle button', | ||
| true | ||
| ); | ||
| const Template = ( props ) => <DropdownMenu { ...props } />; |
There was a problem hiding this comment.
Should we set a hardcoded height like in Dropdown so the popover doesn't get cut off in Docs view?
There was a problem hiding this comment.
Great point — d2ed3fd
Comment on lines
+72
to
+104
| WithChildren.args = { | ||
| label: 'Select a direction.', | ||
| icon: more, | ||
| children: ( { onClose } ) => ( |
There was a problem hiding this comment.
Weird how this doesn't show our children code at all 😭 Might be worth hiding the code and adding manual snippet in the story description.
There was a problem hiding this comment.
Added custom code snippet in d8b8af7
There was a problem hiding this comment.
Ugh, manual snippets look so much nicer. I wish there wasn't such a big increase in maintenance cost.
ciampo
force-pushed
the
feat/components-dropdown-menu-knobs-to-controls
branch
from
8bfdf6f
to
d8b8af7
Compare
|
@mirka this is ready for a final review :) |
mirka
approved these changes
Jan 17, 2023
Comment on lines
+72
to
+104
| WithChildren.args = { | ||
| label: 'Select a direction.', | ||
| icon: more, | ||
| children: ( { onClose } ) => ( |
There was a problem hiding this comment.
Ugh, manual snippets look so much nicer. I wish there wasn't such a big increase in maintenance cost.
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?
Convert
DropdownMenuStorybook examples from using knobs (deprecated) to controlsWhy?
The knobs addon is currently blocking using npm 8 (see #46443)
How?
I rewrote the Storybook example, keeping the previous default example intact and adding one more example ("With Children"). I also added more info for the control args, so that all relevant props show in the controls panel.
Testing Instructions
trunkWithChildrenStorybook example works as expected