Skip to content
Edit this page

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

import Timeline from '@mui/lab/Timeline';
// or
import { Timeline } from '@mui/lab';
You can learn about the difference by reading this guide on minimizing bundle size.

Props

Props of the native component are also available.

NameTypeDefaultDescription
childrennode
The content of the component.
classesobject
Override or extend the styles applied to the component. See CSS API below for more details.
classNamestring
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.
sxArray<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.

Theme default props

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

CSS

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

Rule nameGlobal classDescription
root.MuiTimeline-rootStyles applied to the root element.
positionLeft.MuiTimeline-positionLeftStyles applied to the root element if position="left".
positionRight.MuiTimeline-positionRightStyles applied to the root element if position="right".
positionAlternate.MuiTimeline-positionAlternateStyles applied to the root element if position="alternate".
positionAlternateReverse.MuiTimeline-positionAlternateReverseStyles applied to the root element if position="alternate-reverse".

You can override the style of the component using one of these customization options: