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';
Component name
The nameMuiDivider
can be used when providing default props or style overrides in the theme.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 | 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 using one of these customization options:
- With a rule name of the
classes
object prop. - With a global class name.
- With a theme and an
styleOverrides
property.