cordova-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From agri...@apache.org
Subject git commit: CB-5658 Add doc.index.md for Splashscreen plugin
Date Thu, 19 Dec 2013 01:59:40 GMT
Updated Branches:
  refs/heads/dev c2d22c067 -> a5d40d0a9


CB-5658 Add doc.index.md for Splashscreen plugin


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

Branch: refs/heads/dev
Commit: a5d40d0a95deb32a6595190e80873a7a14c5a111
Parents: c2d22c0
Author: Andrew Grieve <agrieve@chromium.org>
Authored: Wed Dec 18 20:59:29 2013 -0500
Committer: Andrew Grieve <agrieve@chromium.org>
Committed: Wed Dec 18 20:59:29 2013 -0500

----------------------------------------------------------------------
 README.md    | 40 ++++++++++++-----------
 doc/index.md | 94 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 116 insertions(+), 18 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/cordova-plugin-splashscreen/blob/a5d40d0a/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index 20f1a01..7ad2401 100644
--- a/README.md
+++ b/README.md
@@ -1,18 +1,22 @@
-cordova-plugin-splashscreen
-----------------------------
-
-For Android,
-
-In your config.xml, you need to add the following preference
-
-`<preference name="splashscreen" value="foo" />`
-
-Where foo is the name of the splashscreen file. Preferably a 9 patch file. Make sure to add
your splashcreen files to your res/xml directory under the appropriate folders.
-
-For Android, you also have to edit your projects main java file. You must add a second parameter
representing a time delay to your super.loadUrl. 
-
-`super.loadUrl(Config.getStartUrl(), 10000);`
-
-To install this plugin, follow the [Command-line Interface Guide](http://cordova.apache.org/docs/en/edge/guide_cli_index.md.html#The%20Command-line%20Interface).
-
-If you are not using the Cordova Command-line Interface, follow [Using Plugman to Manage
Plugins](http://cordova.apache.org/docs/en/edge/plugin_ref_plugman.md.html).
+<!---
+ license: 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.splashscreen
+
+Plugin documentation: [doc/index.md](doc/index.md)

http://git-wip-us.apache.org/repos/asf/cordova-plugin-splashscreen/blob/a5d40d0a/doc/index.md
----------------------------------------------------------------------
diff --git a/doc/index.md b/doc/index.md
new file mode 100644
index 0000000..5b15c61
--- /dev/null
+++ b/doc/index.md
@@ -0,0 +1,94 @@
+<!---
+ license: 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.splashscreen
+
+This plugin displays and hides a splash screen during application launch.
+
+## Installation
+
+    cordova plugin add org.apache.cordova.splashscreen
+
+
+## Supported Platforms
+
+- Amazon Fire OS
+- Android
+- BlackBerry 10
+- iOS
+- Windows Phone 7 and 8
+- Windows 8
+
+
+## Methods
+
+- splashscreen.show
+- splashscreen.hide
+
+### Android Quirks
+
+In your config.xml, you need to add the following preference
+
+`<preference name="splashscreen" value="foo" />`
+
+Where foo is the name of the splashscreen file. Preferably a 9 patch file. Make sure to add
your splashcreen files to your res/xml directory under the appropriate folders.
+
+For Android, you also have to edit your projects main java file. You must add a second parameter
representing a time delay to your super.loadUrl.
+
+`super.loadUrl(Config.getStartUrl(), 10000);`
+
+## splashscreen.hide
+
+Dismiss the splash screen.
+
+    navigator.splashscreen.hide();
+
+
+### BlackBerry 10 Quirk
+
+The `config.xml` file's `AutoHideSplashScreen` setting must be `false`.
+
+### iOS Quirk
+
+The `config.xml` file's `AutoHideSplashScreen` setting must be
+`false`. To delay hiding the splash screen for two seconds, add a
+timer such as the following in the `deviceready` event handler:
+
+        setTimeout(function() {
+            navigator.splashscreen.hide();
+        }, 2000);
+
+## splashscreen.show
+
+Displays the splash screen.
+
+    navigator.splashscreen.show();
+
+
+Your application cannot call `navigator.splashscreen.show()` until the app has
+started and the `deviceready` event has fired. But since typically the splash
+screen is meant to be visible before your app has started, that would seem to
+defeat the purpose of the splash screen.  Providing some configuration in
+`config.xml` will automatically `show` the splash screen immediately after your
+app launch and before it has fully started and received the `deviceready`
+event. See [Icons and Splash Screens](http://cordova.apache.org/docs/en/edge/config_ref_images.md.html)
+for more information on doing this configuration. For this reason, it is
+unlikely you need to call `navigator.splashscreen.show()` to make the splash
+screen visible for app startup.
+


Mime
View raw message