Registry

Understand Fable UI's hosted registry items and their install targets.

Fable UI is a copy-and-own registry. The canonical public item address is:

https://fable-ui.shobky.com/r/<item>.json

For example:

pnpm dlx shadcn@latest add https://fable-ui.shobky.com/r/metric-card.json

The hosted JSON is the consumer-facing install surface. The repository's registry.json is its source definition; do not substitute a GitHub shorthand when you want to install the deployed public item.

Catalog

ItemRegistry typeInstalled concern
coreregistry:libShared Fable core, including the renderer, provider, schemas, and data registry.
metric-cardregistry:componentMetric UI, show_metric, and its manifest.
suggested-actionsregistry:componentPrompt suggestions, show_next_actions, and its manifest.
confirmation-cardregistry:componentConfirmation UI, request_confirmation, and its manifest.
form-cardregistry:componentForm UI, collect_input, and its manifest.
data-browserregistry:blockBrowser and table UI, show_table, show_data_browser, get_rendered_data, and display manifests.
chartsregistry:blockChart UI, show_chart, and its manifest.
text-editor-cardregistry:componentDraft UI, show_text_editor, and its manifest.
email-composer-cardregistry:componentEmail draft UI, show_email_composer, and its manifest.
code-block-cardregistry:componentCode UI, show_code_block, and its manifest.
rest-driverregistry:libHost-owned REST resource adapter.
firebase-driverregistry:libHost-owned Firestore resource adapter.
quickstartregistry:blockMinimal /fable-chat example with metric and suggested-action tools only.

core is normally pulled in by a surface. It remains directly installable for a custom renderer or data-source integration.

What an item can install

An item is more than a React file. Across the public catalog, an item can install all of these target categories:

Target categoryExamples
Core libraries@lib/fable-ui/core/*
Components and blocks@components/fable-ui/<item>/*
Tool contracts@lib/fable-ui/tools/*
Model manifests@lib/fable-ui/manifests/*
Shared hooks@hooks/use-copy-to-clipboard.ts
Driver adapters@lib/fable-ui/drivers/rest/*, @lib/fable-ui/drivers/firebase/*
shadcn primitivesHost components/ui/* files selected from registryDependencies
Next routesapp/fable-chat/page.tsx, app/api/fable-chat/route.ts
Quickstart client code@components/fable-ui/chat/*, @lib/fable-ui/quickstart/*
Quickstart documentation~/docs/fable-ui/quickstart.md

The @components, @lib, and @hooks prefixes are resolved through the host components.json; they are not fixed source paths. app/... targets are explicit Next route paths. This distinction lets each host keep its own aliases while keeping quickstart routes predictable.

Dependencies

Bare registryDependencies such as card or button are official shadcn items. Fable dependencies are declared as repository references so the CLI installs the required Fable source with the item.

Install the public hosted item URL directly, then let the CLI resolve the source graph:

pnpm dlx shadcn@latest add https://fable-ui.shobky.com/r/email-composer-card.json

Inspect first when the host already owns nearby files:

pnpm dlx shadcn@latest add https://fable-ui.shobky.com/r/email-composer-card.json --dry-run

Boundary

Registry installation copies source into the host project. It does not configure authentication, data access, provider credentials, permissions, database access, mail delivery, or side effects. The host must integrate the installed tool definitions and callbacks deliberately.

See Installation for the full hosted command list, Tool Definitions for the renderer contract, and AI SDK Integration for additive chat integration recipes.