MenuList API
API reference docs for the React MenuList component. Learn about the props, CSS, and other APIs of this exported module.
Demos
Import
import MenuList from '@mui/material/MenuList';
// or
import { MenuList } from '@mui/material';
Learn about the difference by reading this guide on minimizing bundle size.
A permanently displayed menu following https://www.w3.org/WAI/ARIA/apg/patterns/menu-button/.
It's exposed to help customization of the Menu
component if you
use it separately you need to move focus into the component manually. Once
the focus is placed inside the component it is fully keyboard accessible.
Props of the List component are also available.
Name | Type | Default | Description |
---|---|---|---|
autoFocus | bool | false | If |
autoFocusItem | bool | false | If |
children | node | - | MenuList contents, normally |
disabledItemsFocusable | bool | false | If |
disableListWrap | bool | false | If |
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 List component are also available in MenuList. 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 |
---|---|---|
.MuiMenuList-dense | dense | Styles applied to the root element if dense. |
.MuiMenuList-padding | padding | Styles applied to the root element unless disablePadding={true} . |
.MuiMenuList-root | root | Styles applied to the root element. |
.MuiMenuList-subheader | subheader | Styles applied to the root element if a subheader is provided. |
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.