@capacitor-community/keep-awake

Prevent your screen from getting some sleep!

Usage no npm install needed!

<script type="module">
  import capacitorCommunityKeepAwake from 'https://cdn.skypack.dev/@capacitor-community/keep-awake';
</script>

README


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()

keepAwake() => Promise<void>

Prevent the device from dimming the screen.


allowSleep()

allowSleep() => Promise<void>

Allow the device to dim the screen.


Changelog

See CHANGELOG.md.

License

See LICENSE.