Skip to content

Menu API

The API documentation of the Menu React component. Learn more about the props and the CSS customization points.

Import

import Menu from '@material-ui/core/Menu';
// or
import { Menu } from '@material-ui/core';

You can learn more about the difference by reading this guide.

Props

Name Type Default Description
anchorEl object
| func
The DOM element used to set the position of the menu.
autoFocus bool true If true (Default) will focus the [role="menu"] if no focusable child is found. Disabled children are not focusable. If you set this prop to false focus will be placed on the parent modal container. This has severe accessibility implications and should only be considered if you manage focus otherwise.
children node Menu contents, normally MenuItems.
classes object Override or extend the styles applied to the component. See CSS API below for more details.
disableAutoFocusItem bool false When opening the menu will not focus the active item but the [role="menu"] unless autoFocus is also set to false. Not using the default means not following WAI-ARIA authoring practices. Please be considerate about possible accessibility implications.
MenuListProps object {} Props applied to the MenuList element.
onClose func Callback fired when the component requests to be closed.

Signature:
function(event: object, reason: string) => void
event: The event source of the callback.
reason: Can be:"escapeKeyDown", "backdropClick", "tabKeyDown".
onEnter func Callback fired before the Menu enters.
onEntered func Callback fired when the Menu has entered.
onEntering func Callback fired when the Menu is entering.
onExit func Callback fired before the Menu exits.
onExited func Callback fired when the Menu has exited.
onExiting func Callback fired when the Menu is exiting.
open * bool If true, the menu is visible.
PopoverClasses object classes prop applied to the Popover element.
transitionDuration number
| { enter?: number, exit?: number }
| 'auto'
'auto' The length of the transition in ms, or 'auto'
variant 'menu'
| 'selectedMenu'
'selectedMenu' The variant to use. Use menu to prevent selected items from impacting the initial focus and the vertical alignment relative to the anchor element.

The ref is forwarded to the root element.

Any other props supplied will be provided to the root element (Popover).

CSS

  • Style sheet name: MuiMenu.
  • Style sheet details:
Rule name Global class Description
paper MuiMenu-paper Styles applied to the Paper component.
list MuiMenu-list Styles applied to the List component via MenuList.

You can override the style of the component thanks to one of these customization points:

If that's not sufficient, you can check the implementation of the component for more detail.

Inheritance

The props of the Popover component are also available. You can take advantage of this behavior to target nested components.

Demos