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.

Component name

The MuiMenu name can be used for providing default props or style overrides at the theme level.

Props

Name	Type	Default	Description
anchorEl	HTML element | func		A HTML element, or a function that returns it. 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 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		Deprecated. Use the TransitionProps prop instead. Callback fired before the Menu enters.
onEntered	func		Deprecated. Use the TransitionProps prop instead. Callback fired when the Menu has entered.
onEntering	func		Deprecated. Use the TransitionProps prop instead. Callback fired when the Menu is entering.
onExit	func		Deprecated. Use the TransitionProps prop instead. Callback fired before the Menu exits.
onExited	func		Deprecated. Use the TransitionProps prop instead. Callback fired when the Menu has exited.
onExiting	func		Deprecated. Use the TransitionProps prop instead. 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	'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).

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 thanks to one of these customization points:

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

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

• App Bar
• Menus