Menu API
API reference docs for the React Menu component. Learn about the props, CSS, and other APIs of this exported module.
Demos
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 of the Popover component are also available.
Name | Type | Default | Description |
---|---|---|---|
open* | bool | - | If |
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 |
children | node | - | Menu contents, normally |
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 |
MenuListProps | object | {} | Props applied to the |
onClose | func | - | Callback fired when the component requests to be closed. Signature: function(event: object, reason: string) => void
|
PopoverClasses | object | - |
|
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 |
TransitionProps | object | {} | Props applied to the transition element. By default, the element is based on this |
variant | 'menu' | 'selectedMenu' | 'selectedMenu' | The variant to use. Use |
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.
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:
- With a global class name.
- With a rule name as part of the component's
styleOverrides
property in a custom theme.
Source code
If you did not find the information in this page, consider having a look at the implementation of the component for more detail.