ActionMenu

ActionMenu combines an ActionButton with a Menu for simple "more actions" use cases.

installyarn add @adobe/react-spectrum
version3.6.4
usageimport {ActionMenu} from '@adobe/react-spectrum'

Example#


<ActionMenu>
  <Item>Cut</Item>
  <Item>Copy</Item>
  <Item>Paste</Item>
</ActionMenu>
<ActionMenu>
  <Item>Cut</Item>
  <Item>Copy</Item>
  <Item>Paste</Item>
</ActionMenu>
<ActionMenu>
  <Item>Cut</Item>
  <Item>Copy</Item>
  <Item>Paste</Item>
</ActionMenu>

Content#


ActionMenu follows the Collection Components API, accepting both static and dynamic collections. See Menu for further explanation.

function Example() {
  let actionMenuItems = [
    {name: 'Cut'},
    {name: 'Copy'},
    {name: 'Paste'},
    {name: 'Select All'}
  ];

  return (
    <ActionMenu items={actionMenuItems}>
      {item => <Item key={item.name}>{item.name}</Item>}
    </ActionMenu>
  );
}
function Example() {
  let actionMenuItems = [
    {name: 'Cut'},
    {name: 'Copy'},
    {name: 'Paste'},
    {name: 'Select All'}
  ];

  return (
    <ActionMenu items={actionMenuItems}>
      {item => <Item key={item.name}>{item.name}</Item>}
    </ActionMenu>
  );
}
function Example() {
  let actionMenuItems = [
    { name: 'Cut' },
    { name: 'Copy' },
    { name: 'Paste' },
    {
      name: 'Select All'
    }
  ];

  return (
    <ActionMenu
      items={actionMenuItems}
    >
      {(item) => (
        <Item
          key={item.name}
        >
          {item.name}
        </Item>
      )}
    </ActionMenu>
  );
}

Trays#

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

Internationalization#

In order to internationalize an ActionMenu, 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 ActionMenu is flipped.

Events#


ActionMenu supports the onAction prop, which is called when the user presses a menu item. It receives the key of the item as an argument, which can be used to perform the relevant action.

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

  return (
    <>
      <ActionMenu onAction={setAction}>
        <Item key="cut">Cut</Item>
        <Item key="copy">Copy</Item>
        <Item key="paste">Paste</Item>
      </ActionMenu>
      <p>Action: {action}</p>
    </>
  );
}
function Example() {
  let [action, setAction] = React.useState('');

  return (
    <>
      <ActionMenu onAction={setAction}>
        <Item key="cut">Cut</Item>
        <Item key="copy">Copy</Item>
        <Item key="paste">Paste</Item>
      </ActionMenu>
      <p>Action: {action}</p>
    </>
  );
}
function Example() {
  let [
    action,
    setAction
  ] = React.useState('');

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

Sections#


ActionMenu 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#

<ActionMenu>
  <Section title="File">
    <Item key="new">New</Item>
    <Item key="open">Open...</Item>
  </Section>
  <Section title="Save">
    <Item key="save">Save</Item>
    <Item key="saveAs">Save As...</Item>
    <Item key="saveAll">Save All</Item>
  </Section>
</ActionMenu>
<ActionMenu>
  <Section title="File">
    <Item key="new">New</Item>
    <Item key="open">Open...</Item>
  </Section>
  <Section title="Save">
    <Item key="save">Save</Item>
    <Item key="saveAs">Save As...</Item>
    <Item key="saveAll">Save All</Item>
  </Section>
</ActionMenu>
<ActionMenu>
  <Section title="File">
    <Item key="new">
      New
    </Item>
    <Item key="open">
      Open...
    </Item>
  </Section>
  <Section title="Save">
    <Item key="save">
      Save
    </Item>
    <Item key="saveAs">
      Save As...
    </Item>
    <Item key="saveAll">
      Save All
    </Item>
  </Section>
</ActionMenu>

Dynamic Items#

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

function Example() {
  let openWindows = [
    {
      name: 'Reversion',
      id: 'reversion',
      children: [
        {id: 'undo', name: 'Undo'},
        {id: 'redo', name: 'Redo'}
      ]
    },
    {
      name: 'Clipboard',
      id: 'clipboard',
      children: [
        {id: 'cut', name: 'Cut'},
        {id: 'copy', name: 'Copy'},
        {id: 'paste', name: 'Paste'}
      ]
    }
  ];

  return (
    <ActionMenu
      items={openWindows}>
      {item => (
        <Section items={item.children} title={item.name}>
          {item => <Item>{item.name}</Item>}
        </Section>
      )}
    </ActionMenu>
  );
}
function Example() {
  let openWindows = [
    {
      name: 'Reversion',
      id: 'reversion',
      children: [
        {id: 'undo', name: 'Undo'},
        {id: 'redo', name: 'Redo'}
      ]
    },
    {
      name: 'Clipboard',
      id: 'clipboard',
      children: [
        {id: 'cut', name: 'Cut'},
        {id: 'copy', name: 'Copy'},
        {id: 'paste', name: 'Paste'}
      ]
    }
  ];

  return (
    <ActionMenu
      items={openWindows}>
      {item => (
        <Section items={item.children} title={item.name}>
          {item => <Item>{item.name}</Item>}
        </Section>
      )}
    </ActionMenu>
  );
}
function Example() {
  let openWindows = [
    {
      name: 'Reversion',
      id: 'reversion',
      children: [
        {
          id: 'undo',
          name: 'Undo'
        },
        {
          id: 'redo',
          name: 'Redo'
        }
      ]
    },
    {
      name: 'Clipboard',
      id: 'clipboard',
      children: [
        {
          id: 'cut',
          name: 'Cut'
        },
        {
          id: 'copy',
          name: 'Copy'
        },
        {
          id: 'paste',
          name: 'Paste'
        }
      ]
    }
  ];

  return (
    <ActionMenu
      items={openWindows}
    >
      {(item) => (
        <Section
          items={item
            .children}
          title={item
            .name}
        >
          {(item) => (
            <Item>
              {item.name}
            </Item>
          )}
        </Section>
      )}
    </ActionMenu>
  );
}

Accessibility#

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

Complex Menu Items#


Items within ActionMenu 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';

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

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

<ActionMenu>
  <Item
    key="cut"
    textValue="cut"
  >
    <Cut size="S" />
    <Text>Cut</Text>
    <Keyboard>
      ⌘X
    </Keyboard>
  </Item>
  <Item
    key="copy"
    textValue="copy"
  >
    <Copy size="S" />
    <Text>Copy</Text>
    <Keyboard>
      ⌘C
    </Keyboard>
  </Item>
  <Item
    key="paste"
    textValue="paste"
  >
    <Paste size="S" />
    <Text>Paste</Text>
    <Keyboard>
      ⌘V
    </Keyboard>
  </Item>
</ActionMenu>

Props#


NameTypeDefaultDescription
childrenCollectionChildren<object>The contents of the collection.
alignAlignment'start'Alignment of the menu relative to the trigger.
direction'bottom''top''left''right''start''end''bottom'Where the Menu opens relative to its trigger.
shouldFlipbooleantrueWhether the menu should automatically flip direction when space is limited.
isDisabledbooleanWhether the button is disabled.
isQuietbooleanWhether the button should be displayed with a quiet style.
autoFocusbooleanWhether the element should receive focus on render.
itemsIterable<object>Item objects in the collection.
disabledKeysIterable<Key>The item keys that are disabled. These items cannot be selected, focused, or otherwise interacted with.
triggerMenuTriggerType'press'How the menu is triggered.
closeOnSelectbooleantrueWhether the Menu closes when a selection is made.
isOpenbooleanWhether the overlay is open by default (controlled).
defaultOpenbooleanWhether the overlay is open by default (uncontrolled).
Events
NameTypeDefaultDescription
onAction( (key: Key )) => voidHandler that is called when an item is selected.
onOpenChange( (isOpen: boolean )) => voidHandler that is called when the overlay's open state changes.
Layout
NameTypeDefaultDescription
flexResponsive<stringnumberboolean>When used in a flex layout, specifies how the element will grow or shrink to fit the space available. See MDN.
flexGrowResponsive<number>When used in a flex layout, specifies how the element will grow to fit the space available. See MDN.
flexShrinkResponsive<number>When used in a flex layout, specifies how the element will shrink to fit the space available. See MDN.
flexBasisResponsive<numberstring>When used in a flex layout, specifies the initial main size of the element. See MDN.
alignSelfResponsive<'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.
justifySelfResponsive<'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.
orderResponsive<number>The layout order for the element within a flex or grid container. See MDN.
gridAreaResponsive<string>When used in a grid layout, specifies the named grid area that the element should be placed in within the grid. See MDN.
gridColumnResponsive<string>When used in a grid layout, specifies the column the element should be placed in within the grid. See MDN.
gridRowResponsive<string>When used in a grid layout, specifies the row the element should be placed in within the grid. See MDN.
gridColumnStartResponsive<string>When used in a grid layout, specifies the starting column to span within the grid. See MDN.
gridColumnEndResponsive<string>When used in a grid layout, specifies the ending column to span within the grid. See MDN.
gridRowStartResponsive<string>When used in a grid layout, specifies the starting row to span within the grid. See MDN.
gridRowEndResponsive<string>When used in a grid layout, specifies the ending row to span within the grid. See MDN.
Spacing
NameTypeDefaultDescription
marginResponsive<DimensionValue>The margin for all four sides of the element. See MDN.
marginTopResponsive<DimensionValue>The margin for the top side of the element. See MDN.
marginBottomResponsive<DimensionValue>The margin for the bottom side of the element. See MDN.
marginStartResponsive<DimensionValue>The margin for the logical start side of the element, depending on layout direction. See MDN.
marginEndResponsive<DimensionValue>The margin for the logical end side of an element, depending on layout direction. See MDN.
marginXResponsive<DimensionValue>The margin for both the left and right sides of the element. See MDN.
marginYResponsive<DimensionValue>The margin for both the top and bottom sides of the element. See MDN.
Sizing
NameTypeDefaultDescription
widthResponsive<DimensionValue>The width of the element. See MDN.
minWidthResponsive<DimensionValue>The minimum width of the element. See MDN.
maxWidthResponsive<DimensionValue>The maximum width of the element. See MDN.
heightResponsive<DimensionValue>The height of the element. See MDN.
minHeightResponsive<DimensionValue>The minimum height of the element. See MDN.
maxHeightResponsive<DimensionValue>The maximum height of the element. See MDN.
Positioning
NameTypeDefaultDescription
positionResponsive<'static''relative''absolute''fixed''sticky'>Specifies how the element is positioned. See MDN.
topResponsive<DimensionValue>The top position for the element. See MDN.
bottomResponsive<DimensionValue>The bottom position for the element. See MDN.
leftResponsive<DimensionValue>The left position for the element. See MDN. Consider using start instead for RTL support.
rightResponsive<DimensionValue>The right position for the element. See MDN. Consider using start instead for RTL support.
startResponsive<DimensionValue>The logical start position for the element, depending on layout direction. See MDN.
endResponsive<DimensionValue>The logical end position for the element, depending on layout direction. See MDN.
zIndexResponsive<number>The stacking order for the element. See MDN.
isHiddenResponsive<boolean>Hides the element.
Accessibility
NameTypeDefaultDescription
idstringThe element's unique identifier. See MDN.
aria-labelstringDefines a string value that labels the current element.
aria-labelledbystringIdentifies the element (or elements) that labels the current element.
aria-describedbystringIdentifies the element (or elements) that describes the object.
aria-detailsstringIdentifies the element (or elements) that provide a detailed, extended description for the object.
Advanced
NameTypeDefaultDescription
UNSAFE_classNamestringSets the CSS className for the element. Only use as a last resort. Use style props instead.
UNSAFE_styleCSSPropertiesSets inline style for the element. Only use as a last resort. Use style props instead.

Visual options#


Quiet#

View guidelines

<ActionMenu
  isQuiet
  items={[
    {name: 'Cut', id: 'cut'},
    {name: 'Copy', id: 'copy'},
    {name: 'Paste', id: 'paste'}
  ]}>
  {item => <Item>{item.name}</Item>}
</ActionMenu>
<ActionMenu
  isQuiet
  items={[
    {name: 'Cut', id: 'cut'},
    {name: 'Copy', id: 'copy'},
    {name: 'Paste', id: 'paste'}
  ]}>
  {item => <Item>{item.name}</Item>}
</ActionMenu>
<ActionMenu
  isQuiet
  items={[
    {
      name: 'Cut',
      id: 'cut'
    },
    {
      name: 'Copy',
      id: 'copy'
    },
    {
      name: 'Paste',
      id: 'paste'
    }
  ]}
>
  {(item) => (
    <Item>
      {item.name}
    </Item>
  )}
</ActionMenu>

Autofocus#

Applying autoFocus to the ActionMenu sets focus to the ActionMenu trigger.

Disabled#

<ActionMenu
  items={[
    {name: 'Undo', id: 'undo'},
    {name: 'Redo', id: 'redo'},
    {name: 'Cut', id: 'cut'},
    {name: 'Copy', id: 'copy'},
    {name: 'Paste', id: 'paste'}
  ]}
  isDisabled>
  {item => <Item>{item.name}</Item>}
</ActionMenu>
<ActionMenu
  items={[
    {name: 'Undo', id: 'undo'},
    {name: 'Redo', id: 'redo'},
    {name: 'Cut', id: 'cut'},
    {name: 'Copy', id: 'copy'},
    {name: 'Paste', id: 'paste'}
  ]}
  isDisabled>
  {item => <Item>{item.name}</Item>}
</ActionMenu>
<ActionMenu
  items={[
    {
      name: 'Undo',
      id: 'undo'
    },
    {
      name: 'Redo',
      id: 'redo'
    },
    {
      name: 'Cut',
      id: 'cut'
    },
    {
      name: 'Copy',
      id: 'copy'
    },
    {
      name: 'Paste',
      id: 'paste'
    }
  ]}
  isDisabled
>
  {(item) => (
    <Item>
      {item.name}
    </Item>
  )}
</ActionMenu>

Disabled items#

<ActionMenu
  items={[
    {name: 'Undo', id: 'undo'},
    {name: 'Redo', id: 'redo'},
    {name: 'Cut', id: 'cut'},
    {name: 'Copy', id: 'copy'},
    {name: 'Paste', id: 'paste'}
  ]}
  disabledKeys={['redo', 'paste']}>
  {item => <Item>{item.name}</Item>}
</ActionMenu>
<ActionMenu
  items={[
    {name: 'Undo', id: 'undo'},
    {name: 'Redo', id: 'redo'},
    {name: 'Cut', id: 'cut'},
    {name: 'Copy', id: 'copy'},
    {name: 'Paste', id: 'paste'}
  ]}
  disabledKeys={['redo', 'paste']}>
  {item => <Item>{item.name}</Item>}
</ActionMenu>
<ActionMenu
  items={[
    {
      name: 'Undo',
      id: 'undo'
    },
    {
      name: 'Redo',
      id: 'redo'
    },
    {
      name: 'Cut',
      id: 'cut'
    },
    {
      name: 'Copy',
      id: 'copy'
    },
    {
      name: 'Paste',
      id: 'paste'
    }
  ]}
  disabledKeys={[
    'redo',
    'paste'
  ]}
>
  {(item) => (
    <Item>
      {item.name}
    </Item>
  )}
</ActionMenu>

Align and direction#

View guidelines

The align prop aligns the ActionMenu menu relative to the trigger and the direction prop controls the direction the ActionMenu will render.

<Flex gap="size-100">
  <ActionMenu align="start">
    <Item key="cut">Cut</Item>
    <Item key="copy">Copy</Item>
    <Item key="paste">Paste</Item>
  </ActionMenu>
  <ActionMenu align="end" direction="top" shouldFlip={false}>
    <Item key="cut">Cut</Item>
    <Item key="copy">Copy</Item>
    <Item key="paste">Paste</Item>
  </ActionMenu>
  <ActionMenu direction="start" align="start">
    <Item key="cut">Cut</Item>
    <Item key="copy">Copy</Item>
    <Item key="paste">Paste</Item>
  </ActionMenu>
  <ActionMenu direction="end" align="end">
    <Item key="cut">Cut</Item>
    <Item key="copy">Copy</Item>
    <Item key="paste">Paste</Item>
  </ActionMenu>
</Flex>
<Flex gap="size-100">
  <ActionMenu align="start">
    <Item key="cut">Cut</Item>
    <Item key="copy">Copy</Item>
    <Item key="paste">Paste</Item>
  </ActionMenu>
  <ActionMenu
    align="end"
    direction="top"
    shouldFlip={false}
  >
    <Item key="cut">Cut</Item>
    <Item key="copy">Copy</Item>
    <Item key="paste">Paste</Item>
  </ActionMenu>
  <ActionMenu direction="start" align="start">
    <Item key="cut">Cut</Item>
    <Item key="copy">Copy</Item>
    <Item key="paste">Paste</Item>
  </ActionMenu>
  <ActionMenu direction="end" align="end">
    <Item key="cut">Cut</Item>
    <Item key="copy">Copy</Item>
    <Item key="paste">Paste</Item>
  </ActionMenu>
</Flex>
<Flex gap="size-100">
  <ActionMenu align="start">
    <Item key="cut">
      Cut
    </Item>
    <Item key="copy">
      Copy
    </Item>
    <Item key="paste">
      Paste
    </Item>
  </ActionMenu>
  <ActionMenu
    align="end"
    direction="top"
    shouldFlip={false}
  >
    <Item key="cut">
      Cut
    </Item>
    <Item key="copy">
      Copy
    </Item>
    <Item key="paste">
      Paste
    </Item>
  </ActionMenu>
  <ActionMenu
    direction="start"
    align="start"
  >
    <Item key="cut">
      Cut
    </Item>
    <Item key="copy">
      Copy
    </Item>
    <Item key="paste">
      Paste
    </Item>
  </ActionMenu>
  <ActionMenu
    direction="end"
    align="end"
  >
    <Item key="cut">
      Cut
    </Item>
    <Item key="copy">
      Copy
    </Item>
    <Item key="paste">
      Paste
    </Item>
  </ActionMenu>
</Flex>

Flipping#

By default, the ActionMenu menu flips direction automatically upon opening when space is limited. To change this, set the shouldFlip prop to false. Try scrolling the viewport close to the edge of the trigger in the example to see this in action.

<Flex gap="size-100">
  <ActionMenu shouldFlip>
    <Item key="cut">Cut</Item>
    <Item key="copy">Copy</Item>
    <Item key="paste">Paste</Item>
  </ActionMenu>
  <ActionMenu shouldFlip={false}>
    <Item key="cut">Cut</Item>
    <Item key="copy">Copy</Item>
    <Item key="paste">Paste</Item>
  </ActionMenu>
</Flex>
<Flex gap="size-100">
  <ActionMenu shouldFlip>
    <Item key="cut">Cut</Item>
    <Item key="copy">Copy</Item>
    <Item key="paste">Paste</Item>
  </ActionMenu>
  <ActionMenu shouldFlip={false}>
    <Item key="cut">Cut</Item>
    <Item key="copy">Copy</Item>
    <Item key="paste">Paste</Item>
  </ActionMenu>
</Flex>
<Flex gap="size-100">
  <ActionMenu
    shouldFlip
  >
    <Item key="cut">
      Cut
    </Item>
    <Item key="copy">
      Copy
    </Item>
    <Item key="paste">
      Paste
    </Item>
  </ActionMenu>
  <ActionMenu
    shouldFlip={false}
  >
    <Item key="cut">
      Cut
    </Item>
    <Item key="copy">
      Copy
    </Item>
    <Item key="paste">
      Paste
    </Item>
  </ActionMenu>
</Flex>

Open#

The isOpen and defaultOpen props on the ActionMenu control whether the menu is open by default. They apply controlled and uncontrolled behavior on the Menu respectively.

function Example() {
  let [open, setOpen] = React.useState(false);

  return (
    <ActionMenu
      isOpen={open}
      onOpenChange={setOpen}>
      <Item key="cut">Cut</Item>
      <Item key="copy">Copy</Item>
      <Item key="paste">Paste</Item>
    </ActionMenu>
  );
}
function Example() {
  let [open, setOpen] = React.useState(false);

  return (
    <ActionMenu
      isOpen={open}
      onOpenChange={setOpen}>
      <Item key="cut">Cut</Item>
      <Item key="copy">Copy</Item>
      <Item key="paste">Paste</Item>
    </ActionMenu>
  );
}
function Example() {
  let [open, setOpen] =
    React.useState(
      false
    );

  return (
    <ActionMenu
      isOpen={open}
      onOpenChange={setOpen}
    >
      <Item key="cut">
        Cut
      </Item>
      <Item key="copy">
        Copy
      </Item>
      <Item key="paste">
        Paste
      </Item>
    </ActionMenu>
  );
}