Splashscreen Plugin

Tested Version: 5.0.2

This document is based on the original Cordova docs available at Cordova Docs.

This plugin displays and hides a splash screen during application launch.

Plugin ID

cordova-plugin-splashscreen

Adding the Plugin in Monaca

In order to use this plugin, please enable Splashscreen plugin in Monaca Cloud IDE.

Supported Platforms

• Android

• iOS

Preferences

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.

xml<preference name="AutoHideSplashScreen" value="true" />

• SplashScreenDelay (number, default to 3000). Amount of time in milliseconds to wait before automatically hide splash screen.

xml<preference name="SplashScreenDelay" value="3000" />

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 disappear in some future version. )

To disable the splashscreen add the following preference to config.xml:

<preference name="SplashScreenDelay" value="0"/>

iOS Quirk

• In iOS, the splashscreen images are called launch images. These

  images are mandatory on iOS.

In order 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<preference name="FadeSplashScreen" value="false"/>

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

xml<preference name="FadeSplashScreenDuration" value="750"/>

FadeSplashScreenDuration is included into SplashScreenDelay, for example if you have the following configuration defined in in the config.xml file:

<preference name="SplashScreenDelay" value="3000" />
<preference name="FadeSplashScreenDuration" value="1000"/>

Then, the following action will happen:

• 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.

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:

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.

xml<preference name="ShowSplashScreenSpinner" value="false"/>

Android Quirks

In your config.xml, you can add the following preferences:

<preference name="SplashMaintainAspectRatio" value="true|false" />
<preference name="SplashShowOnlyFirstTime" value="true|false" />
<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.

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).

"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.

Methods

• splashscreen.show

• splashscreen.hide

splashscreen.hide

Dismiss the splash screen.

navigator.splashscreen.hide();

iOS Quirk

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);

splashscreen.show

Displays the splash screen.

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 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. For this reason, it is unlikely you need to call navigator.splashscreen.show() to make the splash screen visible for app startup.

Legacy launch images

If you choose to use legacy launch images, you will use the following syntax in config.xml:

<splash src="/res/ios/screen/Default~iphone.png" width="320" height="480"/>
<splash src="/res/ios/screen/Default@2x~iphone.png" width="640" height="960"/>
<splash src="/res/ios/screen/Default-Portrait~ipad.png" width="768" height="1024"/>
<splash src="/res/ios/screen/Default-Portrait@2x~ipad.png" width="1536" height="2048"/>
<splash src="/res/ios/screen/Default-Landscape~ipad.png" width="1024" height="768"/>
<splash src="/res/ios/screen/Default-Landscape@2x~ipad.png" width="2048" height="1536"/>
<splash src="/res/ios/screen/Default-568h@2x~iphone.png" width="640" height="1136"/>
<splash src="/res/ios/screen/Default-667h.png" width="750" height="1334"/>
<splash src="/res/ios/screen/Default-736h.png" width="1242" height="2208"/>

Technically the filename for the src attribute can be anything you want; the filenames are used because they match what will be used when your project is compiled. The width and height attributes determine which launch images are displayed on which devices as follows:

width	height	device (orientation)
320	480	All non-retina iPhones and iPods
640	960	iPhone 4/4s/5/5s (portrait)
750	1334	iPhone 6/6s/7 (portrait)
1242	2208	iPhone 6+/6s+/7+ (portrait)
2208	1242	iPhone 6+/6s+/7+ (landscape)
768	1024	All non-retina iPads (portrait)
1024	768	All non-retina iPads (landscape)
1536	2048	All retina iPads (portrait)
2048	1536	All retina iPads (landscape)

It is vitally important that the source image actually matches the size specified in the width and height attributes. If it does not, the device may fail to render it properly, if at all.

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
        res
            android
                screen
            ios
                screen
        www
            css
            img
            js

<platform name="android">
    <!-- you can use any density that exists in the Android project -->
    <splash src="/res/android/screen/splash-land-hdpi.png" density="land-hdpi"/>
    <splash src="/res/android/screen/splash-land-ldpi.png" density="land-ldpi"/>
    <splash src="/res/android/screen/splash-land-mdpi.png" density="land-mdpi"/>
    <splash src="/res/android/screen/splash-land-xhdpi.png" density="land-xhdpi"/>

    <splash src="/res/android/screen/splash-port-hdpi.png" density="port-hdpi"/>
    <splash src="/res/android/screen/splash-port-ldpi.png" density="port-ldpi"/>
    <splash src="/res/android/screen/splash-port-mdpi.png" density="port-mdpi"/>
    <splash src="/res/android/screen/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/ios/screen/Default~iphone.png" width="320" height="480"/>
    <splash src="/res/ios/screen/Default@2x~iphone.png" width="640" height="960"/>
    <splash src="/res/ios/screen/Default-Portrait~ipad.png" width="768" height="1024"/>
    <splash src="/res/ios/screen/Default-Portrait@2x~ipad.png" width="1536" height="2048"/>
    <splash src="/res/ios/screen/Default-Landscape~ipad.png" width="1024" height="768"/>
    <splash src="/res/ios/screen/Default-Landscape@2x~ipad.png" width="2048" height="1536"/>
    <splash src="/res/ios/screen/Default-568h@2x~iphone.png" width="640" height="1136"/>
    <splash src="/res/ios/screen/Default-667h.png" width="750" height="1334"/>
    <splash src="/res/ios/screen/Default-736h.png" width="1242" height="2208"/>
    <splash src="/res/ios/screen/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/ios/screen/Default@2x~universal~anyany.png" />
    <splash src="/res/ios/screen/Default@2x~universal~comany.png" />
    <splash src="/res/ios/screen/Default@2x~universal~comcom.png" />
    <splash src="/res/ios/screen/Default@3x~universal~anyany.png" />
    <splash src="/res/ios/screen/Default@3x~universal~anycom.png" />
    <splash src="/res/ios/screen/Default@3x~universal~comany.png" />
</platform>

<preference name="SplashScreenDelay" value="10000" />

See Also:

• Third-party Cordova Plugins
• Core Cordova Plugins