Skip to content

List API

API reference docs for the React List component. Learn about the props, CSS, and other APIs of this exported module.

Demos

For examples and details on the usage of this React component, visit the component demo pages:

Import

import List from '@mui/material/List';
// or
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

Props of the native component are also available.

NameTypeDefaultDescription
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
| bool>
| func
| object
The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.

The ref is forwarded to the root 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: