JSPM

font-awesome-list

4.7.0
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 8
  • Score
    100M100P100Q52577F
  • License MIT

Lists the icons provided by FontAwesome

Package Exports

  • font-awesome-list

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (font-awesome-list) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

font-awesome-list

font-awesome-list is a Node.js module for getting the list of all icons provided by FontAwesome.

Build Status Dev Dependency Status License Release

Install

Install using npm:

$ npm install --save font-awesome-list

The version of this library will always match the version of FontAwesome whose icons are listed.

API

all()

Returns all of the FontAwesome icons.

var fontAwesomeList = require('font-awesome-list');

fontAwesomeList.all();
//=> [ { name: "Glass", id: "glass", unicode: "f000", created: 1, filter: [ "martini", "drink", "bar", "alcohol", "liquor" ], categories: [ "Web Application Icons" ] }, ... ]

get(id)

Returns the FontAwesome icon with the specified id.

id can even be an alias but it must always exactly match. To be safe, always specify using lower case.

A hash lookup is used to find the match icon, so it's really fast.

This method will return null if no icon could be found for id.

var fontAwesomeList = require('font-awesome-list');

fontAwesomeList.get('git');
//=> { name: "Git", id: "git", unicode: "f1d3", created: 4.1, categories: [ "Brand Icons" ] }
fontAwesomeList.get('fa');
//=> { name: "Font Awesome", id: "font-awesome", unicode: "f2b4", created: 4.6, aliases: [ "fa" ], categories: [ "Brand Icons" ] }
fontAwesomeList.get('unknown');
//=> null

version()

Returns the FontAwesome version.

var fontAwesomeList = require('font-awesome-list');

fontAwesomeList.version();
//=> "4.7.0"

Bugs

If you have any problems with this library or would like to see changes currently in development you can do so here.

Contributors

If you want to contribute, you're a legend! Information on how you can do so can be found in CONTRIBUTING.md. We want your suggestions and pull requests!

A list of contributors can be found in AUTHORS.md.

License

See LICENSE.md for more information on our MIT license.

Copyright !ninja