DCloud_UNI_CHB
DCloud_UNI_CHB
  • 发布:2018-10-23 17:17
  • 更新:2024-03-28 18:51
  • 阅读:258320

uni-app自定义返回逻辑教程

分类:uni-app

自 HBuilderX v1.1.0 起,uni-app 的页面新增 onBackPress(event) 生命周期函数。

onBackPress(event) 返回 event ={from: backbutton | navigateBack}

说明

当用户进行以下操作时,会触发该函数:

  • Android 实体返回键 (from = backbutton)
  • 顶部导航栏左边的返回按钮 (from = backbutton)
  • 返回 API,即 uni.navigateBack() (from = navigateBack)

注意事项:

  • 只有在该函数中返回值为 true 时,才表示不执行默认的返回,自行处理此时的业务逻辑。
  • 当不阻止页面返回却直接调用页面路由相关接口(如:uni.switchTab)时,可能会导致页面显示异常,可以通过延迟调用路由相关接口解决。
  • 不返回或返回其它值,均会执行默认的返回行为。
  • H5 平台,顶部导航栏返回按钮支持 onBackPress(),浏览器默认返回按键及Android手机实体返回键不支持 onBackPress()
  • 暂不支持直接在自定义组件中配置该函数,目前只能是在页面中来处理。

场景示例

页面返回

场景说明:

页面中的遮罩处于显示状态时,点击返回不希望直接关闭页面,而是隐藏掉遮罩。遮罩隐藏后,继续点击返回再执行默认的逻辑。

自定义遮罩

通常自定义的遮罩/弹出层,都会做成组件,这样方便复用。

新建 uni-app 项目->components->mask.vue 文件,代码如下:

<template>  
    <view>  
        <view class="cpt-mask">  
        </view>  
    </view>  
</template>  

<script>  
    export default {}  
</script>  

<style>  
    .cpt-mask {  
        position: fixed;  
        top: 0;  
        left: 0;  
        width: 100%;  
        height: 100%;  
        background-color: #000000;  
        opacity: 0.5;  
        z-index: 99;  
    }  
</style>

引用遮罩组件

在页面中引入 mask 自定义组件后,通过一个状态值来控制其隐藏/显示。

<mask v-if="showMask"></mask>

这里用 v-if,不要用 v-show,自定义组件存在一些问题待优化。

处理返回逻辑

在 onBackPress 中,判定当前遮罩是否处于显示状态。如果显示,则关闭遮罩并返回 true。

onBackPress() {  
  if(this.showMask) {  
    this.showMask = false;  
    return true;  
  }  
},

多级返回

部分业务场景下,返回的逻辑中需要返回多级页面。

由于 uni.navigateBack() 同样会触发 onBackPress 函数。因此在 onBackPress 中直接调用 uni.navigateBack() 并始终返回 true 会引发死循环。
此时,需要根据 onBackPress 的回调对象中的 from 值来做处理,当来源是 'navigateBack' 时,返回 false。

<template>  
    <view>  
    </view>  
</template>  

<script>  
    export default {  
        data() {  
            return {};  
        },  
        onBackPress(options) {  
            if (options.from === 'navigateBack') {  
                return false;  
            }  
            this.back();  
            return true;  
        },  
        methods: {  
            back() {  
                uni.navigateBack({  
                    delta: 2  
                });  
            }  
        },  
    }  
</script>  

<style>  

</style>

应用退出

场景说明:

若在App首页,点击手机物理返回键,此时无返回页面可关闭,uni-app默认会提示“再按一次退出应用”;若想自定义退出信息,如修改为:出现一个拟态窗口提示我们是否退出应用,点击确定退出应用。点击取消,不做操作。

实现方案:

在 onBackPress 中,遮罩不显示的状态下,点击返回键将弹出拟态窗。

onBackPress() {  
   if(this.showMask) {  
     this.showMask = false;  
     return true;  
   }else{  
      uni.showModal({  
        title: '提示',  
        content: '是否退出uni-app?',  
        success: function(res) {  
            if (res.confirm) {  
                // 退出当前应用,改方法只在App中生效  
                plus.runtime.quit();  
            } else if (res.cancel) {  
                console.log('用户点击取消');  
            }  
        }  
      });  
      return true  
   }  
},

实现效果如下图:

运行体验

完整的示例代码,见附件。解压后,拖至 HBuilderX 运行即可。

37 关注 分享
Trust 8***@qq.com dmj 1***@qq.com 2***@qq.com 3***@qq.com a***@astcn.net 达达x zting590 a***@qq.com 1***@qq.com w***@qq.com 恰似你的温柔丶 最光阴 mfan updream Jasmine001 1***@qq.com c***@sodo-tech.com zr12041019 rysnone uniuk 心乐 Yugi 4***@qq.com 1***@qq.com l***@163.com 陈子文 l***@foxmail.com 小康爱编程 土豆鸡丁_o0 4***@qq.com l***@163.com 鸡排饭加个蛋 l***@qq.com DCloud_UNI_HRK z***@163.com

要回复文章请先登录注册

4***@qq.com

4***@qq.com

回复 l***@163.com :
只能自定义顶部导航
2022-11-30 10:05
x***@126.com

x***@126.com

onBackPress(options) {
if (options.from == "backbutton") {
return false;
}
return true;
},
我遇到的问题是,在安卓和ios上点击返回按钮,触发2次,如何规避
2022-11-21 11:18
3***@qq.com

3***@qq.com

当前页面刷新一次再点击返回按钮的时候,onBackPress事件监听不到。我遇到的问题是,在当前页面刷新一次后,再点击返回按钮,返回的上一页的url上的参数会丢失,希望通过onBackPress事件监听把参数带回到上一页中
2022-11-18 17:31
l***@163.com

l***@163.com

微信小程序不支持,怎么解决
2022-10-08 10:29
1***@qq.com

1***@qq.com

回复 我是船长 :
import { onBackPress } from '@dcloudio/uni-app';
2022-08-02 09:17
8***@qq.com

8***@qq.com

onBackPress 模板上的tabbar 和普通页面 都可以监听到,自己的项目就是监听不到tabbar的onBackPress 普通页面是可以的,请问有知道原因的吗
2022-07-11 11:09
8***@qq.com

8***@qq.com

回复 1***@qq.com :
请问,你解决了吗,什么原因呢
2022-07-11 11:07
dsking

dsking

回复 2***@qq.com :
遇到同样的问题 研究到深夜才解决,主要原因是使用router冲突了 ,onBackPress拦截后,router会处于‘当前页面正在处于跳转状态,请稍后再进行跳转’的状态,所以在触发返回前解锁就可以了 加上this.$Router.$lockStatus = false 即可。
参考文档:https://hhyang.cn/v2/start/cross/navLock.html
2022-06-24 01:48
2***@qq.com

2***@qq.com

为什么安卓app要点两下才能触发onBackPress呢??
2022-05-22 10:22
x***@163.com

x***@163.com

Vue3 setup 调用返回的option为{}
2022-05-20 09:39