Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 14 additions & 2 deletions src/hooks/useAccessibility.ts
Original file line number Diff line number Diff line change
Expand Up @@ -75,13 +75,25 @@ export default function useAccessibility({

React.useEffect(() => {
if (open) {
window.addEventListener('keydown', handleKeyDown);
const handleCapture = (event: KeyboardEvent) => {
if (event.keyCode === ESC) {
handleKeyDown(event);
}
};
const handleBubble = (event: KeyboardEvent) => {
if (event.keyCode !== ESC) {
handleKeyDown(event);
}
};
Comment on lines +78 to +87

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Non-blocking suggestion: please keep braces around both if bodies, consistent with the surrounding code. This preserves the Escape capture / Tab bubble behavior.

Suggested change
const handleCapture = (event: KeyboardEvent) => {
if (event.keyCode === ESC) handleKeyDown(event);
};
const handleBubble = (event: KeyboardEvent) => {
if (event.keyCode !== ESC) handleKeyDown(event);
};
const handleCapture = (event: KeyboardEvent) => {
if (event.keyCode === ESC) {
handleKeyDown(event);
}
};
const handleBubble = (event: KeyboardEvent) => {
if (event.keyCode !== ESC) {
handleKeyDown(event);
}
};

window.addEventListener('keydown', handleCapture, true);
window.addEventListener('keydown', handleBubble);
if (autoFocus) {
// FIXME: hack with raf
raf(() => focusMenu({ preventScroll: true }), 3);
}
return () => {
window.removeEventListener('keydown', handleKeyDown);
window.removeEventListener('keydown', handleCapture, true);
window.removeEventListener('keydown', handleBubble);
focusMenuRef.current = false;
};
}
Expand Down
105 changes: 105 additions & 0 deletions tests/useAccessibility.test.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -28,3 +28,108 @@ it('closes without consuming Tab when the overlay ref is omitted', () => {
trigger.remove();
}
});

it('closes and returns focus to trigger on Escape key', () => {
const trigger = document.createElement('button');
document.body.appendChild(trigger);
const onOpenChange = jest.fn();
const { unmount } = renderHook(() =>
useAccessibility({
open: true,
triggerRef: { current: trigger },
onOpenChange,
}),
);
try {
const event = new KeyboardEvent('keydown', {
keyCode: 27,
bubbles: true,
cancelable: true,
});
act(() => {
window.dispatchEvent(event);
});
expect(onOpenChange).toHaveBeenCalledWith(false);
expect(document.activeElement).toBe(trigger);
} finally {
unmount();
trigger.remove();
}
});

it('lets an overlay handle Tab before the window listener', () => {
const trigger = document.createElement('button');
const overlay = document.createElement('div');
const input = document.createElement('input');
overlay.tabIndex = -1;
overlay.appendChild(input);
document.body.append(trigger, overlay);
const onOpenChange = jest.fn();
input.addEventListener('keydown', (event) => event.stopPropagation());
const { unmount } = renderHook(() =>
useAccessibility({
open: true,
triggerRef: { current: trigger },
overlayRef: { current: overlay },
onOpenChange,
}),
);
try {
input.focus();
const event = new KeyboardEvent('keydown', {
key: 'Tab',
keyCode: 9,
bubbles: true,
cancelable: true,
});
act(() => {
input.dispatchEvent(event);
});
expect(document.activeElement).toBe(input);
expect(event.defaultPrevented).toBe(false);
expect(onOpenChange).not.toHaveBeenCalled();
} finally {
unmount();
trigger.remove();
overlay.remove();
}
});

it('restores focus before an earlier window bubble listener unmounts the hook', () => {
const trigger = document.createElement('button');
const item = document.createElement('button');
document.body.append(trigger, item);
item.focus();
const onOpenChange = jest.fn();
let teardown = () => {};
const portalListener = () => teardown();
window.addEventListener('keydown', portalListener);
const { unmount } = renderHook(() =>
useAccessibility({
open: true,
triggerRef: { current: trigger },
onOpenChange,
}),
);
teardown = unmount;
try {
act(() => {
item.dispatchEvent(
new KeyboardEvent('keydown', {
key: 'Escape',
keyCode: 27,
bubbles: true,
cancelable: true,
}),
);
});
expect(onOpenChange).toHaveBeenCalledTimes(1);
expect(onOpenChange).toHaveBeenCalledWith(false);
expect(document.activeElement).toBe(trigger);
} finally {
window.removeEventListener('keydown', portalListener);
unmount();
trigger.remove();
item.remove();
}
});
Loading