Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
DCloud
unidocs-uni-app-x-zh
提交
b727b572
U
unidocs-uni-app-x-zh
项目概览
DCloud
/
unidocs-uni-app-x-zh
通知
144
Star
2
Fork
33
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
9
列表
看板
标记
里程碑
合并请求
11
DevOps
流水线
流水线任务
计划
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
U
unidocs-uni-app-x-zh
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
9
Issue
9
列表
看板
标记
里程碑
合并请求
11
合并请求
11
Pages
DevOps
DevOps
流水线
流水线任务
计划
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
流水线任务
提交
Issue看板
提交
b727b572
编写于
7月 30, 2024
作者:
G
git_robot
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
更新 utsApiJson.json、pageInstanceJson.json
上级
8bdec84e
变更
1
显示空白变更内容
内联
并排
Showing
1 changed file
with
1 addition
and
1 deletion
+1
-1
docs/.vuepress/utils/pageInstanceJson.json
docs/.vuepress/utils/pageInstanceJson.json
+1
-1
未找到文件。
docs/.vuepress/utils/pageInstanceJson.json
浏览文件 @
b727b572
{
"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
| on
Init | 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 | any | 是 | - | - | 打开当前页面路径中的参数 |
\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
| - | - | - |
\n
"
,
"param"
:
"#### 参数
\n\n
| 名称 | 类型 | 必填 | 默认值 | 兼容性 | 描述 |
\n
| :- | :- | :- | :- | :-: | :- |
\n
| options | **OnBackPressOptions** | 是 | - | - | tab 点击参数 |
\n
@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |
\n
@| :- | :- | :- | :- | :-: | :- |
\n
@| from |
\"
backbutton
\"
\\
|
\"
navigateBack
\"
| 是 | - | - | - backbutton 顶部导航栏左边的返回按钮或 Android 实体返回键<br/>- navigateBack 返回 API，即 uni.navigateBack() |
\n
"
,
"returnValue"
:
"#### 返回值 兼容性
\n\n
| 类型 | 描述 | 必备 |
\n
| :- | :- | :- |
\n
| boolean
\\
| null | 返回 `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 |
\"
button
\"
\\
|
\"
menu
\"
| 是 | - | - | 转发事件来源。<br/>可选值：<br/>- `button`：页面内转发按钮；<br/>- `menu`：右上角转发菜单。 |
\n
@| target | any | 是 | - | - | 如果 `from` 值是 `button`，则 `target` 是触发这次转发事件的 `button`，否则为 `undefined` |
\n
@| webViewUrl | string | 否 | - | - | 页面中包含 `<web-view>` 组件时，返回当前 `<web-view>` 的 url |
\n
"
,
"returnValue"
:
"#### 返回值 兼容性
\n\n
| 类型 | 描述 |
\n
| :- | :- |
\n
| **CustomShareContent**
\\
| Promise
\\
<Omit
\\
<CustomShareContent,
\"
promise
\"
>> | 转发内容 |
\n
@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |
\n
@| :- | :- | :- | :- | :-: | :- |
\n
@| title | string | 否 | - | - | 转发标题。默认值：当前应用名称 |
\n
@| path | string | 否 | - | - | 转发路径，必须是以 / 开头的完整路径。默认值：当前页面 path |
\n
@| imageUrl | string | 否 | - | - | 自定义图片路径，可以是本地文件路径、代码包文件路径或者网络图片路径。支持PNG及JPG。显示图片长宽比是 5:4，默认值：使用默认截图 |
\n
@| promise | Promise
\\
<[{ title?: string; path?: string; imageUrl?: string; }](#title-values)> | 否 | - | - | 如果该参数存在，则以 resolve 结果为准，如果三秒内不 resolve，分享会使用上面传入的默认参数 |
\n
@@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |
\n
@@| :- | :- | :- | :- | :-: | :- |
\n
@@| title | string | 否 | - | - | 转发标题。默认值：当前应用名称 |
\n
@@| path | string | 否 | - | - | 转发路径，必须是以 / 开头的完整路径。默认值：当前页面 path |
\n
@@| imageUrl | string | 否 | - | - | 自定义图片路径，可以是本地文件路径、代码包文件路径或者网络图片路径。支持PNG及JPG。显示图片长宽比是 5:4，默认值：使用默认截图 |
\n
@| desc | string | 否 | - | - | 自定义分享描述 |
\n
@| content | string | 否 | - | - | 自定义吱口令文案，最多 28 个字符 |
\n
@| bgImgUrl | string | 否 | - | - | 自定义分享预览大图，建议尺寸 750x825，支持：网络图片路径、apFilePath 路径、相对路径，不支持：base64 |
\n
@| scImgUrl | string | 否 | - | - | 自定义社交图片链接，作为分享到支付宝好友时的主体图片。建议尺寸 376x330 |
\n
@| searchTip | string | 否 | - | - | 生成分享截图的搜索引导，设置该参数后，会在分享图片中增加上支付宝搜“设置关键字”的内容，设置关键字不能超过 5 个字 |
\n
@| success | () => void | 否 | - | - | 分享成功后回调 |
\n
@| fail | () => void | 否 | - | - | 分享失败后回调 |
\n
@| templateId | string | 否 | - | - | 开发者后台设置的分享素材模板 id |
\n
@| PCPath | string | 否 | - | - | PC端打开小程序加载的页面，不支持可传空字符串 |
\n
@| PCMode | string | 否 | - | - | PC端打开小程序加载的模式，若需要在PC端打开小程序，则必须传PCMode字段 |
\n
@| generalWebpageUrl | string | 否 | - | - | PCQQ、低版本手机QQ无法执行小程序时打开的H5页面 |
\n
@| entryDataHash | string | 否 | - | - | 监听用户点击页面内转发按钮的，只有带上该参数，才支持快速分享 |
\n
@| shareTemplateId | string | 否 | - | - | 分享模板id，可以使用不同的分享模版，可选模版参考管理端分享模版一栏 |
\n
@| shareTemplateData | string | 否 | - | - | 分享模板的数据，不同的模板id需要不同的数据，数据的格式请参考管理端分享模版一栏 |
\n
@| shareType | string | 否 | - | - | 指定分享的类型 |
\n
@| type | string | 否 | - | - | 转发形式（1 - 京东小程序正式版；2 - 京东小程序体验版；京东App9.0.0开始不填或者其他值都会先判断是否有url参数，如果有打开分享后显示url对应页面，否则默认生成京东小程序官方的一个分享中间页面，点击可跳到京东app里面的对应小程序） |
\n
@| channel | string | 否 | - | - | 渠道（不写默认微信朋友，微信朋友圈），可用值有：Wxfriends,QQfriends,Wxmoments,QQzone,Sinaweibo |
\n
@| url | string | 否 | - | - | h5链接地址（h5分享填写，不填默认中间页） |
\n
@| keyShareChannel | string | 否 | - | - | 口令分享渠道，可用值有：Wxfriends,QQfriends,Wxmoments,QQzone,Sinaweibo，当需要口令分享时，需要配置此选项 |
\n
@| localImageUrl | string | 否 | - | - | 海报分享，本地图片地址（海报图片由开发者生成后将图片地址传入jdfile开头的格式） |
\n
@| onlineImageUrl | string | 否 | - | - | 海报分享，网络图片地址（海报图片由开发者生成后将图片地址传入），注意：localImageUrl、onlineImageUrl建议开发者使用时只传一个值 如果传入两个值 优先localImageUrl |
\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 |
\"
button
\"
\\
|
\"
menu
\"
| 是 | - | - | 转发事件来源。<br/>可选值：<br/>- `button`：页面内转发按钮；<br/>- `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))"
}}
{
"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
| on
BackPress | 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 | any | 是 | - | - | 打开当前页面路径中的参数 |
\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 |
\"
backbutton
\"
\\
|
\"
navigateBack
\"
| 是 | - | - | - backbutton 顶部导航栏左边的返回按钮或 Android 实体返回键<br/>- navigateBack 返回 API，即 uni.navigateBack() |
\n
"
,
"returnValue"
:
"#### 返回值
\n\n
| 类型 | 描述 | 必备 |
\n
| :- | :- | :- |
\n
| boolean
\\
| null | 返回 `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 |
\"
button
\"
\\
|
\"
menu
\"
| 是 | - | - | 转发事件来源。<br/>可选值：<br/>- `button`：页面内转发按钮；<br/>- `menu`：右上角转发菜单。 |
\n
@| target | any | 是 | - | - | 如果 `from` 值是 `button`，则 `target` 是触发这次转发事件的 `button`，否则为 `undefined` |
\n
@| webViewUrl | string | 否 | - | - | 页面中包含 `<web-view>` 组件时，返回当前 `<web-view>` 的 url |
\n
"
,
"returnValue"
:
"#### 返回值
\n\n
| 类型 | 描述 |
\n
| :- | :- |
\n
| **CustomShareContent**
\\
| Promise
\\
<Omit
\\
<CustomShareContent,
\"
promise
\"
>> | 转发内容 |
\n
@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |
\n
@| :- | :- | :- | :- | :-: | :- |
\n
@| title | string | 否 | - | - | 转发标题。默认值：当前应用名称 |
\n
@| path | string | 否 | - | - | 转发路径，必须是以 / 开头的完整路径。默认值：当前页面 path |
\n
@| imageUrl | string | 否 | - | - | 自定义图片路径，可以是本地文件路径、代码包文件路径或者网络图片路径。支持PNG及JPG。显示图片长宽比是 5:4，默认值：使用默认截图 |
\n
@| promise | Promise
\\
<[{ title?: string; path?: string; imageUrl?: string; }](#title-values)> | 否 | - | - | 如果该参数存在，则以 resolve 结果为准，如果三秒内不 resolve，分享会使用上面传入的默认参数 |
\n
@@| 名称 | 类型 | 必备 | 默认值 | 兼容性 | 描述 |
\n
@@| :- | :- | :- | :- | :-: | :- |
\n
@@| title | string | 否 | - | - | 转发标题。默认值：当前应用名称 |
\n
@@| path | string | 否 | - | - | 转发路径，必须是以 / 开头的完整路径。默认值：当前页面 path |
\n
@@| imageUrl | string | 否 | - | - | 自定义图片路径，可以是本地文件路径、代码包文件路径或者网络图片路径。支持PNG及JPG。显示图片长宽比是 5:4，默认值：使用默认截图 |
\n
@| desc | string | 否 | - | - | 自定义分享描述 |
\n
@| content | string | 否 | - | - | 自定义吱口令文案，最多 28 个字符 |
\n
@| bgImgUrl | string | 否 | - | - | 自定义分享预览大图，建议尺寸 750x825，支持：网络图片路径、apFilePath 路径、相对路径，不支持：base64 |
\n
@| scImgUrl | string | 否 | - | - | 自定义社交图片链接，作为分享到支付宝好友时的主体图片。建议尺寸 376x330 |
\n
@| searchTip | string | 否 | - | - | 生成分享截图的搜索引导，设置该参数后，会在分享图片中增加上支付宝搜“设置关键字”的内容，设置关键字不能超过 5 个字 |
\n
@| success | () => void | 否 | - | - | 分享成功后回调 |
\n
@| fail | () => void | 否 | - | - | 分享失败后回调 |
\n
@| templateId | string | 否 | - | - | 开发者后台设置的分享素材模板 id |
\n
@| PCPath | string | 否 | - | - | PC端打开小程序加载的页面，不支持可传空字符串 |
\n
@| PCMode | string | 否 | - | - | PC端打开小程序加载的模式，若需要在PC端打开小程序，则必须传PCMode字段 |
\n
@| generalWebpageUrl | string | 否 | - | - | PCQQ、低版本手机QQ无法执行小程序时打开的H5页面 |
\n
@| entryDataHash | string | 否 | - | - | 监听用户点击页面内转发按钮的，只有带上该参数，才支持快速分享 |
\n
@| shareTemplateId | string | 否 | - | - | 分享模板id，可以使用不同的分享模版，可选模版参考管理端分享模版一栏 |
\n
@| shareTemplateData | string | 否 | - | - | 分享模板的数据，不同的模板id需要不同的数据，数据的格式请参考管理端分享模版一栏 |
\n
@| shareType | string | 否 | - | - | 指定分享的类型 |
\n
@| type | string | 否 | - | - | 转发形式（1 - 京东小程序正式版；2 - 京东小程序体验版；京东App9.0.0开始不填或者其他值都会先判断是否有url参数，如果有打开分享后显示url对应页面，否则默认生成京东小程序官方的一个分享中间页面，点击可跳到京东app里面的对应小程序） |
\n
@| channel | string | 否 | - | - | 渠道（不写默认微信朋友，微信朋友圈），可用值有：Wxfriends,QQfriends,Wxmoments,QQzone,Sinaweibo |
\n
@| url | string | 否 | - | - | h5链接地址（h5分享填写，不填默认中间页） |
\n
@| keyShareChannel | string | 否 | - | - | 口令分享渠道，可用值有：Wxfriends,QQfriends,Wxmoments,QQzone,Sinaweibo，当需要口令分享时，需要配置此选项 |
\n
@| localImageUrl | string | 否 | - | - | 海报分享，本地图片地址（海报图片由开发者生成后将图片地址传入jdfile开头的格式） |
\n
@| onlineImageUrl | string | 否 | - | - | 海报分享，网络图片地址（海报图片由开发者生成后将图片地址传入），注意：localImageUrl、onlineImageUrl建议开发者使用时只传一个值 如果传入两个值 优先localImageUrl |
\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 |
\"
button
\"
\\
|
\"
menu
\"
| 是 | - | - | 转发事件来源。<br/>可选值：<br/>- `button`：页面内转发按钮；<br/>- `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))"
}}
\ No newline at end of file
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑！
取消
想要评论请
注册
或
登录
