TimelineDot API

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

Import

import TimelineDot from '@material-ui/lab/TimelineDot';
// or
import { TimelineDot } from '@material-ui/lab';

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

Component name

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

Props

Name	Type	Default	Description
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.
color	'grey' | 'inherit' | 'primary' | 'secondary'	'grey'	The dot can have a different colors.
variant	'default' | 'outlined'	'default'	The dot can appear filled or outlined.

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	.MuiTimelineDot-root	Styles applied to the root element.
defaultGrey	.MuiTimelineDot-defaultGrey	Styles applied to the root element if color="grey" and variant="default".
outlinedGrey	.MuiTimelineDot-outlinedGrey	Styles applied to the root element if color="grey" and variant="outlined".
defaultPrimary	.MuiTimelineDot-defaultPrimary	Styles applied to the root element if color="primary" and variant="default".
outlinedPrimary	.MuiTimelineDot-outlinedPrimary	Styles applied to the root element if color="primary" and variant="outlined".
defaultSecondary	.MuiTimelineDot-defaultSecondary	Styles applied to the root element if color="secondary" and variant="default".
outlinedSecondary	.MuiTimelineDot-outlinedSecondary	Styles applied to the root element if color="secondary" and variant="outlined".

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.

Demos

• Timeline