Menu

Menus display a list of actions or options that a user can choose.

install	`yarn add @adobe/react-spectrum`
added	3.0.0
usage	`import {Menu, MenuTrigger, ContextualHelpTrigger} from '@adobe/react-spectrum'`

View guidelines

Spectrum

Example#

<MenuTrigger>
  <ActionButton>
    Edit
  </ActionButton>
  <Menu onAction={(key) => alert(key)}>
    <Item key="cut">Cut</Item>
    <Item key="copy">Copy</Item>
    <Item key="paste">Paste</Item>
    <Item key="replace">Replace</Item>
  </Menu>
</MenuTrigger>

<MenuTrigger>
  <ActionButton>
    Edit
  </ActionButton>
  <Menu onAction={(key) => alert(key)}>
    <Item key="cut">Cut</Item>
    <Item key="copy">Copy</Item>
    <Item key="paste">Paste</Item>
    <Item key="replace">Replace</Item>
  </Menu>
</MenuTrigger>

<MenuTrigger>
  <ActionButton>
    Edit
  </ActionButton>
  <Menu
    onAction={(key) =>
      alert(key)}
  >
    <Item key="cut">
      Cut
    </Item>
    <Item key="copy">
      Copy
    </Item>
    <Item key="paste">
      Paste
    </Item>
    <Item key="replace">
      Replace
    </Item>
  </Menu>
</MenuTrigger>

Content#

Menu follows the Collection Components API, accepting both static and dynamic collections. Similar to Picker, Menu accepts <Item> elements as children, each with a key prop. Basic usage of Menu, seen in the example above, shows multiple items populated with a string. Static collections, as in this example, can be used when the full list of items is known ahead of time.

Dynamic collections, as shown below, can be used when the items come from an external data source such as an API call, or update over time. Providing the data in this way allows for Menu to automatically cache the rendering of each item, which dramatically improves performance.

As seen below, an iterable list of items is passed to the Menu using the items prop. Each item accepts a key prop, which is passed to the event handler to identify the selected item. Alternatively, if the item objects contain an id property, this is then used automatically and a key prop is not required. See the Events section for more detail on selection and actions.

function Example() {
  let menuItems = [
    {name: 'Cut'},
    {name: 'Copy'},
    {name: 'Paste'},
    {name: 'Replace'}
  ];

  return (
    <MenuTrigger>
      <ActionButton>
        Edit
      </ActionButton>
      <Menu items={menuItems}>
        {item => <Item key={item.name}>{item.name}</Item>}
      </Menu>
    </MenuTrigger>
  );
}

function Example() {
  let menuItems = [
    {name: 'Cut'},
    {name: 'Copy'},
    {name: 'Paste'},
    {name: 'Replace'}
  ];

  return (
    <MenuTrigger>
      <ActionButton>
        Edit
      </ActionButton>
      <Menu items={menuItems}>
        {item => <Item key={item.name}>{item.name}</Item>}
      </Menu>
    </MenuTrigger>
  );
}

function Example() {
  let menuItems = [
    { name: 'Cut' },
    { name: 'Copy' },
    { name: 'Paste' },
    { name: 'Replace' }
  ];

  return (
    <MenuTrigger>
      <ActionButton>
        Edit
      </ActionButton>
      <Menu
        items={menuItems}
      >
        {(item) => (
          <Item
            key={item
              .name}
          >
            {item.name}
          </Item>
        )}
      </Menu>
    </MenuTrigger>
  );
}

Trays#

On mobile, Menus automatically display in a tray instead of a popover to improve usability.

Internationalization#

In order to internationalize a Menu, the content provided to all child items should be localized. For languages that are read right-to-left (e.g. Hebrew and Arabic), the layout of the Menu is flipped.

Events#

Use the onSelectionChange prop as a callback to handle press events on items when selectionMode is either single or multiple. See Selection for more information.

Menu also supports the onAction callback when selectionMode is none (default).

function Example() {
  let [action, setAction] = React.useState(null);

  return (
    <>
      <MenuTrigger>
        <ActionButton>
          Edit
        </ActionButton>
        <Menu onAction={setAction}>
          <Item key="cut">Cut</Item>
          <Item key="copy">Copy</Item>
          <Item key="paste">Paste</Item>
        </Menu>
      </MenuTrigger>
      <p>Action: {action}</p>
    </>
  );
}

function Example() {
  let [action, setAction] = React.useState(null);

  return (
    <>
      <MenuTrigger>
        <ActionButton>
          Edit
        </ActionButton>
        <Menu onAction={setAction}>
          <Item key="cut">Cut</Item>
          <Item key="copy">Copy</Item>
          <Item key="paste">Paste</Item>
        </Menu>
      </MenuTrigger>
      <p>Action: {action}</p>
    </>
  );
}

function Example() {
  let [
    action,
    setAction
  ] = React.useState(
    null
  );

  return (
    <>
      <MenuTrigger>
        <ActionButton>
          Edit
        </ActionButton>
        <Menu
          onAction={setAction}
        >
          <Item key="cut">
            Cut
          </Item>
          <Item key="copy">
            Copy
          </Item>
          <Item key="paste">
            Paste
          </Item>
        </Menu>
      </MenuTrigger>
      <p>
        Action: {action}
      </p>
    </>
  );
}

Selection#

Menu supports multiple selection modes. By default, selection is disabled, however this can be changed using the selectionMode prop. Use defaultSelectedKeys to provide a default set of selected items (uncontrolled) and selectedKeys to set the selected items (controlled). The value of the selected keys must match the key prop of the items. See the react-stately Selection docs for caveats regarding selection prop typing.

import type {Selection} from '@adobe/react-spectrum';

function Example() {
  let [selected, setSelected] = React.useState<Selection>(new Set(['middle']));

  return (
    <>
      <MenuTrigger>
        <ActionButton>
          Align
        </ActionButton>
        <Menu
          selectionMode="single"
          selectedKeys={selected}
          onSelectionChange={setSelected}
        >
          <Item key="left">Left</Item>
          <Item key="middle">Middle</Item>
          <Item key="right">Right</Item>
        </Menu>
      </MenuTrigger>
      <p>Current selection (controlled): {[...selected]}</p>
    </>
  );
}

import type {Selection} from '@adobe/react-spectrum';

function Example() {
  let [selected, setSelected] = React.useState<Selection>(
    new Set(['middle'])
  );

  return (
    <>
      <MenuTrigger>
        <ActionButton>
          Align
        </ActionButton>
        <Menu
          selectionMode="single"
          selectedKeys={selected}
          onSelectionChange={setSelected}
        >
          <Item key="left">Left</Item>
          <Item key="middle">Middle</Item>
          <Item key="right">Right</Item>
        </Menu>
      </MenuTrigger>
      <p>Current selection (controlled): {[...selected]}</p>
    </>
  );
}

import type {Selection} from '@adobe/react-spectrum';

function Example() {
  let [
    selected,
    setSelected
  ] = React.useState<
    Selection
  >(new Set(['middle']));

  return (
    <>
      <MenuTrigger>
        <ActionButton>
          Align
        </ActionButton>
        <Menu
          selectionMode="single"
          selectedKeys={selected}
          onSelectionChange={setSelected}
        >
          <Item key="left">
            Left
          </Item>
          <Item key="middle">
            Middle
          </Item>
          <Item key="right">
            Right
          </Item>
        </Menu>
      </MenuTrigger>
      <p>
        Current selection
        (controlled):
        {' '}
        {[...selected]}
      </p>
    </>
  );
}

Set selectionMode prop to multiple to allow more than one selection.

function Example() {
  let [selected, setSelected] = React.useState<Selection>(
    new Set(['Sidebar', 'Console'])
  );

  return (
    <>
      <MenuTrigger closeOnSelect={false}>
        <ActionButton>
          Show
        </ActionButton>
        <Menu
          selectionMode="multiple"
          selectedKeys={selected}
          onSelectionChange={setSelected}
        >
          <Item key="Sidebar">Sidebar</Item>
          <Item key="Searchbar">Searchbar</Item>
          <Item key="Tools">Tools</Item>
          <Item key="Console">Console</Item>
        </Menu>
      </MenuTrigger>
      <p>
        Current selection (controlled):{' '}
        {selected === 'all' ? 'all' : [...selected].join(', ')}
      </p>
    </>
  );
}

function Example() {
  let [selected, setSelected] = React.useState<Selection>(
    new Set(['Sidebar', 'Console'])
  );

  return (
    <>
      <MenuTrigger closeOnSelect={false}>
        <ActionButton>
          Show
        </ActionButton>
        <Menu
          selectionMode="multiple"
          selectedKeys={selected}
          onSelectionChange={setSelected}
        >
          <Item key="Sidebar">Sidebar</Item>
          <Item key="Searchbar">Searchbar</Item>
          <Item key="Tools">Tools</Item>
          <Item key="Console">Console</Item>
        </Menu>
      </MenuTrigger>
      <p>
        Current selection (controlled): {selected === 'all'
          ? 'all'
          : [...selected].join(', ')}
      </p>
    </>
  );
}

function Example() {
  let [
    selected,
    setSelected
  ] = React.useState<
    Selection
  >(
    new Set([
      'Sidebar',
      'Console'
    ])
  );

  return (
    <>
      <MenuTrigger
        closeOnSelect={false}
      >
        <ActionButton>
          Show
        </ActionButton>
        <Menu
          selectionMode="multiple"
          selectedKeys={selected}
          onSelectionChange={setSelected}
        >
          <Item key="Sidebar">
            Sidebar
          </Item>
          <Item key="Searchbar">
            Searchbar
          </Item>
          <Item key="Tools">
            Tools
          </Item>
          <Item key="Console">
            Console
          </Item>
        </Menu>
      </MenuTrigger>
      <p>
        Current selection
        (controlled):
        {' '}
        {selected ===
            'all'
          ? 'all'
          : [...selected]
            .join(', ')}
      </p>
    </>
  );
}

Links#

By default, interacting with an item in a Menu triggers onAction and optionally onSelectionChange depending on the selectionMode. Alternatively, items may be links to another page or website. This can be achieved by passing the href prop to the <Item> component. Link items in a menu are not selectable.

<MenuTrigger>
  <ActionButton>Links</ActionButton>
  <Menu>
    <Item href="https://adobe.com/" target="_blank">Adobe</Item>
    <Item href="https://apple.com/" target="_blank">Apple</Item>
    <Item href="https://google.com/" target="_blank">Google</Item>
    <Item href="https://microsoft.com/" target="_blank">Microsoft</Item>
  </Menu>
</MenuTrigger>

<MenuTrigger>
  <ActionButton>Links</ActionButton>
  <Menu>
    <Item href="https://adobe.com/" target="_blank">
      Adobe
    </Item>
    <Item href="https://apple.com/" target="_blank">
      Apple
    </Item>
    <Item href="https://google.com/" target="_blank">
      Google
    </Item>
    <Item href="https://microsoft.com/" target="_blank">
      Microsoft
    </Item>
  </Menu>
</MenuTrigger>

<MenuTrigger>
  <ActionButton>
    Links
  </ActionButton>
  <Menu>
    <Item
      href="https://adobe.com/"
      target="_blank"
    >
      Adobe
    </Item>
    <Item
      href="https://apple.com/"
      target="_blank"
    >
      Apple
    </Item>
    <Item
      href="https://google.com/"
      target="_blank"
    >
      Google
    </Item>
    <Item
      href="https://microsoft.com/"
      target="_blank"
    >
      Microsoft
    </Item>
  </Menu>
</MenuTrigger>

Client side routing#

The <Item> component works with frameworks and client side routers like Next.js and React Router. As with other React Spectrum components that support links, this works via the Provider component at the root of your app. See the client side routing guide to learn how to set this up.

Sections#

Menu supports sections in order to group options. Sections can be used by wrapping groups of Items in a Section component. Each Section takes a title and key prop.

Static Items#

import type {Selection} from '@adobe/react-spectrum';

function Example() {
  let [selected, setSelected] = React.useState<Selection>(
    new Set(['bold', 'left'])
  );

  return (
    <MenuTrigger>
      <ActionButton>
        Edit
      </ActionButton>
      <Menu
        selectionMode="multiple"
        selectedKeys={selected}
        onSelectionChange={setSelected}
      >
        <Section title="Styles">
          <Item key="bold">Bold</Item>
          <Item key="underline">Underline</Item>
        </Section>
        <Section title="Align">
          <Item key="left">Left</Item>
          <Item key="middle">Middle</Item>
          <Item key="right">Right</Item>
        </Section>
      </Menu>
    </MenuTrigger>
  );
}

import type {Selection} from '@adobe/react-spectrum';

function Example() {
  let [selected, setSelected] = React.useState<Selection>(
    new Set(['bold', 'left'])
  );

  return (
    <MenuTrigger>
      <ActionButton>
        Edit
      </ActionButton>
      <Menu
        selectionMode="multiple"
        selectedKeys={selected}
        onSelectionChange={setSelected}
      >
        <Section title="Styles">
          <Item key="bold">Bold</Item>
          <Item key="underline">Underline</Item>
        </Section>
        <Section title="Align">
          <Item key="left">Left</Item>
          <Item key="middle">Middle</Item>
          <Item key="right">Right</Item>
        </Section>
      </Menu>
    </MenuTrigger>
  );
}

import type {Selection} from '@adobe/react-spectrum';

function Example() {
  let [
    selected,
    setSelected
  ] = React.useState<
    Selection
  >(
    new Set([
      'bold',
      'left'
    ])
  );

  return (
    <MenuTrigger>
      <ActionButton>
        Edit
      </ActionButton>
      <Menu
        selectionMode="multiple"
        selectedKeys={selected}
        onSelectionChange={setSelected}
      >
        <Section title="Styles">
          <Item key="bold">
            Bold
          </Item>
          <Item key="underline">
            Underline
          </Item>
        </Section>
        <Section title="Align">
          <Item key="left">
            Left
          </Item>
          <Item key="middle">
            Middle
          </Item>
          <Item key="right">
            Right
          </Item>
        </Section>
      </Menu>
    </MenuTrigger>
  );
}

Dynamic Items#

Sections used with dynamic items are populated from a hierarchical data structure. Similarly to the props on Menu, <Section> takes an array of data using the items prop.

import type {Selection} from '@adobe/react-spectrum';

function Example() {
  let [selected, setSelected] = React.useState<Selection>(new Set([1,3]));
  let openWindows = [
    {
      name: 'Left Panel',
      id: 'left',
      children: [
        {id: 1, name: 'Final Copy (1)'}
      ]
    },
    {
      name: 'Right Panel',
      id: 'right',
      children: [
        {id: 2, name: 'index.ts'},
        {id: 3, name: 'package.json'},
        {id: 4, name: 'license.txt'}
      ]
    }
  ];

  return (
    <MenuTrigger>
      <ActionButton>
        Window
      </ActionButton>
      <Menu
        items={openWindows}
        selectionMode="multiple"
        selectedKeys={selected}
        onSelectionChange={setSelected}>
        {item => (
          <Section items={item.children} title={item.name}>
            {item => <Item>{item.name}</Item>}
          </Section>
        )}
      </Menu>
    </MenuTrigger>
  );
}

import type {Selection} from '@adobe/react-spectrum';

function Example() {
  let [selected, setSelected] = React.useState<Selection>(
    new Set([1, 3])
  );
  let openWindows = [
    {
      name: 'Left Panel',
      id: 'left',
      children: [
        { id: 1, name: 'Final Copy (1)' }
      ]
    },
    {
      name: 'Right Panel',
      id: 'right',
      children: [
        { id: 2, name: 'index.ts' },
        { id: 3, name: 'package.json' },
        { id: 4, name: 'license.txt' }
      ]
    }
  ];

  return (
    <MenuTrigger>
      <ActionButton>
        Window
      </ActionButton>
      <Menu
        items={openWindows}
        selectionMode="multiple"
        selectedKeys={selected}
        onSelectionChange={setSelected}
      >
        {(item) => (
          <Section items={item.children} title={item.name}>
            {(item) => <Item>{item.name}</Item>}
          </Section>
        )}
      </Menu>
    </MenuTrigger>
  );
}

import type {Selection} from '@adobe/react-spectrum';

function Example() {
  let [
    selected,
    setSelected
  ] = React.useState<
    Selection
  >(new Set([1, 3]));
  let openWindows = [
    {
      name: 'Left Panel',
      id: 'left',
      children: [
        {
          id: 1,
          name:
            'Final Copy (1)'
        }
      ]
    },
    {
      name:
        'Right Panel',
      id: 'right',
      children: [
        {
          id: 2,
          name:
            'index.ts'
        },
        {
          id: 3,
          name:
            'package.json'
        },
        {
          id: 4,
          name:
            'license.txt'
        }
      ]
    }
  ];

  return (
    <MenuTrigger>
      <ActionButton>
        Window
      </ActionButton>
      <Menu
        items={openWindows}
        selectionMode="multiple"
        selectedKeys={selected}
        onSelectionChange={setSelected}
      >
        {(item) => (
          <Section
            items={item
              .children}
            title={item
              .name}
          >
            {(item) => (
              <Item>
                {item
                  .name}
              </Item>
            )}
          </Section>
        )}
      </Menu>
    </MenuTrigger>
  );
}

Accessibility#

Sections without a title must provide an aria-label for accessibility.

Items within Menu also allow for additional content used to better communicate options. Icons and descriptions can be added to the children of Item as shown in the example below. If a description is added, the prop slot="description" must be used to distinguish the different <Text> elements.

import {Keyboard, Text} from '@adobe/react-spectrum';
<MenuTrigger>
  <ActionButton>
    Edit
  </ActionButton>
  <Menu>
    <Item key="cut" textValue="cut">
      <Cut />
      <Text>Cut</Text>
      <Keyboard>⌘X</Keyboard>
    </Item>
    <Item key="copy" textValue="copy">
      <Copy />
      <Text>Copy</Text>
      <Keyboard>⌘C</Keyboard>
    </Item>
    <Item key="paste" textValue="paste">
      <Paste />
      <Text>Paste</Text>
      <Keyboard>⌘V</Keyboard>
    </Item>
  </Menu>
</MenuTrigger>

import {Keyboard, Text} from '@adobe/react-spectrum';
<MenuTrigger>
  <ActionButton>
    Edit
  </ActionButton>
  <Menu>
    <Item key="cut" textValue="cut">
      <Cut />
      <Text>Cut</Text>
      <Keyboard>⌘X</Keyboard>
    </Item>
    <Item key="copy" textValue="copy">
      <Copy />
      <Text>Copy</Text>
      <Keyboard>⌘C</Keyboard>
    </Item>
    <Item key="paste" textValue="paste">
      <Paste />
      <Text>Paste</Text>
      <Keyboard>⌘V</Keyboard>
    </Item>
  </Menu>
</MenuTrigger>

import {
  Keyboard,
  Text
} from '@adobe/react-spectrum';
<MenuTrigger>
  <ActionButton>
    Edit
  </ActionButton>
  <Menu>
    <Item
      key="cut"
      textValue="cut"
    >
      <Cut />
      <Text>Cut</Text>
      <Keyboard>
        ⌘X
      </Keyboard>
    </Item>
    <Item
      key="copy"
      textValue="copy"
    >
      <Copy />
      <Text>Copy</Text>
      <Keyboard>
        ⌘C
      </Keyboard>
    </Item>
    <Item
      key="paste"
      textValue="paste"
    >
      <Paste />
      <Text>
        Paste
      </Text>
      <Keyboard>
        ⌘V
      </Keyboard>
    </Item>
  </Menu>
</MenuTrigger>

Unavailable Items#

ContextualHelpTrigger disables a menu item's action and replaces it with a popover with information on why the item is unavailable and may link users to more information elsewhere.

The ContextualHelpTrigger accepts exactly two children: the Item which triggers opening of the Dialog and the Dialog itself. The trigger must be the first child passed into the ContextualHelpTrigger and should be an Item. Similar to ContextualHelp, the layout of the Dialog is very deliberate. See ContextualHelp for further explanation.

By default, a ContextualHelpTrigger's Dialog is opened by hovering, pressing the trigger element or activating it via the Space, Enter, or Right Arrow keys. Hovering another item or pressing the Esc key will close the Dialog and leave the Menu open.

Setting the isUnavailable prop on the ContextualHelpTrigger makes the menu item unavailable and enables the Dialog with contextual help, allowing for programmatic control.

Note that the Menu's onAction and onSelectionChange callbacks will not fire for items made unavailable by a ContextualHelpTrigger.

The example below illustrates how one would setup a Menu to use ContextualHelpTrigger.

import {Content, Dialog, Heading} from '@adobe/react-spectrum';
import {ContextualHelpTrigger} from '@react-spectrum/menu';

<MenuTrigger>
  <ActionButton>Edit</ActionButton>
  <Menu>
    <Item key="undo">Undo</Item>
    <Item key="redo">Redo</Item>
    <ContextualHelpTrigger isUnavailable>
      <Item key="cut">Cut</Item>
      <Dialog>
        <Heading>Cut</Heading>
        <Content>Please select text for 'Cut' to be enabled.</Content>
      </Dialog>
    </ContextualHelpTrigger>
    <ContextualHelpTrigger isUnavailable>
      <Item key="copy">Copy</Item>
      <Dialog>
        <Heading>Copy</Heading>
        <Content>Please select text for 'Copy' to be enabled.</Content>
      </Dialog>
    </ContextualHelpTrigger>
    <ContextualHelpTrigger>
      <Item key="paste">Paste</Item>
      <Dialog>
        <Heading>Paste</Heading>
        <Content>You have nothing to 'Paste'.</Content>
      </Dialog>
    </ContextualHelpTrigger>
  </Menu>
</MenuTrigger>

import {
  Content,
  Dialog,
  Heading
} from '@adobe/react-spectrum';
import {ContextualHelpTrigger} from '@react-spectrum/menu';

<MenuTrigger>
  <ActionButton>Edit</ActionButton>
  <Menu>
    <Item key="undo">Undo</Item>
    <Item key="redo">Redo</Item>
    <ContextualHelpTrigger isUnavailable>
      <Item key="cut">Cut</Item>
      <Dialog>
        <Heading>Cut</Heading>
        <Content>
          Please select text for 'Cut' to be enabled.
        </Content>
      </Dialog>
    </ContextualHelpTrigger>
    <ContextualHelpTrigger isUnavailable>
      <Item key="copy">Copy</Item>
      <Dialog>
        <Heading>Copy</Heading>
        <Content>
          Please select text for 'Copy' to be enabled.
        </Content>
      </Dialog>
    </ContextualHelpTrigger>
    <ContextualHelpTrigger>
      <Item key="paste">Paste</Item>
      <Dialog>
        <Heading>Paste</Heading>
        <Content>You have nothing to 'Paste'.</Content>
      </Dialog>
    </ContextualHelpTrigger>
  </Menu>
</MenuTrigger>

import {
  Content,
  Dialog,
  Heading
} from '@adobe/react-spectrum';
import {ContextualHelpTrigger} from '@react-spectrum/menu';

<MenuTrigger>
  <ActionButton>
    Edit
  </ActionButton>
  <Menu>
    <Item key="undo">
      Undo
    </Item>
    <Item key="redo">
      Redo
    </Item>
    <ContextualHelpTrigger
      isUnavailable
    >
      <Item key="cut">
        Cut
      </Item>
      <Dialog>
        <Heading>
          Cut
        </Heading>
        <Content>
          Please select
          text for
          'Cut' to be
          enabled.
        </Content>
      </Dialog>
    </ContextualHelpTrigger>
    <ContextualHelpTrigger
      isUnavailable
    >
      <Item key="copy">
        Copy
      </Item>
      <Dialog>
        <Heading>
          Copy
        </Heading>
        <Content>
          Please select
          text for
          'Copy' to be
          enabled.
        </Content>
      </Dialog>
    </ContextualHelpTrigger>
    <ContextualHelpTrigger>
      <Item key="paste">
        Paste
      </Item>
      <Dialog>
        <Heading>
          Paste
        </Heading>
        <Content>
          You have
          nothing to
          'Paste'.
        </Content>
      </Dialog>
    </ContextualHelpTrigger>
  </Menu>
</MenuTrigger>

Submenus#

Submenus can be created by wrapping an item and a menu in a SubmenuTrigger. The SubmenuTrigger accepts exactly two children: the Item which triggers opening of the submenu, and the Menu itself. Each submenu's Menu accepts its own set of menu props, allowing you to customize its user action and selection behavior.

Static#

import {SubmenuTrigger} from '@react-spectrum/menu';

<MenuTrigger>
  <ActionButton>Actions</ActionButton>
  <Menu onAction={(key) => alert(`Root menu ${key} action`)}>
    <Item key="Copy">Copy</Item>
    <Item key="Cut">Cut</Item>
    <Item key="Paste">Paste</Item>
    <SubmenuTrigger>
      <Item key="Share">Share</Item>
      <Menu onAction={(key) => alert(`Share menu ${key} action`)}>
        <Item key="Copy Link">Copy Link</Item>
        <SubmenuTrigger>
          <Item key="Email">Email</Item>
          <Menu onAction={(key) => alert(`Email menu ${key} action`)}>
            <Item key="Attachment">Email as Attachment</Item>
            <Item key="Link">Email as Link</Item>
          </Menu>
        </SubmenuTrigger>
        <Item key="SMS">SMS</Item>
      </Menu>
    </SubmenuTrigger>
    <Item key="Delete">Delete</Item>
  </Menu>
</MenuTrigger>

import {SubmenuTrigger} from '@react-spectrum/menu';

<MenuTrigger>
  <ActionButton>Actions</ActionButton>
  <Menu
    onAction={(key) => alert(`Root menu ${key} action`)}
  >
    <Item key="Copy">Copy</Item>
    <Item key="Cut">Cut</Item>
    <Item key="Paste">Paste</Item>
    <SubmenuTrigger>
      <Item key="Share">Share</Item>
      <Menu
        onAction={(key) =>
          alert(`Share menu ${key} action`)}
      >
        <Item key="Copy Link">Copy Link</Item>
        <SubmenuTrigger>
          <Item key="Email">Email</Item>
          <Menu
            onAction={(key) =>
              alert(`Email menu ${key} action`)}
          >
            <Item key="Attachment">
              Email as Attachment
            </Item>
            <Item key="Link">Email as Link</Item>
          </Menu>
        </SubmenuTrigger>
        <Item key="SMS">SMS</Item>
      </Menu>
    </SubmenuTrigger>
    <Item key="Delete">Delete</Item>
  </Menu>
</MenuTrigger>

import {SubmenuTrigger} from '@react-spectrum/menu';

<MenuTrigger>
  <ActionButton>
    Actions
  </ActionButton>
  <Menu
    onAction={(key) =>
      alert(
        `Root menu ${key} action`
      )}
  >
    <Item key="Copy">
      Copy
    </Item>
    <Item key="Cut">
      Cut
    </Item>
    <Item key="Paste">
      Paste
    </Item>
    <SubmenuTrigger>
      <Item key="Share">
        Share
      </Item>
      <Menu
        onAction={(
          key
        ) =>
          alert(
            `Share menu ${key} action`
          )}
      >
        <Item key="Copy Link">
          Copy Link
        </Item>
        <SubmenuTrigger>
          <Item key="Email">
            Email
          </Item>
          <Menu
            onAction={(
              key
            ) =>
              alert(
                `Email menu ${key} action`
              )}
          >
            <Item key="Attachment">
              Email as
              Attachment
            </Item>
            <Item key="Link">
              Email as
              Link
            </Item>
          </Menu>
        </SubmenuTrigger>
        <Item key="SMS">
          SMS
        </Item>
      </Menu>
    </SubmenuTrigger>
    <Item key="Delete">
      Delete
    </Item>
  </Menu>
</MenuTrigger>

Dynamic#

You can define a recursive function to render the nested menu items dynamically.

import {SubmenuTrigger} from '@react-spectrum/menu';

let items = [
  { name: 'Copy' },
  { name: 'Cut' },
  { name: 'Paste' },
  {
    name: 'Share',
    children: [
      { name: 'Copy Link' },
      {
        name: 'Email',
        children: [
          { name: 'Email as Attachment' },
          { name: 'Email as Link' }
        ]
      },
      { name: 'SMS' }
    ]
  },
  { name: 'Delete' }
];

<MenuTrigger>
  <ActionButton>Actions</ActionButton>
  <Menu items={items}>
    {function renderSubmenu(item) {
      if (item.children) {
        return (
          <SubmenuTrigger>
            <Item key={item.name}>{item.name}</Item>
            <Menu items={item.children}>
              {(item) => renderSubmenu(item)}
            </Menu>
          </SubmenuTrigger>
        );
      } else {
        return <Item key={item.name}>{item.name}</Item>;
      }
    }}
  </Menu>
</MenuTrigger>

import {SubmenuTrigger} from '@react-spectrum/menu';

let items = [
  { name: 'Copy' },
  { name: 'Cut' },
  { name: 'Paste' },
  {
    name: 'Share',
    children: [
      { name: 'Copy Link' },
      {
        name: 'Email',
        children: [
          { name: 'Email as Attachment' },
          { name: 'Email as Link' }
        ]
      },
      { name: 'SMS' }
    ]
  },
  { name: 'Delete' }
];

<MenuTrigger>
  <ActionButton>Actions</ActionButton>
  <Menu items={items}>
    {function renderSubmenu(item) {
      if (item.children) {
        return (
          <SubmenuTrigger>
            <Item key={item.name}>{item.name}</Item>
            <Menu items={item.children}>
              {(item) => renderSubmenu(item)}
            </Menu>
          </SubmenuTrigger>
        );
      } else {
        return <Item key={item.name}>{item.name}</Item>;
      }
    }}
  </Menu>
</MenuTrigger>

import {SubmenuTrigger} from '@react-spectrum/menu';

let items = [
  { name: 'Copy' },
  { name: 'Cut' },
  { name: 'Paste' },
  {
    name: 'Share',
    children: [
      {
        name: 'Copy Link'
      },
      {
        name: 'Email',
        children: [
          {
            name:
              'Email as Attachment'
          },
          {
            name:
              'Email as Link'
          }
        ]
      },
      { name: 'SMS' }
    ]
  },
  { name: 'Delete' }
];

<MenuTrigger>
  <ActionButton>
    Actions
  </ActionButton>
  <Menu items={items}>
    {function renderSubmenu(
      item
    ) {
      if (
        item.children
      ) {
        return (
          <SubmenuTrigger>
            <Item
              key={item
                .name}
            >
              {item
                .name}
            </Item>
            <Menu
              items={item
                .children}
            >
              {(
                item
              ) =>
                renderSubmenu(
                  item
                )}
            </Menu>
          </SubmenuTrigger>
        );
      } else {
        return (
          <Item
            key={item
              .name}
          >
            {item.name}
          </Item>
        );
      }
    }}
  </Menu>
</MenuTrigger>

Props#

Name	Type	Description
`children`	`CollectionChildren<object>`	The contents of the collection.
`autoFocus`	`boolean \| FocusStrategy`	Where the focus should be set.
`shouldFocusWrap`	`boolean`	Whether keyboard navigation is circular.
`items`	`Iterable<object>`	Item objects in the collection.
`disabledKeys`	`Iterable<Key>`	The item keys that are disabled. These items cannot be selected, focused, or otherwise interacted with.
`selectionMode`	`SelectionMode`	The type of selection that is allowed in the collection.
`disallowEmptySelection`	`boolean`	Whether the collection allows empty selection.
`selectedKeys`	`'all' \| Iterable<Key>`	The currently selected keys in the collection (controlled).
`defaultSelectedKeys`	`'all' \| Iterable<Key>`	The initial selected keys in the collection (uncontrolled).

Events

Name	Type	Description
`onAction`	`( (key: Key )) => void`	Handler that is called when an item is selected.
`onClose`	`() => void`	Handler that is called when the menu should close after selecting an item.
`onSelectionChange`	`( (keys: Selection )) => void`	Handler that is called when the selection changes.

Layout

Name	Type	Description
`flex`	`Responsive<string \| number \| boolean>`	When used in a flex layout, specifies how the element will grow or shrink to fit the space available. See MDN.
`flexGrow`	`Responsive<number>`	When used in a flex layout, specifies how the element will grow to fit the space available. See MDN.
`flexShrink`	`Responsive<number>`	When used in a flex layout, specifies how the element will shrink to fit the space available. See MDN.
`flexBasis`	`Responsive<number \| string>`	When used in a flex layout, specifies the initial main size of the element. See MDN.
`alignSelf`	`Responsive<'auto' \| 'normal' \| 'start' \| 'end' \| 'center' \| 'flex-start' \| 'flex-end' \| 'self-start' \| 'self-end' \| 'stretch'>`	Overrides the `alignItems` property of a flex or grid container. See MDN.
`justifySelf`	`Responsive<'auto' \| 'normal' \| 'start' \| 'end' \| 'flex-start' \| 'flex-end' \| 'self-start' \| 'self-end' \| 'center' \| 'left' \| 'right' \| 'stretch'>`	Specifies how the element is justified inside a flex or grid container. See MDN.
`order`	`Responsive<number>`	The layout order for the element within a flex or grid container. See MDN.
`gridArea`	`Responsive<string>`	When used in a grid layout, specifies the named grid area that the element should be placed in within the grid. See MDN.
`gridColumn`	`Responsive<string>`	When used in a grid layout, specifies the column the element should be placed in within the grid. See MDN.
`gridRow`	`Responsive<string>`	When used in a grid layout, specifies the row the element should be placed in within the grid. See MDN.
`gridColumnStart`	`Responsive<string>`	When used in a grid layout, specifies the starting column to span within the grid. See MDN.
`gridColumnEnd`	`Responsive<string>`	When used in a grid layout, specifies the ending column to span within the grid. See MDN.
`gridRowStart`	`Responsive<string>`	When used in a grid layout, specifies the starting row to span within the grid. See MDN.
`gridRowEnd`	`Responsive<string>`	When used in a grid layout, specifies the ending row to span within the grid. See MDN.

Spacing

Name	Type	Description
`margin`	`Responsive<DimensionValue>`	The margin for all four sides of the element. See MDN.
`marginTop`	`Responsive<DimensionValue>`	The margin for the top side of the element. See MDN.
`marginBottom`	`Responsive<DimensionValue>`	The margin for the bottom side of the element. See MDN.
`marginStart`	`Responsive<DimensionValue>`	The margin for the logical start side of the element, depending on layout direction. See MDN.
`marginEnd`	`Responsive<DimensionValue>`	The margin for the logical end side of an element, depending on layout direction. See MDN.
`marginX`	`Responsive<DimensionValue>`	The margin for both the left and right sides of the element. See MDN.
`marginY`	`Responsive<DimensionValue>`	The margin for both the top and bottom sides of the element. See MDN.

Sizing

Name	Type	Description
`width`	`Responsive<DimensionValue>`	The width of the element. See MDN.
`minWidth`	`Responsive<DimensionValue>`	The minimum width of the element. See MDN.
`maxWidth`	`Responsive<DimensionValue>`	The maximum width of the element. See MDN.
`height`	`Responsive<DimensionValue>`	The height of the element. See MDN.
`minHeight`	`Responsive<DimensionValue>`	The minimum height of the element. See MDN.
`maxHeight`	`Responsive<DimensionValue>`	The maximum height of the element. See MDN.

Positioning

Name	Type	Description
`position`	`Responsive<'static' \| 'relative' \| 'absolute' \| 'fixed' \| 'sticky'>`	Specifies how the element is positioned. See MDN.
`top`	`Responsive<DimensionValue>`	The top position for the element. See MDN.
`bottom`	`Responsive<DimensionValue>`	The bottom position for the element. See MDN.
`left`	`Responsive<DimensionValue>`	The left position for the element. See MDN. Consider using `start` instead for RTL support.
`right`	`Responsive<DimensionValue>`	The right position for the element. See MDN. Consider using `start` instead for RTL support.
`start`	`Responsive<DimensionValue>`	The logical start position for the element, depending on layout direction. See MDN.
`end`	`Responsive<DimensionValue>`	The logical end position for the element, depending on layout direction. See MDN.
`zIndex`	`Responsive<number>`	The stacking order for the element. See MDN.
`isHidden`	`Responsive<boolean>`	Hides the element.

Accessibility

Name	Type	Description
`id`	`string`	The element's unique identifier. See MDN.
`aria-label`	`string`	Defines a string value that labels the current element.
`aria-labelledby`	`string`	Identifies the element (or elements) that labels the current element.
`aria-describedby`	`string`	Identifies the element (or elements) that describes the object.
`aria-details`	`string`	Identifies the element (or elements) that provide a detailed, extended description for the object.

Advanced

Name	Type	Description
`UNSAFE_className`	`string`	Sets the CSS className for the element. Only use as a last resort. Use style props instead.
`UNSAFE_style`	`CSSProperties`	Sets inline style for the element. Only use as a last resort. Use style props instead.

ContextualHelpTrigger Props#

Name	Type	Description
`children`	`[ ReactElement, ReactElement ]`	The triggering Item and the Dialog, respectively.
`isUnavailable`	`boolean`	Whether the menu item is currently unavailable.

SubmenuTrigger Props#

Name	Type	Description
`children`	`ReactElement<any>[]`	The contents of the SubmenuTrigger - an Item and a Menu.

Visual Options#

Autofocus#

Applying autoFocus to the Menu of the MenuTrigger sets focus to a Menu Item within the Menu upon opening.

Disabled#

<MenuTrigger>
  <ActionButton>
    Filter
  </ActionButton>
  <Menu
    items={[
      {name: 'tiff', id: 'a1b2c3'},
      {name: 'png', id: 'g5h1j9'},
      {name: 'jpg', id: 'p8k3i4'},
      {name: 'PDF', id: 'j7i3a0'}
    ]}
    disabledKeys={['a1b2c3', 'p8k3i4']}>
    {item => <Item>{item.name}</Item>}
  </Menu>
</MenuTrigger>

<MenuTrigger>
  <ActionButton>
    Filter
  </ActionButton>
  <Menu
    items={[
      {name: 'tiff', id: 'a1b2c3'},
      {name: 'png', id: 'g5h1j9'},
      {name: 'jpg', id: 'p8k3i4'},
      {name: 'PDF', id: 'j7i3a0'}
    ]}
    disabledKeys={['a1b2c3', 'p8k3i4']}>
    {item => <Item>{item.name}</Item>}
  </Menu>
</MenuTrigger>

<MenuTrigger>
  <ActionButton>
    Filter
  </ActionButton>
  <Menu
    items={[
      {
        name: 'tiff',
        id: 'a1b2c3'
      },
      {
        name: 'png',
        id: 'g5h1j9'
      },
      {
        name: 'jpg',
        id: 'p8k3i4'
      },
      {
        name: 'PDF',
        id: 'j7i3a0'
      }
    ]}
    disabledKeys={[
      'a1b2c3',
      'p8k3i4'
    ]}
  >
    {(item) => (
      <Item>
        {item.name}
      </Item>
    )}
  </Menu>
</MenuTrigger>

CollectionElement<T>
  | CollectionElement<T>[]
  | (
    (item: T
  )) => CollectionElement<T>

SectionElement<T> | ItemElement<T>

ReactElement<SectionProps<T>>

Name	Type	Description
`children`	`ItemElement<T> \| ItemElement<T>[] \| ItemRenderer<T>`	Static child items or a function to render children.
`title`	`ReactNode`	Rendered contents of the section, e.g. a header.
`aria-label`	`string`	An accessibility label for the section.
`items`	`Iterable<T>`	Item objects in the section.

ReactElement<ItemProps<T>>

Name	Type	Description
`children`	`ReactNode`	Rendered contents of the item or child items.
`title`	`ReactNode`	Rendered contents of the item if `children` contains child items.
`textValue`	`string`	A string representation of the item's contents, used for features like typeahead.
`aria-label`	`string`	An accessibility label for this item.
`childItems`	`Iterable<T>`	A list of child item objects. Used for dynamic collections.
`hasChildItems`	`boolean`	Whether this item has children, even if not loaded yet.
`href`	`Href`	A URL to link to. See MDN.
`hrefLang`	`string`	Hints at the human language of the linked URL. SeeMDN.
`target`	`HTMLAttributeAnchorTarget`	The target window for the link. See MDN.
`rel`	`string`	The relationship between the linked resource and the current page. See MDN.
`download`	`boolean \| string`	Causes the browser to download the linked URL. A string may be provided to suggest a file name. See MDN.
`ping`	`string`	A space-separated list of URLs to ping when the link is followed. See MDN.
`referrerPolicy`	`HTMLAttributeReferrerPolicy`	How much of the referrer to send when following the link. See MDN.
`routerOptions`	`RouterOptions`	Options for the configured client side router.

RouterConfig extends {href: any
} ? H : string

RouterConfig extends {routerOptions: any
} ? O : never

(
  (item: T
)) => ItemElement<T>

'first' | 'last'

'none'
  | 'single'
  | 'multiple'

'all' | Set<Key>

T | ResponsiveProp<T>

{base?: T,
S?: T,
M?: T,
L?: T,
[custom: string]: T | undefined
}

See the Styling docs for a visualization of these values.

'size-0'
  | 'size-10'
  | 'size-25'
  | 'size-40'
  | 'size-50'
  | 'size-65'
  | 'size-75'
  | 'size-85'
  | 'size-100'
  | 'size-115'
  | 'size-125'
  | 'size-130'
  | 'size-150'
  | 'size-160'
  | 'size-175'
  | 'size-200'
  | 'size-225'
  | 'size-250'
  | 'size-275'
  | 'size-300'
  | 'size-325'
  | 'size-350'
  | 'size-400'
  | 'size-450'
  | 'size-500'
  | 'size-550'
  | 'size-600'
  | 'size-675'
  | 'size-700'
  | 'size-800'
  | 'size-900'
  | 'size-1000'
  | 'size-1200'
  | 'size-1250'
  | 'size-1600'
  | 'size-1700'
  | 'size-2000'
  | 'size-2400'
  | 'size-3000'
  | 'size-3400'
  | 'size-3600'
  | 'size-4600'
  | 'size-5000'
  | 'size-6000'
  | 'static-size-0'
  | 'static-size-10'
  | 'static-size-25'
  | 'static-size-50'
  | 'static-size-40'
  | 'static-size-65'
  | 'static-size-100'
  | 'static-size-115'
  | 'static-size-125'
  | 'static-size-130'
  | 'static-size-150'
  | 'static-size-160'
  | 'static-size-175'
  | 'static-size-200'
  | 'static-size-225'
  | 'static-size-250'
  | 'static-size-300'
  | 'static-size-400'
  | 'static-size-450'
  | 'static-size-500'
  | 'static-size-550'
  | 'static-size-600'
  | 'static-size-700'
  | 'static-size-800'
  | 'static-size-900'
  | 'static-size-1000'
  | 'static-size-1200'
  | 'static-size-1700'
  | 'static-size-2400'
  | 'static-size-2600'
  | 'static-size-3400'
  | 'static-size-3600'
  | 'static-size-4600'
  | 'static-size-5000'
  | 'static-size-6000'
  | 'single-line-height'
  | 'single-line-width'
  | string
    &  & {}
  | number