MenuItem API
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';
Props
Name | Type | Default | Description |
---|---|---|---|
children | node | The content of the component. | |
color | 'danger' | 'info' | 'neutral' | 'primary' | 'success' | 'warning' | string | selected ? 'primary' : '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. |
orientation | 'horizontal' | 'vertical' | 'horizontal' | The content direction flow. |
selected | bool | false | If true , the component is selected. |
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. |
variant | 'contained' | 'light' | 'outlined' | 'text' | string | 'plain' | 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 ListItemButton component are also available on MenuItem. You can take advantage of this to target nested components.Theme default props
You can useJoyMenuItem
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.
Name | Default class | Default HTML tag | Description |
---|---|---|---|
root | .MuiMenuItem-root | 'div' | The component that renders the root. |
You can override the style of the component using one of these customization options:
- With a global class name.
- With a rule name as part of the component's
styleOverrides
property in a custom theme.
CSS classes
These class names are useful for styling with CSS. They are applied to the root slot when specific states are triggered.
Global class | Description |
---|---|
.Mui-disabled STATE | State class applied to the inner component element if disabled={true} . |
.Mui-focusVisible STATE | State class applied to the component 's focusVisibleClassName prop. |
.Mui-selected STATE | 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-colorInfo | Class name applied to the root element if color="info" . |
.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" . |