Skip to content
Edit this page

ListDivider API

API reference docs for the React ListDivider 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 ListDivider from '@mui/joy/ListDivider';
// or
import { ListDivider } 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
component

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

Type:

elementType
inset

The empty space on the side(s) of the divider in a vertical list.
For horizontal list (the nearest parent List has row prop set to true), only inset="gutter" affects the list divider.

Type:

'context' | 'gutter' | 'startDecorator' | 'startContent' | string

Default:

'context'
orientation

The component orientation.

Type:

'horizontal' | 'vertical'

Default:

'horizontal'
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
The ref is forwarded to the root element.

Theme default props

You can use JoyListDivider 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: 'li'

Global class: .MuiListDivider-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.

.MuiListDivider-horizontal

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

.MuiListDivider-insetGutter

Class name applied to the root element if inset="gutter".

.MuiListDivider-insetStartContent

Class name applied to the root element if inset="startContent".

.MuiListDivider-insetStartDecorator

Class name applied to the root element if inset="startDecorator".

.MuiListDivider-vertical

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