Storybook: Add badges to private components #58123
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
|
Size Change: -882 B (0%) Total Size: 1.7 MB
ℹ️ View Unchanged
|
|
Looking good! I wonder if we should also have a badge for "internal only" components (eg, CustomSelectControl V2) |
Oh, forgot about that one. How about something like this: 
|
|
Should we also have 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 Core SVNIf you're a Core Committer, use this list when committing to GitHub Merge commitsIf 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. |
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?
Adds an informational badge to the Storybook pages of any components that are still locked as private.
Why?
We currently don't have a way to tell from the Storybook which components are "experimental" (implicitly public) vs. "private".
I think we should prefer badge-based solutions like this rather than groupings in the sidebar, because the grouping names affect URLs and will break hyperlinks whenever there are status changes.
How?
Uses an addon called Storybook Addon Badges, which seems to be the most popular addon of its kind.
Testing Instructions
See the Storybook pages for any private component, e.g. Tabs or ProgressBar.
Screenshots or screencast