开发
API

tt.showModal

从基础库 1.0.0 开始支持。

显示模态弹窗。用于同步用户重要信息,并要求用户进行确认,或执行特定操作以决策下一步骤。

语法

tt.showModal(options)

参数说明

options 为 object 类型,属性如下:

属性名类型默认值必填说明最低支持版本
titlestring标题1.0.0
contentstring内容1.0.0
confirmTextstring确定确定按钮的文案,最多 4 个字符1.0.0
showCancelbooleantrue是否显示取消按钮1.0.0
cancelTextstring取消取消按钮的文案,最多 4 个字符1.0.0
successFunction用户点击了确定按钮或者取消按钮的回调函数1.0.0
failFunction接口调用失败后的回调函数1.0.0
completeFunction接口调用结束后的回调函数(调用成功、失败都会执行)1.0.0

回调成功

object 类型,属性如下:

属性名类型说明最低支持版本
errMsgstring"showModal:ok"1.0.0
confirmboolean是否点击了确定按钮1.0.0
cancelboolean是否点击了取消按钮1.0.0

回调失败

object 类型,属性如下:

属性名类型说明最低支持版本
errMsgstring"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:输入参数的 titlecontent 不可同时为空。
点击纠错
评价此篇文档