summaryrefslogtreecommitdiff
path: root/plugins/org.apache.cordova.statusbar/doc/index.md
diff options
context:
space:
mode:
authorArjun Roychowdhury <pliablepixels@gmail.com>2015-10-31 08:21:38 -0400
committerArjun Roychowdhury <pliablepixels@gmail.com>2015-10-31 08:21:38 -0400
commit02811010cf62f1b21a06780d1e470d04bb24c50f (patch)
tree0d933789068aac11c810ed4bb169d14ab16c43c6 /plugins/org.apache.cordova.statusbar/doc/index.md
parentbca561c1b3989d62a1fba829e0380c6fbf36caf5 (diff)
removed unecessary files from git
Diffstat (limited to 'plugins/org.apache.cordova.statusbar/doc/index.md')
-rw-r--r--plugins/org.apache.cordova.statusbar/doc/index.md284
1 files changed, 0 insertions, 284 deletions
diff --git a/plugins/org.apache.cordova.statusbar/doc/index.md b/plugins/org.apache.cordova.statusbar/doc/index.md
deleted file mode 100644
index 9955857a..00000000
--- a/plugins/org.apache.cordova.statusbar/doc/index.md
+++ /dev/null
@@ -1,284 +0,0 @@
-<!---
- Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
--->
-# org.apache.cordova.statusbar
-
-StatusBar
-======
-
-> The `StatusBar` object provides some functions to customize the iOS and Android StatusBar.
-
-
-## Installation
-
- cordova plugin add org.apache.cordova.statusbar
-
-Preferences
------------
-
-#### config.xml
-
-- __StatusBarOverlaysWebView__ (boolean, defaults to true). On iOS 7, make the statusbar overlay or not overlay the WebView at startup.
-
- <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) at startup.
-
- <preference name="StatusBarBackgroundColor" value="#000000" />
-
-- __StatusBarStyle__ (status bar style, defaults to lightcontent). On iOS 7, set the status bar style. Available options default, lightcontent, blacktranslucent, blackopaque.
-
- <preference name="StatusBarStyle" value="lightcontent" />
-
-Hiding at startup
------------
-
-During runtime you can use the StatusBar.hide function below, but if you want the StatusBar to be hidden at app startup, you must modify your app's Info.plist file.
-
-Add/edit these two attributes if not present. Set **"Status bar is initially hidden"** to **"YES"** and set **"View controller-based status bar appearance"** to **"NO"**. If you edit it manually without Xcode, the keys and values are:
-
-
- <key>UIStatusBarHidden</key>
- <true/>
- <key>UIViewControllerBasedStatusBarAppearance</key>
- <false/>
-
-
-Methods
--------
-This plugin defines global `StatusBar` object.
-
-Although in the global scope, it is not available until after the `deviceready` event.
-
- document.addEventListener("deviceready", onDeviceReady, false);
- function onDeviceReady() {
- console.log(StatusBar);
- }
-
-- 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
--------------------
-
-- 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
-- Windows Phone 7
-- Windows Phone 8
-- Windows Phone 8.1
-
-StatusBar.styleLightContent
-=================
-
-Use the lightContent statusbar (light text, for dark backgrounds).
-
- StatusBar.styleLightContent();
-
-
-Supported Platforms
--------------------
-
-- iOS
-- Windows Phone 7
-- Windows Phone 8
-- Windows Phone 8.1
-
-StatusBar.styleBlackTranslucent
-=================
-
-Use the blackTranslucent statusbar (light text, for dark backgrounds).
-
- StatusBar.styleBlackTranslucent();
-
-
-Supported Platforms
--------------------
-
-- iOS
-- Windows Phone 7
-- Windows Phone 8
-- Windows Phone 8.1
-
-StatusBar.styleBlackOpaque
-=================
-
-Use the blackOpaque statusbar (light text, for dark backgrounds).
-
- StatusBar.styleBlackOpaque();
-
-
-Supported Platforms
--------------------
-
-- iOS
-- Windows Phone 7
-- Windows Phone 8
-- Windows Phone 8.1
-
-
-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
-
-
-Supported Platforms
--------------------
-
-- iOS
-- Windows Phone 7
-- Windows Phone 8
-- Windows Phone 8.1
-
-StatusBar.backgroundColorByHexString
-=================
-
-Sets the background color of the statusbar by a hex string.
-
- StatusBar.backgroundColorByHexString("#C0C0C0");
-
-CSS shorthand properties are also supported.
-
- StatusBar.backgroundColorByHexString("#333"); // => #333333
- StatusBar.backgroundColorByHexString("#FAB"); // => #FFAABB
-
-On iOS 7, when you set StatusBar.statusBarOverlaysWebView to false, you can set the background color of the statusbar by a hex string (#RRGGBB).
-
-On WP7 and WP8 you can also specify values as #AARRGGBB, where AA is an alpha value
-
-Supported Platforms
--------------------
-
-- iOS
-- Windows Phone 7
-- Windows Phone 8
-- Windows Phone 8.1
-
-StatusBar.hide
-=================
-
-Hide the statusbar.
-
- StatusBar.hide();
-
-
-Supported Platforms
--------------------
-
-- iOS
-- Android
-- Windows Phone 7
-- Windows Phone 8
-- Windows Phone 8.1
-
-StatusBar.show
-=================
-
-Shows the statusbar.
-
- StatusBar.show();
-
-
-Supported Platforms
--------------------
-
-- iOS
-- Android
-- Windows Phone 7
-- Windows Phone 8
-- Windows Phone 8.1
-
-
-StatusBar.isVisible
-=================
-
-Read this property to see if the statusbar is visible or not.
-
- if (StatusBar.isVisible) {
- // do something
- }
-
-
-Supported Platforms
--------------------
-
-- iOS
-- Android
-- Windows Phone 7
-- Windows Phone 8
-- Windows Phone 8.1
-
-