普通小游戏开发
API
开放能力
数据分析
视频拍摄器
多端支持

tt.createMoreGamesBanner

基础库 1.67.0 开始全面支持本方法,低版本需做兼容处理

,tt.createMoreGamesBanner 仅 Android 客户端支持,iOS 不支持,开发者需做相应兼容处理。

创建更多游戏 banner。用户点击后会跳转小游戏盒子(tt.showMoreGamesModal),盒子中包含预先配置的小游戏列表。

语法

tt.createMoreGamesBanner(options);

参数说明

options 为 object 类型,属性如下:

属性类型默认值必填描述
styleobjectbanner 的样式
appLaunchOptionsArray<object>小游戏的启动参数

appLaunchOptions 参数说明

Array<object> 类型,内部对象结构如下:

属性类型默认值必填说明
appIdstring要打开的小游戏 appId
querystring查询字符串,必须是 key1=val1&key2=val2 的格式。可通过tt.getLaunchOptionSynctt.onShow获取启动参数中的 query
extraDataobject需要传递给目标小游戏的数据。可通过tt.getLaunchOptionSynctt.onShow返回的 referrerInfo 字段获取对应数据

style 参数说明

属性类型默认值必填说明
leftnumber左上角横坐标
topnumber左上角纵坐标
widthnumber宽度
verticalAlignstring垂直方向对齐模式
horizontalAlignstring水平方向对齐模式

verticalAlign 和 horizontalAlign 的取值说明

取值说明
top居上对齐
center居中对齐
bottom居下对齐

返回值

返回值为object类型,属性如下:

属性类型说明参数参数类型参数说明
showFunction显示 banner
hideFunction隐藏 banner
onResizeFunction监听 Banner 大小调整事件callbackFunction可以监听修改 banner 的 style 属性,调整 banner 的大小和定位。
不建议在 onResize 中调整 width 属性,避免循环调用。
offResizeFunction取消监听 Banner 大小调整事件callbackFunctiononResize 绑定的函数
onTapFunction监听点击 banner 事件callbackFunction点击 banner 后触发的事件
offTapFunction移除 onTap 绑定的监听函数callbackFunctiononTap 绑定的函数
onErrorFunction监听异常事件callbackFunction监听到异常后触发的事件,在回调函数中会将错误信息作为参数抛出
offErrorFunction取消监听异常事件callbackFunctiononError 绑定的函数

onResize 回调函数的参数

Object 类型,属性如下:

属性类型说明
widthnumberbanner 的宽度,最小为 300,最大为设备可用窗口宽度和高度的较小值
heightnumberbanner 的高度

onTap 回调函数的参数

Object 类型,属性如下:

属性类型说明
bannerIdnumber注册监听函数的 id

扫码体验

请使用字节宿主APP扫码

代码示例

开发者工具中预览

const banner = tt.createMoreGamesBanner({
  style: {
    left: 20,
    top: 40,
    width: 150,
    height: 40,
  },
  appLaunchOptions: [
    {
      appId: 'ttXXXXXX',
      query: 'foo=bar&baz=qux',
      extraData: {},
    },
    // {...}
  ],
});
// 显示banner
banner.show();
// 隐藏banner
banner.hide();
let callback = () =>{
    console.log('监听事件')
}
// 监听调整banner大小事件
banner.onResize(callback));
// 取消监听调整banner大小事件
banner.offResize(callback);
// 监听点击banner事件
banner.onTap(callback);
// 取消监听banner事件
banner.offTap(callback);
// 监听异常事件
banner.onError(callback)
// 取消监听异常事件
banner.offError(callback)

Bug & Tip

点击纠错
评价此篇文档