@nativescript/brightness
NativeScript plugin, that helps you set the brightness of the screen for Android and iOS.
npm i --save @nativescript/brightness
- Version: 2.0.0
- GitHub: https://github.com/NativeScript/plugins
- NPM: https://www.npmjs.com/package/%40nativescript%2Fbrightness
- Downloads:
- Last Day: 2
- Last Week: 4
- Last Month: 17
Nativescript brightness
ns plugin add @nativescript/brightness
This command automatically installs the necessary files, as well as stores @nativescript/brightness as a dependency in your project's package.json
file.
This plugin requires <uses-permission android:name="android.permission.WRITE_SETTINGS"/>
to be added in the android manifest.
Usage
To use the brightness module you must first require()
and instantiate it:
// JavaScript
var nativescriptBrightness = require("@nativescript/brightness");
var brightness = new nativescriptBrightness.Brightness();
Or if you’re using TypeScript, import
the module:
// TypeScript
import { Brightness } from '@nativescript/brightness';
const brightness = new Brightness();
After you have a reference to the module you can then call its get()
and set()
methods. For example, the code below updates you screen's brightness with an intensity
setting of 25%.
The intensity
can be set to a value from 1 to 100.
// TypeScript
import { Brightness } from '@nativescript/brightness';
const brightness = new Brightness();
brightness.set({
intensity: 25
});
API
Methods
Method | Description |
---|---|
set(options: BrightnessOptions) | set screen's brightness to the desired intensity |
get | returns current screen brightness value as a number between 0 and 100 |
getNative | returns current screen brightness value as returned from the native api: between 0.0 and 1.0 for iOS and 0 and 255 for android |
BrightnessOptions
Property | Default | Description |
---|---|---|
intensity | 100 | defines the desired brightness value, which should be a number between 0 and 100. |
License
Apache License Version 2.0