Timeline API
API documentation for the React Timeline component. Learn about the available props, and the CSS API.
Import
import Timeline from '@mui/lab/Timeline';
// 或
import { Timeline } from '@mui/lab';
Component name
The nameMuiTimeline
can be used when providing default props or style overrides in the theme.属性
Props of the 原生(Native) component are also available.
名称 | 类型 | 默认值 | 描述 |
---|---|---|---|
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. | |
className | string | className applied to the root element. | |
position | 'alternate' | 'left' | 'right' | 'right' | The position where the TimelineContent should appear relative to the time axis. |
sx | func | object | The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details. |
ref
则会被传递到根元素中。CSS
Rule name | Global class | 描述 |
---|---|---|
root | .MuiTimeline-root | Styles applied to the root element. |
positionLeft | .MuiTimeline-positionLeft | Styles applied to the root element if position="left" . |
positionRight | .MuiTimeline-positionRight | Styles applied to the root element if position="right" . |
positionAlternate | .MuiTimeline-positionAlternate | Styles applied to the root element if position="alternate" . |
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.