https://github.com/vineyardbovines/react-native-android-wake-lock

Native Module for setting a wake lock on an Android device
https://github.com/vineyardbovines/react-native-android-wake-lock

native-module react-native wake-lock

Last synced: about 2 months ago
JSON representation

Native Module for setting a wake lock on an Android device

• Host: GitHub
• URL: https://github.com/vineyardbovines/react-native-android-wake-lock
• Owner: vineyardbovines
• License: mit
• Created: 2020-04-11T18:20:27.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-12-15T14:37:04.000Z (about 1 year ago)
• Last Synced: 2024-10-28T22:50:30.729Z (2 months ago)
• Topics: native-module, react-native, wake-lock
• Language: Kotlin
• Size: 2.54 MB
• Stars: 8
• Watchers: 1
• Forks: 16
• Open Issues: 21
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# react-native-android-wake-lock

Native Module for setting a [wake lock](https://developer.android.com/training/scheduling/wakelock) on an Android device. Utilizes both `PowerManager` and `WifiManager`.

## Installation

**Note:** This package requires React Native >=0.60.

Install with npm/yarn.

```bash

npm install react-native-android-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-android-wake-lock`.

## Usage

Make sure to request the wake lock permission. Add the following inside the project manifest (`android/app/src/main/AndroidManifest.xml`):

```xml

```

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.

```js

import React from "react";

import { WakeLockInterface, useWakeLock } from "react-native-android-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 ;

};

```

## API

The interface has 3 methods:

- **`setWakeLock(): Promise`** - sets both the WakeLock and WifiLock

- **`releaseWakeLock(): Promise`** - releases both the WakeLock and WifiLock

- **`isWakeLocked(): Promise`** - whether or not the wake/wifi locks are held