# Radix UI Design System - Detailed Guide > This file contains the detailed procedure and reference material extracted from `SKILL.md` for focused loading. The root skill defines activation, examples, safety constraints, and limitations. ## Overview Radix UI provides unstyled, accessible components (primitives) that you can customize to match any design system. This skill guides you through building scalable component libraries with Radix UI, focusing on accessibility-first design, theming architecture, and composable patterns. **Key Strengths:** - **Headless by design**: Full styling control without fighting defaults - **Accessibility built-in**: WAI-ARIA compliant, keyboard navigation, screen reader support - **Composable primitives**: Build complex components from simple building blocks - **React primitives**: Styles can be portable; these components require React ## Core Principles ### 1. Accessibility First Every Radix primitive is built with accessibility as the foundation: - **Keyboard Navigation**: Full keyboard support (Tab, Arrow keys, Enter, Escape) - **Screen Readers**: Proper ARIA attributes and live regions - **Focus Management**: Automatic focus trapping and restoration - **Disabled States**: Proper handling of disabled and aria-disabled **Rule**: Never override accessibility features. Enhance, don't replace. ### 2. Headless Architecture Radix provides **behavior**, you provide **appearance**: ```tsx // ❌ Don't fight pre-styled components {/* Portal renders outside DOM hierarchy */} {/* Overlay (backdrop) */} {/* Content (modal) */} Title Description {/* Your content here */} ); } ``` --- ## Theming Strategies ### Strategy 1: CSS Variables (Framework-Agnostic) **Best for**: Maximum portability, SSR-friendly ```css /* globals.css */ :root { --color-primary: 220 90% 56%; --color-surface: 0 0% 100%; --radius-base: 0.5rem; --shadow-lg: 0 10px 15px -3px rgb(0 0 0 / 0.1); } [data-theme="dark"] { --color-primary: 220 90% 66%; --color-surface: 222 47% 11%; } ``` ```tsx // Component.tsx ``` ### Strategy 2: Tailwind + CVA (Class Variance Authority) **Best for**: Tailwind projects, variant-heavy components ```tsx // button.tsx import { cva, type VariantProps } from 'class-variance-authority'; import { cn } from '@/lib/utils'; const buttonVariants = cva( // Base styles "inline-flex items-center justify-center rounded-md font-medium transition-colors focus-visible:outline-none focus-visible:ring-2 focus-visible:ring-current disabled:pointer-events-none disabled:opacity-50", { variants: { variant: { default: "bg-primary text-primary-foreground hover:bg-primary/90", destructive: "bg-destructive text-destructive-foreground hover:bg-destructive/90", outline: "border border-input bg-background hover:bg-accent", ghost: "hover:bg-accent hover:text-accent-foreground", }, size: { default: "h-10 px-4 py-2", sm: "h-9 rounded-md px-3", lg: "h-11 rounded-md px-8", icon: "h-10 w-10", }, }, defaultVariants: { variant: "default", size: "default", }, } ); interface ButtonProps extends VariantProps { children: React.ReactNode; } export function Button({ variant, size, children }: ButtonProps) { return ( ); } ``` ### Strategy 3: Stitches (legacy project example) Check maintenance and compatibility before adopting Stitches in a new project. **Best for**: Runtime theming, scoped styles ```tsx import { styled } from '@stitches/react'; import * as Dialog from '@radix-ui/react-dialog'; const StyledContent = styled(Dialog.Content, { backgroundColor: '$surface', borderRadius: '$md', padding: '$6', variants: { size: { small: { width: '300px' }, medium: { width: '500px' }, large: { width: '700px' }, }, }, defaultVariants: { size: 'medium', }, }); ``` --- ## Component Patterns ### Pattern 1: Compound Components with Context **Use case**: Share state between primitive parts ```tsx // Select.tsx import * as Select from '@radix-ui/react-select'; import { CheckIcon, ChevronDownIcon } from '@radix-ui/react-icons'; export function CustomSelect({ items, placeholder, onValueChange }) { return ( {items.map((item) => ( {item.label} ))} ); } ``` ### Pattern 2: Polymorphic Components with `asChild` **Use case**: Render as different elements without losing behavior ```tsx // ✅ Render as Next.js Link but keep Radix behavior Open Settings // ✅ Render as custom component }>Action ``` **Why `asChild` matters**: Prevents nested button/link issues in accessibility tree. ### Pattern 3: Controlled vs Uncontrolled ```tsx // Uncontrolled (Radix manages state) Tab 1 Content // Controlled (You manage state) const [activeTab, setActiveTab] = useState('tab1'); Tab 1 Content ``` **Rule**: Use controlled when you need to sync with external state (URL, Redux, etc.). ### Pattern 4: Animation with Framer Motion ```tsx import * as Dialog from '@radix-ui/react-dialog'; import { motion, AnimatePresence } from 'framer-motion'; export function AnimatedDialog({ open, onOpenChange }) { return ( {open && ( <> Details Review details before continuing. )} ); } ``` --- ## Common Primitives Reference ### Dialog (Modal) ```tsx {/* State container */} {/* Opens dialog */} {/* Renders in portal */} {/* Backdrop */} {/* Modal content */} {/* Required for a11y */} {/* Required for a11y */} {/* Closes dialog */} ``` ### Dropdown Menu ```tsx {/* Nested menus */} ``` ### Tabs ```tsx ``` ### Tooltip ```tsx Tooltip text ``` ### Popover ```tsx Content ``` --- ## Accessibility Checklist ### Every Component Must Have: - [ ] **Focus Management**: Visible focus indicators on all interactive elements - [ ] **Keyboard Navigation**: Full keyboard support (Tab, Arrows, Enter, Esc) - [ ] **ARIA Labels**: Meaningful labels for screen readers - [ ] **Color Contrast**: WCAG AA minimum (4.5:1 for text, 3:1 for UI) - [ ] **Error States**: Clear error messages with `aria-invalid` and `aria-describedby` - [ ] **Loading States**: Proper `aria-busy` during async operations ### Dialog-Specific: - [ ] `Dialog.Title` is present (required for screen readers) - [ ] `Dialog.Description` provides context - [ ] Focus trapped inside modal when open - [ ] Escape key closes dialog - [ ] Focus returns to trigger on close ### Dropdown-Specific: - [ ] Arrow keys navigate items - [ ] Type-ahead search works - [ ] First/last item wrapping behavior - [ ] Selected state indicated visually and with ARIA --- ## Best Practices ### ✅ Do This 1. **Use `asChild` when composing with a compatible element that forwards props and refs** ```tsx ``` 2. **Provide semantic HTML** ```tsx
{/* content */}
``` 3. **Use CSS variables for theming** ```css .dialog-content { background: hsl(var(--surface)); color: hsl(var(--on-surface)); } ``` 4. **Compose primitives for complex components** ```tsx function CommandPalette() { return ( {/* Application combobox inside Dialog */} ); } ``` ### ❌ Don't Do This 1. **Don't skip accessibility parts** ```tsx // ❌ Missing Title and Description
Content
``` 2. **Don't fight the primitives** ```tsx // ❌ Overriding internal behavior e.stopPropagation()}> ``` 3. **Don't mix controlled and uncontrolled** ```tsx // ❌ Inconsistent state management ``` 4. **Don't ignore keyboard navigation** ```tsx // ❌ Disabling keyboard behavior e.preventDefault()}> ``` --- ## Troubleshooting ### Problem: Dialog doesn't close on Escape key **Cause**: `onEscapeKeyDown` event prevented or `open` state not synced **Solution**: ```tsx {/* Don't prevent default on escape */} ``` ### Problem: Dropdown menu positioning is off **Cause**: Parent container has `overflow: hidden` or transform **Solution**: ```tsx // Use Portal to render outside overflow container ``` ### Problem: Animations don't work **Cause**: Portal content unmounts immediately **Solution**: ```tsx // Use forceMount + AnimatePresence {open && } ``` ### Problem: TypeScript errors with `asChild` **Cause**: Type inference issues with polymorphic components **Solution**: ```tsx // Explicitly type your component ``` --- ## Performance Optimization ### 1. Code Splitting ```tsx // Lazy load heavy primitives // Lazy-load your complete component, which must have a default export. const SettingsDialog = lazy(() => import('./SettingsDialog')); // Render inside Suspense; a Radix namespace is not a React component. ``` ### 2. Portal Container Reuse ```tsx // Create portal container once {/* Provider shares tooltip timing/context; portal containers are configured separately */} ... ... ``` ### 3. Memoization ```tsx // Memoize expensive render functions const SelectItems = memo(({ items }) => ( items.map((item) => ) )); ``` --- ## Integration with Popular Tools ### shadcn/ui (Built on Radix) shadcn/ui is a collection of copy-paste components built with Radix + Tailwind. ```bash npx shadcn@latest init npx shadcn@latest add dialog ``` **When to use shadcn vs raw Radix**: - Use shadcn: Quick prototyping, standard designs - Use raw Radix: Full customization, unique designs ### Radix Themes (Official Styled System) ```tsx import { Theme, Button, Dialog } from '@radix-ui/themes'; function App() { return ( ); } ``` --- ## Related Skills - `@tailwind-design-system` - Tailwind + Radix integration patterns - `@react-patterns` - React composition patterns - `@frontend-design` - Overall frontend architecture - `@accessibility-compliance` - WCAG compliance testing --- ## Resources ### Official Documentation - [Radix UI Docs](https://www.radix-ui.com/primitives) - [Radix Colors](https://www.radix-ui.com/colors) - Accessible color system - [Radix Icons](https://www.radix-ui.com/icons) - Icon library ### Community Resources - [shadcn/ui](https://ui.shadcn.com) - Component collection - [Radix UI Discord](https://discord.com/invite/7Xb99uG) - Community support - [CVA Documentation](https://cva.style/docs) - Variant management ### Examples - [Radix Playground](https://www.radix-ui.com/primitives/docs/overview/introduction#try-it-out) - [shadcn/ui Source](https://github.com/shadcn-ui/ui) - Production examples --- ## Quick Reference ### Installation ```bash npm install @radix-ui/react-{primitive-name} ``` ### Basic Pattern ```tsx ``` ### Key Props - `asChild` - Render as child element - `defaultValue` - Uncontrolled default - `value` / `onValueChange` - Controlled state - `open` / `onOpenChange` - Open state - `side` / `align` - Positioning --- **Remember**: Radix gives you **behavior**, you give it **beauty**. Accessible behavior is provided by primitives, but labels, contrast, composition and application testing remain your responsibility.