@spektr/registry

Component registry for Spektr UI. This package contains metadata for all components in the Spektr UI library, compatible with the shadcn/ui CLI.

Usage

As a hosted registry

Host the /registry folder as a static site or API endpoint. Users can then install components using:

npx shadcn-ui@latest add button --registry https://your-domain.com/registry

As a package

Install the registry package to access component metadata programmatically:

npm install @spektr/registry

import { registry, getRegistryItem } from "@spektr/registry";

const buttonComponent = getRegistryItem("button");
console.log(buttonComponent);

Registry Structure

Each component in the registry includes:

• name: Component identifier
• type: Component type (registry:ui, registry:lib, registry:hook)
• description: Component description
• dependencies: Required npm packages
• registryDependencies: Other components from the registry
• files: Component source files
• tailwind: Tailwind configuration (optional)
• cssVars: CSS variables for theming (optional)

Building

pnpm build

This will:

1. Compile TypeScript files
2. Generate JSON registry files in /registry

License

Apache-2.0