Skip to content

List API

API reference docs for the React List component. Learn about the props, CSS, and other APIs of this exported module.

Demos

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.

NameTypeDefaultDescription
childrennode-

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.

componentelementType-

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

markerstring-

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.

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

wrapboolfalse

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 nameClass nameDefault componentDescription
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 nameRule nameDescription
.MuiList-colorContextcolorContextClass name applied to the root element when color inversion is triggered.
.MuiList-colorDangercolorDangerClass name applied to the root element if color="danger".
.MuiList-colorNeutralcolorNeutralClass name applied to the root element if color="neutral".
.MuiList-colorPrimarycolorPrimaryClass name applied to the root element if color="primary".
.MuiList-colorSuccesscolorSuccessClass name applied to the root element if color="success".
.MuiList-colorWarningcolorWarningClass name applied to the root element if color="warning".
.MuiList-horizontalhorizontalClass name applied to the root element if orientation="horizontal".
.MuiList-nestingnestingClass name applied to the root element if wrapped with nested context.
.MuiList-scopedscopedClass name applied to the root element if scoped is true.
.MuiList-sizeLgsizeLgClass name applied to the root element if size="lg".
.MuiList-sizeMdsizeMdClass name applied to the root element if size="md".
.MuiList-sizeSmsizeSmClass name applied to the root element if size="sm".
.MuiList-variantOutlinedvariantOutlinedClass name applied to the root element if variant="outlined".
.MuiList-variantPlainvariantPlainClass name applied to the root element if variant="plain".
.MuiList-variantSoftvariantSoftClass name applied to the root element if variant="soft".
.MuiList-variantSolidvariantSolidClass name applied to the root element if variant="solid".
.MuiList-verticalverticalClass name applied to the root element if orientation="vertical".

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