Search documentation
Search pages, components, blocks, styles and colours.
Install and configure Fabricator UI for Next.js.
Choose the setup that matches your starting point.
Scaffold a new Next.js project directly from the terminal.
Configure Fabricator UI manually in an existing Next.js project.
Use the CLI
Create Project
Run the init command to scaffold a new Next.js project. Follow the prompts to configure your project: base, preset, monorepo, and more.
For a monorepo project, use --monorepo flag:
To choose the base (base, radix or aria), use the -b flag. Base UI is the default.
Add Components
Add the Card component to your project:
If you created a monorepo, run the command from apps/web or specify the workspace from the repo root:
The command above will add the Card component to your project. You can then import it like this:
import {
Card,
CardContent,
CardDescription,
CardHeader,
CardTitle,
} from "@/components/ui/card"
export default function Home() {
return (
<Card className="max-w-sm">
<CardHeader>
<CardTitle>Project Overview</CardTitle>
<CardDescription>
Track progress and recent activity for your Next.js app.
</CardDescription>
</CardHeader>
<CardContent>
Your design system is ready. Start building your next component.
</CardContent>
</Card>
)
}If you created a monorepo, update apps/web/app/page.tsx and import from @workspace/ui/components/card instead.
Existing Project
Create Project
If you need a new Next.js project, create one with create-next-app. Otherwise, skip this step.
Choose the recommended defaults so Tailwind CSS, the App Router, and the default @/* import alias are configured for you.
If you prefer a src/ directory, use --src-dir or choose Yes when prompted:
With --src-dir, Next.js places your app in src/app and configures the @/* alias to point to ./src/*.
Configure Tailwind CSS and Import Aliases
If you created your project with the recommended create-next-app defaults, you can skip this step.
If you're adding Fabricator UI to an older or custom Next.js app, make sure Tailwind CSS is installed first. You can follow the official Next.js installation guide.
Then make sure your tsconfig.json includes the @/* import alias:
{
"compilerOptions": {
"paths": {
"@/*": ["./*"]
}
}
}If you used --src-dir, point the alias to ./src/* instead.
Run the CLI
Run the init command to set up Fabricator UI in your project.
If the project already has components installed, init asks whether to add the @fabricator registry only, or to also apply the Fabricator theme. See Registry.
Add Components
You can now start adding components to your project.
The command above will add the Button component to your project. You can then import it like this:
import { Button } from "@/components/ui/button"
export default function Home() {
return (
<div className="flex min-h-svh items-center justify-center">
<Button>Click me</Button>
</div>
)
}If you used --src-dir, add the component to src/app/page.tsx instead.