shadcn.io is not affiliated with official shadcn/ui
Docs
Vite
Install shadcn.io in a Vite project.
Use the shadcn.io Preset
Create Project
Run the init command with the shadcn.io preset and the Vite template:
Add Components
You can add components with the CLI or copy them manually from the component docs:
- CLI: Run
npx shadcn@latest add https://kit.dev/r/<component>.json(e.g.button,dialog). - Manual: Copy component source from Manual tab in the component docs.
For example, add the Button component to your project:
You can also install every component at once:
Then import and use components like this:
import { Button } from "@/components/ui/button";
function App() {
return (
<div className="flex min-h-svh flex-col items-center justify-center">
<Button>Click me</Button>
</div>
);
}
export default App;Use the CLI
Create Project
Run the init command to scaffold a new Vite project and configure shadcn.io:
For a monorepo project, use the --monorepo flag:
Add Components
You can add components with the CLI or copy them manually from the component docs:
- CLI: Run
npx shadcn@latest add https://kit.dev/r/<component>.json(e.g.button,dialog). - Manual: Copy component source from Manual tab in the component docs.
For example, add the Button component to your project:
If you created a monorepo, run the command from apps/web or specify the workspace from the repo root:
You can also install every component at once:
Then import and use components like this:
import { Button } from "@/components/ui/button";
function App() {
return (
<div className="flex min-h-svh flex-col items-center justify-center">
<Button>Click me</Button>
</div>
);
}
export default App;If you created a monorepo, update apps/web/src/App.tsx and import from your workspace UI package instead.
Existing Project
Create Project
If you need a new Vite project, create one first and select the React + TypeScript template. Otherwise, skip this step.
bun create vite@latestAdd Tailwind CSS
If your project already has Tailwind CSS configured, skip this step.
bun add tailwindcss @tailwindcss/viteReplace everything in src/index.css with the following:
@import "tailwindcss";Edit tsconfig.json
Vite splits TypeScript config across multiple files. Add paths to the compilerOptions in both tsconfig.json and tsconfig.app.json (no baseUrl: TypeScript 6 rejects it, and paths resolve from the file):
{
"files": [],
"references": [
{
"path": "./tsconfig.app.json"
},
{
"path": "./tsconfig.node.json"
}
],
"compilerOptions": {
"paths": {
"@/*": ["./src/*"]
}
}
}Edit tsconfig.app.json
Add the same path resolution so your IDE resolves imports correctly:
{
"compilerOptions": {
"paths": {
"@/*": ["./src/*"]
}
}
}Update vite.config.ts
Add the path alias so Vite resolves @/ at build time:
bun add -D @types/nodeimport path from "path"
import tailwindcss from "@tailwindcss/vite"
import react from "@vitejs/plugin-react"
import { defineConfig } from "vite"
export default defineConfig({
plugins: [react(), tailwindcss()],
resolve: {
alias: {
"@": path.resolve(import.meta.dirname, "./src"),
},
},
})Run the CLI
Run the shadcn init command with the shadcn.io preset to set up your project.
Add Components
You can add components with the CLI or copy them manually from the component docs:
- CLI: Run
npx shadcn@latest add https://kit.dev/r/<component>.json(e.g.button,dialog). - Manual: Copy component source from Manual tab in the component docs.
For example, add the Button component to your project:
You can also install every component at once:
Then import and use components like this:
import { Button } from "@/components/ui/button";
function App() {
return (
<div className="flex min-h-svh flex-col items-center justify-center">
<Button>Click me</Button>
</div>
);
}
export default App;