Menu API

API documentation for the React Menu component. Learn about the available props, and the CSS API.

Import

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

You can learn about the difference by reading this guide on minimizing bundle size.

Component name

The name MuiMenu can be used when providing default props or style overrides in the theme.

Props

Name	Type	Default	Description
open^*	bool	false	If `true`, the component is shown.
anchorEl	HTML element \| func		An HTML element, or a function that returns one. It's 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 `MenuItem`s.
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"`.
PopoverClasses	object		`classes` prop applied to the `Popover` element.
transitionDuration	'auto' \| number \| { appear?: number, enter?: number, exit?: number }	'auto'	The length of the transition in `ms`, or 'auto'
TransitionProps	object	{}	Props applied to the transition element. By default, the element is based on this `Transition` component.
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).

Inheritance

While not explicitly documented above, the props of the Popover component are also available on Menu. You can take advantage of this to target nested components.

CSS

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 using one of these customization options:

With a rule name of the classes object prop.
With a global class name.
With a theme and an styleOverrides property.

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

Menu API

Import

Component name

Props

Inheritance

CSS

Demos