You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by st...@apache.org on 2013/12/05 02:00:16 UTC
[4/7] git commit: CB-5124 - Remove splashscreen config.xml values
from iOS Configuration Docs, move to plugin docs
CB-5124 - Remove splashscreen config.xml values from iOS Configuration Docs, move to plugin docs
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/c9ff4b42
Tree: http://git-wip-us.apache.org/repos/asf/cordova-plugin-splashscreen/tree/c9ff4b42
Diff: http://git-wip-us.apache.org/repos/asf/cordova-plugin-splashscreen/diff/c9ff4b42
Branch: refs/heads/master
Commit: c9ff4b428b4954751c89a464c6549d63cbef42b7
Parents: 0249265
Author: Shazron Abdullah <sh...@apache.org>
Authored: Mon Nov 11 15:16:31 2013 -0800
Committer: Shazron Abdullah <sh...@apache.org>
Committed: Mon Nov 11 15:16:31 2013 -0800
----------------------------------------------------------------------
docs/config.md | 53 +++++++++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 53 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-plugin-splashscreen/blob/c9ff4b42/docs/config.md
----------------------------------------------------------------------
diff --git a/docs/config.md b/docs/config.md
new file mode 100644
index 0000000..7c95136
--- /dev/null
+++ b/docs/config.md
@@ -0,0 +1,53 @@
+---
+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.
+---
+
+# iOS Configuration
+
+The `config.xml` file controls an app's basic settings that apply
+across each application and CordovaWebView instance. This section
+details preferences that only apply to iOS builds. See The config.xml
+File for information on global configuration options.
+
+- `FadeSplashScreen` (boolean, defaults to `true`): Set to `false` to
+ prevent the splash screen from fading in and out when its display
+ state changes.
+
+ <preference name="FadeSplashScreen" value="false"/>
+
+- `FadeSplashScreenDuration` (float, defaults to `2`): Specifies the
+ number of seconds for the splash screen fade effect to execute.
+
+ <preference name="FadeSplashScreenDuration" value="4"/>
+
+- `ShowSplashScreenSpinner` (boolean, defaults to `true`): Set to `false`
+ to hide the splash-screen spinner.
+
+ <preference name="ShowSplashScreenSpinner" value="false"/>
+
+- `KeyboardDisplayRequiresUserAction` (boolean, defaults to `true`):
+ Set to `false` to allow the keyboard to appear when calling
+ `focus()` on form inputs.
+
+ <preference name="KeyboardDisplayRequiresUserAction" value="false"/>
+
+- `AutoHideSplashScreen` (boolean, defaults to `true`):
+ Set to `false` to control when the splashscreen is hidden through the plugin's JavaScript API.
+
+ <preference name="AutoHideSplashScreen" value="false"/>
+