Skip to content

UI Kit

::: warning Status

Foundations available. The first components (button, input, card, badge, alert, toast, tabs, select, modal new) live in the private packages/ui workspace (@katanakit/ui) and are styled with the SCSS framework vendored in katanakit-js (scss/). The package is not published to npm yet — inside this repo you import it by name, outside it you cannot install it. The rest of the kit is still planned; the name Katana UI is provisional.

The full SCSS framework reference lives in this section too: design tokens, colors, breakpoints, dark mode, @apply, layout mixins, every utility class and the complete API reference.

:::

Import the stylesheet once (it ships the full vendored framework, dark-theme tokens and the .* component classes) before using any factory:

import "@katanakit/ui/styles.css";
import { useButton, useInput, useCard, useBadge, useAlert, toast } from "@katanakit/ui";
document.body.append(
useButton({ label: "Save" }),
useInput({ label: "Email", type: "email" }).root,
);
toast.success("Saved.");

Every snippet below assumes that CSS import — without it the components render as unstyled markup. Component classes are unprefixed (.btn, .card, .toast, …) and live inside @layer katana, so they never win an import-order accident against another framework — see Architecture. Dark mode follows the KatanaKit contract: set data-theme="dark" on the root element (the ThemeService in katanakit-js owns that attribute).

Katana UI is the planned UI kit for KatanaKit: design tokens, headless primitives, components, blocks, layouts and full application pages that reuse the toolkit’s core services instead of rebuilding them.

KatanaKit already owns the invisible parts of a product — HTTP with Safe Results, storage strategies, reactive signals, theming, observers, sensors, workers and the AI assistant. Every dashboard, storefront and operational console needs exactly those capabilities on every screen. The kit exists so a team can assemble those screens from the same primitives the toolkit already guarantees.

Principle What it means
Framework-agnostic core Tokens, primitives and styles are vanilla TypeScript and CSS. Framework bindings are thin adapters.
Token-first styling Components consume CSS custom properties only. Tailwind and daisyUI are optional presets, never a requirement.
SSR-safe Every module guards browser-only APIs and hydrates without layout shifts.
Tree-shakeable Per-component entry points and no side effects on import.
Accessible by default WCAG 2.2 AA target: semantics, focus management, keyboard flows, reduced motion.
Safe Result aware Data-bound components speak the same { data, error, ok } contract as the HTTP client.
UI need KatanaKit service
Tables, filters, pagination FetchApiManager, useGetApi
Theme switching and persistence ThemeService, useInitTheme
Remembered UI state StorageService strategies
Reactive widgets and stores ReactiveService signals
Lazy blocks, infinite scroll ObserverService, LazyLoaderService
Device capabilities SensorsUtils, ViewportService
Chat and Gen-AI surfaces AssistantService, adapters/assistant
Heavy computation WorkerService
Formatting numbers, dates, currency FormatterService, DatesService
  • Application pages — eight dashboard layouts, a landing page, ten e-commerce pages, a file manager, a chat app, a four-page Gen-AI app and the Agentic Storage UI.
  • Account flows — four auth pages, profile settings and a support/FAQ page.
  • Building blocks — a foundation component example, 15+ ready-to-use UI blocks, 50+ common layout examples and 100+ interaction examples with plugin integrations.
  • Theming — token-first themes with an optional Tailwind/daisyUI preset.
  • Charts — ApexCharts behind a swappable adapter.
  • LLM files — machine-readable artifacts so agents can consume the kit.
  • Backend and business logic (the kit consumes APIs, it does not own them).
  • Real datasets, seed content and domain-specific integrations.
  • Framework state managers (the reactive signals kernel covers the kit’s needs).
  • Components — button, input, card, badge, alert and toast foundations.
  • Tailwind Components — 592 Tailwind CSS 4 snippets in HTML and React TSX.
  • HyperUI — free Tailwind catalog, vendored with live previews.
  • SCSS framework — the framework behind the kit (vendored from katanakit-css@0.12.5): tokens, utilities, mixins and API reference.
  • Testing — the two suites that cover the kit, and what only a browser can prove.
  • Architecture — layers, theming, distribution and patterns.
  • Inventory — every planned page, block, layout and interaction.
  • LLM files — machine-readable artifacts for AI agents.
  • Roadmap — delivery phases and exit criteria.