Bring React Native App to foreground from Headless JS


4671.0.6a year ago4 years agoMinified + gzip package size for react-native-invoke-app in KB


React Native Invoke App

npm version

Headless JS is a way to run background tasks in a React Native app. Sometimes we may want to open the app from background task (Headless JS). You can use this module to bring your app to foreground in all the following three cases.

  • App is in foreground
  • App is in background
  • App is not running


$ npm install --save react-native-invoke-app
# if your react-native version is <0.60
$ react-native link react-native-invoke-app


import invokeApp from 'react-native-invoke-app';

// Within your headless function

Advanced usage

You can pass an object to invokeApp method to pick it from DeviceEventEmitter by listening to appInvoked event.


const yourObject = { route: 'Dashboard' };

    data: yourObject,

Use case

Let's say you want to navigate to dashboard screen of the app after a specific task is completed. You can acheive it like,

import React, { Component } from 'react';
import { AppRegistry, DeviceEventEmitter, Text, View } from 'react-native';
import { createStackNavigator } from 'react-navigation';
import invokeApp from 'react-native-invoke-app';

import Dashboard from './dashboard';

class App extends Component {
    componentWillMount() {
        DeviceEventEmitter.addListener('appInvoked', (data) => {
        const { route } = data;

        // Using react-navigation library for navigation.

    render() {
        return (
            This is Home screen.

const appStack = () => {
    const Stack = createStackNavigator({

    return <Stack />

const notificationActionHandler = async (data) => {
    // Your background task
    const yourObject = { route: 'Dashboard' };

    data: yourObject,

    'RNPushNotificationActionHandlerTask', () => notificationActionHandler,

AppRegistry.registerComponent('testProject', () => appStack);

Extra step needed when app is not running

Event listener will work fine when your app is in background or foreground. If it is not running, to capture the first event we need to do some extra work. Make the following changes in your file of React Native app,

package com.yourpackage;

+import android.os.Bundle;
import com.facebook.react.ReactActivity;
+import com.codegulp.invokeapp.RNInvokeApp;

public class MainActivity extends ReactActivity {
    * Returns the name of the main component registered from JavaScript.
    * This is used to schedule rendering of the component.
    protected String getMainComponentName() {
        return "testProject";

+   @Override
+   protected void onCreate(Bundle savedInstanceState) {
+       super.onCreate(savedInstanceState);
+    RNInvokeApp.sendEvent();
+   }



If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from