应用 App

App API 提供应用级别的信息和事件。

在线试用

getLaunchOptionsSyncgetEnv

切到其他标签再切回，可看到 visibility 记录

应用 API 试用

getLaunchOptionsSync 与 getEnv；切换浏览器页签时 visibilitychange 会追加一行日志（模拟应用前后台）

Vue

<script setup>
import { ref, onMounted } from 'vue'
import woo from 'mini-sdk'

const launchOpts = ref(null)

onMounted(() => {
  launchOpts.value = woo.getLaunchOptionsSync()

  woo.onAppShow((opts) => {
    console.log('App 进入前台', opts)
  })
  woo.onAppHide(() => {
    console.log('App 进入后台')
  })
})
</script>

<template>
  <pre v-if="launchOpts">{{ launchOpts }}</pre>
</template>

React

import { useState, useEffect } from 'react'
import woo from 'mini-sdk'

function AppInfo() {
  const [launchOpts, setLaunchOpts] = useState(null)

  useEffect(() => {
    setLaunchOpts(woo.getLaunchOptionsSync())

    woo.onAppShow((opts) => {
      console.log('App 进入前台', opts)
    })
    woo.onAppHide(() => {
      console.log('App 进入后台')
    })
  }, [])

  return launchOpts ? <pre>{JSON.stringify(launchOpts, null, 2)}</pre> : null
}

导入

import woo from 'mini-sdk'
// 或
import { app } from 'mini-sdk'

API 列表

getLaunchOptionsSync

同步获取小程序启动参数。

const options = woo.getLaunchOptionsSync()

返回值 LaunchOptions：

字段	类型	说明
path	string	启动页面路径
query	Record<string, string>	启动查询参数
scene	number	场景值（如 1001）
referrerInfo	object	来源信息

const options = woo.getLaunchOptionsSync()
console.log('启动路径：', options.path)
console.log('启动参数：', options.query)
console.log('场景值：', options.scene) // 1001

---

onAppShow

监听应用进入前台。

woo.onAppShow(callback: () => void): () => void

const unsub = woo.onAppShow(() => {
  console.log('应用进入前台')
  // 刷新数据、恢复连接等
})

触发时机

onAppShow 在以下情况触发：

• 从后台切换到前台
• 窗口重新获得焦点（visibilitychange / focus 事件）

---

onAppHide

监听应用进入后台。

woo.onAppHide(callback: () => void): () => void

const unsub = woo.onAppHide(() => {
  console.log('应用进入后台')
  // 暂停动画、断开连接等
})

与 Lifecycle 的区别

API	作用域	触发时机
onAppShow / onAppHide	应用级	整个小程序前后台切换
onShow / onHide	页面级	当前页面的显示/隐藏

// 应用级 — 全局只注册一次
woo.onAppShow(() => console.log('App Show'))
woo.onAppHide(() => console.log('App Hide'))

// 页面级 — 每个页面注册
woo.onShow(() => console.log('Page Show'))
woo.onHide(() => console.log('Page Hide'))

API 速查表

方法	说明	签名
getApp	获取应用实例	() → AppInstance
getAppInfo	获取应用元信息	() → Promise<AppInfo>
getLaunchOptions	获取启动参数	() → LaunchOptions
canIUse	判断 API 是否可用	(apiName: string) → boolean
getEnv	获取运行环境信息	() → EnvInfo