PhoenixPaper.Icon (PhoenixPaper v0.1.0)

Copy Markdown View Source

A thin wrapper around the heroicon classes that mix phx.new already vendors into every Phoenix 1.7+ app (assets/vendor/heroicons + the Tailwind heroicons plugin generated by the installer).

PhoenixPaper does not ship its own icon set or extra dependency: pass the same hero-* class you'd use with the app's default core_components icon helper (e.g. "hero-check", "hero-check-solid", "hero-check-mini").

Summary

Functions

Renders a heroicon. See the module doc.

Functions

pp_icon(assigns)

Renders a heroicon. See the module doc.

Attributes

  • name (:string) (required) - a heroicon class, e.g. "hero-check".
  • paperize (:boolean) - Defaults to true.
  • class (:any) - Defaults to nil.