github/awesome-cordova-plugins
github/awesome-cordova-plugins
2
0
Fork 1
mirror of https://github.com/danielsogl/awesome-cordova-plugins.git synced 2024-10-06 15:52:12 +08:00
Code Issues Projects Releases Wiki Activity

Improved brightness plugin documentation

Browse Source
This commit is contained in:
Aaron Czichon 2016-06-12 15:25:22 +02:00
parent 0e0150bd3a
commit 80e679f4dc
1 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
src/plugins/brightness.ts
View File

@ -1,5 +1,21 @@
import {Plugin, Cordova} from './plugin';
/**
* @name Brightness
* @description
* The Brightness plugin let you control the display brightness of your device.
*
* Requires Cordova plugin: `cordova-plugin-brightness`. For more info, please see the [Brightness plugin docs](https://github.com/mgcrea/cordova-plugin-brightness).
*
* @usage
* ```ts
* import {Brightness} from 'ionic-native';
*
* let brightnessValue: number = 0.8;
* Brightness.setBrightness(brightnessValue);
* ```
*
*/
@Plugin({
plugin: 'cordova-plugin-brightness',
pluginRef: 'plugins.brightness',