mirror of https://github.com/apache/cordova-plugin-statusbar.git synced 2025-01-19 01:12:49 +08:00

Go to file

Shazron Abdullah 378d688833 Updated StatusBar docs for config.xml preferences.		2014-02-18 15:38:42 -08:00
src/ios	CB-5389 - iOS - Status Bar plugin issues with orientation	2013-11-22 12:18:34 -08:00
www	Added show() and hide() to StatusBar API	2013-10-14 16:47:38 -07:00
plugin.xml	statusbar - Load JS on iOS only	2014-02-03 23:38:32 -05:00
README.md	Updated StatusBar docs for config.xml preferences.	2014-02-18 15:38:42 -08:00

StatusBar

The StatusBar object provides some functions to customize the iOS StatusBar.

Preferences

StatusBarOverlaysWebView (boolean, defaults to true). On iOS 7, make the statusbar overlay or not overlay the WebView.
```
 <preference name="StatusBarOverlaysWebView" value="true" />
```
StatusBarBackgroundColor (color hex string, defaults to #000000). On iOS 7, set the background color of the statusbar by a hex string (#RRGGBB).
```
  <preference name="StatusBarBackgroundColor" value="#000000" />
```

        <feature name="StatusBar">
            <param name="ios-package" value="CDVStatusBar" onload="true" />
        </feature>

On iOS 7, make the statusbar overlay or not overlay the WebView.

StatusBar.overlaysWebView(true);

On iOS 7, set to false to make the statusbar appear like iOS 6. Set the style and background color to suit using the other functions.

StatusBar.overlaysWebView(true);
StatusBar.overlaysWebView(false);

Use the default statusbar (dark text, for light backgrounds).

StatusBar.styleDefault();

Use the lightContent statusbar (light text, for dark backgrounds).

StatusBar.styleLightContent();

Use the blackTranslucent statusbar (light text, for dark backgrounds).

StatusBar.styleBlackTranslucent();

Use the blackOpaque statusbar (light text, for dark backgrounds).

StatusBar.styleBlackOpaque();

On iOS 7, when you set StatusBar.statusBarOverlaysWebView to false, you can set the background color of the statusbar by color name.

StatusBar.backgroundColorByName("red");

Supported color names are:

black, darkGray, lightGray, white, gray, red, green, blue, cyan, yellow, magenta, orange, purple, brown, clear

On iOS 7, when you set StatusBar.statusBarOverlaysWebView to false, you can set the background color of the statusbar by a hex string (#RRGGBB).

StatusBar.backgroundColorByHexString("#C0C0C0");

Hide the statusbar.

StatusBar.hide();

Shows the statusbar.

StatusBar.show();

Read this property to see if the statusbar is visible or not.

if (StatusBar.isVisible) {
	// do something
}