katzer / cordova-plugin-hidden-statusbar-overlay

Cordova plugin to hide the statusbar and overlay on iOS
Apache License 2.0
27 stars 14 forks source link
cordova-ios-plugin cordova-plugin overlay statusbar

SAMPLE APP :point_right:

HiddenStatusbarOverlay Plugin npm version

Beginning with iOS 7 view controllers are displayed full screen, by default, as shown here. This means they will cover the entire screen including the area underneath the status bar.

Supported Platforms

Installation

The plugin can be installed via CLI and is publicly available on NPM.

Execute from the projects root folder:

$ cordova plugin add cordova-plugin-hidden-statusbar-overlay

Or install a specific version:

$ cordova plugin add cordova-plugin-hidden-statusbar-overlay@VERSION

Or install the latest head version:

$ cordova plugin add https://github.com/katzer/cordova-plugin-hidden-statusbar-overlay.git

Or install from local source:

$ cordova plugin add cordova-plugin-hidden-statusbar-overlay --searchpath <path>

Or add the following line to the config.xml for Phonegap Build projects:

<plugin name="cordova-plugin-hidden-statusbar-overlay" spec="https://github.com/katzer/cordova-plugin-hidden-statusbar-overlay" />

Usage

The plugin creates the object cordova.plugins.statusbarOverlay and is accessible after the deviceready event has been fired.

document.addEventListener('deviceready', function () {
    // cordova.plugins.statusbarOverlay is now available
}, false);

Statusbar and the overlay will be hidden on app start. The visibility of the status bar can be changed manually.

To hide the status bar:

cordova.plugins.statusbarOverlay.hide();

To show the status bar:

cordova.plugins.statusbarOverlay.show();

To determine if the status bar is hidden:

cordova.plugins.statusbarOverlay.isHidden(function (isHidden) {
    console.log('status bar is hidden? -> ', isHidden)
});

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

License

This software is released under the Apache 2.0 License.

Made with :yum: from Leipzig

© 2013 appPlant GmbH