# Lucideicons

[![hex.pm](https://img.shields.io/hexpm/v/lucide_icons.svg)](https://hex.pm/packages/lucide_icons)
[![docs](https://img.shields.io/badge/hex-docs-blue.svg)](https://hexdocs.pm/lucide_icons)
[![ci](https://github.com/zoedsoupe/lucide_icons/actions/workflows/ci.yml/badge.svg)](https://github.com/zoedsoupe/lucide_icons/actions/workflows/ci.yml)
[![Hex Downloads](https://img.shields.io/hexpm/dt/lucide_icons)](https://hex.pm/packages/lucide_icons)

This package adds a convenient way of using [Lucide](https://lucide.dev/) with your Phoenix.LiveView applications.

Lucide is "An open source icon library for displaying icons and symbols in digital and non-digital projects. It consists of 850+ Vector (svg) files", and is a fork of Feather Icons.

You can find the original docs [here](https://lucide.dev/docs) and repo [here](https://github.com/lucide-icons/lucide).

## Installation

> **Warning:** Since version 2.0 this library only supports phoenix_live_view v1.0+

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

```elixir
def deps do
  [
    {:lucide_icons, "~> 2.0"}
  ]
end
```

Then run `mix deps.get`.

## Usage

### With Heex

```elixir
<Lucideicons.alert_triangle class="h-4 w-4" aria-hidden/>
```

where `alert_triangle` refers to a specific icon name.

> Icon names can be retrieved from `Lucideicons.icon_names/0`