tt.showModal
从基础库 1.0.0 开始支持。
显示模态弹窗。用于同步用户重要信息,并要求用户进行确认,或执行特定操作以决策下一步骤。
语法
tt.showModal(options)
参数说明
options
为 object 类型,属性如下:
属性名 | 类型 | 默认值 | 必填 | 说明 | 最低支持版本 |
---|---|---|---|---|---|
title | string | 否 | 标题 | 1.0.0 | |
content | string | 否 | 内容 | 1.0.0 | |
confirmText | string | 确定 | 否 | 确定按钮的文案,最多 4 个字符 | 1.0.0 |
showCancel | boolean | true | 否 | 是否显示取消按钮 | 1.0.0 |
cancelText | string | 取消 | 否 | 取消按钮的文案,最多 4 个字符 | 1.0.0 |
success | Function | 否 | 用户点击了确定按钮或者取消按钮的回调函数 | 1.0.0 | |
fail | Function | 否 | 接口调用失败后的回调函数 | 1.0.0 | |
complete | Function | 否 | 接口调用结束后的回调函数(调用成功、失败都会执行) | 1.0.0 |
回调成功
object 类型,属性如下:
属性名 | 类型 | 说明 | 最低支持版本 |
---|---|---|---|
errMsg | string | "showModal:ok" | 1.0.0 |
confirm | boolean | 是否点击了确定按钮 | 1.0.0 |
cancel | boolean | 是否点击了取消按钮 | 1.0.0 |
回调失败
object 类型,属性如下:
属性名 | 类型 | 说明 | 最低支持版本 |
---|---|---|---|
errMsg | string | "showModal:fail " + 详细错误信息 | 1.0.0 |
效果示例

扫码体验
请使用字节宿主APP扫码
代码示例
tt.showModal({
title: "请求获得定位权限",
content: "获得你的地理位置能够更好的为你推荐本地信息",
success(res) {
if (res.confirm) {
console.log("confirm, continued");
} else if (res.cancel) {
console.log("cancel, cold");
} else {
// what happend?
}
},
fail(err) {
console.log(`showModal 调用失败`, err);
},
});
Bug & Tip
- Tip:暂不支持取消和确认按钮的颜色设置能力。
-
Tip:
title
的长度限制:- android 端限制为 1 行,每行约 13 个汉字。
- iOS 端限制为 3 行,每行约 17 个汉字。
-
Tip:
content
的长度限制:- android 端没有限制,Modal 最高为屏幕高度,内容滚动。
- iOS 端限制为 3 行,每行约 17 个汉字。
- Tip:输入参数的
title
和content
不可同时为空。
点击纠错
评价此篇文档