Augeo AI Docs
Augeo Design SystemGetting Started

Install Components

How to consume Augeo-themed React components in your app.

Augeo components ship from @kigo-digital/design-system as a Vite-built library — ESM + CJS bundles with type declarations. Brand is applied with ThemeProvider and a complete DesignSystemTheme object.

Prerequisites

  1. GitHub Packages auth. See Tokens → Prerequisites — same .npmrc setup applies.
  2. React 19 host app. This package targets React 19; we don't ship a React 18 fallback.

Install

npm install @kigo-digital/design-system

The package declares these as peerDependencies — your host app must provide them:

{
  "lucide-react": "^1.57.0",
  "@radix-ui/react-slot": "^1.2.2",
  "class-variance-authority": "^0.7.1",
  "clsx": "^2.1.1",
  "react": ">=18.0.0",
  "react-dom": ">=18.0.0",
  "tailwind-merge": "^3.0.0"
}

If you're already on the standard React + shadcn stack you likely have all of them. If not, install at the same versions.

Apply the Augeo brand

Augeo defaults are included in styles.css. Import it once and wrap the app in ThemeProvider.

// app/layout.tsx (Next.js) — or src/main.tsx (Vite)
import '@kigo-digital/design-system/styles.css';
import { ThemeProvider, augeoTheme } from '@kigo-digital/design-system';

export default function RootLayout({ children }: { children: React.ReactNode }) {
  return (
    <html lang="en">
      <body>
        <ThemeProvider theme={augeoTheme}>
          {children}
        </ThemeProvider>
      </body>
    </html>
  );
}

Inside the provider, semantic CSS variables resolve to Augeo values — Midnight Blue + Neon Green by default. Re-theme by passing a different DesignSystemTheme.

Import components

import {
  Button,
  ChatBubble,
  ChatInput,
  Input,
  OfferCard,
  SelectionChip,
  Tag,
} from '@kigo-digital/design-system';

export function Example() {
  return (
    <OfferCard
      primaryLabel="Brand Name"
      secondaryLabel="Starting at 5 Points"
      tag={<Tag category="featured">Featured</Tag>}
    />
  );
}

Every component is documented in Components — props, variants, when-to-use guidance, accessibility notes, and live previews. Each one declares the exact Augeo tokens it reads in its README frontmatter.

Composition rules

A few non-obvious constraints from individual component contracts:

  • ChatInput is fully controlled — pass value, onValueChange, onSend. Don't try to manage internal state.
  • SelectionChip groups require a parent <div role="group" aria-label="…"> — single chips don't have group semantics.
  • OfferCard Tag overlay is a single slot; don't stack more than one Tag per card.
  • No raw hex in consumer overrides. Re-theme via the partner-scope variables; never override component styles directly.

Each component's README carries its contract: name, type, description, and optionally figma and interaction_states. See docs/standards/authoring-components.md for the schema — the design-agent in augeo-ai-server reads these directly to generate code.

SSR / hydration

Augeo interactive components hydrate fine in Next.js App Router. Wrap app content with ThemeProvider at a client boundary when using React Server Components.

Available components

See Components for the live list with previews. A component on its way out carries @deprecated on its export, per the authoring standard.