alighasami/vant
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

docs: prettier all markdown files

Browse Source
This commit is contained in:
chenjiahan
2020-04-11 09:17:33 +08:00
committed by neverland
parent 48067f79db
commit 7f84f8a487
140 changed files with 4441 additions and 4723 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/stepper/README.md
+33 -37
View File
@@ -21,10 +21,10 @@ Vue.use(Stepper);
export default {
data() {
return {
value: 1
}
}
}
value: 1,
};
},
};
```
### Step
@@ -72,11 +72,7 @@ export default {
### Async Change
```html
<van-stepper
:value="value"
async-change
@change="onChange"
/>
<van-stepper :value="value" async-change @change="onChange" />
```
```js
@@ -85,8 +81,8 @@ import { Toast } from 'vant';
export default {
data() {
return {
value: 1
}
value: 1,
};
},
methods: {
onChange(value) {
@@ -96,9 +92,9 @@ export default {
Toast.clear();
this.value = value;
}, 500);
}
}
}
},
},
};
```
## API
@@ -106,33 +102,33 @@ export default {
### Props
| Attribute | Description | Type | Default |
|------|------|------|------|
| v-model | Current value | *number \| string* | - |
| min | Min value | *number \| string* | `1` |
| max | Max value | *number \| string* | - |
| default-value | Default value, valid when v-model is empty | *number \| string* | `1` |
| step | Value change step | *number \| string* | `1` |
| name `v2.0.3` | Stepper name | *number \| string* | - |
| input-width | Input width | *number \| string* | `32px` |
| button-size `v2.0.5` | Button size | *number \| string* | `28px` |
| decimal-length `v2.2.1` | Decimal length | *number \| string* | - |
| integer | Whether to allow only integers | *boolean* | `false` |
| disabled | Disable value change | *boolean* | `false` |
| disable-plus `v2.2.16` | Whether to disable plus button | *boolean* | `false` |
| disable-minus `v2.2.16` | Whether to disable minus button | *boolean* | `false` |
| disable-input | Whether to disable input | *boolean* | `false` |
| async-change | Whether to enable async change | *boolean* | `false` | - |
| show-plus `v2.1.2` | Whether to show plus button | *boolean* | `true` |
| show-minus `v2.1.2` | Whether to show minus button | *boolean* | `true` |
| long-press `v2.4.3` | Whether to allow long press | *boolean* | `true` |
| --- | --- | --- | --- |
| v-model | Current value | _number \| string_ | - |
| min | Min value | _number \| string_ | `1` |
| max | Max value | _number \| string_ | - |
| default-value | Default value, valid when v-model is empty | _number \| string_ | `1` |
| step | Value change step | _number \| string_ | `1` |
| name `v2.0.3` | Stepper name | _number \| string_ | - |
| input-width | Input width | _number \| string_ | `32px` |
| button-size `v2.0.5` | Button size | _number \| string_ | `28px` |
| decimal-length `v2.2.1` | Decimal length | _number \| string_ | - |
| integer | Whether to allow only integers | _boolean_ | `false` |
| disabled | Disable value change | _boolean_ | `false` |
| disable-plus `v2.2.16` | Whether to disable plus button | _boolean_ | `false` |
| disable-minus `v2.2.16` | Whether to disable minus button | _boolean_ | `false` |
| disable-input | Whether to disable input | _boolean_ | `false` |
| async-change | Whether to enable async change | _boolean_ | `false` | - |
| show-plus `v2.1.2` | Whether to show plus button | _boolean_ | `true` |
| show-minus `v2.1.2` | Whether to show minus button | _boolean_ | `true` |
| long-press `v2.4.3` | Whether to allow long press | _boolean_ | `true` |
### Events
| Event | Description | Arguments |
|------|------|------|
| change | Triggered when value change | *value: string, detail: { name: string }* |
| --- | --- | --- |
| change | Triggered when value change | _value: string, detail: { name: string }_ |
| overlimit | Triggered when click disabled button | - |
| plus | Triggered when click plus button | - |
| minus | Triggered when click minus button | - |
| focus | Triggered when input focused | *event: Event* |
| blur | Triggered when input blured | *event: Event* |
| focus | Triggered when input focused | _event: Event_ |
| blur | Triggered when input blured | _event: Event_ |
src/stepper/README.zh-CN.md
+33 -37
View File
@@ -27,10 +27,10 @@ Vue.use(Stepper);
export default {
data() {
return {
value: 1
}
}
}
value: 1,
};
},
};
```
### 步长设置
@@ -94,11 +94,7 @@ export default {
如果需要异步地修改输入框的值，可以设置`async-change`属性，并在`change`事件中手动修改`value`
```html
<van-stepper
:value="value"
async-change
@change="onChange"
/>
<van-stepper :value="value" async-change @change="onChange" />
```
```js
@@ -107,8 +103,8 @@ import { Toast } from 'vant';
export default {
data() {
return {
value: 1
}
value: 1,
};
},
methods: {
onChange(value) {
@@ -120,9 +116,9 @@ export default {
// 注意此时修改 value 后会再次触发 change 事件
this.value = value;
}, 500);
}
}
}
},
},
};
```
## API
@@ -130,33 +126,33 @@ export default {
### Props
| 参数 | 说明 | 类型 | 默认值 |
|------|------|------|------|
| v-model | 当前输入的值 | *number \| string* | - |
| min | 最小值 | *number \| string* | `1` |
| max | 最大值 | *number \| string* | - |
| default-value | 初始值，当 v-model 为空时生效 | *number \| string* | `1` |
| step | 步长，每次点击时改变的值 | *number \| string* | `1` |
| name `v2.2.11` | 标识符，可以在`change`事件回调参数中获取 | *number \| string* | - |
| input-width | 输入框宽度，默认单位为`px` | *number \| string* | `32px` |
| button-size `v2.0.5` | 按钮大小以及输入框高度，默认单位为`px` | *number \| string* | `28px` |
| decimal-length `v2.2.1` | 固定显示的小数位数 | *number \| string* | - |
| integer | 是否只允许输入整数 | *boolean* | `false` |
| disabled | 是否禁用步进器 | *boolean* | `false` |
| disable-plus `v2.2.16` | 是否禁用增加按钮 | *boolean* | `false` |
| disable-minus `v2.2.16` | 是否禁用减少按钮 | *boolean* | `false` |
| disable-input | 是否禁用输入框 | *boolean* | `false` |
| async-change | 是否开启异步变更，开启后需要手动控制输入值 | *boolean* | `false` |
| show-plus `v2.1.2` | 是否显示增加按钮 | *boolean* | `true` |
| show-minus `v2.1.2` | 是否显示减少按钮 | *boolean* | `true` |
| long-press `v2.4.3` | 是否开启长按手势 | *boolean* | `true` |
| --- | --- | --- | --- |
| v-model | 当前输入的值 | _number \| string_ | - |
| min | 最小值 | _number \| string_ | `1` |
| max | 最大值 | _number \| string_ | - |
| default-value | 初始值，当 v-model 为空时生效 | _number \| string_ | `1` |
| step | 步长，每次点击时改变的值 | _number \| string_ | `1` |
| name `v2.2.11` | 标识符，可以在`change`事件回调参数中获取 | _number \| string_ | - |
| input-width | 输入框宽度，默认单位为`px` | _number \| string_ | `32px` |
| button-size `v2.0.5` | 按钮大小以及输入框高度，默认单位为`px` | _number \| string_ | `28px` |
| decimal-length `v2.2.1` | 固定显示的小数位数 | _number \| string_ | - |
| integer | 是否只允许输入整数 | _boolean_ | `false` |
| disabled | 是否禁用步进器 | _boolean_ | `false` |
| disable-plus `v2.2.16` | 是否禁用增加按钮 | _boolean_ | `false` |
| disable-minus `v2.2.16` | 是否禁用减少按钮 | _boolean_ | `false` |
| disable-input | 是否禁用输入框 | _boolean_ | `false` |
| async-change | 是否开启异步变更，开启后需要手动控制输入值 | _boolean_ | `false` |
| show-plus `v2.1.2` | 是否显示增加按钮 | _boolean_ | `true` |
| show-minus `v2.1.2` | 是否显示减少按钮 | _boolean_ | `true` |
| long-press `v2.4.3` | 是否开启长按手势 | _boolean_ | `true` |
### Events
| 事件名 | 说明 | 回调参数 |
|------|------|------|
| change | 当绑定值变化时触发的事件 | *value: string, detail: { name: string }* |
| --- | --- | --- |
| change | 当绑定值变化时触发的事件 | _value: string, detail: { name: string }_ |
| overlimit | 点击不可用的按钮时触发 | - |
| plus | 点击增加按钮时触发 | - |
| minus | 点击减少按钮时触发 | - |
| focus | 输入框聚焦时触发 | *event: Event* |
| blur | 输入框失焦时触发 | *event: Event* |
| focus | 输入框聚焦时触发 | _event: Event_ |
| blur | 输入框失焦时触发 | _event: Event_ |