Skip to content

πŸ™Œ OpenHands: AI-Driven Development

fix(a11y): close menus and popovers on Escape and return focus (#18044)

Engel Nyst3de2aff37442
diff --git a/__tests__/components/features/chat/components/context-window-meter.test.tsx b/__tests__/components/features/chat/components/context-window-meter.test.tsx
index 2136bceac6..07c5dffd7a 100644
--- a/__tests__/components/features/chat/components/context-window-meter.test.tsx
+++ b/__tests__/components/features/chat/components/context-window-meter.test.tsx
@@ -153,6 +153,33 @@ describe("ContextWindowMeter", () => {
expect(screen.getByText("CONVERSATION$CONTEXT_WINDOW")).toBeInTheDocument();
});
+ it("closes the popover with Escape and returns focus to the meter", () => {
+ useMetricsStore.setState({
+ cost: null,
+ max_budget_per_task: null,
+ usage: {
+ prompt_tokens: 0,
+ completion_tokens: 0,
+ cache_read_tokens: 0,
+ cache_write_tokens: 0,
+ context_window: 1_000_000,
+ per_turn_token: 198_500,
+ },
+ });
+ renderWithProviders(<ContextWindowMeter />);
+ const trigger = screen.getByTestId("context-window-meter");
+
+ fireEvent.click(trigger);
+ const compactButton = screen.getByTestId("context-window-compact-button");
+ compactButton.focus();
+ fireEvent.keyDown(compactButton, { key: "Escape" });
+
+ expect(
+ screen.queryByTestId("context-window-meter-popover"),
+ ).not.toBeInTheDocument();
+ expect(trigger).toHaveFocus();
+ });
+
it("opens the Usage drawer from the popover meter", () => {
useMetricsStore.setState({
cost: 1.25,
diff --git a/__tests__/components/features/command-menu/command-menu.test.tsx b/__tests__/components/features/command-menu/command-menu.test.tsx
index bec21b7f48..e7a7a8dec6 100644
--- a/__tests__/components/features/command-menu/command-menu.test.tsx
+++ b/__tests__/components/features/command-menu/command-menu.test.tsx
@@ -18,6 +18,7 @@ import {
NavigationProvider,
type NavigationContextValue,
} from "#/context/navigation-context";
+import { ConversationCardActions } from "#/components/features/conversation-panel/conversation-card/conversation-card-actions";
import { useCommandMenuStore } from "#/stores/command-menu-store";
import { useSidebarStore } from "#/stores/sidebar-store";
import { renderWithProviders } from "../../../../test-utils";
@@ -112,6 +113,81 @@ describe("CommandMenu", () => {
});
});
+ it("closes with escape while a command option has focus", async () => {
+ const user = userEvent.setup();
+ renderCommandMenu();
+ fireEvent.keyDown(window, { key: "k", ctrlKey: true });
+ const searchInput = await screen.findByRole("combobox", {
+ name: SEARCH_LABEL_KEY,
+ });
+ await waitFor(() => expect(searchInput).toHaveFocus());
+
+ await user.tab();
+ expect(document.activeElement?.id).toBe(NEW_CHAT_OPTION_ID);
+ await user.keyboard("{Escape}");
+
+ expect(screen.queryByTestId("command-menu")).not.toBeInTheDocument();
+ });
+
+ it("returns focus to the element that had it before opening", async () => {
+ const user = userEvent.setup();
+ renderWithProviders(
+ <>
+ <textarea data-testid="composer" />
+ <CommandMenu />
+ </>,
+ { navigation: { navigate: navigateMock } },
+ );
+ const composer = screen.getByTestId("composer");
+ composer.focus();
+
+ await user.keyboard("{Control>}k{/Control}");
+ const searchInput = await screen.findByRole("combobox", {
+ name: SEARCH_LABEL_KEY,
+ });
+ await waitFor(() => expect(searchInput).toHaveFocus());
+ await user.keyboard("{Escape}");
+
+ expect(screen.queryByTestId("command-menu")).not.toBeInTheDocument();
+ expect(composer).toHaveFocus();
+ });
+
+ it("closes itself, not a card menu left open underneath, on Escape", async () => {
+ const user = userEvent.setup();
+ const onContextMenuToggle = vi.fn();
+ renderWithProviders(
+ <>
+ <textarea data-testid="composer" />
+ <ConversationCardActions
+ contextMenuOpen
+ onContextMenuToggle={onContextMenuToggle}
+ onDelete={vi.fn()}
+ />
+ <CommandMenu />
+ </>,
+ { navigation: { navigate: navigateMock } },
+ );
+ const composer = screen.getByTestId("composer");
+ composer.focus();
+
+ await user.keyboard("{Control>}k{/Control}");
+ const searchInput = await screen.findByRole("combobox", {
+ name: SEARCH_LABEL_KEY,
+ });
+ await waitFor(() => expect(searchInput).toHaveFocus());
+ await user.keyboard("{Escape}");
+
+ expect(screen.queryByTestId("command-menu")).not.toBeInTheDocument();
+ expect(onContextMenuToggle).not.toHaveBeenCalled();
+ expect(screen.getByTestId("context-menu")).toBeInTheDocument();
+ expect(screen.getByTestId("ellipsis-button")).not.toHaveFocus();
+ expect(composer).toHaveFocus();
+
+ // The next Escape reaches the card menu.
+ await user.keyboard("{Escape}");
+ expect(onContextMenuToggle).toHaveBeenCalledWith(false);
+ });
+
it("opens from the global ctrl-k shortcut", async () => {
renderCommandMenu();
diff --git a/__tests__/components/features/conversation-panel/conversation-card.test.tsx b/__tests__/components/features/conversation-panel/conversation-card.test.tsx
index 5f9d1bd4c0..050c8d7be6 100644
--- a/__tests__/components/features/conversation-panel/conversation-card.test.tsx
+++ b/__tests__/components/features/conversation-panel/conversation-card.test.tsx
@@ -363,6 +363,29 @@ describe("ConversationCard", () => {
expect(onContextMenuToggle).toHaveBeenCalledWith(false);
});
+ it("closes the context menu with Escape and returns focus to its trigger", async () => {
+ const user = userEvent.setup();
+ const onContextMenuToggle = vi.fn();
+ renderWithProviders(
+ <ConversationCard
+ onDelete={onDelete}
+ onChangeTitle={onChangeTitle}
+ title="Conversation 1"
+ selectedRepository={null}
+ lastUpdatedAt="2021-10-01T12:00:00Z"
+ contextMenuOpen
+ onContextMenuToggle={onContextMenuToggle}
+ />,
+ );
+ const menu = screen.getByTestId("context-menu");
+ within(menu).getByTestId("delete-button").focus();
+
+ await user.keyboard("{Escape}");
+
+ expect(onContextMenuToggle).toHaveBeenCalledWith(false);
+ expect(screen.getByTestId("ellipsis-button")).toHaveFocus();
+ });
+
it("should call onDelete when the delete button is clicked", async () => {
const user = userEvent.setup();
const onContextMenuToggle = vi.fn();
diff --git a/__tests__/components/features/conversation/conversation-overview-drawer-content.test.tsx b/__tests__/components/features/conversation/conversation-overview-drawer-content.test.tsx
index 5ad02e370d..27e9745a33 100644
--- a/__tests__/components/features/conversation/conversation-overview-drawer-content.test.tsx
+++ b/__tests__/components/features/conversation/conversation-overview-drawer-content.test.tsx
@@ -1,3 +1,4 @@
+import React from "react";
import { QueryClient, QueryClientProvider } from "@tanstack/react-query";
import { render, screen, within } from "@testing-library/react";
import userEvent from "@testing-library/user-event";
@@ -13,6 +14,7 @@ import SettingsService from "#/api/settings-service/settings-service.api";
import SkillsService from "#/api/skills-service";
import { MOCK_DEFAULT_USER_SETTINGS } from "#/mocks/handlers";
import type { SkillInfo } from "#/types/settings";
+import { useCloseOnEscape } from "#/hooks/use-close-on-escape";
vi.mock("#/hooks/use-conversation-overview-stats", () => ({
useConversationOverviewStats: () => ({
@@ -121,12 +123,31 @@ function OpenSection({
);
}
+// Stands in for a menu that closes on Escape, such as the Overview β‹― menu.
+function MenuOverDrawer() {
+ const [isOpen, setIsOpen] = React.useState(false);
+ useCloseOnEscape(isOpen, () => setIsOpen(false));
+ return (
+ <>
+ <button
+ type="button"
+ data-testid="open-menu-over-drawer"
+ onClick={() => setIsOpen(true)}
+ >
+ Menu
+ </button>
+ {isOpen ? <div data-testid="menu-over-drawer" /> : null}
+ </>
+ );
+}
+
function renderDrawer(
section: (typeof CONVERSATION_OVERVIEW_DRAWER_SECTION)[keyof typeof CONVERSATION_OVERVIEW_DRAWER_SECTION],
) {
return render(
<ConversationOverviewDrawerProvider>
<OpenSection section={section} />
+ <MenuOverDrawer />
<ConversationOverviewDrawerContent />
</ConversationOverviewDrawerProvider>,
{
@@ -184,6 +205,25 @@ describe("ConversationOverviewDrawerContent", () => {
);
});
+ it("lets a menu opened over the drawer take the first Escape", async () => {
+ const user = userEvent.setup();
+ renderDrawer(CONVERSATION_OVERVIEW_DRAWER_SECTION.pull_requests);
+
+ await user.click(screen.getByTestId("open-drawer-section"));
+ await user.click(screen.getByTestId("open-menu-over-drawer"));
+
+ await user.keyboard("{Escape}");
+ expect(screen.queryByTestId("menu-over-drawer")).not.toBeInTheDocument();
+ expect(
+ screen.getByTestId("conversation-overview-drawer-content"),
+ ).toBeInTheDocument();
+
+ await user.keyboard("{Escape}");
+ expect(
+ screen.queryByTestId("conversation-overview-drawer-content"),
+ ).not.toBeInTheDocument();
+ });
+
it("opens the add skill modal from the header add button", async () => {
const user = userEvent.setup();
renderDrawer(CONVERSATION_OVERVIEW_DRAWER_SECTION.skills);
diff --git a/__tests__/components/features/conversation/conversation-overview-panel.test.tsx b/__tests__/components/features/conversation/conversation-overview-panel.test.tsx
index 44b490704e..c51cc80671 100644
--- a/__tests__/components/features/conversation/conversation-overview-panel.test.tsx
+++ b/__tests__/components/features/conversation/conversation-overview-panel.test.tsx
@@ -214,6 +214,21 @@ describe("ConversationOverviewPanel", () => {
);
});
+ it("closes the overflow menu with Escape and returns focus to its trigger", async () => {
+ const user = userEvent.setup();
+ renderPanel();
+ const trigger = screen.getByTestId("conversation-overview-ellipsis");
+
+ await user.click(trigger);
+ screen.getByTestId("conversation-overview-menu-pin-git").focus();
+ await user.keyboard("{Escape}");
+
+ expect(
+ screen.queryByTestId("conversation-overview-context-menu"),
+ ).not.toBeInTheDocument();
+ expect(trigger).toHaveFocus();
+ });
+
it("lets users pin and unpin git changes from the overflow menu", async () => {
const user = userEvent.setup();
renderPanel();
diff --git a/__tests__/components/features/sidebar/sidebar.test.tsx b/__tests__/components/features/sidebar/sidebar.test.tsx
index cfe447299e..8099b2c896 100644
--- a/__tests__/components/features/sidebar/sidebar.test.tsx
+++ b/__tests__/components/features/sidebar/sidebar.test.tsx
@@ -1,4 +1,5 @@
import {
+ act,
render,
screen,
fireEvent,
@@ -272,6 +273,27 @@ describe("Sidebar", () => {
});
});
+ it("leaves the mobile drawer open when a menu inside it already handled Escape", () => {
+ renderSidebar("/conversations");
+ const toggle = screen.getByTestId("sidebar-mobile-menu-toggle");
+ fireEvent.click(toggle);
+
+ const handledEscape = new KeyboardEvent("keydown", {
+ key: "Escape",
+ bubbles: true,
+ cancelable: true,
+ });
+ handledEscape.preventDefault();
+ act(() => {
+ document.body.dispatchEvent(handledEscape);
+ });
+
+ expect(toggle).toHaveAttribute("aria-expanded", "true");
+
+ fireEvent.keyDown(document.body, { key: "Escape" });
+ expect(toggle).toHaveAttribute("aria-expanded", "false");
+ });
+
it("toggles between expanded and collapsed states and persists the choice", () => {
const { unmount } = renderSidebar("/conversations");
diff --git a/__tests__/hooks/use-close-on-escape.test.tsx b/__tests__/hooks/use-close-on-escape.test.tsx
new file mode 100644
index 0000000000..bdff160419
--- /dev/null
+++ b/__tests__/hooks/use-close-on-escape.test.tsx
@@ -0,0 +1,117 @@
+import React from "react";
+import { act, fireEvent, render, screen } from "@testing-library/react";
+import { describe, expect, it, vi } from "vitest";
+import { useCloseOnEscape } from "#/hooks/use-close-on-escape";
+
+function Layer({
+ name,
+ isOpen,
+ onClose,
+}: {
+ name: string;
+ isOpen: boolean;
+ onClose: () => void;
+}) {
+ const triggerRef = React.useRef<HTMLButtonElement>(null);
+ useCloseOnEscape(isOpen, onClose, triggerRef);
+ return (
+ <button ref={triggerRef} type="button" data-testid={`${name}-trigger`}>
+ {name}
+ </button>
+ );
+}
+
+function pressEscape() {
+ fireEvent.keyDown(document.body, { key: "Escape" });
+}
+
+describe("useCloseOnEscape", () => {
+ it("closes only the most recently opened layer, then the one below", () => {
+ const closeFirst = vi.fn();
+ const closeSecond = vi.fn();
+ const { rerender } = render(
+ <>
+ <Layer name="first" isOpen onClose={closeFirst} />
+ <Layer name="second" isOpen={false} onClose={closeSecond} />
+ </>,
+ );
+ // Open the second layer after the first, as a user would.
+ rerender(
+ <>
+ <Layer name="first" isOpen onClose={closeFirst} />
+ <Layer name="second" isOpen onClose={closeSecond} />
+ </>,
+ );
+
+ pressEscape();
+ expect(closeSecond).toHaveBeenCalledTimes(1);
+ expect(closeFirst).not.toHaveBeenCalled();
+ expect(screen.getByTestId("second-trigger")).toHaveFocus();
+
+ rerender(
+ <>
+ <Layer name="first" isOpen onClose={closeFirst} />
+ <Layer name="second" isOpen={false} onClose={closeSecond} />
+ </>,
+ );
+ pressEscape();
+ expect(closeFirst).toHaveBeenCalledTimes(1);
+ expect(closeSecond).toHaveBeenCalledTimes(1);
+ expect(screen.getByTestId("first-trigger")).toHaveFocus();
+ });
+
+ it("orders layers by when they opened, not by render order", () => {
+ const closeFirst = vi.fn();
+ const closeSecond = vi.fn();
+ const { rerender } = render(
+ <>
+ <Layer name="first" isOpen={false} onClose={closeFirst} />
+ <Layer name="second" isOpen onClose={closeSecond} />
+ </>,
+ );
+ rerender(
+ <>
+ <Layer name="first" isOpen onClose={closeFirst} />
+ <Layer name="second" isOpen onClose={closeSecond} />
+ </>,
+ );
+
+ pressEscape();
+ expect(closeFirst).toHaveBeenCalledTimes(1);
+ expect(closeSecond).not.toHaveBeenCalled();
+ });
+
+ it("ignores an Escape that something inside the layer already handled", () => {
+ const onClose = vi.fn();
+ render(<Layer name="only" isOpen onClose={onClose} />);
+
+ const handled = new KeyboardEvent("keydown", {
+ key: "Escape",
+ bubbles: true,
+ cancelable: true,
+ });
+ handled.preventDefault();
+ act(() => {
+ document.body.dispatchEvent(handled);
+ });
+ expect(onClose).not.toHaveBeenCalled();
+
+ pressEscape();
+ expect(onClose).toHaveBeenCalledTimes(1);
+ });
+
+ it("stops listening once every layer is closed or unmounted", () => {
+ const onClose = vi.fn();
+ const { rerender, unmount } = render(
+ <Layer name="only" isOpen onClose={onClose} />,
+ );
+ rerender(<Layer name="only" isOpen={false} onClose={onClose} />);
+ pressEscape();
+ expect(onClose).not.toHaveBeenCalled();
+
+ rerender(<Layer name="only" isOpen onClose={onClose} />);
+ unmount();
+ pressEscape();
+ expect(onClose).not.toHaveBeenCalled();
+ });
+});
diff --git a/src/components/features/chat/components/context-window-meter.tsx b/src/components/features/chat/components/context-window-meter.tsx
index 5675d8a461..de69303826 100644
--- a/src/components/features/chat/components/context-window-meter.tsx
+++ b/src/components/features/chat/components/context-window-meter.tsx
@@ -4,6 +4,7 @@ import { useTranslation } from "react-i18next";
import { useContextWindowUsage } from "#/hooks/use-context-window-usage";
import { useSelectConversationTab } from "#/hooks/use-select-conversation-tab";
import { useClickOutsideElement } from "#/hooks/use-click-outside-element";
+import { useCloseOnEscape } from "#/hooks/use-close-on-escape";
import { useCompactContextAction } from "#/hooks/use-compact-context-action";
import { ContextMenuListItem } from "#/components/features/context-menu/context-menu-list-item";
import { ConversationNameContextMenuIconText } from "#/components/features/conversation/conversation-name-context-menu-icon-text";
@@ -44,6 +45,7 @@ export function ContextWindowMeter() {
() => setIsPopoverOpen(false),
triggerRef,
);
+ useCloseOnEscape(isPopoverOpen, () => setIsPopoverOpen(false), triggerRef);
const { handleCompact, isCompacting, isDisabled } = useCompactContextAction(
usage?.perTurnToken ?? 0,
);
@@ -72,6 +74,9 @@ export function ContextWindowMeter() {
<StyledTooltip
content={t(I18nKey.CHAT_INTERFACE$SHOW_CONTEXT)}
placement="top"
+ // While the popover is open the hint is redundant, and an open
+ // tooltip would swallow the Escape meant for the popover.
+ isDisabled={isPopoverOpen}
>
<button
ref={triggerRef}
diff --git a/src/components/features/command-menu/command-menu.tsx b/src/components/features/command-menu/command-menu.tsx
index cfa175df4f..7c6bdb3570 100644
--- a/src/components/features/command-menu/command-menu.tsx
+++ b/src/components/features/command-menu/command-menu.tsx
@@ -4,6 +4,7 @@ import { Search, X } from "lucide-react";
import { useTranslation } from "react-i18next";
import { I18nKey } from "#/i18n/declaration";
import { useNavigation } from "#/context/navigation-context";
+import { useCloseOnEscape } from "#/hooks/use-close-on-escape";
import { useCommandMenuStore } from "#/stores/command-menu-store";
import { useSidebarStore } from "#/stores/sidebar-store";
import { cn } from "#/utils/utils";
@@ -25,7 +26,6 @@ const COMMAND_MENU_SHORTCUT_KEY = "k";
const COMMAND_MENU_ARROW_DOWN_KEY = "ArrowDown";
const COMMAND_MENU_ARROW_UP_KEY = "ArrowUp";
const COMMAND_MENU_ENTER_KEY = "Enter";
-const COMMAND_MENU_ESCAPE_KEY = "Escape";
const EMPTY_QUERY = "";
const EMPTY_RESULTS_ACTIVE_INDEX = -1;
@@ -85,6 +85,9 @@ export function CommandMenu() {
return () => window.removeEventListener("keydown", onKeyDown);
}, [open]);
+ // Escape closes the modal from any element inside it, not only the input.
+ useCloseOnEscape(isOpen, close);
+
React.useEffect(() => {
if (!isOpen) {
setQuery(EMPTY_QUERY);
@@ -93,8 +96,18 @@ export function CommandMenu() {
return undefined;
}
+ // Return focus to whatever had it (for example the composer) on close.
+ const previouslyFocused =
+ document.activeElement instanceof HTMLElement
+ ? document.activeElement
+ : null;
const frame = requestAnimationFrame(() => inputRef.current?.focus());
- return () => cancelAnimationFrame(frame);
+ return () => {
+ cancelAnimationFrame(frame);
+ if (previouslyFocused?.isConnected) {
+ previouslyFocused.focus();
+ }
+ };
}, [isOpen]);
const items = React.useMemo(
@@ -174,12 +187,6 @@ export function CommandMenu() {
if (event.key === COMMAND_MENU_ENTER_KEY) {
event.preventDefault();
runItem(filteredItems[activeIndex]);
- return;
- }
-
- if (event.key === COMMAND_MENU_ESCAPE_KEY) {
- event.preventDefault();
- close();
}
};
diff --git a/src/components/features/conversation-panel/conversation-card/conversation-card-actions.tsx b/src/components/features/conversation-panel/conversation-card/conversation-card-actions.tsx
index 76df0f4373..1dfa2b4f47 100644
--- a/src/components/features/conversation-panel/conversation-card/conversation-card-actions.tsx
+++ b/src/components/features/conversation-panel/conversation-card/conversation-card-actions.tsx
@@ -5,6 +5,7 @@ import { cn } from "#/utils/utils";
import { I18nKey } from "#/i18n/declaration";
import { ExecutionStatus } from "#/types/agent-server/core/base/common";
import { isExecutionActive, isExecutionPaused } from "#/utils/status";
+import { useCloseOnEscape } from "#/hooks/use-close-on-escape";
import { ConversationCardContextMenu } from "./conversation-card-context-menu";
import { EllipsisButton } from "../ellipsis-button";
@@ -40,6 +41,11 @@ export function ConversationCardActions({
const isActive = isExecutionActive(executionStatus);
const anchorRef = useRef<HTMLButtonElement>(null);
const [, bumpPosition] = useReducer((i: number) => i + 1, 0);
+ useCloseOnEscape(
+ contextMenuOpen,
+ () => onContextMenuToggle(false),
+ anchorRef,
+ );
useLayoutEffect(() => {
if (!contextMenuOpen) return undefined;
diff --git a/src/components/features/conversation/conversation-overview-drawer-content.tsx b/src/components/features/conversation/conversation-overview-drawer-content.tsx
index f3cd95d7f4..56fc1cda3e 100644
--- a/src/components/features/conversation/conversation-overview-drawer-content.tsx
+++ b/src/components/features/conversation/conversation-overview-drawer-content.tsx
@@ -1,4 +1,3 @@
-import React, { useEffect } from "react";
import { useTranslation } from "react-i18next";
import XMarkIcon from "#/icons/x-mark.svg?react";
import { BrandButton } from "#/components/features/settings/brand-button";
@@ -18,6 +17,7 @@ import {
ConversationOverviewGitItemsPanel,
} from "./conversation-overview-git-items-panel";
import { useConversationOverviewStats } from "#/hooks/use-conversation-overview-stats";
+import { useCloseOnEscape } from "#/hooks/use-close-on-escape";
import {
CONVERSATION_SECONDARY_DRAWER_CLOSE_BUTTON_CLASSNAME,
CONVERSATION_SECONDARY_DRAWER_HEADER_ACTION_CLASSNAME,
@@ -149,22 +149,9 @@ export function ConversationOverviewDrawerContent({
const { section, openAdd, closeDrawer } = useConversationOverviewDrawer();
const { workspaceName } = useConversationOverviewStats();
- useEffect(() => {
- if (!section) {
- return undefined;
- }
-
- const handleEscape = (event: KeyboardEvent) => {
- if (event.key === "Escape") {
- closeDrawer();
- }
- };
-
- document.addEventListener("keydown", handleEscape);
- return () => {
- document.removeEventListener("keydown", handleEscape);
- };
- }, [closeDrawer, section]);
+ // A menu opened after the drawer (such as the Overview β‹― menu) takes
+ // Escape first.
+ useCloseOnEscape(Boolean(section), closeDrawer);
if (!section) {
return null;
diff --git a/src/components/features/conversation/conversation-overview-panel.tsx b/src/components/features/conversation/conversation-overview-panel.tsx
index 1a0cad048f..9dcab4f534 100644
--- a/src/components/features/conversation/conversation-overview-panel.tsx
+++ b/src/components/features/conversation/conversation-overview-panel.tsx
@@ -5,6 +5,7 @@ import { useConversationOverviewStats } from "#/hooks/use-conversation-overview-
import { useConversationId } from "#/hooks/use-conversation-id";
import { useConversationPrimaryRepository } from "#/hooks/use-conversation-primary-repository";
import { useConversationLocalStorageState } from "#/utils/conversation-local-storage";
+import { useCloseOnEscape } from "#/hooks/use-close-on-escape";
import { ConversationOverviewDiffsRow } from "./conversation-overview-diffs-row";
import { ConversationOverviewContextMenu } from "./conversation-overview-context-menu";
import { ConversationOverviewGitSection } from "./conversation-overview-git-section";
@@ -80,6 +81,7 @@ export function ConversationOverviewPanel() {
const { isConnected: isGitConnected } = useConversationPrimaryRepository();
const [isMenuOpen, setIsMenuOpen] = useState(false);
const menuAnchorRef = useRef<HTMLButtonElement>(null);
+ useCloseOnEscape(isMenuOpen, () => setIsMenuOpen(false), menuAnchorRef);
const isPinned = (section: ConversationOverviewSection) =>
isOverviewSectionPinned(section, state.unpinnedOverviewSections ?? []);
diff --git a/src/components/features/sidebar/sidebar.tsx b/src/components/features/sidebar/sidebar.tsx
index 9d0c88b20d..1e1b8f319b 100644
--- a/src/components/features/sidebar/sidebar.tsx
+++ b/src/components/features/sidebar/sidebar.tsx
@@ -11,6 +11,7 @@ import { cn } from "#/utils/utils";
import { useSidebarMobileNav } from "./sidebar-mobile-nav-context";
import { useSidebarStore } from "#/stores/sidebar-store";
import { useClickOutsideElement } from "#/hooks/use-click-outside-element";
+import { useCloseOnEscape } from "#/hooks/use-close-on-escape";
import { useBackendsHealth } from "#/hooks/query/use-backends-health";
// The LLM settings modal is only mounted when the settings query 404s and
// LLM settings aren't hidden β€” keep it out of the sidebar's eager graph.
@@ -95,20 +96,8 @@ export function Sidebar() {
return () => window.clearTimeout(timer);
}, [isMobileNavOpen]);
- React.useEffect(() => {
- if (!isMobileNavOpen) {
- return undefined;
- }
-
- const onKeyDown = (event: KeyboardEvent) => {
- if (event.key === "Escape") {
- closeMobileNav();
- }
- };
-
- window.addEventListener("keydown", onKeyDown);
- return () => window.removeEventListener("keydown", onKeyDown);
- }, [isMobileNavOpen, closeMobileNav]);
+ // A menu or the command menu opened over the drawer takes Escape first.
+ useCloseOnEscape(isMobileNavOpen, closeMobileNav);
React.useEffect(() => {
if (currentPath === "/settings") {
diff --git a/src/components/shared/buttons/styled-tooltip.tsx b/src/components/shared/buttons/styled-tooltip.tsx
index 484327b044..b2d50b2ff8 100644
--- a/src/components/shared/buttons/styled-tooltip.tsx
+++ b/src/components/shared/buttons/styled-tooltip.tsx
@@ -12,6 +12,7 @@ export interface StyledTooltipProps {
offset?: number;
shouldFlip?: boolean;
isOpen?: TooltipProps["isOpen"];
+ isDisabled?: TooltipProps["isDisabled"];
}
function getTooltipTriggerChild(children: ReactNode) {
@@ -31,6 +32,7 @@ export function StyledTooltip({
shouldFlip,
offset = 7,
isOpen,
+ isDisabled,
}: StyledTooltipProps) {
const disableAnimation = import.meta.env.MODE === "test";
@@ -42,6 +44,7 @@ export function StyledTooltip({
offset={offset}
shouldFlip={shouldFlip}
isOpen={isOpen}
+ isDisabled={isDisabled}
className={cn("bg-contrast text-contrast-foreground", tooltipClassName)}
showArrow={showArrow}
disableAnimation={disableAnimation}
diff --git a/src/hooks/use-close-on-escape.ts b/src/hooks/use-close-on-escape.ts
new file mode 100644
index 0000000000..2752ed12fe
--- /dev/null
+++ b/src/hooks/use-close-on-escape.ts
@@ -0,0 +1,75 @@
+import React from "react";
+
+const ESCAPE_KEY = "Escape";
+
+interface EscapeLayer {
+ close: () => void;
+}
+
+/**
+ * Open layers, oldest first. Escape closes only the last one, which is the
+ * layer the user opened most recently and so the one on top (for example the
+ * command menu over a card menu that was left open).
+ */
+const openLayers: EscapeLayer[] = [];
+
+const handleDocumentKeyDown = (event: KeyboardEvent) => {
+ if (event.key !== ESCAPE_KEY || event.defaultPrevented) return;
+ const topLayer = openLayers[openLayers.length - 1];
+ if (!topLayer) return;
+ event.preventDefault();
+ topLayer.close();
+};
+
+const pushLayer = (layer: EscapeLayer) => {
+ if (openLayers.length === 0) {
+ document.addEventListener("keydown", handleDocumentKeyDown);
+ }
+ openLayers.push(layer);
+};
+
+const removeLayer = (layer: EscapeLayer) => {
+ const index = openLayers.indexOf(layer);
+ if (index !== -1) openLayers.splice(index, 1);
+ if (openLayers.length === 0) {
+ document.removeEventListener("keydown", handleDocumentKeyDown);
+ }
+};
+
+/**
+ * Close a menu, popover or drawer when Escape is pressed anywhere while it is
+ * open, then return focus to its trigger. Listening on the document (rather
+ * than on the popup) covers focus that is still on the trigger or has moved
+ * past a portaled menu with Tab. When several layers are open, one Escape
+ * closes only the most recently opened one. An Escape whose default was
+ * already prevented (handled by something inside the layer) is ignored.
+ * Pairs with `useClickOutsideElement`.
+ */
+export const useCloseOnEscape = (
+ isOpen: boolean,
+ onClose: () => void,
+ returnFocusRef?: React.RefObject<HTMLElement | null>,
+) => {
+ // Hold the latest values in refs so callers can pass inline closures
+ // without moving their layer to the top of the stack on every render.
+ const onCloseRef = React.useRef(onClose);
+ const returnFocusRefRef = React.useRef(returnFocusRef);
+ React.useEffect(() => {
+ onCloseRef.current = onClose;
+ returnFocusRefRef.current = returnFocusRef;
+ });
+
+ React.useEffect(() => {
+ if (!isOpen) return undefined;
+
+ const layer: EscapeLayer = {
+ close: () => {
+ onCloseRef.current();
+ returnFocusRefRef.current?.current?.focus();
+ },
+ };
+
+ pushLayer(layer);
+ return () => removeLayer(layer);
+ }, [isOpen]);
+};