Divider API
API reference docs for the React Divider component. Learn about the props, CSS, and other APIs of this exported module.
Demos
Import
import Divider from '@mui/joy/Divider';
// or
import { Divider } from '@mui/joy';Learn about the difference by reading this guide on minimizing bundle size.
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 | 'none' | 'context' | string | - | Class name applied to the divider to shrink or stretch the line based on the orientation. |
| 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. |
ref is forwarded to the root element.Theme default props
You can use JoyDivider 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 | .MuiDivider-root | 'hr' | 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 |
|---|---|---|
| .MuiDivider-horizontal | horizontal | Class name applied to the root element if orientation="horizontal". |
| .MuiDivider-insetContext | insetContext | Class name applied to the root element if inset="context". |
| .MuiDivider-insetNone | insetNone | Class name applied to the root element if inset="none". |
| .MuiDivider-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
styleOverridesproperty in a custom theme.