@capacitor-community/keep-awake

Keep Awake

@capacitor-community/keep-awake

Capacitor community plugin to prevent your screen from getting some sleep!

Maintainers

Maintainer	GitHub	Social
Kevin Boosten	boosten	@Boostuh1
Robin Genz	robingenz	@robin_genz

Installation

npm install @capacitor-community/keep-awake
npx cap sync

Configuration

No configuration required for this plugin.

Demo

A working example can be found here: robingenz/capacitor-plugin-demo

Usage

import { KeepAwake } from '@capacitor-community/keep-awake';

const keepAwake = async () => {
    await KeepAwake.keepAwake();
}

const allowSleep = async () => {
    await KeepAwake.allowSleep();
}

API

• keepAwake()
• allowSleep()

keepAwake()

keepAwake() => Promise<void>

Prevent the device from dimming the screen.

Only available for Android and iOS.

---

allowSleep()

allowSleep() => Promise<void>

Allow the device to dim the screen.

Only available for Android and iOS.

---

Changelog

See CHANGELOG.md.

License

See LICENSE.

Changelog

2.0.0 (2021-04-10)

⚠ BREAKING CHANGES

• web: throw unimplemented error on web
• Update to Capacitor 3

Features

• add support for Capacitor 3 (a8a361b)

• web: throw unimplemented error (#9) (18b9ab0)