跳到主要内容
版本:0.80

BackHandler

BackHandler API 检测用于后退导航的硬件按钮按下,允许你为系统的后退操作注册事件监听器,并允许你控制应用程序如何响应。它仅适用于 Android。

事件订阅按相反顺序调用(即最后注册的订阅最先被调用)。

  • 如果某个订阅返回 true, 则较早注册的订阅将不会被调用。
  • 如果没有订阅返回 true 或没有注册任何订阅, 它将编程式地调用默认返回按钮功能以退出应用。

针对模态框用户的警告: 如果你的应用显示了一个打开的 ModalBackHandler 将不会发布任何事件 (Modal 文档)。

模式

tsx
const subscription = BackHandler.addEventListener(
'hardwareBackPress',
function () {
/**
* this.onMainScreen 和 this.goBack 只是示例,
* 你需要在这里使用你自己的实现。
*
* 通常你会在这里使用 navigator 前往上一个状态。
*/

if (!this.onMainScreen()) {
this.goBack();
/**
* 当返回 true 时,事件将不会冒泡
* 且不会执行其他后退操作
*/
return true;
}
/**
* 返回 false 将允许事件冒泡且让其他事件监听器
* 或系统的默认后退操作被执行。
*/
return false;
},
);

// 在卸载时取消订阅监听器
subscription.remove();

示例

以下示例实现了一个场景,即确认用户是否想要退出应用:

BackHandler.addEventListener 创建一个事件监听器并返回一个 NativeEventSubscription 对象,该对象应使用 NativeEventSubscription.remove 方法清除。

与 React Navigation 一起使用

如果你正在使用 React Navigation 在不同屏幕间导航,你可以参考他们的指南 自定义 Android 返回按钮行为

BackHandler 钩子

React Native Hooks 有一个很好的 useBackHandler 钩子,它将简化设置事件监听器的过程。


参考

方法

addEventListener()

tsx
static addEventListener(
eventName: BackPressEventName,
handler: () => boolean | null | undefined,
): NativeEventSubscription;

exitApp()

tsx
static exitApp();