Learn the system
Components Overview
Explore accessible UI building blocks designed for React and Next.js projects.
Installation & Imports
Choose the scoped Core or Next package, load globals once, and use component subpath imports with shared types.
Boreal UI CLI
Configure existing React and Next.js apps with globals, ThemeProvider, and Boreal defaults from the command line.
Server Components
Render static Boreal UI directly in Next.js Server Components, including SSR-safe theme setup and stripped interactive APIs.
Component API Patterns
Learn the shared API conventions behind accessible props, forms, tables, overlays, testing hooks, and styling hooks.
Public API
Map Boreal UI entry points, component exports, theme helpers, public types, and generated prop docs.
Prop Docs & Types
Use @boreal-ui/types and the matching generated docs package for wrappers, prop tables, and custom documentation tooling.
Accessibility Guide
Compose Boreal UI components into accessible forms, tables, overlays, async states, and complete workflows.
Performance & Async Behavior
Understand timer ownership, completion-based polling, stable table keys, cleanup behavior, and efficient theme rendering.
Development Workflow
Keep source components, generated metadata, package exports, and markdown documentation in sync.
Theming & Customization
Customize color schemes, SCSS variables, typography, spacing, and defaults.
Boreal UI Core Starter Project
Start from a lean React workspace when you want Boreal UI without a framework opinion. It is the quickest path for Vite-style apps, prototypes, and component playgrounds.
- Client-rendered React setup
- Boreal globals and theme wiring
Boreal UI Next Starter Project
Use the Next starter when you want the App Router, site shell, and package imports already arranged for a production-facing Boreal UI app.
- App Router project structure
- Next package imports and layout setup
Found a bug? Have an idea?
Open an issue or join the discussion on GitHub to help improve Boreal UI.