A PhoneGap splash screen generator using an HTML document as a template.
JavaScript
Latest commit 3bf1456 Mar 17, 2015 @mwbrooks Version 0.6.0
Permalink
Failed to load latest commit information.
bin
lib
spec
.gitignore
.travis.yml
CONTRIBUTING.md
LICENSE
README.md
package.json

README.md

web2splash Build Status

A PhoneGap splash screen generator using an HTML document as a template.

About

Web2Splash will generate every splash screen for every PhoneGap platform.

A splash screen is the startup image displayed while your PhoneGap application loads. Since the image needs to match the device's screen size, you typically need to create multiple images for each platform. Even more annoying is that most platforms have devices with different screen aspect-ratios. This means a simple image resize will not cut it.

Rather than creating a large master image that is cropped, it makes more sense to use a responsive HTML document. As PhoneGap developer, you've already created a responsive HTML web application. It makes sense to reuse your skills to create the splash screens.

This tool reads in an HTML document into a headless Webkit browser, resizes the viewport to each splash screen size, and then renders an image.

Supported Platforms

  • Android
  • Bada
  • BlackBerry
  • iOS
  • webOS
  • Windows Phone

Install

  1. Download and Install PhantomJs
  2. ln -s /path/to/download/bin/phantomjs /usr/local/bin/phantomjs
  3. npm install [-g] web2splash

Usage

Command-Line

$ web2splash --help
$ web2splash http://example.com/
$ web2splash path/to/template.html path/to/output/dir

node.js

var web2splash = require('web2splash');

web2splash.onRenderImage = function(image) {
    // image.name, image.width, image.height
};

web2splash.render(input, output, function(e) {
    // done
});