From 18c4ddcd05cc229d82022d73f5444bbfeec7d116 Mon Sep 17 00:00:00 2001 From: Ubuntu Date: Sat, 10 Jan 2026 05:38:15 +0000 Subject: [PATCH] drover: task-1767764907653950146 Task: Improve API documentation --- docs/components/API_REFERENCE.md | 232 ++++++++++++ docs/components/api/accordion.md | 179 +++++++++ docs/components/api/alert-dialog.md | 159 ++++++++ docs/components/api/alert.md | 195 ++++++++++ docs/components/api/aspect-ratio.md | 103 +++++ docs/components/api/avatar.md | 150 ++++++++ docs/components/api/badge.md | 165 ++++++++ docs/components/api/breadcrumb.md | 175 +++++++++ docs/components/api/button.md | 383 +++++++++++++++++++ docs/components/api/calendar.md | 107 ++++++ docs/components/api/card.md | 499 +++++++++++++++++++++++++ docs/components/api/carousel.md | 157 ++++++++ docs/components/api/checkbox.md | 120 ++++++ docs/components/api/collapsible.md | 140 +++++++ docs/components/api/combobox.md | 135 +++++++ docs/components/api/command.md | 161 ++++++++ docs/components/api/context-menu.md | 149 ++++++++ docs/components/api/dialog.md | 488 ++++++++++++++++++++++++ docs/components/api/drawer.md | 139 +++++++ docs/components/api/dropdown-menu.md | 144 +++++++ docs/components/api/error-boundary.md | 84 +++++ docs/components/api/form.md | 95 +++++ docs/components/api/hover-card.md | 122 ++++++ docs/components/api/input-otp.md | 107 ++++++ docs/components/api/input.md | 481 ++++++++++++++++++++++++ docs/components/api/label.md | 88 +++++ docs/components/api/lazy-loading.md | 83 ++++ docs/components/api/menubar.md | 147 ++++++++ docs/components/api/navigation-menu.md | 148 ++++++++ docs/components/api/pagination.md | 131 +++++++ docs/components/api/popover.md | 134 +++++++ docs/components/api/progress.md | 108 ++++++ docs/components/api/radio-group.md | 142 +++++++ docs/components/api/registry.md | 69 ++++ docs/components/api/resizable.md | 132 +++++++ docs/components/api/scroll-area.md | 97 +++++ docs/components/api/select.md | 181 +++++++++ docs/components/api/separator.md | 117 ++++++ docs/components/api/sheet.md | 151 ++++++++ docs/components/api/skeleton.md | 105 ++++++ docs/components/api/slider.md | 123 ++++++ docs/components/api/switch.md | 196 ++++++++++ docs/components/api/table.md | 226 +++++++++++ docs/components/api/tabs.md | 305 +++++++++++++++ docs/components/api/textarea.md | 108 ++++++ docs/components/api/toast.md | 150 ++++++++ docs/components/api/toggle.md | 115 ++++++ docs/components/api/tooltip.md | 127 +++++++ 48 files changed, 8052 insertions(+) create mode 100644 docs/components/API_REFERENCE.md create mode 100644 docs/components/api/accordion.md create mode 100644 docs/components/api/alert-dialog.md create mode 100644 docs/components/api/alert.md create mode 100644 docs/components/api/aspect-ratio.md create mode 100644 docs/components/api/avatar.md create mode 100644 docs/components/api/badge.md create mode 100644 docs/components/api/breadcrumb.md create mode 100644 docs/components/api/button.md create mode 100644 docs/components/api/calendar.md create mode 100644 docs/components/api/card.md create mode 100644 docs/components/api/carousel.md create mode 100644 docs/components/api/checkbox.md create mode 100644 docs/components/api/collapsible.md create mode 100644 docs/components/api/combobox.md create mode 100644 docs/components/api/command.md create mode 100644 docs/components/api/context-menu.md create mode 100644 docs/components/api/dialog.md create mode 100644 docs/components/api/drawer.md create mode 100644 docs/components/api/dropdown-menu.md create mode 100644 docs/components/api/error-boundary.md create mode 100644 docs/components/api/form.md create mode 100644 docs/components/api/hover-card.md create mode 100644 docs/components/api/input-otp.md create mode 100644 docs/components/api/input.md create mode 100644 docs/components/api/label.md create mode 100644 docs/components/api/lazy-loading.md create mode 100644 docs/components/api/menubar.md create mode 100644 docs/components/api/navigation-menu.md create mode 100644 docs/components/api/pagination.md create mode 100644 docs/components/api/popover.md create mode 100644 docs/components/api/progress.md create mode 100644 docs/components/api/radio-group.md create mode 100644 docs/components/api/registry.md create mode 100644 docs/components/api/resizable.md create mode 100644 docs/components/api/scroll-area.md create mode 100644 docs/components/api/select.md create mode 100644 docs/components/api/separator.md create mode 100644 docs/components/api/sheet.md create mode 100644 docs/components/api/skeleton.md create mode 100644 docs/components/api/slider.md create mode 100644 docs/components/api/switch.md create mode 100644 docs/components/api/table.md create mode 100644 docs/components/api/tabs.md create mode 100644 docs/components/api/textarea.md create mode 100644 docs/components/api/toast.md create mode 100644 docs/components/api/toggle.md create mode 100644 docs/components/api/tooltip.md diff --git a/docs/components/API_REFERENCE.md b/docs/components/API_REFERENCE.md new file mode 100644 index 0000000..a784ace --- /dev/null +++ b/docs/components/API_REFERENCE.md @@ -0,0 +1,232 @@ +# Leptos Shadcn UI - Component API Reference + +Complete API documentation for all components in the leptos-shadcn-ui library. + +--- + +## Table of Contents + +- [Form Components](#form-components) +- [Layout Components](#layout-components) +- [Navigation Components](#navigation-components) +- [Overlay Components](#overlay-components) +- [Data Display & Feedback Components](#data-display--feedback-components) +- [Interactive Components](#interactive-components) +- [Utility Components](#utility-components) + +--- + +## Form Components + +### [Button](#button) | [Input](#input) | [Label](#label) | [Checkbox](#checkbox) | [Switch](#switch) | [Radio Group](#radio-group) | [Select](#select) | [Textarea](#textarea) | [Form](#form) | [Combobox](#combobox) | [Command](#command) | [Input OTP](#input-otp) + +--- + +## Layout Components + +### [Card](#card) | [Separator](#separator) | [Tabs](#tabs) | [Accordion](#accordion) | [Collapsible](#collapsible) | [Scroll Area](#scroll-area) | [Aspect Ratio](#aspect-ratio) | [Resizable](#resizable) + +--- + +## Navigation Components + +### [Breadcrumb](#breadcrumb) | [Navigation Menu](#navigation-menu) | [Context Menu](#context-menu) | [Dropdown Menu](#dropdown-menu) | [Menubar](#menubar) + +--- + +## Overlay Components + +### [Dialog](#dialog) | [Popover](#popover) | [Tooltip](#tooltip) | [Alert Dialog](#alert-dialog) | [Sheet](#sheet) | [Drawer](#drawer) | [Hover Card](#hover-card) + +--- + +## Data Display & Feedback Components + +### [Alert](#alert) | [Badge](#badge) | [Skeleton](#skeleton) | [Progress](#progress) | [Toast](#toast) | [Table](#table) | [Calendar](#calendar) | [Date Picker](#date-picker) | [Pagination](#pagination) + +--- + +## Interactive Components + +### [Slider](#slider) | [Toggle](#toggle) | [Carousel](#carousel) | [Avatar](#avatar) + +--- + +## Utility Components + +### [Error Boundary](#error-boundary) | [Lazy Loading](#lazy-loading) | [Registry](#registry) + +--- + +## Detailed Component Documentation + +Select a component below to view its complete API documentation: + +- **[Button](./api/button.md)** - Interactive button with multiple variants and sizes +- **[Input](./api/input.md)** - Text input with validation support +- **[Dialog](./api/dialog.md)** - Modal dialog component +- **[Card](./api/card.md)** - Content container with header, body, and footer +- **[Tabs](./api/tabs.md)** - Tabbed content switcher +- **[Select](./api/select.md)** - Dropdown selection component +- **[Checkbox](./api/checkbox.md)** - Binary selection input +- **[Switch](./api/switch.md)** - Toggle switch component +- **[Radio Group](./api/radio-group.md)** - Single selection from options +- **[Textarea](./api/textarea.md)** - Multi-line text input +- **[Label](./api/label.md)** - Form label component +- **[Form](./api/form.md)** - Form container with validation +- **[Alert](./api/alert.md)** - Alert message display +- **[Badge](./api/badge.md)** - Status indicator badge +- **[Skeleton](./api/skeleton.md)** - Loading placeholder +- **[Progress](./api/progress.md)** - Progress indicator +- **[Toast](./api/toast.md)** - Temporary notification +- **[Table](./api/table.md)** - Data table display +- **[Separator](./api/separator.md)** - Visual divider +- **[Accordion](./api/accordion.md)** - Collapsible content sections +- **[Collapsible](./api/collapsible.md)** - Show/hide content toggle +- **[Scroll Area](./api/scroll-area.md)** - Custom scrollable container +- **[Aspect Ratio](./api/aspect-ratio.md)** - Fixed aspect ratio container +- **[Resizable](./api/resizable.md)** - Resizable panel layout +- **[Breadcrumb](./api/breadcrumb.md)** - Navigation breadcrumb +- **[Navigation Menu](./api/navigation-menu.md)** - Site navigation +- **[Context Menu](./api/context-menu.md)** - Right-click context menu +- **[Dropdown Menu](./api/dropdown-menu.md)** - Dropdown action menu +- **[Menubar](./api/menubar.md)** - Application menu bar +- **[Dialog](./api/dialog.md)** - Modal dialog +- **[Popover](./api/popover.md)** - Floating content container +- **[Tooltip](./api/tooltip.md)** - Hover information tip +- **[Alert Dialog](./api/alert-dialog.md)** - Confirmation dialog +- **[Sheet](./api/sheet.md)** - Side panel drawer +- **[Drawer](./api/drawer.md)** - Slide-out drawer +- **[Hover Card](./api/hover-card.md)** - Hover-triggered card +- **[Calendar](./api/calendar.md)** - Date picker calendar +- **[Date Picker](./api/date-picker.md)** - Date selection component +- **[Pagination](./api/pagination.md)** - Page navigation +- **[Slider](./api/slider.md)** - Range slider input +- **[Toggle](./api/toggle.md)** - Toggle button +- **[Carousel](./api/carousel.md)** - Image/content carousel +- **[Avatar](./api/avatar.md)** - User avatar display +- **[Combobox](./api/combobox.md)** - Searchable select +- **[Command](./api/command.md)** - Command palette +- **[Input OTP](./api/input-otp.md)** - One-time password input +- **[Error Boundary](./api/error-boundary.md)** - Error handling wrapper +- **[Lazy Loading](./api/lazy-loading.md)** - Lazy component loading +- **[Registry](./api/registry.md)** - Component registry + +--- + +## Common Props Reference + +Most components support these common props: + +### Core Props +| Prop | Type | Default | Description | +|------|------|---------|-------------| +| `id` | `Option` | `None` | Unique identifier for the component | +| `class` | `Option` | `None` | Additional CSS classes | +| `style` | `Option