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 of the Popover component are also available.
Name | Type | Default | Description |
---|---|---|---|
open* | bool | - | 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 classes 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 |
PopoverClasses | object | - | classes prop applied to the Popover element. |
slotProps | { paper?: func | object, root?: func | object } | {} | The props used for each slot inside. |
slots | { paper?: elementType, root?: elementType } | {} | The components used for each slot inside. |
sx | Array<func | object | bool> | func | object | - | The system prop that allows defining system overrides as well as additional CSS styles. See the sx page for more details. |
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. |
The ref
is forwarded to the root element.
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.
Class name | Rule name | Description |
---|---|---|
.MuiMenu-list | list | Styles applied to the List component via MenuList . |
.MuiMenu-paper | paper | Styles applied to the Paper component. |
.MuiMenu-root | root | Styles applied to the root element. |
You can override the style of the component using one of these customization options:
styleOverrides
property in a custom theme.If you did not find the information in this page, consider having a look at the implementation of the component for more detail.