Handling Android Back Button Press in React Native

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

BackHandler.addEventListener('hardwareBackPress', this.handleBackButtonClick);

1	BackHandler.addEventListener('hardwareBackPress', this.handleBackButtonClick);

2. Remove the hardwareBackPress using

BackHandler.removeEventListener('hardwareBackPress', this.handleBackButtonClick);

1	BackHandler.removeEventListener('hardwareBackPress', this.handleBackButtonClick);

3. To handle the event we have used the function handleBackButtonClick.

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;
  }

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 the react-native-cli command line utility. Open the terminal and go to the workspace and run

npm install -g react-native-cli

Run the following commands to create a new React Native project

react-native init ProjectName

This will make a project structure with an index file named App.js in your project directory.

Installation 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

cd ProjectName

1	cd ProjectName

Run the following commands

npm install react-navigation --save

1	npm install react-navigation --save

npm install react-native-gesture-handler --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

react-native link

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

//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);

//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

// 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
  },
});

// 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 (

{/*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

// 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',
  },
});

// 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 (

<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

// 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',
  },
});

// 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 (

<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 ProjectName

To run the project on an Android Virtual Device or on real debugging device

react-native run-android

or on the iOS Simulator by running

react-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!

Tell us how we can improve this post?

Thanks for your feedback!

Introduction to ReactJs	Introduction to React Native
React V/s React Native	Getting Started With React Native
Installation of npm and node js for Ubuntu and Windows	Installation of npm and node js in Mac OS
Setting up Android Development Environment for Windows and Ubuntu	Setting up Android Development Environment for Mac OS
Create and Launch the Android Virtual Device	Installation of Xcode in Mac
Code Editors For React Native Mobile App Development	ATOM Code Editor for React Native Development
Visual Studio Code Editor for React Native Development
Explore More

Hello World Program using React Native	Introduction of Basic React Native Components
Add Comments in React Native JSX	React Native View
React Native Text	Manage State in React Native
Understanding of Props in React Native	Styling of React Native Component Using Stylesheet
TextInput in React Native	Display Image in React Native
ScrollView in React Native	Button in React Native
Picker in React Native	React Native Switch
React Native ActivityIndicator	Alert in React Native
Toast Message in React Native (Android Only)	Modal in React Native
Open any Website in React Native WebView	React Native Slider
React Native Touchable	Run Time Android Permission using React Native PermissionsAndroid
StatusBar in React Native	FlatList Component in React Native
Section List in React Native	Get Application State using AppState
React Native NetInfo	React Native Copy to Clipboard
Store Data in Session Using AsyncStorage	React Native Share API to Share TextInput message
React Native Disable Screen Rotation	React Native Linking to open Hyperlink in The Browser
Get Device Height Width in React Native	React Native Start Stop Device Vibration
Request Focus and Keyboard Avoiding View in React Native	GridView using FlatList in React Native
React Native Platform to Detect Device is Android or IOS	Lifecycle of React Native Application Component
Explore More

Best UI Libraries for React Native	React Native HTTP Request to Fetch the Data From Web APIs
Current Location Lat-Long Using React Native Geolocation	Working with Date Picker in React Native
Example to Use Time Picker in React Native	Example Showing the Working of Calendar Picker in React Native
React Native Navigation (Router) Version 2+	RN Finish Current Screen while Navigating to Next Screen
React Native Tab with Latest React Navigation Version 3.+	React Native Bottom Navigation with Latest Navigation V. 3+
Bottom Navigation with Navigation Icon from Local Directory	React Native View Pager with 3 Different Indicators
React Native Navigation Drawer with Latest Navigation V. 3+	Example to Make 3 Different Type of Pie Chart in React Native
React Native Camera	React Native ListViewDataSource
Handling Android Back Button Press in React Native	React Native Show SuperScript and SubScript
React Native Custom Star Rating Bar	Generation of QR Code in React Native
React Native Scan QR Code	React Native Global Scope Variables
RN Swipe Down to Refresh List View Using Refresh Control	React Native Floating Action Button
React Native Collapsible Toolbar with Animation	React Native Card View for Android and IOS
React Native SnackBar - Bottom Flash Message	FlatList Pagination to Load More Data dynamically - Infinite List
React Native CountDown Timer	React Native App Intro Slider using AppIntroSlider
RN Custom Shapes - Square, Circle, Triangle, Rectangle, Oval	React Native Timer and Stopwatch
Take Screenshot Programmatically in React Native	Local Database in React Native App
SQLite Database in React Native	Load Pre Populated SQLite Database in React Native
Realm Database in React Native	Image Picker in React Native
React Native Map Example	Google Sign In in React Native
RN Facebook Integration Example using Facebook SDK	Localization in React Native Multi Language App
Grid Image Gallery in React Native	Slider Image Gallery in React Native
Phone Call from React Native App	YouTube Video Integration in React Native
React Native File Picker	Make PDF in React Native from HTML Text
Send Text SMS on Button Click in React Native	Popup Dialog in React Native
Switch from One Screen to another using React Navigation 3.+	React Native Card View using react-native-paper
React Native AutoComplete Input	React Native Overlay ActivityIndicator / Progress Bar / Loading Spinner
React Native Collapsible / Accordion / Expandable List View	React Native Bottom Sheet (Material Design)
React Native Searchable Dropdown / Picker
Explore More

Pass Value From One Screen to Another(React Navigation)	How to use Currency Symbols in React Native
Get Clicked Location of Touchscreen Using RN PanResponder	Image Icon Inside the React Native Button
Image Icon in React Native TextInput	React Native Get Unique ID of Device
Example of Pinch to Zoom Image in React Native	React Native Full Screen Background Image
React Native Load Local HTML File in WebView	React Native Show Progress bar While Loading WebView
Make Circular Image in React Native using Border Radius	Make Search Bar Filter for List View Data in React Native
Scroll to the Top or Bottom of the ListView in React Native	React Native Swipeable Card View UI like Tinder
Dynamically Change React navigationOptions Value	Hide Navigation Bar in React Native Application
Add Image Icon Inside Navigation Bar in React Native	React Native Add Header Footer in ListView / FlatList
React Native Show Message for empty FlatList	React Native Change App Icon for Android and IOS
React Native Change App Icon Using Command Line Interface	React Native Rotate Image View Using Animation
Flip Image View Horizontally Using Animation in React Native	React Native Blinking Animation
React Native Add Items to ScrollView using Loop	Set Alpha Opacity / Transparency of Image View
React Native Enable Disable TextInput Programmatically	Check Value is a Number using isNaN() in React Native
React Native Get Current Date Time	React Native Get Current Time in 12 hours Format AM PM
React Native Strikethrough Text	React Native Underline Text
React Native Check TextInput is Empty or Not	Getting SHA1 Fingerprint for Google API Console
onLongPress on TouchableOpacity in React Native	Call Functions of Other Class From Current Class in RN
Set Border Radius of an Image in React Native	Get Only Numeric Value From TextInput in React Native
Convert Text to Upper or Lower Case in React Native	Align a View at the Bottom of Screen in React Native
Load Different StyleSheet Dynamically in RN	Hide Show Component in React Native
Remove TextInput Underline in React Native	Run React Native App On Real Device Android
Run React Native App On Real Device using Wi-Fi	Generate Signed Android APK of React Native App
Convert any Input Value in MD5 in React Native	Searching in List using Search Bar in React Native
Animated Splash Screen in React Native	Set onPress on a View in React Native
Send WhatsApp Message from React Native App	Vertical and Horizontal Scroll View Like Google Play Store
React Native Bottom Action Menu	React Native Popup Menu - Over Flow Menu
React Navigation Header Customization in React Native	Multi-Line Text / Break Text in React Native
Switch Screen out of the Navigation Drawer React Navigation V. 3+	Social Icons using React Native Elements
Infinite Loading Listview in React Native using FlatList	Expandable List View in React Native
Calendar with Events Listed in React Native	Make a View Like Android Fragment in React Native
Use Ionicons in React Native using react-native-ionicons	Use Vector Icons in React Native
Generate SHA256 Encoded Hash in React Native	Load Local HTML File using react-native-webview
Load URL using react-native-webview	Example to Get Device Information in React Native
Turn on/off Flashlight to Make a Torch App in React Native
Explore More

Problem - After running "npm start" execution got stuck on "starting/running packager.."	'react-native' is not recognized as an internal or external command
You have not accepted the license agreements of the following SDK components	adb server version mismatch react-native run-android
Unable To Load Script From Assets index.android.bundle	Problem in Ejecting React Native Project (npm run eject issue) in version 0.57
Could not Compile Settings File project/android/settings.gradle	null is not an object (Evaluating 'NativeModules["SQLite"][method]')
Warning: ListView is deprecated and will be removed in a future release	Error: Invalid URL provided tel:XXXXXXXXX in React Native
No component found for view with name "ARTShape"
Explore More

Handling Android Back Button Press in React Native

Why not use component lifecycle methods?

To Make a React Native App

Installation of Dependencies

Linking of Dependencies

Project File Structure

App.js

FirstPage.js

SecondPage.js

ThirdPage.js

To Run the React Native App

How useful was this post?

We are sorry that this post was not useful for you!

Leave a Reply

Leave a Reply Cancel reply

Why not use component lifecycle methods?

To Make a React Native App

Installation of Dependencies

Linking of Dependencies

Project File Structure

App.js

FirstPage.js

SecondPage.js

ThirdPage.js

To Run the React Native App

How useful was this post?

As you found this post useful...

We are sorry that this post was not useful for you!

You might also like

Leave a Reply

Leave a Reply Cancel reply

Just Started

Beginner

Pro Level

How To

Frequent Questions