mirror of
https://github.com/danielsogl/awesome-cordova-plugins.git
synced 2025-03-17 00:51:07 +08:00
Improved brightness plugin documentation
This commit is contained in:
parent
0e0150bd3a
commit
80e679f4dc
@ -1,5 +1,21 @@
|
|||||||
import {Plugin, Cordova} from './plugin';
|
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({
|
||||||
plugin: 'cordova-plugin-brightness',
|
plugin: 'cordova-plugin-brightness',
|
||||||
pluginRef: 'plugins.brightness',
|
pluginRef: 'plugins.brightness',
|
||||||
|
Loading…
x
Reference in New Issue
Block a user