Storybook: Add stories for BlockAlignmentControl and BlockAlignmentToolbar components#67233
Open
Storybook: Add stories for BlockAlignmentControl and BlockAlignmentToolbar components#67233
Conversation
|
Size Change: 0 B Total Size: 1.84 MB ℹ️ View Unchanged
|
…-alignment-control-stories
|
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. |
t-hamano
reviewed
Dec 8, 2024
Contributor
t-hamano
left a comment
There was a problem hiding this comment.
Thanks for the PR!
While reviewing this PR, I noticed that the documentation for this component itself is insufficient. Not all props that are actually supported are documented.
Specifically, controls and isCollapsed. As for the isToolbar prop, it is determined internally depending on whether you use BlockAlignmentControl or BlockAlignmentToolbar, so there is no need to document it.
Could you investigate the behavior of these two and reflect it in the README and Storybook?
| argTypes: { | ||
| value: { | ||
| control: { type: null }, | ||
| defaultValue: 'undefined', |
Contributor
There was a problem hiding this comment.
defaultValue is deprecated so let's remove it. It should not affect behavior.
| argTypes: { | ||
| value: { | ||
| control: { type: null }, | ||
| defaultValue: 'undefined', |
Contributor
There was a problem hiding this comment.
defaultValue is deprecated so let's remove it. It should not affect behavior.
...block-editor/src/components/block-alignment-control/stories/block-alignment-toolbar.story.js
Show resolved
Hide resolved
t-hamano
reviewed
Dec 27, 2024
Contributor
t-hamano
left a comment
There was a problem hiding this comment.
Sorry for the late reply.
To make stories more understandable, it's a good idea to define types and default values for the props. You can define them in the following fields. Take a look at other components:
- Types:
meta.argTypes.{propName}.table.type.summary - Default value:
meta.argTypes.{propName}.table.defaultValue.summary
Comment on lines
+44
to
+48
| - **Default:** | ||
|
|
||
| ```js | ||
| [ 'none', 'left', 'center', 'right', 'wide', 'full' ]; | ||
| ``` |
Contributor
There was a problem hiding this comment.
Suggested change
| - **Default:** | |
| ```js | |
| [ 'none', 'left', 'center', 'right', 'wide', 'full' ]; | |
| ``` | |
| - **Default:** [ `none`, `left`, `center`, `right`, `wide`, `full` ] |
Comment on lines
+11
to
+13
| /** | ||
| * The `BlockAlignmentToolbar` component is used to render block alignment options in the editor. The different alignment options it provides are `left`, `center`, `right`, `wide` and `full`. | ||
| */ |
Contributor
There was a problem hiding this comment.
Let's move this comment to meta.parameters.docs.description.component field.
Comment on lines
+11
to
+15
| /** | ||
| * The `BlockAlignmentControl` component is used to render block alignment options in the editor. The different alignment options it provides are `left`, `center`, `right`, `wide` and `full`. | ||
| * | ||
| * If you want to use the block alignment control in a toolbar, you should use the `BlockAlignmentToolbar` component instead. | ||
| */ |
Contributor
There was a problem hiding this comment.
Let's move this comment to meta.parameters.docs.description.component field.
| description: 'An array of available alignment controls.', | ||
| }, | ||
| isCollapsed: { | ||
| control: { type: null }, |
Contributor
There was a problem hiding this comment.
Suggested change
| control: { type: null }, | |
| control: 'boolean', |
Let's make this parameter controllable.
aef25885501c2a0fed0ba5ef131b7d98.mp4
…add/block-alignment-control-stories
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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 #67165
What?
This PR will add stories for
BlockAlignmentControlandBlockAlignmentToolbarcomponents in the StorybookWhy?
Most of Block Editor components don't have stories.
Testing Instructions
npm run storybook:devBlockAlignmentControlandBlockAlignmentControlstories.Screenshots or screencast
BlockEditor-BlockAlignmentControl---Docs-.-Storybook.webm