Skip to content

MenuList API

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

Import

import MenuList from '@material-ui/core/MenuList';
// or
import { MenuList } from '@material-ui/core';
You can learn about the difference by reading this guide on minimizing bundle size.

A permanently displayed menu following https://www.w3.org/TR/wai-aria-practices/#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.

Props

NameTypeDefaultDescription
autoFocusboolfalseIf true, will focus the [role="menu"] container and move into tab order.
autoFocusItemboolfalseIf true, will focus the first menuitem if variant="menu" or selected item if variant="selectedMenu".
childrennodeMenuList contents, normally MenuItems.
disabledItemsFocusableboolfalseIf true, will allow focus on disabled items.
disableListWrapboolfalseIf 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.
Any other props supplied will be provided to the root element (List).

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.

Demos