Skip to content

Documentation

Installation

Install @kamod-ch/icons and render your first Preact icon in minutes.

@kamod-ch/icons ships typed SVG icons as Preact components. It is independent from kamod-ui, has no React runtime dependency, and only expects Preact as a peer dependency.

Install the package#

Prerequisite: use Preact 10 or newer in the app or package that renders the icons.

npm install @kamod-ch/icons

Workspace install:

npm install @kamod-ch/icons --workspace your-app

Package-manager equivalents:

pnpm add @kamod-ch/icons
bun add @kamod-ch/icons
yarn add @kamod-ch/icons

Render your first icon#

Prefer an explicit set import for production code. It keeps the icon source visible and protects you from future default-set changes.

import { SearchIcon } from "@kamod-ch/icons/shadcn";

export function SearchButton() {
  return (
    <button class="inline-flex items-center gap-2">
      <SearchIcon class="h-4 w-4" />
      Search
    </button>
  );
}

Verify bundling#

The package uses ESM and sideEffects: false, so modern bundlers can tree-shake unused icons.

  • Import from a subpath such as @kamod-ch/icons/shadcn.
  • Avoid importing a whole set namespace when you only need a few icons.
  • Keep icons close to the UI component that uses them.

Next steps#