iconify_ex v0.0.2

Iconify for Phoenix

Phoenix helpers for using 100,000+ SVG icons from 100+ icon sets compiled by Iconify (visit that site to browse the sets available and preview the icons)

It copies only the icons you use from the iconify library into your project, preparing them on-the-fly when you first use an icon in a view or component, during development.

It can be configured to embed the icons one of three ways:

  • inline: to generate a Phoenix Component for each icon used, used to embed the icons as svg tags inline in the HTML of your views (meaning the SVG will be included in LiveView diffs)
  • img: to create SVG files in your static assets, used to be included with img tags and loaded over HTTP (you probably want to include a JS hook with https://github.com/iconfu/svg-inject to enable styling of the SVGs, e.g. to change their colour)
  • css: generate a single CSS file containing classes with SVGs of all the icons used (using content:url(\"data:image/svg... meaning the SVG is treated like and image and can't be styled)

Installation 

def deps do
  [
    {:iconify_ex, "~> 0.0.2"}
  ]
end

You then need to fetch the latest iconify icon sets by running:

cd deps/iconify_ex/assets && yarn

Usage

  1. Add import Iconify in your Phoenix or LiveView module where you want to use it (or just once in the macros in your Web module).

  2. Set one of these options in config to choose which approach you want to use (see above for explanations):

  • config :iconify_ex, :mode, :inline
  • config :iconify_ex, :mode, :img
  • config :iconify_ex, :mode, :css
  1. In all three cases, usage is simple and remains the same:

Embed an icon using default classes (copy the icon name from the iconify website):

<.iconify icon="heroicons-solid:collection">

Specify custom classes:

<.iconify icon="heroicons-solid:collection" class="w-8 h-8 text-base-content" />