@capacitor-community/keep-awake
⚡️ Capacitor plugin to prevent devices from dimming or locking the screen.
| Maintainer | GitHub | Social |
|---|---|---|
| Kevin Boosten | kevinboosten | @kevinboosten |
| Robin Genz | robingenz | @robin_genz |
npm install @capacitor-community/keep-awake npx cap syncNo configuration required for this plugin.
A working example can be found in example-app folder.
import { KeepAwake } from '@capacitor-community/keep-awake'; const keepAwake = async () => { await KeepAwake.keepAwake(); }; const allowSleep = async () => { await KeepAwake.allowSleep(); }; const isSupported = async () => { const result = await KeepAwake.isSupported(); return result.isSupported; }; const isKeptAwake = async () => { const result = await KeepAwake.isKeptAwake(); return result.isKeptAwake; };keepAwake() => Promise<void>Prevent the device from dimming the screen.
allowSleep() => Promise<void>Allow the device to dim the screen.
isSupported() => Promise<IsSupportedResult>Whether keep awake is supported or not.
Returns: Promise<IsSupportedResult>
isKeptAwake() => Promise<IsKeptAwakeResult>Check if the device is kept awake.
Returns: Promise<IsKeptAwakeResult>
| Prop | Type |
|---|---|
isSupported | boolean |
| Prop | Type |
|---|---|
isKeptAwake | boolean |
See CHANGELOG.md.
See LICENSE.