capacitor-keep-awake

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/

Install

npm install @capgo/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.

| Prop | Type | Description | Since | | ----------------- | -------------------- | -------------------------------------------------------- | ----- | | isSupported | boolean | Whether keep awake is supported on the current platform. | 1.0.0 |

IsKeptAwakeResult

Result of the isKeptAwake() method.

| Prop | Type | Description | Since | | ----------------- | -------------------- | ------------------------------------------------- | ----- | | isKeptAwake | boolean | Whether the device is currently being kept awake. | 1.0.0 |