TimelineItem API
API documentation for the React TimelineItem component. Learn about the available props, and the CSS API.
Import
import TimelineItem from '@material-ui/lab/TimelineItem';
// or
import { TimelineItem } from '@material-ui/lab';
Component name
The nameMuiTimelineItem
can be used when providing default props or style overrides in the theme.Props
Name | Type | Default | Description |
---|---|---|---|
children | node | The content of the component. | |
classes | object | 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. | |
sx | 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.Any other props supplied will be provided to the root element (native element).
CSS
Rule name | Global class | Description |
---|---|---|
root | .MuiTimelineItem-root | Styles applied to the root element. |
positionLeft | .MuiTimelineItem-positionLeft | Styles applied to the root element if position="left" . |
positionRight | .MuiTimelineItem-positionRight | Styles applied to the root element if position="right" . |
positionAlternate | .MuiTimelineItem-positionAlternate | Styles applied to the root element if position="alternate" . |
missingOppositeContent | .MuiTimelineItem-missingOppositeContent | Styles applied to the root element if TimelineOppositeContent isn't provided. |
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.