mirror of https://github.com/apache/cordova-plugin-statusbar.git synced 2025-01-31 10:35:41 +08:00

Go to file

Shazron Abdullah 062dfceb29 CB-5431 - Status Bar Plugin blanks view on call overlaysWebView(false) in landscape orientation Note that this has been tested and works on iPad only, and Universal. On iPhone only while on iPad, there is a black area where the status bar is (bug in statusBarBackgroundView positioning)		2013-11-18 17:20:37 -08:00
src/ios	CB-5431 - Status Bar Plugin blanks view on call overlaysWebView(false) in landscape orientation	2013-11-18 17:20:37 -08:00
www	Added show() and hide() to StatusBar API	2013-10-14 16:47:38 -07:00
plugin.xml	Updated StatusBar plugin version to 0.1.2	2013-10-15 14:13:33 -07:00
README.md	StatusBar - remove dependence of UIViewControllerBasedStatusBarAppearance Info.plist key	2013-10-15 14:12:55 -07:00

README.md

StatusBar

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

The plugin reads the StatusBarOverlaysWebView (boolean, defaults to true) and StatusBarBackgroundColor (color hex string, defaults to #000000) values from config.xml.

Methods

StatusBar.overlaysWebView
StatusBar.styleDefault
StatusBar.styleLightContent
StatusBar.styleBlackTranslucent
StatusBar.styleBlackOpaque
StatusBar.backgroundColorByName
StatusBar.backgroundColorByHexString
StatusBar.hide
StatusBar.show

Properties

StatusBar.isVisible

Permissions

config.xml

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

StatusBar.overlaysWebView

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

StatusBar.overlaysWebView(true);

Description

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.

Supported Platforms

Quick Example

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

StatusBar.styleDefault

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

StatusBar.styleDefault();

Supported Platforms

StatusBar.styleLightContent

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

StatusBar.styleLightContent();

Supported Platforms

StatusBar.styleBlackTranslucent

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

StatusBar.styleBlackTranslucent();

Supported Platforms

StatusBar.styleBlackOpaque

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

StatusBar.styleBlackOpaque();

Supported Platforms

StatusBar.backgroundColorByName

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

Supported Platforms

StatusBar.backgroundColorByHexString

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");

Supported Platforms

StatusBar.hide

Hide the statusbar.

StatusBar.hide();

Supported Platforms

StatusBar.show

Shows the statusbar.

StatusBar.show();

Supported Platforms

StatusBar.isVisible

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

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