vant/src/steps/README.md
2019-08-27 22:09:21 +08:00

88 lines
1.6 KiB
Markdown

# Steps
### Install
``` javascript
import Vue from 'vue';
import { Step, Steps } from 'vant';
Vue.use(Step).use(Steps);
```
## Usage
### Basic Usage
```html
<van-steps :active="active">
<van-step>Step1</van-step>
<van-step>Step2</van-step>
<van-step>Step3</van-step>
<van-step>Step4</van-step>
</van-steps>
```
```javascript
export default {
data() {
return {
active: 1
};
}
}
```
### Custom Style
```html
<van-steps
:active="active"
active-icon="success"
active-color="#38f"
>
<van-step>Step1</van-step>
<van-step>Step2</van-step>
<van-step>Step3</van-step>
<van-step>Step4</van-step>
</van-steps>
```
### Vertical Steps
```html
<van-steps direction="vertical" :active="0">
<van-step>
<h3>【City】Status1</h3>
<p>2016-07-12 12:40</p>
</van-step>
<van-step>
<h3>【City】Status2</h3>
<p>2016-07-11 10:00</p>
</van-step>
<van-step>
<h3>【City】Status3</h3>
<p>2016-07-10 09:30</p>
</van-step>
</van-steps>
```
## API
### Steps Props
| Attribute | Description | Type | Default | Version |
|------|------|------|------|------|
| active | Active step | *number* | 0 | - |
| description | Description | *string* | - | - |
| direction | Can be set to `vertical` | *string* | `horizontal` | - |
| active-color | Active step color | *string* | `#07c160` | - |
| active-icon | Active icon name | *string* | `checked` | - |
| inactive-icon | Active icon name | *string* | - | - |
### Step Slots
| Name | Description |
|------|------|
| active-icon | Custom active icon |
| inactive-icon | Custom inactive icon |