Question

Keyboard 键盘 平台差异说明

App	H5	微信小程序	支付宝小程序	百度小程序	头条小程序	QQ小程序
√	√	√	√	√	√	√

基本使用

通过mode参数定义键盘的类型，v-model绑定一个值为布尔值的变量控制键盘的弹出与收起：

• mode = number (默认值)为数字键盘，此时顶部工具条中间的提示文字为"数字键盘"
• mode = car 为汽车键盘，此时顶部工具条中间的提示文字为"车牌号键盘"
• mode = card 为身份证键盘，此时顶部工具条中间的提示文字为"身份证键盘"

<template>
	<view>
		<u-keyboard ref="uKeyboard" mode="car" v-model="show"></u-keyboard>
		<u-button @click="show = true">打开</u-button>
	</view>
</template>

<script>
	export default {
		data() {
			return {
				show: false
			}
		}
	}
</script>

控制键盘顶部的工具条

• 通过tooltip参数配置是否显示显示顶部的工具条，默认为true
• 通过tips参数修改工具条中间的提示文字
• 通过show-tips可以控制是否显示工具条中间的文字
• 通过cancelBtn参数配置是否显示工具条左边的"取消"按钮
• 通过confirmBtn参数配置是否显示工具条右边的"完成"按钮

<u-keyboard mode="car" tips="请输入车牌号" :cancelBtn="false"></u-keyboard>

是否显示键盘的点(".")按键

该按键通过dot-enabled(默认为true)参数配置，只在"mode = number"时生效，因为车牌号和身份证键盘，用不到"."这个按键

<u-keyboard ref="uKeyboard" mode="number" :dot-enabled="false" v-model="show"></u-keyboard>

是否打乱按键的顺序

如果配置random参数为true的话，每次打开键盘，按键的顺序都是随机的，该功能默认是关闭的

<u-keyboard ref="uKeyboard" mode="number" :random="true" v-model="show"></u-keyboard>

如何控制键盘的打开和关闭？

通过v-model绑定一个值为布尔值的变量控制组件的弹出与收起，v-model的值是双向绑定的。

<template>
	<u-keyboard mode="number" v-model="show"></u-keyboard>
</template>

<script>
	export default {
		onReady() {
			// 如果想一进入页面就打开键盘，请在此生命周期调用
			this.show = true;
		},
		onLoad() {
			// 不应在此调用，因为此时u-keyboard组件尚未创建完成
			// this.show = true;
		}
	}
</script>

如何监听键盘按键被点击？

• 输入值是通过组件的change事件实现的，组件内部每个按键被点击的时候，组件就会发出一个change事件，回调参数为点击的按键的值。
• 通过backspace事件监听键盘退格键的点击，通过修改父组件的值实现退格的效果，见下方示例

注意：点击退格键(也即删除键)不会触发change事件

<template>
	<u-keyboard mode="number" @change="valChange" @backspace="backspace" v-model="show"></u-keyboard>
</template>

<script>
	export default {
		data() {
			return {
				value: '',
				show: false
			}
		},
		methods: {
			// 按键被点击(点击退格键不会触发此事件)
			valChange(val) {
				// 将每次按键的值拼接到value变量中，注意+=写法
				this.value += val;
				console.log(this.value);
			},
			// 退格键被点击
			backspace() {
				// 删除value的最后一个字符
				if(this.value.length) this.value = this.value.substr(0, this.value.length - 1);
				console.log(this.value);
			}
		}
	}
</script>

是否显示遮罩

当您使用键盘时，可能会不想显示遮罩，这时可以配置mask参数为false即可

<u-keyboard mode="number" v-model="show" :mask="false"></u-keyboard>

API

Props

注意：props中没有控制键盘弹出与收起的参数，因为这是通过v-model绑定变量实现的，见上方说明。

参数	说明	类型	默认值	可选值
mode	键盘类型，见上方基本使用的说明	String	number	car / card
dot-enabled	是否显示"."按键，只在mode=number时有效	Boolean	true	false
tooltip	是否显示键盘顶部工具条	Boolean	true	false
tips	工具条中间的提示文字，见上方基本使用的说明	String	-	-
show-tips	是否显示工具条中间的文字	Boolean	true	false
cancel-btn	是否显示工具条左边的"取消"按钮	Boolean	true	false
confirm-btn	是否显示工具条右边的"完成"按钮	Boolean	true	false
mask	是否显示遮罩	Boolean	true	false
z-index	弹出键盘的z-index值	Number | String	1075	-
random	是否打乱键盘按键的顺序	Boolean	false	true
safe-area-inset-bottom	是否开启底部安全区适配	Boolean	false	true
mask-close-able	是否允许点击遮罩收起键盘	Boolean	true	false
confirm-text 1.5.6	确认按钮的文字	String	取消	-
cancel-text 1.5.6	取消按钮的文字	String	确认	-

Events

事件名	说明	回调参数	版本
change	按键被点击(不包含退格键被点击)	按键的值，见上方说明和示例	-
cancel	键盘顶部工具条左边的"取消"按钮被点击	-	-
confirm	键盘顶部工具条右边的"完成"按钮被点击	-	-
backspace	键盘退格键被点击	-	-

Slot

名称	说明	版本
default	内容将会显示键盘的工具条上面，可以结合MessageInput 验证码输入组件实现类似支付宝输入密码时，上方显示输入内容的功能	-