Skip to content
Edit this page

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 'filled'
| 'outlined'		 'filled' 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.
filledGrey .MuiTimelineDot-filledGrey Styles applied to the root element if color="grey" and variant="filled".
outlinedGrey .MuiTimelineDot-outlinedGrey Styles applied to the root element if color="grey" and variant="outlined".
filledPrimary .MuiTimelineDot-filledPrimary Styles applied to the root element if color="primary" and variant="filled".
outlinedPrimary .MuiTimelineDot-outlinedPrimary Styles applied to the root element if color="primary" and variant="outlined".
filledSecondary .MuiTimelineDot-filledSecondary Styles applied to the root element if color="secondary" and variant="filled".
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:

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

Demos