Skip to content
Edit this page

Timeline API

API documentation for the React Timeline component. Learn about the available props, and the CSS API.

Import

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

Component name

The name MuiTimeline can be used when providing default props or style overrides in the theme.

Props

NameTypeDefaultDescription
align'alternate'
| 'left'
| 'right'		'left'The position where the timeline's content should appear.
childrennodeThe content of the component.
classesobjectOverride or extend the styles applied to the component. See CSS API below for more details.

The ref is forwarded to the root element.
Any other props supplied will be provided to the root element (native element).

CSS

Rule nameGlobal classDescription
root.MuiTimeline-rootStyles applied to the root element.
alignLeft.MuiTimeline-alignLeftStyles applied to the root element if align="left".
alignRight.MuiTimeline-alignRightStyles applied to the root element if align="right".
alignAlternate.MuiTimeline-alignAlternateStyles applied to the root element if align="alternate".

You can override the style of the component using one of these customization options: If that isn't sufficient, you can check the implementation of the component for more detail.

Demos