From 1eac08c558277e7b5683d868fa2db3588d08087d Mon Sep 17 00:00:00 2001 From: daserge Date: Fri, 29 Apr 2016 17:23:19 +0300 Subject: [PATCH] CB-11179 Extend the windows-splashscreen docs Documented a way to disable splashscreen --- README.md | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) 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 ``` -- __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 @@ -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 + +``` + +**iOS Quirk**: to disable the splashscreen on `ios` platform you should also add `` 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 ``` - ## Methods - splashscreen.show