- Accordion
- Attachment
- Avatar
- Badge
- Breadcrumb
- Button
- Button Group
- Card
- Checkbox
- Code Block
- Collapsible
- Dialog
- Dropdown Menu
- Empty
- Field
- Hover Card
- Input
- Input Group
- Input OTP
- Item
- Label
- Marker
- Message
- Number Flow
- Pagination
- Popover
- Progress
- Radio Group
- Select
- Slider
- Sonner
- Spinner
- Switch
- Tooltip
- Separator
- Sheet
- Tabs
- Textarea
- Toggle
- Toggle Group
- Trace
Frakment works in any TanStack Router project with React 19 and Tailwind v4. This guide covers both a new project via the CLI and an existing app.
Prerequisites
- TanStack Router 1.x
- React 19
- Vite 5+
- TypeScript
- Tailwind CSS v4
Components target React 19 and Tailwind v4. For React 18, some components need forwardRef adjustments. For Tailwind v3, port the tokens from Theming manually.
Use the CLI
Scaffold a new TanStack Router app with Frakment installed.
Create project
$ bunx --bun create-tsrouter-app@latest app --template file-router cd app$ npx create-tsrouter-app@latest app --template file-router cd app$ pnpm create tsrouter-app@latest app --template file-router cd app$ yarn create tsrouter-app@latest app --template file-router cd app
Install Tailwind v4
$ bun add tailwindcss@latest @tailwindcss/vite$ npm install tailwindcss@latest @tailwindcss/vite$ pnpm add tailwindcss@latest @tailwindcss/vite$ yarn add tailwindcss@latest @tailwindcss/vite
Register the Vite plugin:
import { tanstackRouter } from "@tanstack/router-plugin/vite";
import tailwindcss from "@tailwindcss/vite";
import react from "@vitejs/plugin-react";
import { defineConfig } from "vite";
export default defineConfig({
plugins: [tanstackRouter(), react(), tailwindcss()],
});Add components
$ bunx --bun frakment@latest init npx frakment@latest add bubble$ npx frakment@latest init npx frakment@latest add bubble$ pnpm dlx frakment@latest init npx frakment@latest add bubble$ yarn dlx frakment@latest init npx frakment@latest add bubble
Use it
import { createFileRoute } from "@tanstack/react-router";
import { Bubble, BubbleContent } from "@/components/ui/message";
export const Route = createFileRoute("/")({
component: Index,
});
function Index() {
return (
<Bubble>
<BubbleContent>Hello, Frakment.</BubbleContent>
</Bubble>
);
}Existing Project
Add Frakment to a TanStack Router app you already created.
Install Tailwind v4
$ bun add tailwindcss@latest @tailwindcss/vite$ npm install tailwindcss@latest @tailwindcss/vite$ pnpm add tailwindcss@latest @tailwindcss/vite$ yarn add tailwindcss@latest @tailwindcss/vite
Register the Vite plugin:
import { tanstackRouter } from "@tanstack/router-plugin/vite";
import tailwindcss from "@tailwindcss/vite";
import react from "@vitejs/plugin-react";
import { defineConfig } from "vite";
export default defineConfig({
plugins: [tanstackRouter(), react(), tailwindcss()],
});Run frakment init
$ bunx --bun frakment@latest init$ npx frakment@latest init$ pnpm dlx frakment@latest init$ yarn dlx frakment@latest init
Point to src/styles.css when prompted. The CLI injects the theme block.
Configure the import alias
In tsconfig.json:
{
"compilerOptions": {
"baseUrl": ".",
"paths": {
"@/*": ["./src/*"]
}
}
}Add a component
$ bunx --bun frakment@latest add bubble$ npx frakment@latest add bubble$ pnpm dlx frakment@latest add bubble$ yarn dlx frakment@latest add bubble
Project structure
Verify
ls src/components/ui/bubble.tsxThen render it in a route. If it renders without errors, you are ready.
Troubleshooting
Make sure tanstackRouter() is the first plugin in vite.config.ts. The router plugin scans src/routes/ at build time.
TanStack apps put source in src/. Set "@/*": ["./src/*"] in tsconfig.json and "components": "@/components" in components.json.
Next
- Theming - customize tokens and dark mode
- Components - browse the catalog
- TanStack Router docs - framework reference