Skip to content

ActionMenu

An ActionMenu is an ActionList-based component for creating a menu of actions that expands through a trigger button.
  • Beta
  • Reviewed for accessibility


import {ActionMenu} from '@primer/react'

Examples

Minimal example

ActionMenu ships with ActionMenu.Button which is an accessible trigger for the overlay. It's recommended to compose ActionList with ActionMenu.Overlay

With a custom anchor

You can choose to have a different anchor for the Menu depending on the application's context.

With Groups

With selection

Use selectionVariant on ActionList to create a menu with single or multiple selection.

With External Anchor

To create an anchor outside of the menu, you need to switch to controlled mode for the menu and pass it as anchorRef to ActionMenu. Make sure you add aria-expanded and aria-haspopup to the external anchor:

With Overlay Props

To create an anchor outside of the menu, you need to switch to controlled mode for the menu and pass it as anchorRef to ActionMenu:

Props

ActionMenu

NameTypeDefaultDescription
children Required
React.ReactElement[]
Recommended: `ActionMenu.Button` or `ActionMenu.Anchor` with `ActionMenu.Overlay`
open
boolean
falseIf defined, will control the open/closed state of the overlay. Must be used in conjuction with `onOpenChange`.
onOpenChange
(open: boolean) => void
If defined, will control the open/closed state of the overlay. Must be used in conjuction with `open`.
anchorRef
React.RefObject<HTMLElement>
Useful for defining an external anchor

ActionMenu.Button

NameTypeDefaultDescription
children Required
React.ReactElement
Additional props are passed to the <Button> element. See Button docs for a list of props accepted by the <Button> element.

ActionMenu.Anchor

NameTypeDefaultDescription
children Required
React.ReactElement
Accepts a single child element

ActionMenu.Overlay

NameTypeDefaultDescription
children Required
React.ReactNode
align
start | center | end
start
Additional props are passed to the <Overlay> element. See Overlay docs for a list of props accepted by the <Overlay> element.

Status

Alpha

  • Component props and basic example usage of the component are documented on primer.style/react.
  • Component does not have any unnecessary third-party dependencies.
  • Component can adapt to different themes.
  • Component can adapt to different screen sizes.
  • Component has robust unit test coverage (100% where achievable).
  • Component has visual regression coverage of its default and interactive states.
  • Component does not introduce any axe violations.
  • Component has been manually reviewed by the accessibility team and any resulting issues have been addressed.

Beta

  • Component is used in a production application.
  • Common usage examples are documented on primer.style/react.
  • Common usage examples are documented in storybook stories.
  • Component has been reviewed by a systems designer and any resulting issues have been addressed.
  • Component does not introduce any performance regressions.

Stable

  • Component API has been stable with no breaking changes for at least one month.
  • Feedback on API usability has been sought from developers using the component and any resulting issues have been addressed.
  • Component has corresponding design guidelines documented in the interface guidelines.
  • Component has corresponding Figma component in the Primer Web library.
  • Tooling (such as linters, codemods, etc.) exists to prevent further use of alternatives.

Further reading

Interface guidelines: Action List + Menu