Skip to content

LucideIconName

LucideIconName = keyof typeof icons

Defined in: packages/core/src/utils.ts:25

Valid Lucide icon name string (e.g. "FileText", "Users", "Settings").

Derived from the icons map exported by lucide-react — the same map the Icon component in @vexcms/react indexes at render time. This is deliberately narrower than the set of names lucide-react exports as components: alias exports (AlertCircleCircleAlert), the *Icon suffixed duplicates (UsersIcon), and non-icon exports (createLucideIcon, icons, Icon) are absent from the map and would render nothing.

Use the canonical PascalCase name as listed on the Lucide site.

const icon: LucideIconName = "CircleAlert"; // ✅ canonical, renders
const alias: LucideIconName = "AlertCircle"; // ❌ alias export, not in `icons`
const bad: LucideIconName = "NotAnIcon"; // ❌ not an icon at all