2016-07-04 10:49:04 +08:00
|
|
|
---
|
|
|
|
|
category: Components
|
2022-11-09 12:28:04 +08:00
|
|
|
group: Data Display
|
2016-07-04 10:49:04 +08:00
|
|
|
title: Timeline
|
2022-11-30 20:14:41 +08:00
|
|
|
cover: https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*FkTySqNt3sYAAAAAAAAAAAAADrJ8AQ/original
|
2022-11-09 12:28:04 +08:00
|
|
|
demo:
|
|
|
|
|
cols: 2
|
2016-07-04 10:49:04 +08:00
|
|
|
---
|
|
|
|
|
|
|
|
|
|
Vertical display timeline.
|
|
|
|
|
|
|
|
|
|
## When To Use
|
|
|
|
|
|
2019-04-20 06:39:34 +08:00
|
|
|
- When a series of information needs to be ordered by time (ascending or descending).
|
2016-11-29 17:13:24 +08:00
|
|
|
- When you need a timeline to make a visual connection.
|
2016-07-04 10:49:04 +08:00
|
|
|
|
2022-11-09 12:28:04 +08:00
|
|
|
## Examples
|
|
|
|
|
|
2022-11-17 17:31:26 +08:00
|
|
|
<!-- prettier-ignore -->
|
2022-11-09 12:28:04 +08:00
|
|
|
<code src="./demo/basic.tsx">Basic</code>
|
|
|
|
|
<code src="./demo/color.tsx">Color</code>
|
|
|
|
|
<code src="./demo/pending.tsx">Last node and Reversing</code>
|
|
|
|
|
<code src="./demo/alternate.tsx">Alternate</code>
|
|
|
|
|
<code src="./demo/custom.tsx">Custom</code>
|
|
|
|
|
<code src="./demo/right.tsx">Right alternate</code>
|
|
|
|
|
<code src="./demo/label.tsx">Label</code>
|
2022-12-06 23:14:30 +08:00
|
|
|
<code src="./demo/wireframe.tsx" debug>Wireframe</code>
|
2022-11-09 12:28:04 +08:00
|
|
|
|
2016-07-04 10:49:04 +08:00
|
|
|
## API
|
|
|
|
|
|
|
|
|
|
```jsx
|
|
|
|
|
<Timeline>
|
|
|
|
|
<Timeline.Item>step1 2015-09-01</Timeline.Item>
|
|
|
|
|
<Timeline.Item>step2 2015-09-01</Timeline.Item>
|
|
|
|
|
<Timeline.Item>step3 2015-09-01</Timeline.Item>
|
|
|
|
|
<Timeline.Item>step4 2015-09-01</Timeline.Item>
|
|
|
|
|
</Timeline>
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Timeline
|
|
|
|
|
|
|
|
|
|
Timeline
|
|
|
|
|
|
2019-11-21 10:23:34 +08:00
|
|
|
| Property | Description | Type | Default |
|
|
|
|
|
| --- | --- | --- | --- |
|
2020-10-21 10:33:43 +08:00
|
|
|
| mode | By sending `alternate` the timeline will distribute the nodes to the left and right | `left` \| `alternate` \| `right` | - |
|
2020-10-09 10:08:52 +08:00
|
|
|
| pending | Set the last ghost node's existence or its content | boolean \| ReactNode | false |
|
|
|
|
|
| pendingDot | Set the dot of the last ghost node when pending is true | ReactNode | <LoadingOutlined /> |
|
2020-07-02 11:56:48 +08:00
|
|
|
| reverse | Whether reverse nodes or not | boolean | false |
|
2016-07-04 10:49:04 +08:00
|
|
|
|
|
|
|
|
### Timeline.Item
|
|
|
|
|
|
|
|
|
|
Node of timeline
|
|
|
|
|
|
2019-11-21 10:23:34 +08:00
|
|
|
| Property | Description | Type | Default |
|
|
|
|
|
| --- | --- | --- | --- |
|
|
|
|
|
| color | Set the circle's color to `blue`, `red`, `green`, `gray` or other custom colors | string | `blue` |
|
2020-10-09 10:08:52 +08:00
|
|
|
| dot | Customize timeline dot | ReactNode | - |
|
2020-02-26 17:21:44 +08:00
|
|
|
| label | Set the label | ReactNode | - |
|
2020-10-21 10:33:43 +08:00
|
|
|
| position | Customize node position | `left` \| `right` | - |
|
