Skip to content

UI: Add component status notes to Storybook#77988

Open
aduth wants to merge 3 commits intotrunkfrom
add/wp-ui-component-status
Open

UI: Add component status notes to Storybook#77988
aduth wants to merge 3 commits intotrunkfrom
add/wp-ui-component-status

Conversation

@aduth
Copy link
Copy Markdown
Member

@aduth aduth commented May 5, 2026

What?

Related: #76135

Updates Storybook stories in @wordpress/ui to add status indicators introduced in #74815.

Why?

To make it clearer which components are ready to use in Gutenberg, and what blockers remain for the components that are not ready yet.

Also serves as a good nudge to ourselves what remains before we can mark a component as stable, or even instances where there's no good reason for a component not to be stable already (e.g. "Icon").

This could also potentially allow us to surface some more nuance through the design system MCP (e.g. use X component for now, but Y component from @wordpress/ui will soon be available for use).

How?

Add componentStatus entry for each component story in @wordpress/ui:

Use whereUsed: 'global' for every component, since all of these components are meant to be globally usable.

Testing Instructions

Verify in Storybook:

  1. Run npm run storybook:dev
  2. Go to http://localhost:50240/
  3. Verify every "Docs" under "Design System" > "Components" components has a status indicator at the top

Review the individual component status notes. Do they make sense? If you disagree with a component's status, do we have the actual blockers tracked anywhere?

Screenshots or screencast

Examples:

Stable:

image

Use with caution:

image

Use of AI Tools

Implemented using Claude Code and Opus 4.7, pre-prompted with logic described in "How?" and iterations on specific status notes.

cc @grbicsanja

@aduth aduth requested a review from a team as a code owner May 5, 2026 21:09
@aduth aduth added [Type] Developer Documentation Documentation for developers [Package] UI /packages/ui labels May 5, 2026
import * as EmptyState from '../';

const meta: Meta< typeof EmptyState.Root > = {
tags: [ 'manifest' ],
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@retrofox Per #77765 (comment), I went ahead and added the tag here, as part of marking this "stable".

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for letting me know. I've just started addressing it.

@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 5, 2026

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 props-bot label.

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Co-authored-by: aduth <aduth@git.wordpress.org>
Co-authored-by: retrofox <retrofox@git.wordpress.org>

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 5, 2026

Flaky tests detected in 7a9eaa7.
Some tests passed with failed attempts. The failures may not be related to this commit but are still reported for visibility. See the documentation for more information.

🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/25402465006
📝 Reported issues:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

[Package] UI /packages/ui [Type] Developer Documentation Documentation for developers

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants