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

use-wake-lock

v1.1.0

Published

A React hook for the Screen Wake Lock API that prevents the device's screen from turning off

Downloads

21

Readme

useWakeLock

A React hook for the Screen Wake Lock API. Can be used to prevent a device's screen from turning off.

NPM License: MIT JavaScript Style Guide

Install

This hook uses the native Screen Wake Lock API that was released in Chrome v84. As this is a newly released feature, you may first want to check browser compatibility.

npm install --save use-wake-lock

Usage

An example page is available here. The source code for the example can be found here.

Toggle wake lock

Checkbox (or similar) that can be toggled to turn wake lock on or off.

import React from "react";
import { useWakeLock } from "use-wake-lock";


const Example = () => {
  const { toggleWakeLock, wakeLockActive } = useWakeLock();

  return (
    <input
      name="wakelock"
      type="checkbox"
      checked={wakeLockActive}
      onChange={() => toggleWakeLock()}
    />
    <span>{wakeLockActive ? "on" : "off"}</span>
  );
};

Turn wake lock on and turn it off automatically after Y milliseconds

Button (or similar) that can be clicked to turn wake lock on. After a set period, provided in milliseconds, the wake lock is released.

import React from "react";
import { useWakeLock } from "use-wake-lock";


const Example = () => {
  const { toggleWakeLock, wakeLockActive } = useWakeLock();

  return (
    <button onClick={() => toggleWakeLock(300000)>Keep screen on for 5 minutes</button>
    <span>{wakeLockActive ? " on" : " off"}</span>
  );
};

API

The hook provides three values:

  • toggleWakeLock: A function you can call to toggle the wake lock. It accepts an optional parameter that is the duration (in milliseconds) that the wake lock should be active for.
  • wakeLockActive: A boolean indicating whether the wake lock is active. The default value is false.
  • wakeLockError: A string containing any errors when using the Wake Lock API. The most common error is if the browser does not support the API. The default value is an empty string.

License

MIT.