Storybook: Update control types from null to undefined
#67581
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
tyxla
added
[Type] Enhancement
|
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message. To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
|
Size Change: 0 B Total Size: 1.83 MB ℹ️ View Unchanged
|
|
Flaky tests detected in f7126d2. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/12181662294
|
mirka
reviewed
Dec 5, 2024
There was a problem hiding this comment.
The intent of type: null is to suppress the rendering of a control, and I'm seeing that type: false is the correct replacement for that:
Specifying false will prevent the control from rendering.
Makes sense. Updated to |
tyxla
commented
Dec 5, 2024
| @@ -23,7 +23,7 @@ const meta: Meta< typeof NumberControl > = { | |||
| step: { control: { type: 'text' } }, | |||
| suffix: { control: { type: 'text' } }, | |||
| type: { control: { type: 'text' } }, | |||
| value: { control: null }, | |||
| value: { control: { type: 'text' } }, | |||
There was a problem hiding this comment.
Note: I thought this one made more sense than what we had before.
There was a problem hiding this comment.
The general pattern is that we suppress the value control when the story is implemented in controlled mode. It especially doesn't work in this implementation because the value prop will be overridden by the template's internal value state anyway.
There was a problem hiding this comment.
Done in 7381add.
Shipping when green.
|
Thanks, @mirka, this is ready for another look. |
mirka
approved these changes
Dec 5, 2024
| @@ -23,7 +23,7 @@ const meta: Meta< typeof NumberControl > = { | |||
| step: { control: { type: 'text' } }, | |||
| suffix: { control: { type: 'text' } }, | |||
| type: { control: { type: 'text' } }, | |||
| value: { control: null }, | |||
| value: { control: { type: 'text' } }, | |||
There was a problem hiding this comment.
The general pattern is that we suppress the value control when the story is implemented in controlled mode. It especially doesn't work in this implementation because the value prop will be overridden by the template's internal value state anyway.
|
@mirka it seems like we should have gone with Going to file a PR to move back to |
See #67646 |
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?
This PR updates
nullcontrol types toundefined.Part of #67574
Why?
Preparatory work for upgrading Storybook v8 -
nullcontrols cause type errors with v8.How?
Just updating the types.
Testing Instructions
Verify Storybook builds well and test a few controls to ensure they work the same way.
Testing Instructions for Keyboard
Same
Screenshots or screencast
None