Skip to content

An open source design system that's fully customizable and agent ready

TypeScript

fix(Tooltip, HoverCard): a pen held before it lifts no longer closes the layer it opened (#9819)

Christopher Chedeaubb5650811b6c
diff --git a/.changeset/pen-hold-hover-show.md b/.changeset/pen-hold-hover-show.md
new file mode 100644
index 0000000000..47be6902f9
--- /dev/null
+++ b/.changeset/pen-hold-hover-show.md
@@ -0,0 +1,7 @@
+---
+'@astryxdesign/core': patch
+---
+
+[fix] Tooltip and HoverCard: a pen held on the trigger before it lifts no longer closes the tooltip or card it just opened.
+
+@vjeux
diff --git a/packages/core/src/HoverCard/HoverCard.test.tsx b/packages/core/src/HoverCard/HoverCard.test.tsx
index f0d0cea97d..8561ef23e4 100644
--- a/packages/core/src/HoverCard/HoverCard.test.tsx
+++ b/packages/core/src/HoverCard/HoverCard.test.tsx
@@ -1389,6 +1389,32 @@ describe('HoverCard', () => {
});
});
+ it('stays open when a pen that lands and stays down past the hover delay lifts', async () => {
+ const onOpenChange = vi.fn();
+ render(
+ <HoverCard
+ content={<span>Card content</span>}
+ onOpenChange={onOpenChange}
+ delay={0}>
+ Ruby Cheung
+ </HoverCard>,
+ );
+
+ const trigger = screen.getByText('Ruby Cheung');
+ // A pen in range hovers like a mouse: its arrival starts the hover show.
+ fireEvent.pointerEnter(trigger, {pointerType: 'pen'});
+ fireEvent.mouseEnter(trigger);
+ fireEvent.pointerDown(trigger, {pointerType: 'pen'});
+ // The pen stays down past the hover delay, then lifts.
+ await new Promise(resolve => setTimeout(resolve, 50));
+ fireEvent.pointerUp(trigger, {pointerType: 'pen'});
+ fireEvent.click(trigger);
+ await waitFor(() => {
+ expect(onOpenChange).toHaveBeenCalledWith(true);
+ });
+ expect(onOpenChange).not.toHaveBeenCalledWith(false);
+ });
+
it('stays shut on a tap when the trigger performs an action', async () => {
const onOpenChange = vi.fn();
render(
diff --git a/packages/core/src/HoverCard/useHoverCard.tsx b/packages/core/src/HoverCard/useHoverCard.tsx
index 7682d70e2d..0a258f2373 100644
--- a/packages/core/src/HoverCard/useHoverCard.tsx
+++ b/packages/core/src/HoverCard/useHoverCard.tsx
@@ -401,7 +401,12 @@ export function useHoverCard(options: HoverCardOptions = {}): HoverCardReturn {
// Tap-to-open on touch; on a mouse this does nothing and hover still rules.
const handlePointerDown = useCallback(
(event: PointerEvent) => {
- handleTouchPointerDown(event);
+ // A pen in range starts the hover show before it lands. Left pending,
+ // that show opens the card during the press. The tap then closes it.
+ if (handleTouchPointerDown(event) && showTimeoutRef.current) {
+ clearTimeout(showTimeoutRef.current);
+ showTimeoutRef.current = null;
+ }
},
[handleTouchPointerDown],
);
diff --git a/packages/core/src/InfoTip/InfoTip.pin.test.tsx b/packages/core/src/InfoTip/InfoTip.pin.test.tsx
index ff15b298c1..50d8e142ca 100644
--- a/packages/core/src/InfoTip/InfoTip.pin.test.tsx
+++ b/packages/core/src/InfoTip/InfoTip.pin.test.tsx
@@ -222,6 +222,30 @@ describe('InfoTip press-to-pin (component:InfoTip FR2)', () => {
expect(shows(TIP)).toBe(false);
});
+ it('a pen held on a hover preview pins it without hiding it first', () => {
+ vi.useFakeTimers();
+ render(<InfoTooltip />);
+ const trigger = screen.getByRole('button', {name: 'About billing'});
+ fireEvent.pointerEnter(trigger, {pointerType: 'pen'});
+ fireEvent.mouseEnter(trigger);
+ act(() => {
+ vi.advanceTimersByTime(500);
+ });
+ expect(shows(TIP)).toBe(true);
+ vi.mocked(HTMLElement.prototype.hidePopover).mockClear();
+ fireEvent.pointerDown(trigger, {pointerType: 'pen'});
+ // The pen stays down past the hover delay, then lifts.
+ act(() => {
+ vi.advanceTimersByTime(300);
+ });
+ expect(shows(TIP)).toBe(true);
+ fireEvent.pointerUp(trigger, {pointerType: 'pen'});
+ fireEvent.click(trigger, {detail: 1});
+ expect(shows(TIP)).toBe(true);
+ expect(trigger).toHaveAttribute('aria-expanded', 'true');
+ expect(HTMLElement.prototype.hidePopover).not.toHaveBeenCalled();
+ });
+
it('after a press on a preview that ends off the button, Enter and Space still pin and close it', () => {
vi.useFakeTimers();
render(<InfoTooltip />);
diff --git a/packages/core/src/Layer/__tests__/TouchTrigger.a11y.chromium.spec.ts b/packages/core/src/Layer/__tests__/TouchTrigger.a11y.chromium.spec.ts
index ef89d57d9a..f243a47375 100644
--- a/packages/core/src/Layer/__tests__/TouchTrigger.a11y.chromium.spec.ts
+++ b/packages/core/src/Layer/__tests__/TouchTrigger.a11y.chromium.spec.ts
@@ -281,12 +281,15 @@ test.describe('Tooltip and InfoTip under a finger and a pen (component:Tooltip F
const term = (page: Page, name: string) =>
page.getByText(name, {exact: true});
- /** A tap: a finger through touch events, or a landed pen through pen-typed presses. */
+ /**
+ * A tap: a finger through touch events, or a landed pen through pen-typed
+ * presses. A held pen stays down past the hover delay before it lifts.
+ */
async function tapWith(
page: Page,
finger: Finger,
target: Locator,
- pointer: 'finger' | 'pen',
+ pointer: 'finger' | 'pen' | 'held pen',
) {
const [x, y] = await centerOf(target);
if (pointer === 'finger') {
@@ -296,6 +299,9 @@ test.describe('Tooltip and InfoTip under a finger and a pen (component:Tooltip F
}
const cdp = await page.context().newCDPSession(page);
for (const type of ['mousePressed', 'mouseReleased'] as const) {
+ if (type === 'mouseReleased' && pointer === 'held pen') {
+ await page.waitForTimeout(300);
+ }
await cdp.send('Input.dispatchMouseEvent', {
type,
x,
@@ -308,7 +314,7 @@ test.describe('Tooltip and InfoTip under a finger and a pen (component:Tooltip F
await cdp.detach();
}
- for (const pointer of ['finger', 'pen'] as const) {
+ for (const pointer of ['finger', 'pen', 'held pen'] as const) {
test(`a ${pointer} tap opens a plain Tooltip term and pins an InfoTip`, async ({
page,
}) => {
diff --git a/packages/core/src/Tooltip/Tooltip.test.tsx b/packages/core/src/Tooltip/Tooltip.test.tsx
index 7dc56dd6e1..074fee8d8c 100644
--- a/packages/core/src/Tooltip/Tooltip.test.tsx
+++ b/packages/core/src/Tooltip/Tooltip.test.tsx
@@ -550,6 +550,50 @@ describe('Tooltip', () => {
});
});
+ it('stays open when a pen that lands and stays down past the hover delay lifts', async () => {
+ const onOpenChange = vi.fn();
+ render(
+ <Tooltip content="Tooltip text" onOpenChange={onOpenChange} delay={0}>
+ Abbreviation
+ </Tooltip>,
+ );
+
+ const trigger = screen.getByText('Abbreviation');
+ // A pen in range hovers like a mouse: its arrival starts the hover show.
+ fireEvent.pointerEnter(trigger, {pointerType: 'pen'});
+ fireEvent.mouseEnter(trigger);
+ fireEvent.pointerDown(trigger, {pointerType: 'pen'});
+ // The pen stays down past the hover delay, then lifts.
+ await new Promise(resolve => setTimeout(resolve, 50));
+ fireEvent.pointerUp(trigger, {pointerType: 'pen'});
+ fireEvent.click(trigger);
+ await waitFor(() => {
+ expect(onOpenChange).toHaveBeenCalledWith(true);
+ });
+ expect(onOpenChange).not.toHaveBeenCalledWith(false);
+ });
+
+ it('still opens on a mouse hover after its delay, and a mouse press still closes it', async () => {
+ const onOpenChange = vi.fn();
+ render(
+ <Tooltip content="Tooltip text" onOpenChange={onOpenChange} delay={20}>
+ Abbreviation
+ </Tooltip>,
+ );
+
+ const trigger = screen.getByText('Abbreviation');
+ fireEvent.pointerEnter(trigger, {pointerType: 'mouse'});
+ fireEvent.mouseEnter(trigger);
+ expect(onOpenChange).not.toHaveBeenCalled();
+ await waitFor(() => {
+ expect(onOpenChange).toHaveBeenCalledWith(true);
+ });
+ fireEvent.pointerDown(trigger, {pointerType: 'mouse'});
+ await waitFor(() => {
+ expect(onOpenChange).toHaveBeenLastCalledWith(false);
+ });
+ });
+
it('never opens for a touch that turns into a scroll', async () => {
const onOpenChange = vi.fn();
render(
diff --git a/packages/core/src/Tooltip/useTooltip.tsx b/packages/core/src/Tooltip/useTooltip.tsx
index 1443dda361..653d1e4dab 100644
--- a/packages/core/src/Tooltip/useTooltip.tsx
+++ b/packages/core/src/Tooltip/useTooltip.tsx
@@ -633,6 +633,12 @@ export function useTooltip(options: TooltipOptions = {}): TooltipReturn {
return;
}
if (handleTouchPointerDown(event)) {
+ // A pen in range starts the hover show before it lands. Left pending,
+ // that show opens the layer during the press. The tap then closes it.
+ if (showTimeoutRef.current) {
+ clearTimeout(showTimeoutRef.current);
+ showTimeoutRef.current = null;
+ }
return;
}
if (isOpen !== undefined) {