Timeline API

The API documentation of the Timeline React component. Learn more about the props and the CSS customization points.

Import

import Timeline from '@material-ui/lab/Timeline';
// or
import { Timeline } from '@material-ui/lab';

You can learn more about the difference by reading this guide.

Component name

The MuiTimeline name can be used for providing default props or style overrides at the theme level.

Props

Name	Type	Default	Description
align	'alternate' | 'left' | 'right'	'left'	The position where the timeline's content should appear.
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.

The ref is forwarded to the root element.

Any other props supplied will be provided to the root element (native element).

CSS

Rule name	Global class	Description
root	.MuiTimeline-root	Styles applied to the root element.
alignLeft	.MuiTimeline-alignLeft	Styles applied to the root element if align="left".
alignRight	.MuiTimeline-alignRight	Styles applied to the root element if align="right".
alignAlternate	.MuiTimeline-alignAlternate	Styles applied to the root element if align="alternate".

You can override the style of the component thanks to one of these customization points:

• With a rule name of the classes object prop.
• With a global class name.
• With a theme and an overrides property.

If that's not sufficient, you can check the implementation of the component for more detail.

Demos

• Timeline