videorc/ui

Installation

Add the videorc/ui registry to a shadcn/ui project and install the theme and components with the shadcn CLI.

videorc/ui is a shadcn registry. You add components with the shadcn CLI, and the code lands in your project.

Requirements

  • React 19.2 or later and Tailwind CSS v4.
  • A shadcn/ui project on Base UI (a base-* style). The components import @base-ui/react.
  • shadcn/tailwind.css imported in your global stylesheet, after tailwindcss. It defines the data-open, data-checked, data-horizontal and other variants the components style with. Every base-* project has it.

Set up shadcn/ui

Skip this if your project already has a components.json.

$ pnpm dlx shadcn@latest init --base base

Add the registry

Add the @videorc namespace to components.json:

components.json
{
  "registries": {
    "@videorc": "https://ui.videorc.com/r/{name}.json"
  }
}

Add the theme

$ pnpm dlx shadcn@latest add @videorc/theme

This merges the Videorc tokens, utilities and base layer into your global stylesheet. Every component depends on it, so the CLI also adds it with the first component you install.

For a desktop app (Electron, Tauri), also add @videorc/desktop: chrome text stops selecting, the arrow stays the pointer, and the window stops rubber-banding.

$ pnpm dlx shadcn@latest add @videorc/desktop

Add a component

$ pnpm dlx shadcn@latest add @videorc/button

What gets installed

PathWhat it is
components/ui/*Components, one file each
components/*Primitives: rows, panes, status bars, menus
components/icons.tsxThe semantic icon set every component draws from
hooks/*, lib/*The shared hooks and helpers
Your global CSSThe theme: tokens in light and dark, @theme mappings, utilities, base layer

Paths follow the aliases in your components.json, so they adapt to a src/ folder or custom aliases.

The ground

Videorc's surfaces are translucent coats, tuned to sit on a window's solid tone. On a plain page, give the page the theme's solid so the coats composite to the right tone:

app/globals.css
@layer base {
  html {
    background-color: var(--glass-solid);
  }
}

For AI agents

Every page has a Copy prompt for AI button that copies the install steps, usage, examples and API as one document. The same document is served at the page URL with .md appended:

curl https://ui.videorc.com/docs/components/button.md

llms.txt indexes every page, and llms-full.txt is the whole documentation in one file.