CinderUI.Icons (cinder_ui v0.1.0)

Copy Markdown View Source

Optional Lucide icon integration for Cinder UI.

This module exposes a single icon/1 function component that dispatches to lucide_icons when the dependency is available.

No sync task is required. Available icon names are read from lucide_icons.icon_names/0 and cached automatically.

Add lucide_icons to your application dependencies to enable icon rendering:

{:lucide_icons, "~> 2.0"}

If the dependency is missing, icon/1 raises a descriptive error.

View live Icons examples and component docs.

Summary

Functions

Renders a Lucide icon by name.

Functions

icon(assigns)

Renders a Lucide icon by name.

name accepts either kebab-case ("chevron-down") or snake_case ("chevron_down").

Example

<.icon name="chevron-down" class="size-4 text-muted-foreground" aria-hidden="true" />

References

Screenshot

icon/1 screenshot

View live examples and full component docs.

Attributes

  • name (:string) (required)
  • class (:string) - Defaults to nil.
  • Global attributes are accepted.