介绍
虚拟数字键盘，可以配合
或自定义的输入框组件使用。
引入
代码演示
默认样式
数字键盘提供了 `input`、`delete`、`blur` 事件，分别对应输入内容、删除内容和失去焦点的动作。
> 点击键盘以外的区域时，键盘会自动收起，通过阻止元素上的 touchstart 事件冒泡可以避免键盘收起。
带右侧栏的键盘
将 theme 属性设置为 `custom` 来展示键盘的右侧栏，常用于输入金额的场景。
身份证号键盘
通过 `extra-key` 属性可以设置左下角按键内容，比如需要输入身份证号时，可以将 `extra-key` 设置为 `X`。
键盘标题
通过 `title` 属性可以设置键盘标题。
配置多个按键
当 theme 为 `custom` 时，支持以数组的形式配置两个 `extra-key`。
随机数字键盘
通过 `random-key-order` 属性可以随机排序数字键盘，常用于安全等级较高的场景。
双向绑定
可以通过 `v-model` 绑定键盘当前输入值。
API
Props
| 参数 | 说明 | 类型 | 默认值 | |
|---|---|---|---|---|
| v-model (value) | 当前输入值 | string | - | |
| show | 是否显示键盘 | boolean | - | |
| title | 键盘标题 | string | - | |
| theme | 样式风格，可选值为 custom | string | default | |
| maxlength | 输入值最大长度 | number 、 string | - | |
| transition | 是否开启过场动画 | boolean | true | |
| z-index | 键盘 z-index 层级 | number 、 string | 100 | |
extra-key v2.8.2 | 底部额外按键的内容 | string 、 string[] | '' | |
| close-button-text | 关闭按钮文字，空则不展示 | string | - | |
| delete-button-text | 删除按钮文字，空则展示删除图标 | string | - | |
close-button-loading v2.7.0 | 是否将关闭按钮设置为加载中状态，仅在 theme="custom" 时有效 | boolean | false | |
show-delete-key v2.5.9 | 是否展示删除图标 | boolean | true | |
| hide-on-click-outside | 点击外部时是否收起键盘 | boolean | true | |
get-container v2.10.0 | 指定挂载的节点，[用法示例](https://youzan.github.io/vant/v2/#/zh-CN/popup#zhi-ding-gua-zai-wei-zhi) | string 、 () => Element | - | |
| safe-area-inset-bottom | 是否开启[底部安全区适配](https://youzan.github.io/vant/v2/#/zh-CN/advanced-usage#di-bu-an-quan-qu-gua-pei) | boolean | true | |
random-key-order v2.12.2 | 是否将通过随机顺序展示按键 | boolean | false |
Events
| 事件名 | 说明 | 回调参数 | |
|---|---|---|---|
| input | 点击按键时触发 | key: 按键内容 | |
| delete | 点击删除键时触发 | - | |
| close | 点击关闭按钮时触发 | - | |
| blur | 点击关闭按钮或非键盘区域时触发 | - | |
| show | 键盘完全弹出时触发 | - | |
| hide | 键盘完全收起时触发 | - |
Slots
| 名称 | 说明 | |
|---|---|---|
| delete | 自定义删除按键内容 | |
| extra-key | 自定义左下角按键内容 | |
| title-left | 自定义标题栏左侧内容 |
样式变量
组件提供了下列 Less 变量，可用于自定义样式，使用方法请参考
。
| 名称 | 默认值 | 描述 | |
|---|---|---|---|
| @number-keyboard-background-color | @gray-2 | - | |
| @number-keyboard-key-height | 48px | - | |
| @number-keyboard-key-font-size | 28px | - | |
| @number-keyboard-key-active-color | @gray-3 | - | |
| @number-keyboard-delete-font-size | @font-size-lg | - | |
| @number-keyboard-title-color | @gray-7 | - | |
| @number-keyboard-title-height | 34px | - | |
| @number-keyboard-title-font-size | @font-size-lg | - | |
| @number-keyboard-close-padding | 0 @padding-md | - | |
| @number-keyboard-close-color | @text-link-color | - | |
| @number-keyboard-close-font-size | @font-size-md | - | |
| @number-keyboard-button-text-color | @white | - | |
| @number-keyboard-button-background-color | @blue | - | |
| @number-keyboard-cursor-color | @text-color | - | |
| @number-keyboard-cursor-width | 1px | - | |
| @number-keyboard-cursor-height | 40% | - | |
| @number-keyboard-cursor-animation-duration | 1s | - | |
| @number-keyboard-z-index | 100 | - |
常见问题
在桌面端无法操作组件？
参见
。
效果图：
