Storybook: Show badges in sidebar #58518
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
andrewhayward
added
the
[Type] Developer Documentation
|
Size Change: +8 B (0%) Total Size: 1.71 MB
ℹ️ View Unchanged
|
ciampo
reviewed
Feb 1, 2024
packages/components/src/custom-select-control-v2/stories/index.story.tsx
Outdated
Show resolved
Hide resolved
mirka
approved these changes
Feb 1, 2024
packages/components/src/custom-select-control-v2/stories/index.story.tsx
Outdated
Show resolved
Hide resolved
|
As also asked in #58123 (comment), should we also show a badge for deprecated components? |
|
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. |
Depends on whether Storybook will add sufficient filtering features in the sidebar, but I'd rather not clutter the main Components grouping with deprecated stuff, so at the moment I kind of prefer moving them to the Deprecated grouping like we did with RadioGroup. (Assuming we set up a middleware to maintain permalinks.) No strong opinion though. |
|
Ok re. not showing a deprecated badge in the sidebar in favour of having a deprecated group (although it could be useful to display them in the canvas top toolbar) |
|
Flaky tests detected in 4d63235. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/7919032863
|
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?
Extending the work done in #58123, this patch adds informational badges to the Storybook sidebar, where relevant.
Why?
It make it more obvious when scanning the sidebar what the status of a component is.
How?
This is a first pass, and requires some duplication of meta data. Unfortunately Storybook doesn't make
parametersavailable until the page is rendered.Future work could involve abstracting away the duplication with some sort of support function.
Testing Instructions
See the Storybook sidebar for components that are Private/WIP.
Screenshots or screencast