| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879 |
- import { IonicNativePlugin } from '@ionic-native/core';
- /**
- * @name Status Bar
- * @description
- * Manage the appearance of the native status bar.
- *
- * Requires Cordova plugin: `cordova-plugin-statusbar`. For more info, please see the [StatusBar plugin docs](https://github.com/apache/cordova-plugin-statusbar).
- *
- * @usage
- * ```typescript
- * import { StatusBar } from '@ionic-native/status-bar';
- *
- * constructor(private statusBar: StatusBar) { }
- *
- * ...
- *
- * // let status bar overlay webview
- * this.statusBar.overlaysWebView(true);
- *
- * // set status bar to white
- * this.statusBar.backgroundColorByHexString('#ffffff');
- * ```
- *
- */
- export declare class StatusBar extends IonicNativePlugin {
- /**
- * Set whether the status bar overlays the main app view. The default
- * is true.
- *
- * @param {boolean} doesOverlay Whether the status bar overlays the main app view.
- */
- overlaysWebView(doesOverlay: boolean): void;
- /**
- * Use the default statusbar (dark text, for light backgrounds).
- */
- styleDefault(): void;
- /**
- * Use the lightContent statusbar (light text, for dark backgrounds).
- */
- styleLightContent(): void;
- /**
- * Use the blackTranslucent statusbar (light text, for dark backgrounds).
- */
- styleBlackTranslucent(): void;
- /**
- * Use the blackOpaque statusbar (light text, for dark backgrounds).
- */
- styleBlackOpaque(): void;
- /**
- * 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.overlaysWebView(false) to enable color changing.
- *
- * @param {string} colorName The name of the color (from above)
- */
- backgroundColorByName(colorName: string): void;
- /**
- * Set the status bar to a specific hex color (CSS shorthand supported!).
- *
- * iOS note: you must call StatusBar.overlaysWebView(false) to enable color changing.
- *
- * @param {string} hexString The hex value of the color.
- */
- backgroundColorByHexString(hexString: string): void;
- /**
- * Hide the StatusBar
- */
- hide(): void;
- /**
- * Show the StatusBar
- */
- show(): void;
- /**
- * Whether the StatusBar is currently visible or not.
- */
- isVisible: boolean;
- }
|