Getting Started

Understand the package-local manifest and React registry build flow.

The React registry is assembled from the package-local registry definitions in packages/react/src/registry/* and published under apps/react/public/r.

Consumer setup

Projects that install Tile UI through the shadcn CLI should register the Tile UI namespace in components.json:

components.json
{
	"registries": {
		"@tile-ui": "https://react.tileui.zmorg.cn/r/{name}.json"
	}
}

Once configured, registry dependencies such as @tile-ui/core and @tile-ui/utils resolve without hardcoding the docs site domain into each item payload.

Install an item

pnpm dlx shadcn@latest add @tile-ui/button

The CLI resolves shared dependencies automatically, so installing @tile-ui/button also brings in @tile-ui/core, @tile-ui/utils, and @tile-ui/styles when needed. The styles item copies shared Sass support files and merges only Tile's --tile-* extension defaults into the global stylesheet configured by components.json; the host semantic palette remains unchanged.

Tile uses the same semantic variables as current shadcn themes. Existing shadcn values remain the source of truth. Tile's default theme and reset are optional choices described in Theming, not registry prerequisites.

Optional themes

See Theme resources for available themes and the Kumo guide for its package and registry setup.

Build flow

corepack pnpm registry:build:react

What is included

  • React component sources
  • SCSS files from the shared design system
  • Hooks and utility helpers

The docs site reads the published registry metadata from apps/react/public/r/registry.json, so the site and the public registry stay aligned.

Registry output

Items write files into a predictable structure:

components/ui/*
hooks/*
styles/*