Panel: Remove knobs from stories #46958
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
Jan 7, 2023
| @@ -8,13 +8,13 @@ import classnames from 'classnames'; | |||
| */ | |||
| import { forwardRef } from '@wordpress/element'; | |||
|
|
|||
| const PanelRow = forwardRef( ( { className, children }, ref ) => ( | |||
| const PanelRow = ( { className, children }, ref ) => ( | |||
There was a problem hiding this comment.
Tweaked the export so the displayName isn't borked.
There was a problem hiding this comment.
Interesting that this is enough! I though we had to name-export PanelRow
There was a problem hiding this comment.
This was super weird, because the original code would show the display name as [object Object] 😕 I don't think I've ever seen that before.
Aside from that, I'm still unclear on why behavior seems inconsistent between "named but unexported" and "named and exported". Sometimes it works without an export, sometimes it doesn't 🤷
| header: 'My panel', | ||
| children: ( | ||
| <> | ||
| <PanelBody title="First section"> |
There was a problem hiding this comment.
Changed the default story to have multiple bodies so it looks more like a Panel.
Comment on lines
-87
to
-105
| function ScrollableContainer( { children } ) { | ||
| return ( | ||
| <div | ||
| style={ { | ||
| width: 300, | ||
| height: '100vh', | ||
| overflowY: 'auto', | ||
| margin: 'auto', | ||
| boxShadow: '0 0 0 1px #ddd inset', | ||
| } } | ||
| > | ||
| { children } | ||
| </div> | ||
| ); | ||
| } | ||
|
|
||
| function Placeholder( { height = 200 } ) { | ||
| return <div style={ { background: '#ddd', height, width: '100%' } } />; | ||
| } |
There was a problem hiding this comment.
Removed these for simplicity. Placeholder can be particularly confusing because we have an actual wp-component called Placeholder.
|
Size Change: -7 B (0%) Total Size: 1.32 MB
ℹ️ View Unchanged
|
|
Flaky tests detected in 0c4c8e8. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/3860042814
|
ciampo
approved these changes
Jan 9, 2023
There was a problem hiding this comment.
Great work! LGTM 🚀
One thought — previously, the knobs also exposed the opened prop for the PanelBody component. I assume it's not available in the list of controls because we can't display a control for a subcomponent ?
Out of curiosity — if it was possible to display it, I imagine our approach would be to leave it undefined by default ("uncontrolled" mode), and let the user edit the controls (making it a "controlled" component) ? Just wondering :)
| @@ -8,13 +8,13 @@ import classnames from 'classnames'; | |||
| */ | |||
| import { forwardRef } from '@wordpress/element'; | |||
|
|
|||
| const PanelRow = forwardRef( ( { className, children }, ref ) => ( | |||
| const PanelRow = ( { className, children }, ref ) => ( | |||
There was a problem hiding this comment.
Interesting that this is enough! I though we had to name-export PanelRow
It is technically possible, just it would be confusing as documentation since we're sticking to a strict 1:1 relationship between "control" and "component prop". (Or maybe that's what you meant 😄)
Yeah I'd have to think about it, but this might be one of the cases where it's worth adding a story specifically to highlight Controlled mode. Because I feel like most people would want to use it uncontrolled. (Unlike form components, where most people use them controlled.) |
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
Panelstories.Why?
This is now a blocker for supporting npm 8 (#46443).
How?
Just a quick, minimal refactor.
Testing Instructions
npm run storybook:devPanelcomponent.