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

children

The content of the component.

Type:node

color

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.

Default:'neutral'

orientation

The content direction flow.

Type:'horizontal' | 'vertical'

Default:'horizontal'

selected

If true, the component is selected.

Type:bool

Default:false

slotProps

The props used for each slot inside.

Type:{ root?: func | object }

Default:{}

slots

The components used for each slot inside.

See Slots API below for more details.

Type:{ root?: elementType }

Default:{}

variant

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.

root

The component that renders the root.

Global class: .MuiMenuItem-root

Default: 'div'

CSS classes

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

.Mui-disabledSTATE

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

.Mui-focusVisibleSTATE

State class applied to the component's focusVisibleClassName prop.

.Mui-selectedSTATE

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

.MuiMenuItem-colorContext

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

.MuiMenuItem-colorDanger

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

.MuiMenuItem-colorNeutral

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

.MuiMenuItem-colorPrimary

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

.MuiMenuItem-colorSuccess

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

.MuiMenuItem-colorWarning

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

.MuiMenuItem-variantOutlined

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

.MuiMenuItem-variantPlain

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

.MuiMenuItem-variantSoft

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

.MuiMenuItem-variantSolid

State class 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.