ListItem API
API reference docs for the React ListItem component. Learn about the props, CSS, and other APIs of this exported module.
Component demos
Import
import ListItem from '@mui/material/ListItem';
// or
import { ListItem } from '@mui/material';Uses an additional container component if ListItemSecondaryAction is the last child.
Props of the native component are also available.
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
The content of the component if a ListItemSecondaryAction is used it must be the last child.
Type:node
Override or extend the styles applied to the component.
See CSS API below for more details.
Type:object
The component used for the root node. Either a string to use a HTML element or a component.
Type: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.
Type:{ Root?: elementType }
Default:{}
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:{}
The container component used when a ListItemSecondaryAction is the last child.
Type:element type
Default:'li'
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
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:{}
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:{}
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
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.
State class applied to the component's focusVisibleClassName prop if button={true}.
Styles applied to the component element if alignItems="flex-start".
Rule name:alignItemsFlexStart
Styles applied to the container element if children includes ListItemSecondaryAction.
Rule name:container
Styles applied to the inner component element if divider={true}.
Rule name:divider
Styles applied to the inner component element unless disableGutters={true}.
Rule name:gutters
Styles applied to the root element unless disablePadding={true}.
Rule name:padding
Styles applied to the (normally root) component element. May be wrapped by a container.
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
styleOverridesproperty in a custom theme.