跳转到内容

Menu API

API documentation for the React Menu component. Learn about the available props, and the CSS API.

Import

import Menu from '@mui/material/Menu';
// 或
import { Menu } from '@mui/material';
You can learn about the difference by reading this guide on minimizing bundle size.

Component name

The name MuiMenu can be used when providing default props or style overrides in the theme.

属性

Props of the Popover component are also available.

名称类型默认值描述
open*boolfalse
Control the popup` open state.
anchorElHTML element
| func
A HTML element, or a function that returns it. It's used to set the position of the menu.
autoFocusbooltrue
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.
childrennode
Menu contents, normally MenuItems.
classesobject
Override or extend the styles applied to the component. See CSS API below for more details.
disableAutoFocusItemboolfalse
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.
MenuListPropsobject{}
Props applied to the MenuList element.
onClosefunc
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".
PopoverClassesobject
classes prop applied to the Popover element.
sxArray<func
| object>
| 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'
TransitionPropsobject{}
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.

ref 则会被传递到根元素中。

Inheritance

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

CSS

Rule nameGlobal class描述
root.MuiMenu-rootStyles applied to the root element.
paper.MuiMenu-paperStyles applied to the Paper component.
list.MuiMenu-listStyles applied to the List component via `MenuList`.

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

Demos