小程序开放平台

文档中心
小组件配置
框架接口
小组件App
App
getApp
页面
自定义组件
模块化
基础功能
XHSML 语法参考

App

开发
>
框架
>
框架接口
>
小组件App
>
App
>
更新时间:2025-08-04 15:51:07

App

注册小组件。接受一个 object 参数,其指定小组件的生命周期回调等

属性
类型
默认值
必填
说明
onLaunchfunction生命周期回调——监听小组件初始化。
onShowfunction生命周期回调——监听小组件启动或切前台。
onHidefunction生命周期回调——监听小组件切后台。
onErrorfunction错误监听函数。
onPageNotFoundfunction页面不存在监听函数。
onUnhandledRejectionfunction未处理的 Promise 拒绝事件监听函数。
其他any开发者可以添加任意的函数或数据变量到 object 参数中,用 this 可以访问

onLaunch(Object object)

小组件初始化完成时触发,全局只触发一次。参数也可以使用

xhs.getLaunchOptionsSync
获取。

参数:与

xhs.getLaunchOptionsSync
一致

Object 启动参数

属性
类型
说明
最低版本
pathstring启动小组件的路径 (代码包路径)-
scenenumber启动小组件的场景值-
queryRecord.<string, string>启动小组件的 query 参数-
shareTicketstringshareTicket,详见获取更多转发信息3.108.x

onShow(Object object)

小组件启动,或从后台进入前台显示时触发。

参数:与

xhs.onAppShow
一致

Object 启动参数

属性
类型
说明
最低版本
pathstring启动小组件的路径 (代码包路径)-
scenenumber启动小组件的场景值-
queryRecord.<string, string>启动小组件的 query 参数-
shareTicketstringshareTicket,详见获取更多转发信息3.108.x

onHide()

小组件从前台进入后台时触发。

onError(String error)

小组件发生脚本错误或 API 调用报错时触发。也可以使用 xhs.onError 绑定监听

参数:与 [xhs.onError]( 一致

onPageNotFound(Object object)

小组件要打开的页面不存在时触发。也可以使用 xhs.onPageNotFound 绑定监听。注意事项请参考 xhs.onPageNotFound

参数:与 xhs.onPageNotFound 一致

示例代码:

App({
  onPageNotFound(res) {
    xhs.redirectTo({
      url: 'pages/...'
    }) // 如果是 tabbar 页面,请使用 xhs.switchTab
  }
})

onUnhandledRejection(Object object)【暂不支持

小组件有未处理的 Promise 拒绝时触发。也可以使用 xhs.onUnhandledRejection 绑定监听。注意事项请参考 xhs.onUnhandledRejection

参数:与 xhs.onUnhandledRejection 一致

示例代码

App({
  onLaunch (options) {
    // Do something initial when launch.
  },
  onShow (options) {
    // Do something when show.
  },
  onHide () {
    // Do something when hide.
  },
  onError (msg) {
    console.log(msg)
  },
  globalData: 'I am global data'
})