Add components for Heroicons
This commit is contained in:
@ -1,66 +1,32 @@
|
||||
defmodule Heroicons do
|
||||
@moduledoc """
|
||||
This library provides functions for every [Heroicon](https://github.com/tailwindlabs/heroicons).
|
||||
See `Heroicons.Outline` and `Heroicons.Solid` for the two styles of icon.
|
||||
This library provides functions and components for every [Heroicon](https://github.com/tailwindlabs/heroicons).
|
||||
|
||||
Heroicons are provided as functions in `Heroicons.Outline` and `Heroicons.Solid`,
|
||||
and as `Phoenix.Component`s in `Heroicons.Components.Outline` and `Heroicons.Components.Solid`.
|
||||
|
||||
Note that components require your project to have `:phoenix_live_view` as a dependency.
|
||||
|
||||
Heroicons are designed by [Steve Schoger](https://twitter.com/steveschoger)
|
||||
"""
|
||||
|
||||
@doc false
|
||||
defmacro __before_compile__(%Macro.Env{module: module}) do
|
||||
unless Module.has_attribute?(module, :icon_dir) do
|
||||
raise CompileError, description: "@icon_dir attrubute is required"
|
||||
end
|
||||
defmodule Outline do
|
||||
@moduledoc """
|
||||
Outline style icons drawn with a stroke, packaged as functions.
|
||||
|
||||
icon_dir = Module.get_attribute(module, :icon_dir)
|
||||
default_attrs = Module.get_attribute(module, :default_attrs)
|
||||
|
||||
|
||||
icon_paths =
|
||||
Path.absname(icon_dir, :code.priv_dir(:heroicons))
|
||||
|> Path.join("*.svg")
|
||||
|> Path.wildcard()
|
||||
|
||||
for path <- icon_paths do
|
||||
generate_function(path, default_attrs)
|
||||
end
|
||||
end
|
||||
|
||||
@doc false
|
||||
def generate_function(path, default_attrs) do
|
||||
name =
|
||||
Path.basename(path, ".svg")
|
||||
|> String.replace("-", "_")
|
||||
|> String.to_atom()
|
||||
|
||||
icon = File.read!(path)
|
||||
{i, _} = :binary.match(icon, ">")
|
||||
{_, body} = String.split_at(icon, i)
|
||||
|
||||
doc = """
|
||||
)}) {: width=24px}
|
||||
|
||||
## Examples
|
||||
iex> #{name}()
|
||||
iex> #{name}(class: "h-6 w-6 text-gray-500")
|
||||
For primary navigation and marketing sections, designed to be rendered at 24x24.
|
||||
"""
|
||||
|
||||
quote do
|
||||
@doc unquote(doc)
|
||||
@spec unquote(name)(keyword(binary)) :: binary
|
||||
def unquote(name)(opts \\ []) do
|
||||
opts = Keyword.merge(unquote(default_attrs), opts)
|
||||
attrs =
|
||||
for {k, v} <- opts do
|
||||
safe_k =
|
||||
k |> Atom.to_string() |> String.replace("_", "-") |> Phoenix.HTML.Safe.to_iodata()
|
||||
safe_v = v |> Phoenix.HTML.Safe.to_iodata()
|
||||
use Heroicons.Generator, icon_dir: "outline/"
|
||||
end
|
||||
|
||||
{:safe, [?\s, safe_k, ?=, ?", safe_v, ?"]}
|
||||
end
|
||||
defmodule Solid do
|
||||
@moduledoc """
|
||||
Solid style icons drawn with fills, packaged as functions.
|
||||
|
||||
{:safe, ["<svg", Phoenix.HTML.Safe.to_iodata(attrs), unquote(body)]}
|
||||
end
|
||||
end
|
||||
For buttons, form elements, and to support text, designed to be rendered at 20x20.
|
||||
"""
|
||||
|
||||
use Heroicons.Generator, icon_dir: "solid/"
|
||||
end
|
||||
end
|
||||
|
81
lib/heroicons/generator.ex
Normal file
81
lib/heroicons/generator.ex
Normal file
@ -0,0 +1,81 @@
|
||||
defmodule Heroicons.Generator do
|
||||
defmacro __using__(icon_dir: icon_dir) do
|
||||
icon_paths =
|
||||
Path.absname(icon_dir, :code.priv_dir(:heroicons))
|
||||
|> Path.join("*.svg")
|
||||
|> Path.wildcard()
|
||||
|
||||
for path <- icon_paths do
|
||||
generate(path)
|
||||
end
|
||||
end
|
||||
|
||||
@doc false
|
||||
def generate(path) do
|
||||
name =
|
||||
Path.basename(path, ".svg")
|
||||
|> String.replace("-", "_")
|
||||
|> String.to_atom()
|
||||
|
||||
icon = File.read!(path)
|
||||
{i, _} = :binary.match(icon, ">")
|
||||
{head, body} = String.split_at(icon, i)
|
||||
|
||||
doc = """
|
||||
)}) {: width=24px}
|
||||
|
||||
Use as a `Phoenix.Component`
|
||||
<.#{name}>
|
||||
|
||||
<.#{name} class="h-6 w-6 text-gray-500">
|
||||
|
||||
Can also be used as a function (deprecated)
|
||||
|
||||
<%= #{name}() %>
|
||||
|
||||
<%= #{name}(class: "h-6 w-6 text-gray-500") %>
|
||||
"""
|
||||
|
||||
quote do
|
||||
@doc unquote(doc)
|
||||
def unquote(name)(assigns_or_opts \\ [])
|
||||
|
||||
def unquote(name)(var!(assigns)) when is_map(var!(assigns)) do
|
||||
var!(attrs) = Phoenix.LiveView.Helpers.assigns_to_attributes(var!(assigns))
|
||||
|
||||
var!(assigns) = Phoenix.LiveView.assign(var!(assigns), :attrs, var!(attrs))
|
||||
|
||||
unquote(
|
||||
EEx.compile_string(head <> "{@attrs}" <> body,
|
||||
engine: Phoenix.LiveView.HTMLEngine,
|
||||
file: __ENV__.file,
|
||||
line: __ENV__.line + 1,
|
||||
module: __ENV__.module,
|
||||
indentation: 0
|
||||
)
|
||||
)
|
||||
end
|
||||
|
||||
def unquote(name)(opts) when is_list(opts) do
|
||||
IO.warn(
|
||||
"<%= #{unquote(name)}(class: \"...\" %> is deprecated, " <>
|
||||
"please use <.#{unquote(name)} class=\"...\" /> inside HEEx templates instead"
|
||||
)
|
||||
|
||||
# opts = Keyword.merge(unquote(default_attrs), opts)
|
||||
|
||||
attrs =
|
||||
for {k, v} <- opts do
|
||||
safe_k =
|
||||
k |> Atom.to_string() |> String.replace("_", "-") |> Phoenix.HTML.Safe.to_iodata()
|
||||
|
||||
safe_v = v |> Phoenix.HTML.Safe.to_iodata()
|
||||
|
||||
{:safe, [?\s, safe_k, ?=, ?", safe_v, ?"]}
|
||||
end
|
||||
|
||||
{:safe, [unquote(head), Phoenix.HTML.Safe.to_iodata(attrs), unquote(body)]}
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
@ -1,10 +0,0 @@
|
||||
defmodule Heroicons.Outline do
|
||||
@moduledoc """
|
||||
Outline style icons drawn with a stroke.
|
||||
|
||||
For primary navigation and marketing sections, designed to be rendered at 24x24.
|
||||
"""
|
||||
@icon_dir "outline/"
|
||||
@default_attrs [xmlns: "http://www.w3.org/2000/svg", fill: "none", viewBox: "0 0 24 24", stroke: "currentColor"]
|
||||
@before_compile Heroicons
|
||||
end
|
@ -1,11 +0,0 @@
|
||||
defmodule Heroicons.Solid do
|
||||
@moduledoc """
|
||||
Solid style icons drawn with fills.
|
||||
|
||||
For buttons, form elements, and to support text, designed to be rendered at 20x20.
|
||||
"""
|
||||
|
||||
@icon_dir "solid/"
|
||||
@default_attrs [xmlns: "http://www.w3.org/2000/svg", viewBox: "0 0 20 20", fill: "currentColor"]
|
||||
@before_compile Heroicons
|
||||
end
|
Reference in New Issue
Block a user