# Splashscreen Plugin

Tested Version: [6.0.0](https://github.com/apache/cordova-plugin-splashscreen/releases/tag/6.0.0)

{% hint style="info" %}
This document is based on the original Cordova docs available at [Cordova Docs](https://github.com/apache/cordova-plugin-splashscreen).
{% endhint %}

{% hint style="info" %}
For iOS, the SplashScreen plugin has been integrated into the iOS platform and Launch Images has been replaced by Launch Storyboards.

Details on how to set up images for Launch Storyboards can be found in [the SplashScreen documentation](https://cordova.apache.org/docs/en/latest/reference/cordova-plugin-splashscreen/index.html#launch-storyboard-images).
{% endhint %}

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

## Plugin ID

```javascript
cordova-plugin-splashscreen
```

## Adding the Plugin in Monaca

In order to use this plugin, please [enable](https://en.docs.monaca.io/products_guide/monaca_ide/dependencies/cordova_plugin#importing-cordova-plugins) `Splashscreen` plugin in Monaca Cloud IDE.

## Supported Platforms

* Android

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

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

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

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

{% hint style="info" %}
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. )
{% endhint %}

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

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

### Android Quirks

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

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

```javascript
navigator.splashscreen.hide();
```

### splashscreen.show

Displays the splash screen.

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

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

```bash
    projectRoot
        res
            android
                screen
        www
            css
            img
            js
```

```markup
<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>

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

See Also:

* [Third-party Cordova Plugins](https://en.docs.monaca.io/reference/third_party_phonegap)
* [Core Cordova Plugins](https://en.docs.monaca.io/reference/core-cordova-plugins)