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.

Simple List

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

function ListItemLink(props) {
  return <ListItem button component="a" {...props} />;
}

//...

<ListItemLink href="#simple-list">
  <ListItemText primary="Spam" />
</ListItemLink>

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

Nested List

Folder List

Interactive

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

Selected ListItem

Align list items

You should change the list item alignment when displaying 3 lines or more, set the alignItems="flex-start" property.

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.

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

Switch

The switch is the secondary action and a separate target.

Pinned Subheader List

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. Unfortunately it's not implemented by all the supported browsers. It defaults to disableSticky when not supported.

<List className={classes.root} subheader={<li />}>
  {[0, 1, 2, 3, 4].map(sectionId => (
    <li key={`section-${sectionId}`} className={classes.listSection}>
      <ul className={classes.ul}>
        <ListSubheader>{`I'm sticky ${sectionId}`}</ListSubheader>
        {[0, 1, 2].map(item => (
          <ListItem key={`item-${sectionId}-${item}`}>
            <ListItemText primary={`Item ${item}`} />
          </ListItem>
        ))}
      </ul>
    </li>
  ))}
</List>

Inset List

<List component="nav" className={classes.root} aria-label="contacts">
  <ListItem button>
    <ListItemIcon>
      <StarIcon />
    </ListItemIcon>
    <ListItemText primary="Chelsea Otakan" />
  </ListItem>
  <ListItem button>
    <ListItemText inset primary="Eric Hoffman" />
  </ListItem>
</List>

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.

<FixedSizeList height={400} width={360} itemSize={46} itemCount={200}>
  {renderRow}
</FixedSizeList>

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

API

• <Collapse />
• <Divider />
• <List />
• <ListItem />
• <ListItemAvatar />
• <ListItemIcon />
• <ListItemSecondaryAction />
• <ListItemText />
• <ListSubheader />