ListItem API
Import
import ListItem from '@mui/material/ListItem';
// or
import { ListItem } from '@mui/material';Uses an additional container component if ListItemSecondaryAction is the last child.
Component name
The nameMuiListItem can be used when providing default props or style overrides in the theme.Props
Props of the native component are also available.
| Name | Type | Default | Description |
|---|---|---|---|
| alignItems | 'center' | 'flex-start' | 'center' | Defines the align-items style property. |
| autoFocus | bool | false | If true, the list item is focused during the first mount. Focus will also be triggered if the value changes from false to true. |
| button | bool | false | If true, the list item is a button (using ButtonBase). Props intended for ButtonBase can then be applied to ListItem. |
| children | node | The content of the component if a ListItemSecondaryAction is used it must be the last child. | |
| classes | object | Override or extend the styles applied to the component. See CSS 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. 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. |
| ContainerComponent | element type | 'li' | The container component used when a ListItemSecondaryAction is the last child.⚠️ Needs to be able to hold a ref. |
| ContainerProps | object | {} | Props applied to the container component if used. |
| dense | bool | false | 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. |
| disabled | bool | false | If true, the component is disabled. |
| disableGutters | bool | false | If true, the left and right padding is removed. |
| disablePadding | bool | false | If true, all padding is removed. |
| divider | bool | false | If true, a 1px light border is added to the bottom of the list item. |
| secondaryAction | node | The element to display at the end of ListItem. | |
| selected | bool | false | 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. |
| 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. |
The
ref is forwarded to the root element.CSS
| Rule name | Global class | Description |
|---|---|---|
| root | .MuiListItem-root | Styles applied to the (normally root) `component` element. May be wrapped by a `container`. |
| container | .MuiListItem-container | Styles applied to the container element if children includes ListItemSecondaryAction. |
| focusVisible | .Mui-focusVisible | State class applied to the `component`'s `focusVisibleClassName` prop if button={true}. |
| dense | .MuiListItem-dense | Styles applied to the component element if dense. |
| alignItemsFlexStart | .MuiListItem-alignItemsFlexStart | Styles applied to the component element if alignItems="flex-start". |
| disabled | .Mui-disabled | State class applied to the inner `component` element if disabled={true}. |
| divider | .MuiListItem-divider | Styles applied to the inner `component` element if divider={true}. |
| gutters | .MuiListItem-gutters | Styles applied to the inner `component` element unless disableGutters={true}. |
| padding | .MuiListItem-padding | Styles applied to the root element unless disablePadding={true}. |
| button | .MuiListItem-button | Styles applied to the inner `component` element if button={true}. |
| secondaryAction | .MuiListItem-secondaryAction | Styles applied to the component element if children includes ListItemSecondaryAction. |
| selected | .Mui-selected | State class applied to the root element if selected={true}. |
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.