cordova-plugin-splashscreen

Chrome Testsuite Lint Test

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

// npm hosted (new) id
cordova plugin add cordova-plugin-splashscreen

// you may also install directly from this repo
cordova plugin add https://github.com/apache/cordova-plugin-splashscreen.git

Supported Platforms

  • Windows (cordova-windows version >= 4.4.0 is required)
    Note: Extended splashscreen does not require the plugin on Windows in case you don't use the plugin API, i.e. programmatic hide/show.
  • Browser

Platform Splash Screen Image Configuration

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
            windows
<!-- 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" />

Windows-specific Information

Splash screen images can be defined using the MRT concept.
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
100 Windows 10/8.1 620 300 splashscreen.png | splashscreen.scale-100.png
125 Windows 10 775 375 splashscreen.scale-125.png
150 Windows 10 930 450 splashscreen.scale-150.png
200 Windows 10 1240 600 splashscreen.scale-200.png
400 Windows 10 2480 1200 splashscreen.scale-400.png
140 Windows 8.1 868 420 splashscreen.scale-140.png
180 Windows 8.1 1116 540 splashscreen.scale-180.png
100 Windows Phone 8.1 480 800 splashscreenphone.png | splashscreenphone.scale-100.png
140 Windows Phone 8.1 672 1120 splashscreenphone.scale-140.png
240 Windows Phone 8.1 1152 1920 splashscreenphone.scale-240.png

Note: SplashScreens size for Windows 10 project should not exceed 200 KBytes.
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.

Preferences

config.xml

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

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

    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:

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

  • 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"/>
    
  • FadeSplashScreenDuration (float, defaults to 500): Specifies the number of milliseconds for the splash screen fade effect to execute.

      <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:

    • 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 screen delay will still be 3 seconds.

    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:

      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.

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

    Note: Does not work on Browser or Windows platforms.

Quirks

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="AutoHideSplashScreen" value="true" /> <!-- defaults to "true" -->
    <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.

Windows Quirks

  • SplashScreenSpinnerColor (string, defaults to system accent color): hash, rgb notation or CSS color name.

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

      <preference name="SplashScreenBackgroundColor" value="0xFFFFFFFF"/>
    

Methods

  • splashscreen.show
  • splashscreen.hide

splashscreen.hide

Dismiss the splash screen.

navigator.splashscreen.hide();

splashscreen.show

Displays the splash screen.

navigator.splashscreen.show();

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