genicon
v1.0.3
Published
Generate icons for mobile apps and broswer extensions/plugins.
Downloads
16
Maintainers
Readme
genicon-cli
Generate icons for mobile apps and browser extensions/plugins
Install
$ npm install --save genicon
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 genicon = require("genicon");
genicon("icon.png", { platform: "android" }).then(() => {
// icons generated
});
genicon("icon.svg", {
platform: "ios",
background: "#ff0000",
contentRatio: 1,
}).then(() => {
// icons generated
});
API
genicon(file, options)
file
Type: string
Source file of the icon.
options
platform
Required
Type: string
Values: android
blackberry10
chrome
ios
pwa
Platform to generate the icons for.
background
Type: string
Default: white
Color of the icon background if the icon is transparant.
contentRatio
Type: number
Default: 1
Logo-icon ratio. 1
means the logo will fill up the entire width (or height) of the icon, 0.5
means it will only fill up half of the icon.
roundedCorners
Type: boolean
Default: true
(only for Android
and PWA
)
Boolean indicating if the generated icons should have rounded corners. This is true
by default for the Android
and PWA
platform, false
otherwise.
borderRadius
Type: number
Default: 0.0909
The corner radius percentage of the generated icon. The default value is 9.09%
. See the material design styleguide for more information.
dest
Type: string
Default: process.cwd()
Directory to save the generated icons.
Platforms
The supported platforms are Android
, BlackBerry 10
, Chrome
, iOS
, and PWA
. Every platform generates a different set of icons.
Android
mipmap-ldpi/icon.png
mipmap-mdpi/icon.png
mipmap-hdpi/icon.png
mipmap-xhdpi/icon.png
mipmap-xxhdpi/icon.png
mipmap-xxxhdpi/icon.png
BlackBerry 10
icon-90.png
icon-96.png
icon-110.png
icon-144.png
Google Chrome Extension
icon-16.png
icon-32.png
icon-48.png
icon-96.png
icon-128.png
Firefox Extension
icon-16.png
icon-32.png
icon-48.png
icon-96.png
icon-128.png
iOS
icon.png
[email protected]
icon-small.png
[email protected]
[email protected]
icon-20.png
icon-40.png
[email protected]
[email protected]
icon-50.png
[email protected]
icon-60.png
[email protected]
[email protected]
icon-72.png
[email protected]
icon-76.png
[email protected]
[email protected]
PWA
icon-72x72.png
icon-96x96.png
icon-128x128.png
icon-144x144.png
icon-152x152.png
icon-192x192.png
icon-384x384.png
icon-512x512.png
Related
- genicon-cli - The CLI for this module
- mobisplash - Mobile app splash screen generator
License
MIT © Andre Fortin