React hook that will help the device stay awake while actively using your website or app.
npm install use-stay-awakesh
yarn add --dev use-stay-awake
`
2. Using NPM
`sh
npm install --save use-stay-awake
`
:100: Usage
`tsx
import React from "react";
import useStayAwake from "use-stay-awake";
function App() {
const device = useStayAwake();
return (
Status:
{device.canSleep
? "Device is allowed to sleep"
: "Device is not allowed to sleep"}
onClick={() => {
device.preventSleeping();
}}
>
Prevent Sleeping
onClick={() => {
device.allowSleeping();
}}
>
Allow Sleeping
);
}
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
- [x] Internet Explorer v9-11
- [x] Microsoft Edge v12-84
- [x] Firefox v22-81
- [x] Chrome v4-87
- [x] Safari v4-14-TP
- [x] Opera v16-69
- [x] iOS Safari v3.2-14.0
- [x] Android Browser v4.4-81
- [x] Opera Mobile v12-46
- [x] Chrome for Android v84
- [x] Firefox for Android v68
- [x] UC Browser for Android v12.12
- [x] Samsung Internet v4-12.0
- [x] QQ Browser v10.4
- [x] Baidu Browser v7.12
- [x] KaiOS Browser v2.5
🛠Development
Thank you so much for contributing! :blue_heart:
$3
1. Clone the repository
`sh
git clone https://github.com/roldanjr/use-stay-awake
`
2. Locate library folder
`sh
cd use-stay-awake
`
3. Install library dependencies
`sh
yarn install or npm install
`
4. Locate demo folder and install dependencies
`sh
cd demo
yarn install or npm install
`
5. Start development server under root folder
`sh
yarn develop or npm run develop
``