Menu

Access a set of commands within a menu bar or dropdown menu. This component is based on the WAI-ARIA Menu Pattern and the WAI-ARIA Menu Button Pattern.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
import {
  Menu,
  MenuButton,
  MenuButtonArrow,
  MenuItem,
  MenuSeparator,
  useMenuState,
} from "ariakit/menu";
import "./style.css";

export default function Example() {
  const menu = useMenuState({ gutter: 8 });
  return (
    <>
      <MenuButton state={menu} className="button">
        Actions
        <MenuButtonArrow />
      </MenuButton>
      <Menu state={menu} className="menu">
        <MenuItem className="menu-item" onClick={() => alert("Edit")}>
          Edit
        </MenuItem>
        <MenuItem className="menu-item">Share</MenuItem>
        <MenuItem className="menu-item" disabled>
          Delete
        </MenuItem>
        <MenuSeparator className="separator" />
        <MenuItem className="menu-item">Report</MenuItem>
      </Menu>
    </>
  );
}

Installation

npm install ariakit

Learn more in Getting started.

API

useMenuState()

<MenuButton>
  <MenuButtonArrow />
</MenuButton>
<MenuList|Menu>
  <MenuArrow />
  <MenuHeading />
  <MenuDescription />
  <MenuDismiss />
  <MenuGroup>
    <MenuGroupLabel />
    <MenuItem />
    <MenuItemCheckbox|MenuItemRadio>
      <MenuItemCheck />
    </MenuItemCheckbox|MenuItemRadio>
    <MenuSeparator />
  </MenuGroup>
</MenuList|Menu>

useMenuBarState()

<MenuBar />

Styling

Styling the active item

When browsing the list with a keyboard (or hovering over items with the mouse when the focusOnHover prop is true), the active item element will have a data-active-item attribute. You can use this attribute to style the active item:

.menu-item[data-active-item] {
  background-color: hsl(204 100% 40%);
  color: white;
}

Learn more in Styling.

Should I use Menu or Select?

Because they behave similarly, it may not be obvious when to use Menu and when to use Select. Here are some guidelines to help you decide:

• Use Select when the purpose is to select a value from a list of options. For example, a dropdown to select a country from a list of countries.
• Use Menu when the purpose is to access a set of commands, actions, or links. For example, a dropdown to access a set of commands to edit a document.

There are also some differences in how both components behave. Similarly to the native <select> element, the Select button's text will reflect the selected item. The button may also have a label in addition to the value. When the SelectPopover opens, the selected item will be focused and brought into view.

On the other hand, MenuButton can't hold a value, only a label, which won't reflect the active item. It's usually a static call to action.