awesome-cordova-plugins/dist/plugins/statusbar.d.ts

60 lines
2.0 KiB
TypeScript
Raw Normal View History

2016-02-06 05:06:03 +08:00
/**
* Manage the appearance of the native status bar.
*
2016-02-17 07:42:41 +08:00
* Requires Cordova plugin: `cordova-plugin-statusbar`. For more info, please see the [StatusBar plugin docs](https://github.com/apache/cordova-plugin-statusbar).
2016-02-06 05:06:03 +08:00
*/
2015-11-29 08:26:55 +08:00
export declare class StatusBar {
2016-02-06 05:06:03 +08:00
/**
* Set whether the status bar overlays the main app view. The default
* is true.
*
2016-02-17 07:42:41 +08:00
* @param {boolean} doesOverlay Whether the status bar overlays the main app view.
*/
static overlaysWebView(doesOverlay: boolean): void;
/**
* Use the default statusbar (dark text, for light backgrounds).
2016-02-06 05:06:03 +08:00
*/
2015-11-30 09:54:45 +08:00
static styleDefault(): void;
2016-02-17 07:42:41 +08:00
/**
* Use the lightContent statusbar (light text, for dark backgrounds).
*/
2015-11-30 09:54:45 +08:00
static styleLightContent(): void;
2016-02-17 07:42:41 +08:00
/**
* Use the blackTranslucent statusbar (light text, for dark backgrounds).
*/
2015-11-30 09:54:45 +08:00
static styleBlackTranslucent(): void;
2016-02-17 07:42:41 +08:00
/**
* Use the blackOpaque statusbar (light text, for dark backgrounds).
*/
2015-11-30 09:54:45 +08:00
static styleBlackOpaque(): void;
2016-02-06 05:06:03 +08:00
/**
* Set the status bar to a specific named color. Valid options:
* black, darkGray, lightGray, white, gray, red, green, blue, cyan, yellow, magenta, orange, purple, brown.
*
* iOS note: you must call StatusBar.setOverlay(false) to enable color changing.
*
2016-02-17 07:42:41 +08:00
* @param {string} colorName The name of the color (from above)
2016-02-06 05:06:03 +08:00
*/
2015-11-30 09:54:45 +08:00
static backgroundColorByName(colorName: string): void;
2016-02-06 05:06:03 +08:00
/**
* Set the status bar to a specific hex color (CSS shorthand supported!).
*
* iOS note: you must call StatusBar.setOverlay(false) to enable color changing.
*
2016-02-17 07:42:41 +08:00
* @param {string} hexString The hex value of the color.
2016-02-06 05:06:03 +08:00
*/
2015-11-30 09:54:45 +08:00
static backgroundColorByHexString(hexString: string): void;
2016-02-06 05:06:03 +08:00
/**
* Hide the StatusBar
*/
2015-11-30 09:54:45 +08:00
static hide(): void;
2016-02-06 05:06:03 +08:00
/**
* Show the StatusBar
*/
2015-11-30 09:54:45 +08:00
static show(): void;
2016-02-17 07:42:41 +08:00
/**
* Whether the StatusBar is currently visible or not.
*/
static isVisible(): any;
2015-11-29 08:26:55 +08:00
}