Skip to content

ListItem API

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

Uses an additional container component if ListItemSecondaryAction is the last child.

Props

Props of the native 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.
buttonboolfalse
If true, the list item is a button (using ButtonBase). Props intended for ButtonBase can then be applied to ListItem.
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.
components{ Root?: elementType }{}
The components used for each slot inside.
This prop is an alias for the slots prop. It's recommended to use the slots prop instead.
componentsProps{ root?: object }{}
The extra props for the slot components. You can override the existing props or add new ones.
This prop is an alias for the slotProps prop. It's recommended to use the slotProps prop instead, as componentsProps will be deprecated in the future.
ContainerComponentelement type'li'
The container component used when a ListItemSecondaryAction is the last child.
⚠️ Needs to be able to hold a ref.
ContainerPropsobject{}
Props applied to the container component if used.
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.
disablePaddingboolfalse
If true, all padding is removed.
dividerboolfalse
If true, a 1px light border is added to the bottom of the list item.
secondaryActionnode
The element to display at the end of ListItem.
selectedboolfalse
Use to apply selected styling.
slotProps{ root?: object }{}
The extra props for the slot components. You can override the existing props or add new ones.
This prop is an alias for the componentsProps prop, which will be deprecated in the future.
slots{ root?: elementType }{}
The components used for each slot inside.
This prop is an alias for the components prop, which will be deprecated in the future.
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.

Theme default props

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

CSS

The following class names are useful for styling with CSS (the state classes are marked).
To learn more, visit the component customization page.

Rule nameGlobal classDescription
root.MuiListItem-rootStyles applied to the (normally root) component element. May be wrapped by a container.
container.MuiListItem-containerStyles applied to the container element if children includes ListItemSecondaryAction.
focusVisible
STATE
.Mui-focusVisibleState class applied to the component's focusVisibleClassName prop if button={true}.
dense.MuiListItem-denseStyles applied to the component element if dense.
alignItemsFlexStart.MuiListItem-alignItemsFlexStartStyles applied to the component element if alignItems="flex-start".
disabled
STATE
.Mui-disabledState class applied to the inner component element if disabled={true}.
divider.MuiListItem-dividerStyles applied to the inner component element if divider={true}.
gutters.MuiListItem-guttersStyles applied to the inner component element unless disableGutters={true}.
padding.MuiListItem-paddingStyles applied to the root element unless disablePadding={true}.
button.MuiListItem-buttonStyles applied to the inner component element if button={true}.
secondaryAction.MuiListItem-secondaryActionStyles applied to the component element if children includes ListItemSecondaryAction.
selected
STATE
.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: