Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/excellenteasy/ios-icons
Get iOS icons: files names and sizes
https://github.com/excellenteasy/ios-icons
Last synced: 12 days ago
JSON representation
Get iOS icons: files names and sizes
- Host: GitHub
- URL: https://github.com/excellenteasy/ios-icons
- Owner: excellenteasy
- License: mit
- Created: 2014-11-30T19:25:26.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2020-05-25T04:07:36.000Z (over 4 years ago)
- Last Synced: 2024-11-14T16:30:56.508Z (30 days ago)
- Language: JavaScript
- Size: 78.1 KB
- Stars: 5
- Watchers: 2
- Forks: 3
- Open Issues: 7
-
Metadata Files:
- Readme: readme.md
- License: license
Awesome Lists containing this project
README
# ios-icons
[](https://travis-ci.org/excellenteasy/ios-icons)
[](https://david-dm.org/excellenteasy/ios-icons)
[](https://david-dm.org/excellenteasy/ios-icons#info=devDependencies)
[](https://github.com/boennemann/semantic-release)
> Get iOS icon file names and dimensions (width)
The default icon file names and required sizes for iOS are listed in a [JSON file](icons.json). This information is useful, for example, when you want to generate icons with the required sizes or to create a [`config.xml`](http://docs.phonegap.com/en/3.5.0/config_ref_images.md.html) file for a PhoneGap/Cordova project or if you just need to create the icons for your iOS project from one source icon.
This information also exists for [android icons](https://github.com/excellenteasy/android-icons).
## Install
```sh
$ npm install --save ios-icons
```
## Usage
```js
var icons = require('ios-icons');
icons();
//=> [{name: '[email protected]', width: 180}, {name: 'icon-60.png', width: 60, ...}]
icons({size: '72'})
//=> {name: 'icon-72.png', width: 72}
icons({size: 'small'})
//=> {name: 'icon-small.png', width: 29}
```
## 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 `"@2x"` or `"@3x"` notation to refer to a certain size or the complete file name, e.g. `icon-small.png`.
Returns icon object for that size or `null`.
For example:
```js
icons({size: "60@3x"});
// ==> {name: "[email protected]", width: 180}
```
## CLI
> ios-icons logs to stdout in comma-separated values format (csv) by default so you can easy pipe to other commands in UNIX systems.
```sh
$ npm install --global ios-icons
```
```sh
$ ios-icons --help
Examples:
$ ios-icons --format json --size 60
{ name: 'icon-60.png', width: 60 }
$ ios-icons --size 60@3x
[email protected],180
$ ios-icons
[email protected],180
icon-60.png,60
[email protected],120
icon-76.png,76
[email protected],152
icon-40.png,40
[email protected],80
icon.png,57
[email protected],114
icon-72.png,72
[email protected],144
icon-small.png,29
[email protected],58
icon-50.png,50
[email protected],100
$ ios-icons --format json
[{"name":"[email protected]","width":180},{"name":"icon-60.png","width":60},{"name":"[email protected]","width":120},{"name":"icon-76.png","width":76},{"name":"[email protected]","width":152},{"name":"icon-40.png","width":40},{"name":"[email protected]","width":80},{"name":"icon.png","width":57},{"name":"[email protected]","width":114},{"name":"icon-72.png","width":72},{"name":"[email protected]","width":144},{"name":"icon-small.png","width":29},{"name":"[email protected]","width":58},{"name":"icon-50.png","width":50},{"name":"[email protected]","width":100}]
```
## Semantic Releases
Since version 2.0.0, this module is being [semantically released](https://github.com/boennemann/semantic-release). You can safely use `"^2.0.0"` in your `package.json`.
## License
This was originally based on [animals](https://github.com/boennemann/animals) by [Stephan Bönnemann](http://boennemann.me/).
MIT © [David Pfahler](http://excellenteasy.com)