MenuList API

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

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';

You can 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/menubutton/. 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.

Component name

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

Props

Props of the List component are also available.

Name	Type	Default	Description
autoFocus	bool	false	If `true`, will focus the `[role="menu"]` container and move into tab order.
autoFocusItem	bool	false	If `true`, will focus the first menuitem if `variant="menu"` or selected item if `variant="selectedMenu"`.
children	node		MenuList contents, normally `MenuItem`s.
disabledItemsFocusable	bool	false	If `true`, will allow focus on disabled items.
disableListWrap	bool	false	If `true`, the menu items will not wrap focus.
variant	'menu' \| 'selectedMenu'	'selectedMenu'	The variant to use. Use `menu` to prevent selected items from impacting the initial focus and the vertical alignment relative to the anchor element.

The ref is forwarded to the root element.

Inheritance

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

CSS

Rule name	Global class	Description
root	.MuiMenuList-root	Styles applied to the root element.
padding	.MuiMenuList-padding	Styles applied to the root element unless `disablePadding={true}`.
dense	.MuiMenuList-dense	Styles applied to the root element if dense.
subheader	.MuiMenuList-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.