{"_id":"@capawesome/capacitor-screen-brightness","_rev":"4-23b1f44e65a444be5409c9338e99968f","name":"@capawesome/capacitor-screen-brightness","dist-tags":{"latest":"0.1.2"},"versions":{"0.0.1":{"name":"@capawesome/capacitor-screen-brightness","version":"0.0.1","keywords":["capacitor","plugin","native"],"author":{"name":"Robin Genz","email":"mail@robingenz.dev"},"license":"MIT","_id":"@capawesome/capacitor-screen-brightness@0.0.1","maintainers":[{"name":"robingenz","email":"mail@robingenz.dev"}],"homepage":"https://capawesome.io/docs/plugins/screen-brightness/","bugs":{"url":"https://github.com/capawesome-team/capacitor-plugins/issues"},"dist":{"shasum":"79b76678d521fab7a91de4c564ff0f7d43422f20","tarball":"https://registry.npmjs.org/@capawesome/capacitor-screen-brightness/-/capacitor-screen-brightness-0.0.1.tgz","fileCount":39,"integrity":"sha512-/CN7y6r1Bcc4upsxA8yXjAUzGUHgZcieM9nEPD9Z3I6kQSe4zd9lPwL4Dq570CzUvsVSWvD+OS4P/Olrk1nInQ==","signatures":[{"sig":"MEQCIA6uEHEJ2QeCAFlGPhAGKXQmv72tDWe7Z9obWTe/sUEDAiBY86xLvJLTVe8KYJ/oVDlwAL/3BfluBPyFI2Z+NpunhA==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":42047},"main":"dist/plugin.cjs.js","types":"dist/esm/index.d.ts","unpkg":"dist/plugin.js","module":"dist/esm/index.js","funding":[{"url":"https://github.com/sponsors/capawesome-team/","type":"github"},{"url":"https://opencollective.com/capawesome","type":"opencollective"}],"gitHead":"8dd31ce5d3f16f94fb71d033f47512e99908f4e4","scripts":{"fmt":"npm run eslint -- --fix && npm run prettier -- --write && npm run swiftlint -- --fix --format","lint":"npm run eslint && npm run prettier -- --check && npm run swiftlint -- lint","build":"npm run clean && npm run docgen && tsc && rollup -c rollup.config.mjs","clean":"rimraf ./dist","watch":"tsc --watch","docgen":"docgen --api ScreenBrightnessPlugin --output-readme README.md --output-json dist/docs.json","eslint":"eslint . --ext ts","verify":"npm run verify:ios && npm run verify:android && npm run verify:web","prettier":"prettier \"**/*.{css,html,ts,js,java}\"","swiftlint":"node-swiftlint","verify:ios":"cd ios && pod install && xcodebuild -workspace Plugin.xcworkspace -scheme Plugin -destination generic/platform=iOS && cd ..","verify:web":"npm run build","prepublishOnly":"npm run build","verify:android":"cd android && ./gradlew clean build test && cd ..","ios:pod:install":"cd ios && pod install --repo-update && cd ..","ios:spm:install":"cd ios && swift package resolve && cd .."},"_npmUser":{"name":"robingenz","email":"mail@robingenz.dev"},"capacitor":{"ios":{"src":"ios"},"android":{"src":"android"}},"repository":{"url":"git+https://github.com/capawesome-team/capacitor-plugins.git","type":"git"},"_npmVersion":"11.13.0","description":"Capacitor plugin for reading and controlling the screen brightness.","directories":{},"_nodeVersion":"24.16.0","eslintConfig":{"extends":"@ionic/eslint-config/recommended"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"eslint":"8.57.0","rimraf":"6.1.2","rollup":"4.53.3","swiftlint":"2.0.0","typescript":"5.9.3","@capacitor/cli":"8.0.0","@capacitor/ios":"8.0.0","@capacitor/core":"8.0.0","@capacitor/docgen":"0.3.1","@capacitor/android":"8.0.0","@ionic/eslint-config":"0.4.0","prettier-plugin-java":"2.6.7"},"peerDependencies":{"@capacitor/core":">=8.0.0"},"_npmOperationalInternal":{"tmp":"tmp/capacitor-screen-brightness_0.0.1_1783405320329_0.5639554136032305","host":"s3://npm-registry-packages-npm-production"}},"0.1.0":{"name":"@capawesome/capacitor-screen-brightness","version":"0.1.0","keywords":["capacitor","plugin","native","capacitor-plugin","screen brightness","brightness control","display brightness","set brightness","dim screen","adjust brightness"],"author":{"name":"Robin Genz","email":"mail@robingenz.dev"},"license":"MIT","_id":"@capawesome/capacitor-screen-brightness@0.1.0","maintainers":[{"name":"robingenz","email":"mail@robingenz.dev"}],"homepage":"https://capawesome.io/docs/sdks/capacitor/screen-brightness/","bugs":{"url":"https://github.com/capawesome-team/capacitor-plugins/issues"},"dist":{"shasum":"810d886b6d0c68a33707103e9fe52f09926de30c","tarball":"https://registry.npmjs.org/@capawesome/capacitor-screen-brightness/-/capacitor-screen-brightness-0.1.0.tgz","fileCount":39,"integrity":"sha512-fAzfsMDaVd+uEqFt6/JfrWRUtLStieAc/QnAehMdTkr8EJZYgT7dOU0SQAuJLimkr3Vb8J1oBFwRlsEbhMYAzw==","signatures":[{"sig":"MEQCID0tGvGHkbZ+Mt2+2wPM4cmAde4K7TndOItyxPcWw51cAiBa/i/z+Ko5+Fssce0zzre7SCsaBGAnZoK38itUZjiORg==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"attestations":{"url":"https://registry.npmjs.org/-/npm/v1/attestations/@capawesome%2fcapacitor-screen-brightness@0.1.0","provenance":{"predicateType":"https://slsa.dev/provenance/v1"}},"unpackedSize":46536},"main":"dist/plugin.cjs.js","types":"dist/esm/index.d.ts","unpkg":"dist/plugin.js","module":"dist/esm/index.js","funding":[{"url":"https://github.com/sponsors/capawesome-team/","type":"github"},{"url":"https://opencollective.com/capawesome","type":"opencollective"}],"gitHead":"1ce17b1fd14c43b2f1d5d3c2da82221e1d1dca37","scripts":{"fmt":"npm run eslint -- --fix && npm run prettier -- --write && npm run swiftlint -- --fix --format","lint":"npm run eslint && npm run prettier -- --check && npm run swiftlint -- lint","build":"npm run clean && npm run docgen && tsc && rollup -c rollup.config.mjs","clean":"rimraf ./dist","watch":"tsc --watch","docgen":"docgen --api ScreenBrightnessPlugin --output-readme README.md --output-json dist/docs.json","eslint":"eslint . --ext ts","verify":"npm run verify:ios && npm run verify:android && npm run verify:web","prettier":"prettier \"**/*.{css,html,ts,js,java}\"","swiftlint":"node-swiftlint","verify:ios":"cd ios && pod install && xcodebuild -workspace Plugin.xcworkspace -scheme Plugin -destination generic/platform=iOS && cd ..","verify:web":"npm run build","prepublishOnly":"npm run build","verify:android":"cd android && ./gradlew clean build test && cd ..","ios:pod:install":"cd ios && pod install --repo-update && cd ..","ios:spm:install":"cd ios && swift package resolve && cd .."},"_npmUser":{"name":"GitHub Actions","email":"npm-oidc-no-reply@github.com","trustedPublisher":{"id":"github","oidcConfigId":"oidc:a6b87549-7f4a-4305-ac4e-8e5c44f74845"}},"capacitor":{"ios":{"src":"ios"},"android":{"src":"android"}},"repository":{"url":"git+https://github.com/capawesome-team/capacitor-plugins.git","type":"git"},"_npmVersion":"11.16.0","description":"Capacitor plugin for reading and controlling the screen brightness on Android and iOS.","directories":{},"_nodeVersion":"24.18.0","eslintConfig":{"extends":"@ionic/eslint-config/recommended"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"eslint":"8.57.0","rimraf":"6.1.2","rollup":"4.53.3","swiftlint":"2.0.0","typescript":"5.9.3","@capacitor/cli":"8.0.0","@capacitor/ios":"8.0.0","@capacitor/core":"8.0.0","@capacitor/docgen":"0.3.1","@capacitor/android":"8.0.0","@ionic/eslint-config":"0.4.0","prettier-plugin-java":"2.6.7"},"peerDependencies":{"@capacitor/core":">=8.0.0"},"_npmOperationalInternal":{"tmp":"tmp/capacitor-screen-brightness_0.1.0_1784015590704_0.28508212035095815","host":"s3://npm-registry-packages-npm-production"}},"0.1.1":{"name":"@capawesome/capacitor-screen-brightness","version":"0.1.1","keywords":["capacitor","plugin","native","capacitor-plugin","screen brightness","brightness control","display brightness","set brightness","dim screen","adjust brightness"],"author":{"name":"Robin Genz","email":"mail@robingenz.dev"},"license":"MIT","_id":"@capawesome/capacitor-screen-brightness@0.1.1","maintainers":[{"name":"robingenz","email":"mail@robingenz.dev"}],"homepage":"https://capawesome.io/docs/sdks/capacitor/screen-brightness/","bugs":{"url":"https://github.com/capawesome-team/capacitor-plugins/issues"},"dist":{"shasum":"ee67e60f3c4f36d8271bd2fee12cfa7e16b9aaa6","tarball":"https://registry.npmjs.org/@capawesome/capacitor-screen-brightness/-/capacitor-screen-brightness-0.1.1.tgz","fileCount":39,"integrity":"sha512-uB+WLhLczbLhsn9gI3rddbQbS7eU+FDlYny6SpuzLvAMlbgZSHn7AM3LF5Ex4Aq1V9zwLopG/D9GDFHnqG3Y8A==","signatures":[{"sig":"MEQCID351p1VdH1VvlQ+jYKDwlp3fNUNWvZd+5e2JX9DY6IzAiAzpBWyXY0V1k97axRVFMNP4VgjJ5YEajQgpzFIGrnOmw==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"attestations":{"url":"https://registry.npmjs.org/-/npm/v1/attestations/@capawesome%2fcapacitor-screen-brightness@0.1.1","provenance":{"predicateType":"https://slsa.dev/provenance/v1"}},"unpackedSize":46545},"main":"dist/plugin.cjs.js","types":"dist/esm/index.d.ts","unpkg":"dist/plugin.js","module":"dist/esm/index.js","funding":[{"url":"https://github.com/sponsors/capawesome-team/","type":"github"},{"url":"https://opencollective.com/capawesome","type":"opencollective"}],"gitHead":"3e61f4b412f9f3f512c21169bb135bbb23a67e6d","scripts":{"fmt":"npm run eslint -- --fix && npm run prettier -- --write && npm run swiftlint -- --fix --format","lint":"npm run eslint && npm run prettier -- --check && npm run swiftlint -- lint","build":"npm run clean && npm run docgen && tsc && rollup -c rollup.config.mjs","clean":"rimraf ./dist","watch":"tsc --watch","docgen":"docgen --api ScreenBrightnessPlugin --output-readme README.md --output-json dist/docs.json","eslint":"eslint . --ext ts","verify":"npm run verify:ios && npm run verify:android && npm run verify:web","prettier":"prettier \"**/*.{css,html,ts,js,java}\"","swiftlint":"node-swiftlint","verify:ios":"cd ios && pod install && xcodebuild -workspace Plugin.xcworkspace -scheme Plugin -destination generic/platform=iOS && cd ..","verify:web":"npm run build","prepublishOnly":"npm run build","verify:android":"cd android && ./gradlew clean build test && cd ..","ios:pod:install":"cd ios && pod install --repo-update && cd ..","ios:spm:install":"cd ios && swift package resolve && cd .."},"_npmUser":{"name":"GitHub Actions","email":"npm-oidc-no-reply@github.com","trustedPublisher":{"id":"github","oidcConfigId":"oidc:a6b87549-7f4a-4305-ac4e-8e5c44f74845"}},"capacitor":{"ios":{"src":"ios"},"android":{"src":"android"}},"repository":{"url":"git+https://github.com/capawesome-team/capacitor-plugins.git","type":"git"},"_npmVersion":"11.16.0","description":"Capacitor plugin for reading and controlling the screen brightness on Android and iOS.","directories":{},"_nodeVersion":"24.18.0","eslintConfig":{"extends":"@ionic/eslint-config/recommended"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"eslint":"8.57.0","rimraf":"6.1.2","rollup":"4.53.3","swiftlint":"2.0.0","typescript":"5.9.3","@capacitor/cli":"8.0.0","@capacitor/ios":"8.0.0","@capacitor/core":"8.0.0","@capacitor/docgen":"0.3.1","@capacitor/android":"8.0.0","@ionic/eslint-config":"0.4.0","prettier-plugin-java":"2.6.7"},"peerDependencies":{"@capacitor/core":">=8.0.0"},"_npmOperationalInternal":{"tmp":"tmp/capacitor-screen-brightness_0.1.1_1784103051669_0.6821293418666561","host":"s3://npm-registry-packages-npm-production"}},"0.1.2":{"name":"@capawesome/capacitor-screen-brightness","version":"0.1.2","description":"Capacitor plugin for reading and controlling the screen brightness on Android and iOS.","main":"dist/plugin.cjs.js","module":"dist/esm/index.js","types":"dist/esm/index.d.ts","unpkg":"dist/plugin.js","author":{"name":"Robin Genz","email":"mail@robingenz.dev"},"license":"MIT","repository":{"type":"git","url":"git+https://github.com/capawesome-team/capacitor-plugins.git"},"bugs":{"url":"https://github.com/capawesome-team/capacitor-plugins/issues"},"funding":[{"type":"github","url":"https://github.com/sponsors/capawesome-team/"},{"type":"opencollective","url":"https://opencollective.com/capawesome"}],"homepage":"https://capawesome.io/docs/sdks/capacitor/screen-brightness/","keywords":["capacitor","plugin","native","capacitor-plugin","screen brightness","brightness control","display brightness","set brightness","dim screen","adjust brightness"],"scripts":{"verify":"npm run verify:ios && npm run verify:android && npm run verify:web","verify:ios":"cd ios && pod install && xcodebuild -workspace Plugin.xcworkspace -scheme Plugin -destination generic/platform=iOS && cd ..","verify:android":"cd android && ./gradlew clean build test && cd ..","verify:web":"npm run build","lint":"npm run eslint && npm run prettier -- --check && npm run swiftlint -- lint","fmt":"npm run eslint -- --fix && npm run prettier -- --write && npm run swiftlint -- --fix --format","eslint":"eslint . --ext ts","prettier":"prettier \"**/*.{css,html,ts,js,java}\"","swiftlint":"node-swiftlint","docgen":"docgen --api ScreenBrightnessPlugin --output-readme README.md --output-json dist/docs.json","build":"npm run clean && npm run docgen && tsc && rollup -c rollup.config.mjs","clean":"rimraf ./dist","watch":"tsc --watch","ios:pod:install":"cd ios && pod install --repo-update && cd ..","ios:spm:install":"cd ios && swift package resolve && cd ..","prepublishOnly":"npm run build"},"devDependencies":{"@capacitor/android":"8.0.0","@capacitor/cli":"8.4.2","@capacitor/core":"8.0.0","@capacitor/docgen":"0.3.1","@capacitor/ios":"8.0.0","@ionic/eslint-config":"0.4.0","eslint":"8.57.0","prettier-plugin-java":"2.9.7","rimraf":"6.1.2","rollup":"4.62.3","swiftlint":"2.0.0","typescript":"5.9.3"},"peerDependencies":{"@capacitor/core":">=8.0.0"},"eslintConfig":{"extends":"@ionic/eslint-config/recommended"},"capacitor":{"ios":{"src":"ios"},"android":{"src":"android"}},"publishConfig":{"access":"public"},"gitHead":"7c1937ed10b7de86ca2c1cdc3539a2735fd69a00","_id":"@capawesome/capacitor-screen-brightness@0.1.2","_nodeVersion":"24.19.0","_npmVersion":"11.17.0","dist":{"integrity":"sha512-QHIMRd7zOP8gIz4VnbZPyEIFdfda6t+0c/cGxwETF8xXyL7+EjuapSqC0HCzuwJ7ME82W/0yRGWs4JaMv1LUvQ==","shasum":"bfaa251c2714ab85889582f49bb55feb7adf7cb5","tarball":"https://registry.npmjs.org/@capawesome/capacitor-screen-brightness/-/capacitor-screen-brightness-0.1.2.tgz","fileCount":39,"unpackedSize":46594,"attestations":{"url":"https://registry.npmjs.org/-/npm/v1/attestations/@capawesome%2fcapacitor-screen-brightness@0.1.2","provenance":{"predicateType":"https://slsa.dev/provenance/v1"}},"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEQCIG4Uiz3MVeehMc2dMDyP+FqSOB1kOlse5vo6ByiOQ0VgAiAhJ/jr/OiF9eMxj1E7Wx3gxJW417twdrOQmo/2LGVb9A=="}]},"_npmUser":{"name":"GitHub Actions","email":"npm-oidc-no-reply@github.com","trustedPublisher":{"id":"github","oidcConfigId":"oidc:a6b87549-7f4a-4305-ac4e-8e5c44f74845"}},"directories":{},"maintainers":[{"name":"robingenz","email":"mail@robingenz.dev"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/capacitor-screen-brightness_0.1.2_1788337403427_0.4786770134248026"},"_hasShrinkwrap":false}},"time":{"created":"2026-07-07T06:22:00.110Z","modified":"2026-09-02T08:23:23.897Z","0.0.1":"2026-07-07T06:22:00.494Z","0.1.0":"2026-07-14T07:53:10.837Z","0.1.1":"2026-07-15T08:10:51.810Z","0.1.2":"2026-09-02T08:23:23.555Z"},"bugs":{"url":"https://github.com/capawesome-team/capacitor-plugins/issues"},"author":{"name":"Robin Genz","email":"mail@robingenz.dev"},"license":"MIT","homepage":"https://capawesome.io/docs/sdks/capacitor/screen-brightness/","keywords":["capacitor","plugin","native","capacitor-plugin","screen brightness","brightness control","display brightness","set brightness","dim screen","adjust brightness"],"repository":{"type":"git","url":"git+https://github.com/capawesome-team/capacitor-plugins.git"},"description":"Capacitor plugin for reading and controlling the screen brightness on Android and iOS.","maintainers":[{"name":"robingenz","email":"mail@robingenz.dev"}],"readme":"# Capacitor Screen Brightness Plugin\n\nCapacitor plugin for reading and controlling the screen brightness.\n\n<div class=\"capawesome-z29o10a\">\n  <a href=\"https://cloud.capawesome.io/\" target=\"_blank\">\n    <img alt=\"Deliver Live Updates to your Capacitor app with Capawesome Cloud\" src=\"https://cloud.capawesome.io/assets/banners/cloud-build-and-deploy-capacitor-apps.png?t=1\" />\n  </a>\n</div>\n\n## Features\n\n- ☀️ **Read brightness**: Read the current screen brightness.\n- 🔆 **Set brightness**: Set the screen brightness, e.g. to boost it for barcode or ticket display.\n- 🔄 **Reset brightness**: Hand the brightness control back to the operating system.\n- 🤝 **Compatibility**: Works alongside the [Keep Awake](https://capawesome.io/docs/sdks/capacitor/keep-awake/) and [Screen Orientation](https://capawesome.io/docs/sdks/capacitor/screen-orientation/) plugins.\n- 📦 **CocoaPods & SPM**: Supports CocoaPods and Swift Package Manager for iOS.\n- 🔁 **Up-to-date**: Always supports the latest Capacitor version.\n\nMissing a feature? Just [open an issue](https://github.com/capawesome-team/capacitor-plugins/issues) and we'll take a look!\n\n## Use Cases\n\nThe Screen Brightness plugin is typically used whenever an app needs to take control of the display brightness, for example:\n\n- **Barcode and QR code display**: Boost the brightness to maximum so scanners can reliably read tickets, boarding passes, or loyalty cards.\n- **Reading and media apps**: Dim the screen for a more comfortable viewing experience in dark environments.\n- **Brightness-aware features**: Read the current brightness to adapt your UI or restore it later.\n- **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.\n\n## Compatibility\n\n| Plugin Version | Capacitor Version | Status         |\n| -------------- | ----------------- | -------------- |\n| 0.x.x          | >=8.x.x           | Active support |\n\n## Installation\n\nYou can use our **AI-Assisted Setup** to install the plugin.\nAdd the [Capawesome Skills](https://github.com/capawesome-team/skills) to your AI tool using the following command:\n\n```bash\nnpx skills add capawesome-team/skills --skill capacitor-plugins\n```\n\nThen use the following prompt:\n\n```\n Use the `capacitor-plugins` skill from `capawesome-team/skills` to install the `@capawesome/capacitor-screen-brightness` plugin in my project.\n```\n\nIf you prefer **Manual Setup**, install the plugin by running the following commands:\n\n```bash\nnpm install @capawesome/capacitor-screen-brightness\nnpx cap sync\n```\n\nThis plugin is available on **Android** and **iOS**. On Web, all methods reject as unimplemented.\n\n## Configuration\n\nNo configuration required for this plugin.\n\n## Usage\n\nThe following examples show how to get, set, and reset the screen brightness.\n\n### Get the current screen brightness\n\nRead the current screen brightness as a value between `0.0` (darkest) and `1.0` (brightest):\n\n```typescript\nimport { ScreenBrightness } from '@capawesome/capacitor-screen-brightness';\n\nconst getBrightness = async () => {\n  const { brightness } = await ScreenBrightness.getBrightness();\n  return brightness;\n};\n```\n\n### Set the screen brightness\n\nSet 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:\n\n```typescript\nimport { ScreenBrightness } from '@capawesome/capacitor-screen-brightness';\n\nconst setBrightness = async () => {\n  await ScreenBrightness.setBrightness({ brightness: 1 });\n};\n```\n\n### Reset the screen brightness\n\nHand the brightness control back to the operating system. Only available on Android:\n\n```typescript\nimport { ScreenBrightness } from '@capawesome/capacitor-screen-brightness';\n\nconst resetBrightness = async () => {\n  await ScreenBrightness.resetBrightness();\n};\n```\n\n## API\n\n<docgen-index>\n\n* [`getBrightness()`](#getbrightness)\n* [`resetBrightness()`](#resetbrightness)\n* [`setBrightness(...)`](#setbrightness)\n* [Interfaces](#interfaces)\n\n</docgen-index>\n\n<docgen-api>\n<!--Update the source file JSDoc comments and rerun docgen to update the docs below-->\n\n### getBrightness()\n\n```typescript\ngetBrightness() => Promise<GetBrightnessResult>\n```\n\nGet the current screen brightness.\n\nOnly available on Android and iOS.\n\n**Returns:** <code>Promise&lt;<a href=\"#getbrightnessresult\">GetBrightnessResult</a>&gt;</code>\n\n**Since:** 0.1.0\n\n--------------------\n\n\n### resetBrightness()\n\n```typescript\nresetBrightness() => Promise<void>\n```\n\nReset the screen brightness to the system default.\n\nThis hands the brightness control back to the operating system.\n\nOnly available on Android.\n\n**Since:** 0.1.0\n\n--------------------\n\n\n### setBrightness(...)\n\n```typescript\nsetBrightness(options: SetBrightnessOptions) => Promise<void>\n```\n\nSet the screen brightness.\n\nOn Android, only the brightness of the current app window is changed.\nThe change is reverted automatically as soon as the app is closed.\n\nOn iOS, this changes the **system** brightness and the change persists\nafter the app is closed.\n\nOnly available on Android and iOS.\n\n| Param         | Type                                                                  |\n| ------------- | --------------------------------------------------------------------- |\n| **`options`** | <code><a href=\"#setbrightnessoptions\">SetBrightnessOptions</a></code> |\n\n**Since:** 0.1.0\n\n--------------------\n\n\n### Interfaces\n\n\n#### GetBrightnessResult\n\n| Prop             | Type                | Description                                                                             | Since |\n| ---------------- | ------------------- | --------------------------------------------------------------------------------------- | ----- |\n| **`brightness`** | <code>number</code> | The current screen brightness as a value between `0.0` (darkest) and `1.0` (brightest). | 0.1.0 |\n\n\n#### SetBrightnessOptions\n\n| Prop             | Type                | Description                                                                            | Since |\n| ---------------- | ------------------- | -------------------------------------------------------------------------------------- | ----- |\n| **`brightness`** | <code>number</code> | The screen brightness to set as a value between `0.0` (darkest) and `1.0` (brightest). | 0.1.0 |\n\n</docgen-api>\n\n## Platform Notes\n\n### Android\n\nSetting 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.\n\n### iOS\n\nSetting 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.\n\n## FAQ\n\n### How is this plugin different from other similar plugins?\n\nIt 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.\n\n### Why does the brightness stay changed after closing my app on iOS?\n\nOn 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.\n\n### Why is the resetBrightness method not available on iOS?\n\nThe `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.\n\n### Does setting the brightness require any permissions on Android?\n\nNo. 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.\n\n### What values can I use for the brightness?\n\nThe brightness is a number between `0.0` (darkest) and `1.0` (brightest). The same range is used by `getBrightness()` when reading the current brightness.\n\n### Does this plugin work on the Web?\n\nNo. 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.\n\n### Can I use this plugin with Ionic, React, Vue or Angular?\n\nYes, 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.\n\n## Related Plugins\n\n- [Keep Awake](https://capawesome.io/docs/sdks/capacitor/keep-awake/): Keep the screen awake while your app is in use.\n- [Screen Orientation](https://capawesome.io/docs/sdks/capacitor/screen-orientation/): Lock and unlock the screen orientation.\n- [Torch](https://capawesome.io/docs/sdks/capacitor/torch/): Switch the flashlight on and off.\n- [Volume](https://capawesome.io/docs/sdks/capacitor/volume/): Control the volume and observe hardware volume button presses.\n\n## Newsletter\n\nStay 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/).\n\n## Changelog\n\nSee [CHANGELOG.md](https://github.com/capawesome-team/capacitor-plugins/blob/main/packages/screen-brightness/CHANGELOG.md).\n\n## License\n\nSee [LICENSE](https://github.com/capawesome-team/capacitor-plugins/blob/main/packages/screen-brightness/LICENSE).\n","readmeFilename":"README.md"}