Public API Reference

This page lists the public API surfaces Boreal UI publishes for consumers and documentation tooling. The generated TypeScript declarations and package.json exports remain the source of truth; this guide explains how those APIs are intended to be imported.

Primary Entry Points

Use the explicit core or next entry in application code.

import "@boreal-ui/core/globals.css";
import { Button, Card, ThemeProvider } from "@boreal-ui/core";

"use client";

import "@boreal-ui/next/globals.css";
import { Button, Card, ThemeProvider } from "@boreal-ui/next";

Next.js Server Component Exports

Import static server-rendered UI from @boreal-ui/next/server or a per-component server path:

import {
  BreadCrumbPageHeader,
  Card,
  MetricBox,
  Timeline,
} from "@boreal-ui/next/server";
import Footer from "@boreal-ui/next/server/Footer";

Available server entries:

Alert, Avatar, Badge, BarChart, BreadCrumbPageHeader, Breadcrumbs, Button, Card, CheckBox, Divider, EmptyState, Footer, Layout, Legend, LineChart, MetricBox, PageHeader, ProgressBar, RadioButton, RadioGroup, Select, Skeleton, Sparkline, TextArea, TextInput, ThemeProvider, Timeline, Toolbar, Typography, and ValidationSummary.

The Layout server entry exports Container, Grid, Inline, Section, Stack, BentoBox, and BentoBoxItem. Normally interactive entries expose stripped static APIs without callbacks. See Next.js Server Components for behavior and examples.

Barrel Component Exports

The core and next barrels export the same component names:

Standalone paths use the same camel-case component names as the barrels.

Standalone Component Imports

Use standalone imports when you want a direct component path.

import Button from "@boreal-ui/core/Button";
import NextButton from "@boreal-ui/next/Button";

Standalone component paths:

Layout standalone paths export the layout primitives: Container, Grid, Inline, Section, Stack, BentoBox, and BentoBoxItem.

Theme and Configuration APIs

Generated Prop Docs

Generated prop metadata is available from the optional docs package.

import {
  buttonPropDocs,
  radioGroupPropDocs,
  themeSelectPropDocs,
  type GeneratedComponentDoc,
} from "@boreal-ui/docs";

Prop-doc exports:

accordionPropDocs, alertPropDocs, appShellPropDocs, avatarPropDocs, badgePropDocs, barChartPropDocs, bentoBoxPropDocs, bentoBoxItemPropDocs, breadCrumbPageHeaderPropDocs, breadcrumbsPropDocs, buttonPropDocs, cardPropDocs, checkBoxPropDocs, chipGroupPropDocs, chipPropDocs, circularProgressPropDocs, colorPickerPropDocs, comboBoxPropDocs, commandPalettePropDocs, containerPropDocs, dataTablePropDocs, datePickerPropDocs, dateRangePickerPropDocs, dateTimePickerPropDocs, dividerPropDocs, donutChartPropDocs, drawerPropDocs, dropdownPropDocs, emptyStatePropDocs, fieldSetPropDocs, fileUploadPropDocs, footerPropDocs, formFieldPropDocs, formGroupPropDocs, gridPropDocs, iconButtonPropDocs, inlinePropDocs, inputGroupPropDocs, legendPropDocs, lineChartPropDocs, markdownRendererPropDocs, menuPropDocs, messagePopupPropDocs, metricBoxPropDocs, modalPropDocs, multiSelectPropDocs, navBarPropDocs, notificationCenterPropDocs, numberInputPropDocs, pageHeaderPropDocs, pagerPropDocs, popOverPropDocs, portalPropDocs, progressBarPropDocs, radioButtonPropDocs, radioGroupPropDocs, ratingPropDocs, scrollToTopPropDocs, searchInputPropDocs, sectionPropDocs, segmentedControlPropDocs, selectPropDocs, sidebarPropDocs, skeletonPropDocs, sliderPropDocs, sparklinePropDocs, spinnerPropDocs, splitPanePropDocs, stackPropDocs, stepperPropDocs, tabsPropDocs, tagInputPropDocs, textAreaPropDocs, textInputPropDocs, themeSelectPropDocs, timePickerPropDocs, timelinePropDocs, toastProviderPropDocs, togglePropDocs, toolbarPropDocs, tooltipPropDocs, treeViewPropDocs, typographyPropDocs, and validationSummaryPropDocs.

Use the generated prop docs for component-specific prop tables. Native HTML passthrough attributes remain documented by the published TypeScript declarations rather than being expanded into the metadata. Use this markdown guide for import paths and usage-level orientation.