title: Splashscreen description: Control the splash screen for your app.

cordova-plugin-splashscreen

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.

• cordova-plugin-splashscreen
• Installation
• Supported Platforms
• Platform Splash Screen Image Configuration
  • Example Configuration
  • Android-specific Information
  • Image Layout
  • density
  • Image Sizing Table
  • Dark Mode (API 28+)
  • Example Android Configuration
  • Windows-specific Information
• Preferences
  • config.xml
  • Quirks
  • Android Quirks
  • Browser Quirks
  • Windows Quirks
• Methods
  • splashscreen.hide
  • splashscreen.show

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

• Android Note: Android implementation has been moved to the core framework. If using cordova-android@10.x or earlier, use cordova-plugin-splashscreen@6.x If using cordova-android@11.x or later and exclusively developing for Android, this plugin can be uninstalled.
• Windows (cordova-windows version >= 4.4.0 is required)
  Note: Extended splashscreen does not require the plugin on Windows (as opposed to Android) 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
            android
            windows

<platform name="android">
    <splash src="https://github.com/apache/cordova-plugin-splashscreen/raw/6.0.2/res/screen/android/splash-land-hdpi.png" density="land-hdpi" />
    <splash src="https://github.com/apache/cordova-plugin-splashscreen/raw/6.0.2/res/screen/android/splash-land-ldpi.png" density="land-ldpi" />
    <splash src="https://github.com/apache/cordova-plugin-splashscreen/raw/6.0.2/res/screen/android/splash-land-mdpi.png" density="land-mdpi" />
    <splash src="https://github.com/apache/cordova-plugin-splashscreen/raw/6.0.2/res/screen/android/splash-land-xhdpi.png" density="land-xhdpi" />
    <splash src="https://github.com/apache/cordova-plugin-splashscreen/raw/6.0.2/res/screen/android/splash-land-xxhdpi.png" density="land-xxhdpi" />
    <splash src="https://github.com/apache/cordova-plugin-splashscreen/raw/6.0.2/res/screen/android/splash-land-xxxhdpi.png" density="land-xxxhdpi" />

    <splash src="https://github.com/apache/cordova-plugin-splashscreen/raw/6.0.2/res/screen/android/splash-port-hdpi.png" density="port-hdpi" />
    <splash src="https://github.com/apache/cordova-plugin-splashscreen/raw/6.0.2/res/screen/android/splash-port-ldpi.png" density="port-ldpi" />
    <splash src="https://github.com/apache/cordova-plugin-splashscreen/raw/6.0.2/res/screen/android/splash-port-mdpi.png" density="port-mdpi" />
    <splash src="https://github.com/apache/cordova-plugin-splashscreen/raw/6.0.2/res/screen/android/splash-port-xhdpi.png" density="port-xhdpi" />
    <splash src="https://github.com/apache/cordova-plugin-splashscreen/raw/6.0.2/res/screen/android/splash-port-xxhdpi.png" density="port-xxhdpi" />
    <splash src="https://github.com/apache/cordova-plugin-splashscreen/raw/6.0.2/res/screen/android/splash-port-xxxhdpi.png" density="port-xxxhdpi" /> 
</platform>


<platform name="windows">
    <splash src="https://github.com/apache/cordova-plugin-splashscreen/raw/6.0.2/res/screen/windows/splashscreen.png" target="SplashScreen"/>
    <splash src="https://github.com/apache/cordova-plugin-splashscreen/raw/6.0.2/res/screen/windows/splashscreenphone.png" target="SplashScreenPhone"/>
</platform>




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

Android-specific Information

To effectively create your Android SplashScreen assets, it is important to understand the idiom and sizes used for the assets.

Android defined its assets by the image's layout and density.

Image Layout

• land short for landscape mode
• port short for portrait mode

density

The image's density refers to the number of pixels per square inch. Android, interchangeably refers to this as DPI.

Not all devices have the same pixel size so it is important to create images for all DPI to ensure that the quality of the image for each device is great.

If not all DPI images are considered, some devices might not show a SplashScreen or will use an incorrect DPI image that can result in a blurry scaled image.

Image Sizing Table

Dark Mode (API 28+)

You can optionally provide an extra SplashScreen image to be used in dark/night mode when enabled on supported devices. To do this, add the -night keyword in between the layout and size keywords of the image's density attribute value. E.g.: land-night-hdpi

For more examples, please see the Example Configuration section.

Example Android Configuration

<platform name="android">

    <splash src="https://github.com/apache/cordova-plugin-splashscreen/raw/6.0.2/res/screen/android/splash-port-hdpi.png" density="hdpi"/>
    <splash src="https://github.com/apache/cordova-plugin-splashscreen/raw/6.0.2/res/screen/android/splash-port-ldpi.png" density="ldpi"/>
    <splash src="https://github.com/apache/cordova-plugin-splashscreen/raw/6.0.2/res/screen/android/splash-port-mdpi.png" density="mdpi"/>
    <splash src="https://github.com/apache/cordova-plugin-splashscreen/raw/6.0.2/res/screen/android/splash-port-xhdpi.png" density="xhdpi"/>
    <splash src="https://github.com/apache/cordova-plugin-splashscreen/raw/6.0.2/res/screen/android/splash-port-xxhdpi.png" density="xxhdpi"/>


    <splash src="https://github.com/apache/cordova-plugin-splashscreen/raw/6.0.2/res/screen/android/splash-land-hdpi.png" density="land-hdpi" />
    <splash src="https://github.com/apache/cordova-plugin-splashscreen/raw/6.0.2/res/screen/android/splash-land-ldpi.png" density="land-ldpi" />
    <splash src="https://github.com/apache/cordova-plugin-splashscreen/raw/6.0.2/res/screen/android/splash-land-mdpi.png" density="land-mdpi" />
    <splash src="https://github.com/apache/cordova-plugin-splashscreen/raw/6.0.2/res/screen/android/splash-land-xhdpi.png" density="land-xhdpi" />
    <splash src="https://github.com/apache/cordova-plugin-splashscreen/raw/6.0.2/res/screen/android/splash-land-xxhdpi.png" density="land-xxhdpi" />
    <splash src="https://github.com/apache/cordova-plugin-splashscreen/raw/6.0.2/res/screen/android/splash-land-xxxhdpi.png" density="land-xxxhdpi" />


    <splash src="https://github.com/apache/cordova-plugin-splashscreen/raw/6.0.2/res/screen/android/splash-port-hdpi.png" density="port-hdpi" />
    <splash src="https://github.com/apache/cordova-plugin-splashscreen/raw/6.0.2/res/screen/android/splash-port-ldpi.png" density="port-ldpi" />
    <splash src="https://github.com/apache/cordova-plugin-splashscreen/raw/6.0.2/res/screen/android/splash-port-mdpi.png" density="port-mdpi" />
    <splash src="https://github.com/apache/cordova-plugin-splashscreen/raw/6.0.2/res/screen/android/splash-port-xhdpi.png" density="port-xhdpi" />
    <splash src="https://github.com/apache/cordova-plugin-splashscreen/raw/6.0.2/res/screen/android/splash-port-xxhdpi.png" density="port-xxhdpi" />
    <splash src="https://github.com/apache/cordova-plugin-splashscreen/raw/6.0.2/res/screen/android/splash-port-xxxhdpi.png" density="port-xxxhdpi" />


    <splash src="https://github.com/apache/cordova-plugin-splashscreen/raw/6.0.2/res/screen/android/splash-land-night-hdpi.png" density="land-night-hdpi" />
    <splash src="https://github.com/apache/cordova-plugin-splashscreen/raw/6.0.2/res/screen/android/splash-land-night-ldpi.png" density="land-night-ldpi" />
    <splash src="https://github.com/apache/cordova-plugin-splashscreen/raw/6.0.2/res/screen/android/splash-land-night-mdpi.png" density="land-night-mdpi" />
    <splash src="https://github.com/apache/cordova-plugin-splashscreen/raw/6.0.2/res/screen/android/splash-land-night-xhdpi.png" density="land-night-xhdpi" />
    <splash src="https://github.com/apache/cordova-plugin-splashscreen/raw/6.0.2/res/screen/android/splash-land-night-xxhdpi.png" density="land-night-xxhdpi" />
    <splash src="https://github.com/apache/cordova-plugin-splashscreen/raw/6.0.2/res/screen/android/splash-land-night-xxxhdpi.png" density="land-night-xxxhdpi" />

    <splash src="https://github.com/apache/cordova-plugin-splashscreen/raw/6.0.2/res/screen/android/splash-port-night-hdpi.png" density="port-night-hdpi" />
    <splash src="https://github.com/apache/cordova-plugin-splashscreen/raw/6.0.2/res/screen/android/splash-port-night-ldpi.png" density="port-night-ldpi" />
    <splash src="https://github.com/apache/cordova-plugin-splashscreen/raw/6.0.2/res/screen/android/splash-port-night-mdpi.png" density="port-night-mdpi" />
    <splash src="https://github.com/apache/cordova-plugin-splashscreen/raw/6.0.2/res/screen/android/splash-port-night-xhdpi.png" density="port-night-xhdpi" />
    <splash src="https://github.com/apache/cordova-plugin-splashscreen/raw/6.0.2/res/screen/android/splash-port-night-xxhdpi.png" density="port-night-xxhdpi" />
    <splash src="https://github.com/apache/cordova-plugin-splashscreen/raw/6.0.2/res/screen/android/splash-port-night-xxxhdpi.png" density="port-night-xxxhdpi" />
</platform>

Windows-specific Information

Splash screen images can be defined using the MRT concept.
If you specify src="https://github.com/apache/cordova-plugin-splashscreen/raw/6.0.2/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:

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.

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

  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 a