[Improvement] Reorganize document (#1066)

This commit is contained in:
neverland
2018-05-15 10:39:01 +08:00
committed by GitHub
parent b1142fd862
commit e8aad7246c
124 changed files with 181 additions and 186 deletions
+66
View File
@@ -0,0 +1,66 @@
## Slider
### Install
``` javascript
import { Slider } from 'vant';
Vue.use(Slider);
```
### Usage
#### Basic Usage
```html
<van-slider v-model="value" @change="onChange" />
```
```js
export default {
data() {
return {
value: 50
};
},
methods: {
onChange(value) {
this.$toast('Current value' + value);
}
}
};
```
#### Range
```html
<van-slider v-model="value" :min="10" :max="90" />
```
#### Disabled
```html
<van-slider v-model="value" disabled />
```
#### Step size
```html
<van-slider v-model="value" :step="10" bar-height="4px" />
```
### API
| Attribute | Description | Type | Default |
|-----------|-----------|-----------|-------------|-------------|
| value | Current value | `Number` | `0` |
| disabled | Whether to disable slider | `Boolean` | `false` |
| max | Max value | `Number` | `100` |
| min | Min value | `Number` | `0` |
| step | Step size | `Number` | `1` |
| bar-height | Height of bar | `String` | `2px` |
### Event
| Event | Description | Arguments |
|-----------|-----------|-----------|
| change | Triggered after value change | value: current rate |
+65
View File
@@ -0,0 +1,65 @@
## Slider 滑块
### 使用指南
``` javascript
import { Slider } from 'vant';
Vue.use(Slider);
```
#### 基本用法
```html
<van-slider v-model="value" @change="onChange" />
```
```js
export default {
data() {
return {
value: 50
};
},
methods: {
onChange(value) {
this.$toast('当前值:' + value);
}
}
};
```
#### 指定选择范围
```html
<van-slider v-model="value" :min="10" :max="90" />
```
#### 禁用
```html
<van-slider v-model="value" disabled />
```
#### 指定步长
```html
<van-slider v-model="value" :step="10" bar-height="4px" />
```
### API
| 参数 | 说明 | 类型 | 默认值 |
|-----------|-----------|-----------|-------------|
| value | 当前进度百分比 | `Number` | `0` |
| disabled | 是否禁用滑块 | `Boolean` | `false` |
| max | 最大值 | `Number` | `100` |
| min | 最小值 | `Number` | `0` |
| step | 步长 | `Number` | `1` |
| bar-height | 进度条高度 | `String` | `2px` |
### Event
| 事件名 | 说明 | 参数 |
|-----------|-----------|-----------|
| change | 进度值改变后触发 | value: 当前进度 |