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.
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.