Documentation

Introduction & Getting Started

BudUI is a modern, accessible React component library built on Radix UI primitives, Tailwind CSS, and CSS custom properties.

1. Installation

Install @ifreebuddy/budui into your React or Next.js application using npm:

npm install @ifreebuddy/budui

2. Styling Setup

Import the global component styles in your application root file (e.g. app/layout.tsx or index.css):

import "@ifreebuddy/budui/styles.css";

3. Basic Usage

Import components directly from @ifreebuddy/budui:

import { Button, Card, CardHeader, CardTitle, CardContent } from "@ifreebuddy/budui";

export default function Example() {
  return (
    <Card className="max-w-sm">
      <CardHeader>
        <CardTitle>BudUI Card</CardTitle>
      </CardHeader>
      <CardContent>
        <Button>Click Me</Button>
      </CardContent>
    </Card>
  );
}

4. Next Steps