Eleventy FontAwesome Icon

A configurable Eleventy shortcode that outputs FontAwesome icon svgs in a custom svg sprite. Forked from @campj/eleventy-fa-icons

Usage

Installation

yarn install --dev @joncottrell/eleventy-fa-icons

Adding to Eleventy

in .eleventy.js:

// require
const { FontAwesomeIcon } = require("@joncottrell/eleventy-fa-icons");
module.exports = function(config) {
  // Shortcode
  config.addNunjucksShortcode("FontAwesomeIcon", FontAwesomeIcon());
  //
};

Optionally you can pass the ouputDir into FontAwesomeIcon if you aren't using the default _site. E.g:

// require
const { FontAwesomeIcon } = require("@joncottrell/eleventy-fa-icons");
module.exports = function(config) {
  // Shortcode
  config.addNunjucksShortcode("FontAwesomeIcon", FontAwesomeIcon("dist"));
  //
};

Note: If you have any idea on how to set the output directory more cleanly, I'm all ears, feel free to send a PR or give me a suggestion.

In any nunjucks template file:

Use the shortcode:

{% FontAwesomeIcon
    name = "times",
    type = "solid",
    class = "someClassName",
%}

Props:

name: the icon name
type: the icon type (one of "solid", "regular" or "brand") -- defaults to solid
class: additional classes to append to the icon wrapper
tag: the type of html tag you'd like to use to output the icon

** other properties will get applied to the wrapper tag as attributes

CSS

Default styles for an icon can be imported from @joncottrell/eleventy-fa-icons/icon.css; I recommend you use your own:

.icon svg {
  display: block;
  width: 1em;
  height: 1em;
}

Utility Methods

getAvailableIcons(type)

Props:

type: the icon type (one of "solid", "regular" or "brand")

Usage

const { getAvailableIcons } = require("@campj/eleventy-fa-icons");

getAvailableIcons("solid"); // outputs a list of icon names for the 'solid' type
getAvailableIcons("regular"); // outputs a list of icon names for the 'regular' type
getAvailableIcons("brand"); // outputs a list of icon names for the 'brand' type

isIconAvailable(name, type)

Props:

name: the icon name
type: the icon type (one of "solid", "regular" or "brand")

Usage

const { isIconAvailable } = require("@joncottrell/eleventy-fa-icons");
// checks whether the icon "times" is available in the "regular" type
isIconAvailable("times", "regular");

would output the following to the console:

FontAwesomeIcon:: no, the icon 'times' is not available in type regular, but it is available in the type solid.