Skip to content
Edit this page

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

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.

children

The content of the component.

Type:

node
color

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.

Type:

'danger' | 'neutral' | 'primary' | 'success' | 'warning' | string

Default:

'neutral'
component

The component used for the root node. Either a string to use a HTML element or a component.

Type:

elementType
orientation

The component orientation.

Type:

'horizontal' | 'vertical'

Default:

'vertical'
size

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.

Type:

'sm' | 'md' | 'lg' | string

Default:

'md'
slotProps

The props used for each slot inside.

Type:

{ root?: func | object }

Default:

{}
slots

The components used for each slot inside.

See Slots API below for more details.

Type:

{ root?: elementType }

Default:

{}
sx

The system prop that allows defining system overrides as well as additional CSS styles.

See the `sx` page for more details.

Type:

Array<func | object | bool> | func | object
variant

The global variant to use.

To learn how to add your own variants, check out Themed components—Extend variants.

Type:

'outlined' | 'plain' | 'soft' | 'solid' | string

Default:

'plain'
wrap

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

Type:

bool

Default:

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

root

The component that renders the root.

Default: 'ul'

Global class: .MuiList-root

You can override the style of the component using one of these customization options:

CSS classes

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

.MuiList-colorContext

Class name applied to the root element when color inversion is triggered.

.MuiList-colorDanger

Class name applied to the root element if color="danger".

.MuiList-colorNeutral

Class name applied to the root element if color="neutral".

.MuiList-colorPrimary

Class name applied to the root element if color="primary".

.MuiList-colorSuccess

Class name applied to the root element if color="success".

.MuiList-colorWarning

Class name applied to the root element if color="warning".

.MuiList-horizontal

Class name applied to the root element if orientation="horizontal".

.MuiList-nesting

Class name applied to the root element if wrapped with nested context.

.MuiList-scoped

Class name applied to the root element if scoped is true.

.MuiList-sizeLg

Class name applied to the root element if size="lg".

.MuiList-sizeMd

Class name applied to the root element if size="md".

.MuiList-sizeSm

Class name applied to the root element if size="sm".

.MuiList-variantOutlined

Class name applied to the root element if variant="outlined".

.MuiList-variantPlain

Class name applied to the root element if variant="plain".

.MuiList-variantSoft

Class name applied to the root element if variant="soft".

.MuiList-variantSolid

Class name applied to the root element if variant="solid".

.MuiList-vertical

Class name applied to the root element if orientation="vertical".