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.

Component 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.

children

The content of the component.

Type:node

classes

Override or extend the styles applied to the component.

See CSS API below for more details.

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.

See the `sx` page for more details.

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-root

Styles applied to the root element.

Rule name:root

.MuiTimelineDot-filled

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

Rule name:filled

.MuiTimelineDot-outlined

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

Rule name:outlined

.MuiTimelineDot-filledGrey

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

Rule name:filledGrey

.MuiTimelineDot-outlinedGrey

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

Rule name:outlinedGrey

.MuiTimelineDot-filledPrimary

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

Rule name:filledPrimary

.MuiTimelineDot-outlinedPrimary

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

Rule name:outlinedPrimary

.MuiTimelineDot-filledSecondary

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

Rule name:filledSecondary

.MuiTimelineDot-outlinedSecondary

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

Rule name:outlinedSecondary


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