npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

react-use-wake-lock

v1.0.1

Published

React hooks to make it easier to use Screen Wake Lock API

Downloads

1,143

Readme

npm Build Status Coverage Status gzip size

React Use Wake Lock

Easily integrate Screen Wake Lock API in your app

  • Zero-dependencies
  • Tiny size (less than 1Kb)
  • Typescript support
  • Auto reacquiring a wake lock out of the box
  • 100% test coverage

Demo

Installation

npm install react-use-wake-lock --save

or

yarn add react-use-wake-lock

Minimal example

import useWakeLock from "react-use-wake-lock";

function MinimalExampleComponent() {
  const { isSupported, isLocked, request, release } = useWakeLock();

  return (
    <div>
      <h3>Screen Wake Lock API supported: {isSupported ? "Yes" : "No"}</h3>
      <h3>Locked: {`${isLocked ? "Yes" : "No"}`}</h3>
      <button type="button" onClick={() => (isLocked ? release() : request())}>
        {isLocked ? "Release" : "Request"}
      </button>
    </div>
  );
}

useWakeLock API

Params

  • onError(error: Error, errorType: "request" | "release") - callback called in case of any error during acuqiring lock or releasing it
  • onLock(lock: WakeLockSentinel) - callback for successful acquiring of a lock
  • onRelease(lock: WakeLockSentinel) - callback called on releasing the lock

Returns

  • isSupported: boolean - is Screen Wake Lock API supported by a browser
  • isLocked: boolean - current state of a lock
  • request: () => void - request a lock
  • release: () => void - release the lock