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 TimelineDot from '@mui/lab/TimelineDot';
// or
import { TimelineDot } from '@mui/lab';

Props of the native component are also available.

Name	Type	Default	Description
children	node	-	The content of the component.
classes	object	-	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.
sx	Array<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.

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

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

Class name	Rule name	Description
.MuiTimelineDot-filled	filled	Styles applied to the root element if `variant="filled"`.
.MuiTimelineDot-filledGrey	filledGrey	Styles applied to the root element if `color="grey"` and `variant="filled"`.
.MuiTimelineDot-filledPrimary	filledPrimary	Styles applied to the root element if `color="primary"` and `variant="filled"`.
.MuiTimelineDot-filledSecondary	filledSecondary	Styles applied to the root element if `color="secondary"` and `variant="filled"`.
.MuiTimelineDot-outlined	outlined	Styles applied to the root element if `variant="outlined"`.
.MuiTimelineDot-outlinedGrey	outlinedGrey	Styles applied to the root element if `color="grey"` and `variant="outlined"`.
.MuiTimelineDot-outlinedPrimary	outlinedPrimary	Styles applied to the root element if `color="primary"` and `variant="outlined"`.
.MuiTimelineDot-outlinedSecondary	outlinedSecondary	Styles applied to the root element if `color="secondary"` and `variant="outlined"`.
.MuiTimelineDot-root	root	Styles applied to the root element.

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

With a global class name.
With a rule name as part of the component's styleOverrides property in a custom theme.

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