{"lifeCycle":{"name":"页面生命周期","compatibility":"| 组合式 | 选项式 | Web | Android | iOS | 描述 |\n| :- | :- | :- | :- | :- | :- |\n| onLoad | onLoad | 4.0 | 3.9 | 4.11 | 生命周期回调 监听页面加载<br/><br/>页面加载时触发。一个页面只会调用一次，可以在 onLoad 的参数中获取打开当前页面路径中的参数。 |\n| onPageShow | onShow | 4.0 | 3.9 | 4.11 | 生命周期回调 监听页面显示<br/><br/>页面显示/切入前台时触发。<br/> |\n| onReady | onReady | 4.0 | 3.9 | 4.11 | 生命周期回调 监听页面初次渲染完成<br/><br/>页面初次渲染完成时触发。一个页面只会调用一次，代表页面已经准备妥当，可以和视图层进行交互。<br/> |\n| onPageHide | onHide | 4.0 | 3.9 | 4.11 | 生命周期回调 监听页面隐藏<br/><br/>页面隐藏/切入后台时触发。 如 `navigateTo` 或底部 `tab` 切换到其他页面，应用切入后台等。<br/> |\n| onUnload | onUnload | 4.0 | 3.9 | 4.11 | 生命周期回调 监听页面卸载<br/><br/>页面卸载时触发。如 `redirectTo` 或 `navigateBack` 到其他页面时。<br/> |\n| onPullDownRefresh | onPullDownRefresh | 4.0 | 3.9 | 4.11 | 监听用户下拉动作<br/>- 需要在 `pages.json` 的页面配置中开启 `enablePullDownRefresh` 。<br/>- 可以通过 `uni.startPullDownRefresh` 触发下拉刷新，调用后触发下拉刷新动画，效果与用户手动下拉刷新一致。<br/>- 当处理完数据刷新后，`uni.stopPullDownRefresh` 可以停止当前页面的下拉刷新。<br/> |\n| onReachBottom | onReachBottom | 4.0 | 3.9 | 4.11 | 页面上拉触底事件的处理函数<br/>- 可以在 `pages.json` 的页面配置中设置触发距离 `onReachBottomDistance` 。<br/>- 在触发距离内滑动期间，本事件只会被触发一次。<br/> |\n| onPageScroll | onPageScroll | 4.0 | 3.9 | 4.13 | 页面滚动触发事件的处理函数<br/><br/>监听用户滑动页面事件。 |\n| onResize | onResize | 4.0 | 3.9 | 4.11 | 页面尺寸改变时触发 |\n| onBackPress | onBackPress | 4.0 | 3.9 | 4.11 | 监听页面返回 |\n| onInit | onInit | x | x | x | 生命周期回调 监听页面初始化<br/><br/>页面初始化时触发。一个页面只会调用一次，可以在 onInit 的参数中获取打开当前页面路径中的参数。 |\n| onShareAppMessage | onShareAppMessage | x | x | x | 用户点击右上角转发<br/><br/>监听用户点击页面内转发按钮（`<button>` 组件 `open-type=\"share\"`）或右上角菜单“转发”按钮的行为，并自定义转发内容。 |\n| onShareTimeline | onShareTimeline | x | x | x | 用户点击右上角转发到朋友圈<br/><br/>监听右上角菜单“分享到朋友圈”按钮的行为，并自定义发享内容。<br/> |\n| onAddToFavorites | onAddToFavorites | x | x | x | 用户点击右上角收藏<br/><br/>监听用户点击右上角菜单“收藏”按钮的行为，并自定义收藏内容。<br/> |\n| onTabItemTap | onTabItemTap | 4.0 | x | x | 当前是 tab 页时，点击 tab 时触发 |\n| onNavigationBarButtonTap | onNavigationBarButtonTap | 4.0 | x | x | 监听原生标题栏按钮点击事件 |\n| onNavigationBarSearchInputChanged | onNavigationBarSearchInputChanged | 4.0 | x | x | 监听原生标题栏搜索输入框输入内容变化事件<br/> |\n| onNavigationBarSearchInputConfirmed | onNavigationBarSearchInputConfirmed | 4.0 | x | x | 监听原生标题栏搜索输入框搜索事件，用户点击软键盘上的“搜索”按钮时触发。<br/> |\n| onNavigationBarSearchInputClicked | onNavigationBarSearchInputClicked | 4.0 | x | x | 监听原生标题栏搜索输入框点击事件<br/> |"},"onLoad":{"name":"### onLoad(query) @onload","description":"生命周期回调 监听页面加载\n\n页面加载时触发。一个页面只会调用一次，可以在 onLoad 的参数中获取打开当前页面路径中的参数。","compatibility":"#### onLoad 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| 4.0 | 3.9 | 4.11 |\n","param":"#### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| query | OnLoadOptions | 是 | - | - | 打开当前页面路径中的参数 | \n","returnValue":"","tutorial":"\n#### 参见\n\n- [参见uni-app相关文档]([https://uniapp.dcloud.net.cn/tutorial/page.html#lifecycle](https://uniapp.dcloud.net.cn/tutorial/page.html#lifecycle))"},"onShow":{"name":"### onShow() @onshow","description":"生命周期回调 监听页面显示\n\n页面显示/切入前台时触发。\n","compatibility":"#### onShow 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| 4.0 | 3.9 | 4.11 |\n","param":"","returnValue":"","tutorial":"\n#### 参见\n\n- [参见uni-app相关文档]([https://uniapp.dcloud.net.cn/tutorial/page.html#lifecycle](https://uniapp.dcloud.net.cn/tutorial/page.html#lifecycle))"},"onReady":{"name":"### onReady() @onready","description":"生命周期回调 监听页面初次渲染完成\n\n页面初次渲染完成时触发。一个页面只会调用一次，代表页面已经准备妥当，可以和视图层进行交互。\n","compatibility":"#### onReady 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| 4.0 | 3.9 | 4.11 |\n","param":"","returnValue":"","tutorial":"\n#### 参见\n\n- [参见uni-app相关文档]([https://uniapp.dcloud.net.cn/tutorial/page.html#lifecycle](https://uniapp.dcloud.net.cn/tutorial/page.html#lifecycle))"},"onHide":{"name":"### onHide() @onhide","description":"生命周期回调 监听页面隐藏\n\n页面隐藏/切入后台时触发。 如 `navigateTo` 或底部 `tab` 切换到其他页面，应用切入后台等。\n","compatibility":"#### onHide 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| 4.0 | 3.9 | 4.11 |\n","param":"","returnValue":"","tutorial":"\n#### 参见\n\n- [参见uni-app相关文档]([https://uniapp.dcloud.net.cn/tutorial/page.html#lifecycle](https://uniapp.dcloud.net.cn/tutorial/page.html#lifecycle))"},"onUnload":{"name":"### onUnload() @onunload","description":"生命周期回调 监听页面卸载\n\n页面卸载时触发。如 `redirectTo` 或 `navigateBack` 到其他页面时。\n","compatibility":"#### onUnload 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| 4.0 | 3.9 | 4.11 |\n","param":"","returnValue":"","tutorial":"\n#### 参见\n\n- [参见uni-app相关文档]([https://uniapp.dcloud.net.cn/tutorial/page.html#lifecycle](https://uniapp.dcloud.net.cn/tutorial/page.html#lifecycle))"},"onPullDownRefresh":{"name":"### onPullDownRefresh() @onpulldownrefresh","description":"监听用户下拉动作\n- 需要在 `pages.json` 的页面配置中开启 `enablePullDownRefresh` 。\n- 可以通过 `uni.startPullDownRefresh` 触发下拉刷新，调用后触发下拉刷新动画，效果与用户手动下拉刷新一致。\n- 当处理完数据刷新后，`uni.stopPullDownRefresh` 可以停止当前页面的下拉刷新。\n","compatibility":"#### onPullDownRefresh 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| 4.0 | 3.9 | 4.11 |\n","param":"","returnValue":"","tutorial":"\n#### 参见\n\n- [参见uni-app相关文档]([https://uniapp.dcloud.net.cn/tutorial/page.html#lifecycle](https://uniapp.dcloud.net.cn/tutorial/page.html#lifecycle))"},"onReachBottom":{"name":"### onReachBottom() @onreachbottom","description":"页面上拉触底事件的处理函数\n- 可以在 `pages.json` 的页面配置中设置触发距离 `onReachBottomDistance` 。\n- 在触发距离内滑动期间，本事件只会被触发一次。\n","compatibility":"#### onReachBottom 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| 4.0 | 3.9 | 4.11 |\n","param":"","returnValue":"","tutorial":"\n#### 参见\n\n- [参见uni-app相关文档]([https://uniapp.dcloud.net.cn/tutorial/page.html#lifecycle](https://uniapp.dcloud.net.cn/tutorial/page.html#lifecycle))"},"onPageScroll":{"name":"### onPageScroll(options) @onpagescroll","description":"页面滚动触发事件的处理函数\n\n监听用户滑动页面事件。","compatibility":"#### onPageScroll 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| 4.0 | 3.9 | 4.13 |\n","param":"#### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | **OnPageScrollOptions** | 是 | - | - | 页面滚动参数 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| scrollTop | number | 是 | - | - | 页面在垂直方向已滚动的距离（单位 px） | \n","returnValue":"","tutorial":"\n#### 参见\n\n- [参见uni-app相关文档]([https://uniapp.dcloud.net.cn/tutorial/page.html#lifecycle](https://uniapp.dcloud.net.cn/tutorial/page.html#lifecycle))"},"onResize":{"name":"### onResize(options) @onresize","description":"页面尺寸改变时触发","compatibility":"#### onResize 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| 4.0 | 3.9 | 4.11 |\n","param":"#### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | **OnResizeOptions** | 是 | - | - | 页面滚动参数 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| deviceOrientation | string | 是 | - | - | 屏幕方向 |\n@| size | **OnResizeSize** | 是 | - | - | 新的显示区域尺寸 |\n@@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@@| :- | :- | :- | :- | :-: | :- |\n@@| screenHeight | number | 是 | - | - | 新的屏幕高度 |\n@@| screenWidth | number | 是 | - | - | 新的屏幕宽度 |\n@@| windowHeight | number | 是 | - | - | 新的显示区域高度 |\n@@| windowWidth | number | 是 | - | - | 新的显示区域宽度 | \n","returnValue":"","tutorial":"\n#### 参见\n\n- [参见uni-app相关文档]([https://uniapp.dcloud.net.cn/tutorial/page.html#lifecycle](https://uniapp.dcloud.net.cn/tutorial/page.html#lifecycle))"},"onBackPress":{"name":"### onBackPress(options) @onbackpress","description":"监听页面返回","compatibility":"#### onBackPress 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| 4.0 | 3.9 | 4.11 |\n","param":"#### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | **OnBackPressOptions** | 是 | - | - | tab 点击参数 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| from | string | 是 | - | - | - backbutton 顶部导航栏左边的返回按钮或 Android 实体返回键<br/>- navigateBack 返回 API，即 uni.navigateBack() |\n@@| 合法值 | 兼容性 | 描述 |\n@@| :- | :-: | :- |\n@@| backbutton | - | - |\n@@| navigateBack | - | - | \n","returnValue":"#### 返回值 \n\n| 类型 | 描述 | 必备 |\n| :- | :- | :- |\n| boolean | 返回 `true` 时阻止页面返回 | 否 |\n \n","tutorial":"\n#### 参见\n\n- [参见uni-app相关文档]([https://uniapp.dcloud.net.cn/tutorial/page.html#lifecycle](https://uniapp.dcloud.net.cn/tutorial/page.html#lifecycle))"},"onInit":{"name":"### onInit(query?) @oninit","description":"生命周期回调 监听页面初始化\n\n页面初始化时触发。一个页面只会调用一次，可以在 onInit 的参数中获取打开当前页面路径中的参数。","compatibility":"#### onInit 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| x | x | x |\n","param":"#### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| query | AnyObject | 否 | - | - | 打开当前页面路径中的参数 | \n","returnValue":"","tutorial":"\n#### 参见\n\n- [参见uni-app相关文档]([https://uniapp.dcloud.net.cn/tutorial/page.html#lifecycle](https://uniapp.dcloud.net.cn/tutorial/page.html#lifecycle))"},"onShareAppMessage":{"name":"### onShareAppMessage(options) @onshareappmessage","description":"用户点击右上角转发\n\n监听用户点击页面内转发按钮（`<button>` 组件 `open-type=\"share\"`）或右上角菜单“转发”按钮的行为，并自定义转发内容。","compatibility":"#### onShareAppMessage 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| x | x | x |\n","param":"#### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | **OnShareAppMessageOption** | 是 | - | - | 分享发起来源参数 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| from | string | 是 | - | - | 转发事件来源。<br/>可选值：<br/>- `button`：页面内转发按钮；<br/>- `menu`：右上角转发菜单。 |\n@@| 合法值 | 兼容性 | 描述 |\n@@| :- | :-: | :- |\n@@| button | - | - |\n@@| menu | - | - |\n@| target | any | 是 | - | - | 如果 `from` 值是 `button`，则 `target` 是触发这次转发事件的 `button`，否则为 `undefined` |\n@| webViewUrl | string | 否 | - | - | 页面中包含 `<web-view>` 组件时，返回当前 `<web-view>` 的 url | \n","returnValue":"#### 返回值 \n\n| 类型 | 描述 |\n| :- | :- |\n| string | 转发内容 |\n\n##### 的属性值 @onshareappmessage-values\n| 合法值 | 兼容性 | 描述 |\n| :- | :-: | :- |\n| interface | - | - |\n| Promise | - | - | \n","tutorial":"\n#### 参见\n\n- [参见uni-app相关文档]([https://uniapp.dcloud.net.cn/tutorial/page.html#lifecycle](https://uniapp.dcloud.net.cn/tutorial/page.html#lifecycle))"},"onShareTimeline":{"name":"### onShareTimeline() @onsharetimeline","description":"用户点击右上角转发到朋友圈\n\n监听右上角菜单“分享到朋友圈”按钮的行为，并自定义发享内容。\n","compatibility":"#### onShareTimeline 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| x | x | x |\n","param":"","returnValue":"#### 返回值 \n\n| 类型 |\n| :- |\n| **ShareTimelineContent** |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| title | string | 否 | - | - | 自定义标题，即朋友圈列表页上显示的标题。默认值：当前小程序名称 |\n@| query | string | 否 | - | - | 自定义页面路径中携带的参数，如 path?a=1&b=2 的 “?” 后面部分。默认值：当前页面路径携带的参数 |\n@| imageUrl | string | 否 | - | - | 自定义图片路径，可以是本地文件或者网络图片。支持 PNG 及 JPG，显示图片长宽比是 1:1。默认值：小程序 Logo | \n","tutorial":"\n#### 参见\n\n- [参见uni-app相关文档]([https://uniapp.dcloud.net.cn/tutorial/page.html#lifecycle](https://uniapp.dcloud.net.cn/tutorial/page.html#lifecycle))"},"onAddToFavorites":{"name":"### onAddToFavorites(options) @onaddtofavorites","description":"用户点击右上角收藏\n\n监听用户点击右上角菜单“收藏”按钮的行为，并自定义收藏内容。\n","compatibility":"#### onAddToFavorites 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| x | x | x |\n","param":"#### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | **OnAddToFavoritesOption** | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| from | string | 是 | - | - | 转发事件来源。<br/>可选值：<br/>- `button`：页面内转发按钮；<br/>- `menu`：右上角转发菜单。 |\n@@| 合法值 | 兼容性 | 描述 |\n@@| :- | :-: | :- |\n@@| button | - | - |\n@@| menu | - | - |\n@| webviewUrl | string | 是 | - | - | 页面中包含 `<web-view>` 组件时，返回当前 `<web-view>` 的 url | \n","returnValue":"#### 返回值 \n\n| 类型 |\n| :- |\n| **CustomFavoritesContent** |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| title | string | 否 | - | - | 自定义标题，默认值：页面标题或账号名称 |\n@| path | string | 否 | - | - | 自定义 query 字段 |\n@| imageUrl | string | 否 | - | - | 自定义图片，显示图片长宽比为 1：1 | \n","tutorial":"\n#### 参见\n\n- [参见uni-app相关文档]([https://uniapp.dcloud.net.cn/tutorial/page.html#lifecycle](https://uniapp.dcloud.net.cn/tutorial/page.html#lifecycle))"},"onTabItemTap":{"name":"### onTabItemTap(options) @ontabitemtap","description":"当前是 tab 页时，点击 tab 时触发","compatibility":"#### onTabItemTap 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| 4.0 | x | x |\n","param":"#### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | **OnTabItemTapOption** | 是 | - | - | tab 点击参数 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| index | number | 是 | - | - | 被点击 tabItem 的序号，从0开始 |\n@| pagePath | string | 是 | - | - | 被点击 tabItem 的页面路径 |\n@| text | string | 是 | - | - | 被点击 tabItem 的按钮文字 | \n","returnValue":"","tutorial":"\n#### 参见\n\n- [参见uni-app相关文档]([https://uniapp.dcloud.net.cn/tutorial/page.html#lifecycle](https://uniapp.dcloud.net.cn/tutorial/page.html#lifecycle))"},"onNavigationBarButtonTap":{"name":"### onNavigationBarButtonTap(options) @onnavigationbarbuttontap","description":"监听原生标题栏按钮点击事件","compatibility":"#### onNavigationBarButtonTap 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| 4.0 | x | x |\n","param":"#### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| options | **OnNavigationBarButtonTapOption** | 是 | - | - | tab 点击参数 |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| index | number | 是 | - | - | 原生标题栏按钮数组的下标 | \n","returnValue":"","tutorial":"\n#### 参见\n\n- [参见uni-app相关文档]([https://uniapp.dcloud.net.cn/tutorial/page.html#lifecycle](https://uniapp.dcloud.net.cn/tutorial/page.html#lifecycle))"},"onNavigationBarSearchInputChanged":{"name":"### onNavigationBarSearchInputChanged(event) @onnavigationbarsearchinputchanged","description":"监听原生标题栏搜索输入框输入内容变化事件\n","compatibility":"#### onNavigationBarSearchInputChanged 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| 4.0 | x | x |\n","param":"#### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| event | **NavigationBarSearchInputEvent** | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| text | string | 是 | - | - | 搜索输入框输入内容 | \n","returnValue":"","tutorial":"\n#### 参见\n\n- [参见uni-app相关文档]([https://uniapp.dcloud.net.cn/tutorial/page.html#lifecycle](https://uniapp.dcloud.net.cn/tutorial/page.html#lifecycle))"},"onNavigationBarSearchInputConfirmed":{"name":"### onNavigationBarSearchInputConfirmed(event) @onnavigationbarsearchinputconfirmed","description":"监听原生标题栏搜索输入框搜索事件，用户点击软键盘上的“搜索”按钮时触发。\n","compatibility":"#### onNavigationBarSearchInputConfirmed 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| 4.0 | x | x |\n","param":"#### 参数 \n\n| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |\n| :- | :- | :- | :- | :-: | :- |\n| event | **NavigationBarSearchInputEvent** | 是 | - | - | - |\n@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |\n@| :- | :- | :- | :- | :-: | :- |\n@| text | string | 是 | - | - | 搜索输入框输入内容 | \n","returnValue":"","tutorial":"\n#### 参见\n\n- [参见uni-app相关文档]([https://uniapp.dcloud.net.cn/tutorial/page.html#lifecycle](https://uniapp.dcloud.net.cn/tutorial/page.html#lifecycle))"},"onNavigationBarSearchInputClicked":{"name":"### onNavigationBarSearchInputClicked() @onnavigationbarsearchinputclicked","description":"监听原生标题栏搜索输入框点击事件\n","compatibility":"#### onNavigationBarSearchInputClicked 兼容性 \n| Web | Android | iOS |\n| :- | :- | :- |\n| 4.0 | x | x |\n","param":"","returnValue":"","tutorial":"\n#### 参见\n\n- [参见uni-app相关文档]([https://uniapp.dcloud.net.cn/tutorial/page.html#lifecycle](https://uniapp.dcloud.net.cn/tutorial/page.html#lifecycle))"}}
