Timeline API

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

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

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'

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.

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

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:

With a global class name.
With a rule name as part of the component's styleOverrides property in a custom theme.