Skip to content

Icon

Open .md
Live preview

Loading example…

Icon is part of the Atoms set, imported from @jcsoftdev/ui/atoms.

import { Icon } from "@jcsoftdev/ui/atoms";

Single-component entry points tree-shake to just this component: @jcsoftdev/ui/atoms/icon.

<Icon name="calendar" className="size-6 text-ink" />
Prop Type Default Description
name "menu" | "search" | "video" | "download" | "alert" | "grid" | "list" | "calendar" | "folder" | "users" | "pen" | "file" | "coin" | "shield" | "calculator" | "sync" | "sliders" | "bell" | "plus" | "chevron-down" | "chevr… Registry name; ignored when icon is provided.
icon LucideIcon Any lucide icon component.
label string Accessible label. Without it the icon is decorative (aria-hidden).
className string

* marks a required prop.

packages/ui/src/atoms/icon/icon.tsx