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:

Lists

Import

import ListItemButton from '@mui/joy/ListItemButton';
// or
import { ListItemButton } from '@mui/joy';

Learn about the difference by reading this guide on minimizing bundle size.

Props

Props of the native component are also available.

Name	Type	Default	Description
action	func \| { current?: { focusVisible: func } }	-	A ref for imperative actions. It currently only supports `focusVisible()` action.
autoFocus	bool	false	If `true`, the list item is focused during the first mount. Focus will also be triggered if the value changes from false to true.
children	node	-	The content of the component.
color	'danger' \| 'neutral' \| 'primary' \| 'success' \| 'warning' \| string	'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.
component	elementType	-	The component used for the root node. Either a string to use a HTML element or a component.
disabled	bool	false	If `true`, the component is disabled.
focusVisibleClassName	string	-	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.
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.
sx	Array<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.

Slot name	Class name	Default component	Description
root	.MuiListItemButton-root	`'div'`	The component that renders the root.

CSS classes

These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.

Class name	Rule name	Description
.Mui-disabled		State class applied to the inner `component` element if `disabled={true}`.
.Mui-focusVisible		State class applied to the `component`'s `focusVisibleClassName` prop.
.Mui-selected		State class applied to the root element if `selected={true}`.
.MuiListItemButton-colorContext	colorContext	Class name applied to the root element if `color="context"`.
.MuiListItemButton-colorDanger	colorDanger	Class name applied to the root element if `color="danger"`.
.MuiListItemButton-colorNeutral	colorNeutral	Class name applied to the root element if `color="neutral"`.
.MuiListItemButton-colorPrimary	colorPrimary	Class name applied to the root element if `color="primary"`.
.MuiListItemButton-colorSuccess	colorSuccess	Class name applied to the root element if `color="success"`.
.MuiListItemButton-colorWarning	colorWarning	Class name applied to the root element if `color="warning"`.
.MuiListItemButton-horizontal	horizontal	Class name applied to the root element, if `orientation="horizontal"`.
.MuiListItemButton-variantOutlined	variantOutlined	State class applied to the root element if `variant="outlined"`.
.MuiListItemButton-variantPlain	variantPlain	State class applied to the root element if `variant="plain"`.
.MuiListItemButton-variantSoft	variantSoft	State class applied to the root element if `variant="soft"`.
.MuiListItemButton-variantSolid	variantSolid	State class applied to the root element if `variant="solid"`.
.MuiListItemButton-vertical	vertical	Class name applied to the root element, if `orientation="vertical"`.

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.

Source code

If you did not find the information in this page, consider having a look at the implementation of the component for more detail.