Menu API
API reference docs for the React Menu component. Learn about the props, CSS, and other APIs of this exported module.
Component demos
Import
import Menu from '@mui/material/Menu';
// or
import { Menu } from '@mui/material';Props of the Popover component are also available.
An HTML element, or a function that returns one. It's used to set the position of the menu.
Type:HTML element
| func
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
Override or extend the styles applied to the component.
See CSS API below for more details.
Type:object
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
Callback fired when the component requests to be closed.
Type:func
function(event: object, reason: string) => voideventThe event source of the callback.reasonCan be:"escapeKeyDown","backdropClick","tabKeyDown".
The extra props for the slot components. You can override the existing props or add new ones.
Type:{ paper?: func
| object, root?: func
| object }
Default:{}
The components used for each slot inside.
Type:{ paper?: elementType, root?: elementType }
Default:{}
The system prop that allows defining system overrides as well as additional CSS styles.
See the `sx` page for more details.
Type:Array<func
| object
| bool>
| func
| object
The length of the transition in ms, or 'auto'
Type:'auto'
| number
| { appear?: number, enter?: number, exit?: number }
Default:'auto'
Props applied to the transition element. By default, the element is based on this Transition component.
Type:object
Default:{}
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.
These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.
You can override the style of the component using one of these customization options:
- With a global class name.
- With a rule name as part of the component's
styleOverridesproperty in a custom theme.