Home

Awesome

mobisplash Build Status

Mobile app splash screen generator

Install

$ npm install --save mobisplash

GraphicsMagick

This library depends on GraphicsMagick, so be sure to install this library as well.

Mac OSX

$ brew install graphicsmagick

Linux

$ sudo apt-get install graphicsmagick

Windows

Manual installation or via chocolatey.

$ choco install graphicsmagick

Usage

const mobisplash = require('mobisplash');

mobisplash('logo.png', {platform: 'ios'}).then(() => {
    // splash screens generated
});

mobisplash('logo.svg', {platform: 'android', draw9patch: false}).then(() => {
    // splash screens generated
});

API

mobisplash(file, options)

file

Type: string

Source file of the splash screen.

options

platform

Required<br> Type: string<br> Values: android ios blackberry10

Platform to generate the splash screens for.

orientation

Type: string<br> Values: both portrait landscape<br> Default: both

Orientation to generate the splash screens for.

background

Type: string<br> Default: white

Color of the splash screen background.

contentRatio

Type: number<br> Default: 0.8

Logo-splash screen ratio. 1 means the logo will fill up the entire width (or height) of the splash screen.

draw9patch

Type: boolean<br> Default: true

9-patch the Android splash screens.

dest

Type: string<br> Default: process.cwd()

Directory to save the generated splash screens to.

Platforms

The supported platforms are Android, iOS and BlackBerry 10. Every platform generates a different set of icons.

Android

iOS

BlackBerry 10

Related

License

MIT © Sam Verschueren