Guides
Use and adapt boardui
Use and adapt boardui: React design system for agentic interfaces. Every free BoardUI component as source, with a working AI chat app on your own model key as the homepage.
Use the documented interfaces and source layout for boardui. The sections below retain the README’s examples and configuration details.
Components
Application blocks
Composed screens and panels: sidebars, chat, tables, settings, cards.
| Component | What it is | Install |
|---|---|---|
| Agent Chat | A working chat app: app sidebar, streaming replies, thinking indicator, a composer pill with stop control, a chat-history rail with local thread switching, and a setup notice when no provider key is set. | npx boardui@latest add agent-chat |
| Agent Log | Shared streaming-log machinery: the reveal ticker, the blur-in with its soft clipping edge, and the curved tree guide that draws itself. Behind Task List and Web Search. | npx boardui@latest add agent-log |
| Agent Thinking | Agent thinking indicator for chat composers — dot wave, dot spin, stars, and infinity variants with a shimmering label and elapsed timer. | npx boardui@latest add agent-thinking |
| App Shell | Page frame for the chat starter: the sidebar, a phone drawer, and a titled content card, carrying the starter's own navigation so the sidebar only links to pages the app has. | npx boardui@latest add app-shell |
| Auth Card | Sign-in and sign-up cards with social providers stacked with labels or inline as icons, plus email fields and a CTA. | npx boardui@latest add auth-card |
| Composer Loader | Loading state that wraps a chat composer — an iridescent light band orbiting the rim with a soft inward bloom, fading in while the agent works. | npx boardui@latest add composer-loader |
| Data Table | TanStack-powered data table with sorting, selection, and pagination. | npx boardui@latest add data-table |
| Important Alerts Card | Scrollable alert feed with tinted icon circles and date pills. | npx boardui@latest add important-alerts-card |
| Notification Center | Tabbed activity inbox with grouped notifications, unread state, avatars, status icons, and inline actions. | npx boardui@latest add notification-center |
| Orders Chart Card | Free chart card: a year of monthly orders as bars, this year beside last year for every month, with a count-up headline, delta chip and hover readout. | npx boardui@latest add orders-chart-card |
| Patient Info Card | Profile card with avatar and label/value detail rows. | npx boardui@latest add patient-info-card |
| Revenue Chart Card | Free chart card: a year of monthly revenue as an area against the year before, with a count-up headline, delta chip and hover readout per month. | npx boardui@latest add revenue-chart-card |
| Settings Modal | Controlled multi-page settings dialog with General, Profile, Tools, and Storage views. | npx boardui@latest add settings-modal |
| Sidebar | The floating dashboard sidebar with team menu, nav, announcement, and user menu. | npx boardui@latest add sidebar |
| Stat Cards | KPI stat card row with delta chips. | npx boardui@latest add stat-cards |
| Theme Toggle | Manual light/dark control with a click-origin reveal, local persistence, and no system-theme dependency. | npx boardui@latest add theme-toggle |
Base components
The everyday building blocks.
| Component | What it is | Install |
|---|---|---|
| Announcement | Dismissible announcement card used in the sidebar footer. | npx boardui@latest add announcement |
| Avatar | Image or initials avatar in multiple sizes and tints. | npx boardui@latest add avatar |
| Badge | Counter pills and the Kbd shortcut hint. | npx boardui@latest add badge |
| Breadcrumb | Icon-capable breadcrumb trail. | npx boardui@latest add breadcrumb |
| Button | Primary, secondary, ghost, and danger buttons in three sizes with icon support. | npx boardui@latest add button |
| Button Group | Row of secondary-style buttons fused into one bordered control with hairline dividers and selectable items. | npx boardui@latest add button-group |
| Carousel | Gallery carousel built on CSS scroll-snap: swipe, arrows and a position indicator. | npx boardui@latest add carousel |
| Checkbox | React Aria checkbox with animated tick and indeterminate state. | npx boardui@latest add checkbox |
| Checkbox Card | Bordered selectable card driven by a checkbox. | npx boardui@latest add checkbox-card |
| Chip | Status/delta chips in bold and soft variants across the accent palette. | npx boardui@latest add chip |
| Close Button | Compact dismiss button for banners, modals, and chips. | npx boardui@latest add close-button |
| Date Picker | Single-date picker with month navigation, built on React Aria. | npx boardui@latest add date-picker |
| Date Range Picker | Two-month range picker sharing the date-picker chrome. | npx boardui@latest add date-range-picker |
| Divider | Horizontal content divider with single-line, double-line, filled, and aligned variants. | npx boardui@latest add divider |
| Dropdown | Composable popover menu (trigger, panel, groups, rows, dividers) built on React Aria — the recipe behind the sidebar team/account menus. | npx boardui@latest add dropdown |
| File Upload | Drag-and-drop file upload with validation, animated progress, and a completion callback. | npx boardui@latest add file-upload |
| Icon Button | Square icon-only button in two sizes. | npx boardui@latest add icon-button |
| Input | Text input with label, hint text, error states, and leading icon support. | npx boardui@latest add input |
| Input OTP | One-time-code field with a monospace box per digit, paste distribution and autofill support. | npx boardui@latest add input-otp |
| Kbd | Keyboard shortcut hint pill. | npx boardui@latest add kbd |
| Link Button | Inline text action styled like a link — primary/secondary variants, three sizes, icon support, renders or . | npx boardui@latest add link-button |
| Meeting Scheduler | Date + time-slot scheduler popover. | npx boardui@latest add meeting-scheduler |
| Notification | Dismissible notification with status icons, avatars, action buttons, and timed countdown. | npx boardui@latest add notification |
| Pagination | Numbered pagination with prev/next and ellipsis collapsing. | npx boardui@latest add pagination |
| Radio | React Aria radio group with the gradient selected dot, two sizes, and the bare RadioDot glyph for menu rows. | npx boardui@latest add radio |
| Radio Card | Bordered selectable card driven by a radio — the radio flavor of Checkbox Card. | npx boardui@latest add radio-card |
| Segmented Control | Pill-style segmented control (Weekly / Monthly / Yearly switchers). | npx boardui@latest add segmented-control |
| Select | React Aria select with styled trigger, non-modal popover, and free-form item content. | npx boardui@latest add select |
| Slider | Single-value and min/max range sliders with exact-value bubbles and keyboard controls. | npx boardui@latest add slider |
| Social Button | Sign-in buttons for 24 providers, with brand logos, three colour treatments and an icon-only form. | npx boardui@latest add social-button |
| Status Dot | Colored status indicator dot used inside selects and tables. | npx boardui@latest add status-dot |
| Switch | Skeuomorphic toggle switch in two sizes. | npx boardui@latest add switch |
| Switch Card | Bordered settings row driven by a switch. | npx boardui@latest add switch-card |
| Table | Static table primitives matching the dashboard tables. | npx boardui@latest add table |
| Tabs | Underline and pill tab variants built on React Aria. | npx boardui@latest add tabs |
| Tooltip | Light-surface tooltip built on React Aria. | npx boardui@latest add tooltip |
Foundations
Tokens, type scale, global styles, utilities, and the agent rules.
| Component | What it is | Install |
|---|---|---|
| Agent rules | Always-on design rules for AI agents (semantic tokens, type scale, conventions), installed as a Cursor rule file. | npx boardui@latest add rules |
| Agent runtime | Streaming chat endpoint for agent templates: one AI_API_KEY from OpenAI, Anthropic, Google, OpenRouter, Groq, xAI or Vercel AI Gateway (or any OpenAI-compatible server by URL), a config probe for unconfigured deploys, and the message contract the BoardUI chat UI installs against. | npx boardui@latest add agent-runtime |
| Chevron icons | Custom chevron glyphs (select caret, sortable table headers) matching the Figma strokes. | npx boardui@latest add chevrons |
| cx utility | tailwind-merge wrapper aware of BoardUI's composite text styles, plus the sortCx helper. | npx boardui@latest add cx |
| Global styles | Tailwind entry css: dark-mode variant, base resets, component animations, and table styling. Imports theme.css and typography.css. | npx boardui@latest add globals |
| Logo | BoardUI brand mark placeholder — swap with your own logo component. | npx boardui@latest add logo |
| Theme tokens | Color primitives, semantic tokens (text/background/border/foreground/chart), radii, shadows, and button gradient utilities. | npx boardui@latest add theme |
| Typography tokens | The full Figma type scale as composite text-{family}-{weight} Tailwind utilities. | npx boardui@latest add typography |
| useCountUp hook | Animated rolling number hook used by chart headline figures. | npx boardui@latest add use-count-up |
| useDismissOnOutsidePress hook | Closes React Aria popovers on outside press without swallowing the outside click. | npx boardui@latest add use-dismiss-on-outside-press |
Commands in the root manifest
The captured package.json declares the following scripts. Run them from the directory containing that manifest.
| Command | Script |
|---|---|
npm run dev | next dev |
npm run build | next build |
npm run start | next start |
npm run typecheck | tsc --noEmit |
Troubleshoot a local change
- Reproduce the smallest example from the quick-start guide.
- Compare required configuration and dependency versions with the README.
- Check the linked issue tracker for the same error. Include the command, runtime version, and relevant error when reporting a problem; omit credentials.
Source and help
The catalog identifies the license as MIT. Read the repository license before redistributing source or assets.
This catalog entry is a fork. The README may describe upstream packages, domains, or release procedures; those destinations do not establish a separate release of this fork.
Source captured: 2026-10-11