search
开发文档
开发文档/小游戏开发/API/界面/键盘
键盘更新时间:2025-12-24 18:13:04

基础信息说明

功能概述:提供软键盘的显示、隐藏、输入以及相关事件的监听能力。

项目说明
版本要求
前提条件
使用限制
相关教程

方法说明

方法名签名同步/异步说明
showKeyboardqg.showKeyboard(Object option): void同步调用,回调同步触发显示键盘
hideKeyboardqg.hideKeyboard(Object option): void同步调用,回调同步触发隐藏键盘
updateKeyboardqg.updateKeyboard(Object option): void同步调用,回调同步触发更新键盘输入框内容。只有当键盘处于拉起状态时才会产生效果
onKeyboardInputqg.onKeyboardInput(Function callback): void同步注册,回调异步触发监听键盘输入变化事件
offKeyboardInputqg.offKeyboardInput(Function callback): void同步调用取消监听键盘输入变化事件
onKeyboardConfirmqg.onKeyboardConfirm(Function callback): void同步注册,回调异步触发监听用户点击键盘 Confirm 按钮时的事件
offKeyboardConfirmqg.offKeyboardConfirm(Function callback): void同步调用取消监听用户点击键盘 Confirm 按钮时的事件
onKeyboardCompleteqg.onKeyboardComplete(Function callback): void同步注册,回调异步触发监听键盘收起的事件
offKeyboardCompleteqg.offKeyboardComplete(Function callback): void同步调用取消监听键盘收起事件

参数说明

qg.showKeyboard(Object option)

属性名类型默认值(如有)必填说明
defaultValueString-键盘输入框显示的默认值
maxLengthNumber-键盘中文本的最大长度
multipleBoolean-是否为多行输入
confirmHoldBoolean-当点击完成时键盘是否保持显示
confirmTypeString-键盘Confirm按钮类型,只影响按钮的文本内容
successFunction-成功回调
failFunction-接口调用失败的回调函数
completeFunction-执行结束后的回调

confirmType 的合法值

说明
done完成
next下一个
search搜索
go前往
send发送

qg.onKeyboardInput(Function callback)

属性名类型必填说明
callbackFunction监听键盘输入事件的回调函数

回调函数 callback(Object res)

属性名类型说明
valueString键盘输入的当前值

qg.onKeyboardConfirm(Function callback)

属性名类型必填说明
callbackFunction用户点击键盘 Confirm 按钮时的回调函数

回调函数 callback(Object res)

属性名类型说明
valueString键盘输入的当前值

qg.onKeyboardComplete(Function callback)

属性名类型必填说明
callbackFunction键盘收起时的回调函数

qg.offKeyboardInput(Function callback)

参数名类型必填说明
callbackFunction需要取消的监听回调,不传callback参数则移除所有监听函数

qg.offKeyboardConfirm(Function callback)

参数名类型必填说明
callbackFunction需要取消的监听回调,不传callback参数则移除所有监听函数

qg.offKeyboardComplete(Function callback)

属性名类型必填说明
callbackFunction需要取消的监听回调,不传callback参数则移除所有监听函数

qg.hideKeyboard(Object option)

属性名类型必填说明
successFunction接口调用成功的回调
failFunction接口调用失败的回调
completeFunction接口调用结束的回调

qg.updateKeyboard(Object option)

属性名类型必填说明
valueString键盘输入框的当前值
successFunction接口调用成功的回调
failFunction接口调用失败的回调
completeFunction接口调用结束的回调

回调结果说明

回调/事件触发时机回调参数说明
showKeyboard.success成功拉起键盘时Object res同步触发
showKeyboard.completesuccess 或 fail 之后总会触发
hideKeyboard.success成功隐藏键盘时同步触发
hideKeyboard.completesuccess 或 fail 之后总会触发
updateKeyboard.success成功更新键盘输入内容时同步触发
updateKeyboard.completesuccess 或 fail 之后总会触发
onKeyboardInput 注册回调用户输入内容变化(包括新增 / 删除字符等)时Object res异步触发,通常包含当前完整输入内容
onKeyboardConfirm 注册回调用户点击键盘Confirm按钮时Object res异步触发,可用于提交表单、发送消息等
onKeyboardComplete 注册回调键盘被收起后Object res异步触发,用于 UI 恢复、状态重置等

示例代码

// 显示与隐藏
qg.showKeyboard({
defaultValue: 'defaultValue',
maxLength: 20,
multiple: false,
confirmHold: false,
confirmType: 'done',
success: function (res) {
console.info('showKeyboard success', res);
},
fail: function () {
console.info('showKeyboard fail');
},
complete: function () {
console.info('showKeyboard complete');
},
});
qg.hideKeyboard({
success: function () {
console.info('hideKeyboard success');
},
fail: function () {
console.info('hideKeyboard fail');
},
complete: function () {
console.info('hideKeyboard complete');
},
})

// 监听键盘输入
function getInputValue(res) {
console.log('keyboard input:', res.value);
}

qg.onKeyboardInput(getInputValue);
qg.offKeyboardInput(getInputValue);

// 监听用户点击键盘 Confirm 按钮
function getConfirmValue(res) {
console.log('keyboard confirm:', res.value);
}

qg.onKeyboardConfirm(getConfirmValue);
qg.offKeyboardConfirm(getConfirmValue);

// 监听键盘收起
function getCompleteValue(res) {
console.log('keyboard complete:', res.value);
}

qg.onKeyboardComplete(getCompleteValue);
qg.offKeyboardComplete(getCompleteValue);

// 更新键盘输入值
qg.updateKeyboard({
value: 'a',
success: function () {
console.info('updateKeyboard success');
},
fail: function () {
console.info('updateKeyboard fail');
},
complete: function () {
console.info('updateKeyboard complete');
},
})

注意事项

  • qg.updateKeyboard方法更新键盘输入框内容,只有当键盘处于拉起状态时才会产生效果
上一篇:提示框
下一篇:WebSocket
文档内容是否有帮助?
有帮助
无帮助