Skip to content
Edit this page

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.

A ref with imperative actions. It allows to select the first or last menu item.

Type:

ref

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.

Type:

'danger' | 'neutral' | 'primary' | 'success' | 'warning'

Default:

'neutral'

The component used for the root node. Either a string to use a HTML element or a component.

Type:

elementType

The children will be under the DOM hierarchy of the parent component.

Type:

bool

Default:

false

If true, the children with an implicit color prop invert their colors to match the component's variant and color.

Type:

bool

Default:

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.

Type:

bool

Default:

false

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.

Type:

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> }>

Triggered when focus leaves the menu and the menu should close.

Type:

func

Function called when the items displayed in the menu change.

Type:

func

Controls whether the menu is displayed.

Type:

bool

Default:

false

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.

Type:

'sm' | 'md' | 'lg' | string

Default:

'md'

The props used for each slot inside.

Type:

{ root?: func | object }

Default:

{}

The components used for each slot inside.

See Slots API below for more details.

Type:

{ root?: elementType }

Default:

{}

The system prop that allows defining system overrides as well as additional CSS styles.

See the `sx` page for more details.

Type:

Array<func | object | bool> | func | object

The global variant to use.

To learn how to add your own variants, check out Themed components—Extend variants.

Type:

'outlined' | 'plain' | 'soft' | 'solid' | string

Default:

'outlined'
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.

The component that renders the root.

Default: 'ul'

Global class: .MuiMenu-root

You can override the style of the component using one of these customization options:

CSS classes

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

Class name applied to the root element when the menu open.

Class name applied to the root element when color inversion is triggered.

Class name applied to the root element if color="danger".

Class name applied to the root element if color="neutral".

Class name applied to the root element if color="primary".

Class name applied to the root element if color="success".

Class name applied to the root element if color="warning".

Class name applied to the listbox element.

Class name applied to the root element if size="lg".

Class name applied to the root element if size="md".

Class name applied to the root element if size="sm".

Class name applied to the root element if variant="outlined".

Class name applied to the root element if variant="plain".

Class name applied to the root element if variant="soft".

Class name applied to the root element if variant="solid".