Menu API

API reference docs for the React Menu 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 Menu from '@mui/joy/Menu';
// or
import { Menu } from '@mui/joy';

Learn about the difference by reading this guide on minimizing bundle size.

Props

Props of the Popper component are also available.

Name	Type	Default	Description
actions	ref		A ref with imperative actions. It allows to select the first or last menu item.
color	'danger' \| 'neutral' \| 'primary' \| 'success' \| 'warning'	'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.
component	elementType		The component used for the root node. Either a string to use a HTML element or a component.
disablePortal	bool	false	The `children` will be under the DOM hierarchy of the parent component.
invertedColors	bool	false	If `true`, the children with an implicit color prop invert their colors to match the component's variant and color.
keepMounted	bool	false	Always keep the children in the DOM. This prop can be useful in SEO situation or when you want to maximize the responsiveness of the Popper.
modifiers	Array<{ data?: object, effect?: func, enabled?: bool, fn?: func, name?: any, options?: object, phase?: 'afterMain' \| 'afterRead' \| 'afterWrite' \| 'beforeMain' \| 'beforeRead' \| 'beforeWrite' \| 'main' \| 'read' \| 'write', requires?: Array<string>, requiresIfExists?: Array<string> }>		Popper.js is based on a "plugin-like" architecture, most of its features are fully encapsulated "modifiers". A modifier is a function that is called each time Popper.js needs to compute the position of the popper. For this reason, modifiers should be very performant to avoid bottlenecks. To learn how to create a modifier, read the modifiers documentation.
onClose	func		Triggered when focus leaves the menu and the menu should close.
onItemsChange	func		Function called when the items displayed in the menu change.
open	bool	false	Controls whether the menu is displayed.
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.
slotProps	{ root?: func \| object }	{}	The props used for each slot inside.
slots	{ root?: elementType }	{}	The components used for each slot inside. See Slots API below for more details.
sx	Array<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.

Inheritance

While not explicitly documented above, the props of the Popper component are also available in Menu. You can take advantage of this to target nested components.

Slots

To learn how to customize the slot, check out the Overriding component structure guide.

Slot name	Class name	Default	Description
root	.MuiMenu-root	`'ul'`	The component that renders the root.

CSS classes

These class names are useful for styling with CSS. They are applied to the root slot when specific states are triggered.

Rule name	Description
.Mui-expanded	Class name applied to the root element when the menu open.
.MuiMenu-colorContext	Class name applied to the root element when color inversion is triggered.
.MuiMenu-colorDanger	Class name applied to the root element if `color="danger"`.
.MuiMenu-colorNeutral	Class name applied to the root element if `color="neutral"`.
.MuiMenu-colorPrimary	Class name applied to the root element if `color="primary"`.
.MuiMenu-colorSuccess	Class name applied to the root element if `color="success"`.
.MuiMenu-colorWarning	Class name applied to the root element if `color="warning"`.
.MuiMenu-listbox	Class name applied to the listbox element.
.MuiMenu-sizeLg	Class name applied to the root element if `size="lg"`.
.MuiMenu-sizeMd	Class name applied to the root element if `size="md"`.
.MuiMenu-sizeSm	Class name applied to the root element if `size="sm"`.
.MuiMenu-variantOutlined	Class name applied to the root element if `variant="outlined"`.
.MuiMenu-variantPlain	Class name applied to the root element if `variant="plain"`.
.MuiMenu-variantSoft	Class name applied to the root element if `variant="soft"`.
.MuiMenu-variantSolid	Class name applied to the root element if `variant="solid"`.

Have any feedback about this new API display design?

We've heard from you and iterated on making the design of API content documentation more scalable and easier to parse! We value your input, so please don't hesitate to share any additional feedback you may have.