TimelineDot API

API documentation for the React TimelineDot component. Learn about the available props, and the CSS API.

Import

import TimelineDot from '@material-ui/lab/TimelineDot';
// 或
import { TimelineDot } from '@material-ui/lab';

The name MuiTimelineDot can be used when providing default props or style overrides in the theme.

名称	类型	默认值	描述
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	'grey' \| 'inherit' \| 'primary' \| 'secondary'	'grey'	The dot can have a different colors.
sx	object
variant	'filled' \| 'outlined' \| string	'filled'	The dot can appear filled or outlined.

ref 则会被传递到根元素中。
Any other props supplied will be provided to the root element (native element).

Rule name	Global class	描述
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.