跳转到内容

List API

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

Import

import List from '@mui/material/List';
// 或
import { List } from '@mui/material';
You can learn about the difference by reading this guide on minimizing bundle size.

Component name

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

属性

Props of the 原生(Native) component are also available.

名称类型默认值描述
childrennode
The content of the component.
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.
denseboolfalse
If true, compact vertical padding designed for keyboard and mouse input is used for the list and list items. The prop is available to descendant components as the dense context.
disablePaddingboolfalse
If true, vertical padding is removed from the list.
subheadernode
The content of the subheader, normally ListSubheader.
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.MuiList-rootStyles applied to the root element.
padding.MuiList-paddingStyles applied to the root element unless disablePadding={true}.
dense.MuiList-denseStyles applied to the root element if dense.
subheader.MuiList-subheaderStyles applied to the root element if a subheader is provided.

You can override the style of the component using one of these customization options:

Demos