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';
Component name
The nameMuiTimelineDot
can be used when providing default props or style overrides in the theme.Props
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 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.CSS
Rule name | Global class | Description |
---|---|---|
root | .MuiTimelineDot-root | Styles applied to the root element. |
filled | .MuiTimelineDot-filled | Styles applied to the root element if variant="filled" . |
outlined | .MuiTimelineDot-outlined | Styles applied to the root element if variant="outlined" . |
filledGrey | .MuiTimelineDot-filledGrey | Styles applied to the root element if color="grey" and variant="filled" . |
outlinedGrey | .MuiTimelineDot-outlinedGrey | Styles applied to the root element if color="grey" and variant="outlined" . |
filledPrimary | .MuiTimelineDot-filledPrimary | Styles applied to the root element if color="primary" and variant="filled" . |
outlinedPrimary | .MuiTimelineDot-outlinedPrimary | Styles applied to the root element if color="primary" and variant="outlined" . |
filledSecondary | .MuiTimelineDot-filledSecondary | Styles applied to the root element if color="secondary" and variant="filled" . |
outlinedSecondary | .MuiTimelineDot-outlinedSecondary | 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:
- With a global class name.
- With a rule name as part of the component's
styleOverrides
property in a custom theme.