Vant 中文入门教程 Vant Stepper 步进器

2024-02-25 开发教程 Vant 中文入门教程匿名 3℃

介绍

步进器由增加按钮、减少按钮和输入框组成，用于在一定范围内输入、调整数字

引入

import Vue from 'vue';
import { Stepper } from 'vant';
Vue.use(Stepper);

代码演示

基础用法

通过v-model绑定输入值，可以通过change事件监听到输入值的变化

<van-stepper v-model="value" />

export default {
  data() {
    return {
      value: 1
    }
  }
}

步长设置

通过step属性设置每次点击增加或减少按钮时变化的值，默认为1

<van-stepper v-model="value" step="2" />

限制输入范围

通过min和max属性限制输入值的范围

<van-stepper v-model="value" min="5" max="8" />

限制输入整数

设置integer属性后，输入框将限制只能输入整数

<van-stepper v-model="value" integer />

禁用状态

通过设置disabled属性来禁用步进器，禁用状态下无法点击按钮或修改输入框

<van-stepper v-model="value" disabled />

禁用输入框

通过设置disabled-input属性来禁用输入框，此时按钮仍然可以点击

<van-stepper v-model="value" disabled-input />

固定小数位数

通过设置decimal-length属性可以保留固定的小数位数

<van-stepper v-model="value" step="0.2" :decimal-length="1" />

自定义大小

通过input-width属性设置输入框宽度，通过button-size属性设置按钮大小和输入框高度

<van-stepper v-model="value" input-width="40px" button-size="32px" />

异步变更

如果需要异步地修改输入框的值，可以设置async-change属性，并在change事件中手动修改value

<van-stepper
  :value="value"
  async-change
  @change="onChange"
/>

import { Toast } from 'vant';
export default {
  data() {
    return {
      value: 1
    }
  },
  methods: {
    onChange(value) {
      Toast.loading({ forbidClick: true });
      setTimeout(() => {
        Toast.clear();
        // 注意此时修改 value 后会再次触发 change 事件
        this.value = value;
      }, 500);
    }
  }
}

API

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`

Events

事件名	说明	回调参数
change	当绑定值变化时触发的事件	value: 当前组件的值, detail: 额外信息，包含 name 的字段
overlimit	点击不可用的按钮时触发	-
plus	点击增加按钮时触发	-
minus	点击减少按钮时触发	-
focus	输入框聚焦时触发	event: Event
blur	输入框失焦时触发	event: Event

实例演示

上一节： Vant Slider 滑块

下一节： Vant Switch 开关

"Vant 中文入门教程"的目录