跳转到内容

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

NameTypeDefaultDescription
childrennodeThe content of the component.
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.
denseboolfalseIf 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.
disablePaddingboolfalseIf true, vertical padding is removed from the list.
subheadernodeThe 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

Rule nameGlobal classDescription
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: If that isn't sufficient, you can check the implementation of the component for more detail.

Demos