Skip to content

Divider API

API documentation for the React Divider component. Learn about the available props, and the CSS API.

Import

import Divider from '@material-ui/core/Divider';
// or
import { Divider } from '@material-ui/core';
You can learn about the difference by reading this guide on minimizing bundle size.

Component name

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

Props

NameTypeDefaultDescription
absoluteboolfalseAbsolutely position the element.
childrennodeThe content of the component.
classesobjectOverride or extend the styles applied to the component. See CSS API below for more details.
componentelementTypeThe component used for the root node. Either a string to use a HTML element or a component.
flexItemboolfalseIf true, a vertical divider will have the correct height when used in flex container. (By default, a vertical divider will have a calculated height of 0px if it is the child of a flex container.)
lightboolfalseIf true, the divider will have a lighter color.
orientation'horizontal'
| 'vertical'
'horizontal'The component orientation.
textAlign'center'
| 'left'
| 'right'
'center'The text alignment.
variant'fullWidth'
| 'inset'
| 'middle'
| string
'fullWidth'The variant to use.

The ref is forwarded to the root element.
Any other props supplied will be provided to the root element (native element).

CSS

Rule nameGlobal classDescription
root.MuiDivider-rootStyles applied to the root element.
absolute.MuiDivider-absoluteStyles applied to the root element if absolute={true}.
inset.MuiDivider-insetStyles applied to the root element if variant="inset".
fullWidth.MuiDivider-fullWidthStyles applied to the root element if variant="fullWidth".
light.MuiDivider-lightStyles applied to the root element if light={true}.
middle.MuiDivider-middleStyles applied to the root element if variant="middle".
vertical.MuiDivider-verticalStyles applied to the root element if orientation="vertical".
flexItem.MuiDivider-flexItemStyles applied to the root element if flexItem={true}.
withChildren.MuiDivider-withChildrenStyles applied to the root element if divider have text.
withChildrenVertical.MuiDivider-withChildrenVerticalStyles applied to the root element if divider have text and orientation="vertical".
textAlignRight.MuiDivider-textAlignRightStyles applied to the root element if textAlign="right" orientation="horizontal".
textAlignLeft.MuiDivider-textAlignLeftStyles applied to the root element if textAlign="left" orientation="horizontal".
wrapper.MuiDivider-wrapperStyles applied to the span children element if orientation="horizontal".
wrapperVertical.MuiDivider-wrapperVerticalStyles applied to the span children element if orientation="vertical".

You can override the style of the component using one of these customization options: If that isn't sufficient, you can check the implementation of the component for more detail.

Demos