cordova-plugin-launchscreen-storyboard

cordova-plugin-launchscreen-storyboard

A cordova plugin for using a launch screen storyboard as the splash screen instead of an image

A common use case for this plugin is to control the default CDVLaunchScreen storyboard launch screen.

Installation

cordova plugin add cordova-plugin-launchscreen-storyboard

or via github

cordova plugin add https://github.com/toddbluhm/cordova-plugin-launchscreen-storyboard.git

Usage

Add the following code to your config.xml to get the plugin with default settings:

<plugin name="cordova-plugin-launchscreen-storyboard" spec="~2.0.0" />

The following preferences can be configured:

<preference name="StoryboardName" value="YOUR_STORY_BOARD_NAME" />
<preference name="FadeOut" value="true" />
<preference name="FadeOutDuration" value="0.5" />

NOTE: StoryboardName must match the name of your "Launch Screen File" in Xcode, or a null-pointer exception will follow. If your StoryboardName is not CDVLaunchScreen, you must specify it in your config.xml.

Once the plugin is setup you must now tell it when to fade out. You can do this by setting up a handler in index.html for the deviceready event.

Something like the following should work:

document.addEventListener("deviceready", function() {
  window.LaunchScreen.hide();
}, false);

Preferences

• StoryboardName - The name of the storyboard that contains your launch screen view controller. This will only instantiate the top level view controller in the storyboard. (Default: CDVLaunchScreen)

• FadeOut - Enable/Disable the view fading out when its told to hide(). This uses an EaseOut function.

• FadeOutDuration - How long should the fade out last (in seconds).

API

These are the javascript APIs exposed off of the window.LaunchScreen object.

• hide( callback ) - Hides the launch screen. Usually called in the deviceready event handler. The callback is called after the launch screen is fully hidden. callback has an error param which will be null or an error object if an error occurred.

• show( callback ) - Shows the launch screen. Should never need to be called in practice. The callback is called after the launch screen is fully visible. callback has an error param which will be null or an error object if an error occurred.

Supported Platforms

• iOS

Contributors

• Daniel Cousens

Contributing Guide

I welcome all pull requests. Before opening a PR please make sure to run the following script if you have modified any js files:

• npm run lint checks for code errors and formats according to js-standard

Changelog

2.0.0

• Breaking: Changed default storyboard name to CDVLaunchScreen as that is now the most common use case
• Fixed: No longer override users preference settings (Special Thanks to Daniel Cousens!)