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.

Component name

The name JoyListDivider can be used when providing default props or style overrides in the theme.

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