List API

The API documentation of the List React component. Learn more about the props and the CSS customization points.

Import

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

You can learn more about the difference by reading this guide.

Props

Name	Type	Default	Description
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	'ul'	The component used for the root node. Either a string to use a DOM element or a component.
dense	bool	false	If true, compact vertical padding designed for keyboard and mouse input will be 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 will be removed from the list.
subheader	node		The content of the subheader, normally ListSubheader.

The ref is forwarded to the root element.

Any other props supplied will be provided to the root element (native element).

CSS

• Style sheet name: MuiList.
• Style sheet details:

Rule name	Global class	Description
root	.MuiList-root	Styles applied to the root element.
padding	.MuiList-padding	Styles applied to the root element if disablePadding={false}.
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 thanks to one of these customization points:

• With a rule name of the classes object prop.
• With a global class name.
• With a theme and an overrides property.

If that's not sufficient, you can check the implementation of the component for more detail.

Demos

• Lists
• Transfer List