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

Component name

The name MuiListItemButton can be used when providing default props or style overrides in the theme.

Props

Props of the ButtonBase component are also available.

NameTypeDefaultDescription
alignItems'center'
| 'flex-start'
'center'
Defines the align-items style property.
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 if a ListItemSecondaryAction is used it must be the last child.
classesobject
Override or extend the styles applied to the component. See CSS API below for more details.
componentelementType
The component used for the root node. Either a string to use a HTML element or a component.
denseboolfalse
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.
disabledboolfalse
If true, the component is disabled.
disableGuttersboolfalse
If true, the left and right padding is removed.
dividerboolfalse
If true, a 1px light border is added to the bottom of the list item.
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.
selectedboolfalse
Use to apply selected styling.
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.

The ref is forwarded to the root element.

Inheritance

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

CSS

Rule nameGlobal classDescription
root.MuiListItemButton-rootStyles applied to the root element.
focusVisible.Mui-focusVisibleState class applied to the `component`'s `focusVisibleClassName` prop.
dense.MuiListItemButton-denseStyles applied to the component element if dense.
alignItemsFlexStart.MuiListItemButton-alignItemsFlexStartStyles applied to the component element if alignItems="flex-start".
disabled.Mui-disabledState class applied to the inner `component` element if disabled={true}.
divider.MuiListItemButton-dividerStyles applied to the inner `component` element if divider={true}.
gutters.MuiListItemButton-guttersStyles applied to the inner `component` element unless disableGutters={true}.
selected.Mui-selectedState class applied to the root element if selected={true}.

You can override the style of the component using one of these customization options: