基础信息说明
功能概述:提供软键盘的显示、隐藏、输入以及相关事件的监听能力。
方法说明
| 方法名 | 签名 | 同步/异步 | 说明 |
| showKeyboard | qg.showKeyboard(Object option): void | 同步调用,回调同步触发 | 显示键盘 |
| hideKeyboard | qg.hideKeyboard(Object option): void | 同步调用,回调同步触发 | 隐藏键盘 |
| updateKeyboard | qg.updateKeyboard(Object option): void | 同步调用,回调同步触发 | 更新键盘输入框内容。只有当键盘处于拉起状态时才会产生效果 |
| onKeyboardInput | qg.onKeyboardInput(Function callback): void | 同步注册,回调异步触发 | 监听键盘输入变化事件 |
| offKeyboardInput | qg.offKeyboardInput(Function callback): void | 同步调用 | 取消监听键盘输入变化事件 |
| onKeyboardConfirm | qg.onKeyboardConfirm(Function callback): void | 同步注册,回调异步触发 | 监听用户点击键盘 Confirm 按钮时的事件 |
| offKeyboardConfirm | qg.offKeyboardConfirm(Function callback): void | 同步调用 | 取消监听用户点击键盘 Confirm 按钮时的事件 |
| onKeyboardComplete | qg.onKeyboardComplete(Function callback): void | 同步注册,回调异步触发 | 监听键盘收起的事件 |
| offKeyboardComplete | qg.offKeyboardComplete(Function callback): void | 同步调用 | 取消监听键盘收起事件 |
参数说明
qg.showKeyboard(Object option)
| 属性名 | 类型 | 默认值(如有) | 必填 | 说明 |
| defaultValue | String | - | 是 | 键盘输入框显示的默认值 |
| maxLength | Number | - | 是 | 键盘中文本的最大长度 |
| multiple | Boolean | - | 是 | 是否为多行输入 |
| confirmHold | Boolean | - | 是 | 当点击完成时键盘是否保持显示 |
| confirmType | String | - | 是 | 键盘Confirm按钮类型,只影响按钮的文本内容 |
| success | Function | - | 否 | 成功回调 |
| fail | Function | - | 否 | 接口调用失败的回调函数 |
| complete | Function | - | 否 | 执行结束后的回调 |
confirmType 的合法值
| 值 | 说明 |
| done | 完成 |
| next | 下一个 |
| search | 搜索 |
| go | 前往 |
| send | 发送 |
qg.onKeyboardInput(Function callback)
| 属性名 | 类型 | 必填 | 说明 |
| callback | Function | 是 | 监听键盘输入事件的回调函数 |
回调函数 callback(Object res)
| 属性名 | 类型 | 说明 |
| value | String | 键盘输入的当前值 |
qg.onKeyboardConfirm(Function callback)
| 属性名 | 类型 | 必填 | 说明 |
| callback | Function | 是 | 用户点击键盘 Confirm 按钮时的回调函数 |
回调函数 callback(Object res)
| 属性名 | 类型 | 说明 |
| value | String | 键盘输入的当前值 |
qg.onKeyboardComplete(Function callback)
| 属性名 | 类型 | 必填 | 说明 |
| callback | Function | 是 | 键盘收起时的回调函数 |
qg.offKeyboardInput(Function callback)
| 参数名 | 类型 | 必填 | 说明 |
| callback | Function | 否 | 需要取消的监听回调,不传callback参数则移除所有监听函数 |
qg.offKeyboardConfirm(Function callback)
| 参数名 | 类型 | 必填 | 说明 |
| callback | Function | 否 | 需要取消的监听回调,不传callback参数则移除所有监听函数 |
qg.offKeyboardComplete(Function callback)
| 属性名 | 类型 | 必填 | 说明 |
| callback | Function | 否 | 需要取消的监听回调,不传callback参数则移除所有监听函数 |
qg.hideKeyboard(Object option)
| 属性名 | 类型 | 必填 | 说明 |
| success | Function | 否 | 接口调用成功的回调 |
| fail | Function | 否 | 接口调用失败的回调 |
| complete | Function | 否 | 接口调用结束的回调 |
qg.updateKeyboard(Object option)
| 属性名 | 类型 | 必填 | 说明 |
| value | String | 是 | 键盘输入框的当前值 |
| success | Function | 否 | 接口调用成功的回调 |
| fail | Function | 否 | 接口调用失败的回调 |
| complete | Function | 否 | 接口调用结束的回调 |
回调结果说明
| 回调/事件 | 触发时机 | 回调参数 | 说明 |
| showKeyboard.success | 成功拉起键盘时 | Object res | 同步触发 |
| showKeyboard.complete | success 或 fail 之后 | 无 | 总会触发 |
| hideKeyboard.success | 成功隐藏键盘时 | 无 | 同步触发 |
| hideKeyboard.complete | success 或 fail 之后 | 无 | 总会触发 |
| updateKeyboard.success | 成功更新键盘输入内容时 | 无 | 同步触发 |
| updateKeyboard.complete | success 或 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方法更新键盘输入框内容,只有当键盘处于拉起状态时才会产生效果