Skip to content

Escape closes the Dropdown but does not return focus to the trigger #272

Open

Description

@FayazK

Versions

  • @rc-component/dropdown 1.0.3
  • @rc-component/portal 2.2.1
  • @rc-component/trigger 3.10.1
  • antd 6.6.6
  • react and react-dom 19.3.0
  • Chrome 155 on macOS. Checked with real clicks and key presses on a bare page holding only the snippet below.

Steps

import { Button, Dropdown } from 'antd';

export default function App() {
    return (
        <Dropdown menu={{ items: [{ key: 'a', label: 'Rename' }] }} trigger={['click']}>
            <Button>Actions</Button>
        </Dropdown>
    );
}
  1. Click "Actions". The menu opens.
  2. Press Tab. Focus moves into the menu.
  3. Press Escape.

Expected: the menu closes and focus goes back to the "Actions" button, as useAccessibility means it to (handleCloseMenuAndReturnFocus calls triggerRef.current.focus()).

Actual: the menu closes and document.activeElement is document.body. A keyboard user has lost their place on the page.

Cause, as far as we can tell

Two listeners on window handle the same Escape key press:

  1. @rc-component/portal, es/useEscKeyDown.js: onGlobalKeyDown calls onEsc for the popup on top of the stack. In @rc-component/trigger, es/index.js, onEsc calls triggerOpen(false).
  2. @rc-component/dropdown, es/hooks/useAccessibility.js: handleKeyDown on ESC calls handleCloseMenuAndReturnFocus(), which focuses the trigger.

The portal's listener is added first (the Portal is a child, so its effect runs before the Dropdown's), so it runs first. It closes the popup. React renders that close before the next listener runs, and the Dropdown's effect cleanup removes its own keydown listener. A listener removed during dispatch is not called, so the focus return never happens.

Note: a test that calls dispatchEvent from script may not show this, because microtasks do not run between listeners then, so React does not render the close in between. A real key press in a browser shows it.

Workaround we use

We pass our own onOpenChange that adds a capture-phase keydown listener on window while the menu is open, notes that Escape was pressed, and on close focuses the element with the ant-dropdown-open class. We would like to remove it once this is fixed here.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions