cordova-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From shaz...@apache.org
Subject [24/40] git commit: Add StatusBar plugin docs.
Date Mon, 04 Nov 2013 22:05:38 GMT
Add StatusBar plugin docs.


Project: http://git-wip-us.apache.org/repos/asf/cordova-plugins/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-plugins/commit/4a319778
Tree: http://git-wip-us.apache.org/repos/asf/cordova-plugins/tree/4a319778
Diff: http://git-wip-us.apache.org/repos/asf/cordova-plugins/diff/4a319778

Branch: refs/heads/master
Commit: 4a319778a603d050d2ba85c412a94fed703d1a1e
Parents: 02d77a0
Author: Shazron Abdullah <shazron@apache.org>
Authored: Mon Oct 7 16:30:33 2013 -0700
Committer: Shazron Abdullah <shazron@apache.org>
Committed: Mon Oct 7 16:30:33 2013 -0700

----------------------------------------------------------------------
 statusbar/README.md | 149 +++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 149 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/cordova-plugins/blob/4a319778/statusbar/README.md
----------------------------------------------------------------------
diff --git a/statusbar/README.md b/statusbar/README.md
new file mode 100644
index 0000000..508fd97
--- /dev/null
+++ b/statusbar/README.md
@@ -0,0 +1,149 @@
+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.
+
+For iOS 7, to use the statusbar style functions, you need the addition of a key in your Info.plist.
See the Permissions section below.
+ 
+Methods
+-------
+
+- StatusBar.statusBarOverlaysWebView
+- StatusBar.styleDefault
+- StatusBar.styleLightContent
+- StatusBar.styleBlackTranslucent
+- StatusBar.styleBlackOpaque
+- StatusBar.statusBarBackgroundColorByName
+- StatusBar.statusBarBackgroundColorByHexString
+
+Properties
+--------
+
+- StatusBar.isVisible (TODO: not implemented yet)
+
+Permissions
+-----------
+
+#### config.xml
+
+            <feature name="StatusBar">
+                <param name="ios-package" value="CDVStatusBar" onload="true" />
+            </feature>
+
+#### [ProjectName]-Info.plist
+
+            <key>UIViewControllerBasedStatusBarAppearance</key>
+            <false/>
+
+StatusBar.statusBarOverlaysWebView
+=================
+
+On iOS 7, make the statusbar overlay or not overlay the WebView.
+
+    StatusBar.statusBarOverlaysWebView(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.statusBarOverlaysWebView(true);
+    StatusBar.statusBarOverlaysWebView(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.styleBlackTranslucent
+=================
+
+Use the blackTranslucent statusbar (light text, for dark backgrounds).
+
+    StatusBar.styleBlackTranslucent();
+
+
+Supported Platforms
+-------------------
+
+- iOS
+
+StatusBar.styleBlackOpaque
+=================
+
+Use the blackOpaque statusbar (light text, for dark backgrounds).
+
+    StatusBar.styleBlackOpaque();
+
+
+Supported Platforms
+-------------------
+
+- iOS
+
+
+StatusBar.statusBarBackgroundColorByName
+=================
+
+On iOS 7, when you set StatusBar.statusBarOverlaysWebView to false, you can set the background
color of the statusbar by color name.
+
+    StatusBar.statusBarBackgroundColorByName("red");
+
+Supported color names are:
+
+    black, darkGray, lightGray, white, gray, red, green, blue, cyan, yellow, magenta, orange,
purple, brown, clear
+
+
+Supported Platforms
+-------------------
+
+- iOS
+
+StatusBar.statusBarBackgroundColorByHexString
+=================
+
+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.statusBarBackgroundColorByHexString("#C0C0C0");
+
+
+Supported Platforms
+-------------------
+
+- iOS
+
+
+
+    
\ No newline at end of file


Mime
View raw message