MenuList API
The API documentation of the MenuList React component. Learn more about the props and the CSS customization points.
Import
import MenuList from '@material-ui/core/MenuList';
// or
import { MenuList } from '@material-ui/core';
You can learn more about the difference by reading this guide.
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
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. |
|
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.
Any other props supplied will be provided to the root element (List).
Inheritance
The props of the List component are also available. You can take advantage of this behavior to target nested components.