DocumentationInstallation
Installation
There are two ways to use QuickCode UI:
- CLI (recommended) → fetch and install components automatically.
- Manual → copy-paste CSS + component code from GitHub.
CLI
CLI Installation
Install the package:
npm install quickcode-uiAdd a component (example: Button):
npx quickcode-ui add Button✨ This will copy the component into your src/components/ui folder and install any required dependencies automatically.
Manual
Manual Setup
Follow these steps if you prefer not to use the CLI:
1. Install dependencies
QuickCode components rely on these packages. Install them first:
npm install clsx tailwind-merge
npm install -D tailwind-animatecss⚠️ Depending on the component you use, you may also need:
framer-motion(animations)lucide-react(icons)recharts(charts)
Install only the ones required for your chosen component.
2. Add lib/utils.ts
Create a file at src/lib/utils.ts and add this code:
import { clsx, type ClassValue } from "clsx";
import { twMerge } from "tailwind-merge";
export function cn(...inputs: ClassValue[]) {
return twMerge(clsx(inputs));
}3. Update your global CSS
Replace your globals.css with the QuickCode theme:
/* QuickCode Theme */
@import "tailwindcss";
@import "tw-animate-css";
@custom-variant dark (&:is(.dark *));
:root {
--background: oklch(0.9842 0.0034 247.8575);
--foreground: oklch(0.2795 0.0368 260.031);
--card: oklch(1 0 0);
--card-foreground: oklch(0.2795 0.0368 260.031);
--popover: oklch(1 0 0);
--popover-foreground: oklch(0.2795 0.0368 260.031);
--primary: oklch(0.5854 0.2041 277.1173);
--primary-foreground: oklch(1 0 0);
--secondary: oklch(0.9276 0.0058 264.5313);
--secondary-foreground: oklch(0.3729 0.0306 259.7328);
--muted: oklch(0.967 0.0029 264.5419);
--muted-foreground: oklch(0.551 0.0234 264.3637);
--accent: oklch(0.9299 0.0334 272.7879);
--accent-foreground: oklch(0.3729 0.0306 259.7328);
--destructive: oklch(0.6368 0.2078 25.3313);
--destructive-foreground: oklch(1 0 0);
--border: oklch(0.8717 0.0093 258.3382);
--input: oklch(0.8717 0.0093 258.3382);
--ring: oklch(0.5854 0.2041 277.1173);
--chart-1: oklch(0.5854 0.2041 277.1173);
--chart-2: oklch(0.5106 0.2301 276.9656);
--chart-3: oklch(0.4568 0.2146 277.0229);
--chart-4: oklch(0.3984 0.1773 277.3662);
--chart-5: oklch(0.3588 0.1354 278.6973);
--sidebar: oklch(0.967 0.0029 264.5419);
--sidebar-foreground: oklch(0.2795 0.0368 260.031);
--sidebar-primary: oklch(0.5854 0.2041 277.1173);
--sidebar-primary-foreground: oklch(1 0 0);
--sidebar-accent: oklch(0.9299 0.0334 272.7879);
--sidebar-accent-foreground: oklch(0.3729 0.0306 259.7328);
--sidebar-border: oklch(0.8717 0.0093 258.3382);
--sidebar-ring: oklch(0.5854 0.2041 277.1173);
--font-sans: Inter, sans-serif;
--font-serif: Merriweather, serif;
--font-mono: JetBrains Mono, monospace;
--radius: 0.5rem;
--shadow-2xs: 0px 4px 8px -1px hsl(0 0% 0% / 0.05);
--shadow-xs: 0px 4px 8px -1px hsl(0 0% 0% / 0.05);
--shadow-sm: 0px 4px 8px -1px hsl(0 0% 0% / 0.1), 0px 1px 2px -2px hsl(0 0%
0% / 0.1);
--shadow: 0px 4px 8px -1px hsl(0 0% 0% / 0.1), 0px 1px 2px -2px hsl(0 0% 0% /
0.1);
--shadow-md: 0px 4px 8px -1px hsl(0 0% 0% / 0.1), 0px 2px 4px -2px hsl(0 0%
0% / 0.1);
--shadow-lg: 0px 4px 8px -1px hsl(0 0% 0% / 0.1), 0px 4px 6px -2px hsl(0 0%
0% / 0.1);
--shadow-xl: 0px 4px 8px -1px hsl(0 0% 0% / 0.1), 0px 8px 10px -2px hsl(0 0%
0% / 0.1);
--shadow-2xl: 0px 4px 8px -1px hsl(0 0% 0% / 0.25);
--tracking-normal: 0em;
--spacing: 0.25rem;
}
.dark {
--background: oklch(0.2077 0.0398 265.7549);
--foreground: oklch(0.9288 0.0126 255.5078);
--card: oklch(0.2795 0.0368 260.031);
--card-foreground: oklch(0.9288 0.0126 255.5078);
--popover: oklch(0.2795 0.0368 260.031);
--popover-foreground: oklch(0.9288 0.0126 255.5078);
--primary: oklch(0.6801 0.1583 276.9349);
--primary-foreground: oklch(0.2077 0.0398 265.7549);
--secondary: oklch(0.3351 0.0331 260.912);
--secondary-foreground: oklch(0.8717 0.0093 258.3382);
--muted: oklch(0.2795 0.0368 260.031);
--muted-foreground: oklch(0.7137 0.0192 261.3246);
--accent: oklch(0.3729 0.0306 259.7328);
--accent-foreground: oklch(0.8717 0.0093 258.3382);
--destructive: oklch(0.6368 0.2078 25.3313);
--destructive-foreground: oklch(0.2077 0.0398 265.7549);
--border: oklch(0.4461 0.0263 256.8018);
--input: oklch(0.4461 0.0263 256.8018);
--ring: oklch(0.6801 0.1583 276.9349);
--chart-1: oklch(0.6801 0.1583 276.9349);
--chart-2: oklch(0.5854 0.2041 277.1173);
--chart-3: oklch(0.5106 0.2301 276.9656);
--chart-4: oklch(0.4568 0.2146 277.0229);
--chart-5: oklch(0.3984 0.1773 277.3662);
--sidebar: oklch(0.2795 0.0368 260.031);
--sidebar-foreground: oklch(0.9288 0.0126 255.5078);
--sidebar-primary: oklch(0.6801 0.1583 276.9349);
--sidebar-primary-foreground: oklch(0.2077 0.0398 265.7549);
--sidebar-accent: oklch(0.3729 0.0306 259.7328);
--sidebar-accent-foreground: oklch(0.8717 0.0093 258.3382);
--sidebar-border: oklch(0.4461 0.0263 256.8018);
--sidebar-ring: oklch(0.6801 0.1583 276.9349);
--font-sans: Inter, sans-serif;
--font-serif: Merriweather, serif;
--font-mono: JetBrains Mono, monospace;
--radius: 0.5rem;
--shadow-2xs: 0px 4px 8px -1px hsl(0 0% 0% / 0.05);
--shadow-xs: 0px 4px 8px -1px hsl(0 0% 0% / 0.05);
--shadow-sm: 0px 4px 8px -1px hsl(0 0% 0% / 0.1), 0px 1px 2px -2px hsl(0 0%
0% / 0.1);
--shadow: 0px 4px 8px -1px hsl(0 0% 0% / 0.1), 0px 1px 2px -2px hsl(0 0% 0% /
0.1);
--shadow-md: 0px 4px 8px -1px hsl(0 0% 0% / 0.1), 0px 2px 4px -2px hsl(0 0%
0% / 0.1);
--shadow-lg: 0px 4px 8px -1px hsl(0 0% 0% / 0.1), 0px 4px 6px -2px hsl(0 0%
0% / 0.1);
--shadow-xl: 0px 4px 8px -1px hsl(0 0% 0% / 0.1), 0px 8px 10px -2px hsl(0 0%
0% / 0.1);
--shadow-2xl: 0px 4px 8px -1px hsl(0 0% 0% / 0.25);
}
@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);
--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);
--font-sans: var(--font-sans);
--font-mono: var(--font-mono);
--font-serif: var(--font-serif);
--radius-sm: calc(var(--radius) - 4px);
--radius-md: calc(var(--radius) - 2px);
--radius-lg: var(--radius);
--radius-xl: calc(var(--radius) + 4px);
--shadow-2xs: var(--shadow-2xs);
--shadow-xs: var(--shadow-xs);
--shadow-sm: var(--shadow-sm);
--shadow: var(--shadow);
--shadow-md: var(--shadow-md);
--shadow-lg: var(--shadow-lg);
--shadow-xl: var(--shadow-xl);
--shadow-2xl: var(--shadow-2xl);
}
body {
background: var(--background);
color: var(--foreground);
}
html {
overflow: overlay;
}
html::-webkit-scrollbar {
width: 0px;
background: transparent;
}4. Copy component code
Browse the QuickCode GitHub components folder , copy the component you need, and paste it into your project at:
src/components/ui/5. Copy hooks (if needed)
Some components use custom hooks.
If a component imports from @/hooks, copy the matching hook(s) from our repo into:
src/hooks/You can find them here: QuickCode GitHub hooks folder
✅ Done! You now have QuickCode components installed manually.
Last updated on