rdiedrich/phosphoricons
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Improve docs & readme & small refactor

Browse Source
This commit is contained in:
Max Veytsman
2022-09-02 13:49:03 -04:00
parent 65fb8c6988
commit cf2401336d
8 changed files with 49 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
lib/heroicons.ex
View File

@ -1,26 +1,34 @@
defmodule Heroicons do
@latest_version "2.0.10"
@moduledoc """
This library provides Phoenix Components for every [Heroicon](https://github.com/tailwindlabs/heroicons).
See `Heroicons.Outline` and `Heroicons.Solid` for the two styles of icon.
See `Heroicons.Outline`, `Heroicons.Solid` and `Heroicons.Mini` for the three styles of icon.
## Examples
<Heroicons.Outline.adjustments />
<Heroicons.Outline.adjustments_vertical />
<Heroicons.Solid.arrow_circle_right class="w-6 h-6" />
<Heroicons.Solid.arrow_right_circle class="w-6 h-6" />
<Heroicons.Mini.bell class="w-4 h-4" />
Can also be used as a function
<%= Heroicons.Outline.adjustments() %>
<%= Heroicons.Outline.adjustments_vertical() %>
<%= Heroicons.Solid.arrow_circle_right(class: "w-6 h-6") />
<%= Heroicons.Solid.arrow_right_circle(class: "w-6 h-6") />
<%= Heroicons.Mini.bell(class: "w-4 h-4") />
This library comes pre-packaged with the icons from Heroicons version `#{@latest_version}`,
but can be locally configured and updated. See `Mix.Tasks.Heroicons.Update` for details
Heroicons are designed by [Steve Schoger](https://twitter.com/steveschoger)
"""
# https://github.com/tailwindlabs/heroicons/releases
@latest_version "2.0.10"
@tmp_dir_name "heroicons-elixir"
use Application
require Logger
@ -28,7 +36,7 @@ defmodule Heroicons do
@doc false
def start(_type, _args) do
children = [
{Heroicons.IconCache, []}
{Heroicons.Cache, []}
]
opts = [strategy: :one_for_one, name: Heroicons.Supervisor]