@randy.tarampi/android-icons

android-icons

Get android icon file names and dimensions (width)

The default icon file names (as used by cordova) and required sizes for android are listed in a JSON file. This information is useful, for example, when you want to generate icons with the required sizes or to create a config.xml file for a PhoneGap/Cordova project or if you just need to create the icons for your android project from one source icon. This information also exists for iOS icons.

Install

$ npm install --save @randy.tarampi/android-icons

Usage

var icons = require('@randy.tarampi/android-icons');

icons();
//=> [{ "name": "mdpi.png", "width": 48 }, { "name": "hdpi.png", "width": 72 }, ... ]

icons({size: '48'})
//=> {name: 'mdpi.png', width: 48}

icons({size: 'xhdpi'})
//=> {name: 'xhdpi.png', width: 96}

API

icons()

Returns an array of icons, each icon being represented by an object with name and width properties.

Notice that icons are always squares, so no height property is provided.

icons(options)

options

Only option for now is size, which can be either a Number or String value. If it is a Number, it represents the width in pixels. If it is a String, you can use "mdpi", "hdpi" etc. to refer to a certain size or the complete file name, e.g. xhdpi.png.

Returns icon object for that size or null.

For example:

icons({size: 'xhdpi'})
//=> {name: 'xhdpi.png', width: 96}

CLI

android-icons logs to stdout in comma-separated values format (csv) by default so you can easy pipe to other commands in UNIX systems.

$ npm install --global @randy.tarampi/android-icons

$ android-icons --help
Get android icon file names and dimensions (width)

Use `--format json` to set output to JSON.
Get specifc icon by size or name by using `--size`.

Examples:
  $ android-icons --size 48
  [e-mail],80

  $ android-icons --size 80 --format json
  {"name":"[e-mail]","width":80}

  $ android-icons --size small
  icon-small.png,29

Semantic Releases

This module is being semantically released. You can safely use "^1.0.0" in your package.json.

License

MIT © David Pfahler, Randy Tarampi