Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Objective-C JavaScript
branch: master

This branch is 2 commits ahead, 5 commits behind phonegap-build:master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
src/ios
www
README.md
plugin.xml

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.backgroundColorByName
  • StatusBar.backgroundColorByHexString
  • StatusBar.hide
  • StatusBar.show

Properties

  • StatusBar.isVisible

Permissions

config.xml if building locally

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

config.xml if using PhoneGap Build

        <gap:plugin name="com.phonegap.plugin.statusbar" />

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

  • iOS

Quick Example

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

StatusBar.styleDefault

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

StatusBar.styleDefault();

Supported Platforms

  • iOS

StatusBar.styleLightContent

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

StatusBar.styleLightContent();

Supported Platforms

  • iOS

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

  • iOS

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

  • iOS

StatusBar.hide

Hide the statusbar.

StatusBar.hide();

Supported Platforms

  • iOS

StatusBar.show

Shows the statusbar.

StatusBar.show();

Supported Platforms

  • iOS

StatusBar.isVisible

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

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

Supported Platforms

  • iOS
Something went wrong with that request. Please try again.