Files
phosphoricons/lib/heroicons.ex

33 lines
1.0 KiB
Elixir
Raw Normal View History

2021-03-03 17:35:03 -05:00
defmodule Heroicons do
@moduledoc """
2021-11-12 09:09:03 -05:00
This library provides functions and components for every [Heroicon](https://github.com/tailwindlabs/heroicons).
2021-03-03 17:35:03 -05:00
2021-11-12 09:09:03 -05:00
Heroicons are provided as functions in `Heroicons.Outline` and `Heroicons.Solid`,
and as `Phoenix.Component`s in `Heroicons.Components.Outline` and `Heroicons.Components.Solid`.
2021-03-03 17:35:03 -05:00
2021-11-12 09:09:03 -05:00
Note that components require your project to have `:phoenix_live_view` as a dependency.
2021-03-03 17:35:03 -05:00
2021-11-12 09:09:03 -05:00
Heroicons are designed by [Steve Schoger](https://twitter.com/steveschoger)
"""
2021-11-12 09:09:03 -05:00
defmodule Outline do
@moduledoc """
Outline style icons drawn with a stroke, packaged as functions.
2021-03-06 16:53:46 -05:00
2021-11-12 09:09:03 -05:00
For primary navigation and marketing sections, designed to be rendered at 24x24.
"""
2021-03-03 17:35:03 -05:00
2021-11-12 09:09:03 -05:00
use Heroicons.Generator, icon_dir: "outline/"
2021-03-06 16:53:46 -05:00
end
2021-11-12 09:09:03 -05:00
defmodule Solid do
@moduledoc """
Solid style icons drawn with fills, packaged as functions.
2021-03-06 16:53:46 -05:00
2021-11-12 09:09:03 -05:00
For buttons, form elements, and to support text, designed to be rendered at 20x20.
2021-03-06 16:53:46 -05:00
"""
2021-11-12 09:09:03 -05:00
use Heroicons.Generator, icon_dir: "solid/"
2021-03-03 17:35:03 -05:00
end
end