---

name: tailwind-shadcn description: Styling conventions for Vite + React projects using Tailwind CSS and shadcn/ui. Use when creating, styling, or refactoring React components, pages, or UI elements. Enforces clean component hierarchy with shadcn primitives in src/components/ui composed into custom components in src/components and src/pages.

Tailwind + shadcn/ui Styling Structure

Folder Structure

Copysrc/
├── components/
│   ├── ui/           # shadcn primitives (Button, Card, Dialog, etc.)
│   │   └── index.js  # barrel exports
│   └── [feature]/    # Domain components composed from ui/ primitives
├── pages/            # Page components, compose from components/
└── index.css         # Global styles, Tailwind imports, theme variables

Keep styles in a single index.css until it exceeds ~300 lines. Light/dark themes belong together as CSS variable swaps — no need for separate theme files.

Component Hierarchy

Layer 1: src/components/ui/ — Design System Primitives

• Install via npx shadcn@latest add <component>
• Modify directly for project-wide design decisions (colors, spacing, cursor, sizing)
• You own this code — it's your design system, not an external dependency
• No unit tests — primitives are tested upstream by shadcn/Base UI
• No Storybook stories — document usage in domain components instead

Layer 2: src/components/ — Domain Components

• Compose ui/ primitives into domain-specific components
• Create wrappers only when adding behavior or composition, not just styling
• Group by feature when >3 related components exist

Layer 3: src/pages/ — Page Components

• Compose custom components into full pages
• Minimal direct Tailwind; prefer component composition
• Handle layout concerns (grid, spacing between sections)

When to Modify ui/ vs. Create Wrapper

Modify ui/ directly when:

• Changing project-wide defaults (padding, cursor, border-radius)
• Adding new variants that apply globally
• Adjusting base styles for consistency

Copy// src/components/ui/button.jsx — modify directly
const buttonVariants = cva(
  'cursor-pointer active:cursor-grabbing ...', // project cursor rules
  {
    variants: {
      size: {
        default: 'h-10 px-5 py-2.5' // project sizing
      }
    }
  }
)

Create wrapper in components/ when:

• Adding domain-specific behavior (onClick handlers, state)
• Composing multiple primitives together
• Creating contextual variations (MenuButton, SubmitButton with loading state)

Copy// src/components/SubmitButton.jsx — wrapper for behavior
import { Button } from '@/components/ui/button'
import { Loader2 } from 'lucide-react'

export function SubmitButton({ loading, children, ...props }) {
  return (
    <Button disabled={loading} {...props}>
      {loading && <Loader2 className='mr-2 h-4 w-4 animate-spin' />}
      {children}
    </Button>
  )
}

Barrel Exports

Use an index file to consolidate ui/ imports. Export only components, not CVA variants (keep variants as internal implementation details):

Copy// src/components/ui/index.js
export { Button } from './button' // not buttonVariants
export { Badge } from './badge' // not badgeVariants
export { Input } from './input' // not inputVariants
export { Card, CardHeader, CardTitle, CardContent, CardFooter } from './card'
// ... add as you install components

Then import from a single path:

Copy// Before: multiple lines
import { Button } from '@/components/ui/button'
import { Badge } from '@/components/ui/badge'
import { Card } from '@/components/ui/card'

// After: single line
import { Button, Badge, Card } from '@/components/ui'

// If you need variants for extending styles, import directly:
import { buttonVariants } from '@/components/ui/button'

Update index.js each time you add a new shadcn component.

Internal imports within ui/: When one ui component imports another (e.g., sidebar.jsx importing button), use relative paths:

Copy// Inside src/components/ui/sidebar.jsx
import { Button } from './button' // not '@/components/ui/button'
import { Sheet, SheetContent } from './sheet'

Tailwind Best Practices

Class Organization

Order classes consistently: layout → sizing → spacing → typography → colors → effects

Copy// Good: logical grouping
<div className='flex items-center gap-4 p-4 text-sm text-muted-foreground bg-card rounded-lg shadow-sm' />

Avoid Inline Style Bloat

Extract repeated behavioral patterns into wrapper components:

Copy// Avoid: repeating complex compositions
;<Button variant='ghost' className='w-full justify-start gap-2'>
  <Icon /> Menu Item
</Button>

// Prefer: wrapper for repeated composition + behavior
// components/MenuItem.jsx
export const MenuItem = ({ icon: Icon, children, ...props }) => (
  <Button variant='ghost' className='w-full justify-start gap-2' {...props}>
    {Icon && <Icon className='h-4 w-4' />}
    {children}
  </Button>
)

Adding Variants to ui/ Components

Extend variants via cva when the variant applies project-wide:

Copy// components/ui/button.jsx - add new variant
const buttonVariants = cva('...', {
  variants: {
    variant: {
      // existing variants...
      brand: 'bg-brand-500 text-white hover:bg-brand-600'
    }
  }
})

Design Tokens via CSS Variables

Define project tokens in src/index.css alongside shadcn variables:

Copy:root {
  /* shadcn defaults... */
  --brand: oklch(51% 0.23 277deg);
  --brand-foreground: oklch(96% 0.02 272deg);
}

.dark {
  --brand: oklch(68% 0.16 277deg);
  --brand-foreground: oklch(96% 0.02 272deg);
}

Reference via Tailwind: bg-brand, text-brand-foreground

Component Composition Pattern

Copy// components/ui/card.jsx - shadcn primitive (don't modify)
// components/ui/button.jsx - shadcn primitive (don't modify)

// components/FeatureCard.jsx - custom composition
import { Card, CardHeader, CardTitle, CardContent } from '@/components/ui/card'
import { Button } from '@/components/ui/button'

export const FeatureCard = ({ title, description, onAction }) => (
  <Card>
    <CardHeader>
      <CardTitle>{title}</CardTitle>
    </CardHeader>
    <CardContent className='space-y-4'>
      <p className='text-muted-foreground'>{description}</p>
      {onAction && <Button onClick={onAction}>Learn More</Button>}
    </CardContent>
  </Card>
)

// pages/Features.jsx - page composition
import { FeatureCard } from '@/components/FeatureCard'

export const FeaturesPage = () => (
  <main className='container py-12'>
    <h1 className='text-3xl font-bold mb-8'>Features</h1>
    <div className='grid gap-6 md:grid-cols-2 lg:grid-cols-3'>
      <FeatureCard title='Fast' description='...' />
      <FeatureCard title='Secure' description='...' onAction={() => {}} />
    </div>
  </main>
)

Common Patterns

Responsive Design

Mobile-first with breakpoint prefixes:

Copy<div className='grid grid-cols-1 md:grid-cols-2 lg:grid-cols-3 gap-4' />

Dark Mode

Use shadcn's built-in dark mode support via dark: prefix:

Copy<div className="bg-background text-foreground" /> // Automatic
<div className="bg-white dark:bg-slate-900" />    // Manual override

Spacing Consistency

Use consistent spacing scale: gap-4, space-y-4, p-4, m-4 (16px base)

• Tight: 2 (8px)
• Default: 4 (16px)
• Loose: 6 (24px)
• Section: 8-12 (32-48px)

Animation

Use Tailwind's transition utilities:

Copy<Button className='transition-colors hover:bg-primary/90' />

For complex animations, use tailwindcss-animate (included with shadcn).