Skip to content
Edit this page

TimelineItem API

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

Import

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

Component name

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

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.
position'left'
| 'right'
The position where the timeline's item should appear.
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.

CSS

Rule nameGlobal classDescription
root.MuiTimelineItem-rootStyles applied to the root element.
positionLeft.MuiTimelineItem-positionLeftStyles applied to the root element if position="left".
positionRight.MuiTimelineItem-positionRightStyles applied to the root element if position="right".
positionAlternate.MuiTimelineItem-positionAlternateStyles applied to the root element if position="alternate".
missingOppositeContent.MuiTimelineItem-missingOppositeContentStyles applied to the root element if TimelineOppositeContent isn't provided.

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

Demos