databricks/appkit-registry

databricks/appkit-registry

Language: TypeScript

License: Apache-2.0

Stars: 0

Forks: 0

Open issues: 0

Created: 2026-06-25T10:09:25Z

Pushed: 2026-09-11T10:44:14Z

Default branch: main

Fork: no

Archived: no

README:

AppKit Registry

The official shadcn-style component registry for Databricks AppKit. Components here are community- and field-built blocks that compose on top of the first-party @databricks/appkit-ui package.

• Core components (genie chat, file browser, charts, data table, primitives) ship in the

@databricks/appkit-ui npm package.

• This registry hosts higher-level, reusable blocks — pulled into your project as source you

own and can edit, via the shadcn CLI.

Registry components import their primitives from @databricks/appkit-ui/react (they are not vendored), so they always match your installed AppKit version and design tokens.

Using the registry

1. Prerequisites

Your app must already have AppKit UI installed and its styles imported once at root:

npm install @databricks/appkit-ui

import "@databricks/appkit-ui/styles.css";

2. Add the @databricks-appkit namespace to components.json

{
"registries": {
"@databricks-appkit": "https://raw.githubusercontent.com/databricks/appkit-registry/main/public/r/{name}.json"
}
}

3. Add an item

appkit add handles both UI components and server plugins — it detects the kind and routes each to the right place:

appkit add metric-card # UI → /src/components/appkit/metric-card.tsx
appkit add hello # plugin → /plugins/hello/ + plugin sync
appkit add metric-card hello # mix in one call

The CLI copies the source into your project and installs any npm dependencies the item declares. For plugins it also runs appkit plugin sync and prints the createApp registration snippet.

Repository layout

registry// Self-contained component source + README
registry.json Manifest — one entry per component (build input)
public/r/*.json Built output served over HTTPS (generated by CI)
components.json Registry tooling config
scripts/validate.ts Pre-build manifest validation (CI gate)
app/globals.css Theme stub for local tooling

Hosting

This repo is the host. The built public/r/*.json files are committed and served directly over raw.githubusercontent.com — no CDN or static-site setup required.

Because the output is committed, always run `pnpm registry:build` before committing so the served JSON matches registry.json. CI re-runs the build and fails if public/r is stale.

Development

pnpm install
pnpm validate # validate registry.json + referenced files
pnpm registry:build # compile registry.json -> public/r/*.json (shadcn build)
pnpm check # validate + build

Contributing

See [CONTRIBUTING.md](./CONTRIBUTING.md).

License

Apache-2.0 — see [LICENSE](./LICENSE). Third-party dependency licenses are listed in [NOTICE.md](./NOTICE.md).