An open source design system that's fully customizable and agent ready
TypeScript
fix(tooltip): dismiss tooltip when its trigger is pressed (#4532)
Cindy Zhang271fb6489a5a
diff --git a/.changeset/tooltip-press-to-dismiss.md b/.changeset/tooltip-press-to-dismiss.mdnew file mode 100644index 0000000000..69daaf3ff9--- /dev/null+++ b/.changeset/tooltip-press-to-dismiss.md@@ -0,0 +1,7 @@+---+'@astryxdesign/core': patch+---++[fix] Tooltip: dismiss the tooltip when its trigger is pressed. Previously the tooltip stayed open through a click (e.g. a "Copy link" button's tooltip lingered after activation); now pressing the trigger hides its own tooltip. Applies to uncontrolled tooltips only.++@cixzhangdiff --git a/packages/core/src/Tooltip/Tooltip.test.tsx b/packages/core/src/Tooltip/Tooltip.test.tsxindex 7ce9f79713..ba76eabc69 100644--- a/packages/core/src/Tooltip/Tooltip.test.tsx+++ b/packages/core/src/Tooltip/Tooltip.test.tsx@@ -221,4 +221,50 @@ describe('Tooltip', () => {expect(onOpenChange).not.toHaveBeenCalledWith(false);});});++ describe('press-to-dismiss', () => {+ it('hides the tooltip when the trigger is pressed', async () => {+ const onOpenChange = vi.fn();+ render(+ <Tooltip content="Copy link" onOpenChange={onOpenChange} delay={0}>+ <button type="button">Trigger</button>+ </Tooltip>,+ );++ const trigger = screen.getByRole('button', {name: 'Trigger'});+ fireEvent.mouseEnter(trigger);+ await waitFor(() => {+ expect(onOpenChange).toHaveBeenCalledWith(true);+ });++ fireEvent.pointerDown(trigger);+ await waitFor(() => {+ expect(onOpenChange).toHaveBeenCalledWith(false);+ });+ });++ it('does not press-dismiss a controlled tooltip', async () => {+ const onOpenChange = vi.fn();+ render(+ <Tooltip+ content="Controlled"+ isOpen+ onOpenChange={onOpenChange}+ delay={0}>+ <button type="button">Trigger</button>+ </Tooltip>,+ );++ const trigger = screen.getByRole('button', {name: 'Trigger'});+ await waitFor(() => {+ expect(onOpenChange).toHaveBeenCalledWith(true);+ });+ onOpenChange.mockClear();++ fireEvent.pointerDown(trigger);+ // Give any (incorrect) async hide a chance to run.+ await new Promise(r => setTimeout(r, 20));+ expect(onOpenChange).not.toHaveBeenCalledWith(false);+ });+ });});diff --git a/packages/core/src/Tooltip/useTooltip.tsx b/packages/core/src/Tooltip/useTooltip.tsxindex 68d0d2ac5a..917e9981ac 100644--- a/packages/core/src/Tooltip/useTooltip.tsx+++ b/packages/core/src/Tooltip/useTooltip.tsx@@ -366,6 +366,19 @@ export function useTooltip(options: TooltipOptions = {}): TooltipReturn {scheduleHide();}, [scheduleHide]);+ // Pressing the trigger hides its own tooltip: once the control is activated+ // the hint has served its purpose, and a tooltip lingering over a+ // just-pressed control reads as stale. Fires on pointerdown so it feels+ // immediate. Uncontrolled tooltips only — a controlled tooltip's visibility+ // is owned by the consumer. `layer.hide()` self-guards when already closed.+ const handlePointerDown = useCallback(() => {+ if (isOpen !== undefined) {+ return;+ }+ clearTimeouts();+ layer.hide();+ }, [isOpen, clearTimeouts, layer]);+// Interaction ref that handles event listeners onlyconst interactionRef: RefCallback<HTMLElement> = useCallback((el: HTMLElement | null) => {@@ -375,12 +388,18 @@ export function useTooltip(options: TooltipOptions = {}): TooltipReturn {triggerRef.current.removeEventListener('mouseleave', handleMouseLeave);triggerRef.current.removeEventListener('focusin', handleFocusIn);triggerRef.current.removeEventListener('focusout', handleFocusOut);+ triggerRef.current.removeEventListener(+ 'pointerdown',+ handlePointerDown,+ );}if (el) {// Attach hover listenersel.addEventListener('mouseenter', handleMouseEnter);el.addEventListener('mouseleave', handleMouseLeave);+ // Press-to-dismiss: activating the trigger hides its own tooltip.+ el.addEventListener('pointerdown', handlePointerDown);// Attach focus listeners based on focusTrigger optionconst shouldAttachFocus =@@ -401,6 +420,7 @@ export function useTooltip(options: TooltipOptions = {}): TooltipReturn {handleMouseLeave,handleFocusIn,handleFocusOut,+ handlePointerDown,],);