React Native WakeUp Screen

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 even if the screen is locked.

Installation

$ npm install --save react-native-wakeup-screen
$ react-native link react-native-wakeup-screen

Usage

import wakeUpApp from 'react-native-wakeup-screen';

// Within your headless function
wakeUpApp();

Advanced usage

You can pass an object to wakeUpApp method to pick it from DeviceEventEmitter by listening to WakeUpApp event.

Example:

const yourObject = { route: 'Dashboard' };

wakeUpApp({
    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 { DeviceEventEmitter, Text, View } from 'react-native';
import { createStackNavigator } from 'react-navigation';
import wakeUpApp from 'react-native-wakeup-screen';

import Dashboard from './dashboard';

class App extends Component {
    componentWillMount() {
        DeviceEventEmitter.addListener('WakeUpApp', (data) => {
	    const { route } = data;
	    
	    // Using react-navigation library for navigation.
	    this.props.navigation.navigate(route);
	});
    }

    render() {
        return (
	    <View>
		<Text>
		    This is Home screen.
		</Text>
	    </View>
	)
    }
}

const appStack = () => {
    const Stack = createStackNavigator({
        App,
        Dashboard,
    });

    return <Stack />
}

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

    wakeUpApp({
	data: yourObject,
    })
}

AppRegistry.registerHeadlessTask(
    '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 MainActivity.java file of React Native app,

package com.yourpackage;

+import android.os.Bundle;
import com.facebook.react.ReactActivity;
+import io.raks.wakeupapp.RNWakeUpApp;

public class MainActivity extends ReactActivity {
    /**
    * Returns the name of the main component registered from JavaScript.
    * This is used to schedule rendering of the component.
    */
    @Override
    protected String getMainComponentName() {
    	return "testProject";
    }
    
+   @Override
+   protected void onCreate(Bundle savedInstanceState) {
+       super.onCreate(savedInstanceState);
+	RNWakeUpApp.sendEvent();
+   }
}

License

MIT

react-native-wakeup-screen