xertica-ui 2.1.2 → 2.1.3

package/templates/CLAUDE.md

@@ -1,172 +1,182 @@
-# Xertica UI — Project Rules
-
-This project uses **xertica-ui**, an enterprise React design system built on Tailwind CSS v4, Radix UI, and Lucide Icons.
-
-> For the complete component reference, read `node_modules/xertica-ui/llms-full.txt`.
-> For a compact quick-reference, read `node_modules/xertica-ui/llms-compact.txt`.
-> For component selection guidance, read `node_modules/xertica-ui/docs/decision-tree.md`.
-
----
-
-## Import Rules
-
-Always use the most specific subpath — never import from a category you don't need:
-
-```tsx
-import { Button, Card, Input, Badge, Table, Dialog } from 'xertica-ui/ui';
-import { Sidebar, Header }                           from 'xertica-ui/layout';
-import { XerticaProvider, XerticaLogo, ThemeToggle } from 'xertica-ui/brand';
-import { XerticaAssistant, generateDemoResponse }    from 'xertica-ui/assistant';
-import { VideoPlayer, AudioPlayer }                  from 'xertica-ui/media';
-import { useLayout, useOptionalLayout, useTheme }    from 'xertica-ui/hooks';
-import 'xertica-ui/style.css'; // import once at root only
-```
-
-The root `from 'xertica-ui'` remains valid for backward compatibility, but scaffolded project code must prefer the subpaths above.
-
-Icons are **never** from xertica-ui — always use `lucide-react`:
-
-```tsx
-import { Home, Settings, Plus, Trash2, ChevronRight } from 'lucide-react';
-```
-
----
-
-## Non-Negotiable Rules
-
-### HTML — never use raw elements for UI
-| ❌ Never | ✅ Always |
-|---|---|
-| `<button>` | `<Button>` from `xertica-ui/ui` |
-| `<input>` | `<Input>` from `xertica-ui/ui` |
-| `<select>` | `<Select>` from `xertica-ui/ui` |
-| `<h1>` / `<h2>` for page headers | `<PageHeader><PageHeaderHeading>` |
-| `<div class="card ...">` | `<Card>` from `xertica-ui/ui` |
-| custom scrollbar div | `<ScrollArea>` from `xertica-ui/ui` |
-
-### Colors — never use raw values
-| ❌ Never | ✅ Always |
-|---|---|
-| `bg-blue-500`, `text-gray-700` | `bg-primary`, `text-muted-foreground` |
-| `#3b82f6`, `rgb(...)` | `var(--primary)` |
-| `rounded-lg`, `rounded-xl` | `rounded-[var(--radius)]` |
-
-Semantic token reference:
-```
-bg-background / text-foreground       → page background and primary text
-bg-card / text-card-foreground        → card surfaces
-bg-muted / text-muted-foreground      → subdued areas and secondary text
-bg-primary / text-primary-foreground  → primary actions
-bg-destructive                        → danger states
-bg-accent                             → hover states
-border-border                         → standard borders
-border-input                          → form field borders
-```
-
-### Layout — always use context, never hardcode
-```tsx
-// ✅ Correct
-import { useLayout } from 'xertica-ui/hooks';
-const { sidebarExpanded, sidebarWidth } = useLayout();
-<div style={{ paddingLeft: sidebarExpanded ? `${sidebarWidth}px` : '80px' }}>
-
-// ✅ Correct for reusable components that may render without providers
-import { useOptionalLayout } from 'xertica-ui/hooks';
-const layout = useOptionalLayout();
-const fallbackSidebarWidth = layout?.sidebarWidth ?? 80;
-
-// ❌ Wrong — never hardcode sidebar width
-<div style={{ paddingLeft: '256px' }}>
-```
-
-### Destructive actions — always confirm
-```tsx
-// ✅ Correct — confirm before executing
-<AlertDialog>
-  <AlertDialogTrigger asChild>
-    <Button variant="destructive">Delete</Button>
-  </AlertDialogTrigger>
-  <AlertDialogContent>...</AlertDialogContent>
-</AlertDialog>
-
-// ❌ Wrong — never execute destructive action directly on click
-<Button variant="destructive" onClick={deleteRecord}>Delete</Button>
-```
-
----
-
-## Page Structure
-
-Every page must follow this structure:
-
-```tsx
-import { PageHeader, PageHeaderHeading, PageHeaderDescription } from 'xertica-ui/ui';
-
-export function MyPage() {
-  return (
-    <>
-      <PageHeader>
-        <PageHeaderHeading>Page Title</PageHeaderHeading>
-        <PageHeaderDescription>Optional subtitle</PageHeaderDescription>
-        <Button>Primary Action</Button>
-      </PageHeader>
-      <div className="p-6 space-y-6">
-        {/* Page content */}
-      </div>
-    </>
-  );
-}
-```
-
----
-
-## App Root Structure
-
-```tsx
-import { XerticaProvider } from 'xertica-ui/brand';
-import { BrowserRouter }   from 'react-router-dom';
-import 'xertica-ui/style.css';
-
-function Root() {
-  const geminiApiKey = import.meta.env.VITE_GEMINI_API_KEY;
-  const googleMapsApiKey = import.meta.env.VITE_GOOGLE_MAPS_API_KEY;
-
-  return (
-    <XerticaProvider
-      apiKey={geminiApiKey}
-      googleMapsApiKey={googleMapsApiKey}
-      disableDarkMode
-    >
-      <BrowserRouter>
-        <App />
-      </BrowserRouter>
-    </XerticaProvider>
-  );
-}
-```
-
-`XerticaProvider` is the app-level convenience wrapper used by this template. It composes theme, brand colors, language, layout, assistant/API keys, Google Maps, tooltips, and toasts. Most individual `xertica-ui` components are designed to render independently; use `useOptionalLayout()` when building reusable components that should keep working outside this provider.
-
----
-
-## Toast Notifications
-
-```tsx
-import { toast } from 'sonner'; // sonner is re-exported, no extra install needed
-
-toast.success('Saved successfully');
-toast.error('Something went wrong');
-toast.info('Processing...');
-toast.warning('Check your input');
-```
-
-Never render `<Toaster>` manually — it is auto-injected by `<XerticaProvider>`.
-
----
-
-## Before Writing Any Component
-
-1. Check `node_modules/xertica-ui/llms-compact.txt` — the component may already exist.
-2. Check `node_modules/xertica-ui/docs/decision-tree.md` — you may be choosing the wrong component.
-3. Read the specific component doc at `node_modules/xertica-ui/docs/components/[name].md`.
-4. Never create custom primitives that duplicate library components.
+# Xertica UI — Project Rules
+
+This project uses **xertica-ui**, an enterprise React design system built on Tailwind CSS v4, Radix UI, and Lucide Icons.
+
+> For the complete component reference, read `node_modules/xertica-ui/llms-full.txt`.
+> For a compact quick-reference, read `node_modules/xertica-ui/llms-compact.txt`.
+> For component selection guidance, read `node_modules/xertica-ui/docs/decision-tree.md`.
+
+---
+
+## Import Rules
+
+Always use the most specific subpath — never import from a category you don't need:
+
+```tsx
+import { Button, Card, Input, Badge, Table, Dialog } from 'xertica-ui/ui';
+import { Sidebar, Header }                           from 'xertica-ui/layout';
+import { XerticaProvider, XerticaLogo, ThemeToggle } from 'xertica-ui/brand';
+import { XerticaAssistant, generateDemoResponse }    from 'xertica-ui/assistant';
+import { VideoPlayer, AudioPlayer }                  from 'xertica-ui/media';
+import { useLayout, useOptionalLayout, useTheme }    from 'xertica-ui/hooks';
+import 'xertica-ui/style.css'; // import once at root only
+```
+
+The root `from 'xertica-ui'` remains valid for backward compatibility, but scaffolded project code must prefer the subpaths above.
+
+Icons are **never** from xertica-ui — always use `lucide-react`:
+
+```tsx
+import { Home, Settings, Plus, Trash2, ChevronRight } from 'lucide-react';
+```
+
+---
+
+## Non-Negotiable Rules
+
+### HTML — never use raw elements for UI
+| ❌ Never | ✅ Always |
+|---|---|
+| `<button>` | `<Button>` from `xertica-ui/ui` |
+| `<input>` | `<Input>` from `xertica-ui/ui` |
+| `<select>` | `<Select>` from `xertica-ui/ui` |
+| `<h1>` / `<h2>` for page headers | `<PageHeader><PageHeaderHeading>` |
+| `<div class="card ...">` | `<Card>` from `xertica-ui/ui` |
+| custom scrollbar div | `<ScrollArea>` from `xertica-ui/ui` |
+
+### Colors — context-dependent rules
+
+| ❌ Never (any context) | Reason |
+|---|---|
+| `#3b82f6`, `rgb(59,130,246)`, `hsl(...)` | Raw values — non-themeable |
+| `style={{ color: '#...' }}` for theming | Non-themeable inline style |
+
+| ❌ Wrong for semantic/status contexts | ✅ Required instead |
+|---|---|
+| `bg-red-500` for error states | `bg-destructive` |
+| `text-red-500` for error text | `text-destructive` |
+| `bg-green-500` for success states | `bg-success` |
+| `bg-yellow-500` for warnings | `bg-warning` |
+
+> For **layout, spacing, and general non-semantic UI** (custom components, decorative elements, Storybook stories where no semantic token applies), standard Tailwind color utilities like `bg-blue-500` or `text-gray-700` are acceptable.
+
+Semantic token reference:
+```
+bg-background / text-foreground       → page background and primary text
+bg-card / text-card-foreground        → card surfaces
+bg-muted / text-muted-foreground      → subdued areas and secondary text
+bg-primary / text-primary-foreground  → primary actions
+bg-destructive                        → danger / error states
+bg-success / bg-warning / bg-info     → semantic status states
+bg-accent                             → hover states
+border-border                         → standard borders
+border-input                          → form field borders
+```
+
+### Layout — always use context, never hardcode
+```tsx
+// ✅ Correct
+import { useLayout } from 'xertica-ui/hooks';
+const { sidebarExpanded, sidebarWidth } = useLayout();
+<div style={{ paddingLeft: sidebarExpanded ? `${sidebarWidth}px` : '80px' }}>
+
+// ✅ Correct for reusable components that may render without providers
+import { useOptionalLayout } from 'xertica-ui/hooks';
+const layout = useOptionalLayout();
+const fallbackSidebarWidth = layout?.sidebarWidth ?? 80;
+
+// ❌ Wrong — never hardcode sidebar width
+<div style={{ paddingLeft: '256px' }}>
+```
+
+### Destructive actions — always confirm
+```tsx
+// ✅ Correct — confirm before executing
+<AlertDialog>
+  <AlertDialogTrigger asChild>
+    <Button variant="destructive">Delete</Button>
+  </AlertDialogTrigger>
+  <AlertDialogContent>...</AlertDialogContent>
+</AlertDialog>
+
+// ❌ Wrong — never execute destructive action directly on click
+<Button variant="destructive" onClick={deleteRecord}>Delete</Button>
+```
+
+---
+
+## Page Structure
+
+Every page must follow this structure:
+
+```tsx
+import { PageHeader, PageHeaderHeading, PageHeaderDescription } from 'xertica-ui/ui';
+
+export function MyPage() {
+  return (
+    <>
+      <PageHeader>
+        <PageHeaderHeading>Page Title</PageHeaderHeading>
+        <PageHeaderDescription>Optional subtitle</PageHeaderDescription>
+        <Button>Primary Action</Button>
+      </PageHeader>
+      <div className="p-6 space-y-6">
+        {/* Page content */}
+      </div>
+    </>
+  );
+}
+```
+
+---
+
+## App Root Structure
+
+```tsx
+import { XerticaProvider } from 'xertica-ui/brand';
+import { BrowserRouter }   from 'react-router-dom';
+import 'xertica-ui/style.css';
+
+function Root() {
+  const geminiApiKey = import.meta.env.VITE_GEMINI_API_KEY;
+  const googleMapsApiKey = import.meta.env.VITE_GOOGLE_MAPS_API_KEY;
+
+  return (
+    <XerticaProvider
+      apiKey={geminiApiKey}
+      googleMapsApiKey={googleMapsApiKey}
+      disableDarkMode
+    >
+      <BrowserRouter>
+        <App />
+      </BrowserRouter>
+    </XerticaProvider>
+  );
+}
+```
+
+`XerticaProvider` is the app-level convenience wrapper used by this template. It composes theme, brand colors, language, layout, assistant/API keys, Google Maps, tooltips, and toasts. Most individual `xertica-ui` components are designed to render independently; use `useOptionalLayout()` when building reusable components that should keep working outside this provider.
+
+---
+
+## Toast Notifications
+
+```tsx
+import { toast } from 'sonner'; // sonner is re-exported, no extra install needed
+
+toast.success('Saved successfully');
+toast.error('Something went wrong');
+toast.info('Processing...');
+toast.warning('Check your input');
+```
+
+Never render `<Toaster>` manually — it is auto-injected by `<XerticaProvider>`.
+
+---
+
+## Before Writing Any Component
+
+1. Check `node_modules/xertica-ui/llms-compact.txt` — the component may already exist.
+2. Check `node_modules/xertica-ui/docs/decision-tree.md` — you may be choosing the wrong component.
+3. Read the specific component doc at `node_modules/xertica-ui/docs/components/[name].md`.
+4. Never create custom primitives that duplicate library components.