cordova-plugin-splashscreen

This plugin is required to work with splash screens. This plugin displays and hides a splash screen during application launch.

Report issues with this plugin on the [Apache Cordova issue tracker][Apache Cordova issue tracker].

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

- Amazon Fire OS
- Android
- BlackBerry 10
- iOS
- Windows Phone 7 and 8
- Windows 8
- Windows
- Browser

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 directory and not to the www directory. You can name the source image whatever you like. The internal name in the app is determined by Cordova.

``xml








































`

Preferences

#### config.xml

- __AutoHideSplashScreen__ (boolean, default to true). Indicates wherether hide splash screen automatically or not. Splash screen hidden after amount of time specified in the SplashScreenDelay preference.

`xml

`

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

`xml

`

$3

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

`xml



`

The first parameter represents how long the splashscreen will appear in milliseconds. It defaults to 3000 ms.

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

$3

You can use the following preferences in your config.xml:

`xml








`

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

$3

- In iOS, the splashscreen images are called launch images. These images are mandatory on iOS.

- FadeSplashScreen (boolean, defaults to true): Set to false to
prevent the splash screen from fading in and out when its display
state changes.

`xml

`

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

`xml

`

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

_Note_: FadeSplashScreenDuration is included into SplashScreenDelay, for example if you have and defined in config.xml:

- 00:00 - splashscreen is shown
- 00:02 - fading has started
- 00:03 - splashscreen is hidden

Turning the fading off via technically means fading duration to be 0 so that in this example the overall splash 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:

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

`xml

`

Methods

- splashscreen.show
- splashscreen.hide

splashscreen.hide

Dismiss the splash screen.

`js
navigator.splashscreen.hide();
`




$3

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:

`js
setTimeout(function() {
navigator.splashscreen.hide();
}, 2000);
`

splashscreen.show

Displays the splash screen.

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

[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