mirror of
https://github.com/status-im/react-native.git
synced 2025-01-10 09:35:48 +00:00
b7e9374c64
Summary: Enable back navigation on Apple TV (with the remote's menu button) in code making use of BackAndroid. The module is renamed to BackHandler. BackAndroid is still exported to ReactNative for now, until external projects switch to using the new name for the module. The navigation in https://github.com/react-community/react-navigation makes use of this module. **Test plan**: Manual testing with an example app (https://github.com/dlowder-salesforce/react-nav-example). Closes https://github.com/facebook/react-native/pull/12571 Differential Revision: D4665152 Pulled By: ericvicenti fbshipit-source-id: 925400ce216379267e014457be6f5eedbe4453ec
97 lines
2.7 KiB
JavaScript
97 lines
2.7 KiB
JavaScript
/**
|
|
* Copyright (c) 2015-present, Facebook, Inc.
|
|
* All rights reserved.
|
|
*
|
|
* This source code is licensed under the BSD-style license found in the
|
|
* LICENSE file in the root directory of this source tree. An additional grant
|
|
* of patent rights can be found in the PATENTS file in the same directory.
|
|
*
|
|
* @providesModule BackHandler
|
|
*/
|
|
|
|
'use strict';
|
|
|
|
var DeviceEventManager = require('NativeModules').DeviceEventManager;
|
|
var RCTDeviceEventEmitter = require('RCTDeviceEventEmitter');
|
|
|
|
var DEVICE_BACK_EVENT = 'hardwareBackPress';
|
|
|
|
type BackPressEventName = $Enum<{
|
|
backPress: string,
|
|
}>;
|
|
|
|
var _backPressSubscriptions = new Set();
|
|
|
|
RCTDeviceEventEmitter.addListener(DEVICE_BACK_EVENT, function() {
|
|
var backPressSubscriptions = new Set(_backPressSubscriptions);
|
|
var invokeDefault = true;
|
|
var subscriptions = [...backPressSubscriptions].reverse();
|
|
for (var i = 0; i < subscriptions.length; ++i) {
|
|
if (subscriptions[i]()) {
|
|
invokeDefault = false;
|
|
break;
|
|
}
|
|
}
|
|
|
|
if (invokeDefault) {
|
|
BackHandler.exitApp();
|
|
}
|
|
});
|
|
|
|
/**
|
|
* Detect hardware button presses for back navigation.
|
|
*
|
|
* Android: Detect hardware back button presses, and programmatically invoke the default back button
|
|
* functionality to exit the app if there are no listeners or if none of the listeners return true.
|
|
*
|
|
* tvOS: Detect presses of the menu button on the TV remote. (Still to be implemented:
|
|
* programmatically disable menu button handling
|
|
* functionality to exit the app if there are no listeners or if none of the listeners return true.)
|
|
*
|
|
* iOS: Not applicable.
|
|
*
|
|
* The event subscriptions are called in reverse order (i.e. last registered subscription first),
|
|
* and if one subscription returns true then subscriptions registered earlier will not be called.
|
|
*
|
|
* Example:
|
|
*
|
|
* ```javascript
|
|
* BackHandler.addEventListener('hardwareBackPress', function() {
|
|
* // this.onMainScreen and this.goBack are just examples, you need to use your own implementation here
|
|
* // Typically you would use the navigator here to go to the last state.
|
|
*
|
|
* if (!this.onMainScreen()) {
|
|
* this.goBack();
|
|
* return true;
|
|
* }
|
|
* return false;
|
|
* });
|
|
* ```
|
|
*/
|
|
var BackHandler = {
|
|
|
|
exitApp: function() {
|
|
DeviceEventManager.invokeDefaultBackPressHandler();
|
|
},
|
|
|
|
addEventListener: function (
|
|
eventName: BackPressEventName,
|
|
handler: Function
|
|
): {remove: () => void} {
|
|
_backPressSubscriptions.add(handler);
|
|
return {
|
|
remove: () => BackHandler.removeEventListener(eventName, handler),
|
|
};
|
|
},
|
|
|
|
removeEventListener: function(
|
|
eventName: BackPressEventName,
|
|
handler: Function
|
|
): void {
|
|
_backPressSubscriptions.delete(handler);
|
|
},
|
|
|
|
};
|
|
|
|
module.exports = BackHandler;
|