Storybook: Add badges based on tags
#61111
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
added
[Type] Developer Documentation
|
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.75 MB ℹ️ View Unchanged
|
mirka
commented
Apr 25, 2024
| @@ -33,8 +33,8 @@ const meta: Meta< typeof UseCompositeStorePlaceholder > = { | |||
| // @ts-expect-error - See https://github.com/storybookjs/storybook/issues/23170 | |||
| CompositeItem, | |||
| }, | |||
| tags: [ 'status-private' ], | |||
There was a problem hiding this comment.
We already had a slip-up here, where the tags weren't present in the metadata so the icon wasn't being displayed in the sidebar.
The automation in this PR will prevent omissions like this.
| @@ -34,7 +34,8 @@ export default { | |||
| controls: { expanded: true }, | |||
| docs: { canvas: { sourceState: 'shown' } }, | |||
| }, | |||
| } as Meta< typeof DimensionControl >; | |||
There was a problem hiding this comment.
Converting this back to our standard format, because the type casting overly complicates the AST parsing we'd have to do. Not worth it right now.
mirka
commented
Apr 25, 2024
| @@ -21,8 +21,8 @@ const meta: Meta< typeof CustomSelectControl > = { | |||
| onChange: { control: { type: null } }, | |||
| value: { control: { type: null } }, | |||
| }, | |||
| tags: [ 'status-wip' ], | |||
tyxla
approved these changes
May 7, 2024
bph
pushed a commit
to bph/gutenberg
that referenced
this pull request
May 27, 2024
* Consolidate tags in stories * DimensionControl: Standardize story meta format for easier parsing * Storybook: Add badges based on `tags` Co-authored-by: mirka <[email protected]> Co-authored-by: tyxla <[email protected]>
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?
Automatically add a status tag (
Private,WIP, etc) to the story, based on thetagsproperty of the story metadata.Why?
This builds upon #58123 where we added component status badges, and #58518 where the status icon was inserted into the Storybook sidebar as well. The badge identifiers needed to be set in
meta.parameters.badges(key for a third-party badge plugin), whereas the sidebar injection required identifiers to be present inmeta.tags(an official Storybook key).Since this duplication of metadata is error-prone, and we'll probably be relying on the
meta.tagsfor more applications in the future (e.g. categorizing, filtering), we decided we should maketagsthe single source of truth.How?
Add a simple Babel plugin to copy relevant tags into the
meta.parameters.badgesfield.Testing instructions
For tagged components like ProgressBar, the Storybook should show a badge icon in the sidebar in addition to the badge in the toolbar.