tt.showModal
收藏我的收藏
收藏基础库 1.0.0 开始支持本方法，这是一个异步方法。
显示模态弹窗。用于同步用户重要信息，并要求用户进行确认，或执行特定操作以决策下一步骤。
| 前提条件 | 无 |
| 业务背景 | 无 |
| 使用限制 | 无 |
| 注意事项 | 输入参数的 title 和 content 不可同时为空。 |
| 支持沙盒 | 否 |
| 相关教程 | 无 |
语法
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 |
| confirmColor | string | #F85959 | 否 | 确认按钮的文字颜色，必须是 16 进制格式的颜色字符串 | 2.62.0 |
| cancelColor | string | #000000 | 否 | 取消按钮的文字颜色，必须是 16 进制格式的颜色字符串 | 2.62.0 |
| editable | boolean | false | 否 | 是否显示输入框 | 2.62.0 |
| placeholderText | string | 否 | 显示输入框时的提示文本 | 2.62.0 | |
| imageSrc | string | 否 | 弹出的模态框里展示的图片，只支持宽高比为 2:1 的图片，只支持小程序包内静态资源图片或 ttfile 开头（如通过 tt.downloadFile 或 tt.chooseImage 获取的临时图片地址）的本地图片，不支持网络图片。图片类型 imageSrc 的合法值 | 2.74.0 | |
| success | function | 否 | 接口调用成功的回调函数 | 1.0.0 | |
| fail | function | 否 | 接口调用失败的回调函数 | 1.0.0 | |
| complete | function | 否 | 接口调用结束的回调函数（调用成功、失败都会执行） | 1.0.0 |
imageSrc 参数说明
值 | 说明 | 最低支持版本 |
JPG | .jpg 图片格式 | 2.74.0 |
PNG | .png 图片格式 | 2.74.0 |
SVG | .svg 图片格式 | 2.74.0 |
WEBP | .webp 图片格式 | 2.74.0 |
回调成功
object 类型，属性如下：
| 属性名 | 类型 | 说明 | 最低支持版本 |
|---|---|---|---|
| errMsg | string | "showModal:ok" | 1.0.0 |
| confirm | boolean | 是否点击了确定按钮 | 1.0.0 |
| cancel | boolean | 是否点击了取消按钮 | 1.0.0 |
| content | string | editable 为 true 时，用户输入的文本 | 1.0.0 |
回调失败
object 类型，属性如下：
| 属性名 | 类型 | 说明 | 最低支持版本 |
|---|---|---|---|
| errMsg | string | "showModal:fail" + 详细错误信息 | 1.0.0 |
错误码
| errorCode | errMsg | errorType | 说明 | 最低支持版本 |
|---|---|---|---|---|
| 102499 | showModal:fail Title and content can't be both empty | D | 参数校验错误 | 1.0.0 |
| 102491 | showModal:fail Internal error: Activity is null,showModal:fail Internal error: no api callback | F | 小程序框架内部错误，有需要请创建工单咨询 | 1.0.0 |
| 102401 | showModal:fail The image aspect ratio must be 2:1 | D | 图片宽高比必须为 2:1 | 1.0.0 |
| 102402 | showModal:fail imageSrc is invalid | D | imageSrc属性无效 | 1.0.0 |
| 102403 | showModal:fail unsupported image type | D | 不支持图片类型 | 1.0.0 |
扫码体验
请使用字节宿主APP扫码
