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';Props of the native component are also available.
Override or extend the styles applied to the component.
See CSS API below for more details.
Type:object
The dot can have a different colors.
Type:'error'
| 'grey'
| 'info'
| 'inherit'
| 'primary'
| 'secondary'
| 'success'
| 'warning'
| string
Default:'grey'
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
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.
These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.
Styles applied to the root element if color="grey" and variant="filled".
Rule name:filledGrey
Styles applied to the root element if color="primary" and variant="filled".
Rule name:filledPrimary
Styles applied to the root element if color="secondary" and variant="filled".
Rule name:filledSecondary
Styles applied to the root element if color="grey" and variant="outlined".
Rule name:outlinedGrey
Styles applied to the root element if color="primary" and variant="outlined".
Rule name:outlinedPrimary
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:
- With a global class name.
- With a rule name as part of the component's
styleOverridesproperty in a custom theme.