ResizableBox: Remove knobs in stories #46774
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
mirka
commented
Dec 23, 2022
Comment on lines
127
to
129
| const ResizableBox = forwardRef( UnforwardedResizableBox ); | ||
|
|
||
| export default ResizableBox; |
There was a problem hiding this comment.
Tweaked the component export so we can use the TypeScript data in the Storybook props table.
Comment on lines
+52
to
+53
| height: height + delta.height, | ||
| width: width + delta.width, |
There was a problem hiding this comment.
The parseInt() that used to be here turned out to be unnecessary. Thanks TypeScript 🙏
| }; | ||
|
|
||
| export const _default = () => { | ||
| const content = text( 'Example: Content', 'Resize' ); |
There was a problem hiding this comment.
content is not an actual component prop.
|
Size Change: -384 B (0%) Total Size: 1.32 MB
ℹ️ View Unchanged
|
ciampo
reviewed
Jan 5, 2023
Comment on lines
20
to
24
| __experimentalShowTooltip: { control: 'boolean' }, | ||
| minHeight: { control: 'number' }, | ||
| minWidth: { control: 'number' }, | ||
| onResizeStop: { action: 'onResizeStop' }, | ||
| showHandle: { control: 'boolean' }, |
There was a problem hiding this comment.
Do you know why are these props not shown by default in the Storybook docs?
There was a problem hiding this comment.
Good question. I tweaked the export so at least our first-party types are visible ✅
However, all the props coming from the upstream re-resizable are not shown at all 🤔 So I think what will happen is that in the full TypeScript migration, we'll decide which ones of the upstream props are noteworthy, and add our own typings/descriptions for them so they'll be shown in the Storybook props table. For all the other upstream props, the main component description will nudge people toward the re-resizable docs as written in the readme.
✅ Done in 7cd7eab |
|
Flaky tests detected in 4cc4395. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/3857597185
|
ciampo
approved these changes
Jan 5, 2023
| const meta: ComponentMeta< typeof ResizableBox > = { | ||
| title: 'Components/ResizableBox', | ||
| component: ResizableBox, | ||
| argTypes: { |
There was a problem hiding this comment.
We should probably hide children's control, as it currently shows a react object that can't really be edited
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.
Part of #35665
What?
Remove the Knobs add-on from
ResizableBoxstories.Why?
This is now a blocker for supporting npm 8 (#46443).
How?
Just a quick, minimal refactor.
Testing Instructions
npm run storybook:devResizableBoxcomponent.