NumberKeyboard 数字键盘

介绍

虚拟数字键盘,可以配合密码输入框组件或自定义的输入框组件使用。

引入

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

  1. import { createApp } from 'vue';
  2. import { NumberKeyboard } from 'vant';
  3. const app = createApp();
  4. app.use(NumberKeyboard);

代码演示

默认样式

数字键盘提供了 inputdeleteblur 事件,分别对应输入内容、删除内容和失去焦点的动作。

  1. <van-cell @touchstart.stop="show = true">弹出默认键盘</van-cell>
  2. <van-number-keyboard
  3. :show="show"
  4. @blur="show = false"
  5. @input="onInput"
  6. @delete="onDelete"
  7. />
  1. import { ref } from 'vue';
  2. import { Toast } from 'vant';
  3. export default {
  4. setup() {
  5. const show = ref(true);
  6. const onInput = (value) => Toast(value);
  7. const onDelete = () => Toast('删除');
  8. return {
  9. show,
  10. onInput,
  11. onDelete,
  12. };
  13. },
  14. };

点击键盘以外的区域时,键盘会自动收起,通过阻止元素上的 touchstart 事件冒泡可以避免键盘收起。

带右侧栏的键盘

将 theme 属性设置为 custom 来展示键盘的右侧栏,常用于输入金额的场景。

  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. />

身份证号键盘

通过 extra-key 属性可以设置左下角按键内容,比如需要输入身份证号时,可以将 extra-key 设置为 X

  1. <van-cell plain type="primary" @touchstart.stop="show = true">
  2. 弹出身份证号键盘
  3. </van-cell>
  4. <van-number-keyboard
  5. :show="show"
  6. extra-key="X"
  7. close-button-text="完成"
  8. @blur="show = false"
  9. @input="onInput"
  10. @delete="onDelete"
  11. />

键盘标题

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

  1. <van-cell plain type="primary" @touchstart.stop="show = true">
  2. 弹出带标题的键盘
  3. </van-cell>
  4. <van-number-keyboard
  5. :show="show"
  6. title="键盘标题"
  7. extra-key="."
  8. close-button-text="完成"
  9. @blur="show = false"
  10. @input="onInput"
  11. @delete="onDelete"
  12. />

配置多个按键

当 theme 为 custom 时,支持以数组的形式配置两个 extra-key

  1. <van-cell plain type="primary" @touchstart.stop="show = true">
  2. 弹出配置多个按键的键盘
  3. </van-cell>
  4. <van-number-keyboard
  5. :show="show"
  6. theme="custom"
  7. :extra-key="['00', '.']"
  8. close-button-text="完成"
  9. @blur="show = false"
  10. @input="onInput"
  11. @delete="onDelete"
  12. />

随机数字键盘

通过 random-key-order 属性可以随机排序数字键盘,常用于安全等级较高的场景。

  1. <van-cell @touchstart.stop="show = true"> 弹出配置随机数字的键盘 </van-cell>
  2. <van-number-keyboard
  3. :show="show"
  4. random-key-order
  5. @blur="show = false"
  6. @input="onInput"
  7. @delete="onDelete"
  8. />

双向绑定

可以通过 v-model 绑定键盘当前输入值,并通过 maxlength 属性来限制输入长度。

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

API

Props

参数说明类型默认值
v-model当前输入值string-
show是否显示键盘boolean-
title键盘标题string-
theme样式风格,可选值为 customstringdefault
maxlength输入值最大长度number | stringInfinity
transition是否开启过场动画booleantrue
z-index键盘 z-index 层级number | string100
extra-key底部额外按键的内容string | string[]‘’
close-button-text关闭按钮文字,空则不展示string-
delete-button-text删除按钮文字,空则展示删除图标string-
close-button-loading是否将关闭按钮设置为加载中状态,仅在 theme=”custom” 时有效booleanfalse
show-delete-key是否展示删除图标booleantrue
blur-on-close v3.0.6是否在点击关闭按钮时触发 blur 事件booleantrue
hide-on-click-outside是否在点击外部时收起键盘booleantrue
teleport指定挂载的节点,等同于 Teleport 组件的 to 属性string | Element-
safe-area-inset-bottom是否开启底部安全区适配booleantrue
random-key-order是否将通过随机顺序展示按键booleanfalse

Events

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

Slots

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

类型定义

组件导出以下类型定义:

  1. import type { NumberKeyboardTheme } from 'vant';

主题定制

样式变量

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

名称默认值描述
—van-number-keyboard-background-colorvar(—van-gray-2)-
—van-number-keyboard-key-height48px-
—van-number-keyboard-key-font-size28px-
—van-number-keyboard-key-active-colorvar(—van-gray-3)-
—van-number-keyboard-key-background-colorvan(—van-white)-
—van-number-keyboard-delete-font-sizevar(—van-font-size-lg)-
—van-number-keyboard-title-colorvar(—van-gray-7)-
—van-number-keyboard-title-height34px-
—van-number-keyboard-title-font-sizevar(—van-font-size-lg)-
—van-number-keyboard-close-padding0 var(—van-padding-md)-
—van-number-keyboard-close-colorvar(—van-text-link-color)-
—van-number-keyboard-close-font-sizevar(—van-font-size-md)-
—van-number-keyboard-button-text-colorvar(—van-white)-
—van-number-keyboard-button-background-colorvar(—van-primary-color)-
—van-number-keyboard-z-index100-

常见问题

在桌面端无法操作组件?

参见桌面端适配

NumberKeyboard 数字键盘 - 图1