ListItem API
API reference docs for the React ListItem component. Learn about the props, CSS, and other APIs of this exported module.
Demos
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 of the native component are also available.
Name | Type | Default | Description |
---|---|---|---|
alignItems | 'center' | 'flex-start' | 'center' | Defines the |
children | node | - | The content of the component if a |
classes | object | - | Override or extend the styles applied to the component. See CSS classes API below for more details. |
component | elementType | - | 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. |
componentsProps | { root?: object } | {} | The extra props for the slot components. You can override the existing props or add new ones. |
ContainerComponent | element type | 'li' | The container component used when a |
ContainerProps | object | {} | Props applied to the container component if used. |
dense | bool | false | If |
disableGutters | bool | false | If |
disablePadding | bool | false | If |
divider | bool | false | If |
secondaryAction | node | - | The element to display at the end of ListItem. |
slotProps | { root?: object } | {} | The extra props for the slot components. You can override the existing props or add new ones. |
slots | { root?: elementType } | {} | The components used for each slot inside. |
sx | Array<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. |
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.
These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.
Class name | Rule name | Description |
---|---|---|
.MuiListItem-alignItemsFlexStart | alignItemsFlexStart | Styles applied to the component element if alignItems="flex-start" . |
.MuiListItem-container | container | Styles applied to the container element if children includes ListItemSecondaryAction . |
.MuiListItem-dense | dense | Styles applied to the component element if dense. |
.MuiListItem-divider | divider | Styles applied to the inner component element if divider={true} . |
.MuiListItem-gutters | gutters | Styles applied to the inner component element unless disableGutters={true} . |
.MuiListItem-padding | padding | Styles applied to the root element unless disablePadding={true} . |
.MuiListItem-root | root | Styles applied to the (normally root) component element. May be wrapped by a container . |
.MuiListItem-secondaryAction | secondaryAction | Styles applied to the component element if children includes ListItemSecondaryAction . |
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.
Source code
If you did not find the information in this page, consider having a look at the implementation of the component for more detail.