Overview
Cult Components are designed specifically for React and developed using TypeScript. They utilize tailwindcss for styling and framer-motion along with CSS for animations. While Cult Components seamlessly integrate with the shadcn ecosystem, shadcn is not mandatory for their use, though some examples may include shadcn components.
Prerequisites
To get started, ensure you have the following dependencies installed:
Next, integrate our utility function by adding the following code to your project:
// lib/utils.ts
import clsx, { ClassValue } from "clsx"
import { twMerge } from "tailwind-merge"
export function cn(...inputs: ClassValue[]) {
return twMerge(clsx(inputs))
}CLI Installation (shadcn v3)
For projects using shadcn CLI v3, you can configure the Cult UI registry to install components directly via the command line.
Configure Registry
Add the Cult UI registry to your components.json file:
{
"$schema": "https://ui.shadcn.com/schema.json",
"style": "new-york",
"rsc": true,
"tsx": true,
"tailwind": {
"config": "",
"css": "app/globals.css",
"baseColor": "neutral",
"cssVariables": true,
"prefix": ""
},
"aliases": {
"components": "@/components",
"utils": "@/lib/utils",
"ui": "@/components/ui",
"lib": "@/lib",
"hooks": "@/hooks"
},
"iconLibrary": "lucide",
"registries": {
"@cult-ui": "https://cult-ui.com/r/{name}.json"
}
}Install Components
Once configured, you can install components using:
# Install a single component
npx shadcn@beta add @cult-ui/text-gif
# Install multiple components
npx shadcn@beta add @cult-ui/texture-card @cult-ui/texture-button
# Search for components
npx shadcn@beta search @cult-ui --query "texture-button"Manual Installation
You're ready to go! Visit any component page and follow the provided instructions.
Just copy and paste the components you need—no unnecessary bloat or third-party dependencies.