Update Splashscreen Plugin Doc for Cordova 9.x (#989)
diff --git a/www/docs/en/9.x/reference/cordova-plugin-splashscreen/index.md b/www/docs/en/9.x/reference/cordova-plugin-splashscreen/index.md
index 94f6261..d36b528 100644
--- a/www/docs/en/9.x/reference/cordova-plugin-splashscreen/index.md
+++ b/www/docs/en/9.x/reference/cordova-plugin-splashscreen/index.md
@@ -33,7 +33,24 @@
# cordova-plugin-splashscreen
-This plugin is required to work with splash screens. This plugin displays and hides a splash screen during application launch.
+This plugin displays and hides a splash screen while your web application is launching. Using its methods you can also show and hide the splash screen manually.
+
+- [Installation](#installation)
+- [Supported Platforms](#supported-platforms)
+- [Platform Splash Screen Image Configuration](#platform-splash-screen-image-configuration)
+ * [Example Configuration](#example-configuration)
+ * [iOS-specific Information](#ios-specific-information)
+ * [Windows-specific Information](#windows-specific-information)
+- [Preferences](#preferences)
+ * [config.xml](#configxml)
+ * [Quirks](#quirks)
+ + [Android Quirks](#android-quirks)
+ + [Browser Quirks](#browser-quirks)
+ + [iOS Quirks](#ios-quirks)
+ + [Windows Quirks](#windows-quirks)
+- [Methods](#methods)
+ * [splashscreen.hide](#splashscreenhide)
+ * [splashscreen.show](#splashscreenshow)
## Installation
@@ -47,12 +64,96 @@
- Android
- iOS
-- Windows (`cordova-windows` version >= 4.4.0 is required)
+- Windows (`cordova-windows` version >= 4.4.0 is required)
+ __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.
- 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.
+## Platform Splash Screen Image Configuration
-### iOS-specific information
+### Example Configuration
+
+In the top-level `config.xml` file (not the one in `platforms`), add configuration elements like those specified here.
+
+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 file whatever you like. The internal name in the application is automatically 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-land-xxhdpi.png" density="land-xxhdpi"/>
+
+ <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"/>
+ <splash src="res/screen/android/splash-port-xxhdpi.png" density="port-xxhdpi"/>
+</platform>
+
+<platform name="ios">
+ <!-- There are two mechanisms for showing launch images.
+ -- Legacy method (supports all devices except iPad Pro 12.9):
+ -- Note: 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"/>
+ <!-- Storyboard method (supports all devices):
+ -- Important: If you use the storyboard method, legacy images are
+ -- copied but ignored.
+ -- Note: images are determined by scale, idiom, and size traits. The following
+ -- are suggested based on current device form factors -->
+ <splash src="res/screen/ios/Default@2x~universal~anyany.png" />
+ <splash src="res/screen/ios/Default@2x~universal~comany.png" />
+ <splash src="res/screen/ios/Default@2x~universal~comcom.png" />
+ <splash src="res/screen/ios/Default@3x~universal~anyany.png" />
+ <splash src="res/screen/ios/Default@3x~universal~anycom.png" />
+ <splash src="res/screen/ios/Default@3x~universal~comany.png" />
+
+</platform>
+
+<!-- Configuration using MRT concept (Recommended, see "Windows-specific information" section for details): -->
+<platform name="windows">
+ <splash src="res/screen/windows/splashscreen.png" target="SplashScreen"/>
+ <splash src="res/screen/windows/splashscreenphone.png" target="SplashScreenPhone"/>
+</platform>
+
+<!-- Configuration using image size: -->
+<!--<platform name="windows">
+ <splash src="res/screen/windows/splashscreen.png" width="620" height="300"/>
+ <splash src="res/screen/windows/splashscreenphone.png" width="1152" height="1920"/>
+</platform>-->
+
+<preference name="SplashScreenDelay" value="10000" />
+```
+
+### iOS-specific Information
There are two mechanisms for displaying a launch screen on iOS:
@@ -253,11 +354,12 @@
3. **`anyany` must be provided for other variations to be used**
If you don't provide an `anyany` version of the launch image for a specific scale and idiom, the other variations (like `anycom`, `comany`, and `comcom`) will ignored.
-## Windows-specific information
+### Windows-specific Information
Splash screen images can be defined using the [MRT](https://cordova.apache.org/docs/en/dev/config_ref/images.html#windows) concept.
-If you specify src="res/windows/splashscreen.png" the following files will be copied into the application's images folder:
+If you specify `src="res/windows/splashscreen.png"` the following files will be copied into the application's images folder:
`res/windows/splashscreen.png` | `res/windows/splashscreen.scale-100.png`, `res/windows/splashscreen.scale-125.png`, etc.
+
The following are supported:
| Scale, % | Project | Width | Height | Filename |
@@ -277,154 +379,78 @@
__Note__: Supported formats are `.png`, `.jpg`, `.jpeg`. Mixing of the extensions within a target is not supported. I.e. you can have `splashscreen.jpg` and `splashscreenphone.png` but not `splashscreen.scale-100.png`, `splashscreen.scale-400.jpg`.
__Note__: You may need to reopen Visual Studio solution after changing the images and doing a `cordova prepare` for the changes to take effect.
-## 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">
- <!-- There are two mechanisms for showing launch images.
- -- Legacy method (supports all devices except iPad Pro 12.9):
- -- Note: 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"/>
- <!-- Storyboard method (supports all devices):
- -- Important: If you use the storyboard method, legacy images are
- -- copied but ignored.
- -- Note: images are determined by scale, idiom, and size traits. The following
- -- are suggested based on current device form factors -->
- <splash src="res/screen/ios/Default@2x~universal~anyany.png" />
- <splash src="res/screen/ios/Default@2x~universal~comany.png" />
- <splash src="res/screen/ios/Default@2x~universal~comcom.png" />
- <splash src="res/screen/ios/Default@3x~universal~anyany.png" />
- <splash src="res/screen/ios/Default@3x~universal~anycom.png" />
- <splash src="res/screen/ios/Default@3x~universal~comany.png" />
-
-</platform>
-
-<!-- Configuration using MRT concept (Recommended, see "Windows-specific information" section for details): -->
-<platform name="windows">
- <splash src="res/screen/windows/splashscreen.png" target="SplashScreen"/>
- <splash src="res/screen/windows/splashscreenphone.png" target="SplashScreenPhone"/>
-</platform>
-
-<!-- Configuration using image size: -->
-<!--<platform name="windows">
- <splash src="res/screen/windows/splashscreen.png" width="620" height="300"/>
- <splash src="res/screen/windows/splashscreenphone.png" width="1152" height="1920"/>
-</platform>-->
-
-<preference name="SplashScreenDelay" value="10000" />
-```
-
## Preferences
-#### config.xml
+### 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. The splash screen is hidden after the amount of time specified in the `SplashScreenDelay` preference.
-```xml
+ ```xml
<preference name="AutoHideSplashScreen" value="true" />
-```
+ ```
- `SplashScreenDelay` (number, default to 3000). Amount of time in milliseconds to wait before automatically hide splash screen.
-```xml
+ ```xml
<preference name="SplashScreenDelay" 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. )
+ This value used to be in seconds (but is now milliseconds) so values less than 30 will continue to 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"/>
-```
+ To disable the splashscreen add the following preference to `config.xml`:
+ ```xml
+ <preference name="SplashScreenDelay" value="0"/>
+ ```
-**Windows Quirk**: You should disable the splashscreen in case you are updating the entire document body dynamically (f.e. with a SPA router) to avoid affecting UI/controls.
-Note that you should also directly reference `WinJS/base.js` in the page HTML in this case to avoid the issues with activation context ([CB-11658](https://issues.apache.org/jira/browse/CB-11658)).
+ **Windows Quirk**: You should disable the splashscreen in case you are updating the entire document body dynamically (f.e. with a SPA router) to avoid affecting UI/controls.
+ Note that you should also directly reference `WinJS/base.js` in the page HTML in this case to avoid the issues with activation context ([CB-11658](https://issues.apache.org/jira/browse/CB-11658)).
-**iOS Quirk**: to disable the splashscreen on `ios` platform you should also add `<preference name="FadeSplashScreenDuration" value="0"/>` to `config.xml`.
+ **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.
-```xml
+ ```xml
<preference name="FadeSplashScreen" value="false"/>
-```
+ ```
- `FadeSplashScreenDuration` (float, defaults to `500`): Specifies the
number of milliseconds for the splash screen fade effect to execute.
-```xml
+ ```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`:
+ _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`:
-- 00:00 - splashscreen is shown
-- 00:02 - fading has started
-- 00:03 - splashscreen is hidden
+ - 00:00 - splashscreen is shown
+ - 00:02 - fading has started
+ - 00:03 - splashscreen is hidden
-Turning the fading off via `<preference name="FadeSplashScreen" value="false"/>` technically means fading duration to be `0` so that in this example the overall splash delay will still be 3 seconds.
+ Turning the fading off via `<preference name="FadeSplashScreen" value="false"/>` technically means fading duration to be `0` so that in this example the overall splash screen delay will still be 3 seconds.
-_Note_: This only applies to the app startup - you need to take the fading timeout into account when manually showing/hiding the splashscreen in the code:
+ _Note_: This only applies to the application startup - you need to take the fading timeout into account when manually showing/hiding the splash screen in your application's code:
-```javascript
-navigator.splashscreen.show();
-window.setTimeout(function () {
- navigator.splashscreen.hide();
-}, splashDuration - fadeDuration);
-```
+ ```javascript
+ navigator.splashscreen.show();
+ window.setTimeout(function () {
+ navigator.splashscreen.hide();
+ }, splashDuration - fadeDuration);
+ ```
- `ShowSplashScreenSpinner` (boolean, defaults to `true`): Set to `false`
- to hide the splash-screen spinner.
+ to hide the splash screen spinner.
-```xml
+ ```xml
<preference name="ShowSplashScreenSpinner" value="false"/>
-```
+ ```
+
+ _Note_: Does not work on Browser or Windows platforms.
-### Android Quirks
+### Quirks
+
+#### Android Quirks
In your `config.xml`, you can add the following preferences:
@@ -434,15 +460,15 @@
<preference name="SplashScreenSpinnerColor" value="white" />
```
-"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.
+`SplashMaintainAspectRatio` preference is optional. If set to `true`, the splash screen drawable is not stretched to fit the full 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.
+The splash screen plugin reloads the splash screen whenever the orientation changes so that you can specify different splash screen images 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).
+`SplashShowOnlyFirstTime` preference is optional and defaults to `true`. When set to `true` the splash screen will only appear on application launch. However, if you plan to use `navigator.app.exitApp()` to close the application and force the splash screen appear on the application's next launch, you should set this property to `false` (this also applies to closing the application with the Back button).
-"SplashScreenSpinnerColor" preference is also optional and is ignored when not set. Setting it to a valid color name or HEX color code will change the color of the spinner on Android 5.0+ devices.
+`SplashScreenSpinnerColor` preference is also optional and is ignored when not set. Setting it to a valid color name or HEX color code will change the color of the spinner on Android 5.0+ devices.
-### Browser Quirks
+#### Browser Quirks
You can use the following preferences in your `config.xml`:
@@ -460,32 +486,32 @@
__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
+#### iOS Quirks
-- In iOS, the splashscreen images are called launch images. These images are mandatory on iOS.
+- In iOS, the splash screen images are called launch images. These images are mandatory on iOS.
-### Windows Quirks
+#### 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)"/>
-```
+ ```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"/>
-```
+ ```xml
+ <preference name="SplashScreenBackgroundColor" value="0xFFFFFFFF"/>
+ ```
## Methods
- splashscreen.show
- splashscreen.hide
-## splashscreen.hide
+### splashscreen.hide
Dismiss the splash screen.
@@ -494,7 +520,7 @@
```
-### iOS Quirk
+#### iOS Quirk
The `config.xml` file's `AutoHideSplashScreen` setting must be
`false`. To delay hiding the splash screen for two seconds, add a
@@ -506,7 +532,7 @@
}, 2000);
```
-## splashscreen.show
+### splashscreen.show
Displays the splash screen.
@@ -514,13 +540,11 @@
navigator.splashscreen.show();
```
-Your application cannot call `navigator.splashscreen.show()` until the app has
+Your application cannot call `navigator.splashscreen.show()` until the application 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
+screen is meant to be visible before your application has started, that would seem to
+defeat the purpose of the splash screen. Providing any parameters 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. 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
+application is launched and before it has fully started and received the `deviceready`
+event. For this reason, it is unlikely you will need to call `navigator.splashscreen.show()` to make the splash
+screen visible for application startup.
