--- description: Capacitor plugin to read, set, and reset the screen brightness of your app on Android and iOS. title: Capacitor Screen Brightness Plugin - Capawesome image: https://capawesome.io/docs/assets/images/social/sdks/capacitor/screen-brightness.png --- [Skip to content ](#capacitor-screen-brightness-plugin) [πŸ“² Introducing **Build Sharing** β€” get your builds onto testers' devices with a link & QR code. No account required. ](/blog/share-mobile-app-builds-with-testers/) * [ 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/) * [ Haptics ](/docs/sdks/capacitor/haptics/) * [ Home Indicator ](/docs/sdks/capacitor/home-indicator/) * [ In-App Browser ](/docs/sdks/capacitor/in-app-browser/) * [ Install Referrer ](/docs/sdks/capacitor/install-referrer/) * [ Keep Awake ](/docs/sdks/capacitor/keep-awake/) * [ libSQL ](/docs/sdks/capacitor/libsql/) * [ Light Sensor ](/docs/sdks/capacitor/light-sensor/) * [ 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/) * [ Network ](/docs/sdks/capacitor/network/) * [ 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/) * [ PDF Generator ](/docs/sdks/capacitor/pdf-generator/) * [ PDF Viewer ](/docs/sdks/capacitor/pdf-viewer/) * [ Pedometer ](/docs/sdks/capacitor/pedometer/) * [ Permissions ](/docs/sdks/capacitor/permissions/) * [ Phone Dialer ](/docs/sdks/capacitor/phone-dialer/) * [ Photo Editor ](/docs/sdks/capacitor/photo-editor/) * [ Photo Manipulator ](/docs/sdks/capacitor/photo-manipulator/) * [ PixLive ](/docs/sdks/capacitor/pixlive/) * [ PostHog ](/docs/sdks/capacitor/posthog/) * [ Printer ](/docs/sdks/capacitor/printer/) * [ Privacy Screen ](/docs/sdks/capacitor/privacy-screen/) * [ Proximity Sensor ](/docs/sdks/capacitor/proximity-sensor/) * [ Purchases ](/docs/sdks/capacitor/purchases/) * [ RealtimeKit ](/docs/sdks/capacitor/realtimekit/) * [ Root Detection ](/docs/sdks/capacitor/root-detection/) * Screen Brightness [ Screen Brightness ](/docs/sdks/capacitor/screen-brightness/) * [ API ](#api) * [ Platform Notes ](#platform-notes) * [ FAQ ](#faq) * [ Related Plugins ](#related-plugins) * [ Newsletter ](#newsletter) * [ Changelog ](#changelog) * [ License ](#license) * [ Screen Orientation ](/docs/sdks/capacitor/screen-orientation/) * [ Screen Reader ](/docs/sdks/capacitor/screen-reader/) * [ Screenshot ](/docs/sdks/capacitor/screenshot/) * [ Secure Preferences ](/docs/sdks/capacitor/secure-preferences/) * [ Settings Launcher ](/docs/sdks/capacitor/settings-launcher/) * [ 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/) * [ System WebView ](/docs/sdks/capacitor/system-webview/) * [ Text Interaction ](/docs/sdks/capacitor/text-interaction/) * [ Text Zoom ](/docs/sdks/capacitor/text-zoom/) * [ Thermal State ](/docs/sdks/capacitor/thermal-state/) * [ Toast ](/docs/sdks/capacitor/toast/) * [ 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 * [ API ](#api) * [ Platform Notes ](#platform-notes) * [ FAQ ](#faq) * [ Related Plugins ](#related-plugins) * [ Newsletter ](#newsletter) * [ Changelog ](#changelog) * [ License ](#license) # Capacitor Screen Brightness Plugin[ΒΆ](#capacitor-screen-brightness-plugin "Permanent link") Capacitor plugin for reading and controlling the screen brightness. [ ![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") * β˜€οΈ **Read brightness**: Read the current screen brightness. * πŸ”† **Set brightness**: Set the screen brightness, e.g. to boost it for barcode or ticket display. * πŸ”„ **Reset brightness**: Hand the brightness control back to the operating system. * πŸ“¦ **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! ## Use Cases[ΒΆ](#use-cases "Permanent link") The Screen Brightness plugin is typically used whenever an app needs to take control of the display brightness, for example: * **Barcode and QR code display**: Boost the brightness to maximum so scanners can reliably read tickets, boarding passes, or loyalty cards. * **Reading and media apps**: Dim the screen for a more comfortable viewing experience in dark environments. * **Brightness-aware features**: Read the current brightness to adapt your UI or restore it later. * **Kiosk and point-of-sale apps**: Keep the display at a defined brightness level while the app is in use and hand control back to the operating system afterwards. ## 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-screen-brightness` 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-screen-brightness [](#%5F%5Fcodelineno-2-2)npx cap sync ` This plugin is available on **Android** and **iOS**. On Web, all methods reject as unimplemented. ## Configuration[ΒΆ](#configuration "Permanent link") No configuration required for this plugin. ## Usage[ΒΆ](#usage "Permanent link") The following examples show how to get, set, and reset the screen brightness. ### Get the current screen brightness[ΒΆ](#get-the-current-screen-brightness "Permanent link") Read the current screen brightness as a value between `0.0` (darkest) and `1.0` (brightest): `[](#%5F%5Fcodelineno-3-1)import { ScreenBrightness } from '@capawesome/capacitor-screen-brightness'; [](#%5F%5Fcodelineno-3-2) [](#%5F%5Fcodelineno-3-3)const getBrightness = async () => { [](#%5F%5Fcodelineno-3-4) const { brightness } = await ScreenBrightness.getBrightness(); [](#%5F%5Fcodelineno-3-5) return brightness; [](#%5F%5Fcodelineno-3-6)}; ` ### Set the screen brightness[ΒΆ](#set-the-screen-brightness "Permanent link") Set the screen brightness to a value between `0.0` (darkest) and `1.0` (brightest). On Android, only the brightness of the current app window is changed and the change is reverted automatically as soon as the app is closed. On iOS, this changes the system brightness and the change persists after the app is closed: `[](#%5F%5Fcodelineno-4-1)import { ScreenBrightness } from '@capawesome/capacitor-screen-brightness'; [](#%5F%5Fcodelineno-4-2) [](#%5F%5Fcodelineno-4-3)const setBrightness = async () => { [](#%5F%5Fcodelineno-4-4) await ScreenBrightness.setBrightness({ brightness: 1 }); [](#%5F%5Fcodelineno-4-5)}; ` ### Reset the screen brightness[ΒΆ](#reset-the-screen-brightness "Permanent link") Hand the brightness control back to the operating system. Only available on Android: `[](#%5F%5Fcodelineno-5-1)import { ScreenBrightness } from '@capawesome/capacitor-screen-brightness'; [](#%5F%5Fcodelineno-5-2) [](#%5F%5Fcodelineno-5-3)const resetBrightness = async () => { [](#%5F%5Fcodelineno-5-4) await ScreenBrightness.resetBrightness(); [](#%5F%5Fcodelineno-5-5)}; ` ## API[ΒΆ](#api "Permanent link") * [getBrightness()](#getbrightness) * [resetBrightness()](#resetbrightness) * [setBrightness(...)](#setbrightness) * [Interfaces](#interfaces) ### getBrightness()[ΒΆ](#getbrightness "Permanent link") `[](#%5F%5Fcodelineno-6-1)getBrightness() => Promise ` Get the current screen brightness. Only available on Android and iOS. **Returns:** `Promise<[GetBrightnessResult](#getbrightnessresult)>` **Since:** 0.1.0 --- ### resetBrightness()[ΒΆ](#resetbrightness "Permanent link") `[](#%5F%5Fcodelineno-7-1)resetBrightness() => Promise ` Reset the screen brightness to the system default. This hands the brightness control back to the operating system. Only available on Android. **Since:** 0.1.0 --- ### setBrightness(...)[ΒΆ](#setbrightness "Permanent link") `[](#%5F%5Fcodelineno-8-1)setBrightness(options: SetBrightnessOptions) => Promise ` Set the screen brightness. On Android, only the brightness of the current app window is changed. The change is reverted automatically as soon as the app is closed. On iOS, this changes the **system** brightness and the change persists after the app is closed. Only available on Android and iOS. | Param | Type | | ----------- | --------------------------------------------- | | **options** | [SetBrightnessOptions](#setbrightnessoptions) | **Since:** 0.1.0 --- ### Interfaces[ΒΆ](#interfaces "Permanent link") #### GetBrightnessResult[ΒΆ](#getbrightnessresult "Permanent link") | Prop | Type | Description | Since | | -------------- | ------ | ----------------------------------------------------------------------------------- | ----- | | **brightness** | number | The current screen brightness as a value between 0.0 (darkest) and 1.0 (brightest). | 0.1.0 | #### SetBrightnessOptions[ΒΆ](#setbrightnessoptions "Permanent link") | Prop | Type | Description | Since | | -------------- | ------ | ---------------------------------------------------------------------------------- | ----- | | **brightness** | number | The screen brightness to set as a value between 0.0 (darkest) and 1.0 (brightest). | 0.1.0 | ## Platform Notes[ΒΆ](#platform-notes "Permanent link") ### Android[ΒΆ](#android "Permanent link") Setting the brightness only affects the **current app window** and does not require the `WRITE_SETTINGS` permission. The change is reverted automatically as soon as the app is closed. Use `resetBrightness()` to hand the brightness control back to the operating system while the app is running. ### iOS[ΒΆ](#ios "Permanent link") Setting the brightness changes the **system** brightness and the change **persists** after the app is closed. There is no system API to hand the brightness control back to the operating system, so `resetBrightness()` is not available on iOS and rejects as unimplemented. ## FAQ[ΒΆ](#faq "Permanent link") ### How is this plugin different from other similar plugins?[ΒΆ](#how-is-this-plugin-different-from-other-similar-plugins "Permanent link") It reads, sets, and (on Android) resets the screen brightness through a small, fully typed API, using a normalized `0.0`–`1.0` range on both platforms. On Android it changes only the current app window, so no `WRITE_SETTINGS` permission is required and the change reverts automatically when the app closes, which makes use cases like boosting brightness to display a barcode or ticket straightforward. It supports CocoaPods and Swift Package Manager on iOS and is actively maintained against the latest Capacitor version. ### Why does the brightness stay changed after closing my app on iOS?[ΒΆ](#why-does-the-brightness-stay-changed-after-closing-my-app-on-ios "Permanent link") On iOS, setting the brightness changes the system brightness, which persists after the app is closed. There is no system API to hand the brightness control back to the operating system on iOS. If you want to be a good citizen, read the current brightness with `getBrightness()` before changing it and restore that value when your app goes to the background. ### Why is the resetBrightness method not available on iOS?[ΒΆ](#why-is-the-resetbrightness-method-not-available-on-ios "Permanent link") The `resetBrightness()` method hands the brightness control back to the operating system, which is only possible on Android. On iOS, there is no system API for this, so the method rejects as unimplemented. See the [Platform Notes](#platform-notes) section for details. ### Does setting the brightness require any permissions on Android?[ΒΆ](#does-setting-the-brightness-require-any-permissions-on-android "Permanent link") No. On Android, the plugin only changes the brightness of the current app window, which does not require the `WRITE_SETTINGS` permission. The change is reverted automatically as soon as the app is closed. ### What values can I use for the brightness?[ΒΆ](#what-values-can-i-use-for-the-brightness "Permanent link") The brightness is a number between `0.0` (darkest) and `1.0` (brightest). The same range is used by `getBrightness()` when reading the current brightness. ### Does this plugin work on the Web?[ΒΆ](#does-this-plugin-work-on-the-web "Permanent link") No. The plugin is available on Android and iOS. On the Web, all methods reject as unimplemented, since browsers do not provide an API to control the screen brightness. ### Can I use this plugin with Ionic, React, Vue or Angular?[ΒΆ](#can-i-use-this-plugin-with-ionic-react-vue-or-angular "Permanent link") Yes, the plugin is framework-agnostic. It works in any Capacitor app regardless of the web framework, including Ionic with Angular, React, or Vue, as well as plain JavaScript projects. ## Related Plugins[ΒΆ](#related-plugins "Permanent link") * [Keep Awake](https://capawesome.io/docs/sdks/capacitor/keep-awake/): Keep the screen awake while your app is in use. * [Screen Orientation](https://capawesome.io/docs/sdks/capacitor/screen-orientation/): Lock and unlock the screen orientation. * [Torch](https://capawesome.io/docs/sdks/capacitor/torch/): Switch the flashlight on and off. * [Volume](https://capawesome.io/docs/sdks/capacitor/volume/): Control the volume and observe hardware volume button presses. ## 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/). ## Changelog[ΒΆ](#changelog "Permanent link") See [CHANGELOG.md](https://github.com/capawesome-team/capacitor-plugins/blob/main/packages/screen-brightness/CHANGELOG.md). ## License[ΒΆ](#license "Permanent link") See [LICENSE](https://github.com/capawesome-team/capacitor-plugins/blob/main/packages/screen-brightness/LICENSE). July 8, 2026 Back to top ```json {"@context": "https://schema.org", "@graph": [{"@type": "TechArticle", "@id": "https://capawesome.io/docs/sdks/capacitor/screen-brightness/#article", "headline": "Capacitor Screen Brightness Plugin", "name": "Capacitor Screen Brightness Plugin", "description": "Capacitor plugin to read, set, and reset the screen brightness of your app on Android and iOS.", "inLanguage": "en", "url": "https://capawesome.io/docs/sdks/capacitor/screen-brightness/", "mainEntityOfPage": "https://capawesome.io/docs/sdks/capacitor/screen-brightness/", "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/screen-brightness/#software"}}, {"@type": "SoftwareSourceCode", "@id": "https://capawesome.io/docs/sdks/capacitor/screen-brightness/#software", "name": "Capacitor Screen Brightness Plugin", "description": "Capacitor plugin to read, set, and reset the screen brightness of your app on Android and iOS.", "url": "https://capawesome.io/docs/sdks/capacitor/screen-brightness/", "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"}}}]} {"@context": "https://schema.org", "@type": "FAQPage", "mainEntity": [{"@type": "Question", "name": "How is this plugin different from other similar plugins?", "acceptedAnswer": {"@type": "Answer", "text": "It reads, sets, and (on Android) resets the screen brightness through a small, fully typed API, using a normalized 0.0 – 1.0 range on both platforms. On Android it changes only the current app window, so no WRITE_SETTINGS permission is required and the change reverts automatically when the app closes, which makes use cases like boosting brightness to display a barcode or ticket straightforward. It supports CocoaPods and Swift Package Manager on iOS and is actively maintained against the latest Capacitor version."}}, {"@type": "Question", "name": "Why does the brightness stay changed after closing my app on iOS?", "acceptedAnswer": {"@type": "Answer", "text": "On iOS, setting the brightness changes the system brightness, which persists after the app is closed. There is no system API to hand the brightness control back to the operating system on iOS. If you want to be a good citizen, read the current brightness with getBrightness() before changing it and restore that value when your app goes to the background."}}, {"@type": "Question", "name": "Why is the resetBrightness method not available on iOS?", "acceptedAnswer": {"@type": "Answer", "text": "The resetBrightness() method hands the brightness control back to the operating system, which is only possible on Android. On iOS, there is no system API for this, so the method rejects as unimplemented. See the Platform Notes section for details."}}, {"@type": "Question", "name": "Does setting the brightness require any permissions on Android?", "acceptedAnswer": {"@type": "Answer", "text": "No. On Android, the plugin only changes the brightness of the current app window, which does not require the WRITE_SETTINGS permission. The change is reverted automatically as soon as the app is closed."}}, {"@type": "Question", "name": "What values can I use for the brightness?", "acceptedAnswer": {"@type": "Answer", "text": "The brightness is a number between 0.0 (darkest) and 1.0 (brightest). The same range is used by getBrightness() when reading the current brightness."}}, {"@type": "Question", "name": "Does this plugin work on the Web?", "acceptedAnswer": {"@type": "Answer", "text": "No. The plugin is available on Android and iOS. On the Web, all methods reject as unimplemented, since browsers do not provide an API to control the screen brightness."}}, {"@type": "Question", "name": "Can I use this plugin with Ionic, React, Vue or Angular?", "acceptedAnswer": {"@type": "Answer", "text": "Yes, the plugin is framework-agnostic. It works in any Capacitor app regardless of the web framework, including Ionic with Angular, React, or Vue, as well as plain JavaScript projects."}}], "url": "https://capawesome.io/docs/sdks/capacitor/screen-brightness/"} ```