# Documentation

- [ObjectUI Documentation](/docs): Build schema-driven React interfaces with ObjectUI, Tailwind CSS, and Shadcn UI
- [API Reference](/docs/api): Complete API reference for ObjectUI schema types, components, and utilities
- [Schema Type Reference](/docs/api/schema-reference): Complete API reference for all ObjectUI schema types with annotated examples
- [Component Gallery](/docs/components): Explore all ObjectUI components organized by category
- [Authentication Blocks](/docs/blocks/authentication): Login forms, signup pages, and authentication flows
- [Block Schema (BlockSchema)](/docs/blocks/block-schema): Reusable component blocks with variables, slots, and marketplace support
- [Dashboard Blocks](/docs/blocks/dashboard): Stats cards, metrics, and dashboard layouts
- [E-commerce Blocks](/docs/blocks/ecommerce): Product cards, checkout flows, and shopping components
- [Form Blocks](/docs/blocks/forms): Contact forms, settings panels, and form layouts
- [Building Blocks](/docs/blocks): Clean, modern building blocks. Copy and paste into your apps. Open Source. Free forever.
- [Marketing Blocks](/docs/blocks/marketing): Pricing tables, hero sections, and marketing components
- [Application Schema (AppSchema)](/docs/core/app-schema): Configure your entire application with navigation, branding, and global settings
- [Enhanced Actions](/docs/core/enhanced-actions): Advanced action system with AJAX calls, chaining, conditions, and callbacks
- [Report Schema (ReportSchema)](/docs/core/report-schema): Enterprise reports with aggregation, export, and scheduling
- [SchemaRenderer](/docs/core/schema-renderer): Core component for rendering JSON schemas into React components
- [Theme Schema (ThemeSchema)](/docs/core/theme-schema): Dynamic theming with light/dark modes, color palettes, and typography
- [AutoNumber Field](/docs/fields/auto-number): Read-only auto-generated sequence number
- [Boolean Field](/docs/fields/boolean): Switch/checkbox input for true/false values
- [Currency Field](/docs/fields/currency): Formatted currency input with locale support
- [Date Field](/docs/fields/date): Date picker input for date and datetime values
- [DateTime Field](/docs/fields/datetime): Date and time input with combined picker
- [Email Field](/docs/fields/email): Email input with validation
- [File Field](/docs/fields/file): File upload with multiple file support and metadata display
- [Formula Field](/docs/fields/formula): Read-only computed field with automatic calculation
- [Grid Field](/docs/fields/grid): Sub-table field for inline tabular data
- [Image Field](/docs/fields/image): Image upload with thumbnail preview and multiple image support
- [Location Field](/docs/fields/location): Geographic coordinates input for latitude and longitude
- [Lookup Field](/docs/fields/lookup): Reference field for linking to other objects/records
- [Number Field](/docs/fields/number): Numeric input field for integer and decimal numbers
- [Object Field](/docs/fields/object): JSON object editor for structured data
- [Password Field](/docs/fields/password): Secure password input with visibility toggle
- [Percent Field](/docs/fields/percent): Percentage input with automatic conversion and formatting
- [Phone Field](/docs/fields/phone): Phone number input with formatting
- [Rich Text Field](/docs/fields/rich-text): Rich text editor for formatted content
- [Select Field](/docs/fields/select): Dropdown selection field with single or multiple options
- [Summary Field](/docs/fields/summary): Read-only aggregation field for rollup calculations
- [Text Field](/docs/fields/text): Single-line text input field for basic text entry
- [TextArea Field](/docs/fields/textarea): Multi-line text input for longer content
- [Time Field](/docs/fields/time): Time-only input field for hour and minute selection
- [URL Field](/docs/fields/url): URL input with validation and link rendering
- [User Field](/docs/fields/user): User and owner selector with avatar display
- [Vector Field](/docs/fields/vector): Vector embeddings viewer for AI/ML data
- [Agent Skills](/docs/guide/agent-skills): Install the ObjectUI Agent Skill into Claude Code, Cursor, Codex, GitHub Copilot, Windsurf, Gemini, Cline, and other agents with a single command.
- [Architecture Overview](/docs/guide/architecture-overview): Deep dive into the ObjectUI 3-layer architecture, data flow, plugin system, state management, and action system.
- [Architecture Overview](/docs/guide/architecture): Understanding ObjectUI's architecture, design principles, and how the pieces fit together
- [Building a CRUD App](/docs/guide/building-crud-app): End-to-end tutorial for building a complete CRUD application with ObjectUI — from schema definition to deployment
- [CI/CD Pipeline](/docs/guide/ci-cd-pipeline): Overview of the ObjectUI continuous integration and deployment workflows.
- [Component Registry](/docs/guide/component-registry): undefined
- [Console Architecture](/docs/guide/console-architecture): Internal architecture of the ObjectStack Console — data flow, routing, and how JSON metadata becomes a working UI.
- [Console App](/docs/guide/console): Getting started with the ObjectStack Console — the reference SDUI application for ObjectUI.
- [Dashboard-Level Filters](/docs/guide/dashboard-filters): undefined
- [Data Connectivity](/docs/guide/data-source): undefined
- [Deployment](/docs/guide/deployment): Deploy ObjectUI applications to Docker, Vercel, Railway, Netlify, and other platforms with production-ready configurations.
- [Designing App Navigation](/docs/guide/designing-app-navigation): How to choose between object navigation, named views, custom pages, and dashboards when composing an app
- [Expression System](/docs/guide/expressions): undefined
- [Field Registry](/docs/guide/fields): undefined
- [Flow Designer](/docs/guide/flow-designer): Authoring automation flows on the visual canvas — nodes, edges, the searchable add-node palette, the node inspector, validation, and simulation.
- [Guide](/docs/guide): Complete guide to using ObjectUI - from getting started to advanced concepts
- [Layout System](/docs/guide/layout): Understanding ObjectUI's layout components for building application shells and page structures
- [Metadata Diagnostics](/docs/guide/metadata-diagnostics): How ObjectStack surfaces load-time validation problems in Studio.
- [ObjectOS Integration Guide](/docs/guide/objectos-integration): Complete guide for integrating ObjectUI with ObjectOS platform
- [Custom Plugin Development](/docs/guide/plugin-development): undefined
- [Plugins](/docs/guide/plugins): undefined
- [Public Forms](/docs/guide/public-forms): Embed hardened public-facing forms — contact, lead capture, signup — with built-in anti-spam, GDPR consent, prefill whitelist, and open-redirect protection.
- [Quick Start](/docs/guide/quick-start): Get up and running with ObjectUI in 5 minutes - install, configure, and render your first server-driven UI
- [Record Edit Modes](/docs/guide/record-edit-modes): Choose between modal and full-page record forms with the editMode metadata flag.
- [Release Notes](/docs/guide/release-notes): Release notes for ObjectUI — highlights, breaking changes and migration notes for each version.
- [Schema Catalog](/docs/guide/schema-catalog): Browseable index of every JSON schema used in the ObjectUI docs.
- [Schema Overview](/docs/guide/schema-overview): Comprehensive overview of ObjectUI schemas for building enterprise applications
- [Schema Playground](/docs/guide/schema-playground): Interactive schema playground for experimenting with ObjectUI schemas — edit JSON, see live UI, and learn by doing
- [Schema Rendering](/docs/guide/schema-rendering): undefined
- [Slotted Pages](/docs/guide/slotted-pages): Customize record detail pages by overriding only the slots you care about — let the default synthesizer handle the rest.
- [Theming & Customization](/docs/guide/theming): Customize the look-and-feel of ObjectUI components with CSS custom properties, Tailwind CSS, cva variants, and runtime theme switching
- [Troubleshooting](/docs/guide/troubleshooting): Solutions to common issues when building with ObjectUI.
- [User-Scoped State Persistence](/docs/guide/user-state-persistence): undefined
- [AppShell](/docs/layout/app-shell): Main application shell with sidebar and header layout
- [PageHeader](/docs/layout/page-header): Page header component with title, description, and actions
- [SidebarNav](/docs/layout/sidebar-nav): Sidebar navigation component with active state, icons, badges, nested items, and search
- [RFC 0001 — Excel-style Clipboard Paste](/docs/rfcs/0001-clipboard-paste): undefined
- [ObjectUI CLI](/docs/utilities/cli): Standalone command-line interface for building ObjectUI applications from JSON/YAML schemas
- [Create Plugin](/docs/utilities/create-plugin): Interactive CLI tool for creating ObjectUI plugins
- [ObjectStack Data Adapter](/docs/utilities/data-objectstack): Data adapter for connecting ObjectUI to ObjectStack backends
- [Utilities & Tools](/docs/utilities): Command-line tools and utilities for ObjectUI development
- [Runner](/docs/utilities/runner): Universal runtime for ObjectUI applications
- [VS Code Extension](/docs/utilities/vscode-extension): Visual Studio Code extension for ObjectUI schema development
- [Plugin Gallery](/docs/plugins): Explore all ObjectUI plugins for extended functionality
- [Plugin AI](/docs/plugins/plugin-ai): AI-driven UI plugin for Object UI — schema generation, conversational assistants and Vercel AI SDK integration
- [Plugin Calendar View](/docs/plugins/plugin-calendar-view): undefined
- [Plugin Calendar](/docs/plugins/plugin-calendar): undefined
- [Plugin Charts](/docs/plugins/plugin-charts): undefined
- [Plugin Chatbot](/docs/plugins/plugin-chatbot): undefined
- [Plugin Dashboard](/docs/plugins/plugin-dashboard): undefined
- [Plugin Designer](/docs/plugins/plugin-designer): Visual designer plugin for Object UI with page, data model, process, and report designers plus collaborative editing.
- [Plugin Detail — Feed & Chatter](/docs/plugins/plugin-detail): undefined
- [Plugin Editor](/docs/plugins/plugin-editor): undefined
- [Plugin Form](/docs/plugins/plugin-form): undefined
- [Plugin Gantt](/docs/plugins/plugin-gantt): undefined
- [Plugin Grid](/docs/plugins/plugin-grid): undefined
- [Plugin Kanban](/docs/plugins/plugin-kanban): undefined
- [Plugin List](/docs/plugins/plugin-list): ListView plugin for Object UI - unified view component with view type switching
- [Plugin Map](/docs/plugins/plugin-map): undefined
- [Plugin Markdown](/docs/plugins/plugin-markdown): undefined
- [Plugin Report](/docs/plugins/plugin-report): Spec-driven reports for Object UI — Tabular, Summary, Matrix and Joined views over any object, with server-side aggregation, drill-down and printable export
- [Plugin Timeline](/docs/plugins/plugin-timeline): undefined
- [Plugin View](/docs/plugins/plugin-view): undefined
- [Button Group](/docs/components/basic/button-group): Group multiple buttons together with shared styling
- [Div (Deprecated)](/docs/components/basic/div): Generic container element - use Shadcn components instead
- [HTML](/docs/components/basic/html): Render raw HTML content safely
- [Icon](/docs/components/basic/icon): Display icons from the Lucide icon library
- [Image](/docs/components/basic/image): Display images with optional fallback
- [Navigation Menu](/docs/components/basic/navigation-menu): Accessible navigation menu with dropdown support
- [Pagination](/docs/components/basic/pagination): Navigate through pages of content
- [Separator](/docs/components/basic/separator): Visual divider between content sections
- [Sidebar](/docs/components/basic/sidebar): Collapsible navigation sidebar
- [Span (Deprecated)](/docs/components/basic/span): Inline container - use Badge or text components instead
- [Text](/docs/components/basic/text): Display text with standardized typography styles
- [Carousel](/docs/components/complex/carousel): Slideshow component for cycling through content
- [Data Table](/docs/components/complex/data-table): Enterprise-grade data table with sorting, filtering, pagination, and row actions
- [Filter Builder](/docs/components/complex/filter-builder): Visual query builder for constructing complex filter conditions
- [Filter UI](/docs/components/complex/filter-ui): Build flexible filter panels for list and view toolbars
- [Resizable](/docs/components/complex/resizable): Resizable panel groups with draggable handles
- [Scroll Area](/docs/components/complex/scroll-area): Customizable scrollable container with styled scrollbars
- [Sort UI](/docs/components/complex/sort-ui): Configure sorting with dropdowns or button toggles
- [Table](/docs/components/complex/table): Display data in tabular format
- [View Switcher](/docs/components/complex/view-switcher): Switch between multiple view configurations in one container
- [Alert](/docs/components/data-display/alert): Display important messages and notifications
- [Avatar](/docs/components/data-display/avatar): User profile image or fallback initials
- [Badge](/docs/components/data-display/badge): Small status or label indicator
- [Breadcrumb](/docs/components/data-display/breadcrumb): Display the current location within a navigational hierarchy
- [Kbd](/docs/components/data-display/kbd): Display keyboard shortcuts and hotkeys
- [List](/docs/components/data-display/list): Display a list of items
- [Statistic](/docs/components/data-display/statistic): Display key metrics and statistical values with trend indicators
- [Tree View](/docs/components/data-display/tree-view): Hierarchical tree structure for displaying nested data
- [Accordion](/docs/components/disclosure/accordion): Expandable content sections
- [Collapsible](/docs/components/disclosure/collapsible): Toggle visibility of content
- [Toggle Group](/docs/components/disclosure/toggle-group): A group of toggle buttons where one or more can be selected
- [Empty](/docs/components/feedback/empty): Empty state placeholder with optional action
- [Loading](/docs/components/feedback/loading): Loading spinner to indicate processing
- [Progress](/docs/components/feedback/progress): Progress bar to show completion status
- [Skeleton](/docs/components/feedback/skeleton): Placeholder for loading content
- [Sonner](/docs/components/feedback/sonner): Toast notifications using Sonner library
- [Spinner](/docs/components/feedback/spinner): Loading spinner indicator
- [Toast](/docs/components/feedback/toast): Brief notification messages that appear temporarily
- [Toaster](/docs/components/feedback/toaster): Container for displaying toast notifications
- [Button](/docs/components/form/button): Trigger actions and events with customizable button styles
- [Calendar](/docs/components/form/calendar): Date selection component with single, multiple, and range modes
- [Checkbox](/docs/components/form/checkbox): Toggle selection with checkboxes
- [Combobox](/docs/components/form/combobox): Searchable dropdown for selecting from a list of options
- [Command](/docs/components/form/command): Fast command menu with search and keyboard navigation
- [Date Picker](/docs/components/form/date-picker): Input for selecting dates with a calendar popup
- [File Upload](/docs/components/form/file-upload): Modern file upload component with drag-and-drop support
- [Form](/docs/components/form/form): Form container with validation and submission handling
- [Input OTP](/docs/components/form/input-otp): One-time password input with auto-focus
- [Input](/docs/components/form/input): Basic text input field for user data entry
- [Label](/docs/components/form/label): Text label for form elements
- [Radio Group](/docs/components/form/radio-group): A set of checkable buttons where only one can be selected at a time
- [Select](/docs/components/form/select): Dropdown selection from a list of options
- [Slider](/docs/components/form/slider): Select a value from a range
- [Switch](/docs/components/form/switch): Toggle switch for binary options
- [Textarea](/docs/components/form/textarea): Multi-line text input for longer content
- [Toggle](/docs/components/form/toggle): Two-state button for toggling options on and off
- [Aspect Ratio](/docs/components/layout/aspect-ratio): Maintain a consistent width to height ratio
- [Card](/docs/components/layout/card): Container with header, content, and footer sections
- [Container](/docs/components/layout/container): Centered content container with max-width
- [Flex](/docs/components/layout/flex): Flexible box layout container
- [Grid](/docs/components/layout/grid): Responsive grid layout container
- [Page](/docs/components/layout/page): Full-page container with title, description, and content sections
- [Semantic](/docs/components/layout/semantic): Semantic HTML5 elements for structured content (header, nav, main, aside, section, article, footer)
- [Stack](/docs/components/layout/stack): Vertical stack layout for organizing content
- [Tabs](/docs/components/layout/tabs): Organize content into switchable tabs
- [Header Bar](/docs/components/navigation/header-bar): Application header with sidebar trigger and breadcrumb navigation
- [Alert Dialog](/docs/components/overlay/alert-dialog): A modal dialog that interrupts the user with important content and expects a response
- [Context Menu](/docs/components/overlay/context-menu): Display a menu on right-click or long-press
- [Dialog](/docs/components/overlay/dialog): Modal dialog overlay for focused interactions
- [Drawer](/docs/components/overlay/drawer): Sliding panel from edge of screen
- [Dropdown Menu](/docs/components/overlay/dropdown-menu): Display a menu of actions or options triggered by a button
- [Hover Card](/docs/components/overlay/hover-card): Display rich content in a popup when hovering over a trigger
- [Menubar](/docs/components/overlay/menubar): Horizontal menu bar with dropdown menus
- [Popover](/docs/components/overlay/popover): Floating content panel
- [Sheet](/docs/components/overlay/sheet): Slide-in panel from the edge of the screen
- [Tooltip](/docs/components/overlay/tooltip): Contextual information on hover