diff --git a/apps/docs/content/docs/shadcn.mdx b/apps/docs/content/docs/shadcn.mdx index 1eca575..c6698cf 100644 --- a/apps/docs/content/docs/shadcn.mdx +++ b/apps/docs/content/docs/shadcn.mdx @@ -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. - - +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 ``` - - +Until then, install the same registry item directly: + + + ```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 ``` diff --git a/registry.json b/registry.json index c68f969..95bf014 100644 --- a/registry.json +++ b/registry.json @@ -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" } ] }