Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/corbt/react-native-keep-awake
Keep the screen from going to sleep. iOS and Android.
https://github.com/corbt/react-native-keep-awake
Last synced: 1 day ago
JSON representation
Keep the screen from going to sleep. iOS and Android.
- Host: GitHub
- URL: https://github.com/corbt/react-native-keep-awake
- Owner: corbt
- License: mit
- Created: 2016-06-25T03:27:40.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2023-06-20T16:16:36.000Z (over 1 year ago)
- Last Synced: 2024-10-29T21:10:56.686Z (2 months ago)
- Language: Java
- Size: 38.1 KB
- Stars: 621
- Watchers: 8
- Forks: 165
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-react-native-native-modules - react-native-keep-awake ★210
README
# DEPRECATION NOTICE
This package has been deprecated. Please try either:
* https://www.npmjs.com/package/expo-keep-awake This package matches functionality and is maintained by the excellent Expo team.
* https://www.npmjs.com/package/@sayem314/react-native-keep-awake. This package is an up to date fork and does not require Expo.
# END DEPRECATION NOTICE
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.
## Installation
As the first step, install this module:
### React Native 0.57+
```
npm install --save react-native-keep-awake
```
### React Native 0.56 and below
v4 of this module targets gradle 3 syntax, which is not available by default for React Native v0.56 and below. If you are targeting an older version of React Native, stick to v3 of this module:
```
npm install --save react-native-keep-awake@3
```
### RNPM
The plugin can be installed using [react-native link](https://facebook.github.io/react-native/docs/linking-libraries-ios.html) on both iOS and Android. Once installed with npm, just run:
```
react-native link react-native-keep-awake
```
### Manual install
#### iOS
1. In XCode, in the project navigator, right click `Libraries` ➜ `Add Files to [your project's name]`
2. Go to `node_modules` ➜ `react-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 Phases` ➜ `Link 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
3. Append the following lines to `android/settings.gradle`:
```groovy
include ':react-native-keep-awake'
project(':react-native-keep-awake').projectDir = new File(rootProject.projectDir, '../node_modules/react-native-keep-awake/android')
```
4. Insert the following lines inside the dependencies block in `android/app/build.gradle`:
```groovy
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
class MyComponent extends Component {
render() {
if (this.props.screenShouldBeAwake) {
return (
Screen will be kept awake
)
} else {
return (
Screen can sleep
);
}
}
}
// Method 2
function changeKeepAwake(shouldBeAwake) {
if (shouldBeAwake) {
KeepAwake.activate();
} else {
KeepAwake.deactivate();
}
}
```
In method 1, the screen will be locked awake when the `` 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.