MenuList API

API reference docs for the React MenuList component. Learn about the props, CSS, and other APIs of this exported module.

Component demos

For examples and details on the usage of this React component, visit the component demo pages:

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

Props of the List component are also available.

autoFocus

If true, will focus the [role="menu"] container and move into tab order.

Type:bool

Default:false

autoFocusItem

If true, will focus the first menuitem if variant="menu" or selected item if variant="selectedMenu".

Type:bool

Default:false

children

MenuList contents, normally MenuItems.

Type:node

disabledItemsFocusable

If true, will allow focus on disabled items.

Type:bool

Default:false

disableListWrap

If true, the menu items will not wrap focus.

Type:bool

Default:false

variant

The variant to use. Use menu to prevent selected items from impacting the initial focus and the vertical alignment relative to the anchor element.

Type:'menu' | 'selectedMenu'

Default:'selectedMenu'

The 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.

CSS classes

These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.

.MuiMenuList-dense

Styles applied to the root element if dense.

Rule name:dense

.MuiMenuList-padding

Styles applied to the root element unless disablePadding={true}.

Rule name:padding

.MuiMenuList-root

Styles applied to the root element.

Rule name:root

.MuiMenuList-subheader

Styles applied to the root element if a subheader is provided.

Rule name:subheader

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.