grunt-cordova-icons

Creates the icons for an Cordova project

Supported platforms

Please contribute your relevant platforms

• iOS
• Android
• ...

Requirements

• Grunt
• Cordova
• GraphicsMagick

Grunt and Cordova can be installed via NPM:

npm i -g grunt-cli cordova

GraphicsMagick can be installed via Homebrew:

brew install graphicsmagick

Usage of the 'icons' task

The task uses one base image (e.g. icon.png) that you provide and resizes it to the various needed icon sizes. The image should be of the size of the largest icon (e.g. 512 x 512 for all iOS icons).

In our project Gruntfile.js, add a section named icons to the config object that is passed into grunt.initConfig.

Run the task via

grunt icons

Example

icons: {
  options: {
    platforms: ['ios', 'android']
  },
  // this would only produce the icons for iOS
  ios: {
    options: {
      platforms: 'ios'
    },
    src: './icon.png',
    dest: 'build/res'
  },
  // this would only produce the icons for Android; with the folders not expanded
  android {
    options: {
      platforms: ['android'],
      expand: false
    },
    src: './icon.png',
    dest: 'build/res/android'
  }
}

Options

options.cordova (todo)

Type: String
Default: config.xml

This is the configuration file that is extended with the icons.

options.expand

Type: Boolean
Default: true

Expands the dest as to be of the format /icons/platform. Otherwise write all the files in the flat directory.

options.platforms

Type: Array or String
Default: [ios, android]

This is the list of platforms the icons should be created for.

Task coded and submitted by Sebastian Döll