react-test/docs/data/material/components/lists/lists.md

productId, title, components, githubLabel, materialDesign, githubSource

productId	title	components	githubLabel	materialDesign	githubSource
material-ui	React List component	Collapse, Divider, List, ListItem, ListItemButton, ListItemAvatar, ListItemIcon, ListItemSecondaryAction, ListItemText, ListSubheader	scope: list	https://m2.material.io/components/lists	packages/mui-material/src/List

Lists

Lists are continuous, vertical indexes of text or images.

Lists are a continuous group of text or images. They are composed of items containing primary and supplemental actions, which are represented by icons and text.

{{"component": "@mui/docs/ComponentLinkHeader"}}

Introduction

Lists present information in a concise, easy-to-follow format through a continuous, vertical index of text or images.

Material UI Lists are implemented using a collection of related components:

• List: a wrapper for list items. Renders as a <ul> by default.
• List Item: a common list item. Renders as an <li> by default.
• List Item Button: an action element to be used inside a list item.
• List Item Icon: an icon to be used inside of a list item.
• List Item Avatar: an avatar to be used inside of a list item.
• List Item Text: a container inside a list item, used to display text content.
• List Divider: a separator between list items.
• List Subheader: a label for a nested list.

{{"demo": "BasicList.js", "bg": true}}

The last item of the previous demo shows how you can render a link:

<ListItemButton component="a" href="#simple-list">
  <ListItemText primary="Spam" />
</ListItemButton>

You can find a demo with React Router following this section of the documentation.

Basics

import List from '@mui/material/List';
import ListItem from '@mui/material/ListItem';

Nested List

{{"demo": "NestedList.js", "bg": true}}

Folder List

{{"demo": "FolderList.js", "bg": true}}

Interactive

Below is an interactive demo that lets you explore the visual results of the different settings:

{{"demo": "InteractiveList.js", "bg": true}}

Selected ListItem

{{"demo": "SelectedListItem.js", "bg": true}}

Align list items

When displaying three lines or more, the avatar is not aligned at the top. You should set the alignItems="flex-start" prop to align the avatar at the top, following the Material Design guidelines:

{{"demo": "AlignItemsList.js", "bg": true}}

List Controls

Checkbox

A checkbox can either be a primary action or a secondary action.

The checkbox is the primary action and the state indicator for the list item. The comment button is a secondary action and a separate target.

{{"demo": "CheckboxList.js", "bg": true}}

The checkbox is the secondary action for the list item and a separate target.

{{"demo": "CheckboxListSecondary.js", "bg": true}}

Switch

The switch is the secondary action and a separate target.

{{"demo": "SwitchListSecondary.js", "bg": true}}

Sticky subheader

Upon scrolling, subheaders remain pinned to the top of the screen until pushed off screen by the next subheader. This feature relies on CSS sticky positioning.

{{"demo": "PinnedSubheaderList.js", "bg": true}}

Inset List Item

The inset prop enables a list item that does not have a leading icon or avatar to align correctly with items that do.

{{"demo": "InsetList.js", "bg": true}}

Gutterless list

When rendering a list within a component that defines its own gutters, ListItem gutters can be disabled with disableGutters.

{{"demo": "GutterlessList.js", "bg": true}}

Virtualized List

In the following example, we demonstrate how to use react-window with the List component. It renders 200 rows and can easily handle more. Virtualization helps with performance issues.

{{"demo": "VirtualizedList.js", "bg": true}}

The use of react-window when possible is encouraged. If this library doesn't cover your use case, you should consider using alternatives like react-virtuoso.

Customization

Here are some examples of customizing the component. You can learn more about this in the overrides documentation page.

{{"demo": "CustomizedList.js"}}