Getting started

Installation

Configure your React or Next.js project and install Calamansi UI components.

Step 01

Create project

Start with a Next.js application configured with Tailwind CSS:

Terminal
npx create-next-app@latest my-app --typescript --tailwind --app

Step 02

Install dependencies

Install the utility libraries for class merging and the animation runtime:

Terminal
npm install clsx tailwind-merge motion

Step 03

Add utility helper

Create lib/utils.ts to merge Tailwind classes cleanly:

lib/utils.ts
1import { clsx, type ClassValue } from "clsx";
2import { twMerge } from "tailwind-merge";
3
4export function cn(...inputs: ClassValue[]) {
5 return twMerge(clsx(inputs));
6}

Step 04

Install components

Use the shadcn CLI to copy any component directly into your project:

Terminal
npx shadcn@latest add fujiDevv/calamansi-ui/calamansi

You can also use bun: bunx --bun shadcn@latest add fujiDevv/calamansi-ui/calamansi