Skip to content

TimelineDot API

API reference docs for the React TimelineDot component. Learn about the props, CSS, and other APIs of this exported module.

Demos

Import

import TimelineDot from '@mui/lab/TimelineDot';
// or
import { TimelineDot } from '@mui/lab';

Learn about the difference by reading this guide on minimizing bundle size.

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 classes API below for more details.

color'error'
| 'grey'
| 'info'
| 'inherit'
| 'primary'
| 'secondary'
| 'success'
| 'warning'
| string
'grey'

The dot can have a different colors.

sxArray<func
| object
| bool>
| func
| object
-

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.

Theme default props

You can use MuiTimelineDot to change the default props of this component with the theme.

CSS classes

These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.

Class nameRule nameDescription
.MuiTimelineDot-filledfilledStyles applied to the root element if variant="filled".
.MuiTimelineDot-filledGreyfilledGreyStyles applied to the root element if color="grey" and variant="filled".
.MuiTimelineDot-filledPrimaryfilledPrimaryStyles applied to the root element if color="primary" and variant="filled".
.MuiTimelineDot-filledSecondaryfilledSecondaryStyles applied to the root element if color="secondary" and variant="filled".
.MuiTimelineDot-outlinedoutlinedStyles applied to the root element if variant="outlined".
.MuiTimelineDot-outlinedGreyoutlinedGreyStyles applied to the root element if color="grey" and variant="outlined".
.MuiTimelineDot-outlinedPrimaryoutlinedPrimaryStyles applied to the root element if color="primary" and variant="outlined".
.MuiTimelineDot-outlinedSecondaryoutlinedSecondaryStyles applied to the root element if color="secondary" and variant="outlined".
.MuiTimelineDot-rootrootStyles applied to the root element.

You can override the style of the component using one of these customization options:

Source code

If you did not find the information in this page, consider having a look at the implementation of the component for more detail.