node package manager
Easy collaboration. Discover, share, and reuse code in your team. Create a free org »

react-native-keep-awake

This React Native package allows you to prevent the screen from going to sleep while your app is active. It's useful for things like navigation or video playback, where the user expects the app to remain visible over long periods without touch interaction.

Compatible Versions

Note: Due to a breaking change in React Native 0.40, versions 2.0+ of this library is only compatible with RN >=0.40. For older versions of React Native, you'll need to install version 1.07.

Installation

As the first step, install this module:

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

RNPM

The plugin can be installed using react-native link on both iOS and Android. Once installed with npm, just run:

react-native link

Manual install

iOS

  1. In XCode, in the project navigator, right click LibrariesAdd Files to [your project's name]
  2. Go to node_modulesreact-native-keep-awake and add KCKeepAwake.xcodeproj
  3. In XCode, in the project navigator, select your project. Add libKCKeepAwake.a to your project's Build PhasesLink Binary With Libraries
  4. Click KCKeepAwake.xcodeproj in the project navigator and go the Build Settings tab. Make sure 'All' is toggled on (instead of 'Basic'). In the Search Paths section, look for Header Search Paths and make sure it contains both $(SRCROOT)/../../react-native/React and $(SRCROOT)/../../../React - mark both as recursive.

Android

  1. Open up `android/app/src/main/java/[...]/MainApplication.java (React Native 0.29+)
  • Add import com.corbt.keepawake.KCKeepAwakePackage; to the imports at the top of the file
  • Add new KCKeepAwakePackage() to the list returned by the getPackages() method
  1. Append the following lines to android/settings.gradle:
include ':react-native-keep-awake'
    project(':react-native-keep-awake').projectDir = new File(rootProject.projectDir,  '../node_modules/react-native-keep-awake/android')
  1. Insert the following lines inside the dependencies block in android/app/build.gradle:
compile project(':react-native-keep-awake')

Usage

There are two ways to use this package: by rendering it as a component, or by explicitly calling the KeepAwake.activate() and KeepAwake.deactivate() static methods. Both are demonstrated below.

 
import React, { Component } from 'react';
import { View, Text } from 'react-native';
 
import KeepAwake from 'react-native-keep-awake';
 
// Method 1
const MyComponent extends Component {
  render() {
    if (this.props.screenShouldBeAwake) {
      return ( 
        <View>
          <Text>Screen will be kept awake</Text>
          <KeepAwake />
        </View>
      )
    } else {
      return (
        <View>
          <Text>Screen can sleep</Text>
        </View>
      );
    }
  }
}
 
// Method 2
function changeKeepAwake(shouldBeAwake) {
  if (shouldBeAwake) {
    KeepAwake.activate();
  } else {
    KeepAwake.deactivate();
  }
}
 

In method 1, the screen will be locked awake when the <KeepAwake /> component is mounted, and the lock will be disabled when the component is unmounted. Method 2 gives you more explicit control of when the lock is active or not.