# Heroicons


This package adds a convenient way of using [Heroicons]( with your Phoenix, Phoenix LiveView and Surface applications.

Heroicons is "A set of 450+ free MIT-licensed high-quality SVG icons for you to use in your web projects."
Created by the amazing folks at [Tailwind Labs](

You can find the original docs [here]( and repo [here](

## Installation

Add `ex_heroicons` to the list of dependencies in `mix.exs`:

def deps do
    {:ex_heroicons, "~> 0.1.4"}

Then run `mix deps.get`.

## Usage

### With Eex or Leex

<%= Heroicons.icon("outline", "academic-cap", class: "h-4 w-4") %>

### With Surface

<Heroicons.Components.Icon type="outline" name="academic-cap" class="h-4 w-4" />