nick777-pixel / use-stay-awake Goto Github PK

View Code? Open in Web Editor NEW

This project forked from roldanjr/use-stay-awake

0.0 0.0 0.0 1.26 MB

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

Home Page: https://roldanjr.github.io/use-stay-awake/

License: MIT License

JavaScript 24.65% TypeScript 75.35%

use-stay-awake's Introduction

use-stay-awake

Live Demo

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

✨ Features

☄️ Installation

Using Yarn
```
 yarn add --dev use-stay-awake
```
Using NPM
```
 npm install --save use-stay-awake
```

💯 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;

🕸️ Properties

Prop Name	Type	Description
canSleep	`boolean` default: `true`	Indicator if the device allowed to sleep.
preventSleeping	`function`	Function that prevent the device from sleeping.
allowSleeping	`function`	Function that allow the device from sleeping.

💫 Browser Support

🛠 Development

Thank you so much for contributing! 💙

⚡ Quick Setup

Clone the repository

 git clone https://github.com/roldanjr/use-stay-awake

Locate library folder
```
 cd use-stay-awake
```
Install library dependencies
```
 yarn install or npm install
```
Locate demo folder and install dependencies
```
 cd demo
 yarn install or npm install
```
Start development server under root folder
```
 yarn develop or npm run develop
```