SigmaKit.Components.Icons (sigma_kit v0.0.6)

Summary

Functions

icon(assigns)

Renders a Heroicon.

Heroicons come in three styles – outline, solid, and mini. By default, the outline style is used, but solid and mini may be applied by using the -solid and -mini suffix.

You can customize the size and colors of the icons by setting width, height, and background color classes.

Icons are extracted from the deps/heroicons directory and bundled within your compiled app.css by the plugin in your assets/tailwind.config.js.

Examples

<.icon name="hero-x-mark-solid" />
<.icon name="hero-arrow-path" class="ml-1 w-3 h-3 animate-spin" />

Attributes

  • name (:string) (required) - The name of the icon.
  • class (:any) - Additional classes to apply to the icon. Defaults to nil.
  • spin (:boolean) - Defaults to false.

Slots

  • inner_block - Content to be aligned with the icon.