Skip to content

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

TypeScript

fix(HoverCard): hide() and Escape on a hovered card no longer leave the next open stuck (#7617)

Cindy Zhang5c95d64e78d6
diff --git a/.changeset/hover-card-hide-latch.md b/.changeset/hover-card-hide-latch.md
new file mode 100644
index 0000000000..58fccb9814
--- /dev/null
+++ b/.changeset/hover-card-hide-latch.md
@@ -0,0 +1,7 @@
+---
+'@astryxdesign/core': patch
+---
+
+[fix] `useHoverCard`: closing a hover card with `hide()` or Escape while the pointer rests on the card no longer leaves the next open stuck. The hook kept believing the pointer was still over the card, because a card closed that way unmounts without a `mouseleave`, so the trigger's next hover-open never closed on leave or after `hideDelay`. Both paths now clear that state, as the touch dismissal already did.
+
+@cixzhang
diff --git a/packages/core/src/HoverCard/HoverCard.test.tsx b/packages/core/src/HoverCard/HoverCard.test.tsx
index a6ce67b1ab..aafe9b4fdc 100644
--- a/packages/core/src/HoverCard/HoverCard.test.tsx
+++ b/packages/core/src/HoverCard/HoverCard.test.tsx
@@ -109,6 +109,64 @@ describe('useHoverCard identity', () => {
});
});
+// A card closed while the pointer rests on it unmounts without a mouseleave,
+// so the hook must not keep believing the pointer is over the card: if it
+// does, the next open of the same trigger never closes on leave.
+describe('useHoverCard closing while the pointer is on the card', () => {
+ function Harness() {
+ const card = useHoverCard({delay: 0, hideDelay: 0});
+ return (
+ <div>
+ <span ref={card.ref}>Trigger</span>
+ <output data-testid="state">{card.isOpen ? 'open' : 'closed'}</output>
+ {card.renderHoverCard(
+ <button type="button" onClick={card.hide}>
+ Pick
+ </button>,
+ )}
+ </div>
+ );
+ }
+
+ async function openThenRestOnCard() {
+ const state = screen.getByTestId('state');
+ fireEvent.mouseEnter(screen.getByText('Trigger'));
+ await waitFor(() => expect(state).toHaveTextContent('open'));
+ const pick = screen.getByRole('button', {name: 'Pick', hidden: true});
+ fireEvent.mouseLeave(screen.getByText('Trigger'));
+ fireEvent.mouseEnter(pick.parentElement!);
+ return {state, pick};
+ }
+
+ async function expectNextOpenClosesOnLeave(state: HTMLElement) {
+ const trigger = screen.getByText('Trigger');
+ fireEvent.mouseEnter(trigger);
+ await waitFor(() => expect(state).toHaveTextContent('open'));
+ fireEvent.mouseLeave(trigger);
+ await waitFor(() => expect(state).toHaveTextContent('closed'));
+ }
+
+ it('closes the next open on leave after hide() from inside the card', async () => {
+ render(<Harness />);
+ const {state, pick} = await openThenRestOnCard();
+
+ fireEvent.click(pick);
+ await waitFor(() => expect(state).toHaveTextContent('closed'));
+
+ await expectNextOpenClosesOnLeave(state);
+ });
+
+ it('closes the next open on leave after Escape dismisses the card', async () => {
+ render(<Harness />);
+ const {state} = await openThenRestOnCard();
+
+ fireEvent.keyDown(document.body, {key: 'Escape'});
+ await waitFor(() => expect(state).toHaveTextContent('closed'));
+
+ await expectNextOpenClosesOnLeave(state);
+ });
+});
+
describe('HoverCard', () => {
it('renders trigger element', () => {
render(
diff --git a/packages/core/src/HoverCard/useHoverCard.tsx b/packages/core/src/HoverCard/useHoverCard.tsx
index 64f256591e..9c28c3dcc0 100644
--- a/packages/core/src/HoverCard/useHoverCard.tsx
+++ b/packages/core/src/HoverCard/useHoverCard.tsx
@@ -345,6 +345,14 @@ export function useHoverCard(options: HoverCardOptions = {}): HoverCardReturn {
hideLayer();
}, [clearTimeouts, hideLayer]);
+ // The imperative hide. A card closed while the pointer rests on it unmounts
+ // without a mouseleave, so the content-hover latch is cleared here; left set,
+ // it would keep the trigger's next hover-open from closing on leave.
+ const hide = useCallback(() => {
+ isHoveringContentRef.current = false;
+ hideLayer();
+ }, [hideLayer]);
+
const {
isTouchPointerRef,
isTouchInteraction,
@@ -508,7 +516,7 @@ export function useHoverCard(options: HoverCardOptions = {}): HoverCardReturn {
? null
: document.getElementById(layerId);
const hadFocus = card?.contains(document.activeElement) ?? false;
- hideLayer();
+ hide();
if (hadFocus) {
isEscapeDismissingRef.current = true;
triggerRef.current?.focus();
@@ -720,6 +728,6 @@ export function useHoverCard(options: HoverCardOptions = {}): HoverCardReturn {
isOpen: isLayerOpen,
renderHoverCard,
show: showLayer,
- hide: hideLayer,
+ hide,
};
}