Skip to content

feat: register Cue with shadcn #13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mauroerta merged 2 commits into from
Sep 21, 2026
Merged

feat: register Cue with shadcn #13

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
de3a892
feat: register Cue with shadcn
mauroerta Sep 20, 2026
83a46fa
docs: explain shadcn registry rollout
mauroerta Sep 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions apps/docs/content/docs/shadcn.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,21 +3,21 @@ title: Using Cue with shadcn
description: Install Cue with shadcn and let Cue own the shared backdrop.
---

The shadcn registry can install the Dialog component and create a local Cue module for your app:
The `@vlkoss/cue` registry item installs shadcn's Dialog component and creates a local Cue module for your app. The namespace is `@vlkoss`; `cue` is the item name.

<Tabs items={["URL", "Namespace", "GitHub"]} groupId="shadcn-install" persist>
<Tab value="URL">
Once [shadcn/ui PR #11959](https://github.com/shadcn-ui/ui/pull/11959) is merged, the recommended install will be:

```npm
npx shadcn@latest add https://cue.vlkstudio.com/r/cue.json
npx shadcn@latest add @vlkoss/cue
```

</Tab>
<Tab value="Namespace">
Until then, install the same registry item directly:

<Tabs items={["Direct URL", "GitHub"]} groupId="shadcn-install" persist>
<Tab value="Direct URL">

```npm
npx shadcn@latest registry add @cue=https://cue.vlkstudio.com/r/{name}.json
npx shadcn@latest add @cue/cue
npx shadcn@latest add https://cue.vlkstudio.com/r/cue.json
```

</Tab>
Expand Down
12 changes: 7 additions & 5 deletions registry.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,23 +1,25 @@
{
"$schema": "https://ui.shadcn.com/schema/registry.json",
"name": "cue",
"name": "vlkoss",
"homepage": "https://cue.vlkstudio.com",
"items": [
{
"name": "cue",
"type": "registry:lib",
"title": "Cue",
"description": "Imperative React overlays with isolated Cue environments, typed shared components, and one shared backdrop.",
"title": "Cue for shadcn/ui",
"author": "VLK Studio",
"description": "Imperative React overlays for shadcn/ui. Create programmatic dialogs and modal flows with typed overlay handles, isolated Cue environments, stacked overlays, and one shared backdrop.",
"dependencies": ["@vlkoss/cue"],
"registryDependencies": ["dialog"],
"files": [
{
"path": "registry/cue.tsx",
"type": "registry:lib",
"target": "@/components/cue/index.tsx"
"target": "@components/cue/index.tsx"
}
],
"docs": "Install a local Cue configuration with shadcn Dialog and create overlays with cue.createOverlay(...). The generated Cue module includes the native backdrop adapter and typed Dialog component map. Add showBackdrop={false} support to DialogContent as described in the docs. https://cue.vlkstudio.com/docs"
"categories": ["react", "overlay", "dialog", "modal", "imperative"],
"docs": "Install the shadcn Dialog component, add showBackdrop={false} support to DialogContent, and use the generated Cue environment for typed imperative overlays. https://cue.vlkstudio.com/docs/shadcn"
}
]
}
Loading