Permalink
Browse files

Docs: Improve BackHandler documentation (addEventListener and removeE…

…ventListener)

Summary:
This commit adds documentation to two methods of BackHandler API, addEventListener and removeEventListener. Despite being a simple change, it helps to keep the documentation consistent.

I have tested the `./website` locally, the changes look similar to some other components such as `NetInfo`.

[DOCS][ENHANCEMENT][BackHandler] - Improve BackHandler documentation (addEventListener and removeEventListener)
Closes #16618

Differential Revision: D6260935

Pulled By: hramos

fbshipit-source-id: ab04a9fca89ddaa1925844b5754caf1c355a9329
  • Loading branch information...
adrianomelo authored and facebook-github-bot committed Nov 7, 2017
1 parent de3976a commit 45ed14259677cff4cbd133e705ec4f0ec84bc216
Showing with 9 additions and 0 deletions.
  1. +9 −0 Libraries/Utilities/BackHandler.android.js
@@ -74,6 +74,12 @@ var BackHandler = {
DeviceEventManager.invokeDefaultBackPressHandler();
},
/**
* Adds an event handler. Supported events:
*
* - `hardwareBackPress`: Fires when the Android hardware back button is pressed or when the
* tvOS menu button is pressed.
*/
addEventListener: function (
eventName: BackPressEventName,
handler: Function
@@ -84,6 +90,9 @@ var BackHandler = {
};
},
/**
* Removes the event handler.
*/
removeEventListener: function(
eventName: BackPressEventName,
handler: Function

0 comments on commit 45ed142

Please sign in to comment.