cordova-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From shaz...@apache.org
Subject [22/40] git commit: Added Keyboard plugin docs.
Date Mon, 04 Nov 2013 22:05:36 GMT
Added Keyboard 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/254410f4
Tree: http://git-wip-us.apache.org/repos/asf/cordova-plugins/tree/254410f4
Diff: http://git-wip-us.apache.org/repos/asf/cordova-plugins/diff/254410f4

Branch: refs/heads/master
Commit: 254410f4aee29d3d1b53b6521fde1c763fdd4e1f
Parents: e30370e
Author: Shazron Abdullah <shazron@apache.org>
Authored: Mon Oct 7 15:54:02 2013 -0700
Committer: Shazron Abdullah <shazron@apache.org>
Committed: Mon Oct 7 15:54:02 2013 -0700

----------------------------------------------------------------------
 keyboard/README.md | 125 ++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 125 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/cordova-plugins/blob/254410f4/keyboard/README.md
----------------------------------------------------------------------
diff --git a/keyboard/README.md b/keyboard/README.md
new file mode 100644
index 0000000..61af1cd
--- /dev/null
+++ b/keyboard/README.md
@@ -0,0 +1,125 @@
+Keyboard
+======
+
+> The `Keyboard` object provides some functions to customize the iOS keyboard.
+
+This plugin only runs in Cordova 3.2 or greater. This plugin contains the keyboard customization
code present in the core in previous Cordova versions, and thus can't be used in those versions.

+
+This plugin supports the old __HideKeyboardFormAccessoryBar__ and __KeyboardShrinksView__
boolean preferences in config.xml as well.
+
+Methods
+-------
+
+- Keyboard.shrinkView
+- Keyboard.hideFormAccessoryBar
+- Keyboard.disableScrollingInShrinkView
+
+Properties
+--------
+
+- Keyboard.isVisible
+
+
+Permissions
+-----------
+
+#### config.xml
+
+            <feature name="Keyboard">
+                <param name="ios-package" value="CDVKeyboard" onload="true" />
+            </feature>
+
+Keyboard.shrinkView
+=================
+
+Shrink the WebView when the keyboard comes up.
+
+    Keyboard.shrinkView(true);
+
+Description
+-----------
+
+Set to true to shrink the WebView when the keyboard comes up. The WebView shrinks instead
of the viewport shrinking and the page scrollable. This applies to apps that position their
elements relative to the bottom of the WebView. This is the default behaviour on Android,
and makes a lot of sense when building apps as opposed to webpages.
+
+
+Supported Platforms
+-------------------
+
+- iOS
+
+Quick Example
+-------------
+
+    Keyboard.shrinkView(true);
+    Keyboard.shrinkView(false);
+
+Keyboard.hideFormAccessoryBar
+=================
+
+Hide the keyboard toolbar.
+
+    Keyboard.hideFormAccessoryBar(true);
+
+Description
+-----------
+
+Set to true to hide the additional toolbar that is on top of the keyboard. This toolbar features
the Prev, Next, and Done buttons.
+
+
+Supported Platforms
+-------------------
+
+- iOS
+
+Quick Example
+-------------
+
+    Keyboard.hideFormAccessoryBar(true);
+    Keyboard.hideFormAccessoryBar(false);
+
+
+Keyboard.disableScrollingInShrinkView
+=================
+
+Disable scrolling when the the WebView is shrunk.
+
+    Keyboard.disableScrollingInShrinkView(true);
+
+Description
+-----------
+
+Set to true to disable scrolling when the WebView is shrunk.
+
+
+Supported Platforms
+-------------------
+
+- iOS
+
+Quick Example
+-------------
+
+    Keyboard.disableScrollingInShrinkView(true);
+    Keyboard.disableScrollingInShrinkView(false);
+
+Keyboard.isVisible
+=================
+
+Determine if the keyboard is visible.
+
+    if (Keyboard.isVisible) {
+    	// do something
+    }
+
+Description
+-----------
+
+Read this property to determine if the keyboard is visible.
+
+
+Supported Platforms
+-------------------
+
+- iOS
+
+    
\ No newline at end of file


Mime
View raw message