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. |
classes | object | Override or extend the styles applied to the component. See CSS API below for more details. | |
component | elementType | '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. |
variant | 'fullWidth' | 'inset' | 'middle' |
'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" . |
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} . |
You can override the style of the component thanks to one of these customization points:
- With a rule name of the
classes
object prop. - With a global class name.
- With a theme and an
overrides
property.
If that's not sufficient, you can check the implementation of the component for more detail.