CB-11832 Updated version and RELEASENOTES.md for release 4.0.0

CB-11795 Add 'protective' entry to cordovaDependencies
The entry is required to protect end-users from fetching edge versions of the plugin by incompatible version of cordova. This also assumes that we will not introduce any regressions in compatibility w/ cordova in minor and patch releases. On every major release we will need to add similar entry with _next_ major version. This closes #113
2026-02-16 00:00:04 +08:00 · 2016-09-08 23:38:55 -07:00 · 2016-09-08 12:01:36 +03:00 · 2016-08-26 20:48:18 +02:00 · 2016-07-21 23:08:02 +03:00 · 2016-07-21 21:39:41 +02:00
13 changed files with 311 additions and 158 deletions
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,23 @@
+<!--
+Please make sure the checklist boxes are all checked before submitting the PR. The checklist
+is intended as a quick reference, for complete details please see our Contributor Guidelines:
+
+http://cordova.apache.org/contribute/contribute_guidelines.html
+
+Thanks!
+-->
+
+### Platforms affected
+
+
+### What does this PR do?
+
+
+### What testing has been done on this change?
+
+
+### Checklist
+- [ ] [ICLA](http://www.apache.org/licenses/icla.txt) has been signed and submitted to secretary@apache.org.
+- [ ] [Reported an issue](http://cordova.apache.org/contribute/issues.html) in the JIRA database
+- [ ] Commit message follows the format: "CB-3232: (android) Fix bug with resolving file paths", where CB-xxxx is the JIRA ID & "android" is the platform affected.
+- [ ] Added automated test coverage as appropriate for this change.
--- a/.jshintignore
+++ b/.jshintignore
@@ -0,0 +1 @@
+tests/ios
--- a/.travis.yml
+++ b/.travis.yml
@@ -1,4 +1,9 @@
-language: node_js
+language: objective-c
+osx_image: xcode7
 sudo: false
 node_js:
  - "4.2"
+env:
+  - TEST_DIR=.
+  - TEST_DIR=./tests/ios
+script: cd $TEST_DIR && npm install && (npm test || npm test)
--- a/README.md
+++ b/README.md
@@ -1,3 +1,7 @@
+---
+title: Splashscreen
+description: Control the splash screen for your app.
+---
 <!--
 # license: Licensed to the Apache Software Foundation (ASF) under one
 #         or more contributor license agreements.  See the NOTICE file
@@ -17,11 +21,13 @@
 #         under the License.
 -->

-[![Build Status](https://travis-ci.org/apache/cordova-plugin-splashscreen.svg?branch=master)](https://travis-ci.org/apache/cordova-plugin-splashscreen)
+|Android|iOS| Windows 8.1 Store | Windows 8.1 Phone | Windows 10 Store | Travis CI |
+|:-:|:-:|:-:|:-:|:-:|:-:|
+|[![Build Status](http://cordova-ci.cloudapp.net:8080/buildStatus/icon?job=cordova-periodic-build/PLATFORM=android,PLUGIN=cordova-plugin-splashscreen)](http://cordova-ci.cloudapp.net:8080/job/cordova-periodic-build/PLATFORM=android,PLUGIN=cordova-plugin-splashscreen/)|[![Build Status](http://cordova-ci.cloudapp.net:8080/buildStatus/icon?job=cordova-periodic-build/PLATFORM=ios,PLUGIN=cordova-plugin-splashscreen)](http://cordova-ci.cloudapp.net:8080/job/cordova-periodic-build/PLATFORM=ios,PLUGIN=cordova-plugin-splashscreen/)|[![Build Status](http://cordova-ci.cloudapp.net:8080/buildStatus/icon?job=cordova-periodic-build/PLATFORM=windows-8.1-store,PLUGIN=cordova-plugin-splashscreen)](http://cordova-ci.cloudapp.net:8080/job/cordova-periodic-build/PLATFORM=windows-8.1-store,PLUGIN=cordova-plugin-splashscreen/)|[![Build Status](http://cordova-ci.cloudapp.net:8080/buildStatus/icon?job=cordova-periodic-build/PLATFORM=windows-8.1-phone,PLUGIN=cordova-plugin-splashscreen)](http://cordova-ci.cloudapp.net:8080/job/cordova-periodic-build/PLATFORM=windows-8.1-phone,PLUGIN=cordova-plugin-splashscreen/)|[![Build Status](http://cordova-ci.cloudapp.net:8080/buildStatus/icon?job=cordova-periodic-build/PLATFORM=windows-10-store,PLUGIN=cordova-plugin-splashscreen)](http://cordova-ci.cloudapp.net:8080/job/cordova-periodic-build/PLATFORM=windows-10-store,PLUGIN=cordova-plugin-splashscreen/)|[![Build Status](https://travis-ci.org/apache/cordova-plugin-splashscreen.svg?branch=master)](https://travis-ci.org/apache/cordova-plugin-splashscreen)|

 # cordova-plugin-splashscreen

-This plugin displays and hides a splash screen during application launch.
+This plugin is required to work with splash screens. This plugin displays and hides a splash screen during application launch.

 Report issues with this plugin on the [Apache Cordova issue tracker][Apache Cordova issue tracker].

@@ -40,74 +46,116 @@ Report issues with this plugin on the [Apache Cordova issue tracker][Apache Cord
 - BlackBerry 10
 - iOS
 - Windows Phone 7 and 8
- Windows 8
- Windows
+- 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.
+
+Please notice that the value of the "src" attribute is relative to the project root directory and not to the www directory (see `Directory structure` below). You can name the source image whatever you like. The internal name in the app is determined by Cordova.
+
+Directory structure:
+
+```
+projectRoot
+    hooks
+    platforms
+    plugins
+    www
+        css
+        img
+        js
+    res
+        screen
+            android
+            ios
+            windows
+```
+
+```xml
+<platform name="android">
+    <!-- you can use any density that exists in the Android project -->
+    <splash src="res/screen/android/splash-land-hdpi.png" density="land-hdpi"/>
+    <splash src="res/screen/android/splash-land-ldpi.png" density="land-ldpi"/>
+    <splash src="res/screen/android/splash-land-mdpi.png" density="land-mdpi"/>
+    <splash src="res/screen/android/splash-land-xhdpi.png" density="land-xhdpi"/>
+
+    <splash src="res/screen/android/splash-port-hdpi.png" density="port-hdpi"/>
+    <splash src="res/screen/android/splash-port-ldpi.png" density="port-ldpi"/>
+    <splash src="res/screen/android/splash-port-mdpi.png" density="port-mdpi"/>
+    <splash src="res/screen/android/splash-port-xhdpi.png" density="port-xhdpi"/>
+</platform>
+
+<platform name="ios">
+    <!-- images are determined by width and height. The following are supported -->
+    <splash src="res/screen/ios/Default~iphone.png" width="320" height="480"/>
+    <splash src="res/screen/ios/Default@2x~iphone.png" width="640" height="960"/>
+    <splash src="res/screen/ios/Default-Portrait~ipad.png" width="768" height="1024"/>
+    <splash src="res/screen/ios/Default-Portrait@2x~ipad.png" width="1536" height="2048"/>
+    <splash src="res/screen/ios/Default-Landscape~ipad.png" width="1024" height="768"/>
+    <splash src="res/screen/ios/Default-Landscape@2x~ipad.png" width="2048" height="1536"/>
+    <splash src="res/screen/ios/Default-568h@2x~iphone.png" width="640" height="1136"/>
+    <splash src="res/screen/ios/Default-667h.png" width="750" height="1334"/>
+    <splash src="res/screen/ios/Default-736h.png" width="1242" height="2208"/>
+    <splash src="res/screen/ios/Default-Landscape-736h.png" width="2208" height="1242"/>
+</platform>
+
+<platform name="windows">
+    <!-- images are determined by width and height. The following are supported -->
+    <splash src="res/screen/windows/splashscreen.png" width="620" height="300"/>
+    <splash src="res/screen/windows/splashscreenphone.png" width="1152" height="1920"/>
+</platform>
+
+<platform name="blackberry10">
+    <!-- Add a rim:splash element for each resolution and locale you wish -->
+    <!-- http://developer.blackberry.com/html5/documentation/rim_splash_element.html -->
+    <rim:splash src="res/screen/blackberry/splashscreen.png"/>
+</platform>
+
+<preference name="SplashScreenDelay" value="10000" />
+```
+
 ## Preferences

 #### config.xml

-  __SplashScreen__ (string). The resource name which is used for the displaying splash screen. Different platforms use values for this.
+- `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.

-        <preference name="SplashScreen" value="resourcename" />
+```xml
+    <preference name="AutoHideSplashScreen" value="true" />
+```

-  __AutoHideSplashScreen__ (boolean, default to `true`). Indicates wherether hide splash screen automatically or not. Splash screen hidden after amount of time specified in the `SplashScreenDelay` preference.
+- `SplashScreenDelay` (number, default to 3000). Amount of time in milliseconds to wait before automatically hide splash screen.

-        <preference name="AutoHideSplashScreen" value="true" />
-
-  __SplashScreenDelay__ (number, default to 3000). Amount of time in milliseconds to wait before automatically hide splash screen.
-
-        <preference name="SplashScreenDelay" value="3000" />
-
-
-### Android Quirks
-
-In your `config.xml`, you need to add the following preferences:
-
-    <preference name="SplashScreen" value="foo" />
+```xml
    <preference name="SplashScreenDelay" value="3000" />
-    <preference name="SplashMaintainAspectRatio" value="true|false" />
-    <preference name="SplashShowOnlyFirstTime" value="true|false" />
+```

-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. The second parameter represents how long the splashscreen will appear in milliseconds. It defaults to 3000 ms. See [Icons and Splash Screens](http://cordova.apache.org/docs/en/edge/config_ref_images.md.html)
-for more information.
+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. )

-"SplashMaintainAspectRatio" preference is optional. If set to true, splash screen drawable is not stretched to fit screen, but instead simply "covers" the screen, like CSS "background-size:cover". This is very useful when splash screen images cannot be distorted in any way, for example when they contain scenery or text. This setting works best with images that have large margins (safe areas) that can be safely cropped on screens with different aspect ratios.
+To disable the splashscreen add the following preference to `config.xml`:
+```xml
+<preference name="SplashScreenDelay" value="0"/>
+```

-The plugin reloads splash drawable whenever orientation changes, so you can specify different drawables for portrait and landscape orientations.
-
-"SplashShowOnlyFirstTime" preference is also optional and defaults to `true`. When set to `true` splash screen will only appear on application launch. However, if you plan to use `navigator.app.exitApp()` to close application and force splash screen appear on next launch, you should set this property to `false` (this also applies to closing the App with Back button).
-
-### Browser Quirks
-
-You can use the following preferences in your `config.xml`:
-
-    <platform name="browser">
-        <preference name="SplashScreen" value="/images/browser/splashscreen.jpg" /> <!-- defaults to "/img/logo.png" -->
-        <preference name="SplashScreenDelay" value="3000" /> <!-- defaults to "3000" -->
-        <preference name="SplashScreenBackgroundColor" value="green" /> <!-- defaults to "#464646" -->
-        <preference name="ShowSplashScreen" value="false" /> <!-- defaults to "true" -->
-        <preference name="SplashScreenWidth" value="600" /> <!-- defaults to "170" -->
-        <preference name="SplashScreenHeight" value="300" /> <!-- defaults to "200" -->
-    </platform>
-
-__Note__: `SplashScreen` value should be absolute in order to work in a sub-page.
-
-### Android and iOS Quirks
+**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.

-        <preference name="FadeSplashScreen" value="false"/>
+```xml
+    <preference name="FadeSplashScreen" value="false"/>
+```

- `FadeSplashScreenDuration` (float, defaults to `3000`): Specifies the
+- `FadeSplashScreenDuration` (float, defaults to `500`): Specifies the
  number of milliseconds for the splash screen fade effect to execute.

-        <preference name="FadeSplashScreenDuration" value="3000"/>
-
-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. )
+```xml
+    <preference name="FadeSplashScreenDuration" value="750"/>
+```

 _Note_: `FadeSplashScreenDuration` is included into `SplashScreenDelay`, for example if you have `<preference name="SplashScreenDelay" value="3000" />` and `<preference name="FadeSplashScreenDuration" value="1000"/>` defined in `config.xml`:

@@ -129,7 +177,61 @@ window.setTimeout(function () {
 - `ShowSplashScreenSpinner` (boolean, defaults to `true`): Set to `false`
  to hide the splash-screen spinner.

-        <preference name="ShowSplashScreenSpinner" value="false"/>
+```xml
+    <preference name="ShowSplashScreenSpinner" value="false"/>
+```
+
+### Android Quirks
+
+In your `config.xml`, you can add the following preferences:
+
+```xml
+<preference name="SplashMaintainAspectRatio" value="true|false" />
+<preference name="SplashShowOnlyFirstTime" value="true|false" />
+```
+
+"SplashMaintainAspectRatio" preference is optional. If set to true, splash screen drawable is not stretched to fit screen, but instead simply "covers" the screen, like CSS "background-size:cover". This is very useful when splash screen images cannot be distorted in any way, for example when they contain scenery or text. This setting works best with images that have large margins (safe areas) that can be safely cropped on screens with different aspect ratios.
+
+The plugin reloads splash drawable whenever orientation changes, so you can specify different drawables for portrait and landscape orientations.
+
+"SplashShowOnlyFirstTime" preference is also optional and defaults to `true`. When set to `true` splash screen will only appear on application launch. However, if you plan to use `navigator.app.exitApp()` to close application and force splash screen appear on next launch, you should set this property to `false` (this also applies to closing the App with Back button).
+
+### Browser Quirks
+
+You can use the following preferences in your `config.xml`:
+
+```xml
+<platform name="browser">
+    <preference name="SplashScreen" value="/images/browser/splashscreen.jpg" /> <!-- defaults to "/img/logo.png" -->
+    <preference name="SplashScreenDelay" value="3000" /> <!-- defaults to "3000" -->
+    <preference name="SplashScreenBackgroundColor" value="green" /> <!-- defaults to "#464646" -->
+    <preference name="ShowSplashScreen" value="false" /> <!-- defaults to "true" -->
+    <preference name="SplashScreenWidth" value="600" /> <!-- defaults to "170" -->
+    <preference name="SplashScreenHeight" value="300" /> <!-- defaults to "200" -->
+</platform>
+```
+
+__Note__: `SplashScreen` value should be absolute in order to work in a sub-page. The `SplashScreen` value is used only for the browser platform. The value will be ignored for other platforms.
+
+### iOS Quirks
+
+- In iOS, the splashscreen images are called launch images. These images are mandatory on iOS.
+
+### Windows Quirks
+
+- `SplashScreenSpinnerColor` (string, defaults to system accent color): hash, rgb notation or CSS color name.
+
+```xml
+<preference name="SplashScreenSpinnerColor" value="#242424"/>
+<preference name="SplashScreenSpinnerColor" value="DarkRed"/>
+<preference name="SplashScreenSpinnerColor" value="rgb(50,128,128)"/>
+```
+
+- `SplashScreenBackgroundColor` (string, defaults to #464646): hex notation.
+
+```xml
+<preference name="SplashScreenBackgroundColor" value="0xFFFFFFFF"/>
+```

 ## Methods

@@ -140,7 +242,9 @@ window.setTimeout(function () {

 Dismiss the splash screen.

-    navigator.splashscreen.hide();
+```js
+navigator.splashscreen.hide();
+```


 ### BlackBerry 10, WP8, iOS Quirk
@@ -149,16 +253,19 @@ 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);
+```js
+setTimeout(function() {
+    navigator.splashscreen.hide();
+}, 2000);
+```

 ## splashscreen.show

 Displays the splash screen.

-    navigator.splashscreen.show();
-
+```js
+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
@@ -166,9 +273,7 @@ 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
+event. For this reason, it is unlikely you need to call `navigator.splashscreen.show()` to make the splash
 screen visible for app startup.

 [Apache Cordova issue tracker]: https://issues.apache.org/jira/issues/?jql=project%20%3D%20CB%20AND%20status%20in%20%28Open%2C%20%22In%20Progress%22%2C%20Reopened%29%20AND%20resolution%20%3D%20Unresolved%20AND%20component%20%3D%20%22Plugin%20Splashscreen%22%20ORDER%20BY%20priority%20DESC%2C%20summary%20ASC%2C%20updatedDate%20DESC
--- a/RELEASENOTES.md
+++ b/RELEASENOTES.md
@@ -20,11 +20,32 @@
 -->
 # Release Notes

+### 4.0.0 (Sep 08, 2016)
+* [CB-11795](https://issues.apache.org/jira/browse/CB-11795) Add 'protective' entry to cordovaDependencies
+* [CB-11326](https://issues.apache.org/jira/browse/CB-11326) Prevent crash when initializing plugin after navigating to another URL
+* Fix crash on **iOS** when reloading page from remote **Safari**
+* Add badges for paramedic builds on Jenkins
+* Add pull request template.
+* [CB-11179](https://issues.apache.org/jira/browse/CB-11179) Extend the windows-splashscreen docs
+* [CB-11159](https://issues.apache.org/jira/browse/CB-11159) Fix flaky splashscreen native tests
+* [CB-11156](https://issues.apache.org/jira/browse/CB-11156) Change default `FadeSplashScreenDuration` value
+* [CB-8056](https://issues.apache.org/jira/browse/CB-8056) Updated the dependency version, added it to the docs
+* [CB-10996](https://issues.apache.org/jira/browse/CB-10996) Adding front matter to README.md
+* [CB-8056](https://issues.apache.org/jira/browse/CB-8056) Implement splashscreen for **Windows** platform
+* [CB-6498](https://issues.apache.org/jira/browse/CB-6498) Misleading documentation in **Android** Quirks
+
+### 3.2.2 (Apr 15, 2016)
+* [CB-10979](https://issues.apache.org/jira/browse/CB-10979) Fix splashscreen **iOS** native tests. Added `jshintignore` for tests/ios
+* [CB-10895](https://issues.apache.org/jira/browse/CB-10895) Transparent Splashscreen view sometimes remains
+* [CB-10562](https://issues.apache.org/jira/browse/CB-10562) `hide()` not working in latest splashscreen plug in 3.1.0 in **iOS**
+* [CB-10688](https://issues.apache.org/jira/browse/CB-10688) Plugin Splashscreen Readme must have examples.
+* [CB-10864](https://issues.apache.org/jira/browse/CB-10864) Run **iOS** native tests on Travis
+
 ### 3.2.1 (Mar 09, 2016)
-* CB-10764: Remove emoji in cordova-plugin-splashscreen
-* CB-10650 Non-index content.src causes Splashscreen to be not displayed on ** Browser **
-* CB-10636 Add JSHint for plugins
-* CB-10606 fix deprecation warning for interfaceOrientation on ** iOS **
+* [CB-10764](https://issues.apache.org/jira/browse/CB-10764) Remove emoji in cordova-plugin-splashscreen
+* [CB-10650](https://issues.apache.org/jira/browse/CB-10650) Non-index content.src causes Splashscreen to be not displayed on **Browser**
+* [CB-10636](https://issues.apache.org/jira/browse/CB-10636) Add JSHint for plugins
+* [CB-10606](https://issues.apache.org/jira/browse/CB-10606) fix deprecation warning for interfaceOrientation on **iOS**
 * chore: edit package.json license to match SPDX id

 ### 3.2.0 (Feb 09, 2016)
@@ -35,14 +56,14 @@
 * [CB-8396](https://issues.apache.org/jira/browse/CB-8396) Add AutoHideSplashScreen logic to Android's Splashscreen

 ### 3.1.0 (Jan 15, 2016)
-* CB-9538 Implementing `FadeSplashScreen` feature for **Android**
-* CB-9240 Cordova splash screen plugin **iPad** landscape mode issue
-* CB-10263 Fix splashscreen plugin filenames for Asset Catalog
-* CB-9374 **Android** add `SplashShowOnlyFirstTime` as preference
-* CB-10244 Don't rotate the **iPhone 6 Plus** splash
-* CB-9043 Fix the **ios** splashscreen being deformed on orientation change
-* CB-10079 Splashscreen plugin does not honor `SplashScreenDelay` on **iOS**
-* CB-10231 Fix `FadeSplashScreen` to default to true on **iOS**
+* [CB-9538](https://issues.apache.org/jira/browse/CB-9538) Implementing `FadeSplashScreen` feature for **Android**
+* [CB-9240](https://issues.apache.org/jira/browse/CB-9240) Cordova splash screen plugin **iPad** landscape mode issue
+* [CB-10263](https://issues.apache.org/jira/browse/CB-10263) Fix splashscreen plugin filenames for Asset Catalog
+* [CB-9374](https://issues.apache.org/jira/browse/CB-9374) **Android** add `SplashShowOnlyFirstTime` as preference
+* [CB-10244](https://issues.apache.org/jira/browse/CB-10244) Don't rotate the **iPhone 6 Plus** splash
+* [CB-9043](https://issues.apache.org/jira/browse/CB-9043) Fix the **ios** splashscreen being deformed on orientation change
+* [CB-10079](https://issues.apache.org/jira/browse/CB-10079) Splashscreen plugin does not honor `SplashScreenDelay` on **iOS**
+* [CB-10231](https://issues.apache.org/jira/browse/CB-10231) Fix `FadeSplashScreen` to default to true on **iOS**

 ### 3.0.0 (Nov 18, 2015)
 * [CB-10035](https://issues.apache.org/jira/browse/CB-10035) Updated `RELEASENOTES` to be newest to oldest
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
 {
  "name": "cordova-plugin-splashscreen",
-  "version": "3.2.1",
+  "version": "4.0.0",
  "description": "Cordova Splashscreen Plugin",
  "cordova": {
    "id": "cordova-plugin-splashscreen",
@@ -38,12 +38,20 @@
    "test": "npm run jshint",
    "jshint": "node node_modules/jshint/bin/jshint www && node node_modules/jshint/bin/jshint src && node node_modules/jshint/bin/jshint tests"
  },
-  "engines": [
-    {
-      "name": "cordova-android",
-      "version": ">=3.6.0"
+  "engines": {
+    "cordovaDependencies": {
+      "2.0.0": {
+        "cordova-android": ">=3.6.0"
+      },
+      "4.0.0": {
+        "cordova-android": ">=3.6.0",
+        "cordova-windows": ">=4.4.0"
+      },
+      "5.0.0": {
+        "cordova": ">100"
+      }
    }
-  ],
+  },
  "author": "Apache Software Foundation",
  "license": "Apache-2.0",
  "devDependencies": {
--- a/plugin.xml
+++ b/plugin.xml
@@ -20,7 +20,7 @@

 <plugin xmlns="http://apache.org/cordova/ns/plugins/1.0"
           id="cordova-plugin-splashscreen"
-      version="3.2.1">
+      version="4.0.0">
    <name>Splashscreen</name>
    <description>Cordova Splashscreen Plugin</description>
    <license>Apache 2.0</license>
@@ -30,6 +30,7 @@

    <engines>
        <engine name="cordova-android" version=">=3.6.0" /><!-- Requires CordovaPlugin.preferences -->
+        <engine name="cordova-windows" version=">=4.4.0" />
    </engines>

    <js-module src="www/splashscreen.js" name="SplashScreen">
--- a/src/android/SplashScreen.java
+++ b/src/android/SplashScreen.java
@@ -52,6 +52,7 @@ public class SplashScreen extends CordovaPlugin {
    // Enable functionality only if running on 4.x.x.
    private static final boolean HAS_BUILT_IN_SPLASH_SCREEN = Integer.valueOf(CordovaWebView.CORDOVA_VERSION.split("\\.")[0]) < 4;
    private static final int DEFAULT_SPLASHSCREEN_DURATION = 3000;
+    private static final int DEFAULT_FADE_DURATION = 500;
    private static Dialog splashDialog;
    private static ProgressDialog spinnerDialog;
    private static boolean firstShow = true;
@@ -82,7 +83,13 @@ public class SplashScreen extends CordovaPlugin {
            return;
        }
        // Make WebView invisible while loading URL
-        getView().setVisibility(View.INVISIBLE);
+        // CB-11326 Ensure we're calling this on UI thread
+        cordova.getActivity().runOnUiThread(new Runnable() {
+            @Override
+            public void run() {
+                getView().setVisibility(View.INVISIBLE);
+            }
+        });
        int drawableId = preferences.getInteger("SplashDrawableId", 0);
        if (drawableId == 0) {
            String splashResource = preferences.getString("SplashScreen", "screen");
@@ -117,7 +124,7 @@ public class SplashScreen extends CordovaPlugin {

    private int getFadeDuration () {
        int fadeSplashScreenDuration = preferences.getBoolean("FadeSplashScreen", true) ?
-            preferences.getInteger("FadeSplashScreenDuration", DEFAULT_SPLASHSCREEN_DURATION) : 0;
+            preferences.getInteger("FadeSplashScreenDuration", DEFAULT_FADE_DURATION) : 0;

        if (fadeSplashScreenDuration < 30) {
            // [CB-9750] This value used to be in decimal seconds, so we will assume that if someone specifies 10
--- a/src/ios/CDVSplashScreen.h
+++ b/src/ios/CDVSplashScreen.h
@@ -36,6 +36,7 @@ typedef struct {
    UIImageView* _imageView;
    NSString* _curImageName;
    BOOL _visible;
+    BOOL _destroyed;
 }

 - (void)show:(CDVInvokedUrlCommand*)command;
--- a/src/ios/CDVSplashScreen.m
+++ b/src/ios/CDVSplashScreen.m
@@ -23,6 +23,7 @@
 #import "CDVViewController+SplashScreen.h"

 #define kSplashScreenDurationDefault 3000.0f
+#define kFadeDurationDefault 500.0f


@implementation CDVSplashScreen
@@ -41,7 +42,7 @@

 - (void)hide:(CDVInvokedUrlCommand*)command
 {
-    [self setVisible:NO];
+    [self setVisible:NO andForce:YES];
 }

 - (void)pageDidLoad
@@ -76,7 +77,7 @@
    BOOL autorotateValue = (device.iPad || device.iPhone6Plus) ?
        [(CDVViewController *)self.viewController shouldAutorotateDefaultValue] :
        NO;
-    
+
    [(CDVViewController *)self.viewController setEnabledAutorotation:autorotateValue];

    NSString* topActivityIndicator = [self.commandDelegate.settings objectForKey:[@"TopActivityIndicator" lowercaseString]];
@@ -120,6 +121,7 @@
    [parentView addObserver:self forKeyPath:@"bounds" options:0 context:nil];

    [self updateImage];
+    _destroyed = NO;
 }

 - (void)hideViews
@@ -130,6 +132,7 @@

 - (void)destroyViews
 {
+    _destroyed = YES;
    [(CDVViewController *)self.viewController setEnabledAutorotation:[(CDVViewController *)self.viewController shouldAutorotateDefaultValue]];

    [_imageView removeFromSuperview];
@@ -139,20 +142,28 @@
    _curImageName = nil;

    self.viewController.view.userInteractionEnabled = YES;  // re-enable user interaction upon completion
-    [self.viewController.view removeObserver:self forKeyPath:@"frame"];
-    [self.viewController.view removeObserver:self forKeyPath:@"bounds"];
+    @try {
+        [self.viewController.view removeObserver:self forKeyPath:@"frame"];
+        [self.viewController.view removeObserver:self forKeyPath:@"bounds"];
+    }
+    @catch (NSException *exception) {
+        // When reloading the page from a remotely connected Safari, there
+        // are no observers, so the removeObserver method throws an exception,
+        // that we can safely ignore.
+        // Alternatively we can check whether there are observers before calling removeObserver
+    }
 }

 - (CDV_iOSDevice) getCurrentDevice
 {
    CDV_iOSDevice device;
-    
+
    UIScreen* mainScreen = [UIScreen mainScreen];
    CGFloat mainScreenHeight = mainScreen.bounds.size.height;
    CGFloat mainScreenWidth = mainScreen.bounds.size.width;
-    
+
    int limit = MAX(mainScreenHeight,mainScreenWidth);
-    
+
    device.iPad = (UI_USER_INTERFACE_IDIOM() == UIUserInterfaceIdiomPad);
    device.iPhone = (UI_USER_INTERFACE_IDIOM() == UIUserInterfaceIdiomPhone);
    device.retina = ([mainScreen scale] == 2.0);
@@ -163,7 +174,7 @@
    // this is appropriate for detecting the runtime screen environment
    device.iPhone6 = (device.iPhone && limit == 667.0);
    device.iPhone6Plus = (device.iPhone && limit == 736.0);
-    
+
    return device;
 }

@@ -171,15 +182,15 @@
 {
    // Use UILaunchImageFile if specified in plist.  Otherwise, use Default.
    NSString* imageName = [[NSBundle mainBundle] objectForInfoDictionaryKey:@"UILaunchImageFile"];
-    
+
    NSUInteger supportedOrientations = [orientationDelegate supportedInterfaceOrientations];
-    
+
    // Checks to see if the developer has locked the orientation to use only one of Portrait or Landscape
    BOOL supportsLandscape = (supportedOrientations & UIInterfaceOrientationMaskLandscape);
    BOOL supportsPortrait = (supportedOrientations & UIInterfaceOrientationMaskPortrait || supportedOrientations & UIInterfaceOrientationMaskPortraitUpsideDown);
    // this means there are no mixed orientations in there
    BOOL isOrientationLocked = !(supportsPortrait && supportsLandscape);
-    
+
    if (imageName)
    {
        imageName = [imageName stringByDeletingPathExtension];
@@ -248,7 +259,7 @@
                case UIInterfaceOrientationLandscapeRight:
                    imageName = [imageName stringByAppendingString:@"-Landscape"];
                    break;
-                    
+
                case UIInterfaceOrientationPortrait:
                case UIInterfaceOrientationPortraitUpsideDown:
                default:
@@ -257,7 +268,7 @@
            }
        }
    }
-    
+
    return imageName;
 }

@@ -376,14 +387,19 @@

 - (void)setVisible:(BOOL)visible
 {
-    if (visible != _visible)
+    [self setVisible:visible andForce:NO];
+}
+
+- (void)setVisible:(BOOL)visible andForce:(BOOL)force
+{
+    if (visible != _visible || force)
    {
        _visible = visible;

        id fadeSplashScreenValue = [self.commandDelegate.settings objectForKey:[@"FadeSplashScreen" lowercaseString]];
        id fadeSplashScreenDuration = [self.commandDelegate.settings objectForKey:[@"FadeSplashScreenDuration" lowercaseString]];

-        float fadeDuration = fadeSplashScreenDuration == nil ? kSplashScreenDurationDefault : [fadeSplashScreenDuration floatValue];
+        float fadeDuration = fadeSplashScreenDuration == nil ? kFadeDurationDefault : [fadeSplashScreenDuration floatValue];

        id splashDurationString = [self.commandDelegate.settings objectForKey: [@"SplashScreenDelay" lowercaseString]];
        float splashDuration = splashDurationString == nil ? kSplashScreenDurationDefault : [splashDurationString floatValue];
@@ -433,26 +449,32 @@
            __weak __typeof(self) weakSelf = self;
            float effectiveSplashDuration;

-            if (!autoHideSplashScreen) {
+            // [CB-10562] AutoHideSplashScreen may be "true" but we should still be able to hide the splashscreen manually.
+            if (!autoHideSplashScreen || force) {
                effectiveSplashDuration = (fadeDuration) / 1000;
            } else {
                effectiveSplashDuration = (splashDuration - fadeDuration) / 1000;
            }

            dispatch_after(dispatch_time(DISPATCH_TIME_NOW, (uint64_t) effectiveSplashDuration * NSEC_PER_SEC), dispatch_get_main_queue(), CFBridgingRelease(CFBridgingRetain(^(void) {
-                   [UIView transitionWithView:self.viewController.view
-                                   duration:(fadeDuration / 1000)
-                                   options:UIViewAnimationOptionTransitionNone
-                                   animations:^(void) {
-                                       [weakSelf hideViews];
-                                   }
-                                   completion:^(BOOL finished) {
-                                       if (finished) {
-                                           [weakSelf destroyViews];
-                                           // TODO: It might also be nice to have a js event happen here -jm
-                                       }
-                                     }
+                if (!_destroyed) {
+                    [UIView transitionWithView:self.viewController.view
+                                    duration:(fadeDuration / 1000)
+                                    options:UIViewAnimationOptionTransitionNone
+                                    animations:^(void) {
+                                        [weakSelf hideViews];
+                                    }
+                                    completion:^(BOOL finished) {
+                                        // Always destroy views, otherwise you could have an
+                                        // invisible splashscreen that is overlayed over your active views
+                                        // which causes that no touch events are passed
+                                        if (!_destroyed) {
+                                            [weakSelf destroyViews];
+                                            // TODO: It might also be nice to have a js event happen here -jm
+                                        }
+                                    }
                    ];
+                }
            })));
        }
    }
--- a/tests/ios/package.json
+++ b/tests/ios/package.json
@@ -5,9 +5,9 @@
    "author": "Apache Software Foundation",
    "license": "Apache Version 2.0",
    "dependencies": {
-        "cordova-ios": "^3.6.0"
+        "cordova-ios": "*"
    },
    "scripts": {
-        "test": "xcodebuild test -workspace CDVSplashScreenTest.xcworkspace -scheme CDVSplashScreenLibTests -destination 'platform=iOS Simulator,name=iPhone 5' CONFIGURATION_BUILD_DIR='/tmp'"
-    }    
-}
+        "test": "xcodebuild test -workspace CDVSplashScreenTest.xcworkspace -scheme CDVSplashScreenLibTests -destination 'platform=iOS Simulator,name=iPhone 5' CONFIGURATION_BUILD_DIR='/tmp' HEADER_SEARCH_PATHS='$(OBJROOT)/UninstalledProducts/$(PLATFORM_NAME)/include'"
+    }
+}
--- a/tests/plugin.xml
+++ b/tests/plugin.xml
@@ -20,7 +20,7 @@

 <plugin xmlns="http://apache.org/cordova/ns/plugins/1.0"
    id="cordova-plugin-splashscreen-tests"
-    version="3.2.1">
+    version="4.0.0">
    <name>Cordova Splashscreen Plugin Tests</name>
    <license>Apache 2.0</license>

--- a/www/windows/SplashScreenProxy.js
+++ b/www/windows/SplashScreenProxy.js
@@ -20,56 +20,15 @@
 */

 /*jslint sloppy:true */
-/*global WinJS */

-var cordova = require('cordova');
-
-var isPhone = (cordova.platformId == "windows") && WinJS.Utilities.isPhone;
-var isHosted = window.location.protocol.indexOf('http') === 0;
-var localSplash = null, localSplashImage = null;
-var bgColor = "#464646"; // default backgrond color; TDOO - read it from .appxmanifest
-var splashImageSrc = (isHosted ? "ms-appx-web" : "ms-appx") + ":///images/" +
-    (isPhone ? "splashscreenphone.png" : "splashscreen.png");
+var splash = require('cordova/splashscreen');

 var SplashScreen = {
-    setBGColor: function (cssBGColor) {
-        bgColor = cssBGColor;
-        if (localSplash) {
-            localSplash.style.backgroundColor = bgColor;
-        }
-    },
    show: function () {
-        if (localSplash) {
-            return; // already showed
-        }
-
-        localSplash = document.createElement("div");
-        localSplash.style.backgroundColor = bgColor;
-        localSplash.style.position = "fixed";
-        localSplash.style.top = "0";
-        localSplash.style.width = "100%";
-        localSplash.style.height = "100%";
-
-        localSplashImage = document.createElement("img");
-        localSplashImage.src = splashImageSrc;
-        localSplashImage.style.maxWidth = "100%";
-        localSplashImage.style.maxHeight = "100%";
-        // center horizontally
-        localSplashImage.style.margin = "0 auto";
-        localSplashImage.style.display = "block";
-        // center vertically
-        localSplashImage.style.position = "relative";
-        localSplashImage.style.top = "50%";
-        localSplashImage.style.transform = "translateY(-50%)";
-
-        localSplash.appendChild(localSplashImage);
-        document.body.appendChild(localSplash);
+        splash.show();
    },
    hide: function () {
-        if (localSplash) {
-            document.body.removeChild(localSplash);
-            localSplash = null;
-        }
+        splash.hide();
    }
 };
Author	SHA1	Message	Date
Steve Gill	6e43615e25	CB-11832 Updated version and RELEASENOTES.md for release 4.0.0	2016-09-08 23:38:55 -07:00
Vladimir Kotikov	ac39b04b6f	CB-11795 Add 'protective' entry to cordovaDependencies The entry is required to protect end-users from fetching edge versions of the plugin by incompatible version of cordova. This also assumes that we will not introduce any regressions in compatibility w/ cordova in minor and patch releases. On every major release we will need to add similar entry with _next_ major version. This closes #113	2016-09-08 12:01:36 +03:00
Julio César	66f7ee34d1	Closing outdated pull request: close #106	2016-08-26 20:48:18 +02:00
Vladimir Kotikov	41ca5809b1	CB-11326 Prevent crash when initializing plugin after navigating to another URL	2016-07-21 23:08:02 +03:00
Franco Bugnano	0a8b5be3d1	Fix crash on iOS when reloading page from remote Safari This closes #110	2016-07-21 21:39:41 +02:00
Vladimir Kotikov	d65c0c7cc5	Add badges for paramedic builds on Jenkins	2016-06-10 12:12:56 +03:00
Nikhil Khandelwal	4102589bd5	Add pull request template.	2016-05-23 13:54:00 -07:00
daserge	1eac08c558	CB-11179 Extend the windows-splashscreen docs Documented a way to disable splashscreen	2016-05-12 17:57:30 +03:00
daserge	80b01049c8	CB-11159 Fix flaky splashscreen native tests Adds a retry as a temporary measure	2016-05-12 15:00:00 +03:00
daserge	4adff6f1c9	CB-11156 Change default FadeSplashScreenDuration value	2016-05-12 15:00:00 +03:00
daserge	3d924fce1b	CB-8056 Updated the dependency version, added it to the docs	2016-04-29 16:26:20 +03:00
Dmitry Blotsky	6a737203da	CB-10996 Adding front matter to README.md	2016-04-22 19:35:51 -07:00
daserge	acb45f3a38	CB-8056 Implement splashscreen for Windows platform The plugin implementation has been moved to the platform code Documented SplashScreenBackgroundColor preference for Windows Updated the docs Updated plugin dependencies - cordova-windows@5 is required Updated the plugin version to 4.0.0	2016-04-22 18:20:28 +03:00
daserge	8d66b9e353	CB-6498 Misleading documentation in Android Quirks	2016-04-19 15:03:04 +03:00
Steve Gill	edb6c3d6f8	CB-11091 Incremented plugin version.	2016-04-15 13:45:27 -07:00
Steve Gill	14061d1999	Updated version and RELEASENOTES.md for release 3.2.2	2016-04-15 13:08:27 -07:00
weexpectedTHIS	6863886d74	Fixed misspelling in the README Github: close #88	2016-03-31 16:09:59 +03:00
daserge	9832d2e165	CB-10979 Fix splashscreen ios native tests Added jshintignore for tests/ios	2016-03-30 10:12:25 +03:00
Jeroen Verhoest	bea0a4e408	CB-10895 Transparent Splashscreen view sometimes remains github: close#92	2016-03-24 16:33:23 +03:00
daserge	41d9ae94ff	CB-10562 hide() not working in latest splashscreen plug in 3.1.0 in iOS	2016-03-24 16:19:19 +03:00
Sarangan Rajamanickam	9ca15db91a	CB-10688:Plugin Splashscreen Readme must have examples. This closes #90	2016-03-21 15:04:56 -07:00
daserge	f8311aaca8	CB-10864 Run ios native tests on Travis Updated cordova-ios tests dependency version to latest published	2016-03-14 20:30:52 +03:00
Carlos Santana	abbb07e5ee	clean up release notes	2016-03-10 13:56:59 -05:00
Carlos Santana	2012ba9ab6	CB-10820 Incremented plugin version.	2016-03-09 22:34:18 -05:00