useWakeLock

Hook that provides a wake lock functionality

browser

test coverage

Last changed: last month

TIP

This hook uses navigator.wakeLock browser api to provide enhanced functionality. Make sure to check for compatibility with different browsers when using this api

Installation

Library

CLI

Manual

import { useWakeLock } from '@siberiacancode/reactuse';

Usage

const { supported, active, request, release } = useWakeLock();

Demo

source

Api

Parameters

Name	Type	Default	Note
options?	immediately	-	Configuration options for the hook.

Returns

UseWakeLockReturn

Type declaration

export interface UseWakeLockOptions {
  /** Determines if the wake lock should be automatically reacquired when the document becomes visible. */
  immediately?: boolean;
  /** A string specifying the screen wake lock type. */
  type?: WakeLockType;
}

export interface UseWakeLockReturn {
  /** Indicates if the wake lock is currently active. */
  active: boolean;
  /** Indicates if the Wake Lock API is supported in the current environment. */
  supported: boolean;
  /** Function to release the wake lock. */
  release: () => Promise<void>;
  /** Function to request the wake lock. */
  request: () => Promise<void>;
}

Source

Source • Demo

Contributors

D

debabin

A

Artem Dereviago