Skip to content
Edit this page

TimelineDot API

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

Demos

For examples and details on the usage of this React component, visit the component demo pages:

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.

children

The content of the component.

Type:

node
classes

Override or extend the styles applied to the component.

Type:

object
color

The dot can have a different colors.

Type:

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

Default:

'grey'
sx

The system prop that allows defining system overrides as well as additional CSS styles.

Type:

Array<func | object | bool> | func | object
variant

The dot can appear filled or outlined.

Type:

'filled' | 'outlined' | string

Default:

'filled'
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

The following class names are useful for styling with CSS (the state classes are marked).
To learn more, visit the component customization page.

.MuiTimelineDot-rootroot

Styles applied to the root element.

.MuiTimelineDot-filledfilled

Styles applied to the root element if variant="filled".

.MuiTimelineDot-outlinedoutlined

Styles applied to the root element if variant="outlined".

.MuiTimelineDot-filledGreyfilledGrey

Styles applied to the root element if color="grey" and variant="filled".

.MuiTimelineDot-outlinedGreyoutlinedGrey

Styles applied to the root element if color="grey" and variant="outlined".

.MuiTimelineDot-filledPrimaryfilledPrimary

Styles applied to the root element if color="primary" and variant="filled".

.MuiTimelineDot-outlinedPrimaryoutlinedPrimary

Styles applied to the root element if color="primary" and variant="outlined".

.MuiTimelineDot-filledSecondaryfilledSecondary

Styles applied to the root element if color="secondary" and variant="filled".

.MuiTimelineDot-outlinedSecondaryoutlinedSecondary

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: