NumberKeyboard 数字键盘

介绍

数字键盘,提供两种样式风格,可以与密码输入框或自定义的输入框组件配合使用

引入

  1. import Vue from 'vue';
  2. import { NumberKeyboard } from 'vant';
  3. Vue.use(NumberKeyboard);

代码演示

默认样式

  1. <van-button @touchstart.stop="show = true">
  2. 弹出默认键盘
  3. </van-button>
  4. <van-number-keyboard
  5. :show="show"
  6. extra-key="."
  7. close-button-text="完成"
  8. @blur="show = false"
  9. @input="onInput"
  10. @delete="onDelete"
  11. />
  1. import { Toast } from 'vant';
  2. export default {
  3. data() {
  4. return {
  5. show: true
  6. }
  7. },
  8. methods: {
  9. onInput(value) {
  10. Toast(value);
  11. },
  12. onDelete() {
  13. Toast('删除');
  14. }
  15. }
  16. }

自定义样式

  1. <van-number-keyboard
  2. :show="show"
  3. theme="custom"
  4. extra-key="."
  5. close-button-text="完成"
  6. @blur="show = false"
  7. @input="onInput"
  8. @delete="onDelete"
  9. />

双向绑定

可以通过v-model绑定键盘当前输入值

  1. <van-field
  2. readonly
  3. clickable
  4. :value="value"
  5. @touchstart.native.stop="show = true"
  6. />
  7. <van-number-keyboard
  8. v-model="value"
  9. :show="show"
  10. :maxlength="6"
  11. @blur="show = false"
  12. />
export default {
  data() {
    return {
      show: false,
      value: ''
    }
  }
}

左下角按键内容

通过extra-key属性可以设置左下角按键内容

<van-button plain type="primary" @touchstart.stop="show = true'">
  弹出身份证号码键盘
</van-button>

<van-number-keyboard
  :show="show"
  close-button-text="完成"
  extra-key="X"
  @blur="show = false"
  @input="onInput"
  @delete="onDelete"
/>

键盘标题

通过title属性可以设置键盘标题

<van-button plain type="info" @touchstart.stop="show = true'">
  弹出自定义标题键盘
</van-button>

<van-number-keyboard
  :show="show"
  close-button-text="完成"
  title="键盘标题"
  extra-key="."
  @blur="show = false"
  @input="onInput"
  @delete="onDelete"
/>

API

Props

参数说明类型默认值
v-model v2.0.2当前输入值string-
show是否显示键盘boolean-
theme样式风格,可选值为 default customstringdefault
title键盘标题string-
maxlength v2.0.2输入值最大长度string | number-
transition是否开启过场动画booleantrue
z-index键盘 z-indexnumber100
extra-key左下角按键内容string''
close-button-text关闭按钮文字,空则不展示string-
delete-button-text删除按钮文字string删除
show-delete-key是否展示删除按钮booleantrue
hide-on-click-outside点击外部时是否收起键盘booleantrue
safe-area-inset-bottom是否开启底部安全区适配,详细说明booleantrue

Events

事件名说明回调参数
input点击按键时触发key: 按键内容
delete点击删除键时触发-
close点击关闭按钮时触发-
blur点击关闭按钮或非键盘区域时触发-
show键盘完全弹出时触发-
hide键盘完全收起时触发-

Slots

名称说明
delete自定义删除按键内容
extra-key自定义左下角按键内容
title-left自定义标题栏左侧内容

常见问题

在桌面端无法操作组件?

参见在桌面端使用

NumberKeyboard 数字键盘 - 图1