capacitor-keep-awake

Keep the screen on while users watch, read, navigate or follow a recipe in your Capacitor app, then let it sleep again when they are done.

🤖 Building with an AI coding agent? Install Capgo skills so Claude Code, Codex, Cursor, Copilot, or Gemini CLI know how to install and use @capgo/capacitor-keep-awake in your Capacitor app: npx skills add Cap-go/capgo-skills. Then ask your agent: "Add @capgo/capacitor-keep-awake to my Capacitor app and wire it up." Agent setup guides · Hosted MCP

Key features

• Keep awake: keepAwake() stops the screen from dimming or locking.
• Allow sleep: allowSleep() restores the normal timeout.
• State: isKeptAwake() reports whether keep awake is active.
• Support check: isSupported() tells you if the current platform can do it.
• Platforms: iOS, Android and Web. Web uses the Screen Wake Lock API where the browser supports it.

Why Capacitor Keep Awake?

A simple, free, and lightweight screen wake lock plugin:

• Keep screen on - Prevent device from dimming or sleeping
• Status checking - Query current wake lock state
• Platform support - Check if wake lock is available on current platform
• Universal compatibility - Works across iOS, Android, and web
• Modern package management - Supports both Swift Package Manager (SPM) and CocoaPods (SPM-ready for Capacitor 8)
• Zero dependencies - Minimal footprint, no bloat

Perfect for video players, navigation apps, games, presentations, and any app that needs the screen to stay on.

Documentation

The most complete doc is available here: https://capgo.app/docs/plugins/keep-awake/

Compatibility

Note: The major version of this plugin follows the major version of Capacitor. Use the version that matches your Capacitor installation (e.g., plugin v8 for Capacitor 8). Only the latest major version is actively maintained.

Install

You can use our AI-Assisted Setup to install the plugin. Add the Capgo skills to your AI tool using the following command:

npx skills add https://github.com/cap-go/capacitor-skills --skill capacitor-plugins

Then use the following prompt:

Use the `capacitor-plugins` skill from `cap-go/capacitor-skills` to install the `@capgo/capacitor-keep-awake` plugin in my project.

If you prefer Manual Setup, install the plugin by running the following commands and follow the platform-specific instructions below:

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

iOS

Works out of the box. Uses UIApplication.shared.isIdleTimerDisabled to control screen sleep.

Android

Works out of the box. Uses WindowManager.LayoutParams.FLAG_KEEP_SCREEN_ON flag. No permissions required.

Web

Works in modern browsers that support the Screen Wake Lock API. Call isSupported() first to check if wake lock is available on the current browser.

API

• keepAwake()
• allowSleep()
• isSupported()
• isKeptAwake()
• getPluginVersion()
• Interfaces

Capacitor Keep Awake Plugin for preventing the device screen from dimming/sleeping.

keepAwake()

keepAwake() => Promise<void>

Prevent the device from dimming the screen.

Since: 1.0.0

allowSleep()

allowSleep() => Promise<void>

Allow the device to dim the screen (disable keep awake).

Since: 1.0.0

isSupported()

isSupported() => Promise<IsSupportedResult>

Check if the keep awake feature is supported on the current platform.

Returns: Promise<IsSupportedResult>

Since: 1.0.0

isKeptAwake()

isKeptAwake() => Promise<IsKeptAwakeResult>

Check if the device is currently being kept awake.

Returns: Promise<IsKeptAwakeResult>

Since: 1.0.0

getPluginVersion()

getPluginVersion() => Promise<{ version: string; }>

Get the native Capacitor plugin version.

Returns: Promise<{ version: string; }>

Since: 1.0.0

Interfaces

IsSupportedResult

Result of the isSupported() method.

IsKeptAwakeResult

Result of the isKeptAwake() method.