Stepper 步进器

介绍

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

引入

通过以下方式来全局注册组件，更多注册方式请参考组件注册。

import { createApp } from 'vue';
import { Stepper } from 'vant';
const app = createApp();
app.use(Stepper);

代码演示

基础用法

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

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

import { ref } from 'vue';
export default {
  setup() {
    const value = ref(1);
    return { value };
  },
};

步长设置

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

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

限制输入范围

通过 min 和 max 属性限制输入值的范围，默认超出范围后会自动校正最大值或最小值，通过 auto-fixed 可以关闭自动校正。

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

限制输入整数

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

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

禁用状态

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

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

禁用输入框

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

<van-stepper v-model="value" disable-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" />

异步变更

通过 before-change 属性可以在输入值变化前进行校验和拦截。

<van-stepper v-model="value" :before-change="beforeChange" />

import { ref } from 'vue';
import { closeToast, showLoadingToast } from 'vant';
export default {
  setup() {
    const value = ref(1);
    const beforeChange = (value) => {
      showLoadingToast({ forbidClick: true });
      return new Promise((resolve) => {
        setTimeout(() => {
          closeToast();
          // 在 resolve 函数中返回 true 或 false
          resolve(true);
        }, 500);
      });
    };
    return {
      value,
      beforeChange,
    };
  },
};

圆角风格

将 theme 设置为 round 来展示圆角风格的步进器。

<van-stepper v-model="value" theme="round" button-size="22" disable-input />

API

Props

Events

类型定义

组件导出以下类型定义：

import type { StepperTheme, StepperProps } from 'vant';

主题定制

样式变量

组件提供了下列 CSS 变量，可用于自定义样式，使用方法请参考 ConfigProvider 组件。

常见问题

为什么 value 有时候会变成 string 类型？

这是因为用户输入过程中可能出现小数点或空值，比如 1.，这种情况下组件会抛出字符串类型。

如果希望 value 保持 number 类型，可以在 v-model 上添加 number 修饰符：

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