List API

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

Import

import List from '@material-ui/core/List';
// 或
import { List } from '@material-ui/core';

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

名称	类型	默认值	描述
children	node		The content of the component.
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.
dense	bool	false	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.
disablePadding	bool	false	If `true`, vertical padding is removed from the list.
subheader	node		The content of the subheader, normally `ListSubheader`.
sx	object

ref 则会被传递到根元素中。
Any other props supplied will be provided to the root element (native element).

Rule name	Global class	描述
root	.MuiList-root	Styles applied to the root element.
padding	.MuiList-padding	Styles applied to the root element unless `disablePadding={true}`.
dense	.MuiList-dense	Styles applied to the root element if dense.
subheader	.MuiList-subheader	Styles applied to the root element if a `subheader` is provided.

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 styleOverrides property in a custom theme.