Repository navigation
fix(Tooltip): make tooltips with empty text inert - #8740
Conversation
A tooltip with empty `text` (and no `keybindingHint`) no longer opens and
no longer labels or describes its trigger. That means you can turn a tooltip
off with `text={allowed ? '' : 'Not allowed'}` instead of conditionally
wrapping the trigger, which remounts it and drops focus.
Fixes #8571
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
🦋 Changeset detectedLatest commit: 7370f21 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
|
The empty-text effect cancelled the pending hover timer. If the text came back while the pointer was already over the trigger, no new mouseover fired, so the tooltip never opened. The effect now only hides an open popover. The hover timer reads the latest props when it fires: it opens if content has returned and does nothing if the text is still empty. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
🟢 Approval recommended
No active review issues were identified for the changes supporting empty tooltip text while preserving trigger focus.
No open issues 🎉
What changed in this PR
This PR addresses #8571 by using empty Tooltip text to disable tooltip behavior without remounting the trigger, preserving keyboard focus.
Changes:
- Adds content checks for opening, closing, and associating tooltips with their triggers.
- Adds tests for empty text, focus retention, ARIA attributes, and pending hover behavior.
- Documents conditional text usage, adds a Storybook example, and includes a patch changeset.
| File | Description |
|---|---|
packages/react/src/TooltipV2/Tooltip.tsx |
Adds content-dependent visibility and ARIA handling. |
packages/react/src/TooltipV2/Tooltip.features.stories.tsx |
Adds a conditional-text example. |
packages/react/src/TooltipV2/Tooltip.docs.json |
Documents empty-text behavior and registers the example. |
packages/react/src/TooltipV2/__tests__/Tooltip.test.tsx |
Covers empty-text behavior and focus preservation. |
.changeset/tooltip-empty-text.md |
Adds an @primer/react patch release note. |
Review effort: Balanced
|
Integration test results from github/github-ui PR:
All checks passed! |
…isabled-prop # Conflicts: # packages/react/src/TooltipV2/__tests__/Tooltip.test.tsx
|
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
|
Closes #8571
Keeping a Tooltip mounted while toggling its text avoids replacing the trigger and dropping focus. Empty
textwithout a keybinding hint now makes Tooltip inert and removes its ARIA association.Changelog
New
Changed
textno longer opens a Tooltip or labels/describes its trigger when nokeybindingHintis provided.Removed
Rollout strategy
Testing & Reviewing
Automated coverage exercises focus retention, tooltip open/close behavior, and ARIA attributes; type-check and targeted lint pass. In the
ConditionalTextstory, toggle the tooltip and confirm focus stays on the button and its accessible description disappears while the text is empty.