アプリ App

App API は、アプリ全体の情報とイベントを扱います。

オンラインで試す

getLaunchOptionsSyncgetEnv

他のタブに切り替えてから戻ると、visibility の記録が表示されます

App API デモ

getLaunchOptionsSync と getEnv。ブラウザのタブを切り替えると visibilitychange が 1 行追記され、アプリの前後台を模します

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	ページ	現在のページの表示 / 非表示

// アプリ層 — グローバルに 1 回だけ登録
woo.onAppShow(() => console.log('App Show'))
woo.onAppHide(() => console.log('App Hide'))

// ページ層 — ページごとに登録
woo.onShow(() => console.log('Page Show'))
woo.onHide(() => console.log('Page Hide'))

早見表

メソッド	説明	シグネチャ
getApp	アプリインスタンスを取得する	() → AppInstance
getAppInfo	アプリのメタ情報を取得する	() → Promise<AppInfo>
getLaunchOptions	起動パラメータを取得する	() → LaunchOptions
canIUse	API が利用可能かどうかを判定する	(apiName: string) → boolean
getEnv	実行環境の情報を取得する	() → EnvInfo