Icon: Remove knobs in stories #46517
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
|
Size Change: 0 B Total Size: 1.32 MB ℹ️ View Unchanged
|
mirka
commented
Dec 13, 2022
| ); | ||
|
|
||
| export const _default = () => { | ||
| const size = number( 'Size', '24' ); |
There was a problem hiding this comment.
I removed this explicit 24px default, since we should just showcase the default component behavior here (which is 20 when icon is a Dashicon, and 24 when otherwise).
Comment on lines
-41
to
-42
| export const sizes = () => { | ||
| const iconSizes = [ 14, 16, 20, 24, 28, 32, 40, 48, 56 ]; |
There was a problem hiding this comment.
I removed this story because it kind of implies that this set of numbers is our official sizing scale. Plus, the size prop is very easy to discover, so no need to highlight this specifically.
There was a problem hiding this comment.
This is good to know - I actually thought those are the recommended / official sizes. Good to know they aren't 👍
| }; | ||
|
|
||
| export const colors = () => { | ||
| const iconColors = [ 'blue', 'purple', 'green' ]; |
There was a problem hiding this comment.
Also simplified this to only show one color, as this fits the Controls paradigm better.
There was a problem hiding this comment.
Theoretically, we could introduce a control for the color, but I'm not sure if that's worth the effort.
There was a problem hiding this comment.
We can't really add a control for things that are not component props, since we want to maintain a 1:1 relationship between props and controls.
I've been wanting to add an official prop to set fill colors though! #40102
tyxla
approved these changes
Dec 20, 2022
Comment on lines
-41
to
-42
| export const sizes = () => { | ||
| const iconSizes = [ 14, 16, 20, 24, 28, 32, 40, 48, 56 ]; |
There was a problem hiding this comment.
This is good to know - I actually thought those are the recommended / official sizes. Good to know they aren't 👍
| }; | ||
|
|
||
| export const colors = () => { | ||
| const iconColors = [ 'blue', 'purple', 'green' ]; |
There was a problem hiding this comment.
Theoretically, we could introduce a control for the color, but I'm not sure if that's worth the effort.
Comment on lines
+78
to
+80
| <SVG> | ||
| <Path d="M5 4v3h5.5v12h3V7H19V4z" /> | ||
| </SVG> |
There was a problem hiding this comment.
For the protocol, I found these Ts a bit confusing before, and I find them confusing again - from the perspective of someone getting familiar with the component. I wonder if we can make it clearer as to what we're doing here. Maybe add some inline comments. Just trying to put myself into the shoes of someone not familiar at all with our components library.
There was a problem hiding this comment.
Completely agree. This might be a case where we'll want to add manual code snippets in the story description, because the auto-generated ones don't help at all:
aristath
approved these changes
Dec 20, 2022
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
Iconstories. I've also converted the file to TypeScript since the component is already typed.Why?
This is now a blocker for supporting npm 8 (#46443).
How?
Just a quick, minimal refactor.
Testing Instructions
npm run storybook:devComponents / Iconcomponent. (Careful, there is also aIcons / Iconcomponent 🙃)