抖音开放平台Logo
控制台

tt.showKeyboard
收藏
我的收藏

基础库 1.0.0 开始支持本方法，这是一个异步方法。

显示软键盘。

前提条件无
业务背景无
使用限制无
注意事项
  • 请在用户完整输入信息后（比如昵称起名环节），使用tt.onKeyboardConfirm 或者tt.onKeyboardComplete 接口来获取用户输入的信息，此时的信息经过平台敏感词检测，能够确保业务安全
  • 该方法并不会返回用户输入，需要用tt.onKeyboardInput监听用户输入。
相关教程无

语法

tt.showKeyboard(options)

参数说明

options 为 object 类型，属性如下：

属性名类型默认值必填说明最低支持版本
maxLengthnumber是

键盘中文本的最大长度

1.0.0
defaultValuestring是

键盘输入框显示的默认值

1.0.0
multipleboolean是

是否为多行输入

1.0.0
confirmHoldboolean是

当点击完成时键盘是否收起。 true 为点击完成后保持键盘为不收起的状态， false 为点击完成后收起键盘

1.0.0
confirmTypeenum是

键盘右下角 confirm 按钮的类型，只影响按钮的文本内容

1.0.0
successfunction否
接口调用成功的回调函数
1.0.0
failfunction否
接口调用失败的回调函数
1.0.0
completefunction否
接口调用结束的回调函数（调用成功、失败都会执行）
1.0.0

confirmType 的合法值

值说明最低支持版本
search

搜索

1.0.0
done

完成

1.0.0
next

下一个

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),
});