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:

Lists

Import

import List from '@mui/joy/List';
// or
import { List } from '@mui/joy';

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

Props

Props of the native component are also available.

Name	Type	Default	Description
children	node	-	The content of the component.
color	'danger' \| 'neutral' \| 'primary' \| 'success' \| 'warning' \| string	'neutral'	The color of the component. It supports those theme colors that make sense for this component. To learn how to add your own colors, check out Themed components—Extend colors.
component	elementType	-	The component used for the root node. Either a string to use a HTML element or a component.
marker	string	-	The marker (such as a disc, character, or custom counter style) of the list items. When this prop is specified, the List Item changes the CSS display to `list-item` in order to apply the marker. To see all available options, check out the MDN list-style-type page.
orientation	'horizontal' \| 'vertical'	'vertical'	The component orientation.
size	'sm' \| 'md' \| 'lg' \| string	'md'	The size of the component (affect other nested list* components). To learn how to add custom sizes to the component, check out Themed components—Extend sizes.
slotProps	{ root?: func \| object }	{}	The props used for each slot inside.
slots	{ root?: elementType }	{}	The components used for each slot inside. See Slots API below for more details.
sx	Array<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.
variant	'outlined' \| 'plain' \| 'soft' \| 'solid' \| string	'plain'	The global variant to use. To learn how to add your own variants, check out Themed components—Extend variants.
wrap	bool	false	Only for horizontal list. If `true`, the list sets the flex-wrap to "wrap" and adjust margin to have gap-like behavior (will move to `gap` in the future).

The ref is forwarded to the root element.

Theme default props

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

Slots

To learn how to customize the slot, check out the Overriding component structure guide.

Slot name	Class name	Default component	Description
root	.MuiList-root	`'ul'`	The component that renders the root.

CSS classes

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

Class name	Rule name	Description
.MuiList-colorContext	colorContext	Class name applied to the root element when color inversion is triggered.
.MuiList-colorDanger	colorDanger	Class name applied to the root element if `color="danger"`.
.MuiList-colorNeutral	colorNeutral	Class name applied to the root element if `color="neutral"`.
.MuiList-colorPrimary	colorPrimary	Class name applied to the root element if `color="primary"`.
.MuiList-colorSuccess	colorSuccess	Class name applied to the root element if `color="success"`.
.MuiList-colorWarning	colorWarning	Class name applied to the root element if `color="warning"`.
.MuiList-horizontal	horizontal	Class name applied to the root element if `orientation="horizontal"`.
.MuiList-nesting	nesting	Class name applied to the root element if wrapped with nested context.
.MuiList-scoped	scoped	Class name applied to the root element if `scoped` is true.
.MuiList-sizeLg	sizeLg	Class name applied to the root element if `size="lg"`.
.MuiList-sizeMd	sizeMd	Class name applied to the root element if `size="md"`.
.MuiList-sizeSm	sizeSm	Class name applied to the root element if `size="sm"`.
.MuiList-variantOutlined	variantOutlined	Class name applied to the root element if `variant="outlined"`.
.MuiList-variantPlain	variantPlain	Class name applied to the root element if `variant="plain"`.
.MuiList-variantSoft	variantSoft	Class name applied to the root element if `variant="soft"`.
.MuiList-variantSolid	variantSolid	Class name applied to the root element if `variant="solid"`.
.MuiList-vertical	vertical	Class name applied to the root element if `orientation="vertical"`.

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.

Source code

If you did not find the information in this page, consider having a look at the implementation of the component for more detail.