---
name: "onAppShow"
mode: "api"
versionRequirements:
  - { name: "基础库", version: "2.10.0" }
title: "ty.onAppShow - 监听小程序切前台事件。该事件与 App.onShow 的回调参数一致。"
---

## onAppShow

> [VERSION] 基础库 >= 2.10.0

### 描述

监听小程序切前台事件。该事件与 App.onShow 的回调参数一致。

### 参数

`(callback: Function)`

| 参数 | 类型 | 必填 | 描述 |
| --- | --- | --- | --- |
| `callback` | `(res: OnAppShowCallbackResult) => void` | 是 | 小程序切前台事件的回调函数 |

### 返回值

无


### 引用对象

##### `interface` OnAppShowCallbackResult

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `path` | `string` | 启动小程序的路径 |
| `query` | `Record<string, string>` | 启动小程序的 query 参数 |
| `scene` | `number` | 启动小程序的场景值 |
| `referrerInfo` | `ReferrerInfo` | 来源信息 |

##### `interface` ReferrerInfo

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `appId` | `string` | 来源小程序或公众号的 appId |
| `extraData` | `Record<string, unknown>` | 来源小程序传过来的数据 |


### 示例代码

#### 监听小程序切前台

```js
// app.js
App({
  onShow(res) {
    console.log('小程序切前台', res.path, res.query);
  },
});

// 或在页面中使用
// page.js
Page({
  onLoad() {
    ty.onAppShow((res) => {
      console.log('小程序切前台', res.path, res.query);
    });
  },
});
```