Your next page is taking shape...

Opening Your Next Page…

Loading the guide and preparing its examples for you to explore. The page will appear here automatically when it’s ready, so you can keep this view open without refreshing.

Made for Preact. Built to be yours.

kamod-icons · Typed SVG · Multiple Icon Sets

Find, Copy, and Ship Production-Ready Icons Faster

Lightweight, tree-shakeable Preact icon components across shadcn, Lucide, Heroicons, Tabler, Iconoir, and Reicon — preferred by Kamod UI blocks over lucide-preact.

Choose a consistent family for related actions and let currentColor connect the icons to your theme. Treat icons as Part of a Control’s Meaning, with a readable label or an accessible name wherever an action would otherwise be ambiguous. Pair it with the Component Library when building your interface. Continue with the Full Documentation for the complete package reference.


What the Package Brings

Choose icons for meaning first and appearance second. Keep one coherent family within a toolbar, then let size, spacing and semantic color connect it to the surrounding interface.

Choose the Right Approach

A Labeled Action

Pair a decorative SVG with a visible label inside a core control.

The icon reinforces the text; it should not duplicate the accessible name.

An Icon-Only Action

Give the surrounding button a precise aria-label and visible focus treatment.

Use a familiar symbol, but do not rely on familiarity as its only explanation.

A Status or Category

Pair the symbol with text and use semantic theme colors.

Neither color nor shape alone should be the only way to understand a critical status.

Typed Components

Every icon is a Preact SVG component with size, class, style, title, and currentColor support.

Wrap interactive icons in real buttons or links. The SVG draws the symbol; the surrounding control supplies focus, keyboard behavior and a comfortable click target.

Stable Subpaths

Import from @kamod-ch/icons/shadcn, /lucide, or outline/solid variants so production builds stay explicit.

Copy the exact exported name and family from the catalog. Keep related imports together so a filled symbol is not accidentally mixed into a group of outline controls.

Design-Token Friendly

Icons inherit color via currentColor and fit cleanly into Kamod UI themes and blocks.

Inherit the control's text color for ordinary actions. Reserve emphasis for meaningful state, and pair error or success symbols with text rather than communicating through color alone.

Installation

Add the icons to your existing Preact app. Install @kamod-ch/icons in the workspace that renders them and keep Preact available as its peer dependency. The SVG components can sit inside your existing buttons and links; choosing an icon family does not require another UI framework.

Pick the family before copying an import. The family is a subpath of this package, such as @kamod-ch/icons/shadcn, rather than a separate installation. Use the Icon Catalog to find an exact exported name, then follow the Usage Example to check its size and alignment in context.

Install PackagesTerminal
pnpm add @kamod-ch/icons preact

Check Your Environment

Use your existing package manager and keep the peer dependencies aligned with your application. Compare package.json and your lockfile with the documentation for the version you install; add the package once at the workspace boundary that uses it.

Keep the First Change Small. Start with the usage example, run your project’s typecheck and build, then connect it to a real screen. The Package Overview helps you decide how companion libraries fit together.

Usage

Make the chosen family visible in the import. An explicit set path such as @kamod-ch/icons/shadcn keeps related controls consistent and makes later replacements easier to review. The example renders SearchIcon with a deliberate size; its currentColor follows the surrounding text color.

Let the control own the action. Keep a decorative SVG hidden from assistive technology with aria-hidden, and give an icon-only button an aria-label that describes what it does. Continue with the Search Action Example to connect an actual callback, then compare the finished controls using the Integration Review and Accessibility Notes.

src/example.tsx5 lines
import { SearchIcon } from "@kamod-ch/icons/shadcn";

export function Example() {
  return <SearchIcon size={20} aria-hidden />;
}

Read the Example

Follow the value from its definition to the interface. Each part below explains a decision to keep when adapting the example.

Choose a Family Deliberately

The subpath is part of the design decision. Check the exact export in the icon catalog and keep related controls in one family; similarly named icons from different families can have different silhouettes and visual weight.

Import SetupTypeScript
import { SearchIcon } from "@kamod-ch/icons/shadcn";
Separate the Symbol from the Target

The size controls the SVG, not the clickable area. Give the surrounding button enough padding and an obvious focus state. Increasing the icon itself is not a substitute for a comfortable pointer target.

Usage PatternTypeScript
<SearchIcon size={20} aria-hidden="true" />
Name the Action Once

An icon-only control needs a name on the button. When visible text already names the action, keep the SVG decorative so screen readers do not announce the same meaning twice. A tooltip can clarify an action but does not replace its accessible name.

Usage PatternTypeScript
<Button aria-label="Search"><SearchIcon size={20} aria-hidden="true" /></Button>

Build a Consistent Search Action

Use a core button for interaction and a catalog icon for the visual cue. This keeps keyboard behavior, spacing and themes in the component system. The callback belongs to the surrounding application, so the example can open a dialog or navigate without assuming a router.

src/components/SearchAction.tsx11 lines
import { SearchIcon } from "@kamod-ch/icons/shadcn";
import { Button } from "@kamod-ch/ui";

export function SearchAction({ onSearch }: { onSearch: () => void }) {
  return (
    <Button variant="outline" onClick={onSearch}>
      <SearchIcon size={18} aria-hidden="true" />
      Search
    </Button>
  );
}

Try the Boundaries. Compare the action beside its neighbors in light and dark themes. Keep the label when there is room; if a compact toolbar hides it, supply an accessible name on the button and retain the same action and focus behavior.

Integrate with Your Application

Use One Visual Language for Each Group of Controls. Match optical size, stroke or fill treatment, and spacing across toolbars. The SVG can stay small while the surrounding button provides a comfortable target.

Keep set imports explicit and verify the exported component name before copying an example. Use the catalog’s import snippet as your starting point; similarly named symbols from different icon sets are not necessarily interchangeable.

Let the surrounding control own the interaction. Use aria-hidden for decorative SVGs and put an aria-label on an icon-only button. Check the icon and its focus indicator against both light and dark surfaces.

Choose the Owner and Lifetime

Keep icon choices close to the controls that use them, or put a small domain-specific mapping in one module when the same statuses repeat. Avoid importing every icon into a runtime name lookup for a few known actions. Explicit imports make it easier to audit family choices and understand which symbols the page needs.

Account for the Environment

Review the complete control under light and dark themes, browser zoom and keyboard focus. currentColor should normally follow the surrounding semantic text color. Size, stroke weight and internal SVG padding all affect perceived weight, so compare related icons at their actual rendered size rather than matching dimensions alone.

Connect the Pieces. Component Styles — Apply a coherent hierarchy of icon sizes, button variants and surface treatments across complete layouts.

Integration goal The final pass

What a Good Integration Looks Like

See the example

Review the finished controls together, not as isolated SVGs. Compare optical size, baseline alignment and focus visibility in the actual toolbar or navigation group.

One visual rhythm
Use one family and a shared size. Compare stroke weight and alignment beside the actual text.
A clear purpose
Keep a visible label when it fits. Give an icon-only button an aria-label that describes its action.
Focus you can follow
Use Tab to move across the controls. Check that the focus ring stays clear in both light and dark mode.

When Something Behaves Differently

Start with the smallest failing interaction. Compare a fresh page with the same page after a change or reload, and keep the package version in your reproduction.

An import does not resolve
Confirm the exact family subpath and exported name against the installed version. A similarly named icon in another library is not evidence that this package exports it.
The symbol looks faint or misaligned
Inspect inherited color, flex shrinking and the line height of adjacent text. Keep the SVG from shrinking in a crowded control and adjust surrounding layout before editing its paths.
A screen reader announces an action twice
Keep the SVG decorative when the parent already has a visible label or aria-label. Test the control's accessible name rather than assuming an SVG title improves every use case.

If the behavior still differs from the documented API, Check Existing Issues before opening a report. Include the expected result, actual result, package version and a small reproduction without private application data.

API Reference

This page is a Kamod UI overview. Browse every set, search icons, and copy imports from the dedicated kamod-icons docs.

Use this page to understand the integration, then consult the Full API Reference on Live Docs for exact signatures and supported options. Compare those details with the version in your lockfile before adapting an example.

Browse the Full Icon Catalog

Open the kamod-icons docs for set tables, usage guides, and a searchable icon browser.

  • Before Choosing an API: read its input types, return values and default behavior.
  • Before Shipping: review lifecycle or server-rendering notes for the features you use.
  • When Behavior Differs: reduce the case to a small example and include your package version in the report.
Continue with the dedicated package documentation.Open Live Docs

Accessibility Notes

Decorative icons should use aria-hidden. Meaningful icons need a title or an accessible name on the surrounding control (for example aria-label on an icon-only button).

Before You Ship

  • Check that every icon-only action has a meaningful accessible name.
  • Compare size and alignment with nearby text and icons in the same family.
  • Review hover, focus and disabled states without relying on color alone.

Review the result with Real Content and Keyboard Input. Keep visible labels, loading and error feedback, and focus behavior in sync with the state your application exposes.

Take the Guide with You

Keep the Examples, Integration Decisions and Troubleshooting Notes together in your project, or share them with a coding assistant. This reference works with any assistant; no model-specific setup is needed. Check the installed version and your project’s conventions before applying a suggestion.

Keep It HandyReady for your project
DownloadMarkdown
icons-package-reference.md163 lines
# Icons — integration reference

Lightweight, tree-shakeable Preact icon components across shadcn, Lucide, Heroicons, Tabler, Iconoir, and Reicon — preferred by Kamod UI blocks over lucide-preact.

Package: @kamod-ch/icons

## Choose an approach

Choose icons for meaning first and appearance second. Keep one coherent family within a toolbar, then let size, spacing and semantic color connect it to the surrounding interface.

### A labeled action

Pair a decorative SVG with a visible label inside a core control.

The icon reinforces the text; it should not duplicate the accessible name.

### An icon-only action

Give the surrounding button a precise aria-label and visible focus treatment.

Use a familiar symbol, but do not rely on familiarity as its only explanation.

### A status or category

Pair the symbol with text and use semantic theme colors.

Neither color nor shape alone should be the only way to understand a critical status.

## Installation

**Add the icons to your existing Preact app.** Install `@kamod-ch/icons` in the workspace that renders them and keep Preact available as its peer dependency. The SVG components can sit inside your existing buttons and links; choosing an icon family does not require another UI framework.

**Pick the family before copying an import.** The family is a subpath of this package, such as `@kamod-ch/icons/shadcn`, rather than a separate installation. Use the [Icon Catalog](https://ui.kamod.ch/docs/icons-package/installation#api-reference) to find an exact exported name, then follow the [Usage Example](https://ui.kamod.ch/docs/icons-package/installation#usage) to check its size and alignment in context.

```bash
pnpm add @kamod-ch/icons preact
```

## Starting example

**Make the chosen family visible in the import.** An explicit set path such as `@kamod-ch/icons/shadcn` keeps related controls consistent and makes later replacements easier to review. The example renders `SearchIcon` with a deliberate `size`; its `currentColor` follows the surrounding text color.

**Let the control own the action.** Keep a decorative SVG hidden from assistive technology with `aria-hidden`, and give an icon-only button an `aria-label` that describes what it does. Continue with the [Search Action Example](https://ui.kamod.ch/docs/icons-package/installation#put-it-to-work) to connect an actual callback, then compare the finished controls using the [Integration Review](https://ui.kamod.ch/docs/icons-package/installation#icons-integration-review) and [Accessibility Notes](https://ui.kamod.ch/docs/icons-package/installation#accessibility).

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

export function Example() {
  return <SearchIcon size={20} aria-hidden />;
}
```

### Choose a Family Deliberately

The subpath is part of the design decision. Check the exact export in the icon catalog and keep related controls in one family; similarly named icons from different families can have different silhouettes and visual weight.

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

### Separate the Symbol from the Target

The size controls the SVG, not the clickable area. Give the surrounding button enough padding and an obvious focus state. Increasing the icon itself is not a substitute for a comfortable pointer target.

```tsx
<SearchIcon size={20} aria-hidden="true" />
```

### Name the Action Once

An icon-only control needs a name on the button. When visible text already names the action, keep the SVG decorative so screen readers do not announce the same meaning twice. A tooltip can clarify an action but does not replace its accessible name.

```tsx
<Button aria-label="Search"><SearchIcon size={20} aria-hidden="true" /></Button>
```

## Build a Consistent Search Action

Use a core button for interaction and a catalog icon for the visual cue. This keeps keyboard behavior, spacing and themes in the component system. The callback belongs to the surrounding application, so the example can open a dialog or navigate without assuming a router.

File: src/components/SearchAction.tsx

```tsx
import { SearchIcon } from "@kamod-ch/icons/shadcn";
import { Button } from "@kamod-ch/ui";

export function SearchAction({ onSearch }: { onSearch: () => void }) {
  return (
    <Button variant="outline" onClick={onSearch}>
      <SearchIcon size={18} aria-hidden="true" />
      Search
    </Button>
  );
}
```

Compare the action beside its neighbors in light and dark themes. Keep the label when there is room; if a compact toolbar hides it, supply an accessible name on the button and retain the same action and focus behavior.

## Ownership and environment

Keep icon choices close to the controls that use them, or put a small domain-specific mapping in one module when the same statuses repeat. Avoid importing every icon into a runtime name lookup for a few known actions. Explicit imports make it easier to audit family choices and understand which symbols the page needs.

Review the complete control under light and dark themes, browser zoom and keyboard focus. currentColor should normally follow the surrounding semantic text color. Size, stroke weight and internal SVG padding all affect perceived weight, so compare related icons at their actual rendered size rather than matching dimensions alone.

Review the finished controls together, not as isolated SVGs. Compare optical size, baseline alignment and focus visibility in the actual toolbar or navigation group.

## Troubleshooting

### An import does not resolve

Confirm the exact family subpath and exported name against the installed version. A similarly named icon in another library is not evidence that this package exports it.

### The symbol looks faint or misaligned

Inspect inherited color, flex shrinking and the line height of adjacent text. Keep the SVG from shrinking in a crowded control and adjust surrounding layout before editing its paths.

### A screen reader announces an action twice

Keep the SVG decorative when the parent already has a visible label or aria-label. Test the control's accessible name rather than assuming an SVG title improves every use case.

## Resources

- [Dedicated documentation](https://kamod-ch.github.io/kamod-icons/) — Exact signatures, supported options and deeper examples.

- [Source & release history](https://github.com/kamod-ch/kamod-icons) — Implementation, release notes and the project’s issue tracker.

- [Published package](https://www.npmjs.com/package/@kamod-ch/icons) — Compare the version and peer requirements with your lockfile.

Icon artwork can carry its own upstream notices. Check the selected family’s source and license information in the repository before redistributing assets; the package’s license does not replace notices attached to individual icon sets.

When copying or distributing source, retain the applicable license and attribution notices from the version you use.

## Companion packages

An icon becomes useful when it explains a real action or state. These companions connect the SVG to behavior, language and a consistent source of truth.

### Hooks — Put the symbol to work

[`@kamod-ch/hooks`](https://ui.kamod.ch/docs/hooks-package/installation)

Connect a search, expand or favorite action to component-owned behavior. Let the surrounding button handle interaction and focus; useToggle can supply a simple state without making the SVG itself interactive.

### i18n — Give every action a voice

[`@kamod-ch/i18n`](https://ui.kamod.ch/docs/i18n-package/installation)

Translate visible labels and icon-only accessible names together. Choose words that describe the action rather than the picture, and review directional symbols separately when supporting a right-to-left interface.

### State — Make status tell one story

[`@kamod-ch/state`](https://ui.kamod.ch/docs/state-package/installation)

Map a workflow’s state to a label and an icon in one view helper. Saving, saved and failed should all reflect the same store value; avoid a second status flag that can disagree with the operation it describes.

## Small icon. Clear purpose.

Choose a family in the catalog, copy the exact import and try it inside a real Button. Compare it beside neighboring actions at the actual rendered size; consistent visual weight matters more than matching SVG dimensions alone.

[Build an icon action](https://ui.kamod.ch/docs/button/installation)

Confirm the accessible name, keyboard focus and contrast in both color modes.

[All packages](https://ui.kamod.ch/docs/packages) · [The wider ecosystem](https://ui.kamod.ch/docs/ecosystem)
Display changes only the view. Copy and download include the complete Markdown reference.

Sources & Attribution

This integration guide accompanies @kamod-ch/icons, maintained in the Kamod ecosystem. The Dedicated Documentation is the reference for package APIs; examples here show how those APIs fit into a Kamod UI application.

Keep the Source Close

Look it up, then build

Icon artwork can carry its own upstream notices. Check the selected family’s source and license information in the repository before redistributing assets; the package’s license does not replace notices attached to individual icon sets.

When copying or distributing source, retain the applicable license and attribution notices from the version you use.

Small Icon. Clear Purpose.

Choose a family in the catalog, copy the exact import and try it inside a real Button. Compare it beside neighboring actions at the actual rendered size; consistent visual weight matters more than matching SVG dimensions alone.

Confirm the accessible name, keyboard focus and contrast in both color modes.

Take the Next Useful Step

You have the pieces. Put them into one real interaction, keep its state in one place, and check the result with the content your application will actually show.

Connect the Foundation

Return to Choose Your Companion Packages to connect this reference to a working screen. Keep global CSS in one entrypoint and import only the components that screen needs.

Build the Surrounding Screen

Find a neighboring interaction in the Component Library, or start with a complete Block. Replace sample content and destinations before refining the layout; a local class change can stay with the composition.

Make the Result Hold Up

Use shared theme roles for changes that belong everywhere. Then review the whole journey: keyboard focus, long labels, narrow screens and a clear way to recover when something fails.

Keep a link to the source and note your intentional changes. Your next edit should begin with a clear decision, not another search.