Skip to content
Edit this page

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

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
button

If true, the list item is a button (using ButtonBase). Props intended for ButtonBase can then be applied to ListItem.

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
components

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.

Type:

{ Root?: elementType }

Default:

{}
componentsProps

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.

Type:

{ root?: object }

Default:

{}
ContainerComponent

The container component used when a ListItemSecondaryAction is the last child.

Type:

element type

Default:

'li'
ContainerProps

Props applied to the container component if used.

Type:

object

Default:

{}
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
disablePadding

If true, all 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
secondaryAction

The element to display at the end of ListItem.

Type:

node
selected

Use to apply selected styling.

Type:

bool

Default:

false
slotProps

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.

Type:

{ root?: object }

Default:

{}
slots

The components used for each slot inside.
This prop is an alias for the components prop, which will be deprecated in the future.

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


.MuiListItem-rootroot

Styles applied to the (normally root) component element. May be wrapped by a container.

.MuiListItem-containercontainer

Styles applied to the container element if children includes ListItemSecondaryAction.

.Mui-focusVisiblefocusVisibleSTATE

State class applied to the component's focusVisibleClassName prop if button={true}.

.MuiListItem-densedense

Styles applied to the component element if dense.

.MuiListItem-alignItemsFlexStartalignItemsFlexStart

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

.Mui-disableddisabledSTATE

State class applied to the inner component element if disabled={true}.

.MuiListItem-dividerdivider

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

.MuiListItem-guttersgutters

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

.MuiListItem-paddingpadding

Styles applied to the root element unless disablePadding={true}.

.MuiListItem-buttonbutton

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

.MuiListItem-secondaryActionsecondaryAction

Styles applied to the component element if children includes ListItemSecondaryAction.

.Mui-selectedselectedSTATE

State class applied to the root element if selected={true}.

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