use-stay-awake-nextjs

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

0.1.12
latest
Source
npm

Version published: 2 years ago

Maintainers: 1

Created: 2 years ago

Source

use-stay-awake-nextjs

Live Demo

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

:sparkles: Features

:comet: Installation

Using PNPM

 pnpm add use-stay-awake-nextjs

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

: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 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.

:dizzy: Browser Support

🛠 Development

Thank you so much for contributing! :blue_heart:

⚡ 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
```

:bookmark_tabs: License

Keywords

FAQs

What is use-stay-awake-nextjs?

Is use-stay-awake-nextjs well maintained?

Package last updated on 19 Apr 2023

Did you know?

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