--- description: Capacitor plugin to keep the device screen awake and prevent it from dimming or sleeping. Supports Android, iOS, and the web. title: Capacitor Keep Awake Plugin - Capawesome image: https://capawesome.io/docs/assets/images/social/sdks/capacitor/keep-awake.png --- [Skip to content ](#capacitor-keep-awake-plugin) [πŸ” Introducing the **Capacitor Vault** plugin β€” store secrets behind biometrics or a device passcode. ](/blog/announcing-the-capacitor-vault-plugin/) * [ SDKs ](/docs/sdks/) * [ Formbricks ](/docs/sdks/capacitor/formbricks/) * [ Geocoder ](/docs/sdks/capacitor/geocoder/) * [ Google Sign-In ](/docs/sdks/capacitor/google-sign-in/) * [ Grafana Faro ](/docs/sdks/capacitor/grafana-faro/) * [ Gyroscope ](/docs/sdks/capacitor/gyroscope/) * [ In-App Browser ](/docs/sdks/capacitor/in-app-browser/) * [ Install Referrer ](/docs/sdks/capacitor/install-referrer/) * Keep Awake [ Keep Awake ](/docs/sdks/capacitor/keep-awake/) * [ Behavior ](#behavior) * [ Changelog ](#changelog) * [ License ](#license) * [ libSQL ](/docs/sdks/capacitor/libsql/) * [ Live Update ](/docs/sdks/capacitor/live-update/) * [ Localization ](/docs/sdks/capacitor/localization/) * [ Mail Composer ](/docs/sdks/capacitor/mail-composer/) * [ Managed Configurations ](/docs/sdks/capacitor/managed-configurations/) * [ Maps Launcher ](/docs/sdks/capacitor/maps-launcher/) * [ Media Session ](/docs/sdks/capacitor/media-session/) * [ ML Kit ](/docs/sdks/capacitor/mlkit/) * [ Navigation Bar ](/docs/sdks/capacitor/navigation-bar/) * [ NFC ](/docs/sdks/capacitor/nfc/) * [ Node.js ](/docs/sdks/capacitor/nodejs/) * [ OAuth ](/docs/sdks/capacitor/oauth/) * [ Passkeys ](/docs/sdks/capacitor/passkeys/) * [ Password Autofill ](/docs/sdks/capacitor/password-autofill/) * [ Pedometer ](/docs/sdks/capacitor/pedometer/) * [ Photo Editor ](/docs/sdks/capacitor/photo-editor/) * [ PixLive ](/docs/sdks/capacitor/pixlive/) * [ PostHog ](/docs/sdks/capacitor/posthog/) * [ Printer ](/docs/sdks/capacitor/printer/) * [ Privacy Screen ](/docs/sdks/capacitor/privacy-screen/) * [ Purchases ](/docs/sdks/capacitor/purchases/) * [ RealtimeKit ](/docs/sdks/capacitor/realtimekit/) * [ Root Detection ](/docs/sdks/capacitor/root-detection/) * [ Screen Brightness ](/docs/sdks/capacitor/screen-brightness/) * [ Screen Orientation ](/docs/sdks/capacitor/screen-orientation/) * [ Screenshot ](/docs/sdks/capacitor/screenshot/) * [ Secure Preferences ](/docs/sdks/capacitor/secure-preferences/) * [ Shake ](/docs/sdks/capacitor/shake/) * [ Silent Mode ](/docs/sdks/capacitor/silent-mode/) * [ SIM ](/docs/sdks/capacitor/sim/) * [ SMS Composer ](/docs/sdks/capacitor/sms-composer/) * [ Speech Recognition ](/docs/sdks/capacitor/speech-recognition/) * [ Speech Synthesis ](/docs/sdks/capacitor/speech-synthesis/) * [ Share Target ](/docs/sdks/capacitor/share-target/) * [ Square Mobile Payments ](/docs/sdks/capacitor/square-mobile-payments/) * [ SQLite ](/docs/sdks/capacitor/sqlite/) * [ Superwall ](/docs/sdks/capacitor/superwall/) * [ Thermal State ](/docs/sdks/capacitor/thermal-state/) * [ Torch ](/docs/sdks/capacitor/torch/) * [ Vault ](/docs/sdks/capacitor/vault/) * [ Volume ](/docs/sdks/capacitor/volume/) * [ Wallet ](/docs/sdks/capacitor/wallet/) * [ Wifi ](/docs/sdks/capacitor/wifi/) * [ Zip ](/docs/sdks/capacitor/zip/) * [ Cordova ](/docs/sdks/cordova/) * [ Cloud ](/docs/cloud/) * [ Integrations ](/docs/cloud/live-updates/integrations/) * Concepts * Reference * [ Troubleshooting ](/docs/cloud/live-updates/troubleshooting/) * [ FAQ ](/docs/cloud/live-updates/faq/) * [ Native Builds ](/docs/cloud/native-builds/) * [ Set Up Environments ](/docs/cloud/native-builds/environments/) * [ Overwrite Native Configurations ](/docs/cloud/native-builds/native-configurations/) * [ Auto-Increment Build Numbers ](/docs/cloud/native-builds/auto-incrementing-build-numbers/) * [ Configure the Web Build Script ](/docs/cloud/native-builds/web-build-script/) * [ Build from a Monorepo ](/docs/cloud/native-builds/monorepo/) * [ Use pnpm, Yarn, or bun ](/docs/cloud/native-builds/package-managers/) * [ Install Private npm Packages ](/docs/cloud/native-builds/npm-private-registry/) * [ Override the Java Version ](/docs/cloud/native-builds/override-java-version/) * [ Custom iOS Provisioning Profiles ](/docs/cloud/native-builds/custom-ios-provisioning-profiles/) * [ Build without Git ](/docs/cloud/native-builds/build-without-git/) * [ Access Git Behind a Firewall ](/docs/cloud/native-builds/firewall-access/) * [ Integrations ](/docs/cloud/native-builds/integrations/) * Reference * [ Troubleshooting ](/docs/cloud/native-builds/troubleshooting/) * [ FAQ ](/docs/cloud/native-builds/faq/) * [ App Store Publishing ](/docs/cloud/app-store-publishing/) * [ Submit a Build ](/docs/cloud/app-store-publishing/submit-a-build/) * [ Submit Automatically After a Build ](/docs/cloud/app-store-publishing/submit-automatically/) * [ Troubleshooting ](/docs/cloud/app-store-publishing/troubleshooting/) * [ FAQ ](/docs/cloud/app-store-publishing/faq/) * [ Automations ](/docs/cloud/automations/) * [ Reference ](/docs/cloud/automations/reference/) * [ Troubleshooting ](/docs/cloud/automations/troubleshooting/) * [ FAQ ](/docs/cloud/automations/faq/) * [ Assist ](/docs/cloud/assist/) * [ CLI ](/docs/cloud/cli/) * APIs and SDKs * [ Webhooks ](/docs/cloud/webhooks/) * [ Integrations ](/docs/cloud/integrations/) * Account * [ Organization ](/docs/cloud/organizations/) * [ Two-Factor Enforcement ](/docs/cloud/organizations/two-factor-authentication/) * [ Audit Logs ](/docs/cloud/organizations/audit-logs/) * [ Billing ](/docs/cloud/organizations/billing/) * [ License Keys ](/docs/cloud/license-keys/) * [ AI ](/docs/ai/) * [ Insiders ](/docs/insiders/) * [ Billing & Plans ](/docs/insiders/billing-and-plans/) * [ FAQ ](/docs/insiders/faq/) * [ License ](https://capawesome.io/legal/eula/) * [ Support ](/docs/support/) * [ Contributing ](/docs/contributing/) * Contributing code * [ Code of Conduct ](/docs/contributing/code-of-conduct/) * [ Questions ](https://docs.github.com/en/discussions/collaborating-with-your-community-using-discussions/participating-in-a-discussion#creating-a-discussion) * [ Blog ](/blog/) * Categories * [ Behavior ](#behavior) * [ Changelog ](#changelog) * [ License ](#license) # Capacitor Keep Awake Plugin[ΒΆ](#capacitor-keep-awake-plugin "Permanent link") Capacitor plugin to keep the screen awake. [ ![Deliver Live Updates to your Capacitor app with Capawesome Cloud](../../../assets/external/cloud.capawesome.io/assets/banners/cloud-build-and-deploy-capacitor-apps.69628c3f.png) ](https://cloud.capawesome.io/) ## Features[ΒΆ](#features "Permanent link") * πŸŒ™ **Keep awake**: Prevent the screen from dimming or turning off. * πŸ’€ **Allow sleep**: Restore the default screen sleep behavior at any time. * πŸ” **State**: Read whether the screen is currently kept awake. * 🌐 **Cross-platform**: Supports Android, iOS and Web (via the Screen Wake Lock API). * πŸ“¦ **CocoaPods & SPM**: Supports CocoaPods and Swift Package Manager for iOS. * πŸ” **Up-to-date**: Always supports the latest Capacitor version. Missing a feature? Just [open an issue](https://github.com/capawesome-team/capacitor-plugins/issues) and we'll take a look! ## Newsletter[ΒΆ](#newsletter "Permanent link") Stay up to date with the latest news and updates about the Capawesome, Capacitor, and Ionic ecosystem by subscribing to our [Capawesome Newsletter](https://cloud.capawesome.io/newsletter/). ## Compatibility[ΒΆ](#compatibility "Permanent link") | Plugin Version | Capacitor Version | Status | | -------------- | ----------------- | -------------- | | 0.x.x | \>=8.x.x | Active support | ## Installation[ΒΆ](#installation "Permanent link") You can use our **AI-Assisted Setup** to install the plugin. Add the [Capawesome Skills](https://github.com/capawesome-team/skills) to your AI tool using the following command: `[](#%5F%5Fcodelineno-0-1)npx skills add capawesome-team/skills --skill capacitor-plugins ` Then use the following prompt: `` [](#%5F%5Fcodelineno-1-1) Use the `capacitor-plugins` skill from `capawesome-team/skills` to install the `@capawesome/capacitor-keep-awake` plugin in my project. `` If you prefer **Manual Setup**, install the plugin by running the following commands: `[](#%5F%5Fcodelineno-2-1)npm install @capawesome/capacitor-keep-awake [](#%5F%5Fcodelineno-2-2)npx cap sync ` This plugin is available on **Android**, **iOS** and **Web**. No additional permissions or configuration are required. ## Configuration[ΒΆ](#configuration "Permanent link") No configuration required for this plugin. ## Usage[ΒΆ](#usage "Permanent link") `[](#%5F%5Fcodelineno-3-1)import { KeepAwake } from '@capawesome/capacitor-keep-awake'; [](#%5F%5Fcodelineno-3-2) [](#%5F%5Fcodelineno-3-3)const keepAwake = async () => { [](#%5F%5Fcodelineno-3-4) await KeepAwake.keepAwake(); [](#%5F%5Fcodelineno-3-5)}; [](#%5F%5Fcodelineno-3-6) [](#%5F%5Fcodelineno-3-7)const allowSleep = async () => { [](#%5F%5Fcodelineno-3-8) await KeepAwake.allowSleep(); [](#%5F%5Fcodelineno-3-9)}; [](#%5F%5Fcodelineno-3-10) [](#%5F%5Fcodelineno-3-11)const isKeptAwake = async () => { [](#%5F%5Fcodelineno-3-12) const { keptAwake } = await KeepAwake.isKeptAwake(); [](#%5F%5Fcodelineno-3-13) return keptAwake; [](#%5F%5Fcodelineno-3-14)}; [](#%5F%5Fcodelineno-3-15) [](#%5F%5Fcodelineno-3-16)const isAvailable = async () => { [](#%5F%5Fcodelineno-3-17) const { available } = await KeepAwake.isAvailable(); [](#%5F%5Fcodelineno-3-18) return available; [](#%5F%5Fcodelineno-3-19)}; ` ## API[ΒΆ](#api "Permanent link") * [allowSleep()](#allowsleep) * [isAvailable()](#isavailable) * [isKeptAwake()](#iskeptawake) * [keepAwake()](#keepawake) * [Interfaces](#interfaces) ### allowSleep()[ΒΆ](#allowsleep "Permanent link") `[](#%5F%5Fcodelineno-4-1)allowSleep() => Promise ` Allow the screen to dim or turn off again. This reverses the effect of `keepAwake(...)`. Only available on Android, iOS and Web. **Since:** 0.1.0 --- ### isAvailable()[ΒΆ](#isavailable "Permanent link") `[](#%5F%5Fcodelineno-5-1)isAvailable() => Promise ` Check if keeping the screen awake is available on this device. On Web, this depends on whether the browser supports the [Screen Wake Lock API](https://developer.mozilla.org/en-US/docs/Web/API/Screen%5FWake%5FLock%5FAPI). On Android and iOS, this always returns `true`. Only available on Android, iOS and Web. **Returns:** `Promise<[IsAvailableResult](#isavailableresult)>` **Since:** 0.1.0 --- ### isKeptAwake()[ΒΆ](#iskeptawake "Permanent link") `[](#%5F%5Fcodelineno-6-1)isKeptAwake() => Promise ` Check if the screen is currently kept awake. Only available on Android, iOS and Web. **Returns:** `Promise<[IsKeptAwakeResult](#iskeptawakeresult)>` **Since:** 0.1.0 --- ### keepAwake()[ΒΆ](#keepawake "Permanent link") `[](#%5F%5Fcodelineno-7-1)keepAwake() => Promise ` Keep the screen awake by preventing it from dimming or turning off. The screen is kept awake until `allowSleep(...)` is called or the app is restarted. This setting only affects your app and is not system-wide. Only available on Android, iOS and Web. **Since:** 0.1.0 --- ### Interfaces[ΒΆ](#interfaces "Permanent link") #### IsAvailableResult[ΒΆ](#isavailableresult "Permanent link") | Prop | Type | Description | Since | | ------------- | ------- | -------------------------------------------------------------------- | ----- | | **available** | boolean | Whether keeping the screen awake is available on this device or not. | 0.1.0 | #### IsKeptAwakeResult[ΒΆ](#iskeptawakeresult "Permanent link") | Prop | Type | Description | Since | | ------------- | ------- | -------------------------------------------------- | ----- | | **keptAwake** | boolean | Whether the screen is currently kept awake or not. | 0.1.0 | ## Behavior[ΒΆ](#behavior "Permanent link") Keep the following in mind when using this plugin: * **App scope**: Keeping the screen awake only affects your app and is not a system-wide setting. * **State reset**: The screen is only kept awake until `allowSleep(...)` is called or the app is restarted. * **Web auto-release**: On the Web, the underlying [Screen Wake Lock](https://developer.mozilla.org/en-US/docs/Web/API/Screen%5FWake%5FLock%5FAPI) is automatically released by the browser whenever the tab becomes hidden (for example, when the user switches tabs or minimizes the window). The plugin automatically re-acquires the wake lock once the tab becomes visible again, as long as `allowSleep(...)` has not been called in the meantime. ## Changelog[ΒΆ](#changelog "Permanent link") See [CHANGELOG.md](https://github.com/capawesome-team/capacitor-plugins/blob/main/packages/keep-awake/CHANGELOG.md). ## License[ΒΆ](#license "Permanent link") See [LICENSE](https://github.com/capawesome-team/capacitor-plugins/blob/main/packages/keep-awake/LICENSE). July 7, 2026 Back to top ```json {"@context": "https://schema.org", "@graph": [{"@type": "TechArticle", "@id": "https://capawesome.io/docs/sdks/capacitor/keep-awake/#article", "headline": "Capacitor Keep Awake Plugin", "name": "Capacitor Keep Awake Plugin", "description": "Capacitor plugin to keep the device screen awake and prevent it from dimming or sleeping. Supports Android, iOS, and the web.", "inLanguage": "en", "url": "https://capawesome.io/docs/sdks/capacitor/keep-awake/", "mainEntityOfPage": "https://capawesome.io/docs/sdks/capacitor/keep-awake/", "author": {"@type": "Organization", "name": "Capawesome", "url": "https://capawesome.io", "logo": {"@type": "ImageObject", "url": "https://capawesome.io/assets/images/logo.svg"}}, "publisher": {"@type": "Organization", "name": "Capawesome", "url": "https://capawesome.io", "logo": {"@type": "ImageObject", "url": "https://capawesome.io/assets/images/logo.svg"}}, "about": {"@id": "https://capawesome.io/docs/sdks/capacitor/keep-awake/#software"}}, {"@type": "SoftwareSourceCode", "@id": "https://capawesome.io/docs/sdks/capacitor/keep-awake/#software", "name": "Capacitor Keep Awake Plugin", "description": "Capacitor plugin to keep the device screen awake and prevent it from dimming or sleeping. Supports Android, iOS, and the web.", "url": "https://capawesome.io/docs/sdks/capacitor/keep-awake/", "programmingLanguage": "TypeScript", "runtimePlatform": "Capacitor", "codeRepository": "https://github.com/capawesome-team", "author": {"@type": "Organization", "name": "Capawesome", "url": "https://capawesome.io", "logo": {"@type": "ImageObject", "url": "https://capawesome.io/assets/images/logo.svg"}}, "publisher": {"@type": "Organization", "name": "Capawesome", "url": "https://capawesome.io", "logo": {"@type": "ImageObject", "url": "https://capawesome.io/assets/images/logo.svg"}}}]} ```