@nexload-sdk/iconcraft
v2.0.0
Published
A powerful CLI tool for effortlessly managing and generating type-safe icon components from Iconify in your projects.
Maintainers
Readme
@nexload-sdk/iconcraft
CLI for managing Iconify icons as local generated React-compatible TSX components.
Install
pnpm add -D @nexload-sdk/iconcraftCLI Commands
Global option for all commands:
--out-dir,-o(default:icons)
Add
pnpm iconcraft add mdi:home
pnpm iconcraft add mdi:home --out-dir src/iconsRemove
pnpm iconcraft remove mdi:homeList
pnpm iconcraft listSync
pnpm iconcraft syncGenerated Files
Inside the output directory (default icons/), IconCraft manages:
*.tsxicon component filesindex.tsbarrel file exportingIcon.ic-meta.jsonregistry (internal manifest)
Example generated usage:
import { MdiHome } from "./icons/mdi-home";
import { Icon } from "./icons";
export function Example() {
return (
<div>
<MdiHome className="size-5" />
<Icon.MdiHome className="size-5" />
</div>
);
}Library API
The package also exports the engine/types for programmatic usage:
IconCraftEngineIconCraftOptionsIconMetaRegistry
Notes
- Icons are fetched from
https://api.iconify.design/...at generation time. - Generated component files are TSX and include
"use client". - The registry file is
.ic-meta.json(noticoncraft.json).
