Skip to content

ListItemButton API

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

Props

Props of the native component are also available.

NameTypeDefaultDescription
actionfunc
| { current?: { focusVisible: func } }
A ref for imperative actions. It currently only supports focusVisible() action.
autoFocusboolfalse
If true, the list item is focused during the first mount. Focus will also be triggered if the value changes from false to true.
childrennode
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.
componentelementType
The component used for the root node. Either a string to use a HTML element or a component.
disabledboolfalse
If true, the component is disabled.
focusVisibleClassNamestring
This prop can help identify which element has keyboard focus. The class name will be applied when the element gains the focus through keyboard interaction. It's a polyfill for the CSS :focus-visible selector. The rationale for using this feature is explained here. A polyfill can be used to apply a focus-visible class to other components if needed.
orientation'horizontal'
| 'vertical'
'horizontal'
The content direction flow.
selectedboolfalse
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.
sxArray<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
'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.

Theme default props

You can use JoyListItemButton 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.

NameDefault classDefault HTML tagDescription
root.MuiListItemButton-root'div'The component that renders the 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.

Global classDescription
.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}.
.MuiListItemButton-colorContextClass name applied to the root element if color="context".
.MuiListItemButton-colorDangerClass name applied to the root element if color="danger".
.MuiListItemButton-colorInfoClass name applied to the root element if color="info".
.MuiListItemButton-colorNeutralClass name applied to the root element if color="neutral".
.MuiListItemButton-colorPrimaryClass name applied to the root element if color="primary".
.MuiListItemButton-colorSuccessClass name applied to the root element if color="success".
.MuiListItemButton-colorWarningClass name applied to the root element if color="warning".
.MuiListItemButton-horizontalClass name applied to the root element, if orientation="horizontal".
.MuiListItemButton-variantOutlinedState class applied to the root element if variant="outlined".
.MuiListItemButton-variantPlainState class applied to the root element if variant="plain".
.MuiListItemButton-variantSoftState class applied to the root element if variant="soft".
.MuiListItemButton-variantSolidState class applied to the root element if variant="solid".
.MuiListItemButton-verticalClass name applied to the root element, if orientation="vertical".