Skip to content
Edit this page

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';
Learn about the difference by reading this guide on minimizing bundle size.

Props

Props of the native component are also available.

action

A ref for imperative actions. It currently only supports focusVisible() action.

Type:

func | { current?: { focusVisible: func } }
autoFocus

If true, the list item is focused during the first mount. Focus will also be triggered if the value changes from false to true.

Type:

bool

Default:

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

Type:

'danger' | 'neutral' | 'primary' | 'success' | 'warning' | string

Default:

'neutral'
component

The component used for the root node. Either a string to use a HTML element or a component.

Type:

elementType
disabled

If true, the component is disabled.

Type:

bool

Default:

false
focusVisibleClassName

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.

Type:

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

{}
sx

The system prop that allows defining system overrides as well as additional CSS styles.

See the `sx` page for more details.

Type:

Array<func | object | bool> | func | object
variant

The global variant to use.

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

Type:

'outlined' | 'plain' | 'soft' | 'solid' | string

Default:

'plain'
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.

root

The component that renders the root.

Default: 'div'

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

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

.MuiListItemButton-colorContext

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

.MuiListItemButton-colorDanger

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

.MuiListItemButton-colorNeutral

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

.MuiListItemButton-colorPrimary

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

.MuiListItemButton-colorSuccess

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

.MuiListItemButton-colorWarning

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

.MuiListItemButton-horizontal

Class name applied to the root element, if orientation="horizontal".

.MuiListItemButton-variantOutlined

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

.MuiListItemButton-variantPlain

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

.MuiListItemButton-variantSoft

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

.MuiListItemButton-variantSolid

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

.MuiListItemButton-vertical

Class name applied to the root element, if orientation="vertical".