Stepper 步进器
介绍
步进器由增加按钮、减少按钮和输入框组成,用于在一定范围内输入、调整数字
引入
在app.json
或index.json
中引入组件,详细介绍见快速上手
"usingComponents": {
"van-stepper": "@vant/weapp/stepper/index"
}
代码演示
基础用法
通过value
设置输入值,可以通过change
事件监听到输入值的变化
<van-stepper value="{{ 1 }}" bind:change="onChange" />
Page({
onChange(event) {
console.log(event.detail);
},
});
步长设置
通过step
属性设置每次点击增加或减少按钮时变化的值,默认为1
<van-stepper value="{{ 1 }}" step="2" />
限制输入范围
通过min
和max
属性限制输入值的范围
<van-stepper value="{{ 5 }}" min="5" max="8" />
限制输入整数
设置integer
属性后,输入框将限制只能输入整数
<van-stepper value="{{ 1 }}" integer />
禁用状态
通过设置disabled
属性来禁用步进器,禁用状态下无法点击按钮或修改输入框
<van-stepper value="{{ 1 }}" disabled />
关闭长按
通过设置long-press
属性决定步进器是否开启长按手势
<van-stepper value="{{ 1 }}" long-press="{{ false }}" />
固定小数位数
通过设置decimal-length
属性可以保留固定的小数位数
<van-stepper value="{{ 1 }}" step="0.2" decimal-length="{{ 1 }}" />
异步变更
如果需要异步地修改输入框的值,可以设置async-change
属性,并在change
事件中手动修改value
<van-stepper value="{{ value }}" async-change bind:change="onChange" />
Page({
data: {
value: 1,
},
onChange(value) {
Toast.loading({ forbidClick: true });
setTimeout(() => {
Toast.clear();
this.setData({ value });
}, 500);
},
});
自定义大小
通过input-width
属性设置输入框宽度,通过button-size
属性设置按钮大小和输入框高度
<van-stepper value="{{ 1 }}" input-width="40px" button-size="32px" />
API
Props
参数 | 说明 | 类型 | 默认值 | 版本 |
---|---|---|---|---|
name | 在表单内提交时的标识符 | string | - | - |
value | 输入值 | string | number | 最小值 | - |
min | 最小值 | string | number | 1 | - |
max | 最大值 | string | number | - | - |
step | 步长 | string | number | 1 | - |
integer | 是否只允许输入整数 | boolean | false | - |
disabled | 是否禁用 | boolean | false | - |
disable-input | 是否禁用输入框 | boolean | false | - |
async-change | 是否开启异步变更,开启后需要手动控制输入值 | boolean | false | - |
input-width | 输入框宽度,默认单位为 px | string | number | 32px | - |
button-size | 按钮大小,默认单位为 px ,输入框高度会和按钮大小保持一致 | string | number | 28px | - |
show-plus | 是否显示增加按钮 | boolean | true | - |
show-minus | 是否显示减少按钮 | boolean | true | - |
decimal-length | 固定显示的小数位数 | number | - | - |
disable-plus | 是否禁用增加按钮 | boolean | - | - |
disable-minus | 是否禁用减少按钮 | boolean | - | - |
long-press | 是否开启长按手势 | boolean | true | - |
Events
事件名 | 说明 | 回调参数 |
---|---|---|
bind:change | 当绑定值变化时触发的事件 | event.detail: 当前输入的值 |
bind:overlimit | 点击不可用的按钮时触发 | - |
bind:plus | 点击增加按钮时触发 | - |
bind:minus | 点击减少按钮时触发 | - |
bind:focus | 输入框聚焦时触发 | - |
bind:blur | 输入框失焦时触发 | - |
外部样式类
类名 | 说明 |
---|---|
custom-class | 根节点样式类 |
input-class | 输入框样式类 |
plus-class | 加号按钮样式类 |
minus-class | 减号按钮样式类 |