uni-app 支持如下页面生命周期函数:
# onInit
监听页面初始化,其参数同 onLoad 参数,为上个页面传递的数据,参数类型为 Object(用于页面传参),触发时机早于 onLoad
onInit使用注意:
- 仅百度小程序基础库 3.260 以上支持 onInit 生命周期
- 其他版本或平台可以同时使用 onLoad 生命周期进行兼容,注意避免重复执行相同逻辑
- 不依赖页面传参的逻辑可以直接使用 created 生命周期替代
# onLoad
监听页面加载,其参数为上个页面传递的数据,参数类型为 Object(用于页面传参)
# onShow
监听页面显示。页面每次出现在屏幕上都触发,包括从下级页面点返回露出当前页面
# onReady
监听页面初次渲染完成。注意如果渲染速度快,会在页面进入动画完成前触发
# onHide
监听页面隐藏
# onUnload
监听页面卸载
# onResize
监听窗口尺寸变化
# onPullDownRefresh
监听用户下拉动作,一般用于下拉刷新
# onReachBottom
页面滚动到底部的事件(不是scroll-view滚到底),常用于下拉下一页数据。具体见下方注意事项
- onReachBottom使用注意 可在pages.json里定义具体页面底部的触发距离onReachBottomDistance,比如设为50,那么滚动页面到距离底部50px时,就会触发onReachBottom事件。
- 如使用scroll-view导致页面没有滚动,则触底事件不会被触发。scroll-view滚动到底部的事件请参考scroll-view的文档
# onTabItemTap
点击 tab 时触发,参数为Object,具体见下方注意事项
onTabItemTap 返回的json对象说明 :
属性 | 类型 | 说明 |
---|---|---|
index | String | 被点击tabItem的序号,从0开始 |
pagePath | String | 被点击tabItem的页面路径 |
text | String | 被点击tabItem的按钮文字 |
注意
- onTabItemTap常用于点击当前tabitem,滚动或刷新当前页面。如果是点击不同的tabitem,一定会触发页面切换。
- 如果想在App端实现点击某个tabitem不跳转页面,不能使用onTabItemTap,可以使用 plus.nativeObj.view (opens new window)放一个区块盖住原先的tabitem,并拦截点击事件。
- 支付宝小程序平台onTabItemTap表现为点击非当前tabitem后触发,因此不能用于实现点击返回顶部这种操作
onTabItemTap : function(e) {
console.log(e);
// e的返回格式为json对象: {"index":0,"text":"首页","pagePath":"pages/index/index"}
},
2
3
4
# onShareAppMessage
用户点击右上角分享
# onPageScroll
监听页面滚动,参数为Object
- onPageScroll (监听滚动、滚动监听、滚动事件)参数说明:
属性 | 类型 | 说明 |
---|---|---|
scrollTop | Number | 页面在垂直方向已滚动的距离(单位px) |
注意
- onPageScroll里不要写交互复杂的js,比如频繁修改页面。因为这个生命周期是在渲染层触发的,在非h5端,js是在逻辑层执行的,两层之间通信是有损耗的。如果在滚动过程中,频发触发两层之间的数据交换,可能会造成卡顿。
- 如果想实现滚动时标题栏透明渐变,在App和H5下,可在pages.json中配置titleNView下的type为transparent 参考 (opens new window)
- 如果需要滚动吸顶固定某些元素,推荐使用css的粘性布局,参考插件市场 (opens new window) 。插件市场也有其他js实现的吸顶插件,但性能不佳,需要时可自行搜索。
- 在App、微信小程序、H5中,也可以使用wxs监听滚动,参考 (opens new window) ;在app-nvue中,可以使用bindingx监听滚动,参考 (opens new window) 。
onPageScroll : function(e) { //nvue暂不支持滚动监听,可用bindingx代替
console.log("滚动距离为:" + e.scrollTop);
},
2
3
4
# onNavigationBarButtonTap
监听原生标题栏按钮点击事件,参数为Object
参数说明:
属性 | 类型 | 说明 |
---|---|---|
index | Number | 原生标题栏按钮数组的下标 |
onNavigationBarButtonTap : function (e) {
console.log(e);
// e的返回格式为json对象:{"text":"测试","index":0}
}
2
3
4
# onBackPress
监听页面返回,返回 event = {from:backbutton、 navigateBack} ,backbutton 表示来源是左上角返回按钮或 android 返回键;navigateBack表示来源是 uni.navigateBack ;。支付宝小程序只有真机能触发,只能监听非navigateBack引起的返回,不可阻止默认行为。
- onBackPress上不可使用async,会导致无法阻止默认返回
- onBackPress 回调参数对象说明:
属性 | 类型 | 说明 |
---|---|---|
from | String | 触发返回行为的来源:'backbutton'——左上角导航栏按钮及安卓返回键;'navigateBack'——uni.navigateBack() 方法。支付宝小程序端不支持返回此字段 |
export default {
data() {
return {};
},
onBackPress(options) {
console.log('from:' + options.from)
}
}
2
3
4
5
6
7
8
注意
- nvue 页面weex编译模式支持的生命周期同weex,具体参考: weex生命周期介绍 (opens new window) 。
- 支付宝小程序真机可以监听到非
navigateBack
引发的返回事件(使用小程序开发工具时不会触发onBackPress
),不可以阻止默认返回行为
# onNavigationBarSearchInputChanged
监听原生标题栏搜索输入框输入内容变化事件
# onNavigationBarSearchInputConfirmed
监听原生标题栏搜索输入框搜索事件,用户点击软键盘上的“搜索”按钮时触发。
# onNavigationBarSearchInputClicked
监听原生标题栏搜索输入框点击事件(pages.json 中的 searchInput 配置 disabled 为 true 时才会触发)
# onShareTimeline
监听用户点击右上角转发到朋友圈
# onAddToFavorites
监听用户点击右上角收藏