react-native-wake-lock
v1.0.1
Published
Forked from [react-native-android-wake-lock](https://github.com/gretzky/react-native-android-wake-lock) to release with bugfix.
Downloads
68
Maintainers
Readme
react-native-wake-lock
Forked from react-native-android-wake-lock to release with bugfix.
Native Module for setting a wake lock on an Android device. Utilizes both PowerManager
and WifiManager
.
Installation
Note: This package requires React Native >=0.60.
Install with npm/yarn.
npm install react-native-wake-lock --save
// or
yarn add react-native-wake-lock
Since this package requires RN 0.60 or higher, this package will be linked automatically. If you run into an issue, you can try react-native link react-native-wake-lock
.
Usage
Make sure to request the wake lock permission. Add the following inside the project manifest (android/app/src/main/AndroidManifest.xml
):
<uses-permission android:name="android.permission.WAKE_LOCK" />
This module exposes 2 possible methods for accessing the wake lock: via an interface object or a React hook. Depending on your use case, one or the other should suffice.
import React from "react";
import { WakeLockInterface, useWakeLock } from "react-native-wake-lock";
// the interface exposes all 3 (async) methods
const isWakeLocked = WakeLockInterface.isWakeLocked();
// these 2 aren't necessary if you're using the hook
const setWakeLock = WakeLockInterface.setWakeLock();
const releaseWakeLock = WakeLockInterface.releaseWakeLock();
// you can also use the hook to set/release a wake lock on component mount/unmount
const Component = () => {
const [wakeLocked, setWakeLocked] = useState(isWakeLocked);
// you can use the `isWakeLocked` method from the interface to check whether or not the wake lock is set
useEffect(() => {
console.log(wakeLocked);
}, [wakeLocked]);
useWakeLock();
return <View />;
};
API
The interface has 3 methods:
setWakeLock(): Promise<boolean>
- sets both the WakeLock and WifiLockreleaseWakeLock(): Promise<boolean>
- releases both the WakeLock and WifiLockisWakeLocked(): Promise<boolean>
- whether or not the wake/wifi locks are held