Iconex.Set behaviour (iconex v0.1.0)

The behaviour every icon set implements, and the registry of known sets.

Each set is identified by an atom (:lucide, ...) that names its component function (Iconex.lucide/1), its config key (config :iconex, lucide: [...]), its data file (priv/sets/lucide.json) and its sprite symbol prefix (#lucide-house).

Data files

mix iconex.download SET fetches a set's upstream data and writes it in a normalized form shared by every set:

{"set": "lucide", "version": "1.47.0",
 "icons": {"house": {"viewBox": "0 0 24 24",
                     "nodes": [["path", {"d": "..."}], ...]}}}

Nodes are [tag, attrs] or [tag, attrs, children] with string attribute values.

Adding an icon set

Write Iconex.Set.<Name> implementing this behaviour.
Register it in modules/0.
Add a component function named after the id in Iconex, wrapped in if :<id> in @sets do ... end.
Add its pinned version to @set_versions in mix.exs and its data file to package[:files].
Add its license text under licenses/.

Summary

Types

icon()

%{"viewBox" => String.t(), "nodes" => [node]}

Callbacks

data_url(version)

The URL of the upstream data for version.

docs_url()

Where users can look up the set's icon names.

normalize(decoded)

Converts the decoded upstream data to %{name => icon}.

npm_package()

The npm package the set's data is downloaded from.

symbol_attrs()

Presentation attributes placed on every <symbol> of the set.

Functions

ids()

Known set ids.

module!(id)

The module implementing set id.

modules()

Known sets, keyed by id.

read(path)

Reads a normalized data file written by mix iconex.download.