cordova-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From shaz...@apache.org
Subject [1/3] git commit: CB-6316 Moved StatusBar plugin documentation to docs folder
Date Thu, 20 Mar 2014 17:44:53 GMT
Repository: cordova-plugin-statusbar
Updated Branches:
  refs/heads/dev a6a4cf473 -> 6ada08af4


CB-6316 Moved StatusBar plugin documentation to docs folder


Project: http://git-wip-us.apache.org/repos/asf/cordova-plugin-statusbar/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-plugin-statusbar/commit/563c7197
Tree: http://git-wip-us.apache.org/repos/asf/cordova-plugin-statusbar/tree/563c7197
Diff: http://git-wip-us.apache.org/repos/asf/cordova-plugin-statusbar/diff/563c7197

Branch: refs/heads/dev
Commit: 563c71978a57e073bc857bb70d219a74540a9cc1
Parents: a6a4cf4
Author: Andrey Kurdyumov <kant2002@gmail.com>
Authored: Thu Mar 20 13:55:57 2014 +0600
Committer: Andrey Kurdyumov <kant2002@gmail.com>
Committed: Thu Mar 20 13:55:57 2014 +0600

----------------------------------------------------------------------
 README.md    | 214 ------------------------------------------------------
 doc/index.md | 214 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 214 insertions(+), 214 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/cordova-plugin-statusbar/blob/563c7197/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
deleted file mode 100644
index 30c16ac..0000000
--- a/README.md
+++ /dev/null
@@ -1,214 +0,0 @@
-StatusBar
-======
-
-> The `StatusBar` object provides some functions to customize the iOS and Android 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" />
-
-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
--------
-
-- 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
-
-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.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
-- Android
-
-StatusBar.show
-=================
-
-Shows the statusbar.
-
-    StatusBar.show();
-
-
-Supported Platforms
--------------------
-
-- iOS
-- Android
-
-
-StatusBar.isVisible
-=================
-
-Read this property to see if the statusbar is visible or not.
-
-    if (StatusBar.isVisible) {
-    	// do something
-    }
-
-
-Supported Platforms
--------------------
-
-- iOS
-- Android
-
-
-    
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/cordova-plugin-statusbar/blob/563c7197/doc/index.md
----------------------------------------------------------------------
diff --git a/doc/index.md b/doc/index.md
new file mode 100644
index 0000000..30c16ac
--- /dev/null
+++ b/doc/index.md
@@ -0,0 +1,214 @@
+StatusBar
+======
+
+> The `StatusBar` object provides some functions to customize the iOS and Android 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" />
+
+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
+-------
+
+- 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
+
+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.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
+- Android
+
+StatusBar.show
+=================
+
+Shows the statusbar.
+
+    StatusBar.show();
+
+
+Supported Platforms
+-------------------
+
+- iOS
+- Android
+
+
+StatusBar.isVisible
+=================
+
+Read this property to see if the statusbar is visible or not.
+
+    if (StatusBar.isVisible) {
+    	// do something
+    }
+
+
+Supported Platforms
+-------------------
+
+- iOS
+- Android
+
+
+    
\ No newline at end of file


Mime
View raw message