@brite-nites/sandbox-kit
v0.14.1
Published
The Brite Sandbox Kit — the imported Sandbox Harness (explorer chrome, Design System reference pages, review tooling, Workspace engine) that consumers mount behind their own routes. Extracted from @brite-nites/design-system's ./sandbox-kit subpath per ADR
Readme
@brite-nites/sandbox-kit
The Brite Sandbox Kit — the imported Sandbox Harness (ADR-0005): explorer chrome, Design System reference pages, review tooling, and the Workspace engine that render the BriteBase Design System inside a Consumer's own app. A Consumer supplies one SandboxConfig and edits nothing; the reference pages are locked canon (hide sections, never fork them).
Extracted from @brite-nites/design-system's ./sandbox-kit subpath in 0.6.0. Migrating from the subpath is a specifier-prefix swap:
- import { SandboxShell } from "@brite-nites/design-system/sandbox-kit";
+ import { SandboxShell } from "@brite-nites/sandbox-kit";
- import { ComponentDetail } from "@brite-nites/design-system/sandbox-kit/component-detail";
+ import { ComponentDetail } from "@brite-nites/sandbox-kit/component-detail";Install
npm install @brite-nites/sandbox-kitPublic npm, no registry auth. @brite-nites/design-system is a peer — the Kit renders the Design System's own primitives, so consumers that mount the Kit already have it. Declared peers (installed automatically by npm ≥7 / pnpm with auto-install-peers): @brite-nites/design-system, react, react-dom, next, radix-ui, @phosphor-icons/react, react-hook-form, sonner.
Your globals.css needs the Design System styles plus a Tailwind @source for the Kit so its arbitrary-value utilities are generated:
@import "@brite-nites/design-system/styles";
@source "../../node_modules/@brite-nites/design-system/dist";
@source "../../node_modules/@brite-nites/sandbox-kit/dist";Layout
@brite-nites/sandbox-kit— barrel:SandboxShell,SandboxConfig,SandboxThemeProvider,VariantCard, …@brite-nites/sandbox-kit/<module>— every module is directly importable (/component-detail,/ds-catalog,/grid-workbench,/wizard/brand-wizard, …), mirroring the design-system's subpath-export convention so unused slices never enter your bundle.
Scaffolding a fresh sandbox into an app? Use @brite-nites/create-sandbox — it wires the routes, config, and both dependencies.
