Skip to content

🙌 OpenHands: AI-Driven Development

fix(a11y): close the tools, status and tabs menus on Escape (#18095)

Engel Nyst9f055996c6b6
diff --git a/__tests__/components/chat/chat-add-file-button.test.tsx b/__tests__/components/chat/chat-add-file-button.test.tsx
index 6dc767bae0..bed0aee1c0 100644
--- a/__tests__/components/chat/chat-add-file-button.test.tsx
+++ b/__tests__/components/chat/chat-add-file-button.test.tsx
@@ -2,6 +2,7 @@ import { render, screen } from "@testing-library/react";
import userEvent from "@testing-library/user-event";
import { describe, expect, it, vi } from "vitest";
import { ChatAddFileButton } from "#/components/features/chat/chat-add-file-button";
+import { useCloseOnEscape } from "#/hooks/use-close-on-escape";
import { I18nKey } from "#/i18n/declaration";
vi.mock("#/hooks/query/use-active-conversation", () => ({
@@ -33,12 +34,28 @@ vi.mock("#/hooks/use-user-providers", () => ({
useUserProviders: () => ({ providers: [] }),
}));
+// Stands in for a layer opened over the tools menu without an outside click,
+// such as the command menu opened with Ctrl+K.
+function LayerOverMenu({
+ isOpen,
+ onClose,
+}: {
+ isOpen: boolean;
+ onClose: () => void;
+}) {
+ useCloseOnEscape(isOpen, onClose);
+ return null;
+}
+
describe("ChatAddFileButton", () => {
it("uses the translated aria-label for the plus menu trigger", () => {
render(<ChatAddFileButton handleFileIconClick={vi.fn()} />);
const button = screen.getByTestId("chat-plus-button");
- expect(button).toHaveAttribute("aria-label", I18nKey.CHAT_INTERFACE$PLUS_MENU);
+ expect(button).toHaveAttribute(
+ "aria-label",
+ I18nKey.CHAT_INTERFACE$PLUS_MENU,
+ );
expect(button).toHaveAttribute("aria-haspopup", "menu");
});
@@ -55,15 +72,54 @@ describe("ChatAddFileButton", () => {
expect(handleFileIconClick).toHaveBeenCalledTimes(1);
});
+ it.each(["chat-plus-button", "macros-button"])(
+ "closes the tools menu with Escape from %s and returns focus to the + button",
+ async (focusedTestId) => {
+ const user = userEvent.setup();
+ render(<ChatAddFileButton handleFileIconClick={vi.fn()} />);
+ const trigger = screen.getByTestId("chat-plus-button");
+
+ await user.click(trigger);
+ screen.getByTestId(focusedTestId).focus();
+ await user.keyboard("{Escape}");
+
+ expect(
+ screen.queryByTestId("tools-context-menu"),
+ ).not.toBeInTheDocument();
+ expect(trigger).toHaveAttribute("aria-expanded", "false");
+ expect(trigger).toHaveFocus();
+ },
+ );
+
+ it("leaves the tools menu open while a layer opened over it takes Escape", async () => {
+ const user = userEvent.setup();
+ const closeLayer = vi.fn();
+ const renderWithLayer = (isLayerOpen: boolean) => (
+ <>
+ <ChatAddFileButton handleFileIconClick={vi.fn()} />
+ <LayerOverMenu isOpen={isLayerOpen} onClose={closeLayer} />
+ </>
+ );
+ const { rerender } = render(renderWithLayer(false));
+ await user.click(screen.getByTestId("chat-plus-button"));
+ rerender(renderWithLayer(true));
+
+ await user.keyboard("{Escape}");
+ expect(closeLayer).toHaveBeenCalledTimes(1);
+ expect(screen.getByTestId("tools-context-menu")).toBeInTheDocument();
+
+ // Once the layer above has closed, the next Escape reaches the menu.
+ rerender(renderWithLayer(false));
+ await user.keyboard("{Escape}");
+ expect(screen.queryByTestId("tools-context-menu")).not.toBeInTheDocument();
+ });
+
it("does not open the menu or invoke the file handler when disabled", async () => {
const user = userEvent.setup();
const handleFileIconClick = vi.fn();
render(
- <ChatAddFileButton
- handleFileIconClick={handleFileIconClick}
- disabled
- />,
+ <ChatAddFileButton handleFileIconClick={handleFileIconClick} disabled />,
);
const button = screen.getByTestId("chat-plus-button");
diff --git a/__tests__/components/features/conversation/conversation-name-with-status.test.tsx b/__tests__/components/features/conversation/conversation-name-with-status.test.tsx
index 70980ea740..7bccc40069 100644
--- a/__tests__/components/features/conversation/conversation-name-with-status.test.tsx
+++ b/__tests__/components/features/conversation/conversation-name-with-status.test.tsx
@@ -6,6 +6,7 @@ import {
OH_STATUS_ERROR_COLOR,
OH_STATUS_SUCCESS_COLOR,
} from "#/constants/status-colors";
+import { useCloseOnEscape } from "#/hooks/use-close-on-escape";
import { AgentState } from "#/types/agent-state";
import { ExecutionStatus } from "#/types/agent-server/core/base/common";
@@ -86,26 +87,20 @@ vi.mock("#/components/features/controls/server-status-context-menu", () => ({
data-is-pausing={String(isPausing)}
data-position={position}
>
- <button type="button" data-testid="close-status-menu" onClick={onClose}>
- close
- </button>
+ <button type="button" data-testid="close-status-menu" onClick={onClose} />
{onStopServer && (
<button
type="button"
data-testid="stop-server-button"
onClick={onStopServer}
- >
- stop
- </button>
+ />
)}
{onStartServer && (
<button
type="button"
data-testid="start-server-button"
onClick={onStartServer}
- >
- start
- </button>
+ />
)}
</div>
),
@@ -138,6 +133,27 @@ function openStatusMenu() {
fireEvent.click(screen.getByTestId("server-status-menu-trigger"));
}
+function hoverStatusMenu() {
+ fireEvent.pointerEnter(
+ screen.getByTestId("server-status-menu-trigger")
+ .parentElement as HTMLElement,
+ { pointerType: "mouse" },
+ );
+}
+
+function pressEscape() {
+ fireEvent.keyDown(document.activeElement ?? document.body, {
+ key: "Escape",
+ });
+}
+
+// Stands in for a layer opened before the status menu, such as the
+// context-window popover.
+function LayerUnderMenu({ onClose }: { onClose: () => void }) {
+ useCloseOnEscape(true, onClose);
+ return null;
+}
+
describe("conversation name status controls", () => {
beforeEach(() => {
vi.clearAllMocks();
@@ -278,6 +294,63 @@ describe("conversation name status controls", () => {
).not.toBeInTheDocument();
});
+ it.each(["server-status-menu-trigger", "stop-server-button"])(
+ "closes a clicked-open menu with Escape from %s and returns focus to the dot",
+ (focusedTestId) => {
+ renderSubject();
+ const trigger = screen.getByTestId("server-status-menu-trigger");
+
+ openStatusMenu();
+ screen.getByTestId(focusedTestId).focus();
+ pressEscape();
+
+ expect(
+ screen.queryByTestId("server-status-context-menu"),
+ ).not.toBeInTheDocument();
+ expect(trigger).toHaveAttribute("aria-expanded", "false");
+ expect(trigger).toHaveFocus();
+ },
+ );
+
+ it("closes a hover-opened menu with Escape without moving focus", () => {
+ render(
+ <>
+ <textarea data-testid="composer" />
+ <ConversationNameWithStatus />
+ </>,
+ );
+ const composer = screen.getByTestId("composer");
+ composer.focus();
+
+ hoverStatusMenu();
+ pressEscape();
+
+ expect(
+ screen.queryByTestId("server-status-context-menu"),
+ ).not.toBeInTheDocument();
+ expect(composer).toHaveFocus();
+ });
+
+ it("closes a menu opened over another layer before that layer", () => {
+ const closeLayer = vi.fn();
+ render(
+ <>
+ <LayerUnderMenu onClose={closeLayer} />
+ <ConversationNameWithStatus />
+ </>,
+ );
+
+ hoverStatusMenu();
+ pressEscape();
+ expect(
+ screen.queryByTestId("server-status-context-menu"),
+ ).not.toBeInTheDocument();
+ expect(closeLayer).not.toHaveBeenCalled();
+
+ pressEscape();
+ expect(closeLayer).toHaveBeenCalledTimes(1);
+ });
+
it.each([
[ExecutionStatus.RUNNING, "stop-server-button"],
[ExecutionStatus.PAUSED, "start-server-button"],
diff --git a/__tests__/components/features/conversation/conversation-tabs-context-menu.test.tsx b/__tests__/components/features/conversation/conversation-tabs-context-menu.test.tsx
index d0d30799be..ce57fefd28 100644
--- a/__tests__/components/features/conversation/conversation-tabs-context-menu.test.tsx
+++ b/__tests__/components/features/conversation/conversation-tabs-context-menu.test.tsx
@@ -1,8 +1,9 @@
import { render, screen } from "@testing-library/react";
-import { useRef } from "react";
+import { useRef, useState } from "react";
import userEvent from "@testing-library/user-event";
import { describe, it, expect, vi, beforeEach } from "vitest";
import { ConversationTabsContextMenu } from "#/components/features/conversation/conversation-tabs/conversation-tabs-context-menu";
+import { useCloseOnEscape } from "#/hooks/use-close-on-escape";
import { useConversationStore } from "#/stores/conversation-store";
import { ActiveBackendProvider } from "#/contexts/active-backend-context";
import { __resetActiveStoreForTests } from "#/api/backend-registry/active-store";
@@ -110,6 +111,41 @@ const renderAnchoredMenu = (rect: {
return document.querySelector<HTMLElement>('div[style*="position: fixed"]');
};
+/** The â‹® trigger toggles and anchors the menu, as in ConversationTabs. */
+function MenuWithTrigger() {
+ const [isOpen, setIsOpen] = useState(false);
+ const anchorRef = useRef<HTMLButtonElement>(null);
+ return (
+ <>
+ <button
+ type="button"
+ ref={anchorRef}
+ data-testid="tabs-menu-trigger"
+ onClick={() => setIsOpen(!isOpen)}
+ />
+ <ConversationTabsContextMenu
+ isOpen={isOpen}
+ onClose={() => setIsOpen(false)}
+ ignoreOutsideClickRef={anchorRef}
+ anchorRef={anchorRef}
+ />
+ </>
+ );
+}
+
+// Stands in for a layer opened over the menu without an outside click, such
+// as the command menu opened with Ctrl+K.
+function LayerOverMenu({
+ isOpen,
+ onClose,
+}: {
+ isOpen: boolean;
+ onClose: () => void;
+}) {
+ useCloseOnEscape(isOpen, onClose);
+ return null;
+}
+
describe("ConversationTabsContextMenu", () => {
beforeEach(() => {
localStorage.clear();
@@ -171,7 +207,9 @@ describe("ConversationTabsContextMenu", () => {
render(<ConversationTabsContextMenu isOpen={true} onClose={vi.fn()} />);
- await user.click(screen.getByTestId("conversation-tabs-menu-open-terminal"));
+ await user.click(
+ screen.getByTestId("conversation-tabs-menu-open-terminal"),
+ );
expect(useConversationStore.getState().selectedTab).toBe("terminal");
const storedState = JSON.parse(
@@ -230,6 +268,51 @@ describe("ConversationTabsContextMenu", () => {
expect(storeState.hasRightPanelToggled).toBe(true);
});
+ it.each(["tabs-menu-trigger", "conversation-tabs-menu-open-files"])(
+ "closes with Escape from %s and returns focus to its trigger",
+ async (focusedTestId) => {
+ const user = userEvent.setup();
+ render(<MenuWithTrigger />);
+ const trigger = screen.getByTestId("tabs-menu-trigger");
+
+ await user.click(trigger);
+ screen.getByTestId(focusedTestId).focus();
+ await user.keyboard("{Escape}");
+
+ expect(
+ screen.queryByTestId("conversation-tabs-menu-open-files"),
+ ).not.toBeInTheDocument();
+ expect(trigger).toHaveFocus();
+ },
+ );
+
+ it("stays open while a layer opened over it takes Escape", async () => {
+ const user = userEvent.setup();
+ const closeLayer = vi.fn();
+ const renderWithLayer = (isLayerOpen: boolean) => (
+ <>
+ <MenuWithTrigger />
+ <LayerOverMenu isOpen={isLayerOpen} onClose={closeLayer} />
+ </>
+ );
+ const { rerender } = render(renderWithLayer(false));
+ await user.click(screen.getByTestId("tabs-menu-trigger"));
+ rerender(renderWithLayer(true));
+
+ await user.keyboard("{Escape}");
+ expect(closeLayer).toHaveBeenCalledTimes(1);
+ expect(
+ screen.getByTestId("conversation-tabs-menu-open-files"),
+ ).toBeInTheDocument();
+
+ // Once the layer above has closed, the next Escape reaches the menu.
+ rerender(renderWithLayer(false));
+ await user.keyboard("{Escape}");
+ expect(
+ screen.queryByTestId("conversation-tabs-menu-open-files"),
+ ).not.toBeInTheDocument();
+ });
+
describe("with tasklist", () => {
beforeEach(() => {
mockHasTaskList = true;
diff --git a/src/components/features/chat/chat-add-file-button.tsx b/src/components/features/chat/chat-add-file-button.tsx
index cf10ffe0b0..5481f2c46b 100644
--- a/src/components/features/chat/chat-add-file-button.tsx
+++ b/src/components/features/chat/chat-add-file-button.tsx
@@ -6,6 +6,7 @@ import { cn } from "#/utils/utils";
import { chatInputIconButtonClassName } from "#/utils/form-control-classes";
import { useOptionalConversationId } from "#/hooks/use-conversation-id";
import { useActiveConversation } from "#/hooks/query/use-active-conversation";
+import { useCloseOnEscape } from "#/hooks/use-close-on-escape";
import { useConversationNameContextMenu } from "#/hooks/use-conversation-name-context-menu";
import { ToolsContextMenu } from "#/components/features/controls/tools-context-menu";
import { SystemMessageModal } from "#/components/features/conversation-panel/system-message-modal";
@@ -34,6 +35,8 @@ export function ChatAddFileButton({
const { conversationId } = useOptionalConversationId();
const { data: conversation } = useActiveConversation();
const [menuOpen, setMenuOpen] = React.useState(false);
+ const triggerRef = React.useRef<HTMLButtonElement>(null);
+ useCloseOnEscape(menuOpen, () => setMenuOpen(false), triggerRef);
const {
handleShowAgentTools,
@@ -69,6 +72,7 @@ export function ChatAddFileButton({
return (
<div className="relative">
<button
+ ref={triggerRef}
type="button"
className={cn(
chatInputIconButtonClassName,
diff --git a/src/components/features/conversation/conversation-name-with-status.tsx b/src/components/features/conversation/conversation-name-with-status.tsx
index f77ad4e12c..6fa3aa4fe9 100644
--- a/src/components/features/conversation/conversation-name-with-status.tsx
+++ b/src/components/features/conversation/conversation-name-with-status.tsx
@@ -6,6 +6,7 @@ import { useActiveConversation } from "#/hooks/query/use-active-conversation";
import { useUnifiedPauseConversation } from "#/hooks/mutation/use-unified-stop-conversation";
import { useUnifiedResumeConversation } from "#/hooks/mutation/use-unified-start-conversation";
import { useConversationId } from "#/hooks/use-conversation-id";
+import { useCloseOnEscape } from "#/hooks/use-close-on-escape";
import { useUserProviders } from "#/hooks/use-user-providers";
import { getStatusColor, cn } from "#/utils/utils";
import { AgentState } from "#/types/agent-state";
@@ -56,6 +57,10 @@ export function ConversationNameWithStatus() {
setHoveredOpen(false);
};
+ // A menu opened by click or Enter returns focus to the dot; one opened by
+ // hover closes without moving focus.
+ useCloseOnEscape(isMenuVisible, closeMenu, menuOpen ? triggerRef : undefined);
+
const handleStopServer = (event: React.MouseEvent<HTMLButtonElement>) => {
event.preventDefault();
event.stopPropagation();
diff --git a/src/components/features/conversation/conversation-tabs/conversation-tabs-context-menu.tsx b/src/components/features/conversation/conversation-tabs/conversation-tabs-context-menu.tsx
index b822f1b3f8..d498553b89 100644
--- a/src/components/features/conversation/conversation-tabs/conversation-tabs-context-menu.tsx
+++ b/src/components/features/conversation/conversation-tabs/conversation-tabs-context-menu.tsx
@@ -3,6 +3,7 @@ import ReactDOM from "react-dom";
import { useTranslation } from "react-i18next";
import { ContextMenu } from "#/ui/context-menu";
import { useClickOutsideElement } from "#/hooks/use-click-outside-element";
+import { useCloseOnEscape } from "#/hooks/use-close-on-escape";
import { clampLeftToViewport } from "#/hooks/use-popover-fixed-placement";
import { useConversationId } from "#/hooks/use-conversation-id";
import { useConversationLocalStorageState } from "#/utils/conversation-local-storage";
@@ -48,6 +49,7 @@ export function ConversationTabsContextMenu({
onClose,
ignoreOutsideClickRef,
);
+ useCloseOnEscape(isOpen, onClose, anchorRef);
const [portalStyle, setPortalStyle] = useState<React.CSSProperties>();
useLayoutEffect(() => {