Skip to content

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';
You can 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.
componentelementType
The component used for the root node. Either a string to use a HTML element or a component.
inset'context'
| 'gutter'
| 'startDecorator'
| 'startContent'
| string
'context'
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.
orientation'horizontal'
| 'vertical'
'horizontal'
The component orientation.
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.

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.

NameDefault classDefault HTML tagDescription
root.MuiListDivider-root'li'The component that renders the 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.

Global classDescription
.MuiListDivider-horizontalClass name applied to the root element if orientation="horizontal".
.MuiListDivider-insetGutterClass name applied to the root element if inset="gutter".
.MuiListDivider-insetStartContentClass name applied to the root element if inset="startContent".
.MuiListDivider-insetStartDecoratorClass name applied to the root element if inset="startDecorator".
.MuiListDivider-verticalClass name applied to the root element if orientation="vertical".