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.

Component 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.

children

The content of the component.

Type:node

classes

Override or extend the styles applied to the component.

See CSS API below for more details.

Type:object

className

className applied to the root element.

Type:string

position

The position where the TimelineContent should appear relative to the time axis.

Type:'alternate-reverse'
| 'alternate'
| 'left'
| 'right'

Default:'right'

sx

The system prop that allows defining system overrides as well as additional CSS styles.

See the `sx` page for more details.

Type:Array<func
| object
| bool>
| func
| object

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.

.MuiTimeline-positionAlternate

Styles applied to the root element if position="alternate".

Rule name:positionAlternate

.MuiTimeline-positionAlternateReverse

Styles applied to the root element if position="alternate-reverse".

Rule name:positionAlternateReverse

.MuiTimeline-positionLeft

Styles applied to the root element if position="left".

Rule name:positionLeft

.MuiTimeline-positionRight

Styles applied to the root element if position="right".

Rule name:positionRight

.MuiTimeline-root

Styles applied to the root element.

Rule name:root


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