虚拟数字键盘，可以配合密码输入框组件或自定义的输入框组件使用。
通过以下方式来全局注册组件，更多注册方式请参考组件注册。
import { createApp } from 'vue';
import { NumberKeyboard } from 'vant';
const app = createApp();
app.use(NumberKeyboard); 数字键盘提供了 input、delete、blur 事件，分别对应输入内容、删除内容和失去焦点的动作。
<van-cell @touchstart.stop="show = true">弹出默认键盘</van-cell>
<van-number-keyboard
:show="show"
@blur="show = false"
@input="onInput"
@delete="onDelete"
/>
import { ref } from 'vue';
import { showToast } from 'vant';
export default {
setup() {
const show = ref(true);
const onInput = (value) => showToast(value);
const onDelete = () => showToast('删除');
return {
show,
onInput,
onDelete,
};
},
};点击键盘以外的区域时，键盘会自动收起，通过阻止元素上的 touchstart 事件冒泡可以避免键盘收起。
将 theme 属性设置为 custom 来展示键盘的右侧栏，常用于输入金额的场景。
<van-number-keyboard
:show="show"
theme="custom"
extra-key="."
close-button-text="完成"
@blur="show = false"
@input="onInput"
@delete="onDelete"
/>
通过 extra-key 属性可以设置左下角按键内容，比如需要输入身份证号时，可以将 extra-key 设置为 X。
<van-cell plain type="primary" @touchstart.stop="show = true">
弹出身份证号键盘
</van-cell>
<van-number-keyboard
:show="show"
extra-key="X"
close-button-text="完成"
@blur="show = false"
@input="onInput"
@delete="onDelete"
/>
通过 title 属性可以设置键盘标题。
<van-cell plain type="primary" @touchstart.stop="show = true">
弹出带标题的键盘
</van-cell>
<van-number-keyboard
:show="show"
title="键盘标题"
extra-key="."
close-button-text="完成"
@blur="show = false"
@input="onInput"
@delete="onDelete"
/>
当 theme 为 custom 时，支持以数组的形式配置两个 extra-key。
<van-cell plain type="primary" @touchstart.stop="show = true">
弹出配置多个按键的键盘
</van-cell>
<van-number-keyboard
:show="show"
theme="custom"
:extra-key="['00', '.']"
close-button-text="完成"
@blur="show = false"
@input="onInput"
@delete="onDelete"
/>
通过 random-key-order 属性可以随机排序数字键盘，常用于安全等级较高的场景。
<van-cell @touchstart.stop="show = true"> 弹出配置随机数字的键盘 </van-cell>
<van-number-keyboard
:show="show"
random-key-order
@blur="show = false"
@input="onInput"
@delete="onDelete"
/>
可以通过 v-model 绑定键盘当前输入值，并通过 maxlength 属性来限制输入长度。
<van-field v-model="value" readonly clickable @touchstart.stop="show = true" />
<van-number-keyboard
v-model="value"
:show="show"
:maxlength="6"
@blur="show = false"
/>
import { ref } from 'vue';
export default {
setup() {
const show = ref(true);
const value = ref('');
return {
show,
value,
};
},
}; | 参数 | 说明 | 类型 | 默认值 |
|---|---|---|---|
| v-model | 当前输入值 | string | - |
| show | 是否显示键盘 | boolean | - |
| title | 键盘标题 | string | - |
| theme | 样式风格，可选值为 custom | string | default |
| maxlength | 输入值最大长度 | number | string | Infinity |
| transition | 是否开启过场动画 | boolean | true |
| z-index | 键盘 z-index 层级 | number | string | 100 |
| extra-key | 底部额外按键的内容 | string | string[] | '' |
| close-button-text | 关闭按钮文字，空则不展示 | string | - |
| delete-button-text | 删除按钮文字，空则展示删除图标 | string | - |
| close-button-loading | 是否将关闭按钮设置为加载中状态，仅在 theme="custom"时有效 | boolean | false |
| show-delete-key | 是否展示删除图标 | boolean | true |
blur-on-close v3.0.6 | 是否在点击关闭按钮时触发 blur 事件 | boolean | true |
| hide-on-click-outside | 是否在点击外部时收起键盘 | boolean | true |
| teleport | 指定挂载的节点，等同于 Teleport 组件的 to 属性 | string | Element | - |
| safe-area-inset-bottom | 是否开启底部安全区适配 | boolean | true |
| random-key-order | 是否将通过随机顺序展示按键 | boolean | false |
| 事件名 | 说明 | 回调参数 |
|---|---|---|
| input | 点击按键时触发 | key: string |
| delete | 点击删除键时触发 | - |
| close | 点击关闭按钮时触发 | - |
| blur | 点击关闭按钮或非键盘区域时触发 | - |
| show | 键盘完全弹出时触发 | - |
| hide | 键盘完全收起时触发 | - |
| 名称 | 说明 |
|---|---|
| delete | 自定义删除按键内容 |
| extra-key | 自定义左下角按键内容 |
| title-left | 自定义标题栏左侧内容 |
组件导出以下类型定义：
import type { NumberKeyboardProps, NumberKeyboardTheme } from 'vant'; 组件提供了下列 CSS 变量，可用于自定义样式，使用方法请参考 ConfigProvider 组件。
| 名称 | 默认值 | 描述 |
|---|---|---|
| --van-number-keyboard-background | var(--van-gray-2) | - |
| --van-number-keyboard-key-height | 48px | - |
| --van-number-keyboard-key-font-size | 28px | - |
| --van-number-keyboard-key-active-color | var(--van-gray-3) | - |
| --van-number-keyboard-key-background | var(--van-white) | - |
| --van-number-keyboard-delete-font-size | var(--van-font-size-lg) | - |
| --van-number-keyboard-title-color | var(--van-gray-7) | - |
| --van-number-keyboard-title-height | 34px | - |
| --van-number-keyboard-title-font-size | var(--van-font-size-lg) | - |
| --van-number-keyboard-close-padding | 0 var(--van-padding-md) | - |
| --van-number-keyboard-close-color | var(--van-link-color) | - |
| --van-number-keyboard-close-font-size | var(--van-font-size-md) | - |
| --van-number-keyboard-button-text-color | var(--van-white) | - |
| --van-number-keyboard-button-background | var(--van-primary-color) | - |
| --van-number-keyboard-z-index | 100 | - |
参见桌面端适配。