List API

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

Component 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';

Learn about the difference by reading this guide on minimizing bundle size.

Props

Props of the native component are also available.

children

The content of the component.

Type:node

classes

Override or extend the styles applied to the component.

See CSS API below for more details.

Type:object

component

The component used for the root node. Either a string to use a HTML element or a component.

Type:elementType

dense

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.

Type:bool

Default:false

disablePadding

If true, vertical padding is removed from the list.

Type:bool

Default:false

subheader

The content of the subheader, normally ListSubheader.

Type:node

The system prop that allows defining system overrides as well as additional CSS styles.

See the `sx` page for more details.

Type:Array<func | object | bool> | func | object

The ref is forwarded to the root element.

Theme default props

You can use MuiList to change the default props of this component with the theme.

CSS classes

These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.

.MuiList-dense

Styles applied to the root element if dense.

Rule name:dense

.MuiList-padding

Styles applied to the root element unless disablePadding={true}.

Rule name:padding

.MuiList-root

Styles applied to the root element.

Rule name:root

.MuiList-subheader

Styles applied to the root element if a subheader is provided.

Rule name:subheader

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.