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.
As the first step, install this module:
npm install --save react-native-keep-awake
The plugin can be installed using react-native link on both iOS and Android. Once installed with npm, just run:
react-native link
- In XCode, in the project navigator, right click
Libraries
➜Add Files to [your project's name]
- Go to
node_modules
➜react-native-keep-awake
and addKCKeepAwake.xcodeproj
- In XCode, in the project navigator, select your project. Add
libKCKeepAwake.a
to your project'sBuild Phases
➜Link Binary With Libraries
- Click
KCKeepAwake.xcodeproj
in the project navigator and go theBuild Settings
tab. Make sure 'All' is toggled on (instead of 'Basic'). In theSearch Paths
section, look forHeader Search Paths
and make sure it contains both$(SRCROOT)/../../react-native/React
and$(SRCROOT)/../../../React
- mark both asrecursive
.
- 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 thegetPackages()
method
-
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')
-
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.
```jsx
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.