Pular para o conteúdo

ListItem API

API documentation for the React ListItem component. Learn about the available props, and the CSS API.

Import

import ListItem from '@material-ui/core/ListItem';
// or
import { ListItem } from '@material-ui/core';
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.

Component name

The name MuiListItem can be used when providing default props or style overrides in the theme.

Props

NameTypeDefaultDescription
alignItems'center'
| 'flex-start'
'center'Defines the align-items style property.
autoFocusboolfalseIf true, the list item is focused during the first mount. Focus will also be triggered if the value changes from false to true.
buttonboolfalseIf true, the list item is a button (using ButtonBase). Props intended for ButtonBase can then be applied to ListItem.
childrennodeThe content of the component. If a ListItemSecondaryAction is used it must be the last child.
classesobjectOverride or extend the styles applied to the component. See CSS API below for more details.
componentelementTypeThe component used for the root node. Either a string to use a HTML element or a component.
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.
denseboolfalseIf true, compact vertical padding designed for keyboard and mouse input is used. The prop defaults to the value inherited from the parent List component.
disabledboolfalseIf true, the list item is disabled.
disableGuttersboolfalseIf true, the left and right padding is removed.
dividerboolfalseIf true, a 1px light border is added to the bottom of the list item.
selectedboolfalseUse to apply selected styling.

The ref is forwarded to the root element.
Any other props supplied will be provided to the root element (native element).

CSS

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.Mui-focusVisiblePseudo-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.Mui-disabledPseudo-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}.
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.Mui-selectedPseudo-class applied to the root element if selected={true}.

You can override the style of the component using one of these customization options: If that isn't sufficient, you can check the implementation of the component for more detail.

Demos