Installation

Yugami UI is published as two packages on npm:

npm install @yugami/ui-react @yugami/ui-react

Or with pnpm:

pnpm add @yugami/ui-react @yugami/ui-react

Global Styles

Your globals.css must import Tailwind v4 and scan the package for utility classes:

@import "tailwindcss";
@source "../node_modules/@yugami/ui-react/dist/**/*.{js,mjs}";

Define all CSS custom properties inside @theme inline and :root / .dark:

@import "tailwindcss";
@import "tw-animate-css";
@source "../node_modules/@yugami/ui-react/dist/**/*.{js,mjs}";

@custom-variant dark (&:is(.dark *));

@theme inline {
  --color-background: var(--background);
  --color-foreground: var(--foreground);
  --color-card: var(--card);
  --color-card-foreground: var(--card-foreground);
  --color-popover: var(--popover);
  --color-popover-foreground: var(--popover-foreground);
  --color-primary: var(--primary);
  --color-primary-foreground: var(--primary-foreground);
  --color-secondary: var(--secondary);
  --color-secondary-foreground: var(--secondary-foreground);
  --color-muted: var(--muted);
  --color-muted-foreground: var(--muted-foreground);
  --color-accent: var(--accent);
  --color-accent-foreground: var(--accent-foreground);
  --color-destructive: var(--destructive);
  --color-destructive-foreground: var(--destructive-foreground);
  --color-border: var(--border);
  --color-input: var(--input);
  --color-ring: var(--ring);
  --color-chart-1: var(--chart-1);
  --color-chart-2: var(--chart-2);
  --color-chart-3: var(--chart-3);
  --color-chart-4: var(--chart-4);
  --color-chart-5: var(--chart-5);
  --radius-sm: calc(var(--radius) * 0.6);
  --radius-md: calc(var(--radius) * 0.8);
  --radius-lg: var(--radius);
  --radius-xl: calc(var(--radius) * 1.4);
  --radius-2xl: calc(var(--radius) * 1.8);
  --radius-3xl: calc(var(--radius) * 2.2);
  --radius-4xl: calc(var(--radius) * 2.6);
  --color-sidebar: var(--sidebar);
  --color-sidebar-foreground: var(--sidebar-foreground);
  --color-sidebar-primary: var(--sidebar-primary);
  --color-sidebar-primary-foreground: var(--sidebar-primary-foreground);
  --color-sidebar-accent: var(--sidebar-accent);
  --color-sidebar-accent-foreground: var(--sidebar-accent-foreground);
  --color-sidebar-border: var(--sidebar-border);
  --color-sidebar-ring: var(--sidebar-ring);
}

:root {
  --radius: 0.625rem;
  --background: hsl(0 0% 100%);
  --foreground: hsl(0 0% 14%);
  --card: hsl(0 0% 100%);
  --card-foreground: hsl(0 0% 14%);
  --popover: hsl(0 0% 100%);
  --popover-foreground: hsl(0 0% 14%);
  --primary: hsl(0 0% 20%);
  --primary-foreground: hsl(0 0% 98%);
  --secondary: hsl(0 0% 97%);
  --secondary-foreground: hsl(0 0% 20%);
  --muted: hsl(0 0% 97%);
  --muted-foreground: hsl(0 0% 56%);
  --accent: hsl(0 0% 97%);
  --accent-foreground: hsl(0 0% 20%);
  --destructive: hsl(0 72% 51%);
  --border: hsl(0 0% 92%);
  --input: hsl(0 0% 92%);
  --ring: hsl(0 0% 71%);
  --chart-1: oklch(0.646 0.222 41.116);
  --chart-2: oklch(0.6 0.118 184.704);
  --chart-3: oklch(0.398 0.07 227.392);
  --chart-4: oklch(0.828 0.189 84.429);
  --chart-5: oklch(0.769 0.188 70.08);
  --sidebar: hsl(0 0% 98%);
  --sidebar-foreground: hsl(0 0% 14%);
  --sidebar-primary: hsl(0 0% 20%);
  --sidebar-primary-foreground: hsl(0 0% 98%);
  --sidebar-accent: hsl(0 0% 97%);
  --sidebar-accent-foreground: hsl(0 0% 20%);
  --sidebar-border: hsl(0 0% 92%);
  --sidebar-ring: hsl(0 0% 71%);
}

.dark {
  --background: oklch(0.145 0 0);
  --foreground: oklch(0.985 0 0);
  --card: oklch(0.205 0 0);
  --card-foreground: oklch(0.985 0 0);
  --popover: oklch(0.205 0 0);
  --popover-foreground: oklch(0.985 0 0);
  --primary: oklch(0.922 0 0);
  --primary-foreground: oklch(0.205 0 0);
  --secondary: oklch(0.269 0 0);
  --secondary-foreground: oklch(0.985 0 0);
  --muted: oklch(0.269 0 0);
  --muted-foreground: oklch(0.708 0 0);
  --accent: oklch(0.269 0 0);
  --accent-foreground: oklch(0.985 0 0);
  --destructive: oklch(0.704 0.191 22.216);
  --border: oklch(1 0 0 / 10%);
  --input: oklch(1 0 0 / 15%);
  --ring: oklch(0.556 0 0);
  --chart-1: oklch(0.488 0.243 264.376);
  --chart-2: oklch(0.696 0.17 162.48);
  --chart-3: oklch(0.769 0.188 70.08);
  --chart-4: oklch(0.627 0.265 303.9);
  --chart-5: oklch(0.645 0.246 16.439);
  --sidebar: oklch(0.205 0 0);
  --sidebar-foreground: oklch(0.985 0 0);
  --sidebar-primary: oklch(0.92 0.02 60);
  --sidebar-primary-foreground: oklch(0.985 0 0);
  --sidebar-accent: oklch(0.269 0 0);
  --sidebar-accent-foreground: oklch(0.985 0 0);
  --sidebar-border: oklch(1 0 0 / 10%);
  --sidebar-ring: oklch(0.556 0 0);
}

@layer base {
  * {
    @apply border-border outline-ring/50;
  }
  body {
    @apply bg-background text-foreground;
  }
}

*::-webkit-scrollbar {
  width: 6px;
}

*::-webkit-scrollbar-track {
  background: transparent;
}

*::-webkit-scrollbar-thumb {
  border-radius: 9999px;
  background: var(--border);
}

*::-webkit-scrollbar-thumb:hover {
  background: var(--muted-foreground);
}

See the full reference in yugami-prime/app/globals.css.

Quick Start

Wrap your app with the providers, then use components:

import { TooltipProvider, Button } from "@yugami/ui-react";

function App() {
  return (
    <TooltipProvider>
      <Button onClick={() => alert("Hello!")}>
        Click me
      </Button>
    </TooltipProvider>
  );
}

Icons

Over 1,000 icons available through @yugami/ui-icons:

npm install @yugami/ui-icons

Or with pnpm:

pnpm add @yugami/ui-icons

Import icons by name and size them with className:

import { Palette, Moon, Sun, Search, Bell, User } from "@yugami/ui-icons";

function ThemeToggle() {
  return <Palette className="h-4 w-4" />;    // 16px
}

Use DynamicIcon to render icons by name at runtime:

import { DynamicIcon } from "@yugami/ui-icons";

<DynamicIcon name="Palette" className="h-4 w-4" />

Components

Browse all 65+ components with live examples and import snippets:

import { Button, Card, Input, Tabs, Dialog, Sidebar } from "@yugami/ui-react";