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 ListDivider from '@mui/joy/ListDivider';
// or
import { ListDivider } from '@mui/joy';

Props of the native component are also available.

Name	Type	Default	Description
children	node	-	The content of the component.
component	elementType	-	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.
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.

The ref is forwarded to the root element.

You can use JoyListDivider to change the default props of this component with the theme.

To learn how to customize the slot, check out the Overriding component structure guide.

Slot name	Class name	Default component	Description
root	.MuiListDivider-root	`'li'`	The component that renders the root.

These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.

Class name	Rule name	Description
.MuiListDivider-horizontal	horizontal	Class name applied to the root element if `orientation="horizontal"`.
.MuiListDivider-insetGutter	insetGutter	Class name applied to the root element if `inset="gutter"`.
.MuiListDivider-insetStartContent	insetStartContent	Class name applied to the root element if `inset="startContent"`.
.MuiListDivider-insetStartDecorator	insetStartDecorator	Class name applied to the root element if `inset="startDecorator"`.
.MuiListDivider-vertical	vertical	Class name applied to the root element if `orientation="vertical"`.

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

With a global class name.
With a rule name as part of the component's styleOverrides property in a custom theme.