跳到主要内容
版本:0.82

BackHandler

BackHandler API 用于检测硬件返回导航按钮的按下事件,允许你注册系统返回动作的事件监听器,并让你控制应用程序的响应方式。它仅适用于 Android。

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

  • 如果某个订阅返回 true, 则更早注册的订阅不会被调用。
  • 如果没有订阅返回 true,或者根本没有注册订阅, 则会以编程方式调用默认的返回按钮功能来退出应用。
模态框用户警告

如果你的应用显示了一个已打开的 ModalBackHandler 将不会发布任何事件(参见 Modal 文档)。

模式

React 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()

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

exitApp()

React TSX
static exitApp();