Actual list of Font Awesome icons (plain JS array)
JavaScript
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
data
.editorconfig
.eslintrc
.gitattributes
.gitignore
.travis.yml
index.js
license
package.json
readme.md
test.js

readme.md

font-awesome-icons Build Status

Returns actual list of Font Awesome icons (plain JS array)

Install

$ npm install --save font-awesome-icons

Usage

const faIcons = require('font-awesome-icons');

faIcons.getList().then(icons => console.log(icons.length));
//=> 675

faIcons.getList().then(icons => console.log(icons[0]));
/*=>
{ name: 'Glass',
  id: 'glass',
  unicode: 'f000',
  created: 1,
  filter: [ 'martini', 'drink', 'bar', 'alcohol', 'liquor' ],
  categories: [ 'Web Application Icons' ]
}
*/

API

.getList()

Type: function

Returns a promise with a full list of actual Font Awesome icons.

.version()

Type: function

Returns a promise with an actual version of Font Awesome.

.getCategories()

Type: function

Returns a promise with a categories array.

[
    {
        name: 'Web Application Icons',
        icons: [
            {
                name: 'Glass',
                id: 'glass',
                unicode: 'f000',
                created: 1,
                filter: [ 'martini', 'drink', 'bar', 'alcohol', 'liquor' ],
                categories: [ 'Web Application Icons' ]
            },
            ...
        ]
    },
    ...
]

.getIconsByCategory(categoryName)

Type: function

Returns a promise with array of icons in needed category.

.getListByKeys(arrayOfNeededKeys)

Type: function

Returns a promise with a full list of Font Awesome icons with needed keys only.

const faIcons = require('font-awesome-icons');

faIcons.getListByKeys(['name', 'unicode']).then(icons => console.log(icons[0]));
//=> { name: 'Glass', unicode: 'f000' }

Related

font-awesome-v5-icons – separate package for Font Awesome v5

License

MIT © Sergey Lysenko