Keep the Screen Awake/On for the Infinite Time in React Native

React Native Keep Screen Awake

This is an Example to Keep the Screen Awake/On for the Infinite Time in React Native using react-native-keep-awake for Android and IOS. Before starting the example I just want you to think about this feature. Have you ever experienced Screen Awake feature in any app?

Maybe you have the answer or maybe not but let me tell you the most general example and that is the YouTube App. Yes, Video streaming apps are the most generic applications to use these features while we play any video. They keep the screen on as long as we watch the video. Other than that the book reading or article reading applications also use screen awake features to provide a seamless user experience for their readers.

In this example Keep the Screen Awake/On for the Infinite Time in React Native you will find the way to keep the screen on for the infinite time as long as your application is open. Here you can see the screenshot of my mobile device in which I have tried it and it was awake for 01Hr: 12 Min: 32 Sec (after that I was having work so I stopped testing :p).

To Keep Screen Awake for the Infinite Time

To keep the screen awake we are going to use KeepAwake component from  react-native-keep-awake library.

There are two ways to use this library:

  1. By rendering it as a component.
  2. Explicitly calling the KeepAwake.activate()and KeepAwake.deactivate() static methods.

By rendering it as a component

<View style={{ marginTop: 20 }}>
  {this.state.keepScreenAwake ? (
    <View>
      <Button
        title="Make Screen Normal using Component"
        onPress={() => this.changeKeepAwakeComponenet(false)}
      />
      <KeepAwake />
    </View>
  ) : (
    <View>
      <Button
        title="Keep Screen Awake using Component"
        onPress={() => this.changeKeepAwakeComponenet(true)}
      />
    </View>
  )}
</View>

Explicitly calling the static methods

changeKeepAwake(shouldBeAwake) {
  //To keep screen awake using function Calling
  this.setState({ keepScreenAwake: shouldBeAwake });
  if (shouldBeAwake) {
    //Calling the Activate function to Active Keep awake and
    //Make the Screen On for infinite time
    KeepAwake.activate();
    alert('Screen will be awake for infinite time');
  } else {
    //Calling the deactivate function to Deactive Keep awake
    KeepAwake.deactivate();
    alert('Screen awake time will become normal now');
  }
}

For this example, We are going to make a simple screen that has two buttons which will change their state according to the state of Infinite awake on or off. I have covered both the ways in this example. So let’s get started.

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

If you want to start a new project with a specific React Native version, you can use the --version argument:

react-native init ProjectName --version X.XX.X
react-native init ProjectName --version react-native@next

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

Installation of Dependency

To use KeepAwake we need to install react-native-keep-awake dependency.

To install this open the terminal and jump into your project using

cd ProjectName

Run the following command to install

For React Native 0.57+ (Recommended)

npm install react-native-keep-awake --save

For React Native 0.56 and below

npm install react-native-keep-awake@3 --save

This command will copy all the dependency into your node_module directory.

–save is optional, it is just to update the react-native-keep-awake dependency in your package.json file.

CocoaPods Installation

After the updation of React Native 0.60, they have introduced autolinking so we do not require to link the library but need to install pods. So to install pods use

cd ios && pod install && cd ..

Code to Keep Screen Awake

Now Open App.js in any code editor and replace the code with the following code

App.js

/*Example to keep your mobile Screen Awake for infinite time in React Native*/
import React, { Component } from 'react';
//Import React

import { Platform, StyleSheet, Text, View, Button } from 'react-native';
//Import All the Basic Components

import KeepAwake from 'react-native-keep-awake';
//import KeepAwake Component

export default class App extends Component {
  constructor(props) {
    super(props);
    this.state = {
      keepScreenAwake: false,
      //Default Keep Awake off
    };
  }

  changeKeepAwake(shouldBeAwake) {
    //To keep screen awake using function Calling
    this.setState({ keepScreenAwake: shouldBeAwake });
    if (shouldBeAwake) {
      //Calling the Activate function to Active Keep awake and
      //Make the Screen On for infinite time
      KeepAwake.activate();
      alert('Screen will be awake for infinite time');
    } else {
      //Calling the deactivate function to Deactive Keep awake
      KeepAwake.deactivate();
      alert('Screen awake time will become normal now');
    }
  }

  changeKeepAwakeComponenet(shouldBeAwake) {
    //To keep screen awake using Compoenent
    this.setState({ keepScreenAwake: shouldBeAwake });
    if (shouldBeAwake) {
      alert('Screen will be awake for infinite time');
    } else {
      alert('Screen awake time will become normal now');
    }
  }

  render() {
    return (
      <View style={styles.container}>
        <Text style={styles.textStyle}>Example to keep the Screen On</Text>
        {/*Method 1 to keep the screen on for infinite time using function calling*/}
        <View style={{ marginTop: 20 }}>
          {this.state.keepScreenAwake ? (
            <Button
              title="Make Screen Normal by Calling Function"
              onPress={() => this.changeKeepAwake(false)}
            />
          ) : (
            <Button
              title="Keep Screen Awake by Calling Function"
              onPress={() => this.changeKeepAwake(true)}
            />
          )}
        </View>
        {/*Method 2 to keep the screen on for infinite time using KeepAwake Component*/}
        <View style={{ marginTop: 20 }}>
          {this.state.keepScreenAwake ? (
            <View>
              <Button
                title="Make Screen Normal using Component"
                onPress={() => this.changeKeepAwakeComponenet(false)}
              />
              <KeepAwake />
            </View>
          ) : (
            <View>
              <Button
                title="Keep Screen Awake using Component"
                onPress={() => this.changeKeepAwakeComponenet(true)}
              />
            </View>
          )}
        </View>
      </View>
    );
  }
}

const styles = StyleSheet.create({
  container: {
    flex: 1,
    justifyContent: 'center',
    alignItems: 'center',
    backgroundColor: '#F5FCFF',
  },
  textStyle: {
    fontSize: 20,
    textAlign: 'center',
    margin: 20,
  },
});

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).

Output Screenshots

IOS

         

Android

         

This is how you can keep the screen awake/on for an infinite time in React Native for Android and IOS. If you have any doubts 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. 🙂


Related Posts

Leave a Comment

This site uses Akismet to reduce spam. Learn how your comment data is processed.