Create splashscreen from a PNG.
Create PhoneGap splashscreens from a single PNG file.
As of 0.3.X, Cordova / PhoneGap have changed their directory and naming conventions so that it fits better the targeted platforms. This plugin is adapted to the new file structure to ease integration. Check former release 0.1.X if you are still on Cordova / PhoneGap 0.2.X releases.
Note on resolutions: See App Splash Screen Sizes.
In bold, the chart represents the user provided options. Normal texts are the generated sub file paths.
This plugin requires GraphicsMagick.
If you are on OSX, use HomeBrew:
brew install graphicsmagick
If you are on Ubuntu:
sudo apt-get install graphicsmagick
This plugin requires Grunt
If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:
npm install grunt-phonegapsplash --save-dev
In your project's Gruntfile, add a section named
phonegapsplash to the data object passed into
gruntinitConfigphonegapsplash:your_target:// Source file: the PNG.src: 'app/res/splash.png'// Destination directory where are stored all splashscreensdest: 'www/'// Optionnal, it produces splashscreen and layout for all phonegap targets if not specifiedoptions:// A list of layouts, it produces landscape and portrait if not specifiedlayouts: 'landscape'// A list of phone targets, it produces android, bada, blackberry, ios, webos, windows-phone if not specifiedprofiles: 'windows-phone' 'android';
Specify your project's name. It is mostly used for iOS as the
platforms/ios sub directory. PhoneGap/Cordova iOS target uses it when building the application.
Array of String
['landscape', 'portrait', 'none']
Specify the layout mode that you target. The full list is provided as default with the following meanings:
landscape: Splashscreen displayed in landscape mode.
portrait: Splashscreen displayed in portrait mode.
none: Splascreen for squared screens.
Array of String
['android', 'bada', 'blackberry', 'ios', 'webos', 'windows-phone']
Specify the stores that you target. The full list is provided as default. The default target produce a single
icon.png at the root of the specified destination directory with the following meanings:
android: Splashcreen for Android phones and tablets.
bada: Splashcreens for Bada and Bada-WAC phones.
blackberry: Splashcreens for Blackberry phones.
ios: Splascreens for iPod touch, iPhone and iPad in normal and retina resolutions.
webos: Splashcreens for WebOS (Palm) phones.
windows-phone: Splashcreens for Windows phones (7 and 8).
If an unused target is provided, nothing happens. This favors the re-use of already defined targeted OSes (stores or platforms) as find under the grunt-svg2storeicons.
In this example, the default options are used. All splashcreens for all layout and all OSes are being produced. The
src contains the filepath to the original PNG splashscreen. The
dest contains the directory in which the splashscreens are produced.
gruntinitConfigphonegapsplash:all_phones:src: 'app/res/splash.png'dest: 'www/';
In this example, custom options are used to create the unique splashscreen for blackberry.
gruntinitConfigsvg2storeicons:blackberry_only:src: 'app/res/splash.png'dest: 'www/'options:layouts: 'landscape'profiles: 'blackberry';
The main plugin is written and its tests are written in CoffeeScript. In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt. Feel free to contribute.