Skip to content
Edit this page

Divider API

The API documentation of the Divider React component. Learn more about the props and the CSS customization points.

Import

import Divider from '@material-ui/core/Divider';
// or
import { Divider } from '@material-ui/core';

You can learn more about the difference by reading this guide.

Component name

The MuiDivider name can be used for providing default props or style overrides at the theme level.

Props

Name Type Default Description
absolute bool false Absolutely position the element.
children node The content of the component.
classes object Override or extend the styles applied to the component. See CSS API below for more details.
component elementType children ? 'div' : 'hr' The component used for the root node. Either a string to use a HTML element or a component.
flexItem bool false If 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.)
light bool false If true, the divider will have a lighter color.
orientation 'horizontal'
| 'vertical'		 'horizontal' The divider 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 name Global class Description
root .MuiDivider-root Styles applied to the root element.
absolute .MuiDivider-absolute Styles applied to the root element if absolute={true}.
inset .MuiDivider-inset Styles applied to the root element if variant="inset".
fullWidth .MuiDivider-fullWidth Styles applied to the root element if variant="fullWidth".
light .MuiDivider-light Styles applied to the root element if light={true}.
middle .MuiDivider-middle Styles applied to the root element if variant="middle".
vertical .MuiDivider-vertical Styles applied to the root element if orientation="vertical".
flexItem .MuiDivider-flexItem Styles applied to the root element if flexItem={true}.
withChildren .MuiDivider-withChildren Styles applied to the root element if divider have text.
withChildrenVertical .MuiDivider-withChildrenVertical Styles applied to the root element if divider have text and orientation="vertical".
textAlignRight .MuiDivider-textAlignRight Styles applied to the root element if textAlign="right" orientation="horizontal".
textAlignLeft .MuiDivider-textAlignLeft Styles applied to the root element if textAlign="left" orientation="horizontal".
wrapper .MuiDivider-wrapper Styles applied to the span children element if orientation="horizontal".
wrapperVertical .MuiDivider-wrapperVertical Styles applied to the span children element if orientation="vertical".

You can override the style of the component thanks to one of these customization points:

If that's not sufficient, you can check the implementation of the component for more detail.

Demos