Skip to content

UI: Recommend Notice component - #82685

Merged
aduth merged 2 commits into
trunkfrom
update/ui-recommend-notice
Sep 30, 2026
Merged

aduth merged 2 commits into
trunkfrom
update/ui-recommend-notice

Conversation

@aduth

@aduth aduth commented Sep 9, 2026

Copy link
Copy Markdown
Member

What?

Updates component recommendations so that @wordpress/ui's Notice is recommended over the component from @wordpress/components.

Part of #76135

Why?

All known blockers to readiness have been resolved.

The last known blocker was its internal dependency on the Button component which is used in presenting actions. Based on #76135 (comment), the Button component itself is effectively ready, absent some migration documentation.

How?

  • Updates Storybook tags and status for each version of the component to mark @wordpress/ui implementation as the recommended option
  • Updates tooling artifacts around ESLint suppressions, Storybook manifest, and redundant inline lint disabling

Testing Instructions

Verify that each component's status is reflected accurately in Storybook via npm run storybook:dev.

Bonus points:

Use of AI Tools

Used Cursor IDE + Auto model to implement, verified manually.

@aduth
aduth requested review from a team and retrofox as code owners September 9, 2026 13:58
@aduth aduth added [Type] Enhancement A suggestion for improvement. Design System Issues related to the system of combining components according to best practices. [Package] UI /packages/ui labels Sep 9, 2026
@github-actions github-actions Bot added [Package] Components /packages/components [Package] Editor /packages/editor [Tool] ESLint plugin /packages/eslint-plugin [Package] Edit Widgets /packages/edit-widgets [Package] Widget Dashboard /packages/widget-dashboard labels Sep 9, 2026
@github-actions

github-actions Bot commented Sep 9, 2026 •

Copy link
Copy Markdown

🤖 PR meta 🤖

📦 Bundle size

Size Change: 0 B

Total Size: 8.25 MB

f9be9fd Run

⚡ Performance

Show the results

Client side metrics exclude the server response time.

front-end-block-theme

Metric 14a18b9 trunk % Change
timeToFirstByte 44.25 ms +16.27% -3.5% 42.75 ms +12.98% -1.75% 3.51%
largestContentfulPaint 76 ms +5.26% -0% 76 ms +7.89% -5.26% 0%
lcpMinusTtfb 32.9 ms +8.05% -14.89% 31.8 ms +8.96% -12.89% 3.46%
wpBeforeTemplate 21.41 ms +13.83% -0.89% 21.14 ms +17.5% -0.52% 1.28%
wpTemplate 19.25 ms +3.84% -4.88% 18.19 ms +5.28% -2.75% 5.83%
wpTotal 41.16 ms +13.99% -3.77% 39.74 ms +13.24% -2.21% 3.57%
wpMemoryUsage 7.62 MB +0% -0% 7.59 MB +0% -0% 0.46%
wpDbQueries 17 +0% -0% 17 +0% -0% 0%

front-end-classic-theme

Metric 14a18b9 trunk % Change
timeToFirstByte 35.95 ms +5.01% -1.95% 35.4 ms +8.62% -2.12% 1.55%
largestContentfulPaint 82 ms +2.44% -2.44% 80 ms +2.5% -5% 2.5%
lcpMinusTtfb 44.95 ms +4.67% -1.78% 43.55 ms +2.87% -4.36% 3.21%
wpBeforeTemplate 18.9 ms +6.14% -0.95% 18.78 ms +9.85% -1.7% 0.64%
wpTemplate 13.87 ms +3.24% -1.73% 13.78 ms +4.93% -2.83% 0.65%
wpTotal 33.28 ms +5.23% -1.92% 32.8 ms +8.63% -2.16% 1.46%
wpMemoryUsage 6.25 MB +0% -0% 6.20 MB +0% -0% 0.71%
wpDbQueries 14 +0% -0% 14 +0% -0% 0%

media-processing

Metric 14a18b9 trunk % Change
mediaProcessingJpeg 322.39 ms +3.86% -0.93% 317.4 ms +1.04% -0.28% 1.57%
mediaProcessingAvif 4766.98 ms +0.44% -0.11% 4822.73 ms +0.16% -0.29% -1.16%
mediaProcessingJpegToAvif 3349.78 ms +0.3% -0.43% 3349.45 ms +0.66% -0.47% 0.01%

media-upload

Metric 14a18b9 trunk % Change
jpegUploadProcessing 1429.62 ms +2.66% -2% 1405.72 ms +2.62% -0.54% 1.7%
pngUploadProcessing 180.13 ms +4.58% -3.59% 188.19 ms +12.77% -4.45% -4.28%
largeJpegUploadProcessing 1407.53 ms +0.48% -0.25% 1414.18 ms +2.24% -1.38% -0.47%
multipleImageUploadProcessing 1483.92 ms +0.58% -1.46% 1488.13 ms +0.81% -0.79% -0.28%

post-editor

Metric 14a18b9 trunk % Change
serverResponse 534.51 ms +1.8% -0.99% 528.66 ms +3.21% -1.83% 1.11%
firstPaint 242.11 ms +13.34% -6% 264.54 ms +63.8% -18.41% -8.48%
domContentLoaded 1153.4 ms +2.46% -1.09% 1151.14 ms +0.67% -3.49% 0.2%
loaded 1154.64 ms +2.48% -1.09% 1152.54 ms +0.65% -3.49% 0.18%
firstContentfulPaint 477.3 ms +5.67% -3.68% 475.22 ms +3.07% -2.93% 0.44%
firstBlock 3441.45 ms +0.44% -0.73% 3450.91 ms +0.4% -1.92% -0.27%
type 19.82 ms +4.19% -9.99% 17.47 ms +4.46% -8.07% 13.45%
typeWithoutInspector 18.4 ms +3.04% -5.33% 17.73 ms +5.19% -4.79% 3.78%
typeWithTopToolbar 25.76 ms +3.07% -6.29% 22.79 ms +7.02% -4.65% 13.03%
typeContainer 9.62 ms +11.54% -10.71% 9.5 ms +4.21% -6.63% 1.26%
focus 85.36 ms +1.98% -7.49% 71.49 ms +4.38% -4.73% 19.4%
firstFocus 213.75 ms +0% -0% 197.53 ms +0% -0% 8.21%
selectAll 557.02 ms +0.69% -3.24% 537.24 ms +2.06% -0.89% 3.68%
listViewOpen 69.5 ms +9.14% -11.17% 68.13 ms +5.39% -3.52% 2.01%
inserterOpen 24.13 ms +20.56% -11.65% 23.67 ms +4.65% -10.65% 1.94%
inserterHover 2.47 ms +11.34% -4.05% 2.46 ms +7.32% -13.01% 0.41%
inserterSearch 8.62 ms +25.17% -10.32% 7.7 ms +8.83% -7.4% 11.95%
loadPatterns 692.5 ms +2.49% -2.15% 666.82 ms +1.06% -6.87% 3.85%
wpTotal 524.34 ms +1.88% -0.88% 518.21 ms +3.41% -1.8% 1.18%
wpMemoryUsage 13.16 MB +0% -0% 13.13 MB +0% -0% 0.28%
wpDbQueries 53.5 +0.93% -0.93% 53 +1.89% -0% 0.94%

site-editor

Metric 14a18b9 trunk % Change
serverResponse 496.52 ms +2.61% -5.4% 471.39 ms +3.8% -1.15% 5.33%
firstPaint 252.89 ms +9.33% -5.96% 255.92 ms +8.29% -9.39% -1.18%
domContentLoaded 1130.63 ms +1.28% -0.64% 1131.6 ms +0.75% -0.53% -0.09%
loaded 1131.84 ms +1.28% -0.62% 1132.74 ms +0.75% -0.53% -0.08%
firstContentfulPaint 444.21 ms +3.31% -0.61% 454.01 ms +1.19% -0.63% -2.16%
firstBlock 4113.77 ms +0.72% -0.39% 4131.85 ms +0.94% -0.25% -0.44%
type 18.61 ms +4.3% -5.59% 17.33 ms +4.67% -5.65% 7.39%
navigate 114.94 ms +0.89% -4.09% 107.83 ms +10.12% -7.79% 6.59%
loadPatterns 1276.9 ms +8.09% -3.77% 1341.67 ms +10.78% -6.89% -4.83%
loadPages 1053.1 ms +0.6% -2.32% 1054.04 ms +1.74% -3.27% -0.09%
wpTotal 486.61 ms +2.65% -5.52% 461.39 ms +3.93% -1.15% 5.47%
wpMemoryUsage 12.14 MB +0% -0% 12.11 MB +0% -0% 0.3%
wpDbQueries 43 +2.33% -0% 43 +2.33% -0% 0%

f9be9fd Run

@ciampo ciampo left a comment

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.

LGTM 🚀

Side question: should we also mark components as "Not recommended" (and point out the substitutes) in each README file?

Comment thread packages/components/CHANGELOG.md Outdated

### Enhancements

- `Notice`: Mark as not recommended in favor of `Notice` from `@wordpress/ui`.

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.

Missing PR reference, here and in every CHANGELOG entry in this PR

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.

Missing PR reference, here and in every CHANGELOG entry in this PR

👍 Updated in 0027ed1.

@github-actions

github-actions Bot commented Sep 9, 2026

Copy link
Copy Markdown

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: ciampo <mciampini@git.wordpress.org>

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

@aduth

aduth commented Sep 9, 2026

Copy link
Copy Markdown
Member Author

Side question: should we also mark components as "Not recommended" (and point out the substitutes) in each README file?

Yes, probably. I'll plan to address that in a fast follow-on to apply to all of the non-recommended components. It might also be good to include this in some written documentation around what steps need to be taken to mark a component as recommended. This was something I had my AI agent verify before starting with this and we don't really have any canonical documentation at the moment.

A side-side question could be in regard to how we think about README in relation to published Storybook documentation, where we keep this source of truth, and whether we should even have non-recommended components in Storybook.

@aduth

aduth commented Sep 9, 2026 •

Copy link
Copy Markdown
Member Author

At the risk of self-imposing blockers, I wonder if we should sort out #82701 before marking this as recommended, per my own points at #82611 (comment) of recommendation being a signal of API stability. Or perhaps we can accept that API stability should be detached from encouraging component adoption.

My main reason to pause would be that #82701 would be easier to address before wide-scale adoption if we can understand how spoken messages should be announced at the time of migration, rather than retroactively through an audit.

@ciampo

ciampo commented Sep 9, 2026

Copy link
Copy Markdown
Contributor

If #82701 can be wrapped up soon, it's probably worth the wait

@aduth

aduth commented Sep 14, 2026

Copy link
Copy Markdown
Member Author

If we go with something similar to what I proposed in #82701 (comment), I think the main blocker to stabilization would be removing the default spoken announcements (what you're already exploring in #82737). This would avoid a situation where developers could become dependent upon the existing announcement behavior and requiring us to audit and migrate such usage. Then, whatever abstraction we come up with for the live region announcements would be an additional, separate enhancement to make it easier to implement live notice announcements the correct way.

@ciampo

ciampo commented Sep 14, 2026

Copy link
Copy Markdown
Contributor

Sounds good, I'll work on #82737 and mark it as ready for review soon.

@aduth

aduth commented Sep 29, 2026

Copy link
Copy Markdown
Member Author

With #82737 since being merged, I think it unblocks this and I'll plan to refresh and merge soon.

@aduth
aduth force-pushed the update/ui-recommend-notice branch from c3aca70 to b41eb56 Compare September 29, 2026 21:03
@aduth
aduth requested a review from ellatrix as a code owner September 29, 2026 21:03
@github-actions github-actions Bot added the [Package] Block editor /packages/block-editor label Sep 29, 2026
@aduth
aduth force-pushed the update/ui-recommend-notice branch from 00a7e37 to d7e704e Compare September 30, 2026 16:11
@aduth
aduth force-pushed the update/ui-recommend-notice branch from d7e704e to f9be9fd Compare September 30, 2026 17:35
@aduth
aduth merged commit 13e61d4 into trunk Sep 30, 2026
119 checks passed
@aduth
aduth deleted the update/ui-recommend-notice branch September 30, 2026 18:29
@github-actions github-actions Bot added this to the Gutenberg 24.2 milestone Sep 30, 2026
widoz pushed a commit to widoz/gutenberg that referenced this pull request Oct 2, 2026
* UI: Recommend Notice component

* Remove Notice from caution list

Co-authored-by: aduth <aduth@git.wordpress.org>
Co-authored-by: ciampo <mciampini@git.wordpress.org>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Design System Issues related to the system of combining components according to best practices. [Package] Block editor /packages/block-editor [Package] Components /packages/components [Package] Edit Widgets /packages/edit-widgets [Package] Editor /packages/editor [Package] UI /packages/ui [Package] Widget Dashboard /packages/widget-dashboard [Tool] ESLint plugin /packages/eslint-plugin [Type] Enhancement A suggestion for improvement.

Projects

Status: 💫 Done

Development

Successfully merging this pull request may close these issues.

2 participants