TimelineDot API

API documentation for the React TimelineDot component. Learn about the available props, and the CSS API.

Import

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

The name MuiTimelineDot can be used when providing default props or style overrides in the theme.

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' \| string	'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).

Rule name	Global class	Description
root	.MuiTimelineDot-root	Styles applied to the root element.
filled	.MuiTimelineDot-filled	Styles applied to the root element if `variant="filled"`.
outlined	.MuiTimelineDot-outlined	Styles applied to the root element if `variant="outlined"`.
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 using one of these customization options:

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