UI/Tooltip: Add usage guidelines documentation#77158
Merged
Conversation
|
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: 7.74 MB ℹ️ View Unchanged
|
|
Flaky tests detected in 0250077. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/24198681664
|
ciampo
force-pushed
the
docs/tooltip-usage-guidelines
branch
4 times, most recently
from
419a409 to
8b6d112
Compare
ciampo
changed the title
mirka
approved these changes
Apr 9, 2026
| popup itself, it's a popover. If the trigger's purpose is unrelated to | ||
| opening the popup, it's a tooltip. | ||
|
|
||
| <Canvas of={ UsageGuidelinesStories.InfoTipWithPopover } /> |
Member
There was a problem hiding this comment.
Hey you literally made us the Infotip component! Please make this a component 😂
Contributor
Author
There was a problem hiding this comment.
Why not! I can follow-up (low-prio) on that
Add interactive Storybook examples for the Tooltip usage guidelines documentation page: - RecommendedUsage: manual Tooltip with aria-label on triggers - IconButtonWithTooltip: using IconButton's built-in tooltip support - InfoTipWithPopover: Popover-based infotip pattern as a tooltip alternative Made-with: Cursor
Add a Storybook documentation page covering when and when not to use tooltips, including: - Usage guidelines (visual labels, accessible naming) - Alternatives section (infotips via Popover, description text, feedback) - References to WCAG 1.4.13 and WAI-ARIA APG tooltip pattern Made-with: Cursor
Refine JSDoc on Tooltip Root to clarify that popups are visual-only and not exposed to assistive technologies, and add @see links to the new usage guidelines page and IconButton docs. Made-with: Cursor
ciampo
force-pushed
the
docs/tooltip-usage-guidelines
branch
from
8b6d112 to
0250077
Compare
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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?
Follow-up to #76705.
Add a Storybook docs page for the
@wordpress/uiTooltip with usage guidelines and alternatives, adapted from Base UI's tooltip docs.Why?
Tooltip docs lack guidance on when (not) to use tooltips, leading to misuse for infotips, descriptions, or feedback messages — all inaccessible to touch and screen reader users.
How?
packages/ui/src/tooltip/stories/.@seeJSDoc links onTooltip.Root.Testing Instructions
npm run storybook:devOpen question
Should similar guidance be added to the
@wordpress/componentsTooltip README? Could be a follow-up.Use of AI Tools
Cursor (Claude).