vant/src/number-keyboard/README.zh-CN.md

NumberKeyboard 数字键盘

引入

import Vue from 'vue';
import { NumberKeyboard } from 'vant';

Vue.use(NumberKeyboard);

代码演示

默认样式

<van-button @touchstart.stop="show = true">
  弹出默认键盘
</van-button>

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

export default {
  data() {
    return {
      show: true
    }
  },

  methods: {
    onInput(value) {
      Toast(value);
    },
    onDelete() {
      Toast('删除');
    }
  }
}

自定义样式

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

双向绑定

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

<van-field
  readonly
  clickable
  :value="value"
  @touchstart.native.stop="show = true"
/>

<van-number-keyboard
  v-model="value"
  :show="show"
  :maxlength="6"
  @blur="show = false"
/>

export default {
  data() {
    return {
      show: false,
      value: ''
    }
  }
}

API

Props

参数	说明	类型	默认值	版本
v-model	当前输入值	string	-	2.0.2
show	是否显示键盘	boolean	-	-
theme	样式风格，可选值为 default custom	string	default	-
title	键盘标题	string	-	-
maxlength	输入值最大长度	`number	string`	-
transition	是否开启过场动画	boolean	true	-
z-index	键盘 z-index	number	100	-
extra-key	左下角按键内容	string	''	-
close-button-text	关闭按钮文字，空则不展示	string	-	-
delete-button-text	删除按钮文字	string	删除	-
show-delete-key	是否展示删除按钮	boolean	true	-
hide-on-click-outside	点击外部时是否收起键盘	boolean	true	-
safe-area-inset-bottom	是否开启 iPhone X 底部安全区适配，需要在 viewport meta 标签中设置 viewport-fit=cover	boolean	false	-

Events

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

Slots

名称	说明
delete	自定义删除按钮内容
title-left	自定义标题栏左侧内容