Installation

A guided set of instructions and snippets to help developers quickly set up and integrate the framixui components into their projects.

1. Install utilities

All components use Tailwind CSS v4, so ensure it's installed in your project. Many components also use the cn utility function—install it with the following command:

bunx shadcn@latest add https://framixui.vercel.app/r/utils.json 
npx shadcn@latest add https://framixui.vercel.app/r/utils.json
pnpm dlx shadcn@latest add https://framixui.vercel.app/r/utils.json

2. That's it

We use lucide-icons for most components that include icons, along with some shadcn/ui components. These dependencies will be automatically installed when using the CLI.

For example to add card-01 to your project, it will be easy as:

bunx shadcn@latest add https://framixui.vercel.app/r/card-05.json
npx shadcn@latest add https://framixui.vercel.app/r/card-05.json
pnpm dlx shadcn@latest add https://framixui.vercel.app/r/card-05.json

While we provide a convenient 'copy' button for the code, we strongly recommend using the CLI for installing components, as it ensures all necessary files are included.

Add to your page and it works!

import Card01 from "@/components/framixui/card-01";

export default function Page() {
    return <Card01 />;
}

Then, add to your page and it works!

/**
 * AICardGeneration require 5 additional components
 * that will be automatically installed with the CLI.
 */
import BookingForm from "@/components/framixui/booking-form";

export default function Page() {
    return <BookingForm />;
}

4. Optionnal dependencies

Some components require additional libraries, listed at the bottom of each components. Make sure to install them to ensure the component works properly.

5. Monorepo

For monorepo shadcn/ui CLI contain the options -c to the path to your workspace for example:

bunx shadcn@latest add https://framixui.vercel.app/r/card-05.json -c ./apps/www
npx shadcn@latest add https://framixui.vercel.app/r/card-05.json -c ./apps/www
pnpm dlx shadcn@latest add https://framixui.vercel.app/r/card-05.json -c ./apps/www