Skip to content

Latest commit

 

History

History
47 lines (30 loc) · 1.24 KB

README.md

File metadata and controls

47 lines (30 loc) · 1.24 KB
Raw

Boxicons

Boxicons are "simple open source icons carefully crafted for designers & developers". This package gives you Elixir functions to drop Boxicons into your HTML, styled with arbitrary classes.

This library provides optimized svgs for regular and solid Boxicons packaged as a Phoenix Component.

Installation

The package can be installed by adding boxicons to your list of dependencies in mix.exs:

def deps do
  [
    {:boxicons, "~> 0.1.0"}
  ]
end

After that run mix deps.get

Usage

The components are provided by the Boxicons module. Each icon is a Phoenix Component you can use in your HEEx templates.

For icons with both a regular and solid variant, the regular style is used:

<Boxicons.sushi />

You can select the solid variant by passing a flag:

<Boxicons.sushi solid />

You can also provide arbitrary HTML attributes to the svg tag, such as classes:

<Boxicons.sushi class="w-6 h-6 text-gray-500" />

For a full list of icons see the docs or boxicons.com.

Credits

This project is inspired by the heroicons_elixir library.