README.md

FontAwesome

This package adds a convenient way of using Font Awesome SVGs with your Phoenix, Phoenix LiveView and Surface applications.

You can find the original docs here and repo here.

Current FontAwesome version: 6.2.0

Installation

Add ex_fontawesome to the list of dependencies in mix.exs:

def deps do
  [
    {:ex_fontawesome, "~> 0.7.2"}
  ]
end

Then run mix deps.get.

Usage

With Eex or Leex

<%= FontAwesome.icon("address-book", type: "regular", class: "h-4 w-4") %>

With Heex

<FontAwesome.LiveView.icon name="address-book" type="regular" class="h-4 w-4" />

With Surface

<FontAwesome.Surface.Icon name="address-book" type="regular" class="h-4 w-4" />

Config

Defaults can be set in the FontAwesome application configuration.

config :ex_fontawesome, type: "regular"

License

MIT. See LICENSE for more details.