Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

use-stay-awake-lp

Package Overview
Dependencies
Maintainers
1
Versions
2
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

use-stay-awake-lp

React hook that will help the device stay awake while actively using your website or app.

  • 0.1.8
  • latest
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
1
Maintainers
1
Weekly downloads
 
Created
Source

use-stay-awake

Live Demo

React hook that make device stay awake while actively using your website.

Build Status NPM JavaScript Style Guide License

:sparkles: Features

  • Typescript support
  • Best browser support
  • Easy to implement
  • CPU friendly
  • Zero dependencies

:comet: Installation

  1. Using Yarn

     yarn add --dev use-stay-awake
    
  2. Using NPM

     npm install --save use-stay-awake
    

:100: Usage

import React from "react";
import useStayAwake from "use-stay-awake";

function App() {
  const device = useStayAwake();

  return (
    <div>
      <p>
        Status:
        <span>
          {device.canSleep
            ? "Device is allowed to sleep"
            : "Device is not allowed to sleep"}
        </span>
      </p>
      <button
        onClick={() => {
          device.preventSleeping();
        }}
      >
        Prevent Sleeping
      </button>
      <button
        onClick={() => {
          device.allowSleeping();
        }}
      >
        Allow Sleeping
      </button>
    </div>
  );
}

export default App;

:spider_web: Properties

Prop NameTypeDescription
canSleepboolean default: trueIndicator if the device allowed to sleep.
preventSleepingfunctionFunction that prevent the device from sleeping.
allowSleepingfunctionFunction that allow the device from sleeping.

:dizzy: Browser Support

  • Internet Explorer v9-11
  • Microsoft Edge v12-84
  • Firefox v22-81
  • Chrome v4-87
  • Safari v4-14-TP
  • Opera v16-69
  • iOS Safari v3.2-14.0
  • Android Browser v4.4-81
  • Opera Mobile v12-46
  • Chrome for Android v84
  • Firefox for Android v68
  • UC Browser for Android v12.12
  • Samsung Internet v4-12.0
  • QQ Browser v10.4
  • Baidu Browser v7.12
  • KaiOS Browser v2.5

🛠 Development

Thank you so much for contributing! :blue_heart:

⚡ Quick Setup

  1. Clone the repository

     git clone https://github.com/roldanjr/use-stay-awake
    
  2. Locate library folder

     cd use-stay-awake
    
  3. Install library dependencies

     yarn install or npm install
    
  4. Locate demo folder and install dependencies

     cd demo
     yarn install or npm install
    
  5. Start development server under root folder

     yarn develop or npm run develop
    

:bookmark_tabs: License

MIT © Roldan Montilla Jr

Keywords

FAQs

Package last updated on 17 Apr 2023

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc