跳转到内容

ListItem API

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

Import

import ListItem from '@mui/material/ListItem';
// 或
import { ListItem } from '@mui/material';
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 of the 原生(Native) component are also available.

名称类型默认值描述
alignItems'center'
| 'flex-start'
'center'
Defines the align-items style property.
autoFocusboolfalse
If true, the list item is focused during the first mount. Focus will also be triggered if the value changes from false to true.
buttonboolfalse
If true, the list item is a button (using ButtonBase). Props intended for ButtonBase can then be applied to ListItem.
childrennode
The content of the component if a ListItemSecondaryAction is used it must be the last child.
classesobject
Override or extend the styles applied to the component. See CSS API below for more details.
componentelementType
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 the InputBase. Either a string to use a HTML element or a component.
componentsPropsobject{}
The props used for each slot inside the Input.
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.
denseboolfalse
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.
disabledboolfalse
如果被设置为 true,那么该组件将会被禁用。
disableGuttersboolfalse
If true, the left and right padding is removed.
disablePaddingboolfalse
If true, all padding is removed.
dividerboolfalse
If true, a 1px light border is added to the bottom of the list item.
secondaryActionnode
The element to display at the end of ListItem.
selectedboolfalse
Use to apply selected styling.
sxArray<func
| object>
| func
| object
The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.

ref 则会被传递到根元素中。

CSS

Rule nameGlobal class描述
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}.
padding.MuiListItem-paddingStyles applied to the root element unless disablePadding={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:

Demos