2016-07-04 10:49:04 +08:00
|
|
|
---
|
|
|
|
category: Components
|
2016-11-09 14:43:32 +08:00
|
|
|
type: Data Display
|
2016-07-04 10:49:04 +08:00
|
|
|
title: Timeline
|
|
|
|
---
|
|
|
|
|
|
|
|
Vertical display timeline.
|
|
|
|
|
|
|
|
## When To Use
|
|
|
|
|
2016-11-29 17:13:24 +08:00
|
|
|
- When a series of information need to be ordered from top to bottom by time.
|
|
|
|
- When you need a timeline to make a visual connection.
|
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
|
|
|
|
|
|
|
|
| Property | Description | Type | Default |
|
|
|
|
|----------|----------------------------------------|------------|-------|
|
|
|
|
| pending | to set the last ghost node's existence or its content | boolean or React.Element | false |
|
|
|
|
|
|
|
|
### Timeline.Item
|
|
|
|
|
|
|
|
Node of timeline
|
|
|
|
|
|
|
|
| Property | Description | Type | Default |
|
|
|
|
|----------|------------------------------------------|------------|-------|
|
|
|
|
| color | to set the circle's color to `blue, red, green` or other custom colors | string | blue |
|
|
|
|
| dot | custom timeline dot | React.Element | - |
|