Cordova-splashscreen-android-blackberry NPM

This plugin displays and hides a splash screen during application launch (for Android and Blackberry).

Installation

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

Supported platforms

Android
Blackberry10

Preferences in config.xml

SplashScreen (string). The resource name which is used for the displaying splash screen. Different platforms use values for this.

<preference name="SplashScreen" value="resourcename" />

AutoHideSplashScreen (boolean, default to true). Indicates whether to hide the 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 hiding the splash screen.

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

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

<preference name="SplashMaintainAspectRatio" value="true|false" />

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 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. See Icons and Splash Screens for more information on doing this configuration. For this reason, it is unlikely you need to call navigator.splashscreen.show() to make the splash screen visible for app startup.