Timeline API

API reference docs for the React Timeline 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 Timeline from '@mui/lab/Timeline';
// or
import { Timeline } 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 API below for more details.
className	string		className applied to the root element.
position	'alternate-reverse' \| 'alternate' \| 'left' \| 'right'	'right'	The position where the TimelineContent should appear relative to the time axis.
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.

The ref is forwarded to the root element.

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

The following class names are useful for styling with CSS (the state classes are marked).
To learn more, visit the component customization page.

Rule name	Global class	Description
root	.MuiTimeline-root	Styles applied to the root element.
positionLeft	.MuiTimeline-positionLeft	Styles applied to the root element if `position="left"`.
positionRight	.MuiTimeline-positionRight	Styles applied to the root element if `position="right"`.
positionAlternate	.MuiTimeline-positionAlternate	Styles applied to the root element if `position="alternate"`.
positionAlternateReverse	.MuiTimeline-positionAlternateReverse	Styles applied to the root element if `position="alternate-reverse"`.

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.