普通小游戏开发
API
开放能力
数据分析
视频拍摄器
多端支持

tt.showKeyboard

基础库 1.0.0 开始支持本方法。

显示软键盘。

语法

tt.showKeyboard(options);

参数说明

options为 object 类型,属性如下:

属性名类型默认值必填说明最低支持版本
defaultValuestring键盘输入框显示的默认值1.0.0
maxLengthnumber键盘中文本的最大长度1.0.0
multipleboolean是否为多行输入1.0.0
confirmHoldboolean当点击完成时键盘是否收起1.0.0
confirmTypestring键盘右下角 confirm 按钮的类型,只影响按钮的文本内容1.0.0
successFunction接口调用成功的回调函数1.0.0
failFunction接口调用失败的回调函数1.0.0
completeFunction接口调用结束的回调函数(调用成功、失败都会执行)1.0.0

confirmType 的有效值

说明最低支持版本
done完成1.0.0
next下一个1.0.0
search搜索1.0.0
go前往1.0.0
send发送1.0.0

回调成功

object 类型,属性如下:

属性类型说明最低支持版本
errMsgstring"showKeyboard:ok"1.0.0

回调失败

Object 类型,属性如下:

属性类型说明最低支持版本
errMsgstring"showKeyboard:fail" + 报错信息1.0.0

扫码体验

请使用字节宿主APP扫码

代码示例

开发者工具中预览

tt.showKeyboard({
  defaultValue: "hello world", // 键盘输入框显示的默认值
  maxLength: 20, // 键盘中文本的最大长度
  multiple: true, // 是否为多行输入
  confirmHold: true, // 当点击完成时键盘是否收起
  confirmType: "done", // 键盘右下角 confirm 按钮的类型
  success: (res) => console.log(res),
});

Bug & Tip

  • Tip: 该方法并不会返回用户输入,需要用tt.onKeyboardInput监听用户输入。
点击纠错
评价此篇文档