ListItemButton API

API reference docs for the React ListItemButton component. Learn about the props, CSS, and other APIs of this exported module.

Component demos

For examples and details on the usage of this React component, visit the component demo pages:

Lists

Import

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

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

Props

Props of the ButtonBase component are also available.

alignItems

Defines the align-items style property.

Type:'center' | 'flex-start'

Default:'center'

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 if a ListItemSecondaryAction is used it must be the last child.

Type:node

classes

Override or extend the styles applied to the component.

See CSS API below for more details.

Type:object

component

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

Type:elementType

dense

If true, compact vertical padding designed for keyboard and mouse input is used. The prop defaults to the value inherited from the parent List component.

Type:bool

Default:false

disabled

If true, the component is disabled.

Type:bool

Default:false

disableGutters

If true, the left and right padding is removed.

Type:bool

Default:false

divider

If true, a 1px light border is added to the bottom of the list item.

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

selected

Use to apply selected styling.

Type:bool

Default:false

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

The ref is forwarded to the root element.

Inheritance

While not explicitly documented above, the props of the ButtonBase component are also available in ListItemButton. You can take advantage of this to target nested components.

Theme default props

You can use MuiListItemButton to change the default props of this component with the theme.

CSS classes

These class names are useful for styling with CSS. They are applied to the component's slots 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-alignItemsFlexStart

Styles applied to the component element if alignItems="flex-start".

Rule name:alignItemsFlexStart

.MuiListItemButton-dense

Styles applied to the component element if dense.

Rule name:dense

.MuiListItemButton-divider

Styles applied to the inner component element if divider={true}.

Rule name:divider

.MuiListItemButton-gutters

Styles applied to the inner component element unless disableGutters={true}.

Rule name:gutters

.MuiListItemButton-root

Styles applied to the root element.

Rule name: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.