When the user presses the Android hardware back button in React Native, react-navigation will pop a screen or exit the app if there are no screens to pop. This is the sensible default behavior, but there are situations when you might want to implement custom handling. This is where handling android back button is useful. You can also check react-navigation-backhandler library to handle the back press.
To handle the Android Back Button Press in the react native we have to register the hardwareBackPress event listener with a callback function, which will be called after pressing the Back Button. We should also remove the listener when we are jumping out from the screen (where we have added the listener) because sometime after going to the next screen or any other screen the listener remains active in the background if the last screen is in the stack and not killed by the system.
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.
1. Add the hardwareBackPress using
1 | BackHandler.addEventListener('hardwareBackPress', this.handleBackButtonClick); |
2. Remove the hardwareBackPress using
1 | BackHandler.removeEventListener('hardwareBackPress', this.handleBackButtonClick); |
3. To handle the event we have used the function handleBackButtonClick.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | handleBackButtonClick() { // After clicking on Back Button // To go to any other screen this.props.navigation.navigate('ThirdPage'); // To popup the default screen this.props.navigation.goBack(null); // To exit from your App BackHandler.exitApp(); // Returning true/false is described below return true; } |
Returning true from handleBackButtonClick denotes that we have handled the event, and react-navigation’s listener will not get called, thus not popping the screen. Returning false will cause the event to bubble up and react-navigation’s listener will pop the screen.
Why not use component lifecycle methods?
At first, you may be inclined to use componentDidMount to subscribe for the back press event and componentWillUnmount to unsubscribe. The reason, why we do not use them, is that they are not generally called when entering or leaving a screen.
More specifically, consider a StackNavigator with screens A and B. After navigating to A, its componentDidMount is called. When pushing B, its componentDidMount is also called, but A remains mounted and its componentWillUnmount is therefore not called.
Similarly, when going back from B to A, componentWillUnmount of B is called, but componentDidMount of A is not because A remained mounted the whole time.
So here was the big discussion. Now Let’s start with the code.
In our example, we are going from FirstPage to SecondPage using navigate and after clicking Back Button on SecondPage we will navigate to ThirdPage with an alert. We have also used this.props.navigation.goBack(null); on ThirdPage to popup the default screen. So let’s get started.
This example will work for the React Navigation Version 3+. If you are using Version 2+ then please find the comments in the code for the suitable changes or can see our old post React Native Navigation Version 2+ for the help.
To Make a React Native App
Getting started with React Native will help you to know more about the way you can make a React Native project. We are going to use react-native init to make our React Native App. Assuming that you have node installed, you can use npm to install thereact-native-cli command line utility.
Open the terminal and go to the workspace and runnpm install -g react-native-clireact-native init ProjectNameInstallation of Dependencies
To use createStackNavigator you need to install react-navigation and react-native-gesture-handler dependencies.
To install these dependencies open the terminal and jump into your project
1 | cd ProjectName |
Run the following commands
1 | npm install react-navigation --save |
1 | npm install react-native-gesture-handler --save |
This command will copy all the dependencies into your node_module directory. –save is optional, it is just to update dependencies in your package.json file.
Linking of Dependencies
After installing the dependencies you need to link it with your project using
1 | react-native link |
After linking the dependency if you face Could not Compile Settings File project/android/settings.gradle error while building and installing the project then you can find the solution here.
Project File Structure
To start with this Example you need to create a directory named pages in your project and create three files FirstPge.js, SecondPage.js, and ThirdPage.js.
Now Open App.js in any code editor and replace the code with the following code.
App.js
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 | //This is an example code to handle Android back button press// import React, { Component } from 'react'; //import react in our code. //For React Navigation 2.+ //import {createStackNavigator} from 'react-navigation'; //For React Navigation 3.+ import {createStackNavigator,createAppContainer} from 'react-navigation'; //import Navigator in our project import FirstPage from './pages/FirstPage'; import SecondPage from './pages/SecondPage'; import ThirdPage from './pages/ThirdPage'; //import all the screens we are going to switch const App = createStackNavigator({ //Constant which holds all the screens like index of any book FirstPage: { screen: FirstPage }, //First entry by default be our first screen if we do not define initialRouteName SecondPage: { screen: SecondPage }, ThirdPage: { screen: ThirdPage }, }, { initialRouteName: 'FirstPage', } ); //For React Navigation 2.+ //export default App; //For React Navigation 3.+ export default createAppContainer(App); |
Open pages/FirstPage.js in any code editor and replace the code with the following code.
FirstPage.js
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 | // First screen which will be used to navigate to second screen import React, { Component } from 'react'; //import react in our code. import { StyleSheet, View, Button, TextInput} from 'react-native'; //import all the components we are going to use. export default class FirstPage extends Component { static navigationOptions = { //Setting the header of the screen title: 'First Page', }; render() { const { navigate } = this.props.navigation; return ( <View style={styles.container}> {/*Button to go to the next SecondPage*/} <Button title='Go next' onPress={() =>navigate('SecondPage')} /> </View> ); } } const styles = StyleSheet.create({ container: { flex: 1, backgroundColor: '#fff', alignItems: 'center', padding:16 }, }); |
Open pages/SecondPage.js in any code editor and replace the code with the following code.
SecondPage.js
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 | // Second Screen which will be used to show backpress import React, { Component } from 'react'; //import react in our code. import { StyleSheet, View, Text ,BackHandler } from 'react-native'; //import all the components we are going to use. export default class SecondPage extends Component { constructor(props) { super(props) //Binding handleBackButtonClick function with this this.handleBackButtonClick = this.handleBackButtonClick.bind(this); } componentWillMount() { // This is the first method in the activity lifecycle // Addding Event Listener for the BackPress BackHandler.addEventListener('hardwareBackPress', this.handleBackButtonClick); } componentWillUnmount() { // This is the Last method in the activity lifecycle // Removing Event Listener for the BackPress BackHandler.removeEventListener('hardwareBackPress', this.handleBackButtonClick); } handleBackButtonClick() { // Registered function to handle the Back Press // We are generating an alert to show the back button pressed alert('You clicked back. Now Screen will move to ThirdPage'); // We can move to any screen. If we want this.props.navigation.navigate('ThirdPage'); // Returning true means we have handled the backpress // Returning false means we haven't handled the backpress return true; } static navigationOptions = { //Setting the header of the screen title: 'Second Page', }; render() { const { navigate } = this.props.navigation; return ( <View style={styles.container}> <Text> You are on SecondPage </Text> </View> ); } } const styles = StyleSheet.create({ container: { flex: 1, backgroundColor: '#fff', alignItems: 'center', justifyContent: 'center', }, }); |
Open pages/ThirdPage.js in any code editor and replace the code with the following code.
ThirdPage.js
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 | // Third Screen which will be used to show backpress import React, { Component } from 'react'; //import react in our code. import { StyleSheet, View, Text ,BackHandler } from 'react-native'; //import all the components we are going to use. export default class ThirdPage extends Component { constructor(props) { super(props) //Binding handleBackButtonClick function with this this.handleBackButtonClick = this.handleBackButtonClick.bind(this); } componentWillMount() { // This is the first method in the activity lifecycle // Addding Event Listener for the BackPress BackHandler.addEventListener('hardwareBackPress', this.handleBackButtonClick); } componentWillUnmount() { // This is the Last method in the activity lifecycle // Removing Event Listener for the BackPress BackHandler.removeEventListener('hardwareBackPress', this.handleBackButtonClick); } handleBackButtonClick() { // Registered function to handle the Back Press // To popup the default screen while going back you can use goBack this.props.navigation.goBack(null); // To exit from your App you can use BackHandler.exitApp();. // Just comment the above line and uncomment the below to use it //BackHandler.exitApp(); // Returning true means we have handled the backpress // Returning false means we haven't handled the backpress // Try to make it false also return true; } static navigationOptions = { title: 'Third Page', //Sets Header text of Status Bar }; render() { const { navigate } = this.props.navigation; return ( <View style={styles.container}> <Text> You are on Third Page </Text> </View> ); } } const styles = StyleSheet.create({ container: { flex: 1, backgroundColor: '#fff', alignItems: 'center', justifyContent: 'center', }, }); |
To Run the React Native App
Open the terminal again and jump into your project using.cd ProjectNamereact-native run-androidreact-native run-ios (macOS only).
That was the way to handle the Android Back Button. If you have any doubt or you want to share something about the topic you can comment below or contact us here. There will be more posts coming soon. Stay tuned!
Hope you liked it. 🙂
How useful was this post?
Click on a star to rate us!
Average rating / 5. Vote count:
We are sorry that this post was not useful for you!
Let us improve this post!
Thanks for your feedback!