Tailark Registry

The Tailark Registry provides two distinct bases for components: Base UI (base) and Radix UI (radix).

• Base UI is the default base and is served under the /r path segment.
• Radix UI is served under the /r/radix path segment.

You can fetch the full registry index or individual items using the following patterns:

Base UI (Default):

• Full index: /r/registry.json
• Single item: /r/[name]

Radix UI:

• Full index: /r/radix/registry.json
• Single item: /r/radix/[name]

To run the registry in a development environment:

1. Install dependencies using pnpm.
2. Start the development server.
3. Inspect the registry index at http://localhost:3003/registry.

pnpm install
pnpm dev

Once the registry is configured in your components.json, you can install any block or page by its name using the npx shadcn@latest add command.

To find available item names, browse the registry index at /r/registry.json (for Base UI) or /r/radix/registry.json (for Radix UI).

To use Tailark blocks and pages, you must add the @tailark-oss namespace to your project's components.json file. This allows the shadcn CLI to resolve components from the Tailark registry.

Depending on which UI base you want to use, add one of the following configurations to the registries key in components.json.

### For Base UI (Default)
```json
{
  "registries": {
    "@tailark-oss": "https://oss-tailark.com/r/{name}"
  }
}

For Radix UI

{
  "registries": {
    "@tailark-oss": "https://oss-tailark.com/r/radix/{name}"
  }
}

The createRegistryHelpers factory provides several functions to generate standardized package names for different Tailark ecosystems. These are useful when defining dependencies for registry items.

Given a kit name (e.g., base), the following functions are available:

• ui(name): Returns @tailark-oss/${kit}-${name}
• core(name): Returns @tailark-oss/core-${name}
• motionPrimitive(name): Returns @tailark-oss/motion-primitives-${name}
• magicUi(name): Returns @tailark-oss/magic-ui-${name}
• shadcn(name): Returns @shadcn/${name}

Use getRegistryComponent to asynchronously load the actual code module for a registry entry. This function resolves the component's import path and returns the default export of the module.

If the component cannot be found or the import fails, it returns null.

The registry supports multiple bases, primarily base and radix. Use the following utility functions to manage base selection:

• isRegistryBase(base: string): Returns true if the provided string is a valid registry base ('base' or 'radix').
• getRegistryBase(base?: string): Returns the provided base if valid; otherwise, defaults to 'base'.

The createRegistryHelpers function is a factory that returns a set of helper functions (block, component, page) used to generate standardized RegistryItem objects for the Tailark registry. It also provides utility functions for resolving package names for various ecosystems like ui, core, motionPrimitive, magicUi, and shadcn.

To use these helpers, you must provide a kit name (e.g., 'base'). You can optionally pass componentTarget: true to automatically set a default file target for components.

Use getRegistryItem to retrieve a complete RegistryItem by its name. This function resolves the item's files from the registry, reads their content, and automatically rewrites import specifiers so they are compatible with a consumer's project structure (e.g., converting registry-internal paths to @/components/... aliases).

Supported registry bases are base and radix. If no base is provided, it defaults to base.