cordova-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From dase...@apache.org
Subject cordova-plugin-splashscreen git commit: CB-11179 Extend the windows-splashscreen docs
Date Thu, 12 May 2016 17:43:44 GMT
Repository: cordova-plugin-splashscreen
Updated Branches:
  refs/heads/master 80b01049c -> 1eac08c55


CB-11179 Extend the windows-splashscreen docs

Documented a way to disable splashscreen


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/1eac08c5
Tree: http://git-wip-us.apache.org/repos/asf/cordova-plugin-splashscreen/tree/1eac08c5
Diff: http://git-wip-us.apache.org/repos/asf/cordova-plugin-splashscreen/diff/1eac08c5

Branch: refs/heads/master
Commit: 1eac08c558277e7b5683d868fa2db3588d08087d
Parents: 80b0104
Author: daserge <v-seshak@microsoft.com>
Authored: Fri Apr 29 17:23:19 2016 +0300
Committer: daserge <v-seshak@microsoft.com>
Committed: Thu May 12 17:57:30 2016 +0300

----------------------------------------------------------------------
 README.md | 14 +++++++++++---
 1 file changed, 11 insertions(+), 3 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/cordova-plugin-splashscreen/blob/1eac08c5/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index fc1993a..be06b06 100644
--- a/README.md
+++ b/README.md
@@ -47,6 +47,8 @@ Report issues with this plugin on the [Apache Cordova issue tracker][Apache
Cord
 - Windows (`cordova-windows` version >= 4.4.0 is required)
 - Browser
 
+__Note__: Extended splashscreen does not require the plugin on Windows (as opposed to Android
and iOS) in case you don't use the plugin API, i.e. programmatic hide/show.
+
 ## Example Configuration
 In the top-level `config.xml` file (not the one in `platforms`), add configuration elements
like those specified here.
 
@@ -117,13 +119,13 @@ projectRoot
 
 #### config.xml
 
--  __AutoHideSplashScreen__ (boolean, default to `true`). Indicates whether to hide splash
screen automatically or not. Splash screen hidden after amount of time specified in the `SplashScreenDelay`
preference.
+- `AutoHideSplashScreen` (boolean, default to `true`). Indicates whether to hide splash screen
automatically or not. Splash screen hidden after amount of time specified in the `SplashScreenDelay`
preference.
 
 ```xml
     <preference name="AutoHideSplashScreen" value="true" />
 ```
 
--  __SplashScreenDelay__ (number, default to 3000). Amount of time in milliseconds to wait
before automatically hide splash screen.
+- `SplashScreenDelay` (number, default to 3000). Amount of time in milliseconds to wait before
automatically hide splash screen.
 
 ```xml
     <preference name="SplashScreenDelay" value="3000" />
@@ -131,6 +133,13 @@ projectRoot
 
 Note also that this value used to be seconds, and not milliseconds, so values less than 30
will still be treated as seconds. ( Consider this a deprecated patch that will disapear in
some future version. )
 
+To disable the splashscreen add the following preference to `config.xml`: 
+```xml
+<preference name="SplashScreenDelay" value="0"/>
+```
+
+**iOS Quirk**: to disable the splashscreen on `ios` platform you should also add `<preference
name="FadeSplashScreenDuration" value="0"/>` to `config.xml`.
+
 - `FadeSplashScreen` (boolean, defaults to `true`): Set to `false` to
   prevent the splash screen from fading in and out when its display
   state changes.
@@ -222,7 +231,6 @@ __Note__: `SplashScreen` value should be absolute in order to work in
a sub-page
 <preference name="SplashScreenBackgroundColor" value="0xFFFFFFFF"/>
 ```
 
-
 ## Methods
 
 - splashscreen.show


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cordova.apache.org
For additional commands, e-mail: commits-help@cordova.apache.org


Mime
View raw message