Skip to content

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/joy/MenuList';
// or
import { MenuList } from '@mui/joy';
You can learn about the difference by reading this guide on minimizing bundle size.

Props

Props of the native component are also available.

NameTypeDefaultDescription
actionsfunc
| { current?: { highlightFirstItem: func, highlightLastItem: func } }
A ref with imperative actions. It allows to select the first or last menu item.
color'danger'
| 'info'
| 'neutral'
| 'primary'
| 'success'
| 'warning'
| string
'neutral'
The color of the component. It supports those theme colors that make sense for this component. To learn how to add your own colors, check out Themed components—Extend colors.
componentelementType
The component used for the root node. Either a string to use a HTML element or a component.
size'sm'
| 'md'
| 'lg'
| string
'md'
The size of the component (affect other nested list* components because the Menu inherits List). To learn how to add custom sizes to the component, check out Themed components—Extend sizes.
sxArray<func
| object
| bool>
| func
| object
The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.
variant'outlined'
| 'plain'
| 'soft'
| 'solid'
| string
'outlined'
The global variant to use. To learn how to add your own variants, check out Themed components—Extend variants.

The ref is forwarded to the root element.

Theme default props

You can use JoyMenuList to change the default props of this component with the theme.