LanternUI.Components.Icon (LanternUI v0.8.2)

Copy Markdown View Source

A small, curated inline-SVG icon set (Heroicons outline paths, MIT).

Self-contained by design: no icon font, no Tailwind plugin, no host asset pipeline — the SVG ships in the HTML, sized in em so it scales with text and colored via currentColor.

<.icon name="chevron-down" />
<.icon name="calendar-days" class="lui-mr-1" />

The set is deliberately minimal: what LanternUI's own components need plus the everyday few. It is not a general icon system — for that, use your host's icon setup.

An unknown name renders an empty glyph and warns rather than raising — see icon/1.

Summary

Functions

Renders an icon by name. Available: window, minus, funnel, map-pin, calendar-days, arrow-path, check-circle, pencil-square, magnifying-glass, trash, chevron-up, clock, printer, folder-open, chevron-right, document, view-columns, ellipsis-horizontal, bars-3, sparkles, folder, cloud, chevron-up-down, information-circle, cursor-arrow-rays, x-mark, calendar, check, chart-bar, arrow-right, arrow-up-tray, chevron-down, inbox, adjustments-horizontal, globe-alt, chevron-left, presentation-chart-line, arrow-trending-up, plus, squares-2x2, arrow-down-tray, circle-stack, exclamation-circle.

Functions

icon(assigns)

Renders an icon by name. Available: window, minus, funnel, map-pin, calendar-days, arrow-path, check-circle, pencil-square, magnifying-glass, trash, chevron-up, clock, printer, folder-open, chevron-right, document, view-columns, ellipsis-horizontal, bars-3, sparkles, folder, cloud, chevron-up-down, information-circle, cursor-arrow-rays, x-mark, calendar, check, chart-bar, arrow-right, arrow-up-tray, chevron-down, inbox, adjustments-horizontal, globe-alt, chevron-left, presentation-chart-line, arrow-trending-up, plus, squares-2x2, arrow-down-tray, circle-stack, exclamation-circle.

Attributes

  • name (:string) (required) - Icon key from the curated outline set. Must be one of "window", "minus", "funnel", "map-pin", "calendar-days", "arrow-path", "check-circle", "pencil-square", "magnifying-glass", "trash", "chevron-up", "clock", "printer", "folder-open", "chevron-right", "document", "view-columns", "ellipsis-horizontal", "bars-3", "sparkles", "folder", "cloud", "chevron-up-down", "information-circle", "cursor-arrow-rays", "x-mark", "calendar", "check", "chart-bar", "arrow-right", "arrow-up-tray", "chevron-down", "inbox", "adjustments-horizontal", "globe-alt", "chevron-left", "presentation-chart-line", "arrow-trending-up", "plus", "squares-2x2", "arrow-down-tray", "circle-stack", or "exclamation-circle".
  • class (:any) - Extra classes merged onto the root element. Defaults to nil.
  • Global attributes are accepted. Arbitrary HTML/phx-* attributes passed through.