Skip to content
Edit this page

MenuItem API

API reference docs for the React MenuItem 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 MenuItem from '@mui/joy/MenuItem';
// or
import { MenuItem } from '@mui/joy';
Learn about the difference by reading this guide on minimizing bundle size.

Props

The content of the component.

Type:

node

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' | string

Default:

'neutral'

The content direction flow.

Type:

'horizontal' | 'vertical'

Default:

'horizontal'

If true, the component is selected.

Type:

bool

Default:

false

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 global variant to use.

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

Type:

'contained' | 'light' | 'outlined' | 'text' | string

Default:

'plain'
The ref is forwarded to the root element.

Inheritance

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

Theme default props

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

Slots

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

The component that renders the root.

Default: 'div'

Global class: .MuiMenuItem-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.

State class applied to the inner component element if disabled={true}.

State class applied to the component's focusVisibleClassName prop.

State class applied to the root element if selected={true}.

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".

State class applied to the root element if variant="outlined".

State class applied to the root element if variant="plain".

State class applied to the root element if variant="soft".

State class applied to the root element if variant="solid".