Skip to content
Edit this page

Menu API

API reference docs for the React Menu component. Learn about the props, CSS, and other APIs of this exported module.

Demos

For examples and details on the usage of this React component, visit the component demo pages:

Import

import Menu from '@mui/material/Menu';
// or
import { Menu } from '@mui/material';
Learn about the difference by reading this guide on minimizing bundle size.

Props

Props of the Popover component are also available.

openRequired

If true, the component is shown.

Type:

bool
anchorEl

An HTML element, or a function that returns one. It's used to set the position of the menu.

Type:

HTML element | func
autoFocus

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.

Type:

bool

Default:

true
children

Menu contents, normally MenuItems.

Type:

node
classes

Override or extend the styles applied to the component.

Type:

object
disableAutoFocusItem

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.

Type:

bool

Default:

false
MenuListProps

Props applied to the MenuList element.

Type:

object

Default:

{}
onClose

Callback fired when the component requests to be closed.

Type:

func

Signature:

function(event: object, reason: string) => void
  • event The event source of the callback.
  • reason Can be: "escapeKeyDown", "backdropClick", "tabKeyDown".
PopoverClasses

classes prop applied to the Popover element.

Type:

object
sx

The system prop that allows defining system overrides as well as additional CSS styles.

Type:

Array<func | object | bool> | func | object
transitionDuration

The length of the transition in ms, or 'auto'

Type:

'auto' | number | { appear?: number, enter?: number, exit?: number }

Default:

'auto'
TransitionProps

Props applied to the transition element. By default, the element is based on this Transition component.

Type:

object

Default:

{}
variant

The variant to use. Use menu to prevent selected items from impacting the initial focus.

Type:

'menu' | 'selectedMenu'

Default:

'selectedMenu'
The ref is forwarded to the root element.

Inheritance

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

CSS

The following class names are useful for styling with CSS (the state classes are marked).
To learn more, visit the component customization page.

.MuiMenu-rootroot

Styles applied to the root element.

.MuiMenu-paperpaper

Styles applied to the Paper component.

.MuiMenu-listlist

Styles applied to the List component via MenuList.

You can override the style of the component using one of these customization options: