更新记录

1.1.4(2025-03-08) 下载此版本

v2新增disable属性支持禁用某些按钮

1.1.3(2025-02-26) 下载此版本

修改键盘布局 支持更多简称 【挂, 台, 临, 试】

1.1.2(2024-07-01) 下载此版本

  1. 新增动画事件
  2. 新增车牌号码最后一位新能源特殊样式
  3. 处理当输入位数太短时 显示框异常的大
  4. 处理震动反馈无效的问题
  5. 修复删除异常
查看更多

平台兼容性

Vue2 Vue3
App 快应用 微信小程序 支付宝小程序 百度小程序 字节小程序 QQ小程序
HBuilderX 3.1.0 app-vue app-nvue
钉钉小程序 快手小程序 飞书小程序 京东小程序 鸿蒙元服务
×
H5-Safari Android Browser 微信浏览器(Android) QQ浏览器(Android) Chrome IE Edge Firefox PC-Safari

xm-keyboard 介绍

xm-keyboard是一款虚拟键盘, 支持自定义拓展键盘内容。

插件已按照easycom处理, 支持直接使用

如何使用(v1.1.0使用说明)

xm-keyboard-v2

xm-keyboard-v2, 是对多个组件的聚合处理,也可以自行结合实现

<template>
    <view>
        <xm-cell special label="【v2】车牌号" :value="value" @show="showKeyboard('xmKeyboard')"></xm-cell>
        // 虚拟键盘载体
        <xm-keyboard-v2 ref="xmKeyboard" @confirm="(v) => value = v"></xm-keyboard-v2>
    </view>
</template>

<script>
    export default {
        data(){
            return {
                value: '京A11223'
            }
        },
        methods: {
            showKeyboard(ref){
                this.$refs[ref].toShow(this.value)
            },
        }
    }
</script>

属性说明

名称 类型 是否必填 默认值 可选值 说明
title string '' 显示键盘标题
cursor boolean false true、false 是否显示光标
vibration boolean false true、false 是否开启震动
type string 'plate' plate: 做了车牌号特殊处理
max number 8 输入内容的最大长度
showContent boolean false true、false 是否直接显示键盘
anim boolean true true、false 是否在弹出时显示动画效果
disable string '' 禁用某些按钮, 例如 "IO"

事件说明

名称 参数 说明
@confirm function(data) 键盘数据变化回调, data:输入的内容
@cancel function() 键盘关闭回调

xm-keyboard-box

键盘界面

<template>
    <view>
        <xm-keyboard-box></xm-keyboard-v2>
    </view>
</template>

<script>
    export default {

    }
</script>

属性说明

名称 类型 是否必填 默认值 可选值 说明
vibration boolean false true、false 是否开启震动
showChangeBtn boolean false true、false 是否显示切换按钮
showCancelBtn boolean false true、false 是否显示取消按钮

事件说明

名称 参数 说明
@add function(data) 键盘数据变化回调, data:输入的内容
@del function() 删除按钮点击回调
@confirm function() 确认按钮点击回调
@cancel function() 取消按钮点击回调
@clear function() 清空按钮点击回调

xm-keyboard-input

键盘输入框界面

<template>
    <view>
        <xm-keyboard-input></xm-keyboard-input>
    </view>
</template>

<script>
    export default {

    }
</script>

属性说明

名称 类型 是否必填 默认值 可选值 说明
initValue string '' 默认输入值
cursor boolean false true、false 是否显示光标
max number 8 键盘输入框数量
maxSize number 40 输入框最大宽高 (单位px)
showPointer boolean true true、false 默认第二位 和 第三位之间 有个点
align string center justify-content css属性取值 整体输入框位置

maxSize

事件说明

名称 参数 说明
@add function(data) 键盘数据变化回调, data:输入的内容
@del function() 删除按钮点击回调
@confirm function() 确认按钮点击回调
@cancel function() 取消按钮点击回调
@clear function() 清空按钮点击回调

如何使用(v1.0.2使用说明)

<xm-keyboard :show="show"></xm-keyboard>

属性说明

名称 类型 是否必填 默认值 可选值 说明
show boolean false true、false 是否展示键盘
mask boolean true true、false 是否显示遮罩
anim boolean true true、false 是否显示弹起动画
defaultValue string '' 默认值
exchange boolean true true、false 是否显示切换键盘按钮
mode number 1 0、1 0:地区键盘,1:字母数字键盘,可拓展
maxLength number -1 限制输入长度
disable string IO 禁用哪些按键
maxAutoClose boolean false true、false 达到最大长度后是否自动关闭键盘
safeSize number 10 距离底部的安全距离, 自动匹配失效时可手动配置

事件说明

名称 参数 说明
@change function(data) 键盘数据变化回调, data({ text: '', v: '', add: true }) text:输入的值, v:本次变化的值, add:添加还是删除
@close function(show) 键盘关闭回调, show: 是否显示

快速体验

隐私、权限声明

1. 本插件需要申请的系统权限列表:

2. 本插件采集的数据、发送的服务器地址、以及数据用途说明:

3. 本插件是否包含广告,如包含需详细说明广告表达方式、展示频率:

许可协议

MIT协议

使用中有什么不明白的地方,就向插件作者提问吧~ 我要提问