ant-design/components/timeline/index.en-US.md

47 lines
1.4 KiB
Markdown
Raw Normal View History

---
category: Components
type: Data Display
title: Timeline
cover: https://gw.alipayobjects.com/zos/antfincdn/vJmo00mmgR/Timeline.svg
---
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.
## 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
| Property | Description | Type | Default |
| --- | --- | --- | --- |
| 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 | &lt;LoadingOutlined /> |
| reverse | Whether reverse nodes or not | boolean | false |
### Timeline.Item
Node of timeline
| 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 | - |
| label | Set the label | ReactNode | - |
| position | Customize node position | `left` \| `right` | - |