Skip to content

Timeline API

API reference docs for the React Timeline component. Learn about the props, CSS, and other APIs of this exported module.

Demos

Import

import Timeline from '@mui/lab/Timeline';
// or
import { Timeline } from '@mui/lab';

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 classes 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 classes

These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.

Class nameRule nameDescription
.MuiTimeline-positionAlternatepositionAlternateStyles applied to the root element if position="alternate".
.MuiTimeline-positionAlternateReversepositionAlternateReverseStyles applied to the root element if position="alternate-reverse".
.MuiTimeline-positionLeftpositionLeftStyles applied to the root element if position="left".
.MuiTimeline-positionRightpositionRightStyles applied to the root element if position="right".
.MuiTimeline-rootrootStyles applied to the root element.

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

Source code

If you did not find the information in this page, consider having a look at the implementation of the component for more detail.