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:

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

Props of the native component are also available.

Name	Type	Default	Description
children	node		The content of the component.
color	'danger' \| 'info' \| '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.
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.

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

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

Name	Default class	Default HTML tag	Description
root	.MuiList-root	'ul'	The component that renders the root.

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.

These class names are useful for styling with CSS. They are applied to the root slot when specific states are triggered.

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