react-test/docs/data/joy/components/list/list.md

productId, title, components, githubLabel

productId	title	components	githubLabel
joy-ui	React List component	List, ListDivider, ListItem, ListItemButton, ListItemContent, ListItemDecorator, ListSubheader	scope: list

Lists

Lists are organizational tools that enhance the readability and organization of content.

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

Introduction

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

Joy 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 Decorator - a decorator of a list item, usually used to display an icon.
• List Item Content - 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": "ListUsage.js", "hideToolbar": true, "bg": "gradient"}}

Basics

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

Customization

Variants

The List component supports Joy UI's four global variants: solid, soft, outlined, and plain.

Sizes

The List component comes in three sizes: sm, md, and lg. The size of the List determines its font size and density.

{{"demo": "SizesList.js"}}

:::info To learn how to add custom sizes to the component, check out Themed components—Extend sizes. :::

Colors

Every palette included in the theme is available via the color prop.

Decorators

import ListItemDecorator from '@mui/joy/ListItemDecorator';

Use the List Item Decorator component to add supporting icons or elements to the list item.

{{"demo": "DecoratedList.js"}}

:::info The List Item Decorator comes with a minimum set width that can be adjusted using the --list-decorator-size CSS variable within the List component. :::

Horizontal list

Use the orientation="horizontal" prop on the List component to display the List horizontally.

{{"demo": "HorizontalList.js"}}

:::warning While nested lists will not work in a horizontal direction, you can create a custom pop-up component to achieve a similar effect (see the Navigation menu example). :::

Semantic elements

Use the component prop to control which HTML tag is rendered.

<List component="ol">

The example below renders the List component as an HTML <nav> element.

{{"demo": "NavList.js"}}

:::info The List Item component is optional in this case. If used, it will automatically change the semantic element from the default <li> to <div>. :::

Marker

Use the marker prop with any valid list-style-type value to add a marker to the list items.

{{"demo": "MarkerList.js"}}

:::success For numbered lists, change the List component to component="ol".

<List component="ol" marker="decimal">

:::

Ellipsis content

import ListItemContent from '@mui/joy/ListItemContent';

When working with longer content in a List, you can use the List Item Content component in combination with <Typography noWrap /> to display an ellipsis when the content exceeds the available space. This can help to keep the List Items visually consistent and prevent text from overflowing outside of the List Item's container.

{{"demo": "EllipsisList.js"}}

Divider

import ListDivider from '@mui/joy/ListDivider';

The List Divider component comes with four inset patterns:

• Default (no inset prop provided): stretches form one edge of the List to the other.
• inset="gutter": from the start of List Item Decorator to the end of the content.
• inset="startDecorator": from the start of List Item Decorator to the end of the edge of the container.
• inset="startContent": from the start of the content to the edge of the container.

{{"demo": "DividedList.js"}}

If you're using a horizontal list, only inset="gutter" will work as the list divider.

{{"demo": "HorizontalDividedList.js"}}

Sticky item

Use the List component as a child of the Sheet component to create "sticky" items. On the item you wish to stick, you can then add the sticky prop.

The Sheet component automatically adjusts the sticky list item to have the same background so that content does not overflow when scrolling.

{{"demo": "StickyList.js"}}

:::info By default, this works on both light and dark modes. :::

Nested list

import ListSubheader from '@mui/joy/ListSubheader';

You can create a nested list using the nested prop on a List Item. This enables you to add a List Subheader as well as a new List component as children of the List Item. The nested List will inherit its size as well as other CSS variables like --List-radius and --ListItem-radius from the root List component to keep the design consistent. The layout and spacing of the nested List will remain independent.

{{"demo": "NestedList.js"}}

:::info Nested lists will stick to the left of the root list, by default. If you need to add spacing to the start of the nested list you can use --List-nestedInsetStart: ${value}.

<List sx={{ '--List-nestedInsetStart': '1rem' }}> {/* This is the root List */}

:::

Interactive list items

import ListItemButton from '@mui/joy/ListItemButton';

To make a List Item interactive, you can use List Item Button inside a List Item.

{{"demo": "ActionableList.js"}}

To add a secondary action to the List Item Button, wrap it in a List Item component and then add the desired start or end action elements to it.

{{"demo": "SecondaryList.js"}}

:::info The List Item Button and the secondary action render as siblings so that the rendered semantic element is appropriately adjusted.

<ul>                    {/* List */}
  <li>                  {/* ListItem */}
    <div role="button"> {/* ListItemButton */}
    <button>            {/* IconButton */}

:::

Selected

Use the selected prop on the List Item Button component to indicate whether or not an item is currently selected. When the item is selected, it applies color="primary" and a few extra styles—like font weight—to visually communicate the selected state.

{{"demo": "SelectedList.js"}}

:::info A selected List Item Button does not apply :hover and :active global variant styles. :::

CSS variables playground

Play around with the CSS variables available to the List components to see how the design changes. You can use these to customize the components with both the sx prop and the theme.

{{"demo": "ListVariables.js", "hideToolbar": true, "bg": "gradient"}}

Common examples

iOS settings

This example uses nested lists to split the settings into groups.

{{"demo": "ExampleIOSList.js"}}

Gmail navigation

Inspired by Gmail's desktop navigation bar.

{{"demo": "ExampleGmailList.js"}}

Collapsible list

Inspired by the Gatsby documentation navbar. This example uses the startAction prop to create a collapsible button.

{{"demo": "ExampleCollapsibleList.js"}}

Navigation menu

Inspired by the APG Navigation Menubar design pattern. This example uses a combination of horizontal and vertical lists to form the navigation menu bar.

It also supports keyboard navigation, inspired by the Roving UX technique.

{{"demo": "ExampleNavigationMenu.js"}}

Accessibility

To ensure that your List is accessible, here are some factors you should consider:

• Use the appropriate HTML semantic element for the list (for example ol or ul), to ensure that assistive technologies can correctly interpret the list structure.
• Make sure to use a meaningful name that describes the content of the list in the aria-labelledby prop.
• Use role attributes to provide additional information about the purpose of the list and its items. For example, use role="list" for the list and role="listitem" for each list item.

Anatomy

The List component is composed of a root <ul> element with one or more child <li> elements rendered by the List Item component. All components nested inside the List Item are optional. The List Divider (when present) renders an <li> with role="separator", while the List Subheader renders a <div>.

<ul class="MuiList-root">
  <li class="MuiListItem-root">
    <div class="MuiListItemButton-root" role="button">
      <span class="MuiListItemDecorator-root">
        <!-- Icon for List Item Decorator -->
      </span>
      <div class="MuiListItemContent-root">
        <!-- List Item content -->
      </div>
    </div>
  </li>
</ul>