Skip to content
Edit this page

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';
You can learn about the difference by reading this guide on minimizing bundle size.

Component name

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

Props

Props of the native component are also available.

NameTypeDefaultDescription
childrennode
The content of the component.
classesobject
Override or extend the styles applied to the component. See CSS API below for more details.
color'error'
| 'grey'
| 'info'
| 'inherit'
| 'primary'
| 'secondary'
| 'success'
| 'warning'		'grey'
The dot can have a different colors.
sxobject
The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.
variant'filled'
| 'outlined'
| string		'filled'
The dot can appear filled or outlined.

The ref is forwarded to the root element.

CSS

Rule nameGlobal classDescription
root.MuiTimelineDot-rootStyles applied to the root element.
filled.MuiTimelineDot-filledStyles applied to the root element if variant="filled".
outlined.MuiTimelineDot-outlinedStyles applied to the root element if variant="outlined".
filledGrey.MuiTimelineDot-filledGreyStyles applied to the root element if color="grey" and variant="filled".
outlinedGrey.MuiTimelineDot-outlinedGreyStyles applied to the root element if color="grey" and variant="outlined".
filledPrimary.MuiTimelineDot-filledPrimaryStyles applied to the root element if color="primary" and variant="filled".
outlinedPrimary.MuiTimelineDot-outlinedPrimaryStyles applied to the root element if color="primary" and variant="outlined".
filledSecondary.MuiTimelineDot-filledSecondaryStyles applied to the root element if color="secondary" and variant="filled".
outlinedSecondary.MuiTimelineDot-outlinedSecondaryStyles 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:

Demos