tt.previewImage
收藏
我的收藏

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

预览一组图片。

前提条件
业务背景
使用限制

当前仅支持除了 heic 之外的常规格式。

注意事项
  • 当 urls 中存在多个相同的图片地址,预览时会选择 current 地址对应的第一张图片进行展示,可通过给图片地址增加 query 或 hash 值避免地址重复;
  • 从基础库 3.16.0 开始,支持开发者按 url 和 domain 维度配置添加 referer 请求头的规则,具体见:网络资源请求添加referer规则
支持沙盒
相关教程

语法

tt.previewImage(options)

参数说明

options 为 object 类型,属性如下:

属性名类型默认值必填说明最低支持版本
currentstringurls[0] 的内容
当前显示图片的链接,不填则默认为 urls 中的第一张
1.0.0
showmenubooleanfalse
是否显示长按菜单, 菜单支持保存图片至本地相册
2.48.0
urlsArray<string>
需要预览的图片地址列表
1.0.0
successfunction
接口调用成功的回调函数
1.0.0
failfunction
接口调用失败的回调函数
1.0.0
completefunction
接口调用结束的回调函数(调用成功、失败都会执行)
1.0.0

回调成功

object 类型,属性如下:

属性名类型说明最低支持版本
errMsgstring
"previewImage:ok"
1.0.0
invalidIdarray
urls 中不合法的图片的索引
2.48.0

回调失败

object 类型,属性如下:

属性名类型说明最低支持版本
errMsgstring
"previewImage:fail" + 详细错误信息
1.0.0

扫码体验

请使用字节宿主APP扫码

代码示例