mirror of
https://github.com/vercel-labs/json-render.git
synced 2026-10-03 04:18:15 +08:00
Compare commits
72
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
09f8d56a9c | ||
|
|
2e54a867e4 | ||
|
|
2913192cbe | ||
|
|
43694d6046 | ||
|
|
7b67f33bab | ||
|
|
945d1d232a | ||
|
|
44c135bf3b | ||
|
|
7a610fc2b6 | ||
|
|
5b3c2c167b | ||
|
|
f9459e1001 | ||
|
|
cc00444546 | ||
|
|
7655ab4822 | ||
|
|
cc8f3ff139 | ||
|
|
d694e0efde | ||
|
|
7fde7cd0a9 | ||
|
|
c502d5517e | ||
|
|
8740deb018 | ||
|
|
1d755c104a | ||
|
|
d904d45150 | ||
|
|
a110c6e0ea | ||
|
|
7de08ccdf7 | ||
|
|
3201854481 | ||
|
|
64c889221e | ||
|
|
49838fa353 | ||
|
|
fa47b08869 | ||
|
|
5ccb109c08 | ||
|
|
62932f6516 | ||
|
|
ee28d548c1 | ||
|
|
0e6f2afc6c | ||
|
|
bccedc2459 | ||
|
|
0a404302ef | ||
|
|
09376db2f6 | ||
|
|
4c294417f4 | ||
|
|
f77c1d6c98 | ||
|
|
a66aef17f9 | ||
|
|
ba9ffa3c91 | ||
|
|
b7d5a75bfa | ||
|
|
0dfe07da45 | ||
|
|
c82eefd1c5 | ||
|
|
2d70fab00a | ||
|
|
320c935bfb | ||
|
|
e7103ce519 | ||
|
|
43ad534482 | ||
|
|
ea97aff3e0 | ||
|
|
9af3f999e0 | ||
|
|
06b8745da7 | ||
|
|
ddae61805e | ||
|
|
f11283fa92 | ||
|
|
fd8c7a489f | ||
|
|
f8e39b30fe | ||
|
|
68ba7c6d7d | ||
|
|
7c4a6fed9a | ||
|
|
5b4fcaa349 | ||
|
|
2b3f3a723f | ||
|
|
726ddc1d4f | ||
|
|
429e456a4f | ||
|
|
0e16ca33d4 | ||
|
|
edbeb5a637 | ||
|
|
d9a4efdbeb | ||
|
|
f435643817 | ||
|
|
458f3a728c | ||
|
|
d5734e975c | ||
|
|
3d2d1adb2d | ||
|
|
801708a128 | ||
|
|
e9ea9c782b | ||
|
|
dd17549ee8 | ||
|
|
1eb6212dd7 | ||
|
|
711e79b069 | ||
|
|
f3611860a7 | ||
|
|
61ee8e5291 | ||
|
|
d38b281e5e | ||
|
|
39fcc192e9 |
@@ -6,8 +6,14 @@
|
||||
[
|
||||
"@json-render/core",
|
||||
"@json-render/react",
|
||||
"@json-render/react-pdf",
|
||||
"@json-render/shadcn",
|
||||
"@json-render/react-native",
|
||||
"@json-render/remotion",
|
||||
"@json-render/codegen"
|
||||
"@json-render/codegen",
|
||||
"@json-render/zustand",
|
||||
"@json-render/redux",
|
||||
"@json-render/jotai"
|
||||
]
|
||||
],
|
||||
"linked": [],
|
||||
@@ -15,7 +21,7 @@
|
||||
"baseBranch": "main",
|
||||
"updateInternalDependencies": "patch",
|
||||
"privatePackages": {
|
||||
"version": false,
|
||||
"version": true,
|
||||
"tag": false
|
||||
}
|
||||
}
|
||||
|
||||
@@ -23,8 +23,6 @@ jobs:
|
||||
|
||||
- name: Install pnpm
|
||||
uses: pnpm/action-setup@v4
|
||||
with:
|
||||
version: 9.0.0
|
||||
|
||||
- name: Setup Node.js
|
||||
uses: actions/setup-node@v4
|
||||
|
||||
+11
-6
@@ -6,11 +6,8 @@ node_modules
|
||||
.pnp.js
|
||||
|
||||
# Local env files
|
||||
.env
|
||||
.env.local
|
||||
.env.development.local
|
||||
.env.test.local
|
||||
.env.production.local
|
||||
.env*
|
||||
!.env.example
|
||||
|
||||
# Testing
|
||||
coverage
|
||||
@@ -21,11 +18,15 @@ coverage
|
||||
# Vercel
|
||||
.vercel
|
||||
|
||||
# Expo
|
||||
.expo/
|
||||
|
||||
# Build Outputs
|
||||
.next/
|
||||
out/
|
||||
build
|
||||
dist
|
||||
*.tsbuildinfo
|
||||
|
||||
|
||||
# Debug
|
||||
@@ -39,4 +40,8 @@ yarn-error.log*
|
||||
|
||||
# opensrc - source code for packages
|
||||
opensrc/
|
||||
.env*.local
|
||||
|
||||
# Stripe apps (generated from template + build artifacts)
|
||||
examples/stripe-app/*/stripe-app.json
|
||||
examples/stripe-app/*/.build
|
||||
examples/stripe-app/*/yarn.lock
|
||||
|
||||
@@ -25,12 +25,52 @@ This ensures we don't install outdated versions that may have incompatible types
|
||||
## Code Style
|
||||
|
||||
- Do not use emojis in code or UI
|
||||
- Do not use barrel files (index.ts that re-exports from other files)
|
||||
- Use shadcn CLI to add shadcn/ui components: `pnpm dlx shadcn@latest add <component>`
|
||||
|
||||
## AI SDK / AI Gateway
|
||||
|
||||
When using the Vercel AI SDK (`ai` package) with AI Gateway, pass the model as a plain string identifier -- do not import a provider constructor:
|
||||
|
||||
```ts
|
||||
import { streamText } from "ai";
|
||||
|
||||
const result = streamText({
|
||||
model: "anthropic/claude-haiku-4.5",
|
||||
prompt: "...",
|
||||
});
|
||||
```
|
||||
|
||||
This requires `AI_GATEWAY_API_KEY` to be set in the environment. See `tests/e2e/` for examples.
|
||||
|
||||
## Dev Servers
|
||||
|
||||
All apps and examples with dev servers use [portless](https://github.com/vercel-labs/portless) to avoid hardcoded ports. Portless assigns random ports and exposes each app via `.localhost` URLs.
|
||||
|
||||
Naming convention:
|
||||
- Main web app: `json-render` → `json-render.localhost:1355`
|
||||
- Examples: `[name]-demo.json-render` → `[name]-demo.json-render.localhost:1355`
|
||||
|
||||
When adding a new example that runs a dev server, wrap its `dev` script with `portless <name>`:
|
||||
|
||||
```json
|
||||
{
|
||||
"scripts": {
|
||||
"dev": "portless my-example-demo.json-render next dev --turbopack"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Do **not** add `--port` flags -- portless handles port assignment automatically. Do **not** add portless as a project dependency; it must be installed globally.
|
||||
|
||||
## Workflow
|
||||
|
||||
- Run `pnpm type-check` after each turn to ensure type safety
|
||||
- When making user-facing changes (new packages, API changes, new features, renamed exports, changed behavior), update the relevant documentation:
|
||||
- Package `README.md` files in `packages/*/README.md`
|
||||
- Root `README.md` (if packages table, install commands, or examples are affected)
|
||||
- Web app docs in `apps/web/` (if guides, API references, or examples need updating)
|
||||
- Skills in `skills/*/SKILL.md` (if the package has a corresponding skill)
|
||||
- `AGENTS.md` (if workflow or conventions change)
|
||||
|
||||
<!-- opensrc:start -->
|
||||
|
||||
|
||||
@@ -1,22 +1,30 @@
|
||||
# json-render
|
||||
|
||||
**Predictable. Guardrailed. Fast.**
|
||||
**The Generative UI framework.**
|
||||
|
||||
Let end users generate dashboards, widgets, apps, and videos from prompts — safely constrained to components you define.
|
||||
Generate dynamic, personalized UIs from prompts without sacrificing reliability. Predefined components and actions for safe, predictable output.
|
||||
|
||||
```bash
|
||||
npm install @json-render/core @json-render/react
|
||||
# pre-built shadcn/ui components
|
||||
npm install @json-render/shadcn
|
||||
# or for mobile
|
||||
npm install @json-render/core @json-render/react-native
|
||||
# or for video
|
||||
npm install @json-render/core @json-render/remotion
|
||||
# or for PDF documents
|
||||
npm install @json-render/core @json-render/react-pdf
|
||||
```
|
||||
|
||||
## Why json-render?
|
||||
|
||||
When users prompt for UI, you need guarantees. json-render gives AI a **constrained vocabulary** so output is always predictable:
|
||||
json-render is a **Generative UI** framework: AI generates interfaces from natural language prompts, constrained to components you define. You set the guardrails, AI generates within them:
|
||||
|
||||
- **Guardrailed** — AI can only use components in your catalog
|
||||
- **Predictable** — JSON output matches your schema, every time
|
||||
- **Fast** — Stream and render progressively as the model responds
|
||||
- **Guardrailed** - AI can only use components in your catalog
|
||||
- **Predictable** - JSON output matches your schema, every time
|
||||
- **Fast** - Stream and render progressively as the model responds
|
||||
- **Cross-Platform** - React (web) and React Native (mobile) from the same catalog
|
||||
- **Batteries Included** - 36 pre-built shadcn/ui components ready to use
|
||||
|
||||
## Quick Start
|
||||
|
||||
@@ -24,7 +32,7 @@ When users prompt for UI, you need guarantees. json-render gives AI a **constrai
|
||||
|
||||
```typescript
|
||||
import { defineCatalog } from "@json-render/core";
|
||||
import { schema } from "@json-render/react";
|
||||
import { schema } from "@json-render/react/schema";
|
||||
import { z } from "zod";
|
||||
|
||||
const catalog = defineCatalog(schema, {
|
||||
@@ -75,8 +83,8 @@ const { registry } = defineRegistry(catalog, {
|
||||
<span>{format(props.value, props.format)}</span>
|
||||
</div>
|
||||
),
|
||||
Button: ({ props, onAction }) => (
|
||||
<button onClick={() => onAction?.({ name: props.action })}>
|
||||
Button: ({ props, emit }) => (
|
||||
<button onClick={() => emit("press")}>
|
||||
{props.label}
|
||||
</button>
|
||||
),
|
||||
@@ -100,9 +108,15 @@ function Dashboard({ spec }) {
|
||||
|
||||
| Package | Description |
|
||||
|---------|-------------|
|
||||
| `@json-render/core` | Schemas, catalogs, AI prompts, SpecStream utilities |
|
||||
| `@json-render/core` | Schemas, catalogs, AI prompts, dynamic props, SpecStream utilities |
|
||||
| `@json-render/react` | React renderer, contexts, hooks |
|
||||
| `@json-render/shadcn` | 36 pre-built shadcn/ui components (Radix UI + Tailwind CSS) |
|
||||
| `@json-render/react-native` | React Native renderer with standard mobile components |
|
||||
| `@json-render/remotion` | Remotion video renderer, timeline schema |
|
||||
| `@json-render/react-pdf` | React PDF renderer for generating PDF documents from specs |
|
||||
| `@json-render/redux` | Redux / Redux Toolkit adapter for `StateStore` |
|
||||
| `@json-render/zustand` | Zustand adapter for `StateStore` |
|
||||
| `@json-render/jotai` | Jotai adapter for `StateStore` |
|
||||
|
||||
## Renderers
|
||||
|
||||
@@ -110,17 +124,23 @@ function Dashboard({ spec }) {
|
||||
|
||||
```tsx
|
||||
import { defineRegistry, Renderer } from "@json-render/react";
|
||||
import { schema } from "@json-render/react";
|
||||
import { schema } from "@json-render/react/schema";
|
||||
|
||||
// Element tree spec format
|
||||
// Flat spec format (root key + elements map)
|
||||
const spec = {
|
||||
root: {
|
||||
type: "Card",
|
||||
props: { title: "Hello" },
|
||||
children: [
|
||||
{ type: "Button", props: { label: "Click me" } }
|
||||
]
|
||||
}
|
||||
root: "card-1",
|
||||
elements: {
|
||||
"card-1": {
|
||||
type: "Card",
|
||||
props: { title: "Hello" },
|
||||
children: ["button-1"],
|
||||
},
|
||||
"button-1": {
|
||||
type: "Button",
|
||||
props: { label: "Click me" },
|
||||
children: [],
|
||||
},
|
||||
},
|
||||
};
|
||||
|
||||
// defineRegistry creates a type-safe component registry
|
||||
@@ -128,6 +148,60 @@ const { registry } = defineRegistry(catalog, { components });
|
||||
<Renderer spec={spec} registry={registry} />
|
||||
```
|
||||
|
||||
### shadcn/ui (Web)
|
||||
|
||||
```tsx
|
||||
import { defineCatalog } from "@json-render/core";
|
||||
import { schema } from "@json-render/react/schema";
|
||||
import { defineRegistry, Renderer } from "@json-render/react";
|
||||
import { shadcnComponentDefinitions } from "@json-render/shadcn/catalog";
|
||||
import { shadcnComponents } from "@json-render/shadcn";
|
||||
|
||||
// Pick components from the 36 standard definitions
|
||||
const catalog = defineCatalog(schema, {
|
||||
components: {
|
||||
Card: shadcnComponentDefinitions.Card,
|
||||
Stack: shadcnComponentDefinitions.Stack,
|
||||
Heading: shadcnComponentDefinitions.Heading,
|
||||
Button: shadcnComponentDefinitions.Button,
|
||||
},
|
||||
actions: {},
|
||||
});
|
||||
|
||||
// Use matching implementations
|
||||
const { registry } = defineRegistry(catalog, {
|
||||
components: {
|
||||
Card: shadcnComponents.Card,
|
||||
Stack: shadcnComponents.Stack,
|
||||
Heading: shadcnComponents.Heading,
|
||||
Button: shadcnComponents.Button,
|
||||
},
|
||||
});
|
||||
|
||||
<Renderer spec={spec} registry={registry} />
|
||||
```
|
||||
|
||||
### React Native (Mobile)
|
||||
|
||||
```tsx
|
||||
import { defineCatalog } from "@json-render/core";
|
||||
import { schema } from "@json-render/react-native/schema";
|
||||
import {
|
||||
standardComponentDefinitions,
|
||||
standardActionDefinitions,
|
||||
} from "@json-render/react-native/catalog";
|
||||
import { defineRegistry, Renderer } from "@json-render/react-native";
|
||||
|
||||
// 25+ standard components included
|
||||
const catalog = defineCatalog(schema, {
|
||||
components: { ...standardComponentDefinitions },
|
||||
actions: standardActionDefinitions,
|
||||
});
|
||||
|
||||
const { registry } = defineRegistry(catalog, { components: {} });
|
||||
<Renderer spec={spec} registry={registry} />
|
||||
```
|
||||
|
||||
### Remotion (Video)
|
||||
|
||||
```tsx
|
||||
@@ -154,6 +228,40 @@ const spec = {
|
||||
/>
|
||||
```
|
||||
|
||||
### React PDF (Documents)
|
||||
|
||||
```typescript
|
||||
import { renderToBuffer } from "@json-render/react-pdf";
|
||||
|
||||
const spec = {
|
||||
root: "doc",
|
||||
elements: {
|
||||
doc: { type: "Document", props: { title: "Invoice" }, children: ["page-1"] },
|
||||
"page-1": {
|
||||
type: "Page",
|
||||
props: { size: "A4" },
|
||||
children: ["heading-1", "table-1"],
|
||||
},
|
||||
"heading-1": {
|
||||
type: "Heading",
|
||||
props: { text: "Invoice #1234", level: "h1" },
|
||||
children: [],
|
||||
},
|
||||
"table-1": {
|
||||
type: "Table",
|
||||
props: {
|
||||
columns: [{ header: "Item", width: "60%" }, { header: "Price", width: "40%", align: "right" }],
|
||||
rows: [["Widget A", "$10.00"], ["Widget B", "$25.00"]],
|
||||
},
|
||||
children: [],
|
||||
},
|
||||
},
|
||||
};
|
||||
|
||||
// Render to buffer, stream, or file
|
||||
const buffer = await renderToBuffer(spec);
|
||||
```
|
||||
|
||||
## Features
|
||||
|
||||
### Streaming (SpecStream)
|
||||
@@ -188,27 +296,46 @@ const systemPrompt = catalog.prompt();
|
||||
{
|
||||
"type": "Alert",
|
||||
"props": { "message": "Error occurred" },
|
||||
"visible": {
|
||||
"and": [
|
||||
{ "path": "/form/hasError" },
|
||||
{ "not": { "path": "/form/errorDismissed" } }
|
||||
]
|
||||
}
|
||||
"visible": [
|
||||
{ "$state": "/form/hasError" },
|
||||
{ "$state": "/form/errorDismissed", "not": true }
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
### Data Binding
|
||||
### Dynamic Props
|
||||
|
||||
Any prop value can be data-driven using expressions:
|
||||
|
||||
```json
|
||||
{
|
||||
"type": "Metric",
|
||||
"type": "Icon",
|
||||
"props": {
|
||||
"label": "Revenue",
|
||||
"value": "{{data.revenue}}"
|
||||
"name": { "$cond": { "$state": "/activeTab", "eq": "home" }, "$then": "home", "$else": "home-outline" },
|
||||
"color": { "$cond": { "$state": "/activeTab", "eq": "home" }, "$then": "#007AFF", "$else": "#8E8E93" }
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Two expression forms:
|
||||
|
||||
- **`{ "$state": "/state/key" }`** - reads a value from the state model
|
||||
- **`{ "$cond": <condition>, "$then": <value>, "$else": <value> }`** - evaluates a condition (same syntax as visibility conditions) and picks a branch
|
||||
|
||||
### Actions
|
||||
|
||||
Components can trigger actions, including the built-in `setState` action:
|
||||
|
||||
```json
|
||||
{
|
||||
"type": "Pressable",
|
||||
"props": { "action": "setState", "actionParams": { "statePath": "/activeTab", "value": "home" } },
|
||||
"children": ["home-icon"]
|
||||
}
|
||||
```
|
||||
|
||||
The `setState` action updates the state model directly, which re-evaluates visibility conditions and dynamic prop expressions.
|
||||
|
||||
---
|
||||
|
||||
## Demo
|
||||
@@ -220,9 +347,11 @@ pnpm install
|
||||
pnpm dev
|
||||
```
|
||||
|
||||
- http://localhost:3000 — Docs & Playground
|
||||
- http://localhost:3001 — Example Dashboard
|
||||
- http://localhost:3002 — Remotion Video Example
|
||||
- http://json-render.localhost:1355 - Docs & Playground
|
||||
- http://dashboard-demo.json-render.localhost:1355 - Example Dashboard
|
||||
- http://remotion-demo.json-render.localhost:1355 - Remotion Video Example
|
||||
- Chat Example: run `pnpm dev` in `examples/chat`
|
||||
- React Native example: run `npx expo start` in `examples/react-native`
|
||||
|
||||
## How It Works
|
||||
|
||||
@@ -237,10 +366,10 @@ flowchart LR
|
||||
D -.- G([streamed])
|
||||
```
|
||||
|
||||
1. **Define the guardrails** — what components, actions, and data bindings AI can use
|
||||
2. **Users prompt** — end users describe what they want in natural language
|
||||
3. **AI generates JSON** — output is always predictable, constrained to your catalog
|
||||
4. **Render fast** — stream and render progressively as the model responds
|
||||
1. **Define the guardrails** - what components, actions, and data bindings AI can use
|
||||
2. **Prompt** - describe what you want in natural language
|
||||
3. **AI generates JSON** - output is always predictable, constrained to your catalog
|
||||
4. **Render fast** - stream and render progressively as the model responds
|
||||
|
||||
## License
|
||||
|
||||
|
||||
@@ -12,3 +12,7 @@ AI_GATEWAY_MODEL=anthropic/claude-haiku-4.5
|
||||
# Automatically populated when you add Vercel KV to your project
|
||||
KV_REST_API_URL=
|
||||
KV_REST_API_TOKEN=
|
||||
|
||||
# Rate Limiting
|
||||
# RATE_LIMIT_PER_MINUTE=10
|
||||
# RATE_LIMIT_PER_DAY=100
|
||||
|
||||
@@ -0,0 +1,10 @@
|
||||
# web
|
||||
|
||||
## 0.1.1
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [1d755c1]
|
||||
- @json-render/core@0.9.0
|
||||
- @json-render/react@0.9.0
|
||||
- @json-render/codegen@0.9.0
|
||||
+1
-1
@@ -14,7 +14,7 @@ pnpm dev
|
||||
bun dev
|
||||
```
|
||||
|
||||
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
|
||||
Open [http://json-render.localhost:1355](http://json-render.localhost:1355) with your browser to see the result.
|
||||
|
||||
You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
|
||||
|
||||
|
||||
@@ -1,49 +1,26 @@
|
||||
import Link from "next/link";
|
||||
import { Code } from "@/components/code";
|
||||
import { pageMetadata } from "@/lib/page-metadata"
|
||||
export const metadata = pageMetadata("docs/a2ui")
|
||||
|
||||
export const metadata = {
|
||||
title: "A2UI Integration | json-render",
|
||||
};
|
||||
# A2UI Integration
|
||||
|
||||
export default function A2UIPage() {
|
||||
return (
|
||||
<article>
|
||||
<h1 className="text-3xl font-bold mb-4">A2UI Integration</h1>
|
||||
<p className="text-muted-foreground mb-8">
|
||||
Use <code className="text-foreground">@json-render/core</code> to
|
||||
support{" "}
|
||||
<a
|
||||
href="https://a2ui.org"
|
||||
target="_blank"
|
||||
rel="noopener noreferrer"
|
||||
className="text-foreground hover:underline"
|
||||
>
|
||||
A2UI
|
||||
</a>{" "}
|
||||
natively.
|
||||
</p>
|
||||
Use `@json-render/core` to support [A2UI](https://a2ui.org) natively.
|
||||
|
||||
<div className="rounded-lg border border-amber-500/50 bg-amber-500/10 p-4 mb-8">
|
||||
<p className="text-sm text-amber-700 dark:text-amber-300">
|
||||
<strong>Concept:</strong> This page demonstrates how json-render can
|
||||
support A2UI. The examples are illustrative and may require adaptation
|
||||
for production use.
|
||||
</p>
|
||||
</div>
|
||||
<div className="rounded-lg border border-amber-500/50 bg-amber-500/10 p-4 mb-8">
|
||||
<p className="text-sm text-amber-700 dark:text-amber-300">
|
||||
<strong>Concept:</strong> This page demonstrates how json-render can support A2UI. The examples are illustrative and may require adaptation for production use.
|
||||
</p>
|
||||
</div>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">Native A2UI Support</h2>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
<code className="text-foreground">@json-render/core</code> is
|
||||
schema-agnostic. Define a catalog that matches A2UI's format and
|
||||
build a renderer that understands it - no conversion layer needed.
|
||||
</p>
|
||||
## Native A2UI Support
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">Example A2UI Message</h2>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
A2UI uses an adjacency list model - a flat list of components with ID
|
||||
references. This makes it easy to patch individual components:
|
||||
</p>
|
||||
<Code lang="json">{`{
|
||||
`@json-render/core` is schema-agnostic. Define a catalog that matches A2UI's format and build a renderer that understands it - no conversion layer needed.
|
||||
|
||||
## Example A2UI Message
|
||||
|
||||
A2UI uses an adjacency list model - a flat list of components with ID references. This makes it easy to patch individual components:
|
||||
|
||||
```json
|
||||
{
|
||||
"surfaceUpdate": {
|
||||
"surfaceId": "main",
|
||||
"components": [
|
||||
@@ -83,12 +60,14 @@ export default function A2UIPage() {
|
||||
}
|
||||
]
|
||||
}
|
||||
}`}</Code>
|
||||
}
|
||||
```
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">
|
||||
Define the A2UI Catalog
|
||||
</h2>
|
||||
<Code lang="typescript">{`import { createCatalog } from '@json-render/core';
|
||||
## Define the A2UI Catalog
|
||||
|
||||
```typescript
|
||||
import { defineCatalog } from '@json-render/core';
|
||||
import { schema } from '@json-render/react/schema';
|
||||
import { z } from 'zod';
|
||||
|
||||
// A2UI BoundValue schema
|
||||
@@ -106,7 +85,7 @@ const Children = z.object({
|
||||
}).optional(),
|
||||
}).refine(d => d.explicitList || d.template);
|
||||
|
||||
export const a2uiCatalog = createCatalog({
|
||||
export const a2uiCatalog = defineCatalog(schema, {
|
||||
components: {
|
||||
Text: {
|
||||
description: 'Displays text content',
|
||||
@@ -151,15 +130,15 @@ export const a2uiCatalog = createCatalog({
|
||||
},
|
||||
// Add more A2UI standard components...
|
||||
},
|
||||
});`}</Code>
|
||||
});
|
||||
```
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">
|
||||
Define the A2UI Schema
|
||||
</h2>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
Define the schema for A2UI message types:
|
||||
</p>
|
||||
<Code lang="typescript">{`import { z } from 'zod';
|
||||
## Define the A2UI Schema
|
||||
|
||||
Define the schema for A2UI message types:
|
||||
|
||||
```typescript
|
||||
import { z } from 'zod';
|
||||
|
||||
// Component instance in the adjacency list
|
||||
const A2UIComponent = z.object({
|
||||
@@ -173,8 +152,8 @@ const SurfaceUpdate = z.object({
|
||||
components: z.array(A2UIComponent),
|
||||
});
|
||||
|
||||
// Data model update message
|
||||
const DataModelUpdate = z.object({
|
||||
// State model update message
|
||||
const StateModelUpdate = z.object({
|
||||
surfaceId: z.string().optional(),
|
||||
path: z.string().optional(),
|
||||
contents: z.array(z.object({
|
||||
@@ -196,18 +175,18 @@ const BeginRendering = z.object({
|
||||
// Complete A2UI message schema
|
||||
export const A2UIMessage = z.object({
|
||||
surfaceUpdate: SurfaceUpdate.optional(),
|
||||
dataModelUpdate: DataModelUpdate.optional(),
|
||||
dataModelUpdate: StateModelUpdate.optional(),
|
||||
beginRendering: BeginRendering.optional(),
|
||||
deleteSurface: z.object({ surfaceId: z.string() }).optional(),
|
||||
});`}</Code>
|
||||
});
|
||||
```
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">
|
||||
Build an A2UI Renderer
|
||||
</h2>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
Create a renderer that processes the A2UI adjacency list format:
|
||||
</p>
|
||||
<Code lang="tsx">{`import { a2uiCatalog } from './catalog';
|
||||
## Build an A2UI Renderer
|
||||
|
||||
Create a renderer that processes the A2UI adjacency list format:
|
||||
|
||||
```tsx
|
||||
import { a2uiCatalog } from './catalog';
|
||||
|
||||
// Component registry
|
||||
const components = {
|
||||
@@ -239,7 +218,7 @@ export function renderA2UI(
|
||||
if (!bound) return undefined;
|
||||
if (bound.literalString) return bound.literalString;
|
||||
if (bound.path) {
|
||||
const parts = bound.path.replace(/^\\//, '').split('/');
|
||||
const parts = bound.path.replace(/^\//, '').split('/');
|
||||
let value = dataModel;
|
||||
for (const p of parts) value = value?.[p];
|
||||
return value;
|
||||
@@ -272,10 +251,13 @@ export function renderA2UI(
|
||||
}
|
||||
|
||||
return render(rootId);
|
||||
}`}</Code>
|
||||
}
|
||||
```
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">Usage</h2>
|
||||
<Code lang="tsx">{`const [components] = useState(() => new Map());
|
||||
## Usage
|
||||
|
||||
```tsx
|
||||
const [components] = useState(() => new Map());
|
||||
const [dataModel, setDataModel] = useState({});
|
||||
const [rootId, setRootId] = useState<string | null>(null);
|
||||
|
||||
@@ -295,19 +277,9 @@ function handleMessage(msg: any) {
|
||||
}
|
||||
|
||||
// Render
|
||||
{rootId && renderA2UI(components, dataModel, rootId, handleAction)}`}</Code>
|
||||
{rootId && renderA2UI(components, dataModel, rootId, handleAction)}
|
||||
```
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">Next</h2>
|
||||
<p className="text-sm text-muted-foreground">
|
||||
Learn about{" "}
|
||||
<Link
|
||||
href="/docs/adaptive-cards"
|
||||
className="text-foreground hover:underline"
|
||||
>
|
||||
Adaptive Cards integration
|
||||
</Link>{" "}
|
||||
for another UI protocol.
|
||||
</p>
|
||||
</article>
|
||||
);
|
||||
}
|
||||
## Next
|
||||
|
||||
Learn about [Adaptive Cards integration](/docs/adaptive-cards) for another UI protocol.
|
||||
@@ -0,0 +1,408 @@
|
||||
import { pageMetadata } from "@/lib/page-metadata"
|
||||
export const metadata = pageMetadata("docs/adaptive-cards")
|
||||
|
||||
# Adaptive Cards Integration
|
||||
|
||||
Use json-render to render [Microsoft Adaptive Cards](https://adaptivecards.io) natively.
|
||||
|
||||
<div className="rounded-lg border border-amber-500/50 bg-amber-500/10 p-4 mb-8">
|
||||
<p className="text-sm text-amber-700 dark:text-amber-300">
|
||||
<strong>Concept:</strong> This page demonstrates how json-render can support Adaptive Cards. The examples are illustrative and may require adaptation for production use.
|
||||
</p>
|
||||
</div>
|
||||
|
||||
## Adaptive Cards Overview
|
||||
|
||||
Adaptive Cards is a JSON-based format for platform-agnostic UI snippets. Cards have a `body` array of elements and an optional `actions` array for interactive buttons.
|
||||
|
||||
### Example Adaptive Card
|
||||
|
||||
```json
|
||||
{
|
||||
"$schema": "http://adaptivecards.io/schemas/adaptive-card.json",
|
||||
"type": "AdaptiveCard",
|
||||
"version": "1.5",
|
||||
"body": [
|
||||
{
|
||||
"type": "TextBlock",
|
||||
"text": "Hello, Adaptive Cards!",
|
||||
"size": "large",
|
||||
"weight": "bolder"
|
||||
},
|
||||
{
|
||||
"type": "Image",
|
||||
"url": "https://example.com/image.png",
|
||||
"altText": "Example image"
|
||||
},
|
||||
{
|
||||
"type": "Container",
|
||||
"items": [
|
||||
{
|
||||
"type": "TextBlock",
|
||||
"text": "This is inside a container",
|
||||
"wrap": true
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"type": "ColumnSet",
|
||||
"columns": [
|
||||
{
|
||||
"type": "Column",
|
||||
"width": "auto",
|
||||
"items": [
|
||||
{ "type": "TextBlock", "text": "Column 1" }
|
||||
]
|
||||
},
|
||||
{
|
||||
"type": "Column",
|
||||
"width": "stretch",
|
||||
"items": [
|
||||
{ "type": "TextBlock", "text": "Column 2" }
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"type": "Input.Text",
|
||||
"id": "userInput",
|
||||
"placeholder": "Enter your name",
|
||||
"label": "Name"
|
||||
}
|
||||
],
|
||||
"actions": [
|
||||
{
|
||||
"type": "Action.Submit",
|
||||
"title": "Submit"
|
||||
},
|
||||
{
|
||||
"type": "Action.OpenUrl",
|
||||
"title": "Learn More",
|
||||
"url": "https://adaptivecards.io"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
## Creating an Adaptive Cards Catalog
|
||||
|
||||
Define a catalog matching the Adaptive Cards element types:
|
||||
|
||||
```typescript
|
||||
import { defineCatalog } from '@json-render/core';
|
||||
import { schema } from '@json-render/react/schema';
|
||||
import { z } from 'zod';
|
||||
|
||||
// Common Adaptive Cards properties
|
||||
const Spacing = z.enum(['none', 'small', 'default', 'medium', 'large', 'extraLarge', 'padding']);
|
||||
const HorizontalAlignment = z.enum(['left', 'center', 'right']);
|
||||
const VerticalAlignment = z.enum(['top', 'center', 'bottom']);
|
||||
const FontSize = z.enum(['small', 'default', 'medium', 'large', 'extraLarge']);
|
||||
const FontWeight = z.enum(['lighter', 'default', 'bolder']);
|
||||
const ImageSize = z.enum(['auto', 'stretch', 'small', 'medium', 'large']);
|
||||
const ImageStyle = z.enum(['default', 'person']);
|
||||
|
||||
// Base element properties shared by most elements
|
||||
const BaseElement = {
|
||||
id: z.string().optional(),
|
||||
isVisible: z.boolean().optional(),
|
||||
separator: z.boolean().optional(),
|
||||
spacing: Spacing.optional(),
|
||||
};
|
||||
|
||||
export const adaptiveCardsCatalog = defineCatalog(schema, {
|
||||
components: {
|
||||
// Root card
|
||||
AdaptiveCard: {
|
||||
description: 'Root Adaptive Card container',
|
||||
props: z.object({
|
||||
version: z.string(),
|
||||
body: z.array(z.unknown()).optional(),
|
||||
actions: z.array(z.unknown()).optional(),
|
||||
fallbackText: z.string().optional(),
|
||||
minHeight: z.string().optional(),
|
||||
rtl: z.boolean().optional(),
|
||||
verticalContentAlignment: VerticalAlignment.optional(),
|
||||
}),
|
||||
},
|
||||
|
||||
// Elements
|
||||
TextBlock: {
|
||||
description: 'Displays text with formatting options',
|
||||
props: z.object({
|
||||
...BaseElement,
|
||||
text: z.string(),
|
||||
color: z.enum(['default', 'dark', 'light', 'accent', 'good', 'warning', 'attention']).optional(),
|
||||
fontType: z.enum(['default', 'monospace']).optional(),
|
||||
horizontalAlignment: HorizontalAlignment.optional(),
|
||||
isSubtle: z.boolean().optional(),
|
||||
maxLines: z.number().optional(),
|
||||
size: FontSize.optional(),
|
||||
weight: FontWeight.optional(),
|
||||
wrap: z.boolean().optional(),
|
||||
}),
|
||||
},
|
||||
|
||||
Image: {
|
||||
description: 'Displays an image',
|
||||
props: z.object({
|
||||
...BaseElement,
|
||||
url: z.string(),
|
||||
altText: z.string().optional(),
|
||||
backgroundColor: z.string().optional(),
|
||||
height: z.string().optional(),
|
||||
width: z.string().optional(),
|
||||
horizontalAlignment: HorizontalAlignment.optional(),
|
||||
size: ImageSize.optional(),
|
||||
style: ImageStyle.optional(),
|
||||
}),
|
||||
},
|
||||
|
||||
Container: {
|
||||
description: 'Groups elements together',
|
||||
props: z.object({
|
||||
...BaseElement,
|
||||
items: z.array(z.unknown()),
|
||||
style: z.enum(['default', 'emphasis', 'good', 'attention', 'warning', 'accent']).optional(),
|
||||
verticalContentAlignment: VerticalAlignment.optional(),
|
||||
bleed: z.boolean().optional(),
|
||||
minHeight: z.string().optional(),
|
||||
}),
|
||||
},
|
||||
|
||||
ColumnSet: {
|
||||
description: 'Arranges columns horizontally',
|
||||
props: z.object({
|
||||
...BaseElement,
|
||||
columns: z.array(z.unknown()),
|
||||
horizontalAlignment: HorizontalAlignment.optional(),
|
||||
minHeight: z.string().optional(),
|
||||
}),
|
||||
},
|
||||
|
||||
Column: {
|
||||
description: 'A column within a ColumnSet',
|
||||
props: z.object({
|
||||
...BaseElement,
|
||||
items: z.array(z.unknown()).optional(),
|
||||
width: z.union([z.string(), z.number()]).optional(),
|
||||
style: z.enum(['default', 'emphasis', 'good', 'attention', 'warning', 'accent']).optional(),
|
||||
verticalContentAlignment: VerticalAlignment.optional(),
|
||||
}),
|
||||
},
|
||||
|
||||
FactSet: {
|
||||
description: 'Displays a series of facts as key/value pairs',
|
||||
props: z.object({
|
||||
...BaseElement,
|
||||
facts: z.array(z.object({
|
||||
title: z.string(),
|
||||
value: z.string(),
|
||||
})),
|
||||
}),
|
||||
},
|
||||
|
||||
// Inputs
|
||||
'Input.Text': {
|
||||
description: 'Text input field',
|
||||
props: z.object({
|
||||
...BaseElement,
|
||||
id: z.string(),
|
||||
isMultiline: z.boolean().optional(),
|
||||
maxLength: z.number().optional(),
|
||||
placeholder: z.string().optional(),
|
||||
label: z.string().optional(),
|
||||
value: z.string().optional(),
|
||||
style: z.enum(['text', 'tel', 'url', 'email', 'password']).optional(),
|
||||
isRequired: z.boolean().optional(),
|
||||
errorMessage: z.string().optional(),
|
||||
}),
|
||||
},
|
||||
|
||||
'Input.Number': {
|
||||
description: 'Number input field',
|
||||
props: z.object({
|
||||
...BaseElement,
|
||||
id: z.string(),
|
||||
max: z.number().optional(),
|
||||
min: z.number().optional(),
|
||||
placeholder: z.string().optional(),
|
||||
label: z.string().optional(),
|
||||
value: z.number().optional(),
|
||||
isRequired: z.boolean().optional(),
|
||||
errorMessage: z.string().optional(),
|
||||
}),
|
||||
},
|
||||
|
||||
'Input.Toggle': {
|
||||
description: 'Toggle/checkbox input',
|
||||
props: z.object({
|
||||
...BaseElement,
|
||||
id: z.string(),
|
||||
title: z.string(),
|
||||
label: z.string().optional(),
|
||||
value: z.string().optional(),
|
||||
valueOff: z.string().optional(),
|
||||
valueOn: z.string().optional(),
|
||||
isRequired: z.boolean().optional(),
|
||||
}),
|
||||
},
|
||||
|
||||
'Input.ChoiceSet': {
|
||||
description: 'Dropdown or radio/checkbox group',
|
||||
props: z.object({
|
||||
...BaseElement,
|
||||
id: z.string(),
|
||||
choices: z.array(z.object({
|
||||
title: z.string(),
|
||||
value: z.string(),
|
||||
})),
|
||||
isMultiSelect: z.boolean().optional(),
|
||||
style: z.enum(['compact', 'expanded']).optional(),
|
||||
label: z.string().optional(),
|
||||
value: z.string().optional(),
|
||||
placeholder: z.string().optional(),
|
||||
isRequired: z.boolean().optional(),
|
||||
}),
|
||||
},
|
||||
|
||||
// Actions
|
||||
'Action.OpenUrl': {
|
||||
description: 'Opens a URL',
|
||||
props: z.object({
|
||||
title: z.string().optional(),
|
||||
url: z.string(),
|
||||
iconUrl: z.string().optional(),
|
||||
}),
|
||||
},
|
||||
|
||||
'Action.Submit': {
|
||||
description: 'Submits input data',
|
||||
props: z.object({
|
||||
title: z.string().optional(),
|
||||
data: z.unknown().optional(),
|
||||
iconUrl: z.string().optional(),
|
||||
}),
|
||||
},
|
||||
|
||||
'Action.ShowCard': {
|
||||
description: 'Shows a card inline',
|
||||
props: z.object({
|
||||
title: z.string().optional(),
|
||||
card: z.unknown(),
|
||||
iconUrl: z.string().optional(),
|
||||
}),
|
||||
},
|
||||
|
||||
'Action.Execute': {
|
||||
description: 'Universal action for bots',
|
||||
props: z.object({
|
||||
title: z.string().optional(),
|
||||
verb: z.string().optional(),
|
||||
data: z.unknown().optional(),
|
||||
iconUrl: z.string().optional(),
|
||||
}),
|
||||
},
|
||||
},
|
||||
});
|
||||
```
|
||||
|
||||
## Building an Adaptive Cards Renderer
|
||||
|
||||
Create a renderer that processes Adaptive Cards JSON. See the [A2UI integration](/docs/a2ui) page for a similar pattern. The key is mapping each Adaptive Card element type to a React component, resolving nested `items` and `columns` arrays recursively.
|
||||
|
||||
## Usage Example
|
||||
|
||||
Render an Adaptive Card and handle actions:
|
||||
|
||||
```tsx
|
||||
'use client';
|
||||
|
||||
import { AdaptiveCardRenderer } from './adaptive-card-renderer';
|
||||
|
||||
const card = {
|
||||
type: 'AdaptiveCard' as const,
|
||||
version: '1.5',
|
||||
body: [
|
||||
{
|
||||
type: 'TextBlock',
|
||||
text: 'Contact Form',
|
||||
size: 'large',
|
||||
weight: 'bolder',
|
||||
},
|
||||
{
|
||||
type: 'Input.Text',
|
||||
id: 'name',
|
||||
label: 'Your Name',
|
||||
placeholder: 'Enter your name',
|
||||
},
|
||||
{
|
||||
type: 'Input.Text',
|
||||
id: 'message',
|
||||
label: 'Message',
|
||||
placeholder: 'Enter your message',
|
||||
isMultiline: true,
|
||||
},
|
||||
],
|
||||
actions: [
|
||||
{
|
||||
type: 'Action.Submit',
|
||||
title: 'Send',
|
||||
data: { action: 'submitForm' },
|
||||
},
|
||||
],
|
||||
};
|
||||
|
||||
export function ContactCard() {
|
||||
const handleAction = (action: any, inputData: Record<string, unknown>) => {
|
||||
console.log('Action:', action);
|
||||
console.log('Input data:', inputData);
|
||||
|
||||
// Send to your backend
|
||||
fetch('/api/submit', {
|
||||
method: 'POST',
|
||||
headers: { 'Content-Type': 'application/json' },
|
||||
body: JSON.stringify({ action, data: inputData }),
|
||||
});
|
||||
};
|
||||
|
||||
return <AdaptiveCardRenderer card={card} onAction={handleAction} />;
|
||||
}
|
||||
```
|
||||
|
||||
## Handling Action.Execute for Bots
|
||||
|
||||
For bot scenarios, handle `Action.Execute` with the verb and data:
|
||||
|
||||
```typescript
|
||||
interface ActionExecutePayload {
|
||||
action: {
|
||||
type: 'Action.Execute';
|
||||
verb: string;
|
||||
data?: unknown;
|
||||
};
|
||||
inputs: Record<string, unknown>;
|
||||
}
|
||||
|
||||
async function handleBotAction(payload: ActionExecutePayload) {
|
||||
const response = await fetch('/api/bot/action', {
|
||||
method: 'POST',
|
||||
headers: { 'Content-Type': 'application/json' },
|
||||
body: JSON.stringify({
|
||||
verb: payload.action.verb,
|
||||
data: payload.action.data,
|
||||
inputs: payload.inputs,
|
||||
}),
|
||||
});
|
||||
|
||||
// Bot may return a new card to render
|
||||
const result = await response.json();
|
||||
if (result.card) {
|
||||
return result.card; // New AdaptiveCard to render
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Next
|
||||
|
||||
Learn about [A2UI integration](/docs/a2ui) for another agent-driven UI protocol.
|
||||
@@ -1,791 +0,0 @@
|
||||
import Link from "next/link";
|
||||
import { Code } from "@/components/code";
|
||||
|
||||
export const metadata = {
|
||||
title: "Adaptive Cards Integration | json-render",
|
||||
};
|
||||
|
||||
export default function AdaptiveCardsPage() {
|
||||
return (
|
||||
<article>
|
||||
<h1 className="text-3xl font-bold mb-4">Adaptive Cards Integration</h1>
|
||||
<p className="text-muted-foreground mb-8">
|
||||
Use json-render to render{" "}
|
||||
<a
|
||||
href="https://adaptivecards.io"
|
||||
target="_blank"
|
||||
rel="noopener noreferrer"
|
||||
className="text-foreground hover:underline"
|
||||
>
|
||||
Microsoft Adaptive Cards
|
||||
</a>{" "}
|
||||
natively.
|
||||
</p>
|
||||
|
||||
<div className="rounded-lg border border-amber-500/50 bg-amber-500/10 p-4 mb-8">
|
||||
<p className="text-sm text-amber-700 dark:text-amber-300">
|
||||
<strong>Concept:</strong> This page demonstrates how json-render can
|
||||
support Adaptive Cards. The examples are illustrative and may require
|
||||
adaptation for production use.
|
||||
</p>
|
||||
</div>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">
|
||||
Adaptive Cards Overview
|
||||
</h2>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
Adaptive Cards is a JSON-based format for platform-agnostic UI snippets.
|
||||
Cards have a <code className="text-foreground">body</code> array of
|
||||
elements and an optional{" "}
|
||||
<code className="text-foreground">actions</code> array for interactive
|
||||
buttons.
|
||||
</p>
|
||||
|
||||
<h3 className="text-lg font-medium mt-8 mb-3">Example Adaptive Card</h3>
|
||||
<Code lang="json">{`{
|
||||
"$schema": "http://adaptivecards.io/schemas/adaptive-card.json",
|
||||
"type": "AdaptiveCard",
|
||||
"version": "1.5",
|
||||
"body": [
|
||||
{
|
||||
"type": "TextBlock",
|
||||
"text": "Hello, Adaptive Cards!",
|
||||
"size": "large",
|
||||
"weight": "bolder"
|
||||
},
|
||||
{
|
||||
"type": "Image",
|
||||
"url": "https://example.com/image.png",
|
||||
"altText": "Example image"
|
||||
},
|
||||
{
|
||||
"type": "Container",
|
||||
"items": [
|
||||
{
|
||||
"type": "TextBlock",
|
||||
"text": "This is inside a container",
|
||||
"wrap": true
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"type": "ColumnSet",
|
||||
"columns": [
|
||||
{
|
||||
"type": "Column",
|
||||
"width": "auto",
|
||||
"items": [
|
||||
{ "type": "TextBlock", "text": "Column 1" }
|
||||
]
|
||||
},
|
||||
{
|
||||
"type": "Column",
|
||||
"width": "stretch",
|
||||
"items": [
|
||||
{ "type": "TextBlock", "text": "Column 2" }
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"type": "Input.Text",
|
||||
"id": "userInput",
|
||||
"placeholder": "Enter your name",
|
||||
"label": "Name"
|
||||
}
|
||||
],
|
||||
"actions": [
|
||||
{
|
||||
"type": "Action.Submit",
|
||||
"title": "Submit"
|
||||
},
|
||||
{
|
||||
"type": "Action.OpenUrl",
|
||||
"title": "Learn More",
|
||||
"url": "https://adaptivecards.io"
|
||||
}
|
||||
]
|
||||
}`}</Code>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">
|
||||
Creating an Adaptive Cards Catalog
|
||||
</h2>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
Define a catalog matching the Adaptive Cards element types:
|
||||
</p>
|
||||
<Code lang="typescript">{`import { createCatalog } from '@json-render/core';
|
||||
import { z } from 'zod';
|
||||
|
||||
// Common Adaptive Cards properties
|
||||
const Spacing = z.enum(['none', 'small', 'default', 'medium', 'large', 'extraLarge', 'padding']);
|
||||
const HorizontalAlignment = z.enum(['left', 'center', 'right']);
|
||||
const VerticalAlignment = z.enum(['top', 'center', 'bottom']);
|
||||
const FontSize = z.enum(['small', 'default', 'medium', 'large', 'extraLarge']);
|
||||
const FontWeight = z.enum(['lighter', 'default', 'bolder']);
|
||||
const ImageSize = z.enum(['auto', 'stretch', 'small', 'medium', 'large']);
|
||||
const ImageStyle = z.enum(['default', 'person']);
|
||||
|
||||
// Base element properties shared by most elements
|
||||
const BaseElement = {
|
||||
id: z.string().optional(),
|
||||
isVisible: z.boolean().optional(),
|
||||
separator: z.boolean().optional(),
|
||||
spacing: Spacing.optional(),
|
||||
};
|
||||
|
||||
export const adaptiveCardsCatalog = createCatalog({
|
||||
components: {
|
||||
// Root card
|
||||
AdaptiveCard: {
|
||||
description: 'Root Adaptive Card container',
|
||||
props: z.object({
|
||||
version: z.string(),
|
||||
body: z.array(z.unknown()).optional(),
|
||||
actions: z.array(z.unknown()).optional(),
|
||||
fallbackText: z.string().optional(),
|
||||
minHeight: z.string().optional(),
|
||||
rtl: z.boolean().optional(),
|
||||
verticalContentAlignment: VerticalAlignment.optional(),
|
||||
}),
|
||||
},
|
||||
|
||||
// Elements
|
||||
TextBlock: {
|
||||
description: 'Displays text with formatting options',
|
||||
props: z.object({
|
||||
...BaseElement,
|
||||
text: z.string(),
|
||||
color: z.enum(['default', 'dark', 'light', 'accent', 'good', 'warning', 'attention']).optional(),
|
||||
fontType: z.enum(['default', 'monospace']).optional(),
|
||||
horizontalAlignment: HorizontalAlignment.optional(),
|
||||
isSubtle: z.boolean().optional(),
|
||||
maxLines: z.number().optional(),
|
||||
size: FontSize.optional(),
|
||||
weight: FontWeight.optional(),
|
||||
wrap: z.boolean().optional(),
|
||||
}),
|
||||
},
|
||||
|
||||
Image: {
|
||||
description: 'Displays an image',
|
||||
props: z.object({
|
||||
...BaseElement,
|
||||
url: z.string(),
|
||||
altText: z.string().optional(),
|
||||
backgroundColor: z.string().optional(),
|
||||
height: z.string().optional(),
|
||||
width: z.string().optional(),
|
||||
horizontalAlignment: HorizontalAlignment.optional(),
|
||||
size: ImageSize.optional(),
|
||||
style: ImageStyle.optional(),
|
||||
}),
|
||||
},
|
||||
|
||||
Container: {
|
||||
description: 'Groups elements together',
|
||||
props: z.object({
|
||||
...BaseElement,
|
||||
items: z.array(z.unknown()),
|
||||
style: z.enum(['default', 'emphasis', 'good', 'attention', 'warning', 'accent']).optional(),
|
||||
verticalContentAlignment: VerticalAlignment.optional(),
|
||||
bleed: z.boolean().optional(),
|
||||
minHeight: z.string().optional(),
|
||||
}),
|
||||
},
|
||||
|
||||
ColumnSet: {
|
||||
description: 'Arranges columns horizontally',
|
||||
props: z.object({
|
||||
...BaseElement,
|
||||
columns: z.array(z.unknown()),
|
||||
horizontalAlignment: HorizontalAlignment.optional(),
|
||||
minHeight: z.string().optional(),
|
||||
}),
|
||||
},
|
||||
|
||||
Column: {
|
||||
description: 'A column within a ColumnSet',
|
||||
props: z.object({
|
||||
...BaseElement,
|
||||
items: z.array(z.unknown()).optional(),
|
||||
width: z.union([z.string(), z.number()]).optional(),
|
||||
style: z.enum(['default', 'emphasis', 'good', 'attention', 'warning', 'accent']).optional(),
|
||||
verticalContentAlignment: VerticalAlignment.optional(),
|
||||
}),
|
||||
},
|
||||
|
||||
FactSet: {
|
||||
description: 'Displays a series of facts as key/value pairs',
|
||||
props: z.object({
|
||||
...BaseElement,
|
||||
facts: z.array(z.object({
|
||||
title: z.string(),
|
||||
value: z.string(),
|
||||
})),
|
||||
}),
|
||||
},
|
||||
|
||||
ImageSet: {
|
||||
description: 'Displays a collection of images',
|
||||
props: z.object({
|
||||
...BaseElement,
|
||||
images: z.array(z.object({
|
||||
type: z.literal('Image'),
|
||||
url: z.string(),
|
||||
altText: z.string().optional(),
|
||||
})),
|
||||
imageSize: ImageSize.optional(),
|
||||
}),
|
||||
},
|
||||
|
||||
ActionSet: {
|
||||
description: 'Displays a set of actions',
|
||||
props: z.object({
|
||||
...BaseElement,
|
||||
actions: z.array(z.unknown()),
|
||||
}),
|
||||
},
|
||||
|
||||
RichTextBlock: {
|
||||
description: 'Rich text with inline formatting',
|
||||
props: z.object({
|
||||
...BaseElement,
|
||||
inlines: z.array(z.unknown()),
|
||||
horizontalAlignment: HorizontalAlignment.optional(),
|
||||
}),
|
||||
},
|
||||
|
||||
// Inputs
|
||||
'Input.Text': {
|
||||
description: 'Text input field',
|
||||
props: z.object({
|
||||
...BaseElement,
|
||||
id: z.string(),
|
||||
isMultiline: z.boolean().optional(),
|
||||
maxLength: z.number().optional(),
|
||||
placeholder: z.string().optional(),
|
||||
label: z.string().optional(),
|
||||
value: z.string().optional(),
|
||||
style: z.enum(['text', 'tel', 'url', 'email', 'password']).optional(),
|
||||
isRequired: z.boolean().optional(),
|
||||
errorMessage: z.string().optional(),
|
||||
}),
|
||||
},
|
||||
|
||||
'Input.Number': {
|
||||
description: 'Number input field',
|
||||
props: z.object({
|
||||
...BaseElement,
|
||||
id: z.string(),
|
||||
max: z.number().optional(),
|
||||
min: z.number().optional(),
|
||||
placeholder: z.string().optional(),
|
||||
label: z.string().optional(),
|
||||
value: z.number().optional(),
|
||||
isRequired: z.boolean().optional(),
|
||||
errorMessage: z.string().optional(),
|
||||
}),
|
||||
},
|
||||
|
||||
'Input.Date': {
|
||||
description: 'Date picker input',
|
||||
props: z.object({
|
||||
...BaseElement,
|
||||
id: z.string(),
|
||||
max: z.string().optional(),
|
||||
min: z.string().optional(),
|
||||
placeholder: z.string().optional(),
|
||||
label: z.string().optional(),
|
||||
value: z.string().optional(),
|
||||
isRequired: z.boolean().optional(),
|
||||
}),
|
||||
},
|
||||
|
||||
'Input.Time': {
|
||||
description: 'Time picker input',
|
||||
props: z.object({
|
||||
...BaseElement,
|
||||
id: z.string(),
|
||||
max: z.string().optional(),
|
||||
min: z.string().optional(),
|
||||
placeholder: z.string().optional(),
|
||||
label: z.string().optional(),
|
||||
value: z.string().optional(),
|
||||
isRequired: z.boolean().optional(),
|
||||
}),
|
||||
},
|
||||
|
||||
'Input.Toggle': {
|
||||
description: 'Toggle/checkbox input',
|
||||
props: z.object({
|
||||
...BaseElement,
|
||||
id: z.string(),
|
||||
title: z.string(),
|
||||
label: z.string().optional(),
|
||||
value: z.string().optional(),
|
||||
valueOff: z.string().optional(),
|
||||
valueOn: z.string().optional(),
|
||||
isRequired: z.boolean().optional(),
|
||||
}),
|
||||
},
|
||||
|
||||
'Input.ChoiceSet': {
|
||||
description: 'Dropdown or radio/checkbox group',
|
||||
props: z.object({
|
||||
...BaseElement,
|
||||
id: z.string(),
|
||||
choices: z.array(z.object({
|
||||
title: z.string(),
|
||||
value: z.string(),
|
||||
})),
|
||||
isMultiSelect: z.boolean().optional(),
|
||||
style: z.enum(['compact', 'expanded']).optional(),
|
||||
label: z.string().optional(),
|
||||
value: z.string().optional(),
|
||||
placeholder: z.string().optional(),
|
||||
isRequired: z.boolean().optional(),
|
||||
}),
|
||||
},
|
||||
|
||||
// Actions
|
||||
'Action.OpenUrl': {
|
||||
description: 'Opens a URL',
|
||||
props: z.object({
|
||||
title: z.string().optional(),
|
||||
url: z.string(),
|
||||
iconUrl: z.string().optional(),
|
||||
}),
|
||||
},
|
||||
|
||||
'Action.Submit': {
|
||||
description: 'Submits input data',
|
||||
props: z.object({
|
||||
title: z.string().optional(),
|
||||
data: z.unknown().optional(),
|
||||
iconUrl: z.string().optional(),
|
||||
}),
|
||||
},
|
||||
|
||||
'Action.ShowCard': {
|
||||
description: 'Shows a card inline',
|
||||
props: z.object({
|
||||
title: z.string().optional(),
|
||||
card: z.unknown(),
|
||||
iconUrl: z.string().optional(),
|
||||
}),
|
||||
},
|
||||
|
||||
'Action.ToggleVisibility': {
|
||||
description: 'Toggles visibility of elements',
|
||||
props: z.object({
|
||||
title: z.string().optional(),
|
||||
targetElements: z.array(z.union([
|
||||
z.string(),
|
||||
z.object({ elementId: z.string(), isVisible: z.boolean().optional() }),
|
||||
])),
|
||||
iconUrl: z.string().optional(),
|
||||
}),
|
||||
},
|
||||
|
||||
'Action.Execute': {
|
||||
description: 'Universal action for bots',
|
||||
props: z.object({
|
||||
title: z.string().optional(),
|
||||
verb: z.string().optional(),
|
||||
data: z.unknown().optional(),
|
||||
iconUrl: z.string().optional(),
|
||||
}),
|
||||
},
|
||||
},
|
||||
});`}</Code>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">
|
||||
Building an Adaptive Cards Renderer
|
||||
</h2>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
Create a renderer that processes Adaptive Cards JSON:
|
||||
</p>
|
||||
<Code lang="tsx">{`'use client';
|
||||
|
||||
import React from 'react';
|
||||
|
||||
interface AdaptiveCardElement {
|
||||
type: string;
|
||||
[key: string]: unknown;
|
||||
}
|
||||
|
||||
interface AdaptiveCard {
|
||||
type: 'AdaptiveCard';
|
||||
version: string;
|
||||
body?: AdaptiveCardElement[];
|
||||
actions?: AdaptiveCardElement[];
|
||||
}
|
||||
|
||||
interface RenderContext {
|
||||
onAction: (action: AdaptiveCardElement, data: Record<string, unknown>) => void;
|
||||
inputs: Record<string, unknown>;
|
||||
setInput: (id: string, value: unknown) => void;
|
||||
}
|
||||
|
||||
// Widget registry for Adaptive Cards elements
|
||||
const widgets: Record<string, React.FC<any>> = {
|
||||
TextBlock: ({ text, size, weight, color, isSubtle, wrap, horizontalAlignment }) => {
|
||||
const sizeClass = {
|
||||
small: 'text-xs',
|
||||
default: 'text-sm',
|
||||
medium: 'text-base',
|
||||
large: 'text-lg',
|
||||
extraLarge: 'text-2xl',
|
||||
}[size || 'default'];
|
||||
|
||||
const weightClass = {
|
||||
lighter: 'font-light',
|
||||
default: 'font-normal',
|
||||
bolder: 'font-bold',
|
||||
}[weight || 'default'];
|
||||
|
||||
const alignClass = {
|
||||
left: 'text-left',
|
||||
center: 'text-center',
|
||||
right: 'text-right',
|
||||
}[horizontalAlignment || 'left'];
|
||||
|
||||
return (
|
||||
<p className={\`\${sizeClass} \${weightClass} \${alignClass} \${isSubtle ? 'text-muted-foreground' : ''} \${wrap !== false ? '' : 'truncate'}\`}>
|
||||
{text}
|
||||
</p>
|
||||
);
|
||||
},
|
||||
|
||||
Image: ({ url, altText, size, style, horizontalAlignment }) => {
|
||||
const sizeClass = {
|
||||
auto: '',
|
||||
stretch: 'w-full',
|
||||
small: 'w-16',
|
||||
medium: 'w-32',
|
||||
large: 'w-48',
|
||||
}[size || 'auto'];
|
||||
|
||||
return (
|
||||
<div className={\`flex \${horizontalAlignment === 'center' ? 'justify-center' : horizontalAlignment === 'right' ? 'justify-end' : ''}\`}>
|
||||
<img
|
||||
src={url}
|
||||
alt={altText || ''}
|
||||
className={\`\${sizeClass} \${style === 'person' ? 'rounded-full' : ''}\`}
|
||||
/>
|
||||
</div>
|
||||
);
|
||||
},
|
||||
|
||||
Container: ({ items, style, children, ctx }) => {
|
||||
const styleClass = {
|
||||
default: '',
|
||||
emphasis: 'bg-muted p-2 rounded',
|
||||
good: 'bg-green-50 p-2 rounded',
|
||||
attention: 'bg-red-50 p-2 rounded',
|
||||
warning: 'bg-yellow-50 p-2 rounded',
|
||||
accent: 'bg-blue-50 p-2 rounded',
|
||||
}[style || 'default'];
|
||||
|
||||
return (
|
||||
<div className={\`\${styleClass} space-y-2\`}>
|
||||
{children || items?.map((item: any, i: number) => (
|
||||
<AdaptiveElement key={i} element={item} ctx={ctx} />
|
||||
))}
|
||||
</div>
|
||||
);
|
||||
},
|
||||
|
||||
ColumnSet: ({ columns, ctx }) => (
|
||||
<div className="flex gap-2">
|
||||
{columns?.map((col: any, i: number) => (
|
||||
<AdaptiveElement key={i} element={{ ...col, type: 'Column' }} ctx={ctx} />
|
||||
))}
|
||||
</div>
|
||||
),
|
||||
|
||||
Column: ({ items, width, style, ctx }) => {
|
||||
const widthClass = width === 'auto' ? 'flex-none' :
|
||||
width === 'stretch' ? 'flex-1' :
|
||||
typeof width === 'number' ? \`flex-[\${width}]\` : 'flex-1';
|
||||
return (
|
||||
<div className={\`\${widthClass} space-y-2\`}>
|
||||
{items?.map((item: any, i: number) => (
|
||||
<AdaptiveElement key={i} element={item} ctx={ctx} />
|
||||
))}
|
||||
</div>
|
||||
);
|
||||
},
|
||||
|
||||
FactSet: ({ facts }) => (
|
||||
<div className="grid grid-cols-2 gap-x-4 gap-y-1 text-sm">
|
||||
{facts?.map((fact: any, i: number) => (
|
||||
<React.Fragment key={i}>
|
||||
<span className="font-medium">{fact.title}</span>
|
||||
<span>{fact.value}</span>
|
||||
</React.Fragment>
|
||||
))}
|
||||
</div>
|
||||
),
|
||||
|
||||
ActionSet: ({ actions, ctx }) => (
|
||||
<div className="flex gap-2 pt-2">
|
||||
{actions?.map((action: any, i: number) => (
|
||||
<AdaptiveElement key={i} element={action} ctx={ctx} />
|
||||
))}
|
||||
</div>
|
||||
),
|
||||
|
||||
'Input.Text': ({ id, placeholder, label, isMultiline, value, ctx }) => (
|
||||
<div className="space-y-1">
|
||||
{label && <label className="text-sm font-medium">{label}</label>}
|
||||
{isMultiline ? (
|
||||
<textarea
|
||||
className="w-full px-3 py-2 border rounded text-sm"
|
||||
placeholder={placeholder}
|
||||
defaultValue={value}
|
||||
onChange={(e) => ctx.setInput(id, e.target.value)}
|
||||
/>
|
||||
) : (
|
||||
<input
|
||||
type="text"
|
||||
className="w-full px-3 py-2 border rounded text-sm"
|
||||
placeholder={placeholder}
|
||||
defaultValue={value}
|
||||
onChange={(e) => ctx.setInput(id, e.target.value)}
|
||||
/>
|
||||
)}
|
||||
</div>
|
||||
),
|
||||
|
||||
'Input.Number': ({ id, placeholder, label, min, max, value, ctx }) => (
|
||||
<div className="space-y-1">
|
||||
{label && <label className="text-sm font-medium">{label}</label>}
|
||||
<input
|
||||
type="number"
|
||||
className="w-full px-3 py-2 border rounded text-sm"
|
||||
placeholder={placeholder}
|
||||
min={min}
|
||||
max={max}
|
||||
defaultValue={value}
|
||||
onChange={(e) => ctx.setInput(id, parseFloat(e.target.value))}
|
||||
/>
|
||||
</div>
|
||||
),
|
||||
|
||||
'Input.Toggle': ({ id, title, label, valueOn = 'true', valueOff = 'false', value, ctx }) => (
|
||||
<div className="flex items-center gap-2">
|
||||
<input
|
||||
type="checkbox"
|
||||
id={id}
|
||||
defaultChecked={value === valueOn}
|
||||
onChange={(e) => ctx.setInput(id, e.target.checked ? valueOn : valueOff)}
|
||||
/>
|
||||
<label htmlFor={id} className="text-sm">{title || label}</label>
|
||||
</div>
|
||||
),
|
||||
|
||||
'Input.ChoiceSet': ({ id, choices, isMultiSelect, style, label, placeholder, ctx }) => (
|
||||
<div className="space-y-1">
|
||||
{label && <label className="text-sm font-medium">{label}</label>}
|
||||
{style === 'expanded' ? (
|
||||
<div className="space-y-1">
|
||||
{choices?.map((choice: any, i: number) => (
|
||||
<label key={i} className="flex items-center gap-2 text-sm">
|
||||
<input
|
||||
type={isMultiSelect ? 'checkbox' : 'radio'}
|
||||
name={id}
|
||||
value={choice.value}
|
||||
onChange={(e) => ctx.setInput(id, e.target.value)}
|
||||
/>
|
||||
{choice.title}
|
||||
</label>
|
||||
))}
|
||||
</div>
|
||||
) : (
|
||||
<select
|
||||
className="w-full px-3 py-2 border rounded text-sm"
|
||||
onChange={(e) => ctx.setInput(id, e.target.value)}
|
||||
>
|
||||
{placeholder && <option value="">{placeholder}</option>}
|
||||
{choices?.map((choice: any, i: number) => (
|
||||
<option key={i} value={choice.value}>{choice.title}</option>
|
||||
))}
|
||||
</select>
|
||||
)}
|
||||
</div>
|
||||
),
|
||||
|
||||
'Action.Submit': ({ title, data, ctx }) => (
|
||||
<button
|
||||
className="px-4 py-2 bg-primary text-primary-foreground rounded text-sm"
|
||||
onClick={() => ctx.onAction({ type: 'Action.Submit', data }, ctx.inputs)}
|
||||
>
|
||||
{title || 'Submit'}
|
||||
</button>
|
||||
),
|
||||
|
||||
'Action.OpenUrl': ({ title, url }) => (
|
||||
<a
|
||||
href={url}
|
||||
target="_blank"
|
||||
rel="noopener noreferrer"
|
||||
className="px-4 py-2 border rounded text-sm hover:bg-muted"
|
||||
>
|
||||
{title || 'Open'}
|
||||
</a>
|
||||
),
|
||||
|
||||
'Action.Execute': ({ title, verb, data, ctx }) => (
|
||||
<button
|
||||
className="px-4 py-2 bg-primary text-primary-foreground rounded text-sm"
|
||||
onClick={() => ctx.onAction({ type: 'Action.Execute', verb, data }, ctx.inputs)}
|
||||
>
|
||||
{title || 'Execute'}
|
||||
</button>
|
||||
),
|
||||
};
|
||||
|
||||
function AdaptiveElement({ element, ctx }: { element: AdaptiveCardElement; ctx: RenderContext }) {
|
||||
const Widget = widgets[element.type];
|
||||
if (!Widget) {
|
||||
console.warn(\`Unknown Adaptive Card element: \${element.type}\`);
|
||||
return null;
|
||||
}
|
||||
return <Widget {...element} ctx={ctx} />;
|
||||
}
|
||||
|
||||
export function AdaptiveCardRenderer({
|
||||
card,
|
||||
onAction,
|
||||
}: {
|
||||
card: AdaptiveCard;
|
||||
onAction?: (action: AdaptiveCardElement, data: Record<string, unknown>) => void;
|
||||
}) {
|
||||
const [inputs, setInputs] = React.useState<Record<string, unknown>>({});
|
||||
|
||||
const ctx: RenderContext = {
|
||||
onAction: onAction || (() => {}),
|
||||
inputs,
|
||||
setInput: (id, value) => setInputs((prev) => ({ ...prev, [id]: value })),
|
||||
};
|
||||
|
||||
return (
|
||||
<div className="rounded-lg border p-4 space-y-3 max-w-md">
|
||||
{card.body?.map((element, i) => (
|
||||
<AdaptiveElement key={i} element={element} ctx={ctx} />
|
||||
))}
|
||||
{card.actions && card.actions.length > 0 && (
|
||||
<div className="flex gap-2 pt-2 border-t">
|
||||
{card.actions.map((action, i) => (
|
||||
<AdaptiveElement key={i} element={action} ctx={ctx} />
|
||||
))}
|
||||
</div>
|
||||
)}
|
||||
</div>
|
||||
);
|
||||
}`}</Code>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">Usage Example</h2>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
Render an Adaptive Card and handle actions:
|
||||
</p>
|
||||
<Code lang="tsx">{`'use client';
|
||||
|
||||
import { AdaptiveCardRenderer } from './adaptive-card-renderer';
|
||||
|
||||
const card = {
|
||||
type: 'AdaptiveCard' as const,
|
||||
version: '1.5',
|
||||
body: [
|
||||
{
|
||||
type: 'TextBlock',
|
||||
text: 'Contact Form',
|
||||
size: 'large',
|
||||
weight: 'bolder',
|
||||
},
|
||||
{
|
||||
type: 'Input.Text',
|
||||
id: 'name',
|
||||
label: 'Your Name',
|
||||
placeholder: 'Enter your name',
|
||||
},
|
||||
{
|
||||
type: 'Input.Text',
|
||||
id: 'message',
|
||||
label: 'Message',
|
||||
placeholder: 'Enter your message',
|
||||
isMultiline: true,
|
||||
},
|
||||
],
|
||||
actions: [
|
||||
{
|
||||
type: 'Action.Submit',
|
||||
title: 'Send',
|
||||
data: { action: 'submitForm' },
|
||||
},
|
||||
],
|
||||
};
|
||||
|
||||
export function ContactCard() {
|
||||
const handleAction = (action: any, inputData: Record<string, unknown>) => {
|
||||
console.log('Action:', action);
|
||||
console.log('Input data:', inputData);
|
||||
|
||||
// Send to your backend
|
||||
fetch('/api/submit', {
|
||||
method: 'POST',
|
||||
headers: { 'Content-Type': 'application/json' },
|
||||
body: JSON.stringify({ action, data: inputData }),
|
||||
});
|
||||
};
|
||||
|
||||
return <AdaptiveCardRenderer card={card} onAction={handleAction} />;
|
||||
}`}</Code>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">
|
||||
Handling Action.Execute for Bots
|
||||
</h2>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
For bot scenarios, handle{" "}
|
||||
<code className="text-foreground">Action.Execute</code> with the verb
|
||||
and data:
|
||||
</p>
|
||||
<Code lang="typescript">{`interface ActionExecutePayload {
|
||||
action: {
|
||||
type: 'Action.Execute';
|
||||
verb: string;
|
||||
data?: unknown;
|
||||
};
|
||||
inputs: Record<string, unknown>;
|
||||
}
|
||||
|
||||
async function handleBotAction(payload: ActionExecutePayload) {
|
||||
const response = await fetch('/api/bot/action', {
|
||||
method: 'POST',
|
||||
headers: { 'Content-Type': 'application/json' },
|
||||
body: JSON.stringify({
|
||||
verb: payload.action.verb,
|
||||
data: payload.action.data,
|
||||
inputs: payload.inputs,
|
||||
}),
|
||||
});
|
||||
|
||||
// Bot may return a new card to render
|
||||
const result = await response.json();
|
||||
if (result.card) {
|
||||
return result.card; // New AdaptiveCard to render
|
||||
}
|
||||
}`}</Code>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">Next</h2>
|
||||
<p className="text-sm text-muted-foreground">
|
||||
Learn about{" "}
|
||||
<Link href="/docs/a2ui" className="text-foreground hover:underline">
|
||||
A2UI integration
|
||||
</Link>{" "}
|
||||
for another agent-driven UI protocol.
|
||||
</p>
|
||||
</article>
|
||||
);
|
||||
}
|
||||
@@ -0,0 +1,385 @@
|
||||
import { pageMetadata } from "@/lib/page-metadata"
|
||||
export const metadata = pageMetadata("docs/ag-ui")
|
||||
|
||||
# AG-UI Integration
|
||||
|
||||
Use json-render to support [AG-UI](https://docs.copilotkit.ai/ag-ui) (Agent User Interaction Protocol) from CopilotKit.
|
||||
|
||||
<div className="rounded-lg border border-amber-500/50 bg-amber-500/10 p-4 mb-8">
|
||||
<p className="text-sm text-amber-700 dark:text-amber-300">
|
||||
<strong>Concept:</strong> This page demonstrates how json-render can support AG-UI. The examples are illustrative and may require adaptation for production use.
|
||||
</p>
|
||||
</div>
|
||||
|
||||
## What is AG-UI?
|
||||
|
||||
AG-UI is an open protocol for connecting AI agents to user interfaces. It provides a standardized way for agents to render UI components, handle user input, and manage state. The protocol uses events streamed over HTTP to update the UI in real-time.
|
||||
|
||||
## AG-UI Event Types
|
||||
|
||||
AG-UI defines several event types for agent-UI communication:
|
||||
|
||||
- `TEXT_MESSAGE_START` / `TEXT_MESSAGE_CONTENT` / `TEXT_MESSAGE_END` — Streaming text messages
|
||||
- `TOOL_CALL_START` / `TOOL_CALL_ARGS` / `TOOL_CALL_END` — Tool/function calls
|
||||
- `STATE_SNAPSHOT` / `STATE_DELTA` — State updates
|
||||
- `CUSTOM` — Custom events for UI rendering
|
||||
|
||||
### Example AG-UI Event Stream
|
||||
|
||||
```json
|
||||
{"type": "RUN_STARTED", "threadId": "thread-123", "runId": "run-456"}
|
||||
{"type": "TEXT_MESSAGE_START", "messageId": "msg-1", "role": "assistant"}
|
||||
{"type": "TEXT_MESSAGE_CONTENT", "messageId": "msg-1", "delta": "Here's a dashboard for you:"}
|
||||
{"type": "TEXT_MESSAGE_END", "messageId": "msg-1"}
|
||||
{"type": "TOOL_CALL_START", "toolCallId": "tc-1", "toolCallName": "render_ui"}
|
||||
{"type": "TOOL_CALL_ARGS", "toolCallId": "tc-1", "delta": "{\"component\": \"Dashboard\", \"props\": {\"title\": \"Sales\"}}"}
|
||||
{"type": "TOOL_CALL_END", "toolCallId": "tc-1"}
|
||||
{"type": "RUN_FINISHED"}
|
||||
```
|
||||
|
||||
## Define the AG-UI Schema
|
||||
|
||||
Define schemas for AG-UI event types:
|
||||
|
||||
```typescript
|
||||
import { z } from 'zod';
|
||||
|
||||
// Base event schema
|
||||
const BaseEvent = z.object({
|
||||
type: z.string(),
|
||||
timestamp: z.number().optional(),
|
||||
});
|
||||
|
||||
// Text message events
|
||||
const TextMessageStart = BaseEvent.extend({
|
||||
type: z.literal('TEXT_MESSAGE_START'),
|
||||
messageId: z.string(),
|
||||
role: z.enum(['user', 'assistant']),
|
||||
});
|
||||
|
||||
const TextMessageContent = BaseEvent.extend({
|
||||
type: z.literal('TEXT_MESSAGE_CONTENT'),
|
||||
messageId: z.string(),
|
||||
delta: z.string(),
|
||||
});
|
||||
|
||||
const TextMessageEnd = BaseEvent.extend({
|
||||
type: z.literal('TEXT_MESSAGE_END'),
|
||||
messageId: z.string(),
|
||||
});
|
||||
|
||||
// Tool call events
|
||||
const ToolCallStart = BaseEvent.extend({
|
||||
type: z.literal('TOOL_CALL_START'),
|
||||
toolCallId: z.string(),
|
||||
toolCallName: z.string(),
|
||||
parentMessageId: z.string().optional(),
|
||||
});
|
||||
|
||||
const ToolCallArgs = BaseEvent.extend({
|
||||
type: z.literal('TOOL_CALL_ARGS'),
|
||||
toolCallId: z.string(),
|
||||
delta: z.string(),
|
||||
});
|
||||
|
||||
const ToolCallEnd = BaseEvent.extend({
|
||||
type: z.literal('TOOL_CALL_END'),
|
||||
toolCallId: z.string(),
|
||||
});
|
||||
|
||||
// State events
|
||||
const StateSnapshot = BaseEvent.extend({
|
||||
type: z.literal('STATE_SNAPSHOT'),
|
||||
snapshot: z.record(z.unknown()),
|
||||
});
|
||||
|
||||
const StateDelta = BaseEvent.extend({
|
||||
type: z.literal('STATE_DELTA'),
|
||||
delta: z.array(z.object({
|
||||
op: z.enum(['add', 'remove', 'replace']),
|
||||
path: z.string(),
|
||||
value: z.unknown().optional(),
|
||||
})),
|
||||
});
|
||||
|
||||
// Custom event for UI components
|
||||
const CustomEvent = BaseEvent.extend({
|
||||
type: z.literal('CUSTOM'),
|
||||
name: z.string(),
|
||||
value: z.unknown(),
|
||||
});
|
||||
|
||||
// Run lifecycle events
|
||||
const RunStarted = BaseEvent.extend({
|
||||
type: z.literal('RUN_STARTED'),
|
||||
threadId: z.string(),
|
||||
runId: z.string(),
|
||||
});
|
||||
|
||||
const RunFinished = BaseEvent.extend({
|
||||
type: z.literal('RUN_FINISHED'),
|
||||
});
|
||||
|
||||
const RunError = BaseEvent.extend({
|
||||
type: z.literal('RUN_ERROR'),
|
||||
message: z.string(),
|
||||
code: z.string().optional(),
|
||||
});
|
||||
|
||||
// Union of all events
|
||||
export const AGUIEvent = z.discriminatedUnion('type', [
|
||||
TextMessageStart,
|
||||
TextMessageContent,
|
||||
TextMessageEnd,
|
||||
ToolCallStart,
|
||||
ToolCallArgs,
|
||||
ToolCallEnd,
|
||||
StateSnapshot,
|
||||
StateDelta,
|
||||
CustomEvent,
|
||||
RunStarted,
|
||||
RunFinished,
|
||||
RunError,
|
||||
]);
|
||||
|
||||
export type AGUIEvent = z.infer<typeof AGUIEvent>;
|
||||
```
|
||||
|
||||
## Define the AG-UI Catalog
|
||||
|
||||
Create a catalog for UI components that agents can render:
|
||||
|
||||
```typescript
|
||||
import { defineCatalog } from '@json-render/core';
|
||||
import { schema } from '@json-render/react/schema';
|
||||
import { z } from 'zod';
|
||||
|
||||
export const aguiCatalog = defineCatalog(schema, {
|
||||
components: {
|
||||
Container: {
|
||||
description: 'A container for grouping elements',
|
||||
props: z.object({
|
||||
direction: z.enum(['row', 'column']).optional(),
|
||||
gap: z.enum(['none', 'sm', 'md', 'lg']).optional(),
|
||||
padding: z.enum(['none', 'sm', 'md', 'lg']).optional(),
|
||||
}),
|
||||
},
|
||||
Card: {
|
||||
description: 'A card with optional title',
|
||||
props: z.object({
|
||||
title: z.string().optional(),
|
||||
description: z.string().optional(),
|
||||
}),
|
||||
},
|
||||
Text: {
|
||||
description: 'Text content',
|
||||
props: z.object({
|
||||
content: z.string(),
|
||||
variant: z.enum(['body', 'heading', 'caption', 'code']).optional(),
|
||||
}),
|
||||
},
|
||||
Metric: {
|
||||
description: 'Displays a metric value',
|
||||
props: z.object({
|
||||
label: z.string(),
|
||||
value: z.union([z.string(), z.number()]),
|
||||
change: z.number().optional(),
|
||||
format: z.enum(['number', 'currency', 'percent']).optional(),
|
||||
}),
|
||||
},
|
||||
Button: {
|
||||
description: 'Interactive button',
|
||||
props: z.object({
|
||||
label: z.string(),
|
||||
variant: z.enum(['primary', 'secondary', 'outline', 'ghost']).optional(),
|
||||
disabled: z.boolean().optional(),
|
||||
}),
|
||||
},
|
||||
Alert: {
|
||||
description: 'Alert message',
|
||||
props: z.object({
|
||||
message: z.string(),
|
||||
type: z.enum(['info', 'success', 'warning', 'error']).optional(),
|
||||
}),
|
||||
},
|
||||
// Add more components...
|
||||
},
|
||||
|
||||
actions: {
|
||||
submit: {
|
||||
description: 'Submit form data',
|
||||
params: z.object({ formId: z.string() }),
|
||||
},
|
||||
navigate: {
|
||||
description: 'Navigate to a URL',
|
||||
params: z.object({ url: z.string() }),
|
||||
},
|
||||
callback: {
|
||||
description: 'Trigger a callback to the agent',
|
||||
params: z.object({
|
||||
name: z.string(),
|
||||
data: z.record(z.unknown()).optional(),
|
||||
}),
|
||||
},
|
||||
},
|
||||
});
|
||||
```
|
||||
|
||||
## Build an AG-UI Event Processor
|
||||
|
||||
Process AG-UI events and render UI components:
|
||||
|
||||
```tsx
|
||||
'use client';
|
||||
|
||||
import React, { useState, useCallback } from 'react';
|
||||
import { AGUIEvent } from './schema';
|
||||
|
||||
interface AGUIState {
|
||||
messages: Array<{
|
||||
id: string;
|
||||
role: 'user' | 'assistant';
|
||||
content: string;
|
||||
}>;
|
||||
toolCalls: Map<string, {
|
||||
name: string;
|
||||
args: string;
|
||||
result?: unknown;
|
||||
}>;
|
||||
state: Record<string, unknown>;
|
||||
isRunning: boolean;
|
||||
}
|
||||
|
||||
export function useAGUI() {
|
||||
const [aguiState, setAGUIState] = useState<AGUIState>({
|
||||
messages: [],
|
||||
toolCalls: new Map(),
|
||||
state: {},
|
||||
isRunning: false,
|
||||
});
|
||||
|
||||
const processEvent = useCallback((event: AGUIEvent) => {
|
||||
switch (event.type) {
|
||||
case 'RUN_STARTED':
|
||||
setAGUIState(prev => ({ ...prev, isRunning: true }));
|
||||
break;
|
||||
case 'RUN_FINISHED':
|
||||
setAGUIState(prev => ({ ...prev, isRunning: false }));
|
||||
break;
|
||||
case 'TEXT_MESSAGE_START':
|
||||
setAGUIState(prev => ({
|
||||
...prev,
|
||||
messages: [...prev.messages, {
|
||||
id: event.messageId,
|
||||
role: event.role,
|
||||
content: '',
|
||||
}],
|
||||
}));
|
||||
break;
|
||||
case 'TEXT_MESSAGE_CONTENT':
|
||||
setAGUIState(prev => ({
|
||||
...prev,
|
||||
messages: prev.messages.map(msg =>
|
||||
msg.id === event.messageId
|
||||
? { ...msg, content: msg.content + event.delta }
|
||||
: msg
|
||||
),
|
||||
}));
|
||||
break;
|
||||
case 'TOOL_CALL_START':
|
||||
setAGUIState(prev => {
|
||||
const toolCalls = new Map(prev.toolCalls);
|
||||
toolCalls.set(event.toolCallId, { name: event.toolCallName, args: '' });
|
||||
return { ...prev, toolCalls };
|
||||
});
|
||||
break;
|
||||
case 'TOOL_CALL_ARGS':
|
||||
setAGUIState(prev => {
|
||||
const toolCalls = new Map(prev.toolCalls);
|
||||
const tc = toolCalls.get(event.toolCallId);
|
||||
if (tc) {
|
||||
toolCalls.set(event.toolCallId, { ...tc, args: tc.args + event.delta });
|
||||
}
|
||||
return { ...prev, toolCalls };
|
||||
});
|
||||
break;
|
||||
case 'STATE_SNAPSHOT':
|
||||
setAGUIState(prev => ({ ...prev, state: event.snapshot }));
|
||||
break;
|
||||
}
|
||||
}, []);
|
||||
|
||||
return { state: aguiState, processEvent };
|
||||
}
|
||||
```
|
||||
|
||||
## Usage Example
|
||||
|
||||
```tsx
|
||||
'use client';
|
||||
|
||||
import { useAGUI } from './use-agui';
|
||||
import { renderToolCallUI } from './renderer';
|
||||
|
||||
export function AGUIChat() {
|
||||
const { state, processEvent } = useAGUI();
|
||||
|
||||
async function startRun(prompt: string) {
|
||||
const response = await fetch('/api/agent', {
|
||||
method: 'POST',
|
||||
headers: { 'Content-Type': 'application/json' },
|
||||
body: JSON.stringify({ prompt }),
|
||||
});
|
||||
|
||||
const reader = response.body?.getReader();
|
||||
const decoder = new TextDecoder();
|
||||
|
||||
while (reader) {
|
||||
const { done, value } = await reader.read();
|
||||
if (done) break;
|
||||
|
||||
const lines = decoder.decode(value).split('\n').filter(Boolean);
|
||||
for (const line of lines) {
|
||||
const event = JSON.parse(line);
|
||||
processEvent(event);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return (
|
||||
<div className="space-y-4">
|
||||
{state.messages.map(msg => (
|
||||
<div key={msg.id} className={`p-3 rounded ${
|
||||
msg.role === 'assistant' ? 'bg-muted' : 'bg-primary/10'
|
||||
}`}>
|
||||
{msg.content}
|
||||
</div>
|
||||
))}
|
||||
|
||||
{Array.from(state.toolCalls.values()).map((tc, i) => (
|
||||
<div key={i}>{renderToolCallUI(tc)}</div>
|
||||
))}
|
||||
|
||||
<form onSubmit={(e) => {
|
||||
e.preventDefault();
|
||||
const input = e.currentTarget.querySelector('input');
|
||||
if (input?.value) {
|
||||
startRun(input.value);
|
||||
input.value = '';
|
||||
}
|
||||
}}>
|
||||
<input
|
||||
type="text"
|
||||
placeholder="Ask the agent..."
|
||||
className="w-full px-4 py-2 border rounded"
|
||||
disabled={state.isRunning}
|
||||
/>
|
||||
</form>
|
||||
</div>
|
||||
);
|
||||
}
|
||||
```
|
||||
|
||||
## Next
|
||||
|
||||
Learn about [OpenAPI integration](/docs/openapi) for rendering forms from API schemas.
|
||||
@@ -1,651 +0,0 @@
|
||||
import Link from "next/link";
|
||||
import { Code } from "@/components/code";
|
||||
|
||||
export const metadata = {
|
||||
title: "AG-UI Integration | json-render",
|
||||
};
|
||||
|
||||
export default function AGUIPage() {
|
||||
return (
|
||||
<article>
|
||||
<h1 className="text-3xl font-bold mb-4">AG-UI Integration</h1>
|
||||
<p className="text-muted-foreground mb-8">
|
||||
Use json-render to support{" "}
|
||||
<a
|
||||
href="https://docs.copilotkit.ai/ag-ui"
|
||||
target="_blank"
|
||||
rel="noopener noreferrer"
|
||||
className="text-foreground hover:underline"
|
||||
>
|
||||
AG-UI
|
||||
</a>{" "}
|
||||
(Agent User Interaction Protocol) from CopilotKit.
|
||||
</p>
|
||||
|
||||
<div className="rounded-lg border border-amber-500/50 bg-amber-500/10 p-4 mb-8">
|
||||
<p className="text-sm text-amber-700 dark:text-amber-300">
|
||||
<strong>Concept:</strong> This page demonstrates how json-render can
|
||||
support AG-UI. The examples are illustrative and may require
|
||||
adaptation for production use.
|
||||
</p>
|
||||
</div>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">What is AG-UI?</h2>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
AG-UI is an open protocol for connecting AI agents to user interfaces.
|
||||
It provides a standardized way for agents to render UI components,
|
||||
handle user input, and manage state. The protocol uses events streamed
|
||||
over HTTP to update the UI in real-time.
|
||||
</p>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">AG-UI Event Types</h2>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
AG-UI defines several event types for agent-UI communication:
|
||||
</p>
|
||||
<ul className="list-disc list-inside text-sm text-muted-foreground space-y-1 mb-4">
|
||||
<li>
|
||||
<code className="text-foreground">TEXT_MESSAGE_START</code> /{" "}
|
||||
<code className="text-foreground">TEXT_MESSAGE_CONTENT</code> /{" "}
|
||||
<code className="text-foreground">TEXT_MESSAGE_END</code> — Streaming
|
||||
text messages
|
||||
</li>
|
||||
<li>
|
||||
<code className="text-foreground">TOOL_CALL_START</code> /{" "}
|
||||
<code className="text-foreground">TOOL_CALL_ARGS</code> /{" "}
|
||||
<code className="text-foreground">TOOL_CALL_END</code> — Tool/function
|
||||
calls
|
||||
</li>
|
||||
<li>
|
||||
<code className="text-foreground">STATE_SNAPSHOT</code> /{" "}
|
||||
<code className="text-foreground">STATE_DELTA</code> — State updates
|
||||
</li>
|
||||
<li>
|
||||
<code className="text-foreground">CUSTOM</code> — Custom events for UI
|
||||
rendering
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3 className="text-lg font-medium mt-8 mb-3">
|
||||
Example AG-UI Event Stream
|
||||
</h3>
|
||||
<Code lang="json">{`{"type": "RUN_STARTED", "threadId": "thread-123", "runId": "run-456"}
|
||||
{"type": "TEXT_MESSAGE_START", "messageId": "msg-1", "role": "assistant"}
|
||||
{"type": "TEXT_MESSAGE_CONTENT", "messageId": "msg-1", "delta": "Here's a dashboard for you:"}
|
||||
{"type": "TEXT_MESSAGE_END", "messageId": "msg-1"}
|
||||
{"type": "TOOL_CALL_START", "toolCallId": "tc-1", "toolCallName": "render_ui"}
|
||||
{"type": "TOOL_CALL_ARGS", "toolCallId": "tc-1", "delta": "{\\"component\\": \\"Dashboard\\", \\"props\\": {\\"title\\": \\"Sales\\"}}"}
|
||||
{"type": "TOOL_CALL_END", "toolCallId": "tc-1"}
|
||||
{"type": "RUN_FINISHED"}`}</Code>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">
|
||||
Define the AG-UI Schema
|
||||
</h2>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
Define schemas for AG-UI event types:
|
||||
</p>
|
||||
<Code lang="typescript">{`import { z } from 'zod';
|
||||
|
||||
// Base event schema
|
||||
const BaseEvent = z.object({
|
||||
type: z.string(),
|
||||
timestamp: z.number().optional(),
|
||||
});
|
||||
|
||||
// Text message events
|
||||
const TextMessageStart = BaseEvent.extend({
|
||||
type: z.literal('TEXT_MESSAGE_START'),
|
||||
messageId: z.string(),
|
||||
role: z.enum(['user', 'assistant']),
|
||||
});
|
||||
|
||||
const TextMessageContent = BaseEvent.extend({
|
||||
type: z.literal('TEXT_MESSAGE_CONTENT'),
|
||||
messageId: z.string(),
|
||||
delta: z.string(),
|
||||
});
|
||||
|
||||
const TextMessageEnd = BaseEvent.extend({
|
||||
type: z.literal('TEXT_MESSAGE_END'),
|
||||
messageId: z.string(),
|
||||
});
|
||||
|
||||
// Tool call events
|
||||
const ToolCallStart = BaseEvent.extend({
|
||||
type: z.literal('TOOL_CALL_START'),
|
||||
toolCallId: z.string(),
|
||||
toolCallName: z.string(),
|
||||
parentMessageId: z.string().optional(),
|
||||
});
|
||||
|
||||
const ToolCallArgs = BaseEvent.extend({
|
||||
type: z.literal('TOOL_CALL_ARGS'),
|
||||
toolCallId: z.string(),
|
||||
delta: z.string(),
|
||||
});
|
||||
|
||||
const ToolCallEnd = BaseEvent.extend({
|
||||
type: z.literal('TOOL_CALL_END'),
|
||||
toolCallId: z.string(),
|
||||
});
|
||||
|
||||
// State events
|
||||
const StateSnapshot = BaseEvent.extend({
|
||||
type: z.literal('STATE_SNAPSHOT'),
|
||||
snapshot: z.record(z.unknown()),
|
||||
});
|
||||
|
||||
const StateDelta = BaseEvent.extend({
|
||||
type: z.literal('STATE_DELTA'),
|
||||
delta: z.array(z.object({
|
||||
op: z.enum(['add', 'remove', 'replace']),
|
||||
path: z.string(),
|
||||
value: z.unknown().optional(),
|
||||
})),
|
||||
});
|
||||
|
||||
// Custom event for UI components
|
||||
const CustomEvent = BaseEvent.extend({
|
||||
type: z.literal('CUSTOM'),
|
||||
name: z.string(),
|
||||
value: z.unknown(),
|
||||
});
|
||||
|
||||
// Run lifecycle events
|
||||
const RunStarted = BaseEvent.extend({
|
||||
type: z.literal('RUN_STARTED'),
|
||||
threadId: z.string(),
|
||||
runId: z.string(),
|
||||
});
|
||||
|
||||
const RunFinished = BaseEvent.extend({
|
||||
type: z.literal('RUN_FINISHED'),
|
||||
});
|
||||
|
||||
const RunError = BaseEvent.extend({
|
||||
type: z.literal('RUN_ERROR'),
|
||||
message: z.string(),
|
||||
code: z.string().optional(),
|
||||
});
|
||||
|
||||
// Union of all events
|
||||
export const AGUIEvent = z.discriminatedUnion('type', [
|
||||
TextMessageStart,
|
||||
TextMessageContent,
|
||||
TextMessageEnd,
|
||||
ToolCallStart,
|
||||
ToolCallArgs,
|
||||
ToolCallEnd,
|
||||
StateSnapshot,
|
||||
StateDelta,
|
||||
CustomEvent,
|
||||
RunStarted,
|
||||
RunFinished,
|
||||
RunError,
|
||||
]);
|
||||
|
||||
export type AGUIEvent = z.infer<typeof AGUIEvent>;`}</Code>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">
|
||||
Define the AG-UI Catalog
|
||||
</h2>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
Create a catalog for UI components that agents can render:
|
||||
</p>
|
||||
<Code lang="typescript">{`import { createCatalog } from '@json-render/core';
|
||||
import { z } from 'zod';
|
||||
|
||||
export const aguiCatalog = createCatalog({
|
||||
components: {
|
||||
// Layout components
|
||||
Container: {
|
||||
description: 'A container for grouping elements',
|
||||
props: z.object({
|
||||
direction: z.enum(['row', 'column']).optional(),
|
||||
gap: z.enum(['none', 'sm', 'md', 'lg']).optional(),
|
||||
padding: z.enum(['none', 'sm', 'md', 'lg']).optional(),
|
||||
}),
|
||||
},
|
||||
|
||||
Card: {
|
||||
description: 'A card with optional title',
|
||||
props: z.object({
|
||||
title: z.string().optional(),
|
||||
description: z.string().optional(),
|
||||
}),
|
||||
},
|
||||
|
||||
// Content components
|
||||
Text: {
|
||||
description: 'Text content',
|
||||
props: z.object({
|
||||
content: z.string(),
|
||||
variant: z.enum(['body', 'heading', 'caption', 'code']).optional(),
|
||||
}),
|
||||
},
|
||||
|
||||
Markdown: {
|
||||
description: 'Renders markdown content',
|
||||
props: z.object({
|
||||
content: z.string(),
|
||||
}),
|
||||
},
|
||||
|
||||
Image: {
|
||||
description: 'Displays an image',
|
||||
props: z.object({
|
||||
src: z.string(),
|
||||
alt: z.string().optional(),
|
||||
width: z.number().optional(),
|
||||
height: z.number().optional(),
|
||||
}),
|
||||
},
|
||||
|
||||
// Data display
|
||||
Table: {
|
||||
description: 'Displays tabular data',
|
||||
props: z.object({
|
||||
columns: z.array(z.object({
|
||||
key: z.string(),
|
||||
header: z.string(),
|
||||
width: z.string().optional(),
|
||||
})),
|
||||
data: z.array(z.record(z.unknown())),
|
||||
}),
|
||||
},
|
||||
|
||||
Chart: {
|
||||
description: 'Renders a chart',
|
||||
props: z.object({
|
||||
type: z.enum(['line', 'bar', 'pie', 'area']),
|
||||
data: z.array(z.record(z.unknown())),
|
||||
xKey: z.string(),
|
||||
yKey: z.string(),
|
||||
title: z.string().optional(),
|
||||
}),
|
||||
},
|
||||
|
||||
Metric: {
|
||||
description: 'Displays a metric value',
|
||||
props: z.object({
|
||||
label: z.string(),
|
||||
value: z.union([z.string(), z.number()]),
|
||||
change: z.number().optional(),
|
||||
format: z.enum(['number', 'currency', 'percent']).optional(),
|
||||
}),
|
||||
},
|
||||
|
||||
// Input components
|
||||
Button: {
|
||||
description: 'Interactive button',
|
||||
props: z.object({
|
||||
label: z.string(),
|
||||
variant: z.enum(['primary', 'secondary', 'outline', 'ghost']).optional(),
|
||||
disabled: z.boolean().optional(),
|
||||
}),
|
||||
},
|
||||
|
||||
Input: {
|
||||
description: 'Text input field',
|
||||
props: z.object({
|
||||
name: z.string(),
|
||||
label: z.string().optional(),
|
||||
placeholder: z.string().optional(),
|
||||
type: z.enum(['text', 'email', 'password', 'number']).optional(),
|
||||
required: z.boolean().optional(),
|
||||
}),
|
||||
},
|
||||
|
||||
Select: {
|
||||
description: 'Dropdown select',
|
||||
props: z.object({
|
||||
name: z.string(),
|
||||
label: z.string().optional(),
|
||||
options: z.array(z.object({
|
||||
value: z.string(),
|
||||
label: z.string(),
|
||||
})),
|
||||
placeholder: z.string().optional(),
|
||||
}),
|
||||
},
|
||||
|
||||
Form: {
|
||||
description: 'Form container',
|
||||
props: z.object({
|
||||
id: z.string(),
|
||||
submitLabel: z.string().optional(),
|
||||
}),
|
||||
},
|
||||
|
||||
// Feedback components
|
||||
Alert: {
|
||||
description: 'Alert message',
|
||||
props: z.object({
|
||||
message: z.string(),
|
||||
type: z.enum(['info', 'success', 'warning', 'error']).optional(),
|
||||
}),
|
||||
},
|
||||
|
||||
Progress: {
|
||||
description: 'Progress indicator',
|
||||
props: z.object({
|
||||
value: z.number(),
|
||||
max: z.number().optional(),
|
||||
label: z.string().optional(),
|
||||
}),
|
||||
},
|
||||
|
||||
Skeleton: {
|
||||
description: 'Loading placeholder',
|
||||
props: z.object({
|
||||
width: z.string().optional(),
|
||||
height: z.string().optional(),
|
||||
variant: z.enum(['text', 'circular', 'rectangular']).optional(),
|
||||
}),
|
||||
},
|
||||
},
|
||||
|
||||
actions: {
|
||||
submit: {
|
||||
description: 'Submit form data',
|
||||
params: z.object({
|
||||
formId: z.string(),
|
||||
}),
|
||||
},
|
||||
navigate: {
|
||||
description: 'Navigate to a URL',
|
||||
params: z.object({
|
||||
url: z.string(),
|
||||
}),
|
||||
},
|
||||
callback: {
|
||||
description: 'Trigger a callback to the agent',
|
||||
params: z.object({
|
||||
name: z.string(),
|
||||
data: z.record(z.unknown()).optional(),
|
||||
}),
|
||||
},
|
||||
},
|
||||
});`}</Code>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">
|
||||
Build an AG-UI Event Processor
|
||||
</h2>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
Process AG-UI events and render UI components:
|
||||
</p>
|
||||
<Code lang="tsx">{`'use client';
|
||||
|
||||
import React, { useState, useCallback } from 'react';
|
||||
import { AGUIEvent } from './schema';
|
||||
|
||||
interface AGUIState {
|
||||
messages: Array<{
|
||||
id: string;
|
||||
role: 'user' | 'assistant';
|
||||
content: string;
|
||||
}>;
|
||||
toolCalls: Map<string, {
|
||||
name: string;
|
||||
args: string;
|
||||
result?: unknown;
|
||||
}>;
|
||||
state: Record<string, unknown>;
|
||||
isRunning: boolean;
|
||||
}
|
||||
|
||||
export function useAGUI() {
|
||||
const [aguiState, setAGUIState] = useState<AGUIState>({
|
||||
messages: [],
|
||||
toolCalls: new Map(),
|
||||
state: {},
|
||||
isRunning: false,
|
||||
});
|
||||
|
||||
const processEvent = useCallback((event: AGUIEvent) => {
|
||||
switch (event.type) {
|
||||
case 'RUN_STARTED':
|
||||
setAGUIState(prev => ({ ...prev, isRunning: true }));
|
||||
break;
|
||||
|
||||
case 'RUN_FINISHED':
|
||||
setAGUIState(prev => ({ ...prev, isRunning: false }));
|
||||
break;
|
||||
|
||||
case 'TEXT_MESSAGE_START':
|
||||
setAGUIState(prev => ({
|
||||
...prev,
|
||||
messages: [...prev.messages, {
|
||||
id: event.messageId,
|
||||
role: event.role,
|
||||
content: '',
|
||||
}],
|
||||
}));
|
||||
break;
|
||||
|
||||
case 'TEXT_MESSAGE_CONTENT':
|
||||
setAGUIState(prev => ({
|
||||
...prev,
|
||||
messages: prev.messages.map(msg =>
|
||||
msg.id === event.messageId
|
||||
? { ...msg, content: msg.content + event.delta }
|
||||
: msg
|
||||
),
|
||||
}));
|
||||
break;
|
||||
|
||||
case 'TOOL_CALL_START':
|
||||
setAGUIState(prev => {
|
||||
const toolCalls = new Map(prev.toolCalls);
|
||||
toolCalls.set(event.toolCallId, { name: event.toolCallName, args: '' });
|
||||
return { ...prev, toolCalls };
|
||||
});
|
||||
break;
|
||||
|
||||
case 'TOOL_CALL_ARGS':
|
||||
setAGUIState(prev => {
|
||||
const toolCalls = new Map(prev.toolCalls);
|
||||
const tc = toolCalls.get(event.toolCallId);
|
||||
if (tc) {
|
||||
toolCalls.set(event.toolCallId, { ...tc, args: tc.args + event.delta });
|
||||
}
|
||||
return { ...prev, toolCalls };
|
||||
});
|
||||
break;
|
||||
|
||||
case 'STATE_SNAPSHOT':
|
||||
setAGUIState(prev => ({ ...prev, state: event.snapshot }));
|
||||
break;
|
||||
|
||||
case 'STATE_DELTA':
|
||||
setAGUIState(prev => {
|
||||
const newState = { ...prev.state };
|
||||
for (const op of event.delta) {
|
||||
const parts = op.path.split('/').filter(Boolean);
|
||||
if (op.op === 'replace' || op.op === 'add') {
|
||||
let obj: any = newState;
|
||||
for (let i = 0; i < parts.length - 1; i++) {
|
||||
obj = obj[parts[i]] = obj[parts[i]] || {};
|
||||
}
|
||||
obj[parts[parts.length - 1]] = op.value;
|
||||
} else if (op.op === 'remove') {
|
||||
let obj: any = newState;
|
||||
for (let i = 0; i < parts.length - 1; i++) {
|
||||
obj = obj[parts[i]];
|
||||
if (!obj) break;
|
||||
}
|
||||
if (obj) delete obj[parts[parts.length - 1]];
|
||||
}
|
||||
}
|
||||
return { ...prev, state: newState };
|
||||
});
|
||||
break;
|
||||
}
|
||||
}, []);
|
||||
|
||||
return { state: aguiState, processEvent };
|
||||
}`}</Code>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">
|
||||
Rendering Tool Call Results as UI
|
||||
</h2>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
When an agent calls a <code className="text-foreground">render_ui</code>{" "}
|
||||
tool, parse the arguments and render the component:
|
||||
</p>
|
||||
<Code lang="tsx">{`import { aguiCatalog } from './catalog';
|
||||
|
||||
// Component registry
|
||||
const components: Record<string, React.FC<any>> = {
|
||||
Container: ({ direction = 'column', gap = 'md', children }) => (
|
||||
<div className={\`flex flex-\${direction} gap-\${gap}\`}>{children}</div>
|
||||
),
|
||||
Card: ({ title, description, children }) => (
|
||||
<div className="border rounded-lg p-4">
|
||||
{title && <h3 className="font-semibold">{title}</h3>}
|
||||
{description && <p className="text-muted-foreground text-sm">{description}</p>}
|
||||
{children}
|
||||
</div>
|
||||
),
|
||||
Text: ({ content, variant = 'body' }) => {
|
||||
const styles = {
|
||||
body: 'text-sm',
|
||||
heading: 'text-lg font-semibold',
|
||||
caption: 'text-xs text-muted-foreground',
|
||||
code: 'font-mono text-sm bg-muted px-1 rounded',
|
||||
};
|
||||
return <p className={styles[variant]}>{content}</p>;
|
||||
},
|
||||
Button: ({ label, variant = 'primary', onClick }) => (
|
||||
<button
|
||||
className={\`px-4 py-2 rounded text-sm \${
|
||||
variant === 'primary' ? 'bg-primary text-primary-foreground' :
|
||||
variant === 'secondary' ? 'bg-secondary text-secondary-foreground' :
|
||||
'border'
|
||||
}\`}
|
||||
onClick={onClick}
|
||||
>
|
||||
{label}
|
||||
</button>
|
||||
),
|
||||
Metric: ({ label, value, change, format }) => {
|
||||
const formatted = format === 'currency' ? \`$\${value.toLocaleString()}\` :
|
||||
format === 'percent' ? \`\${value}%\` :
|
||||
value.toLocaleString();
|
||||
return (
|
||||
<div className="p-4 border rounded">
|
||||
<p className="text-sm text-muted-foreground">{label}</p>
|
||||
<p className="text-2xl font-bold">{formatted}</p>
|
||||
{change !== undefined && (
|
||||
<p className={\`text-sm \${change >= 0 ? 'text-green-600' : 'text-red-600'}\`}>
|
||||
{change >= 0 ? '+' : ''}{change}%
|
||||
</p>
|
||||
)}
|
||||
</div>
|
||||
);
|
||||
},
|
||||
Alert: ({ message, type = 'info' }) => {
|
||||
const styles = {
|
||||
info: 'bg-blue-50 text-blue-800 border-blue-200',
|
||||
success: 'bg-green-50 text-green-800 border-green-200',
|
||||
warning: 'bg-yellow-50 text-yellow-800 border-yellow-200',
|
||||
error: 'bg-red-50 text-red-800 border-red-200',
|
||||
};
|
||||
return <div className={\`p-3 rounded border \${styles[type]}\`}>{message}</div>;
|
||||
},
|
||||
// Add more components...
|
||||
};
|
||||
|
||||
// Render tool call result
|
||||
export function renderToolCallUI(toolCall: { name: string; args: string }) {
|
||||
if (toolCall.name !== 'render_ui') return null;
|
||||
|
||||
try {
|
||||
const parsed = JSON.parse(toolCall.args);
|
||||
const Component = components[parsed.component];
|
||||
if (!Component) return null;
|
||||
|
||||
return <Component {...parsed.props} />;
|
||||
} catch {
|
||||
return null;
|
||||
}
|
||||
}`}</Code>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">Usage Example</h2>
|
||||
<Code lang="tsx">{`'use client';
|
||||
|
||||
import { useAGUI } from './use-agui';
|
||||
import { renderToolCallUI } from './renderer';
|
||||
|
||||
export function AGUIChat() {
|
||||
const { state, processEvent } = useAGUI();
|
||||
|
||||
// Connect to AG-UI event stream
|
||||
async function startRun(prompt: string) {
|
||||
const response = await fetch('/api/agent', {
|
||||
method: 'POST',
|
||||
headers: { 'Content-Type': 'application/json' },
|
||||
body: JSON.stringify({ prompt }),
|
||||
});
|
||||
|
||||
const reader = response.body?.getReader();
|
||||
const decoder = new TextDecoder();
|
||||
|
||||
while (reader) {
|
||||
const { done, value } = await reader.read();
|
||||
if (done) break;
|
||||
|
||||
const lines = decoder.decode(value).split('\\n').filter(Boolean);
|
||||
for (const line of lines) {
|
||||
const event = JSON.parse(line);
|
||||
processEvent(event);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return (
|
||||
<div className="space-y-4">
|
||||
{/* Messages */}
|
||||
{state.messages.map(msg => (
|
||||
<div key={msg.id} className={\`p-3 rounded \${
|
||||
msg.role === 'assistant' ? 'bg-muted' : 'bg-primary/10'
|
||||
}\`}>
|
||||
{msg.content}
|
||||
</div>
|
||||
))}
|
||||
|
||||
{/* Rendered UI from tool calls */}
|
||||
{Array.from(state.toolCalls.values()).map((tc, i) => (
|
||||
<div key={i}>{renderToolCallUI(tc)}</div>
|
||||
))}
|
||||
|
||||
{/* Input */}
|
||||
<form onSubmit={(e) => {
|
||||
e.preventDefault();
|
||||
const input = e.currentTarget.querySelector('input');
|
||||
if (input?.value) {
|
||||
startRun(input.value);
|
||||
input.value = '';
|
||||
}
|
||||
}}>
|
||||
<input
|
||||
type="text"
|
||||
placeholder="Ask the agent..."
|
||||
className="w-full px-4 py-2 border rounded"
|
||||
disabled={state.isRunning}
|
||||
/>
|
||||
</form>
|
||||
</div>
|
||||
);
|
||||
}`}</Code>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">Next</h2>
|
||||
<p className="text-sm text-muted-foreground">
|
||||
Learn about{" "}
|
||||
<Link href="/docs/openapi" className="text-foreground hover:underline">
|
||||
OpenAPI integration
|
||||
</Link>{" "}
|
||||
for rendering forms from API schemas.
|
||||
</p>
|
||||
</article>
|
||||
);
|
||||
}
|
||||
@@ -0,0 +1,239 @@
|
||||
import { pageMetadata } from "@/lib/page-metadata"
|
||||
export const metadata = pageMetadata("docs/ai-sdk")
|
||||
|
||||
# AI SDK Integration
|
||||
|
||||
Use json-render with the [Vercel AI SDK](https://sdk.vercel.ai) for seamless streaming. json-render supports two modes: **Generate** (standalone UI) and **Chat** (UI embedded in conversation). See [Generation Modes](/docs/generation-modes) for a detailed comparison.
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
npm install ai @ai-sdk/react
|
||||
```
|
||||
|
||||
## Generate Mode
|
||||
|
||||
In generate mode, the AI outputs only JSONL patches. The entire response is a UI spec with no prose. This is the default mode and is ideal for playgrounds, builders, and dashboard generators.
|
||||
|
||||
### API Route
|
||||
|
||||
```typescript
|
||||
// app/api/generate/route.ts
|
||||
import { streamText } from "ai";
|
||||
import { catalog } from "@/lib/catalog";
|
||||
|
||||
export async function POST(req: Request) {
|
||||
const { prompt, currentTree } = await req.json();
|
||||
|
||||
const systemPrompt = catalog.prompt();
|
||||
|
||||
// Optionally include current UI state for context
|
||||
const contextPrompt = currentTree
|
||||
? `\n\nCurrent UI state:\n${JSON.stringify(currentTree, null, 2)}`
|
||||
: "";
|
||||
|
||||
const result = streamText({
|
||||
model: yourModel,
|
||||
system: systemPrompt + contextPrompt,
|
||||
prompt,
|
||||
});
|
||||
|
||||
return result.toTextStreamResponse();
|
||||
}
|
||||
```
|
||||
|
||||
### Client
|
||||
|
||||
Use `useUIStream` on the client to compile the JSONL stream into a spec:
|
||||
|
||||
```tsx
|
||||
"use client";
|
||||
|
||||
import { useUIStream, Renderer } from "@json-render/react";
|
||||
|
||||
function GenerativeUI() {
|
||||
const { spec, isStreaming, error, send } = useUIStream({
|
||||
api: "/api/generate",
|
||||
});
|
||||
|
||||
return (
|
||||
<div>
|
||||
<button
|
||||
onClick={() => send("Create a dashboard with metrics")}
|
||||
disabled={isStreaming}
|
||||
>
|
||||
{isStreaming ? "Generating..." : "Generate"}
|
||||
</button>
|
||||
|
||||
{error && <p className="text-red-500">{error.message}</p>}
|
||||
|
||||
<Renderer spec={spec} registry={registry} loading={isStreaming} />
|
||||
</div>
|
||||
);
|
||||
}
|
||||
```
|
||||
|
||||
## Chat Mode
|
||||
|
||||
In chat mode, the AI responds conversationally and includes JSONL patches inline. Text-only replies are allowed when no UI is needed. This is ideal for chatbots, copilots, and educational assistants.
|
||||
|
||||
### API Route
|
||||
|
||||
Use `pipeJsonRender` to separate text from JSONL patches in the stream. Patches are emitted as data parts that the client can pick up.
|
||||
|
||||
```typescript
|
||||
// app/api/chat/route.ts
|
||||
import { streamText } from "ai";
|
||||
import { pipeJsonRender } from "@json-render/core";
|
||||
import {
|
||||
createUIMessageStream,
|
||||
createUIMessageStreamResponse,
|
||||
} from "ai";
|
||||
import { catalog } from "@/lib/catalog";
|
||||
|
||||
export async function POST(req: Request) {
|
||||
const { messages } = await req.json();
|
||||
|
||||
const result = streamText({
|
||||
model: yourModel,
|
||||
system: catalog.prompt({ mode: "chat" }),
|
||||
messages,
|
||||
});
|
||||
|
||||
const stream = createUIMessageStream({
|
||||
execute: async ({ writer }) => {
|
||||
writer.merge(pipeJsonRender(result.toUIMessageStream()));
|
||||
},
|
||||
});
|
||||
|
||||
return createUIMessageStreamResponse({ stream });
|
||||
}
|
||||
```
|
||||
|
||||
### Client
|
||||
|
||||
Use `useChat` from the AI SDK and `useJsonRenderMessage` from json-render to extract the spec from each message:
|
||||
|
||||
```tsx
|
||||
"use client";
|
||||
|
||||
import { useChat } from "@ai-sdk/react";
|
||||
import { useJsonRenderMessage, Renderer } from "@json-render/react";
|
||||
|
||||
function Chat() {
|
||||
const { messages, input, handleInputChange, handleSubmit } = useChat({
|
||||
api: "/api/chat",
|
||||
});
|
||||
|
||||
return (
|
||||
<div>
|
||||
<div>
|
||||
{messages.map((msg) => (
|
||||
<ChatMessage key={msg.id} message={msg} />
|
||||
))}
|
||||
</div>
|
||||
|
||||
<form onSubmit={handleSubmit}>
|
||||
<input
|
||||
value={input}
|
||||
onChange={handleInputChange}
|
||||
placeholder="Ask something..."
|
||||
/>
|
||||
<button type="submit">Send</button>
|
||||
</form>
|
||||
</div>
|
||||
);
|
||||
}
|
||||
|
||||
function ChatMessage({ message }: { message: { parts: Array<{ type: string; text?: string; data?: unknown }> } }) {
|
||||
const { spec, text, hasSpec } = useJsonRenderMessage(message.parts);
|
||||
|
||||
return (
|
||||
<div>
|
||||
{text && <p>{text}</p>}
|
||||
{hasSpec && spec && (
|
||||
<Renderer spec={spec} registry={registry} />
|
||||
)}
|
||||
</div>
|
||||
);
|
||||
}
|
||||
```
|
||||
|
||||
## Prompt Engineering
|
||||
|
||||
The `catalog.prompt()` method creates an optimized system prompt that:
|
||||
|
||||
- Lists all available components and their props
|
||||
- Describes available actions
|
||||
- Specifies the expected output format (JSONL-only or text + JSONL depending on mode)
|
||||
- Includes examples for better generation
|
||||
|
||||
### Custom Rules
|
||||
|
||||
Pass custom rules to tailor AI behavior:
|
||||
|
||||
```typescript
|
||||
const systemPrompt = catalog.prompt({
|
||||
customRules: [
|
||||
"Always use Card components for grouping related content",
|
||||
"Prefer horizontal layouts (Row) for metrics",
|
||||
"Use consistent spacing with padding=\"md\"",
|
||||
],
|
||||
});
|
||||
```
|
||||
|
||||
### Chat Mode Prompt
|
||||
|
||||
```typescript
|
||||
const chatPrompt = catalog.prompt({ mode: "chat" });
|
||||
```
|
||||
|
||||
In chat mode, the prompt instructs the AI to respond conversationally first, then include JSONL patches on their own lines when UI is needed. Text-only replies are allowed.
|
||||
|
||||
## Which Mode?
|
||||
|
||||
<div className="my-6 overflow-x-auto">
|
||||
<table className="mdx-table w-full text-sm border-collapse">
|
||||
<thead>
|
||||
<tr>
|
||||
<th></th>
|
||||
<th>Generate</th>
|
||||
<th>Chat</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>Output</td>
|
||||
<td>JSONL only</td>
|
||||
<td>Text + JSONL</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Text-only replies</td>
|
||||
<td>No</td>
|
||||
<td>Yes</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>System prompt</td>
|
||||
<td><code>catalog.prompt()</code></td>
|
||||
<td><code>{"catalog.prompt({ mode: \"chat\" })"}</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Stream utility</td>
|
||||
<td><code>useUIStream</code></td>
|
||||
<td><code>pipeJsonRender</code> + <code>useJsonRenderMessage</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Use case</td>
|
||||
<td>Playgrounds, builders</td>
|
||||
<td>Chatbots, copilots</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
Learn more in the [Generation Modes](/docs/generation-modes) guide.
|
||||
|
||||
## Next
|
||||
|
||||
- Learn about [progressive streaming](/docs/streaming)
|
||||
- See the [chat example](https://github.com/vercel-labs/json-render/tree/main/examples/chat) for a complete implementation
|
||||
@@ -1,112 +0,0 @@
|
||||
import Link from "next/link";
|
||||
import { Code } from "@/components/code";
|
||||
|
||||
export const metadata = {
|
||||
title: "AI SDK Integration | json-render",
|
||||
};
|
||||
|
||||
export default function AiSdkPage() {
|
||||
return (
|
||||
<article>
|
||||
<h1 className="text-3xl font-bold mb-4">AI SDK Integration</h1>
|
||||
<p className="text-muted-foreground mb-8">
|
||||
Use json-render with the Vercel AI SDK for seamless streaming.
|
||||
</p>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">Installation</h2>
|
||||
<Code lang="bash">npm install ai</Code>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">API Route Setup</h2>
|
||||
<Code lang="typescript">{`// app/api/generate/route.ts
|
||||
import { streamText } from 'ai';
|
||||
import { catalog } from '@/lib/catalog';
|
||||
|
||||
export async function POST(req: Request) {
|
||||
const { prompt, currentTree } = await req.json();
|
||||
|
||||
// Generate system prompt from catalog
|
||||
const systemPrompt = catalog.prompt();
|
||||
|
||||
// Optionally include current UI state for context
|
||||
const contextPrompt = currentTree
|
||||
? \`\\n\\nCurrent UI state:\\n\${JSON.stringify(currentTree, null, 2)}\`
|
||||
: '';
|
||||
|
||||
const result = streamText({
|
||||
model: 'anthropic/claude-haiku-4.5',
|
||||
system: systemPrompt + contextPrompt,
|
||||
prompt,
|
||||
});
|
||||
|
||||
return result.toTextStreamResponse();
|
||||
}`}</Code>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">Client-Side Hook</h2>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
Use <code className="text-foreground">useUIStream</code> on the client:
|
||||
</p>
|
||||
<Code lang="tsx">{`'use client';
|
||||
|
||||
import { useUIStream, Renderer } from '@json-render/react';
|
||||
|
||||
function GenerativeUI() {
|
||||
const { spec, isStreaming, error, send } = useUIStream({
|
||||
api: '/api/generate',
|
||||
});
|
||||
|
||||
return (
|
||||
<div>
|
||||
<button
|
||||
onClick={() => send('Create a dashboard with metrics')}
|
||||
disabled={isStreaming}
|
||||
>
|
||||
{isStreaming ? 'Generating...' : 'Generate'}
|
||||
</button>
|
||||
|
||||
{error && <p className="text-red-500">{error.message}</p>}
|
||||
|
||||
<Renderer spec={spec} registry={registry} loading={isStreaming} />
|
||||
</div>
|
||||
);
|
||||
}`}</Code>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">Prompt Engineering</h2>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
The <code className="text-foreground">catalog.prompt()</code> method
|
||||
creates an optimized system prompt that:
|
||||
</p>
|
||||
<ul className="list-disc list-inside text-sm text-muted-foreground space-y-1 mb-4">
|
||||
<li>Lists all available components and their props</li>
|
||||
<li>Describes available actions</li>
|
||||
<li>Specifies the expected JSON output format</li>
|
||||
<li>Includes examples for better generation</li>
|
||||
</ul>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">
|
||||
Custom System Prompts
|
||||
</h2>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
Pass custom rules to tailor AI behavior:
|
||||
</p>
|
||||
<Code lang="typescript">{`const systemPrompt = catalog.prompt({
|
||||
customRules: [
|
||||
'Always use Card components for grouping related content',
|
||||
'Prefer horizontal layouts (Row) for metrics',
|
||||
'Use consistent spacing with padding="md"',
|
||||
],
|
||||
});`}</Code>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">Next</h2>
|
||||
<p className="text-sm text-muted-foreground">
|
||||
Learn about{" "}
|
||||
<Link
|
||||
href="/docs/streaming"
|
||||
className="text-foreground hover:underline"
|
||||
>
|
||||
progressive streaming
|
||||
</Link>
|
||||
.
|
||||
</p>
|
||||
</article>
|
||||
);
|
||||
}
|
||||
@@ -0,0 +1,142 @@
|
||||
import { pageMetadata } from "@/lib/page-metadata"
|
||||
export const metadata = pageMetadata("docs/api/codegen")
|
||||
|
||||
# @json-render/codegen
|
||||
|
||||
Utilities for generating code from UI trees.
|
||||
|
||||
## Tree Traversal
|
||||
|
||||
### traverseSpec
|
||||
|
||||
Walk the UI spec depth-first.
|
||||
|
||||
```typescript
|
||||
function traverseSpec(
|
||||
spec: Spec,
|
||||
visitor: TreeVisitor,
|
||||
startKey?: string
|
||||
): void
|
||||
|
||||
interface TreeVisitor {
|
||||
(element: UIElement, key: string, depth: number, parent: UIElement | null): void;
|
||||
}
|
||||
```
|
||||
|
||||
### collectUsedComponents
|
||||
|
||||
Get all unique component types used in a spec.
|
||||
|
||||
```typescript
|
||||
function collectUsedComponents(spec: Spec): Set<string>
|
||||
|
||||
// Example
|
||||
const components = collectUsedComponents(spec);
|
||||
// Set { 'Card', 'Metric', 'Chart' }
|
||||
```
|
||||
|
||||
### collectStatePaths
|
||||
|
||||
Get all state paths referenced in props (statePath, bindPath, etc.).
|
||||
|
||||
```typescript
|
||||
function collectStatePaths(spec: Spec): Set<string>
|
||||
|
||||
// Example
|
||||
const paths = collectStatePaths(spec);
|
||||
// Set { 'analytics/revenue', 'analytics/customers' }
|
||||
```
|
||||
|
||||
### collectActions
|
||||
|
||||
Get all action names used in the spec.
|
||||
|
||||
```typescript
|
||||
function collectActions(spec: Spec): Set<string>
|
||||
|
||||
// Example
|
||||
const actions = collectActions(spec);
|
||||
// Set { 'submit_form', 'refresh_data' }
|
||||
```
|
||||
|
||||
## Serialization
|
||||
|
||||
### serializePropValue
|
||||
|
||||
Serialize a single value to a code string.
|
||||
|
||||
```typescript
|
||||
function serializePropValue(
|
||||
value: unknown,
|
||||
options?: SerializeOptions
|
||||
): { value: string; needsBraces: boolean }
|
||||
|
||||
// Examples
|
||||
serializePropValue("hello")
|
||||
// { value: '"hello"', needsBraces: false }
|
||||
|
||||
serializePropValue(42)
|
||||
// { value: '42', needsBraces: true }
|
||||
|
||||
serializePropValue({ $state: '/user/name' })
|
||||
// { value: '{ $state: "/user/name" }', needsBraces: true }
|
||||
```
|
||||
|
||||
### serializeProps
|
||||
|
||||
Serialize a props object to a JSX attributes string.
|
||||
|
||||
```typescript
|
||||
function serializeProps(
|
||||
props: Record<string, unknown>,
|
||||
options?: SerializeOptions
|
||||
): string
|
||||
|
||||
// Example
|
||||
serializeProps({ title: 'Dashboard', columns: 3, disabled: true })
|
||||
// 'title="Dashboard" columns={3} disabled'
|
||||
```
|
||||
|
||||
### escapeString
|
||||
|
||||
Escape a string for use in code.
|
||||
|
||||
```typescript
|
||||
function escapeString(
|
||||
str: string,
|
||||
quotes?: 'single' | 'double'
|
||||
): string
|
||||
```
|
||||
|
||||
## Types
|
||||
|
||||
### GeneratedFile
|
||||
|
||||
```typescript
|
||||
interface GeneratedFile {
|
||||
/** File path relative to project root */
|
||||
path: string;
|
||||
/** File contents */
|
||||
content: string;
|
||||
}
|
||||
```
|
||||
|
||||
### CodeGenerator
|
||||
|
||||
```typescript
|
||||
interface CodeGenerator {
|
||||
/** Generate files from a UI spec */
|
||||
generate(spec: Spec): GeneratedFile[];
|
||||
}
|
||||
```
|
||||
|
||||
### SerializeOptions
|
||||
|
||||
```typescript
|
||||
interface SerializeOptions {
|
||||
/** Quote style for strings */
|
||||
quotes?: 'single' | 'double';
|
||||
/** Indent for objects/arrays */
|
||||
indent?: number;
|
||||
}
|
||||
```
|
||||
@@ -1,130 +0,0 @@
|
||||
import { Code } from "@/components/code";
|
||||
|
||||
export const metadata = {
|
||||
title: "@json-render/codegen API | json-render",
|
||||
};
|
||||
|
||||
export default function CodegenApiPage() {
|
||||
return (
|
||||
<article>
|
||||
<h1 className="text-3xl font-bold mb-4">@json-render/codegen</h1>
|
||||
<p className="text-muted-foreground mb-8">
|
||||
Utilities for generating code from UI trees.
|
||||
</p>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">Tree Traversal</h2>
|
||||
|
||||
<h3 className="text-lg font-semibold mt-8 mb-4">traverseSpec</h3>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
Walk the UI spec depth-first.
|
||||
</p>
|
||||
<Code lang="typescript">{`function traverseSpec(
|
||||
spec: Spec,
|
||||
visitor: SpecVisitor,
|
||||
startKey?: string
|
||||
): void
|
||||
|
||||
interface SpecVisitor {
|
||||
(element: UIElement, depth: number, parent: UIElement | null): void;
|
||||
}`}</Code>
|
||||
|
||||
<h3 className="text-lg font-semibold mt-8 mb-4">collectUsedComponents</h3>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
Get all unique component types used in a spec.
|
||||
</p>
|
||||
<Code lang="typescript">{`function collectUsedComponents(spec: Spec): Set<string>
|
||||
|
||||
// Example
|
||||
const components = collectUsedComponents(spec);
|
||||
// Set { 'Card', 'Metric', 'Chart' }`}</Code>
|
||||
|
||||
<h3 className="text-lg font-semibold mt-8 mb-4">collectDataPaths</h3>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
Get all data paths referenced in props (valuePath, dataPath, bindPath,
|
||||
etc.).
|
||||
</p>
|
||||
<Code lang="typescript">{`function collectDataPaths(spec: Spec): Set<string>
|
||||
|
||||
// Example
|
||||
const paths = collectDataPaths(spec);
|
||||
// Set { 'analytics/revenue', 'analytics/customers' }`}</Code>
|
||||
|
||||
<h3 className="text-lg font-semibold mt-8 mb-4">collectActions</h3>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
Get all action names used in the spec.
|
||||
</p>
|
||||
<Code lang="typescript">{`function collectActions(spec: Spec): Set<string>
|
||||
|
||||
// Example
|
||||
const actions = collectActions(spec);
|
||||
// Set { 'submit_form', 'refresh_data' }`}</Code>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">Serialization</h2>
|
||||
|
||||
<h3 className="text-lg font-semibold mt-8 mb-4">serializePropValue</h3>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
Serialize a single value to a code string.
|
||||
</p>
|
||||
<Code lang="typescript">{`function serializePropValue(
|
||||
value: unknown,
|
||||
options?: SerializeOptions
|
||||
): { value: string; needsBraces: boolean }
|
||||
|
||||
// Examples
|
||||
serializePropValue("hello")
|
||||
// { value: '"hello"', needsBraces: false }
|
||||
|
||||
serializePropValue(42)
|
||||
// { value: '42', needsBraces: true }
|
||||
|
||||
serializePropValue({ path: 'user/name' })
|
||||
// { value: '{ path: "user/name" }', needsBraces: true }`}</Code>
|
||||
|
||||
<h3 className="text-lg font-semibold mt-8 mb-4">serializeProps</h3>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
Serialize a props object to a JSX attributes string.
|
||||
</p>
|
||||
<Code lang="typescript">{`function serializeProps(
|
||||
props: Record<string, unknown>,
|
||||
options?: SerializeOptions
|
||||
): string
|
||||
|
||||
// Example
|
||||
serializeProps({ title: 'Dashboard', columns: 3, disabled: true })
|
||||
// 'title="Dashboard" columns={3} disabled'`}</Code>
|
||||
|
||||
<h3 className="text-lg font-semibold mt-8 mb-4">escapeString</h3>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
Escape a string for use in code.
|
||||
</p>
|
||||
<Code lang="typescript">{`function escapeString(
|
||||
str: string,
|
||||
quotes?: 'single' | 'double'
|
||||
): string`}</Code>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">Types</h2>
|
||||
|
||||
<h3 className="text-lg font-semibold mt-8 mb-4">GeneratedFile</h3>
|
||||
<Code lang="typescript">{`interface GeneratedFile {
|
||||
/** File path relative to project root */
|
||||
path: string;
|
||||
/** File contents */
|
||||
content: string;
|
||||
}`}</Code>
|
||||
|
||||
<h3 className="text-lg font-semibold mt-8 mb-4">CodeGenerator</h3>
|
||||
<Code lang="typescript">{`interface CodeGenerator {
|
||||
/** Generate files from a UI spec */
|
||||
generate(spec: Spec): GeneratedFile[];
|
||||
}`}</Code>
|
||||
|
||||
<h3 className="text-lg font-semibold mt-8 mb-4">SerializeOptions</h3>
|
||||
<Code lang="typescript">{`interface SerializeOptions {
|
||||
/** Quote style for strings */
|
||||
quotes?: 'single' | 'double';
|
||||
/** Indent for objects/arrays */
|
||||
indent?: number;
|
||||
}`}</Code>
|
||||
</article>
|
||||
);
|
||||
}
|
||||
@@ -0,0 +1,611 @@
|
||||
import { pageMetadata } from "@/lib/page-metadata"
|
||||
export const metadata = pageMetadata("docs/api/core")
|
||||
|
||||
# @json-render/core
|
||||
|
||||
Core types, schemas, and utilities.
|
||||
|
||||
## defineCatalog
|
||||
|
||||
Creates a type-safe catalog definition with schema validation.
|
||||
|
||||
```typescript
|
||||
import { defineCatalog } from '@json-render/core';
|
||||
import { schema } from '@json-render/react/schema';
|
||||
|
||||
function defineCatalog<T extends ZodType>(
|
||||
s: T,
|
||||
config: CatalogConfig
|
||||
): Catalog
|
||||
|
||||
// Use the React schema for standard UI specs
|
||||
const catalog = defineCatalog(schema, {
|
||||
components: {...},
|
||||
actions: {...},
|
||||
});
|
||||
```
|
||||
|
||||
### CatalogConfig
|
||||
|
||||
```typescript
|
||||
interface CatalogConfig {
|
||||
components: Record<string, ComponentDefinition>;
|
||||
actions?: Record<string, ActionDefinition>;
|
||||
functions?: Record<string, FunctionDefinition>;
|
||||
}
|
||||
|
||||
interface ComponentDefinition {
|
||||
props: ZodObject; // Use .nullable() for optional props
|
||||
slots?: string[]; // Named slots (e.g., ["default"])
|
||||
description?: string; // Help AI understand usage
|
||||
}
|
||||
|
||||
interface ActionDefinition {
|
||||
params?: ZodObject;
|
||||
description?: string;
|
||||
}
|
||||
|
||||
interface FunctionDefinition {
|
||||
description?: string;
|
||||
}
|
||||
```
|
||||
|
||||
### Catalog Instance
|
||||
|
||||
The returned catalog provides methods for AI prompt generation, validation, and schema export:
|
||||
|
||||
```typescript
|
||||
interface Catalog {
|
||||
// Data
|
||||
readonly data: CatalogConfig; // The catalog configuration
|
||||
readonly componentNames: string[]; // List of component names
|
||||
readonly actionNames: string[]; // List of action names
|
||||
|
||||
// AI Prompt Generation
|
||||
prompt(options?: PromptOptions): string;
|
||||
|
||||
// Validation
|
||||
validate(spec: unknown): SpecValidationResult;
|
||||
zodSchema(): z.ZodType; // Get the Zod schema for specs
|
||||
|
||||
// Export
|
||||
jsonSchema(): object; // Export as JSON Schema
|
||||
}
|
||||
|
||||
interface PromptOptions {
|
||||
system?: string; // Custom system message intro
|
||||
customRules?: string[]; // Additional rules to append
|
||||
mode?: "generate" | "chat"; // Output mode (default: "generate")
|
||||
}
|
||||
|
||||
interface SpecValidationResult<T> {
|
||||
success: boolean;
|
||||
data?: T; // Validated spec (if success)
|
||||
error?: z.ZodError; // Validation errors (if failed)
|
||||
}
|
||||
```
|
||||
|
||||
### Catalog Methods
|
||||
|
||||
```typescript
|
||||
// Generate AI system prompt
|
||||
const systemPrompt = catalog.prompt({
|
||||
customRules: ["Always use Card as root element"],
|
||||
});
|
||||
|
||||
// Validate a spec from AI
|
||||
const result = catalog.validate(aiOutput);
|
||||
if (result.success) {
|
||||
render(result.data);
|
||||
} else {
|
||||
console.error(result.error);
|
||||
}
|
||||
|
||||
// Get Zod schema for custom validation
|
||||
const schema = catalog.zodSchema();
|
||||
const parsed = schema.safeParse(aiOutput);
|
||||
|
||||
// Export as JSON Schema (for structured outputs)
|
||||
const jsonSchema = catalog.jsonSchema();
|
||||
```
|
||||
|
||||
## Schema System
|
||||
|
||||
json-render uses a flexible schema system that defines both the AI output format (spec) and what catalogs must provide. Each renderer package provides its own schema (e.g., @json-render/react exports `schema`).
|
||||
|
||||
### schema
|
||||
|
||||
The schema for flat UI element trees. This is exported from @json-render/react.
|
||||
|
||||
```typescript
|
||||
import { defineCatalog } from '@json-render/core';
|
||||
import { schema } from '@json-render/react/schema';
|
||||
|
||||
// schema defines:
|
||||
// - Spec shape: { root: string, elements: Record<string, UIElement> }
|
||||
// - Catalog shape: { components: {...}, actions: {...} }
|
||||
|
||||
const catalog = defineCatalog(schema, {
|
||||
components: {
|
||||
Card: {
|
||||
props: z.object({ title: z.string() }),
|
||||
slots: ["default"],
|
||||
description: "Container card",
|
||||
},
|
||||
},
|
||||
actions: {
|
||||
submit: {
|
||||
params: z.object({ formId: z.string() }),
|
||||
description: "Submit a form",
|
||||
},
|
||||
},
|
||||
});
|
||||
```
|
||||
|
||||
### SchemaOptions
|
||||
|
||||
When creating schemas with `defineSchema`, you can pass options:
|
||||
|
||||
```typescript
|
||||
interface SchemaOptions {
|
||||
promptTemplate?: PromptTemplate; // Custom AI prompt generator
|
||||
defaultRules?: string[]; // Default rules injected before custom rules in prompts
|
||||
builtInActions?: BuiltInAction[]; // Actions always available at runtime, auto-injected into prompts
|
||||
}
|
||||
|
||||
interface BuiltInAction {
|
||||
name: string; // Action name (e.g. "setState")
|
||||
description: string; // Human-readable description for the LLM
|
||||
}
|
||||
```
|
||||
|
||||
Built-in actions are injected into prompts as `[built-in]` and are handled by the runtime (e.g. `ActionProvider`) without requiring handlers in `defineRegistry`. The React schema declares `setState`, `pushState`, and `removeState` as built-in.
|
||||
|
||||
### defineSchema
|
||||
|
||||
Create custom schemas for different output formats (e.g., page-based, block-based).
|
||||
|
||||
```typescript
|
||||
import { defineSchema } from '@json-render/core';
|
||||
|
||||
const mySchema = defineSchema((s) => ({
|
||||
// What the AI outputs (spec)
|
||||
spec: s.object({
|
||||
title: s.string(),
|
||||
blocks: s.array(s.object({
|
||||
type: s.ref("catalog.blocks"),
|
||||
content: s.any(),
|
||||
})),
|
||||
}),
|
||||
|
||||
// What the catalog must provide
|
||||
catalog: s.object({
|
||||
blocks: s.map({
|
||||
props: s.zod(),
|
||||
description: s.string(),
|
||||
}),
|
||||
}),
|
||||
}));
|
||||
```
|
||||
|
||||
### Schema Builder API
|
||||
|
||||
The schema builder provides these methods:
|
||||
|
||||
```typescript
|
||||
// Primitive types
|
||||
s.string() // String value
|
||||
s.number() // Number value
|
||||
s.boolean() // Boolean value
|
||||
s.any() // Any value
|
||||
|
||||
// Compound types
|
||||
s.array(item) // Array of items
|
||||
s.object({ ... }) // Object with shape
|
||||
s.record(value) // Record/map with value type
|
||||
|
||||
// Catalog references (for type safety)
|
||||
s.ref("catalog.components") // Reference to catalog key (becomes enum)
|
||||
s.propsOf("catalog.components") // Props schema from catalog entry
|
||||
|
||||
// Catalog definitions
|
||||
s.map({ props: s.zod(), ... }) // Map of named entries with shared shape
|
||||
s.zod() // Placeholder for user-provided Zod schema
|
||||
|
||||
// Modifiers
|
||||
s.optional() // Mark field as optional
|
||||
```
|
||||
|
||||
## Zod Schemas
|
||||
|
||||
Pre-built Zod schemas for common json-render types:
|
||||
|
||||
### Dynamic Value Schemas
|
||||
|
||||
```typescript
|
||||
import {
|
||||
DynamicValueSchema, // string | number | boolean | null | { $state: string }
|
||||
DynamicStringSchema, // string | { $state: string }
|
||||
DynamicNumberSchema, // number | { $state: string }
|
||||
DynamicBooleanSchema, // boolean | { $state: string }
|
||||
} from '@json-render/core';
|
||||
|
||||
// Dynamic values can be literals or state path references
|
||||
type DynamicValue<T> = T | { $state: string };
|
||||
|
||||
// Example: a prop that can be a literal or bound to state
|
||||
const schema = z.object({
|
||||
label: DynamicStringSchema, // "Hello" or { $state: "/user/name" }
|
||||
});
|
||||
```
|
||||
|
||||
### Visibility Schemas
|
||||
|
||||
```typescript
|
||||
import { VisibilityConditionSchema } from '@json-render/core';
|
||||
|
||||
// Use in component props that need conditional rendering
|
||||
const schema = z.object({
|
||||
visible: VisibilityConditionSchema.optional(),
|
||||
});
|
||||
```
|
||||
|
||||
### Action Schemas
|
||||
|
||||
```typescript
|
||||
import {
|
||||
ActionSchema, // Full action definition
|
||||
ActionConfirmSchema, // Confirmation dialog config
|
||||
ActionOnSuccessSchema, // Success handler config
|
||||
ActionOnErrorSchema, // Error handler config
|
||||
} from '@json-render/core';
|
||||
```
|
||||
|
||||
### Validation Schemas
|
||||
|
||||
```typescript
|
||||
import {
|
||||
ValidationCheckSchema, // Single validation check
|
||||
ValidationConfigSchema, // Full validation config with checks array
|
||||
} from '@json-render/core';
|
||||
```
|
||||
|
||||
## SpecStream
|
||||
|
||||
SpecStream is json-render's streaming format for progressively building specs from JSONL patches.
|
||||
|
||||
### createSpecStreamCompiler
|
||||
|
||||
Create a streaming compiler that incrementally builds a spec:
|
||||
|
||||
```typescript
|
||||
import { createSpecStreamCompiler } from '@json-render/core';
|
||||
|
||||
const compiler = createSpecStreamCompiler<MySpec>();
|
||||
|
||||
// Process streaming chunks
|
||||
const { result, newPatches } = compiler.push(chunk);
|
||||
|
||||
// Get final result
|
||||
const spec = compiler.getResult();
|
||||
|
||||
// Reset for reuse
|
||||
compiler.reset();
|
||||
```
|
||||
|
||||
### compileSpecStream
|
||||
|
||||
Compile an entire SpecStream string at once:
|
||||
|
||||
```typescript
|
||||
import { compileSpecStream } from '@json-render/core';
|
||||
|
||||
const jsonl = `{"op":"add","path":"/root","value":{}}
|
||||
{"op":"add","path":"/root/type","value":"Card"}`;
|
||||
|
||||
const spec = compileSpecStream<MySpec>(jsonl);
|
||||
```
|
||||
|
||||
### Low-Level Utilities
|
||||
|
||||
```typescript
|
||||
import {
|
||||
parseSpecStreamLine,
|
||||
applySpecStreamPatch,
|
||||
} from '@json-render/core';
|
||||
|
||||
// Parse a single line
|
||||
const patch = parseSpecStreamLine('{"op":"add","path":"/root","value":{}}');
|
||||
|
||||
// Apply patch to object (mutates in place)
|
||||
const obj = {};
|
||||
applySpecStreamPatch(obj, patch);
|
||||
```
|
||||
|
||||
### applySpecPatch
|
||||
|
||||
Apply a single SpecStream patch to a Spec object (mutates in place, returns the spec):
|
||||
|
||||
```typescript
|
||||
import { applySpecPatch } from '@json-render/core';
|
||||
|
||||
let spec: Spec = { root: "", elements: {} };
|
||||
applySpecPatch(spec, { op: "add", path: "/root", value: "main" });
|
||||
|
||||
// For React state updates, spread to create a new reference:
|
||||
setSpec({ ...applySpecPatch(spec, patch) });
|
||||
```
|
||||
|
||||
### nestedToFlat
|
||||
|
||||
Convert a nested element tree (with inline children) into the flat `Spec` format:
|
||||
|
||||
```typescript
|
||||
import { nestedToFlat } from '@json-render/core';
|
||||
|
||||
const flat = nestedToFlat({
|
||||
type: "Card",
|
||||
props: { title: "Hello" },
|
||||
children: [
|
||||
{ type: "Text", props: { content: "World" }, children: [] }
|
||||
],
|
||||
});
|
||||
// { root: "el-0", elements: { "el-0": ..., "el-1": ... } }
|
||||
```
|
||||
|
||||
### createJsonRenderTransform
|
||||
|
||||
Low-level `TransformStream` that separates text from JSONL patches in a mixed AI stream. Lines that parse as JSONL patches are emitted as `data-spec` parts; everything else passes through as text.
|
||||
|
||||
The transform properly splits text blocks around spec data by emitting `text-end`/`text-start` pairs, ensuring the AI SDK creates separate text parts and preserving correct interleaving of prose and UI in `message.parts`.
|
||||
|
||||
```typescript
|
||||
import { createJsonRenderTransform } from '@json-render/core';
|
||||
|
||||
const transform = createJsonRenderTransform();
|
||||
// Use with ReadableStream.pipeThrough(transform) for custom pipelines
|
||||
```
|
||||
|
||||
Most users should use `pipeJsonRender()` instead, which wraps this transform for the common AI SDK use case.
|
||||
|
||||
### createMixedStreamParser
|
||||
|
||||
Parse a mixed stream of text and JSONL patches (used for Chat + GenUI mode):
|
||||
|
||||
```typescript
|
||||
import { createMixedStreamParser } from '@json-render/core';
|
||||
|
||||
const parser = createMixedStreamParser({
|
||||
onText: (text) => appendToMessage(text),
|
||||
onPatch: (patch) => applySpecPatch(spec, patch),
|
||||
});
|
||||
|
||||
// As chunks arrive from the stream:
|
||||
for await (const chunk of stream) {
|
||||
parser.push(chunk);
|
||||
}
|
||||
parser.flush();
|
||||
```
|
||||
|
||||
### pipeJsonRender
|
||||
|
||||
Pipe an AI SDK `UIMessageStream` through the json-render transform. Lines that parse as JSONL patches are emitted as `data-spec` parts; everything else passes through as text. Used in Chat mode API routes.
|
||||
|
||||
```typescript
|
||||
import { pipeJsonRender } from '@json-render/core';
|
||||
import { createUIMessageStream, createUIMessageStreamResponse } from 'ai';
|
||||
|
||||
const stream = createUIMessageStream({
|
||||
execute: async ({ writer }) => {
|
||||
writer.merge(pipeJsonRender(result.toUIMessageStream()));
|
||||
},
|
||||
});
|
||||
return createUIMessageStreamResponse({ stream });
|
||||
```
|
||||
|
||||
See [Generation Modes](/docs/generation-modes) for full Chat mode setup.
|
||||
|
||||
### SpecStream Types
|
||||
|
||||
Fully compliant with [RFC 6902](https://datatracker.ietf.org/doc/html/rfc6902):
|
||||
|
||||
```typescript
|
||||
interface SpecStreamLine {
|
||||
op: 'add' | 'remove' | 'replace' | 'move' | 'copy' | 'test';
|
||||
path: string;
|
||||
value?: unknown; // Required for add, replace, test
|
||||
from?: string; // Required for move, copy
|
||||
}
|
||||
|
||||
interface SpecStreamCompiler<T> {
|
||||
push(chunk: string): { result: T; newPatches: SpecStreamLine[] };
|
||||
getResult(): T;
|
||||
getPatches(): SpecStreamLine[];
|
||||
reset(): void;
|
||||
}
|
||||
|
||||
interface MixedStreamCallbacks {
|
||||
onText: (text: string) => void;
|
||||
onPatch: (patch: SpecStreamLine) => void;
|
||||
}
|
||||
|
||||
interface MixedStreamParser {
|
||||
push(chunk: string): void;
|
||||
flush(): void;
|
||||
}
|
||||
```
|
||||
|
||||
## Utility Functions
|
||||
|
||||
### Path Utilities
|
||||
|
||||
```typescript
|
||||
import { getByPath, setByPath } from '@json-render/core';
|
||||
|
||||
// Get value by JSON Pointer path
|
||||
const value = getByPath(state, '/user/name'); // "Alice"
|
||||
|
||||
// Set value by path (mutates object)
|
||||
setByPath(state, '/user/email', 'alice@example.com');
|
||||
```
|
||||
|
||||
### resolveDynamicValue
|
||||
|
||||
```typescript
|
||||
import { resolveDynamicValue } from '@json-render/core';
|
||||
|
||||
// Resolve a dynamic value against state
|
||||
const name = resolveDynamicValue("Hello", state); // "Hello"
|
||||
const name2 = resolveDynamicValue({ $state: "/user/name" }, state); // "Alice"
|
||||
```
|
||||
|
||||
### findFormValue
|
||||
|
||||
```typescript
|
||||
import { findFormValue } from '@json-render/core';
|
||||
|
||||
// Find form values regardless of path format
|
||||
// Checks: params.name, params["form.name"], state["form.name"], state.form.name
|
||||
const value = findFormValue("name", params, state);
|
||||
```
|
||||
|
||||
## buildUserPrompt
|
||||
|
||||
Build structured user prompts for AI generation, with support for refinement and state context.
|
||||
|
||||
```typescript
|
||||
import { buildUserPrompt } from '@json-render/core';
|
||||
|
||||
function buildUserPrompt(options: UserPromptOptions): string
|
||||
|
||||
interface UserPromptOptions {
|
||||
prompt: string; // The user's text prompt
|
||||
currentSpec?: Spec | null; // Existing spec to refine (triggers patch-only mode)
|
||||
state?: Record<string, unknown> | null; // Runtime state context to include
|
||||
maxPromptLength?: number; // Max length for user text (truncates before wrapping)
|
||||
}
|
||||
```
|
||||
|
||||
### Fresh generation
|
||||
|
||||
```typescript
|
||||
const userPrompt = buildUserPrompt({ prompt: "create a todo app" });
|
||||
```
|
||||
|
||||
### Refinement (patch-only mode)
|
||||
|
||||
When `currentSpec` is provided, the prompt instructs the AI to output only the patches needed for the change, not recreate the entire spec:
|
||||
|
||||
```typescript
|
||||
const userPrompt = buildUserPrompt({
|
||||
prompt: "add a dark mode toggle",
|
||||
currentSpec: existingSpec,
|
||||
});
|
||||
```
|
||||
|
||||
### With state context
|
||||
|
||||
Include runtime state so the AI knows what data is available:
|
||||
|
||||
```typescript
|
||||
const userPrompt = buildUserPrompt({
|
||||
prompt: "show my data",
|
||||
state: { todos: [{ text: "Buy milk" }] },
|
||||
});
|
||||
```
|
||||
|
||||
## evaluateVisibility
|
||||
|
||||
Evaluates a visibility condition against the state model.
|
||||
|
||||
```typescript
|
||||
function evaluateVisibility(
|
||||
condition: VisibilityCondition | undefined,
|
||||
ctx: VisibilityContext
|
||||
): boolean
|
||||
|
||||
interface VisibilityContext {
|
||||
stateModel: StateModel;
|
||||
repeatItem?: unknown; // Current repeat item (inside repeat scope)
|
||||
repeatIndex?: number; // Current repeat array index (inside repeat scope)
|
||||
}
|
||||
|
||||
type VisibilityCondition =
|
||||
| { $state: string } // truthiness
|
||||
| { $state: string; not: true } // falsy
|
||||
| { $state: string; eq: unknown } // equality
|
||||
| { $state: string; neq: unknown } // inequality
|
||||
| { $state: string; gt: number } // greater than
|
||||
| { $state: string; gte: number } // gte
|
||||
| { $state: string; lt: number } // lt
|
||||
| { $state: string; lte: number } // lte
|
||||
| { $item: string } // item field (repeat scope)
|
||||
| { $item: string; eq: unknown } // item field equality
|
||||
| { $index: true } // index truthiness (repeat scope)
|
||||
| { $index: true; gt: number } // index comparison
|
||||
| VisibilityCondition[] // implicit AND
|
||||
| { $and: VisibilityCondition[] } // explicit AND
|
||||
| { $or: VisibilityCondition[] } // OR
|
||||
| boolean; // always / never
|
||||
```
|
||||
|
||||
## Types
|
||||
|
||||
### UIElement
|
||||
|
||||
```typescript
|
||||
interface UIElement {
|
||||
type: string;
|
||||
props: Record<string, unknown>;
|
||||
children?: string[]; // Keys of child elements
|
||||
visible?: VisibilityCondition;
|
||||
on?: Record<string, ActionBinding | ActionBinding[]>; // Event bindings
|
||||
repeat?: { statePath: string; key?: string }; // Repeat for arrays
|
||||
}
|
||||
```
|
||||
|
||||
Elements are stored in the `elements` map keyed by string IDs. The key comes from the map, not from the element itself.
|
||||
|
||||
### Spec (Element Tree)
|
||||
|
||||
```typescript
|
||||
interface Spec {
|
||||
root: string | null; // Key of root element
|
||||
elements: Record<string, UIElement>; // Flat element map
|
||||
state?: Record<string, unknown>; // Initial state model
|
||||
}
|
||||
```
|
||||
|
||||
Elements are stored as a flat map with string keys. The tree structure is built by following the `children` arrays.
|
||||
|
||||
### ActionBinding
|
||||
|
||||
```typescript
|
||||
interface ActionBinding {
|
||||
action: string;
|
||||
params?: Record<string, DynamicValue>;
|
||||
confirm?: {
|
||||
title: string;
|
||||
message: string;
|
||||
variant?: 'default' | 'danger';
|
||||
};
|
||||
onSuccess?: { set: Record<string, unknown> };
|
||||
onError?: { set: Record<string, unknown> };
|
||||
preventDefault?: boolean; // Prevent default browser behavior (e.g. navigation on links)
|
||||
}
|
||||
```
|
||||
|
||||
### ValidationSchema
|
||||
|
||||
```typescript
|
||||
interface ValidationSchema {
|
||||
checks: ValidationCheck[];
|
||||
validateOn?: 'change' | 'blur' | 'submit';
|
||||
}
|
||||
|
||||
interface ValidationCheck {
|
||||
type: string;
|
||||
args?: Record<string, unknown>;
|
||||
message: string;
|
||||
}
|
||||
```
|
||||
@@ -1,403 +0,0 @@
|
||||
import { Code } from "@/components/code";
|
||||
|
||||
export const metadata = {
|
||||
title: "@json-render/core API | json-render",
|
||||
};
|
||||
|
||||
export default function CoreApiPage() {
|
||||
return (
|
||||
<article>
|
||||
<h1 className="text-3xl font-bold mb-4">@json-render/core</h1>
|
||||
<p className="text-muted-foreground mb-8">
|
||||
Core types, schemas, and utilities.
|
||||
</p>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">defineCatalog</h2>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
Creates a type-safe catalog definition with schema validation.
|
||||
</p>
|
||||
<Code lang="typescript">{`import { defineCatalog } from '@json-render/core';
|
||||
import { schema } from '@json-render/react';
|
||||
|
||||
function defineCatalog<T extends ZodType>(
|
||||
s: T,
|
||||
config: CatalogConfig
|
||||
): Catalog
|
||||
|
||||
// Use the React schema for standard UI specs
|
||||
const catalog = defineCatalog(schema, {
|
||||
components: {...},
|
||||
actions: {...},
|
||||
});`}</Code>
|
||||
|
||||
<h3 className="text-lg font-semibold mt-8 mb-4">CatalogConfig</h3>
|
||||
<Code lang="typescript">{`interface CatalogConfig {
|
||||
components: Record<string, ComponentDefinition>;
|
||||
actions?: Record<string, ActionDefinition>;
|
||||
functions?: Record<string, FunctionDefinition>;
|
||||
}
|
||||
|
||||
interface ComponentDefinition {
|
||||
props: ZodObject; // Use .nullable() for optional props
|
||||
slots?: string[]; // Named slots (e.g., ["default"])
|
||||
description?: string; // Help AI understand usage
|
||||
}
|
||||
|
||||
interface ActionDefinition {
|
||||
params?: ZodObject;
|
||||
description?: string;
|
||||
}
|
||||
|
||||
interface FunctionDefinition {
|
||||
description?: string;
|
||||
}`}</Code>
|
||||
|
||||
<h3 className="text-lg font-semibold mt-8 mb-4">Catalog Instance</h3>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
The returned catalog provides methods for AI prompt generation,
|
||||
validation, and schema export:
|
||||
</p>
|
||||
<Code lang="typescript">{`interface Catalog {
|
||||
// Data
|
||||
readonly data: CatalogConfig; // The catalog configuration
|
||||
readonly componentNames: string[]; // List of component names
|
||||
readonly actionNames: string[]; // List of action names
|
||||
|
||||
// AI Prompt Generation
|
||||
prompt(options?: PromptOptions): string;
|
||||
|
||||
// Validation
|
||||
validate(spec: unknown): SpecValidationResult;
|
||||
zodSchema(): z.ZodType; // Get the Zod schema for specs
|
||||
|
||||
// Export
|
||||
jsonSchema(): object; // Export as JSON Schema
|
||||
}
|
||||
|
||||
interface PromptOptions {
|
||||
system?: string; // Custom system message intro
|
||||
customRules?: string[]; // Additional rules to append
|
||||
}
|
||||
|
||||
interface SpecValidationResult<T> {
|
||||
success: boolean;
|
||||
data?: T; // Validated spec (if success)
|
||||
error?: z.ZodError; // Validation errors (if failed)
|
||||
}`}</Code>
|
||||
|
||||
<h3 className="text-lg font-semibold mt-8 mb-4">Catalog Methods</h3>
|
||||
<Code lang="typescript">{`// Generate AI system prompt
|
||||
const systemPrompt = catalog.prompt({
|
||||
customRules: ["Always use Card as root element"],
|
||||
});
|
||||
|
||||
// Validate a spec from AI
|
||||
const result = catalog.validate(aiOutput);
|
||||
if (result.success) {
|
||||
render(result.data);
|
||||
} else {
|
||||
console.error(result.error);
|
||||
}
|
||||
|
||||
// Get Zod schema for custom validation
|
||||
const schema = catalog.zodSchema();
|
||||
const parsed = schema.safeParse(aiOutput);
|
||||
|
||||
// Export as JSON Schema (for structured outputs)
|
||||
const jsonSchema = catalog.jsonSchema();`}</Code>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">Schema System</h2>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
json-render uses a flexible schema system that defines both the AI
|
||||
output format (spec) and what catalogs must provide. Each renderer
|
||||
package provides its own schema (e.g., @json-render/react exports{" "}
|
||||
<code className="text-foreground">schema</code>).
|
||||
</p>
|
||||
|
||||
<h3 className="text-lg font-semibold mt-8 mb-4">schema</h3>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
The schema for flat UI element trees. This is exported from
|
||||
@json-render/react.
|
||||
</p>
|
||||
<Code lang="typescript">{`import { defineCatalog } from '@json-render/core';
|
||||
import { schema } from '@json-render/react';
|
||||
|
||||
// schema defines:
|
||||
// - Spec shape: { root: string, elements: Record<string, UIElement> }
|
||||
// - Catalog shape: { components: {...}, actions: {...} }
|
||||
|
||||
const catalog = defineCatalog(schema, {
|
||||
components: {
|
||||
Card: {
|
||||
props: z.object({ title: z.string() }),
|
||||
slots: ["default"],
|
||||
description: "Container card",
|
||||
},
|
||||
},
|
||||
actions: {
|
||||
submit: {
|
||||
params: z.object({ formId: z.string() }),
|
||||
description: "Submit a form",
|
||||
},
|
||||
},
|
||||
});`}</Code>
|
||||
|
||||
<h3 className="text-lg font-semibold mt-8 mb-4">defineSchema</h3>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
Create custom schemas for different output formats (e.g., page-based,
|
||||
block-based).
|
||||
</p>
|
||||
<Code lang="typescript">{`import { defineSchema } from '@json-render/core';
|
||||
|
||||
const mySchema = defineSchema((s) => ({
|
||||
// What the AI outputs (spec)
|
||||
spec: s.object({
|
||||
title: s.string(),
|
||||
blocks: s.array(s.object({
|
||||
type: s.ref("catalog.blocks"),
|
||||
content: s.any(),
|
||||
})),
|
||||
}),
|
||||
|
||||
// What the catalog must provide
|
||||
catalog: s.object({
|
||||
blocks: s.map({
|
||||
props: s.zod(),
|
||||
description: s.string(),
|
||||
}),
|
||||
}),
|
||||
}));`}</Code>
|
||||
|
||||
<h3 className="text-lg font-semibold mt-8 mb-4">Schema Builder API</h3>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
The schema builder provides these methods:
|
||||
</p>
|
||||
<Code lang="typescript">{`// Primitive types
|
||||
s.string() // String value
|
||||
s.number() // Number value
|
||||
s.boolean() // Boolean value
|
||||
s.any() // Any value
|
||||
|
||||
// Compound types
|
||||
s.array(item) // Array of items
|
||||
s.object({ ... }) // Object with shape
|
||||
s.record(value) // Record/map with value type
|
||||
|
||||
// Catalog references (for type safety)
|
||||
s.ref("catalog.components") // Reference to catalog key (becomes enum)
|
||||
s.propsOf("catalog.components") // Props schema from catalog entry
|
||||
|
||||
// Catalog definitions
|
||||
s.map({ props: s.zod(), ... }) // Map of named entries with shared shape
|
||||
s.zod() // Placeholder for user-provided Zod schema
|
||||
|
||||
// Modifiers
|
||||
s.optional() // Mark field as optional`}</Code>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">Zod Schemas</h2>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
Pre-built Zod schemas for common json-render types:
|
||||
</p>
|
||||
|
||||
<h3 className="text-lg font-semibold mt-8 mb-4">Dynamic Value Schemas</h3>
|
||||
<Code lang="typescript">{`import {
|
||||
DynamicValueSchema, // string | number | boolean | null | { path: string }
|
||||
DynamicStringSchema, // string | { path: string }
|
||||
DynamicNumberSchema, // number | { path: string }
|
||||
DynamicBooleanSchema, // boolean | { path: string }
|
||||
} from '@json-render/core';
|
||||
|
||||
// Dynamic values can be literals or data path references
|
||||
type DynamicValue<T> = T | { path: string };
|
||||
|
||||
// Example: a prop that can be a literal or bound to data
|
||||
const schema = z.object({
|
||||
label: DynamicStringSchema, // "Hello" or { path: "/user/name" }
|
||||
});`}</Code>
|
||||
|
||||
<h3 className="text-lg font-semibold mt-8 mb-4">
|
||||
Visibility & Logic Schemas
|
||||
</h3>
|
||||
<Code lang="typescript">{`import {
|
||||
VisibilityConditionSchema, // Full visibility condition
|
||||
LogicExpressionSchema, // Logic operators (and, or, not, eq, gt, etc.)
|
||||
} from '@json-render/core';
|
||||
|
||||
// Use in component props that need conditional rendering
|
||||
const schema = z.object({
|
||||
visible: VisibilityConditionSchema.optional(),
|
||||
});`}</Code>
|
||||
|
||||
<h3 className="text-lg font-semibold mt-8 mb-4">Action Schemas</h3>
|
||||
<Code lang="typescript">{`import {
|
||||
ActionSchema, // Full action definition
|
||||
ActionConfirmSchema, // Confirmation dialog config
|
||||
ActionOnSuccessSchema, // Success handler config
|
||||
ActionOnErrorSchema, // Error handler config
|
||||
} from '@json-render/core';`}</Code>
|
||||
|
||||
<h3 className="text-lg font-semibold mt-8 mb-4">Validation Schemas</h3>
|
||||
<Code lang="typescript">{`import {
|
||||
ValidationCheckSchema, // Single validation check
|
||||
ValidationConfigSchema, // Full validation config with checks array
|
||||
} from '@json-render/core';`}</Code>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">SpecStream</h2>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
SpecStream is json-render's streaming format for progressively
|
||||
building specs from JSONL patches.
|
||||
</p>
|
||||
|
||||
<h3 className="text-lg font-semibold mt-8 mb-4">
|
||||
createSpecStreamCompiler
|
||||
</h3>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
Create a streaming compiler that incrementally builds a spec:
|
||||
</p>
|
||||
<Code lang="typescript">{`import { createSpecStreamCompiler } from '@json-render/core';
|
||||
|
||||
const compiler = createSpecStreamCompiler<MySpec>();
|
||||
|
||||
// Process streaming chunks
|
||||
const { result, newPatches } = compiler.push(chunk);
|
||||
|
||||
// Get final result
|
||||
const spec = compiler.getResult();
|
||||
|
||||
// Reset for reuse
|
||||
compiler.reset();`}</Code>
|
||||
|
||||
<h3 className="text-lg font-semibold mt-8 mb-4">compileSpecStream</h3>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
Compile an entire SpecStream string at once:
|
||||
</p>
|
||||
<Code lang="typescript">{`import { compileSpecStream } from '@json-render/core';
|
||||
|
||||
const jsonl = \`{"op":"set","path":"/root","value":{}}
|
||||
{"op":"set","path":"/root/type","value":"Card"}\`;
|
||||
|
||||
const spec = compileSpecStream<MySpec>(jsonl);`}</Code>
|
||||
|
||||
<h3 className="text-lg font-semibold mt-8 mb-4">Low-Level Utilities</h3>
|
||||
<Code lang="typescript">{`import {
|
||||
parseSpecStreamLine,
|
||||
applySpecStreamPatch,
|
||||
} from '@json-render/core';
|
||||
|
||||
// Parse a single line
|
||||
const patch = parseSpecStreamLine('{"op":"set","path":"/root","value":{}}');
|
||||
|
||||
// Apply patch to object (mutates in place)
|
||||
const obj = {};
|
||||
applySpecStreamPatch(obj, patch);`}</Code>
|
||||
|
||||
<h3 className="text-lg font-semibold mt-8 mb-4">SpecStream Types</h3>
|
||||
<Code lang="typescript">{`interface SpecStreamLine {
|
||||
op: 'set' | 'add' | 'replace' | 'remove';
|
||||
path: string;
|
||||
value?: unknown;
|
||||
}
|
||||
|
||||
interface SpecStreamCompiler<T> {
|
||||
push(chunk: string): { result: T; newPatches: SpecStreamLine[] };
|
||||
getResult(): T;
|
||||
reset(): void;
|
||||
}`}</Code>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">Utility Functions</h2>
|
||||
|
||||
<h3 className="text-lg font-semibold mt-8 mb-4">Path Utilities</h3>
|
||||
<Code lang="typescript">{`import { getByPath, setByPath } from '@json-render/core';
|
||||
|
||||
// Get value by JSON Pointer path
|
||||
const value = getByPath(data, '/user/name'); // "Alice"
|
||||
|
||||
// Set value by path (mutates object)
|
||||
setByPath(data, '/user/email', 'alice@example.com');`}</Code>
|
||||
|
||||
<h3 className="text-lg font-semibold mt-8 mb-4">resolveDynamicValue</h3>
|
||||
<Code lang="typescript">{`import { resolveDynamicValue } from '@json-render/core';
|
||||
|
||||
// Resolve a dynamic value against data
|
||||
const name = resolveDynamicValue("Hello", data); // "Hello"
|
||||
const name2 = resolveDynamicValue({ path: "/user/name" }, data); // "Alice"`}</Code>
|
||||
|
||||
<h3 className="text-lg font-semibold mt-8 mb-4">findFormValue</h3>
|
||||
<Code lang="typescript">{`import { findFormValue } from '@json-render/core';
|
||||
|
||||
// Find form values regardless of path format
|
||||
// Checks: params.name, params["form.name"], data["form.name"], data.form.name
|
||||
const value = findFormValue("name", params, data);`}</Code>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">evaluateVisibility</h2>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
Evaluates a visibility condition against data and auth state.
|
||||
</p>
|
||||
<Code lang="typescript">{`function evaluateVisibility(
|
||||
condition: VisibilityCondition | undefined,
|
||||
data: Record<string, unknown>,
|
||||
auth?: AuthState
|
||||
): boolean
|
||||
|
||||
type VisibilityCondition =
|
||||
| { path: string }
|
||||
| { auth: 'signedIn' | 'signedOut' | string }
|
||||
| { and: VisibilityCondition[] }
|
||||
| { or: VisibilityCondition[] }
|
||||
| { not: VisibilityCondition }
|
||||
| { eq: [DynamicValue, DynamicValue] }
|
||||
| { gt: [DynamicValue, DynamicValue] }
|
||||
| { gte: [DynamicValue, DynamicValue] }
|
||||
| { lt: [DynamicValue, DynamicValue] }
|
||||
| { lte: [DynamicValue, DynamicValue] };`}</Code>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">Types</h2>
|
||||
|
||||
<h3 className="text-lg font-semibold mt-8 mb-4">UIElement</h3>
|
||||
<Code lang="typescript">{`interface UIElement {
|
||||
key: string;
|
||||
type: string;
|
||||
props: Record<string, unknown>;
|
||||
children?: string[]; // Keys of child elements
|
||||
visible?: VisibilityCondition;
|
||||
validation?: ValidationSchema;
|
||||
}`}</Code>
|
||||
|
||||
<h3 className="text-lg font-semibold mt-8 mb-4">Spec (Element Tree)</h3>
|
||||
<Code lang="typescript">{`interface Spec {
|
||||
root: string | null; // Key of root element
|
||||
elements: Record<string, UIElement>;
|
||||
}`}</Code>
|
||||
<p className="text-sm text-muted-foreground mt-2 mb-4">
|
||||
Elements are stored as a flat map with string keys. The tree structure
|
||||
is built by following the{" "}
|
||||
<code className="text-foreground">children</code> arrays.
|
||||
</p>
|
||||
|
||||
<h3 className="text-lg font-semibold mt-8 mb-4">Action</h3>
|
||||
<Code lang="typescript">{`interface Action {
|
||||
name: string;
|
||||
params?: Record<string, unknown>;
|
||||
confirm?: {
|
||||
title: string;
|
||||
message: string;
|
||||
variant?: 'default' | 'danger';
|
||||
};
|
||||
onSuccess?: { set: Record<string, unknown> };
|
||||
onError?: { set: Record<string, unknown> };
|
||||
}`}</Code>
|
||||
|
||||
<h3 className="text-lg font-semibold mt-8 mb-4">ValidationSchema</h3>
|
||||
<Code lang="typescript">{`interface ValidationSchema {
|
||||
checks: ValidationCheck[];
|
||||
validateOn?: 'change' | 'blur' | 'submit';
|
||||
}
|
||||
|
||||
interface ValidationCheck {
|
||||
fn: string;
|
||||
args?: Record<string, unknown>;
|
||||
message: string;
|
||||
}`}</Code>
|
||||
</article>
|
||||
);
|
||||
}
|
||||
@@ -0,0 +1,197 @@
|
||||
import { pageMetadata } from "@/lib/page-metadata"
|
||||
export const metadata = pageMetadata("docs/api/react-native")
|
||||
|
||||
# @json-render/react-native
|
||||
|
||||
React Native renderer with standard components, providers, and hooks.
|
||||
|
||||
## Standard Components
|
||||
|
||||
### Layout
|
||||
|
||||
| Component | Props | Description |
|
||||
|-----------|-------|-------------|
|
||||
| `Container` | `padding`, `background`, `borderRadius`, `borderColor`, `flex` | Basic wrapper with styling |
|
||||
| `Row` | `gap`, `align`, `justify`, `flex`, `wrap` | Horizontal flex layout |
|
||||
| `Column` | `gap`, `align`, `justify`, `flex` | Vertical flex layout |
|
||||
| `ScrollContainer` | `direction` | Scrollable area (vertical or horizontal) |
|
||||
| `SafeArea` | `edges` | Safe area insets for notch/home indicator |
|
||||
| `Pressable` | `action`, `actionParams` | Touchable wrapper that triggers actions |
|
||||
| `Spacer` | `size`, `flex` | Fixed or flexible spacing |
|
||||
| `Divider` | `color`, `thickness` | Thin line separator |
|
||||
|
||||
### Content
|
||||
|
||||
| Component | Props | Description |
|
||||
|-----------|-------|-------------|
|
||||
| `Heading` | `text`, `level`, `align`, `color` | Heading text (levels 1-6) |
|
||||
| `Paragraph` | `text`, `align`, `color` | Body text |
|
||||
| `Label` | `text`, `color`, `bold` | Small label text |
|
||||
| `Image` | `uri`, `width`, `height`, `resizeMode`, `borderRadius` | Image display |
|
||||
| `Avatar` | `uri`, `size`, `fallback` | Circular avatar |
|
||||
| `Badge` | `label`, `color`, `textColor` | Status badge |
|
||||
| `Chip` | `label`, `selected`, `color` | Tag/chip |
|
||||
|
||||
### Input
|
||||
|
||||
| Component | Props | Description |
|
||||
|-----------|-------|-------------|
|
||||
| `Button` | `label`, `variant`, `size`, `disabled`, `action`, `actionParams` | Pressable button |
|
||||
| `TextInput` | `placeholder`, `value` (use `$bindState`), `secure`, `keyboardType`, `multiline` | Text input field |
|
||||
| `Switch` | `checked` (use `$bindState`), `label` | Toggle switch |
|
||||
| `Checkbox` | `checked` (use `$bindState`), `label` | Checkbox with label |
|
||||
| `Slider` | `value` (use `$bindState`), `min`, `max`, `step` | Range slider |
|
||||
| `SearchBar` | `placeholder`, `value` (use `$bindState`) | Search input |
|
||||
|
||||
### Feedback
|
||||
|
||||
| Component | Props | Description |
|
||||
|-----------|-------|-------------|
|
||||
| `Spinner` | `size`, `color` | Loading indicator |
|
||||
| `ProgressBar` | `progress`, `color`, `trackColor` | Progress indicator |
|
||||
|
||||
### Composite
|
||||
|
||||
| Component | Props | Description |
|
||||
|-----------|-------|-------------|
|
||||
| `Card` | `title`, `subtitle`, `padding` | Card container |
|
||||
| `ListItem` | `title`, `subtitle`, `leading`, `trailing`, `action`, `actionParams` | List row |
|
||||
| `Modal` | `visible`, `title` | Bottom sheet modal |
|
||||
|
||||
## Providers
|
||||
|
||||
### StateProvider
|
||||
|
||||
```tsx
|
||||
<StateProvider initialState={object} onStateChange={fn}>
|
||||
{children}
|
||||
</StateProvider>
|
||||
```
|
||||
|
||||
| Prop | Type | Description |
|
||||
|------|------|-------------|
|
||||
| `store` | `StateStore` | External store (controlled mode). When provided, `initialState` and `onStateChange` are ignored. |
|
||||
| `initialState` | `Record<string, unknown>` | Initial state model (uncontrolled mode). |
|
||||
| `onStateChange` | `(changes: Array<{ path: string; value: unknown }>) => void` | Callback when state changes (uncontrolled mode). Called once per `set` or `update` with all changed entries. |
|
||||
|
||||
#### External Store (Controlled Mode)
|
||||
|
||||
Pass a `StateStore` to bypass the internal state and wire json-render to any state management library:
|
||||
|
||||
```tsx
|
||||
import { createStateStore, type StateStore } from "@json-render/react-native";
|
||||
|
||||
const store = createStateStore({ count: 0 });
|
||||
|
||||
<StateProvider store={store}>
|
||||
{children}
|
||||
</StateProvider>
|
||||
|
||||
// Mutate from anywhere — components re-render automatically:
|
||||
store.set("/count", 1);
|
||||
```
|
||||
|
||||
The `store` prop is also available on `JSONUIProvider` and `createRenderer`.
|
||||
|
||||
### ActionProvider
|
||||
|
||||
```tsx
|
||||
<ActionProvider handlers={Record<string, ActionHandler>}>
|
||||
{children}
|
||||
</ActionProvider>
|
||||
```
|
||||
|
||||
### VisibilityProvider
|
||||
|
||||
```tsx
|
||||
<VisibilityProvider>
|
||||
{children}
|
||||
</VisibilityProvider>
|
||||
```
|
||||
|
||||
Conditions in specs use the `VisibilityCondition` format with `$state` paths (e.g. `{ "$state": "/path" }`, `{ "$state": "/path", "eq": value }`). See [visibility](/docs/visibility) for the full syntax.
|
||||
|
||||
### ValidationProvider
|
||||
|
||||
```tsx
|
||||
<ValidationProvider>
|
||||
{children}
|
||||
</ValidationProvider>
|
||||
```
|
||||
|
||||
## defineRegistry
|
||||
|
||||
Create a type-safe component registry. Standard components are built-in; only register custom components.
|
||||
|
||||
```tsx
|
||||
import { defineRegistry, type Components } from '@json-render/react-native';
|
||||
|
||||
const { registry } = defineRegistry(catalog, {
|
||||
components: {
|
||||
Icon: ({ props }) => <Ionicons name={props.name} size={props.size ?? 24} />,
|
||||
} as Components<typeof catalog>,
|
||||
});
|
||||
```
|
||||
|
||||
## Hooks
|
||||
|
||||
### useUIStream
|
||||
|
||||
```typescript
|
||||
const {
|
||||
spec, // Spec | null - current UI state
|
||||
isStreaming, // boolean - true while streaming
|
||||
error, // Error | null
|
||||
send, // (prompt: string) => Promise<void>
|
||||
clear, // () => void - reset spec and error
|
||||
} = useUIStream({
|
||||
api: string,
|
||||
onComplete?: (spec: Spec) => void,
|
||||
onError?: (error: Error) => void,
|
||||
});
|
||||
```
|
||||
|
||||
### useStateStore
|
||||
|
||||
```typescript
|
||||
const { state, get, set, update } = useStateStore();
|
||||
```
|
||||
|
||||
### useStateValue
|
||||
|
||||
```typescript
|
||||
const value = useStateValue(path: string);
|
||||
```
|
||||
|
||||
### useStateBinding (deprecated)
|
||||
|
||||
> **Deprecated.** Use `useBoundProp` with `$bindState` expressions instead.
|
||||
|
||||
```typescript
|
||||
const [value, setValue] = useStateBinding(path: string);
|
||||
```
|
||||
|
||||
### useActions
|
||||
|
||||
```typescript
|
||||
const { execute } = useActions();
|
||||
```
|
||||
|
||||
### useIsVisible
|
||||
|
||||
```typescript
|
||||
const isVisible = useIsVisible(condition?: VisibilityCondition);
|
||||
```
|
||||
|
||||
## Catalog Exports
|
||||
|
||||
```typescript
|
||||
import { standardComponentDefinitions, standardActionDefinitions } from "@json-render/react-native/catalog";
|
||||
import { schema } from "@json-render/react-native/schema";
|
||||
```
|
||||
|
||||
| Export | Purpose |
|
||||
|--------|---------|
|
||||
| `standardComponentDefinitions` | Catalog definitions for all 25+ standard components |
|
||||
| `standardActionDefinitions` | Catalog definitions for standard actions (setState, navigate) |
|
||||
| `schema` | React Native element tree schema |
|
||||
@@ -0,0 +1,439 @@
|
||||
import { pageMetadata } from "@/lib/page-metadata"
|
||||
export const metadata = pageMetadata("docs/api/react-pdf")
|
||||
|
||||
# @json-render/react-pdf
|
||||
|
||||
PDF document renderer. Turn JSON specs into PDFs using `@react-pdf/renderer`.
|
||||
|
||||
## Install
|
||||
|
||||
```bash
|
||||
npm install @json-render/core @json-render/react-pdf
|
||||
```
|
||||
|
||||
See the [React PDF example](https://github.com/vercel-labs/json-render/tree/main/examples/react-pdf) for a full working example.
|
||||
|
||||
## schema
|
||||
|
||||
The PDF element schema for document specs. Use with `defineCatalog` from core.
|
||||
|
||||
```typescript
|
||||
import { defineCatalog } from '@json-render/core';
|
||||
import { schema, standardComponentDefinitions } from '@json-render/react-pdf';
|
||||
|
||||
const catalog = defineCatalog(schema, {
|
||||
components: standardComponentDefinitions,
|
||||
});
|
||||
```
|
||||
|
||||
## Render Functions
|
||||
|
||||
Server-side functions for producing PDF output. All accept a spec and optional `RenderOptions`.
|
||||
|
||||
```typescript
|
||||
import { renderToBuffer, renderToStream, renderToFile } from '@json-render/react-pdf';
|
||||
|
||||
const buffer = await renderToBuffer(spec);
|
||||
|
||||
const stream = await renderToStream(spec);
|
||||
stream.pipe(res);
|
||||
|
||||
await renderToFile(spec, './output.pdf');
|
||||
```
|
||||
|
||||
### RenderOptions
|
||||
|
||||
```typescript
|
||||
interface RenderOptions {
|
||||
registry?: ComponentRegistry;
|
||||
includeStandard?: boolean; // default: true
|
||||
state?: Record<string, unknown>;
|
||||
}
|
||||
```
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Option</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>registry</code></td>
|
||||
<td>Custom component map (merged with standard components)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>includeStandard</code></td>
|
||||
<td>Include built-in standard components (default: <code>true</code>)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>state</code></td>
|
||||
<td>Initial state for <code>$state</code> / <code>$cond</code> dynamic prop resolution</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
## defineRegistry
|
||||
|
||||
Create a type-safe component registry from a catalog. Components receive `{ props, children, emit, bindings, loading }`.
|
||||
|
||||
```tsx
|
||||
import { defineRegistry } from '@json-render/react-pdf';
|
||||
import { View, Text } from '@react-pdf/renderer';
|
||||
|
||||
const { registry } = defineRegistry(catalog, {
|
||||
components: {
|
||||
Badge: ({ props }) => (
|
||||
<View style={{ backgroundColor: props.color ?? '#e5e7eb', padding: 4, borderRadius: 4 }}>
|
||||
<Text style={{ fontSize: 10 }}>{props.label}</Text>
|
||||
</View>
|
||||
),
|
||||
},
|
||||
});
|
||||
|
||||
const buffer = await renderToBuffer(spec, { registry });
|
||||
```
|
||||
|
||||
## createRenderer
|
||||
|
||||
Create a standalone renderer component wired to state, actions, and validation.
|
||||
|
||||
```typescript
|
||||
import { createRenderer } from '@json-render/react-pdf';
|
||||
|
||||
const PDFRenderer = createRenderer(catalog, components);
|
||||
```
|
||||
|
||||
```typescript
|
||||
interface CreateRendererProps {
|
||||
spec: Spec | null;
|
||||
store?: StateStore;
|
||||
state?: Record<string, unknown>;
|
||||
onAction?: (actionName: string, params?: Record<string, unknown>) => void;
|
||||
onStateChange?: (changes: Array<{ path: string; value: unknown }>) => void;
|
||||
loading?: boolean;
|
||||
fallback?: ComponentRenderer;
|
||||
}
|
||||
```
|
||||
|
||||
When `store` is provided, `state` and `onStateChange` are ignored (controlled mode).
|
||||
|
||||
## Renderer
|
||||
|
||||
The main component that renders a spec to `@react-pdf/renderer` elements.
|
||||
|
||||
```typescript
|
||||
interface RendererProps {
|
||||
spec: Spec | null;
|
||||
registry?: ComponentRegistry;
|
||||
includeStandard?: boolean; // default: true
|
||||
loading?: boolean;
|
||||
fallback?: ComponentRenderer;
|
||||
}
|
||||
```
|
||||
|
||||
## Standard Components
|
||||
|
||||
### Document Structure
|
||||
|
||||
#### Document
|
||||
|
||||
Top-level PDF wrapper. Must be the root element. Children must be `Page` components.
|
||||
|
||||
```typescript
|
||||
{
|
||||
title: string | null;
|
||||
author: string | null;
|
||||
subject: string | null;
|
||||
}
|
||||
```
|
||||
|
||||
#### Page
|
||||
|
||||
A page in the document with configurable size, orientation, and margins.
|
||||
|
||||
```typescript
|
||||
{
|
||||
size: "A4" | "A3" | "A5" | "LETTER" | "LEGAL" | "TABLOID" | null;
|
||||
orientation: "portrait" | "landscape" | null;
|
||||
marginTop: number | null;
|
||||
marginBottom: number | null;
|
||||
marginLeft: number | null;
|
||||
marginRight: number | null;
|
||||
backgroundColor: string | null;
|
||||
}
|
||||
```
|
||||
|
||||
### Layout
|
||||
|
||||
#### View
|
||||
|
||||
Generic container with padding, margin, background, border, and flex alignment.
|
||||
|
||||
```typescript
|
||||
{
|
||||
padding: number | null;
|
||||
paddingTop: number | null;
|
||||
paddingBottom: number | null;
|
||||
paddingLeft: number | null;
|
||||
paddingRight: number | null;
|
||||
margin: number | null;
|
||||
backgroundColor: string | null;
|
||||
borderWidth: number | null;
|
||||
borderColor: string | null;
|
||||
borderRadius: number | null;
|
||||
flex: number | null;
|
||||
alignItems: "flex-start" | "center" | "flex-end" | "stretch" | null;
|
||||
justifyContent: "flex-start" | "center" | "flex-end" | "space-between" | "space-around" | null;
|
||||
}
|
||||
```
|
||||
|
||||
#### Row
|
||||
|
||||
Horizontal flex layout with optional wrapping.
|
||||
|
||||
```typescript
|
||||
{
|
||||
gap: number | null;
|
||||
alignItems: "flex-start" | "center" | "flex-end" | "stretch" | null;
|
||||
justifyContent: "flex-start" | "center" | "flex-end" | "space-between" | "space-around" | null;
|
||||
padding: number | null;
|
||||
flex: number | null;
|
||||
wrap: boolean | null;
|
||||
}
|
||||
```
|
||||
|
||||
#### Column
|
||||
|
||||
Vertical flex layout.
|
||||
|
||||
```typescript
|
||||
{
|
||||
gap: number | null;
|
||||
alignItems: "flex-start" | "center" | "flex-end" | "stretch" | null;
|
||||
justifyContent: "flex-start" | "center" | "flex-end" | "space-between" | "space-around" | null;
|
||||
padding: number | null;
|
||||
flex: number | null;
|
||||
}
|
||||
```
|
||||
|
||||
### Content
|
||||
|
||||
#### Heading
|
||||
|
||||
h1-h4 heading text with configurable color and alignment.
|
||||
|
||||
```typescript
|
||||
{
|
||||
text: string;
|
||||
level: "h1" | "h2" | "h3" | "h4" | null;
|
||||
color: string | null;
|
||||
align: "left" | "center" | "right" | null;
|
||||
}
|
||||
```
|
||||
|
||||
#### Text
|
||||
|
||||
Body text with full styling control.
|
||||
|
||||
```typescript
|
||||
{
|
||||
text: string;
|
||||
fontSize: number | null;
|
||||
color: string | null;
|
||||
align: "left" | "center" | "right" | null;
|
||||
fontWeight: "normal" | "bold" | null;
|
||||
fontStyle: "normal" | "italic" | null;
|
||||
lineHeight: number | null;
|
||||
}
|
||||
```
|
||||
|
||||
#### Image
|
||||
|
||||
Image from a URL with optional dimensions and fit.
|
||||
|
||||
```typescript
|
||||
{
|
||||
src: string;
|
||||
width: number | null;
|
||||
height: number | null;
|
||||
objectFit: "contain" | "cover" | "fill" | "none" | null;
|
||||
}
|
||||
```
|
||||
|
||||
#### Link
|
||||
|
||||
Hyperlink with visible text.
|
||||
|
||||
```typescript
|
||||
{
|
||||
text: string;
|
||||
href: string;
|
||||
fontSize: number | null;
|
||||
color: string | null;
|
||||
}
|
||||
```
|
||||
|
||||
### Data
|
||||
|
||||
#### Table
|
||||
|
||||
Data table with typed columns and string rows. Supports header styling and striped rows.
|
||||
|
||||
```typescript
|
||||
{
|
||||
columns: { header: string; width?: string; align?: "left" | "center" | "right" }[];
|
||||
rows: string[][];
|
||||
headerBackgroundColor: string | null;
|
||||
headerTextColor: string | null;
|
||||
borderColor: string | null;
|
||||
fontSize: number | null;
|
||||
striped: boolean | null;
|
||||
}
|
||||
```
|
||||
|
||||
#### List
|
||||
|
||||
Ordered or unordered list.
|
||||
|
||||
```typescript
|
||||
{
|
||||
items: string[];
|
||||
ordered: boolean | null;
|
||||
fontSize: number | null;
|
||||
color: string | null;
|
||||
spacing: number | null;
|
||||
}
|
||||
```
|
||||
|
||||
### Decorative
|
||||
|
||||
#### Divider
|
||||
|
||||
Horizontal line separator.
|
||||
|
||||
```typescript
|
||||
{
|
||||
color: string | null;
|
||||
thickness: number | null;
|
||||
marginTop: number | null;
|
||||
marginBottom: number | null;
|
||||
}
|
||||
```
|
||||
|
||||
#### Spacer
|
||||
|
||||
Empty vertical space.
|
||||
|
||||
```typescript
|
||||
{
|
||||
height: number | null;
|
||||
}
|
||||
```
|
||||
|
||||
### Page-Level
|
||||
|
||||
#### PageNumber
|
||||
|
||||
Renders current page number and total pages. Format uses `{pageNumber}` and `{totalPages}` placeholders.
|
||||
|
||||
```typescript
|
||||
{
|
||||
format: string | null; // default: "{pageNumber} / {totalPages}"
|
||||
fontSize: number | null;
|
||||
color: string | null;
|
||||
align: "left" | "center" | "right" | null;
|
||||
}
|
||||
```
|
||||
|
||||
## External Store (Controlled Mode)
|
||||
|
||||
Pass a `StateStore` to `StateProvider`, `JSONUIProvider`, or `createRenderer` for full control over state:
|
||||
|
||||
```tsx
|
||||
import { createStateStore, type StateStore } from "@json-render/react-pdf";
|
||||
|
||||
const store = createStateStore({ invoice: { total: 100 } });
|
||||
store.set("/invoice/total", 200);
|
||||
```
|
||||
|
||||
When `store` is provided, `initialState` / `state` and `onStateChange` are ignored.
|
||||
|
||||
## Server-Safe Import
|
||||
|
||||
Import schema and catalog definitions without pulling in React or `@react-pdf/renderer`:
|
||||
|
||||
```typescript
|
||||
import { schema, standardComponentDefinitions } from '@json-render/react-pdf/server';
|
||||
```
|
||||
|
||||
## Sub-path Exports
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Export</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>@json-render/react-pdf</code></td>
|
||||
<td>Full package: schema, renderer, components, render functions</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>@json-render/react-pdf/server</code></td>
|
||||
<td>Schema and catalog definitions only (no React)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>@json-render/react-pdf/catalog</code></td>
|
||||
<td>Standard component definitions and types</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>@json-render/react-pdf/render</code></td>
|
||||
<td>Server-side render functions only</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
## Types
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Export</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>ReactPdfSchema</code></td>
|
||||
<td>Schema type for PDF specs</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>ReactPdfSpec</code></td>
|
||||
<td>Spec type for PDF documents</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>RenderOptions</code></td>
|
||||
<td>Options for render functions</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>ComponentContext</code></td>
|
||||
<td>Typed component render function context</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>ComponentFn</code></td>
|
||||
<td>Component render function type</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>StandardComponentDefinitions</code></td>
|
||||
<td>Type of the standard component definitions object</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>StandardComponentProps<K></code></td>
|
||||
<td>Inferred props type for a standard component by name</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
@@ -0,0 +1,313 @@
|
||||
import { pageMetadata } from "@/lib/page-metadata"
|
||||
export const metadata = pageMetadata("docs/api/react")
|
||||
|
||||
# @json-render/react
|
||||
|
||||
React components, providers, and hooks.
|
||||
|
||||
## Providers
|
||||
|
||||
### StateProvider
|
||||
|
||||
```tsx
|
||||
<StateProvider initialState={object} onStateChange={fn}>
|
||||
{children}
|
||||
</StateProvider>
|
||||
```
|
||||
|
||||
| Prop | Type | Description |
|
||||
|------|------|-------------|
|
||||
| `store` | `StateStore` | External store (controlled mode). When provided, `initialState` and `onStateChange` are ignored. |
|
||||
| `initialState` | `Record<string, unknown>` | Initial state model (uncontrolled mode). |
|
||||
| `onStateChange` | `(changes: Array<{ path: string; value: unknown }>) => void` | Callback when state changes (uncontrolled mode). Called once per `set` or `update` with all changed entries. |
|
||||
|
||||
#### External Store (Controlled Mode)
|
||||
|
||||
Pass a `StateStore` to bypass the internal state and wire json-render to any state management library:
|
||||
|
||||
```tsx
|
||||
import { createStateStore, type StateStore } from "@json-render/react";
|
||||
|
||||
const store = createStateStore({ count: 0 });
|
||||
|
||||
<StateProvider store={store}>
|
||||
{children}
|
||||
</StateProvider>
|
||||
|
||||
// Mutate from anywhere — React re-renders automatically:
|
||||
store.set("/count", 1);
|
||||
```
|
||||
|
||||
The `store` prop is also available on `JSONUIProvider` and `createRenderer`.
|
||||
|
||||
### ActionProvider
|
||||
|
||||
```tsx
|
||||
<ActionProvider handlers={Record<string, ActionHandler>}>
|
||||
{children}
|
||||
</ActionProvider>
|
||||
|
||||
type ActionHandler = (params: Record<string, unknown>) => void | Promise<void>;
|
||||
```
|
||||
|
||||
### VisibilityProvider
|
||||
|
||||
```tsx
|
||||
<VisibilityProvider>
|
||||
{children}
|
||||
</VisibilityProvider>
|
||||
```
|
||||
|
||||
`VisibilityProvider` reads state from the parent `StateProvider` automatically. Conditions in specs use the `VisibilityCondition` format with `$state` paths (e.g. `{ "$state": "/path" }`, `{ "$state": "/path", "eq": value }`). See [visibility](/docs/visibility) for the full syntax.
|
||||
|
||||
### ValidationProvider
|
||||
|
||||
```tsx
|
||||
<ValidationProvider customFunctions={Record<string, ValidationFunction>}>
|
||||
{children}
|
||||
</ValidationProvider>
|
||||
|
||||
type ValidationFunction = (value: unknown, args?: object) => boolean | Promise<boolean>;
|
||||
```
|
||||
|
||||
## defineRegistry
|
||||
|
||||
Create a type-safe component registry from a catalog. Components receive `props`, `children`, `emit`, `on`, and `loading` with catalog-inferred types.
|
||||
|
||||
When the catalog declares actions, the `actions` field is required. When the catalog has no actions (e.g. `actions: {}`), the field is optional.
|
||||
|
||||
```tsx
|
||||
import { defineRegistry } from '@json-render/react';
|
||||
|
||||
const { registry } = defineRegistry(catalog, {
|
||||
components: {
|
||||
Card: ({ props, children }) => <div>{props.title}{children}</div>,
|
||||
Button: ({ props, emit }) => (
|
||||
<button onClick={() => emit("press")}>
|
||||
{props.label}
|
||||
</button>
|
||||
),
|
||||
},
|
||||
});
|
||||
|
||||
// Pass to <Renderer>
|
||||
<Renderer spec={spec} registry={registry} />
|
||||
```
|
||||
|
||||
## Components
|
||||
|
||||
### Renderer
|
||||
|
||||
```tsx
|
||||
<Renderer
|
||||
spec={Spec} // The UI spec to render
|
||||
registry={Registry} // Component registry (from defineRegistry)
|
||||
loading={boolean} // Optional loading state
|
||||
fallback={Component} // Optional fallback for unknown types
|
||||
/>
|
||||
|
||||
type Registry = Record<string, React.ComponentType<ComponentRenderProps>>;
|
||||
```
|
||||
|
||||
### Component Props (via defineRegistry)
|
||||
|
||||
```tsx
|
||||
interface ComponentContext<P> {
|
||||
props: P; // Typed props from catalog
|
||||
children?: React.ReactNode; // Rendered children (for slot components)
|
||||
emit: (event: string) => void; // Emit a named event (always defined)
|
||||
on: (event: string) => EventHandle; // Get event handle with metadata
|
||||
loading?: boolean;
|
||||
bindings?: Record<string, string>; // State paths from $bindState/$bindItem expressions
|
||||
}
|
||||
|
||||
interface EventHandle {
|
||||
emit: () => void; // Fire the event
|
||||
shouldPreventDefault: boolean; // Whether any binding requested preventDefault
|
||||
bound: boolean; // Whether any handler is bound
|
||||
}
|
||||
```
|
||||
|
||||
Use `emit("press")` for simple event firing. Use `on("click")` when you need to check metadata like `shouldPreventDefault`:
|
||||
|
||||
```tsx
|
||||
Link: ({ props, on }) => {
|
||||
const click = on("click");
|
||||
return (
|
||||
<a
|
||||
href={props.href}
|
||||
onClick={(e) => {
|
||||
if (click.shouldPreventDefault) e.preventDefault();
|
||||
click.emit();
|
||||
}}
|
||||
>
|
||||
{props.label}
|
||||
</a>
|
||||
);
|
||||
},
|
||||
```
|
||||
|
||||
### BaseComponentProps
|
||||
|
||||
Catalog-agnostic base type for building reusable component libraries (e.g. `@json-render/shadcn`) that are not tied to a specific catalog:
|
||||
|
||||
```typescript
|
||||
import type { BaseComponentProps } from "@json-render/react";
|
||||
|
||||
const Card = ({ props, children }: BaseComponentProps<{ title?: string }>) => (
|
||||
<div>{props.title}{children}</div>
|
||||
);
|
||||
```
|
||||
|
||||
## Hooks
|
||||
|
||||
### useUIStream
|
||||
|
||||
```typescript
|
||||
const {
|
||||
spec, // Spec | null - current UI state
|
||||
isStreaming, // boolean - true while streaming
|
||||
error, // Error | null
|
||||
send, // (prompt: string, context?: Record<string, unknown>) => Promise<void>
|
||||
clear, // () => void - reset spec and error
|
||||
} = useUIStream({
|
||||
api: string, // API endpoint URL
|
||||
onComplete?: (spec: Spec) => void, // Called when streaming completes
|
||||
onError?: (error: Error) => void, // Called when an error occurs
|
||||
});
|
||||
```
|
||||
|
||||
### useStateStore
|
||||
|
||||
```typescript
|
||||
const {
|
||||
state, // StateModel (Record<string, unknown>)
|
||||
get, // (path: string) => unknown
|
||||
set, // (path: string, value: unknown) => void
|
||||
update, // (updates: Record<string, unknown>) => void
|
||||
} = useStateStore();
|
||||
```
|
||||
|
||||
### useStateValue
|
||||
|
||||
```typescript
|
||||
const value = useStateValue(path: string);
|
||||
```
|
||||
|
||||
### useStateBinding (deprecated)
|
||||
|
||||
> **Deprecated.** Use `useBoundProp` with `$bindState` expressions instead.
|
||||
|
||||
```typescript
|
||||
const [value, setValue] = useStateBinding(path: string);
|
||||
```
|
||||
|
||||
### useActions
|
||||
|
||||
```typescript
|
||||
const { execute } = useActions();
|
||||
// execute(binding: ActionBinding) => Promise<void>
|
||||
```
|
||||
|
||||
### useAction
|
||||
|
||||
```typescript
|
||||
const { execute, isLoading } = useAction(binding: ActionBinding);
|
||||
// execute() => Promise<void>
|
||||
```
|
||||
|
||||
### useIsVisible
|
||||
|
||||
```typescript
|
||||
const isVisible = useIsVisible(condition?: VisibilityCondition);
|
||||
```
|
||||
|
||||
### useFieldValidation
|
||||
|
||||
```typescript
|
||||
const {
|
||||
state, // FieldValidationState
|
||||
validate, // () => ValidationResult
|
||||
touch, // () => void
|
||||
clear, // () => void
|
||||
errors, // string[]
|
||||
isValid, // boolean
|
||||
} = useFieldValidation(path: string, config?: ValidationConfig);
|
||||
```
|
||||
|
||||
`ValidationConfig` is `{ checks?: ValidationCheck[], validateOn?: 'change' | 'blur' | 'submit' }`.
|
||||
|
||||
### useBoundProp
|
||||
|
||||
Two-way binding helper for `$bindState` / `$bindItem` expressions. Returns `[value, setValue]` where `setValue` writes back to the bound state path.
|
||||
|
||||
```typescript
|
||||
const [value, setValue] = useBoundProp<T>(
|
||||
propValue: T | undefined, // The already-resolved prop value
|
||||
bindingPath: string | undefined // From bindings?.value
|
||||
);
|
||||
```
|
||||
|
||||
Use inside registry components:
|
||||
|
||||
```tsx
|
||||
const Input: ComponentRenderer = ({ props, bindings }) => {
|
||||
const [value, setValue] = useBoundProp<string>(props.value, bindings?.value);
|
||||
return <input value={value ?? ""} onChange={(e) => setValue(e.target.value)} />;
|
||||
};
|
||||
```
|
||||
|
||||
### Chat Hooks
|
||||
|
||||
Two hooks are available for chat + GenUI, depending on your setup:
|
||||
|
||||
- **`useChatUI`** -- Self-contained chat hook with its own message state, fetch logic, and mixed stream parsing. Use when you want a standalone chat experience without the Vercel AI SDK.
|
||||
- **`useJsonRenderMessage`** -- Extracts spec + text from an AI SDK `UIMessage.parts` array. Use with the Vercel AI SDK's `useChat` for full AI SDK integration.
|
||||
|
||||
### useChatUI
|
||||
|
||||
Hook for chat + GenUI experiences. Manages a multi-turn conversation where each assistant message can contain both text and a json-render UI spec.
|
||||
|
||||
```typescript
|
||||
const {
|
||||
messages, // ChatMessage[] - all messages in the conversation
|
||||
isStreaming, // boolean - true while streaming
|
||||
error, // Error | null
|
||||
send, // (text: string) => Promise<void>
|
||||
clear, // () => void - reset conversation
|
||||
} = useChatUI({
|
||||
api: string, // API endpoint
|
||||
onComplete?: (message: ChatMessage) => void, // Called when streaming completes
|
||||
onError?: (error: Error) => void, // Called on error
|
||||
});
|
||||
|
||||
interface ChatMessage {
|
||||
id: string;
|
||||
role: "user" | "assistant";
|
||||
text: string;
|
||||
spec: Spec | null;
|
||||
}
|
||||
```
|
||||
|
||||
### useJsonRenderMessage
|
||||
|
||||
Extract a spec and text content from an AI SDK message's `parts` array. Designed for integration with Vercel AI SDK's `useChat`.
|
||||
|
||||
```typescript
|
||||
const { spec, text, hasSpec } = useJsonRenderMessage(parts: DataPart[]);
|
||||
|
||||
// spec: Spec | null - compiled from JSONL patches in data parts
|
||||
// text: string - concatenated text parts
|
||||
// hasSpec: boolean - true when spec is non-null
|
||||
```
|
||||
|
||||
### buildSpecFromParts / getTextFromParts
|
||||
|
||||
Standalone utilities for extracting spec and text from AI SDK message parts (non-hook versions):
|
||||
|
||||
```typescript
|
||||
import { buildSpecFromParts, getTextFromParts } from '@json-render/react';
|
||||
|
||||
const spec = buildSpecFromParts(message.parts); // Spec | null
|
||||
const text = getTextFromParts(message.parts); // string
|
||||
```
|
||||
@@ -1,143 +0,0 @@
|
||||
import { Code } from "@/components/code";
|
||||
|
||||
export const metadata = {
|
||||
title: "@json-render/react API | json-render",
|
||||
};
|
||||
|
||||
export default function ReactApiPage() {
|
||||
return (
|
||||
<article>
|
||||
<h1 className="text-3xl font-bold mb-4">@json-render/react</h1>
|
||||
<p className="text-muted-foreground mb-8">
|
||||
React components, providers, and hooks.
|
||||
</p>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">Providers</h2>
|
||||
|
||||
<h3 className="text-lg font-semibold mt-8 mb-4">DataProvider</h3>
|
||||
<Code lang="tsx">{`<DataProvider initialData={object}>
|
||||
{children}
|
||||
</DataProvider>`}</Code>
|
||||
|
||||
<h3 className="text-lg font-semibold mt-8 mb-4">ActionProvider</h3>
|
||||
<Code lang="tsx">{`<ActionProvider handlers={Record<string, ActionHandler>}>
|
||||
{children}
|
||||
</ActionProvider>
|
||||
|
||||
type ActionHandler = (params: Record<string, unknown>) => void | Promise<void>;`}</Code>
|
||||
|
||||
<h3 className="text-lg font-semibold mt-8 mb-4">VisibilityProvider</h3>
|
||||
<Code lang="tsx">{`<VisibilityProvider auth={AuthState}>
|
||||
{children}
|
||||
</VisibilityProvider>
|
||||
|
||||
interface AuthState {
|
||||
isSignedIn: boolean;
|
||||
roles?: string[];
|
||||
}`}</Code>
|
||||
|
||||
<h3 className="text-lg font-semibold mt-8 mb-4">ValidationProvider</h3>
|
||||
<Code lang="tsx">{`<ValidationProvider functions={Record<string, ValidatorFn>}>
|
||||
{children}
|
||||
</ValidationProvider>
|
||||
|
||||
type ValidatorFn = (value: unknown, args?: object) => boolean | Promise<boolean>;`}</Code>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">defineRegistry</h2>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
Create a type-safe component registry from a catalog. Components receive{" "}
|
||||
<code className="text-foreground">props</code>,{" "}
|
||||
<code className="text-foreground">children</code>,{" "}
|
||||
<code className="text-foreground">onAction</code>, and{" "}
|
||||
<code className="text-foreground">loading</code> with catalog-inferred
|
||||
types.
|
||||
</p>
|
||||
<Code lang="tsx">{`import { defineRegistry } from '@json-render/react';
|
||||
|
||||
const { registry } = defineRegistry(catalog, {
|
||||
components: {
|
||||
Card: ({ props, children }) => <div>{props.title}{children}</div>,
|
||||
Button: ({ props, onAction }) => (
|
||||
<button onClick={() => onAction?.({ name: props.action })}>
|
||||
{props.label}
|
||||
</button>
|
||||
),
|
||||
},
|
||||
});
|
||||
|
||||
// Pass to <Renderer>
|
||||
<Renderer spec={spec} registry={registry} />`}</Code>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">Components</h2>
|
||||
|
||||
<h3 className="text-lg font-semibold mt-8 mb-4">Renderer</h3>
|
||||
<Code lang="tsx">{`<Renderer
|
||||
spec={Spec} // The UI spec to render
|
||||
registry={Registry} // Component registry (from defineRegistry)
|
||||
loading={boolean} // Optional loading state
|
||||
fallback={Component} // Optional fallback for unknown types
|
||||
/>
|
||||
|
||||
type Registry = Record<string, React.ComponentType<ComponentRenderProps>>;`}</Code>
|
||||
|
||||
<h3 className="text-lg font-semibold mt-8 mb-4">
|
||||
Component Props (via defineRegistry)
|
||||
</h3>
|
||||
<Code lang="tsx">{`interface ComponentContext<P> {
|
||||
props: P; // Typed props from catalog
|
||||
children?: React.ReactNode; // Rendered children (for slot components)
|
||||
onAction?: (action: { name: string; params?: object }) => void;
|
||||
loading?: boolean;
|
||||
}`}</Code>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">Hooks</h2>
|
||||
|
||||
<h3 className="text-lg font-semibold mt-8 mb-4">useUIStream</h3>
|
||||
<Code lang="typescript">{`const {
|
||||
spec, // Spec - current UI state
|
||||
isStreaming, // boolean - true while streaming
|
||||
error, // Error | null
|
||||
send, // (prompt: string) => void
|
||||
abort, // () => void
|
||||
} = useUIStream({
|
||||
api: string, // API endpoint URL
|
||||
onChunk?: (chunk: string) => void, // Called for each chunk
|
||||
onFinish?: (spec: Spec) => void, // Called when streaming completes
|
||||
});`}</Code>
|
||||
|
||||
<h3 className="text-lg font-semibold mt-8 mb-4">useData</h3>
|
||||
<Code lang="typescript">{`const {
|
||||
data, // Record<string, unknown>
|
||||
setData, // (data: object) => void
|
||||
getValue, // (path: string) => unknown
|
||||
setValue, // (path: string, value: unknown) => void
|
||||
} = useData();`}</Code>
|
||||
|
||||
<h3 className="text-lg font-semibold mt-8 mb-4">useDataValue</h3>
|
||||
<Code lang="typescript">{`const value = useDataValue(path: string);`}</Code>
|
||||
|
||||
<h3 className="text-lg font-semibold mt-8 mb-4">useDataBinding</h3>
|
||||
<Code lang="typescript">{`const [value, setValue] = useDataBinding(path: string);`}</Code>
|
||||
|
||||
<h3 className="text-lg font-semibold mt-8 mb-4">useActions</h3>
|
||||
<Code lang="typescript">{`const { dispatch } = useActions();
|
||||
// dispatch(actionName: string, params: object)`}</Code>
|
||||
|
||||
<h3 className="text-lg font-semibold mt-8 mb-4">useAction</h3>
|
||||
<Code lang="typescript">{`const submitForm = useAction('submit_form');
|
||||
// submitForm(params: object)`}</Code>
|
||||
|
||||
<h3 className="text-lg font-semibold mt-8 mb-4">useIsVisible</h3>
|
||||
<Code lang="typescript">{`const isVisible = useIsVisible(condition?: VisibilityCondition);`}</Code>
|
||||
|
||||
<h3 className="text-lg font-semibold mt-8 mb-4">useFieldValidation</h3>
|
||||
<Code lang="typescript">{`const {
|
||||
value, // unknown
|
||||
setValue, // (value: unknown) => void
|
||||
errors, // string[]
|
||||
validate, // () => Promise<boolean>
|
||||
isValid, // boolean
|
||||
} = useFieldValidation(path: string, checks: ValidationCheck[]);`}</Code>
|
||||
</article>
|
||||
);
|
||||
}
|
||||
@@ -0,0 +1,241 @@
|
||||
import { pageMetadata } from "@/lib/page-metadata"
|
||||
export const metadata = pageMetadata("docs/api/remotion")
|
||||
|
||||
# @json-render/remotion
|
||||
|
||||
Remotion video renderer. Turn JSON timeline specs into video compositions.
|
||||
|
||||
## schema
|
||||
|
||||
The timeline schema for video specs. Use with `defineCatalog` from core.
|
||||
|
||||
```typescript
|
||||
import { defineCatalog } from '@json-render/core';
|
||||
import { schema, standardComponentDefinitions } from '@json-render/remotion';
|
||||
|
||||
const catalog = defineCatalog(schema, {
|
||||
components: standardComponentDefinitions,
|
||||
transitions: standardTransitionDefinitions,
|
||||
effects: standardEffectDefinitions,
|
||||
});
|
||||
```
|
||||
|
||||
## Renderer
|
||||
|
||||
The main composition component that renders timeline specs. Use with Remotion's Player or in a Remotion project.
|
||||
|
||||
```tsx
|
||||
import { Player } from '@remotion/player';
|
||||
import { Renderer } from '@json-render/remotion';
|
||||
|
||||
function VideoPlayer({ spec }) {
|
||||
return (
|
||||
<Player
|
||||
component={Renderer}
|
||||
inputProps={{ spec }}
|
||||
durationInFrames={spec.composition.durationInFrames}
|
||||
fps={spec.composition.fps}
|
||||
compositionWidth={spec.composition.width}
|
||||
compositionHeight={spec.composition.height}
|
||||
controls
|
||||
/>
|
||||
);
|
||||
}
|
||||
```
|
||||
|
||||
### Custom Components
|
||||
|
||||
Pass custom components to the Renderer:
|
||||
|
||||
```tsx
|
||||
import { Renderer, standardComponents } from '@json-render/remotion';
|
||||
|
||||
const customComponents = {
|
||||
...standardComponents,
|
||||
MyCustomClip: ({ clip }) => <div>{clip.props.text}</div>,
|
||||
};
|
||||
|
||||
<Player
|
||||
component={Renderer}
|
||||
inputProps={{ spec, components: customComponents }}
|
||||
// ...
|
||||
/>
|
||||
```
|
||||
|
||||
## Standard Components
|
||||
|
||||
Pre-built video components included in the package:
|
||||
|
||||
```typescript
|
||||
import {
|
||||
TitleCard, // Full-screen title with subtitle
|
||||
ImageSlide, // Full-screen image display
|
||||
SplitScreen, // Two-column layout
|
||||
QuoteCard, // Quote with attribution
|
||||
StatCard, // Large statistic display
|
||||
LowerThird, // Name/title overlay
|
||||
TextOverlay, // Centered text overlay
|
||||
TypingText, // Terminal typing animation
|
||||
LogoBug, // Corner logo watermark
|
||||
VideoClip, // Video playback
|
||||
} from '@json-render/remotion';
|
||||
```
|
||||
|
||||
### TitleCard Props
|
||||
|
||||
```typescript
|
||||
{
|
||||
title: string;
|
||||
subtitle?: string;
|
||||
backgroundColor?: string; // default: "#1a1a1a"
|
||||
textColor?: string; // default: "#ffffff"
|
||||
}
|
||||
```
|
||||
|
||||
### TypingText Props
|
||||
|
||||
```typescript
|
||||
{
|
||||
text: string;
|
||||
charsPerSecond?: number; // default: 15
|
||||
showCursor?: boolean; // default: true
|
||||
cursorChar?: string; // default: "|"
|
||||
fontFamily?: string; // default: "monospace"
|
||||
fontSize?: number; // default: 48
|
||||
textColor?: string; // default: "#00ff00"
|
||||
backgroundColor?: string; // default: "#1e1e1e"
|
||||
}
|
||||
```
|
||||
|
||||
## Catalog Definitions
|
||||
|
||||
Pre-built definitions for creating catalogs:
|
||||
|
||||
```typescript
|
||||
import {
|
||||
standardComponentDefinitions, // All standard component definitions
|
||||
standardTransitionDefinitions, // fade, slideLeft, slideRight, etc.
|
||||
standardEffectDefinitions, // kenBurns, pulseGlow, colorShift
|
||||
} from '@json-render/remotion';
|
||||
|
||||
// Use in your catalog
|
||||
const catalog = defineCatalog(schema, {
|
||||
components: {
|
||||
...standardComponentDefinitions,
|
||||
// Add custom components
|
||||
},
|
||||
transitions: standardTransitionDefinitions,
|
||||
effects: standardEffectDefinitions,
|
||||
});
|
||||
```
|
||||
|
||||
## Hooks & Utilities
|
||||
|
||||
### useTransition
|
||||
|
||||
Calculate transition styles for a clip based on current frame:
|
||||
|
||||
```typescript
|
||||
import { useTransition } from '@json-render/remotion';
|
||||
import { useCurrentFrame } from 'remotion';
|
||||
|
||||
function MyComponent({ clip }) {
|
||||
const frame = useCurrentFrame();
|
||||
const transition = useTransition(clip, frame);
|
||||
|
||||
return (
|
||||
<div style={{
|
||||
opacity: transition.opacity,
|
||||
transform: transition.transform,
|
||||
}}>
|
||||
Content
|
||||
</div>
|
||||
);
|
||||
}
|
||||
```
|
||||
|
||||
### ClipWrapper
|
||||
|
||||
Automatically apply transitions to clip content:
|
||||
|
||||
```tsx
|
||||
import { ClipWrapper } from '@json-render/remotion';
|
||||
|
||||
function MyClip({ clip }) {
|
||||
return (
|
||||
<ClipWrapper clip={clip}>
|
||||
<div>My content with automatic transitions</div>
|
||||
</ClipWrapper>
|
||||
);
|
||||
}
|
||||
```
|
||||
|
||||
## Types
|
||||
|
||||
### TimelineSpec
|
||||
|
||||
```typescript
|
||||
interface TimelineSpec {
|
||||
composition: {
|
||||
id: string;
|
||||
fps: number;
|
||||
width: number;
|
||||
height: number;
|
||||
durationInFrames: number;
|
||||
};
|
||||
tracks: Track[];
|
||||
clips: Clip[];
|
||||
audio: {
|
||||
tracks: AudioTrack[];
|
||||
};
|
||||
}
|
||||
```
|
||||
|
||||
### Clip
|
||||
|
||||
```typescript
|
||||
interface Clip {
|
||||
id: string;
|
||||
trackId: string;
|
||||
component: string;
|
||||
props: Record<string, unknown>;
|
||||
from: number;
|
||||
durationInFrames: number;
|
||||
transitionIn?: {
|
||||
type: string;
|
||||
durationInFrames: number;
|
||||
};
|
||||
transitionOut?: {
|
||||
type: string;
|
||||
durationInFrames: number;
|
||||
};
|
||||
}
|
||||
```
|
||||
|
||||
### TransitionStyles
|
||||
|
||||
```typescript
|
||||
interface TransitionStyles {
|
||||
opacity: number;
|
||||
transform: string;
|
||||
}
|
||||
```
|
||||
|
||||
### ComponentRegistry
|
||||
|
||||
```typescript
|
||||
type ClipComponent = React.ComponentType<{ clip: Clip }>;
|
||||
type ComponentRegistry = Record<string, ClipComponent>;
|
||||
```
|
||||
|
||||
## Transitions
|
||||
|
||||
Available transition types:
|
||||
|
||||
- `fade` - Opacity fade in/out
|
||||
- `slideLeft` - Slide from right
|
||||
- `slideRight` - Slide from left
|
||||
- `slideUp` - Slide from bottom
|
||||
- `slideDown` - Slide from top
|
||||
- `zoom` - Scale zoom in/out
|
||||
- `wipe` - Horizontal wipe
|
||||
@@ -1,240 +0,0 @@
|
||||
import { Code } from "@/components/code";
|
||||
|
||||
export const metadata = {
|
||||
title: "@json-render/remotion API | json-render",
|
||||
};
|
||||
|
||||
export default function RemotionApiPage() {
|
||||
return (
|
||||
<article>
|
||||
<h1 className="text-3xl font-bold mb-4">@json-render/remotion</h1>
|
||||
<p className="text-muted-foreground mb-8">
|
||||
Remotion video renderer. Turn JSON timeline specs into video
|
||||
compositions.
|
||||
</p>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">schema</h2>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
The timeline schema for video specs. Use with{" "}
|
||||
<code className="text-foreground">defineCatalog</code> from core.
|
||||
</p>
|
||||
<Code lang="typescript">{`import { defineCatalog } from '@json-render/core';
|
||||
import { schema, standardComponentDefinitions } from '@json-render/remotion';
|
||||
|
||||
const catalog = defineCatalog(schema, {
|
||||
components: standardComponentDefinitions,
|
||||
transitions: standardTransitionDefinitions,
|
||||
effects: standardEffectDefinitions,
|
||||
});`}</Code>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">Renderer</h2>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
The main composition component that renders timeline specs. Use with
|
||||
Remotion's Player or in a Remotion project.
|
||||
</p>
|
||||
<Code lang="tsx">{`import { Player } from '@remotion/player';
|
||||
import { Renderer } from '@json-render/remotion';
|
||||
|
||||
function VideoPlayer({ spec }) {
|
||||
return (
|
||||
<Player
|
||||
component={Renderer}
|
||||
inputProps={{ spec }}
|
||||
durationInFrames={spec.composition.durationInFrames}
|
||||
fps={spec.composition.fps}
|
||||
compositionWidth={spec.composition.width}
|
||||
compositionHeight={spec.composition.height}
|
||||
controls
|
||||
/>
|
||||
);
|
||||
}`}</Code>
|
||||
|
||||
<h3 className="text-lg font-semibold mt-8 mb-4">Custom Components</h3>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
Pass custom components to the Renderer:
|
||||
</p>
|
||||
<Code lang="tsx">{`import { Renderer, standardComponents } from '@json-render/remotion';
|
||||
|
||||
const customComponents = {
|
||||
...standardComponents,
|
||||
MyCustomClip: ({ clip }) => <div>{clip.props.text}</div>,
|
||||
};
|
||||
|
||||
<Player
|
||||
component={Renderer}
|
||||
inputProps={{ spec, components: customComponents }}
|
||||
// ...
|
||||
/>`}</Code>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">Standard Components</h2>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
Pre-built video components included in the package:
|
||||
</p>
|
||||
<Code lang="typescript">{`import {
|
||||
TitleCard, // Full-screen title with subtitle
|
||||
ImageSlide, // Full-screen image display
|
||||
SplitScreen, // Two-column layout
|
||||
QuoteCard, // Quote with attribution
|
||||
StatCard, // Large statistic display
|
||||
LowerThird, // Name/title overlay
|
||||
TextOverlay, // Centered text overlay
|
||||
TypingText, // Terminal typing animation
|
||||
LogoBug, // Corner logo watermark
|
||||
VideoClip, // Video playback
|
||||
} from '@json-render/remotion';`}</Code>
|
||||
|
||||
<h3 className="text-lg font-semibold mt-8 mb-4">TitleCard Props</h3>
|
||||
<Code lang="typescript">{`{
|
||||
title: string;
|
||||
subtitle?: string;
|
||||
backgroundColor?: string; // default: "#1a1a1a"
|
||||
textColor?: string; // default: "#ffffff"
|
||||
}`}</Code>
|
||||
|
||||
<h3 className="text-lg font-semibold mt-8 mb-4">TypingText Props</h3>
|
||||
<Code lang="typescript">{`{
|
||||
text: string;
|
||||
charsPerSecond?: number; // default: 15
|
||||
showCursor?: boolean; // default: true
|
||||
cursorChar?: string; // default: "|"
|
||||
fontFamily?: string; // default: "monospace"
|
||||
fontSize?: number; // default: 48
|
||||
textColor?: string; // default: "#00ff00"
|
||||
backgroundColor?: string; // default: "#1e1e1e"
|
||||
}`}</Code>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">Catalog Definitions</h2>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
Pre-built definitions for creating catalogs:
|
||||
</p>
|
||||
<Code lang="typescript">{`import {
|
||||
standardComponentDefinitions, // All standard component definitions
|
||||
standardTransitionDefinitions, // fade, slideLeft, slideRight, etc.
|
||||
standardEffectDefinitions, // kenBurns, pulseGlow, colorShift
|
||||
} from '@json-render/remotion';
|
||||
|
||||
// Use in your catalog
|
||||
const catalog = defineCatalog(schema, {
|
||||
components: {
|
||||
...standardComponentDefinitions,
|
||||
// Add custom components
|
||||
},
|
||||
transitions: standardTransitionDefinitions,
|
||||
effects: standardEffectDefinitions,
|
||||
});`}</Code>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">
|
||||
Hooks & Utilities
|
||||
</h2>
|
||||
|
||||
<h3 className="text-lg font-semibold mt-8 mb-4">useTransition</h3>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
Calculate transition styles for a clip based on current frame:
|
||||
</p>
|
||||
<Code lang="typescript">{`import { useTransition } from '@json-render/remotion';
|
||||
import { useCurrentFrame } from 'remotion';
|
||||
|
||||
function MyComponent({ clip }) {
|
||||
const frame = useCurrentFrame();
|
||||
const transition = useTransition(clip, frame);
|
||||
|
||||
return (
|
||||
<div style={{
|
||||
opacity: transition.opacity,
|
||||
transform: transition.transform,
|
||||
}}>
|
||||
Content
|
||||
</div>
|
||||
);
|
||||
}`}</Code>
|
||||
|
||||
<h3 className="text-lg font-semibold mt-8 mb-4">ClipWrapper</h3>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
Automatically apply transitions to clip content:
|
||||
</p>
|
||||
<Code lang="tsx">{`import { ClipWrapper } from '@json-render/remotion';
|
||||
|
||||
function MyClip({ clip }) {
|
||||
return (
|
||||
<ClipWrapper clip={clip}>
|
||||
<div>My content with automatic transitions</div>
|
||||
</ClipWrapper>
|
||||
);
|
||||
}`}</Code>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">Types</h2>
|
||||
|
||||
<h3 className="text-lg font-semibold mt-8 mb-4">TimelineSpec</h3>
|
||||
<Code lang="typescript">{`interface TimelineSpec {
|
||||
composition: {
|
||||
id: string;
|
||||
fps: number;
|
||||
width: number;
|
||||
height: number;
|
||||
durationInFrames: number;
|
||||
};
|
||||
tracks: Track[];
|
||||
clips: Clip[];
|
||||
audio: {
|
||||
tracks: AudioTrack[];
|
||||
};
|
||||
}`}</Code>
|
||||
|
||||
<h3 className="text-lg font-semibold mt-8 mb-4">Clip</h3>
|
||||
<Code lang="typescript">{`interface Clip {
|
||||
id: string;
|
||||
trackId: string;
|
||||
component: string;
|
||||
props: Record<string, unknown>;
|
||||
from: number;
|
||||
durationInFrames: number;
|
||||
transitionIn?: {
|
||||
type: string;
|
||||
durationInFrames: number;
|
||||
};
|
||||
transitionOut?: {
|
||||
type: string;
|
||||
durationInFrames: number;
|
||||
};
|
||||
}`}</Code>
|
||||
|
||||
<h3 className="text-lg font-semibold mt-8 mb-4">TransitionStyles</h3>
|
||||
<Code lang="typescript">{`interface TransitionStyles {
|
||||
opacity: number;
|
||||
transform: string;
|
||||
}`}</Code>
|
||||
|
||||
<h3 className="text-lg font-semibold mt-8 mb-4">ComponentRegistry</h3>
|
||||
<Code lang="typescript">{`type ClipComponent = React.ComponentType<{ clip: Clip }>;
|
||||
type ComponentRegistry = Record<string, ClipComponent>;`}</Code>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">Transitions</h2>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
Available transition types:
|
||||
</p>
|
||||
<ul className="list-disc list-inside text-sm text-muted-foreground space-y-1 mb-4">
|
||||
<li>
|
||||
<code className="text-foreground">fade</code> - Opacity fade in/out
|
||||
</li>
|
||||
<li>
|
||||
<code className="text-foreground">slideLeft</code> - Slide from right
|
||||
</li>
|
||||
<li>
|
||||
<code className="text-foreground">slideRight</code> - Slide from left
|
||||
</li>
|
||||
<li>
|
||||
<code className="text-foreground">slideUp</code> - Slide from bottom
|
||||
</li>
|
||||
<li>
|
||||
<code className="text-foreground">slideDown</code> - Slide from top
|
||||
</li>
|
||||
<li>
|
||||
<code className="text-foreground">zoom</code> - Scale zoom in/out
|
||||
</li>
|
||||
<li>
|
||||
<code className="text-foreground">wipe</code> - Horizontal wipe
|
||||
</li>
|
||||
</ul>
|
||||
</article>
|
||||
);
|
||||
}
|
||||
@@ -0,0 +1,176 @@
|
||||
import { pageMetadata } from "@/lib/page-metadata"
|
||||
export const metadata = pageMetadata("docs/api/shadcn")
|
||||
|
||||
# @json-render/shadcn
|
||||
|
||||
Pre-built [shadcn/ui](https://ui.shadcn.com/) components for json-render. 36 components built on Radix UI + Tailwind CSS, ready to use with `defineCatalog` and `defineRegistry`.
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
npm install @json-render/shadcn @json-render/core @json-render/react zod
|
||||
```
|
||||
|
||||
Your app must have Tailwind CSS configured.
|
||||
|
||||
## Entry Points
|
||||
|
||||
| Entry Point | Exports | Use For |
|
||||
|-------------|---------|---------|
|
||||
| `@json-render/shadcn` | `shadcnComponents` | React implementations |
|
||||
| `@json-render/shadcn/catalog` | `shadcnComponentDefinitions` | Catalog schemas (no React dependency, safe for server) |
|
||||
|
||||
## Usage
|
||||
|
||||
Pick the components you need from the standard definitions:
|
||||
|
||||
```typescript
|
||||
import { defineCatalog } from "@json-render/core";
|
||||
import { schema } from "@json-render/react/schema";
|
||||
import { shadcnComponentDefinitions } from "@json-render/shadcn/catalog";
|
||||
import { defineRegistry } from "@json-render/react";
|
||||
import { shadcnComponents } from "@json-render/shadcn";
|
||||
|
||||
// Catalog: pick definitions
|
||||
const catalog = defineCatalog(schema, {
|
||||
components: {
|
||||
Card: shadcnComponentDefinitions.Card,
|
||||
Stack: shadcnComponentDefinitions.Stack,
|
||||
Heading: shadcnComponentDefinitions.Heading,
|
||||
Button: shadcnComponentDefinitions.Button,
|
||||
Input: shadcnComponentDefinitions.Input,
|
||||
},
|
||||
actions: {},
|
||||
});
|
||||
|
||||
// Registry: pick matching implementations
|
||||
const { registry } = defineRegistry(catalog, {
|
||||
components: {
|
||||
Card: shadcnComponents.Card,
|
||||
Stack: shadcnComponents.Stack,
|
||||
Heading: shadcnComponents.Heading,
|
||||
Button: shadcnComponents.Button,
|
||||
Input: shadcnComponents.Input,
|
||||
},
|
||||
});
|
||||
```
|
||||
|
||||
State actions (`setState`, `pushState`, `removeState`) are built into the React schema and handled by `ActionProvider` automatically. You don't need to declare them in your catalog.
|
||||
|
||||
## Extending with Custom Components
|
||||
|
||||
Add custom components alongside standard ones:
|
||||
|
||||
```typescript
|
||||
import { z } from "zod";
|
||||
|
||||
const catalog = defineCatalog(schema, {
|
||||
components: {
|
||||
// Standard
|
||||
Card: shadcnComponentDefinitions.Card,
|
||||
Stack: shadcnComponentDefinitions.Stack,
|
||||
Button: shadcnComponentDefinitions.Button,
|
||||
|
||||
// Custom
|
||||
Metric: {
|
||||
props: z.object({
|
||||
label: z.string(),
|
||||
value: z.string(),
|
||||
trend: z.enum(["up", "down", "neutral"]).nullable(),
|
||||
}),
|
||||
description: "KPI metric display",
|
||||
},
|
||||
},
|
||||
actions: {},
|
||||
});
|
||||
|
||||
const { registry } = defineRegistry(catalog, {
|
||||
components: {
|
||||
Card: shadcnComponents.Card,
|
||||
Stack: shadcnComponents.Stack,
|
||||
Button: shadcnComponents.Button,
|
||||
Metric: ({ props }) => (
|
||||
<div>
|
||||
<span>{props.label}</span>
|
||||
<span>{props.value}</span>
|
||||
</div>
|
||||
),
|
||||
},
|
||||
});
|
||||
```
|
||||
|
||||
## Available Components
|
||||
|
||||
### Layout
|
||||
|
||||
| Component | Description |
|
||||
|-----------|-------------|
|
||||
| `Card` | Container card with optional title, description, maxWidth, centered |
|
||||
| `Stack` | Flex container with direction, gap, align, justify |
|
||||
| `Grid` | Grid layout with columns (1-6) and gap |
|
||||
| `Separator` | Visual separator line with orientation |
|
||||
|
||||
### Navigation
|
||||
|
||||
| Component | Description |
|
||||
|-----------|-------------|
|
||||
| `Tabs` | Tabbed navigation with tabs array, defaultValue, value |
|
||||
| `Accordion` | Collapsible sections with items array and type (single/multiple) |
|
||||
| `Collapsible` | Single collapsible section with title and defaultOpen |
|
||||
| `Pagination` | Page navigation with totalPages and page |
|
||||
|
||||
### Overlay
|
||||
|
||||
| Component | Description |
|
||||
|-----------|-------------|
|
||||
| `Dialog` | Modal dialog with title, description, openPath |
|
||||
| `Drawer` | Bottom drawer with title, description, openPath |
|
||||
| `Tooltip` | Hover tooltip with content and text |
|
||||
| `Popover` | Click-triggered popover with trigger and content |
|
||||
| `DropdownMenu` | Dropdown menu with label and items array |
|
||||
|
||||
### Content
|
||||
|
||||
| Component | Description |
|
||||
|-----------|-------------|
|
||||
| `Heading` | Heading text with level (h1-h4) |
|
||||
| `Text` | Paragraph with variant (body, caption, muted, lead, code) |
|
||||
| `Image` | Image with alt, width, height |
|
||||
| `Avatar` | User avatar with src, name, size |
|
||||
| `Badge` | Status badge with text and variant |
|
||||
| `Alert` | Alert banner with title, message, type |
|
||||
| `Carousel` | Horizontally scrollable carousel with items |
|
||||
| `Table` | Data table with columns and rows |
|
||||
|
||||
### Feedback
|
||||
|
||||
| Component | Description |
|
||||
|-----------|-------------|
|
||||
| `Progress` | Progress bar with value, max, label |
|
||||
| `Skeleton` | Loading placeholder with width, height, rounded |
|
||||
| `Spinner` | Loading spinner with size and label |
|
||||
|
||||
### Input
|
||||
|
||||
| Component | Description |
|
||||
|-----------|-------------|
|
||||
| `Button` | Clickable button with label, variant, disabled |
|
||||
| `Link` | Anchor link with label and href |
|
||||
| `Input` | Text input with label, name, type, placeholder, value, checks |
|
||||
| `Textarea` | Multi-line text input with label, name, placeholder, rows, value, checks |
|
||||
| `Select` | Dropdown select with label, name, options, value, checks |
|
||||
| `Checkbox` | Checkbox with label, name, checked |
|
||||
| `Radio` | Radio button group with label, name, options, value |
|
||||
| `Switch` | Toggle switch with label, name, checked |
|
||||
| `Slider` | Range slider with label, min, max, step, value |
|
||||
| `Toggle` | Toggle button with label, pressed, variant |
|
||||
| `ToggleGroup` | Group of toggle buttons with items, type, value |
|
||||
| `ButtonGroup` | Group of buttons with buttons array and selected |
|
||||
|
||||
## Notes
|
||||
|
||||
- The `/catalog` entry point has no React dependency -- use it for server-side prompt generation
|
||||
- Components use Tailwind CSS classes -- your app must have Tailwind configured
|
||||
- Component implementations use bundled shadcn/ui primitives (not your app's `components/ui/`)
|
||||
- Form inputs support `checks` for validation (type + message pairs)
|
||||
- Events: inputs emit `change`/`submit`/`focus`/`blur`; buttons emit `press`; selects emit `change`/`select`
|
||||
@@ -0,0 +1,101 @@
|
||||
import { pageMetadata } from "@/lib/page-metadata"
|
||||
export const metadata = pageMetadata("docs/catalog")
|
||||
|
||||
# Catalog
|
||||
|
||||
The catalog defines what AI can generate. It's your guardrail.
|
||||
|
||||
## What is a Catalog?
|
||||
|
||||
A catalog is the vocabulary for your UI. While the [schema](/docs/schemas) defines the grammar (how specs are structured), the catalog defines the vocabulary (what components and actions are available). It lists:
|
||||
|
||||
- **Components** — UI elements AI can create (with props and optional slots)
|
||||
- **Actions** — Operations AI can trigger
|
||||
- **Functions** — Custom validation or transformation functions
|
||||
|
||||
## Creating a Catalog
|
||||
|
||||
`defineCatalog` is from `@json-render/core`. The `schema` import comes from your platform package (`@json-render/react` or `@json-render/react-native`) and defines the element structure the catalog targets. The catalog definition itself is framework-agnostic.
|
||||
|
||||
```typescript
|
||||
import { defineCatalog } from '@json-render/core';
|
||||
import { schema } from '@json-render/react/schema'; // or '@json-render/react-native/schema'
|
||||
import { z } from 'zod';
|
||||
|
||||
const catalog = defineCatalog(schema, {
|
||||
components: {
|
||||
// Define each component with its props schema
|
||||
Card: {
|
||||
props: z.object({
|
||||
title: z.string(),
|
||||
description: z.string().nullable(),
|
||||
padding: z.enum(['sm', 'md', 'lg']).nullable(),
|
||||
}),
|
||||
slots: ["default"], // Can contain other components
|
||||
description: "Container card for grouping content",
|
||||
},
|
||||
|
||||
Metric: {
|
||||
props: z.object({
|
||||
label: z.string(),
|
||||
value: z.union([z.string(), z.number()]),
|
||||
format: z.enum(['currency', 'percent', 'number']),
|
||||
}),
|
||||
description: "Display a single metric value",
|
||||
},
|
||||
},
|
||||
|
||||
actions: {
|
||||
submit_form: {
|
||||
params: z.object({
|
||||
formId: z.string(),
|
||||
}),
|
||||
description: 'Submit a form',
|
||||
},
|
||||
|
||||
export_data: {
|
||||
params: z.object({
|
||||
format: z.enum(['csv', 'pdf', 'json']),
|
||||
}),
|
||||
description: 'Export data in various formats',
|
||||
},
|
||||
},
|
||||
});
|
||||
```
|
||||
|
||||
## Component Definition
|
||||
|
||||
Each component in the catalog has:
|
||||
|
||||
```typescript
|
||||
{
|
||||
props: z.object({...}), // Zod schema for props (use .nullable() for optional)
|
||||
slots?: string[], // Named slots for children (e.g., ["default"])
|
||||
description?: string, // Help AI understand when to use it
|
||||
}
|
||||
```
|
||||
|
||||
Use `slots: ["default"]` for components that can contain children. The slot name corresponds to where child elements are rendered.
|
||||
|
||||
## Generating AI Prompts
|
||||
|
||||
Use the `catalog.prompt()` method to generate a system prompt for AI:
|
||||
|
||||
```typescript
|
||||
// Generate a system prompt from your catalog
|
||||
const systemPrompt = catalog.prompt();
|
||||
|
||||
// Or with custom rules for the AI
|
||||
const customPrompt = catalog.prompt({
|
||||
customRules: [
|
||||
"Always use Card as the root element for forms",
|
||||
"Group related inputs in a Stack with direction=vertical",
|
||||
],
|
||||
});
|
||||
|
||||
// Pass this to your AI model as the system prompt
|
||||
```
|
||||
|
||||
## Next
|
||||
|
||||
Learn how to [register components](/docs/registry) in your registry.
|
||||
@@ -1,126 +0,0 @@
|
||||
import Link from "next/link";
|
||||
import { Code } from "@/components/code";
|
||||
|
||||
export const metadata = {
|
||||
title: "Catalog | json-render",
|
||||
};
|
||||
|
||||
export default function CatalogPage() {
|
||||
return (
|
||||
<article>
|
||||
<h1 className="text-3xl font-bold mb-4">Catalog</h1>
|
||||
<p className="text-muted-foreground mb-8">
|
||||
The catalog defines what AI can generate. It's your guardrail.
|
||||
</p>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">What is a Catalog?</h2>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
A catalog is a schema that defines:
|
||||
</p>
|
||||
<ul className="list-disc list-inside text-sm text-muted-foreground space-y-1 mb-4">
|
||||
<li>
|
||||
<strong className="text-foreground">Components</strong> — UI elements
|
||||
AI can create (with props and optional slots)
|
||||
</li>
|
||||
<li>
|
||||
<strong className="text-foreground">Actions</strong> — Operations AI
|
||||
can trigger
|
||||
</li>
|
||||
<li>
|
||||
<strong className="text-foreground">Functions</strong> — Custom
|
||||
validation or transformation functions
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">Creating a Catalog</h2>
|
||||
<Code lang="typescript">{`import { defineCatalog } from '@json-render/core';
|
||||
import { schema } from '@json-render/react';
|
||||
import { z } from 'zod';
|
||||
|
||||
const catalog = defineCatalog(schema, {
|
||||
components: {
|
||||
// Define each component with its props schema
|
||||
Card: {
|
||||
props: z.object({
|
||||
title: z.string(),
|
||||
description: z.string().nullable(),
|
||||
padding: z.enum(['sm', 'md', 'lg']).nullable(),
|
||||
}),
|
||||
slots: ["default"], // Can contain other components
|
||||
description: "Container card for grouping content",
|
||||
},
|
||||
|
||||
Metric: {
|
||||
props: z.object({
|
||||
label: z.string(),
|
||||
valuePath: z.string(), // JSON Pointer to data
|
||||
format: z.enum(['currency', 'percent', 'number']),
|
||||
}),
|
||||
description: "Display a single metric value",
|
||||
},
|
||||
},
|
||||
|
||||
actions: {
|
||||
submit_form: {
|
||||
params: z.object({
|
||||
formId: z.string(),
|
||||
}),
|
||||
description: 'Submit a form',
|
||||
},
|
||||
|
||||
export_data: {
|
||||
params: z.object({
|
||||
format: z.enum(['csv', 'pdf', 'json']),
|
||||
}),
|
||||
description: 'Export data in various formats',
|
||||
},
|
||||
},
|
||||
});`}</Code>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">Component Definition</h2>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
Each component in the catalog has:
|
||||
</p>
|
||||
<Code lang="typescript">{`{
|
||||
props: z.object({...}), // Zod schema for props (use .nullable() for optional)
|
||||
slots?: string[], // Named slots for children (e.g., ["default"])
|
||||
description?: string, // Help AI understand when to use it
|
||||
}`}</Code>
|
||||
<p className="text-sm text-muted-foreground mt-4 mb-4">
|
||||
Use{" "}
|
||||
<code className="text-foreground">slots: ["default"]</code>{" "}
|
||||
for components that can contain children. The slot name corresponds to
|
||||
where child elements are rendered.
|
||||
</p>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">
|
||||
Generating AI Prompts
|
||||
</h2>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
Use the <code className="text-foreground">catalog.prompt()</code> method
|
||||
to generate a system prompt for AI:
|
||||
</p>
|
||||
<Code lang="typescript">{`// Generate a system prompt from your catalog
|
||||
const systemPrompt = catalog.prompt();
|
||||
|
||||
// Or with custom rules for the AI
|
||||
const customPrompt = catalog.prompt({
|
||||
customRules: [
|
||||
"Always use Card as the root element for forms",
|
||||
"Group related inputs in a Stack with direction=vertical",
|
||||
],
|
||||
});
|
||||
|
||||
// Pass this to your AI model as the system prompt`}</Code>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">Next</h2>
|
||||
<p className="text-sm text-muted-foreground">
|
||||
Learn how to{" "}
|
||||
<Link href="/docs/registry" className="text-foreground hover:underline">
|
||||
register components
|
||||
</Link>{" "}
|
||||
in your registry.
|
||||
</p>
|
||||
</article>
|
||||
);
|
||||
}
|
||||
@@ -0,0 +1,633 @@
|
||||
import { pageMetadata } from "@/lib/page-metadata"
|
||||
export const metadata = pageMetadata("docs/changelog")
|
||||
|
||||
# Changelog
|
||||
|
||||
Notable changes and updates to json-render.
|
||||
|
||||
## v0.9.0
|
||||
|
||||
February 2026
|
||||
|
||||
### New: External State Store
|
||||
|
||||
The `StateStore` interface lets you plug in your own state management (Redux, Zustand, Jotai, XState, etc.) instead of the built-in internal store. Pass a `store` prop to `StateProvider`, `JSONUIProvider`, or `createRenderer` for controlled mode.
|
||||
|
||||
- Added `StateStore` interface and `createStateStore()` factory to `@json-render/core`
|
||||
- `StateProvider`, `JSONUIProvider`, and `createRenderer` now accept an optional `store` prop
|
||||
- When `store` is provided, it becomes the single source of truth (`initialState`/`onStateChange` are ignored)
|
||||
- When `store` is omitted, everything works exactly as before (fully backward compatible)
|
||||
- Applied across all platform packages: react, react-native, react-pdf
|
||||
- Store utilities (`createStoreAdapter`, `immutableSetByPath`, `flattenToPointers`) available via `@json-render/core/store-utils` for building custom adapters
|
||||
|
||||
New adapter packages: `@json-render/redux`, `@json-render/zustand`, `@json-render/jotai`.
|
||||
|
||||
See the [Data Binding](/docs/data-binding#external-store-controlled-mode) guide for usage.
|
||||
|
||||
### Changed: `onStateChange` signature updated (breaking)
|
||||
|
||||
The `onStateChange` callback now receives a single array of changed entries instead of being called once per path. This makes batch updates via `update()` easier to handle:
|
||||
|
||||
```ts
|
||||
// Before
|
||||
onStateChange?: (path: string, value: unknown) => void
|
||||
|
||||
// After
|
||||
onStateChange?: (changes: Array<{ path: string; value: unknown }>) => void
|
||||
```
|
||||
|
||||
The callback is only called when a `set()` or `update()` call actually changes the state. A `set()` call produces a single-element array; an `update()` call produces one array with all changed paths.
|
||||
|
||||
### Fixed: Server-safe schema import
|
||||
|
||||
`@json-render/react` barrel-imports React contexts that call `createContext`, which crashes in Next.js App Router API routes (RSC runtime strips `createContext`). All docs, examples, and skills now import `schema` from `@json-render/react/schema` instead of `@json-render/react`.
|
||||
|
||||
For combined imports, split into separate `schema` (subpath) and client API (main entry) lines:
|
||||
|
||||
```ts
|
||||
import { schema } from "@json-render/react/schema";
|
||||
import { defineRegistry, Renderer } from "@json-render/react";
|
||||
```
|
||||
|
||||
### Fixed: Chaining actions
|
||||
|
||||
Fixed an issue where chaining multiple actions on the same event (e.g. `setState` followed by a custom action) did not execute all actions. Affected `@json-render/react`, `@json-render/react-native`, and `@json-render/react-pdf`.
|
||||
|
||||
### Fixed: Zod array inner type resolution
|
||||
|
||||
Fixed safely resolving the inner type for Zod arrays in schema introspection, preventing errors when catalog component props use `z.array()`.
|
||||
|
||||
---
|
||||
|
||||
## v0.8.0
|
||||
|
||||
February 2026
|
||||
|
||||
### New: `@json-render/react-pdf`
|
||||
|
||||
PDF renderer for json-render, powered by [`@react-pdf/renderer`](https://react-pdf.org/). Define catalogs and registries the same way as `@json-render/react`, but output PDF documents instead of web UI.
|
||||
|
||||
```bash
|
||||
npm install @json-render/core @json-render/react-pdf
|
||||
```
|
||||
|
||||
```typescript
|
||||
import { renderToBuffer } from "@json-render/react-pdf";
|
||||
import type { Spec } from "@json-render/core";
|
||||
|
||||
const spec: Spec = {
|
||||
root: "doc",
|
||||
elements: {
|
||||
doc: { type: "Document", props: { title: "Invoice" }, children: ["page"] },
|
||||
page: {
|
||||
type: "Page",
|
||||
props: { size: "A4" },
|
||||
children: ["heading", "table"],
|
||||
},
|
||||
heading: {
|
||||
type: "Heading",
|
||||
props: { text: "Invoice #1234", level: "h1" },
|
||||
children: [],
|
||||
},
|
||||
table: {
|
||||
type: "Table",
|
||||
props: {
|
||||
columns: [
|
||||
{ header: "Item", width: "60%" },
|
||||
{ header: "Price", width: "40%", align: "right" },
|
||||
],
|
||||
rows: [
|
||||
["Widget A", "$10.00"],
|
||||
["Widget B", "$25.00"],
|
||||
],
|
||||
},
|
||||
children: [],
|
||||
},
|
||||
},
|
||||
};
|
||||
|
||||
const buffer = await renderToBuffer(spec);
|
||||
```
|
||||
|
||||
Server-side rendering APIs:
|
||||
|
||||
- `renderToBuffer(spec)` -- render to an in-memory PDF buffer
|
||||
- `renderToStream(spec)` -- render to a readable stream (pipe to HTTP response)
|
||||
- `renderToFile(spec, path)` -- render directly to a file
|
||||
|
||||
15 standard components covering document structure (Document, Page), layout (View, Row, Column), content (Heading, Text, Image, Link), data (Table, List), decorative (Divider, Spacer), and page-level (PageNumber).
|
||||
|
||||
Supports custom catalogs with `defineRegistry`, server-safe imports via `@json-render/react-pdf/server`, and full context support (state, visibility, actions, validation, repeat scopes).
|
||||
|
||||
---
|
||||
|
||||
## v0.7.0
|
||||
|
||||
February 2026
|
||||
|
||||
### New: `@json-render/shadcn`
|
||||
|
||||
Pre-built [shadcn/ui](https://ui.shadcn.com/) component library for json-render. 36 components built on Radix UI + Tailwind CSS, ready to use with `defineCatalog` and `defineRegistry`.
|
||||
|
||||
```bash
|
||||
npm install @json-render/shadcn
|
||||
```
|
||||
|
||||
```typescript
|
||||
import { defineCatalog } from "@json-render/core";
|
||||
import { schema } from "@json-render/react/schema";
|
||||
import { shadcnComponentDefinitions } from "@json-render/shadcn/catalog";
|
||||
import { defineRegistry } from "@json-render/react";
|
||||
import { shadcnComponents } from "@json-render/shadcn";
|
||||
|
||||
const catalog = defineCatalog(schema, {
|
||||
components: {
|
||||
Card: shadcnComponentDefinitions.Card,
|
||||
Button: shadcnComponentDefinitions.Button,
|
||||
Input: shadcnComponentDefinitions.Input,
|
||||
},
|
||||
actions: {},
|
||||
});
|
||||
|
||||
const { registry } = defineRegistry(catalog, {
|
||||
components: {
|
||||
Card: shadcnComponents.Card,
|
||||
Button: shadcnComponents.Button,
|
||||
Input: shadcnComponents.Input,
|
||||
},
|
||||
});
|
||||
```
|
||||
|
||||
Components include: layout (Card, Stack, Grid, Separator), navigation (Tabs, Accordion, Collapsible, Pagination), overlay (Dialog, Drawer, Tooltip, Popover, DropdownMenu), content (Heading, Text, Image, Avatar, Badge, Alert, Carousel, Table), feedback (Progress, Skeleton, Spinner), and input (Button, Link, Input, Textarea, Select, Checkbox, Radio, Switch, Slider, Toggle, ToggleGroup, ButtonGroup).
|
||||
|
||||
See the [API reference](/docs/api/shadcn) for full details.
|
||||
|
||||
### New: Event Handles (`on()`)
|
||||
|
||||
Components now receive an `on(event)` function in addition to `emit(event)`. The `on()` function returns an `EventHandle` with metadata:
|
||||
|
||||
- `emit()` -- fire the event
|
||||
- `shouldPreventDefault` -- whether any action binding requested `preventDefault`
|
||||
- `bound` -- whether any handler is bound to this event
|
||||
|
||||
```tsx
|
||||
Link: ({ props, on }) => {
|
||||
const click = on("click");
|
||||
return (
|
||||
<a href={props.href} onClick={(e) => {
|
||||
if (click.shouldPreventDefault) e.preventDefault();
|
||||
click.emit();
|
||||
}}>{props.label}</a>
|
||||
);
|
||||
},
|
||||
```
|
||||
|
||||
### New: `BaseComponentProps`
|
||||
|
||||
Catalog-agnostic base type for component render functions. Use when building reusable component libraries (like `@json-render/shadcn`) that are not tied to a specific catalog.
|
||||
|
||||
```typescript
|
||||
import type { BaseComponentProps } from "@json-render/react";
|
||||
|
||||
const Card = ({ props, children }: BaseComponentProps<{ title?: string }>) => (
|
||||
<div>{props.title}{children}</div>
|
||||
);
|
||||
```
|
||||
|
||||
### New: Built-in Actions in Schema
|
||||
|
||||
Schemas can now declare `builtInActions` -- actions that are always available at runtime and automatically injected into prompts. The React schema declares `setState`, `pushState`, and `removeState` as built-in, so they appear in prompts without needing to be listed in catalog `actions`.
|
||||
|
||||
### New: `preventDefault` on `ActionBinding`
|
||||
|
||||
Action bindings now support a `preventDefault` boolean field, allowing the LLM to request that default browser behavior (e.g. navigation on links) be prevented.
|
||||
|
||||
### Improved: Stream Transform Text Block Splitting
|
||||
|
||||
`createJsonRenderTransform()` now properly splits text blocks around spec data by emitting `text-end`/`text-start` pairs. This ensures the AI SDK creates separate text parts, preserving correct interleaving of prose and UI in `message.parts`.
|
||||
|
||||
### Improved: `defineRegistry` Actions Requirement
|
||||
|
||||
`defineRegistry` now conditionally requires the `actions` field only when the catalog declares actions. Catalogs with no actions (e.g. `actions: {}`) no longer need to pass an empty actions object.
|
||||
|
||||
---
|
||||
|
||||
## v0.6.0
|
||||
|
||||
February 2026
|
||||
|
||||
### New: Chat Mode (Inline GenUI)
|
||||
|
||||
json-render now supports two generation modes: **Generate** (JSONL-only, the default) and **Chat** (text + JSONL inline). Chat mode lets the AI respond conversationally with embedded UI specs, ideal for chatbots and copilot experiences.
|
||||
|
||||
```typescript
|
||||
// Generate mode (default) — AI outputs only JSONL
|
||||
const prompt = catalog.prompt();
|
||||
|
||||
// Chat mode — AI outputs text + JSONL inline
|
||||
const chatPrompt = catalog.prompt({ mode: "chat" });
|
||||
```
|
||||
|
||||
On the server, `pipeJsonRender()` separates text from JSONL patches in a mixed stream:
|
||||
|
||||
```typescript
|
||||
import { pipeJsonRender } from "@json-render/core";
|
||||
import { createUIMessageStream, createUIMessageStreamResponse } from "ai";
|
||||
|
||||
const stream = createUIMessageStream({
|
||||
execute: async ({ writer }) => {
|
||||
writer.merge(pipeJsonRender(result.toUIMessageStream()));
|
||||
},
|
||||
});
|
||||
return createUIMessageStreamResponse({ stream });
|
||||
```
|
||||
|
||||
On the client, `useJsonRenderMessage` extracts the spec and text from message parts:
|
||||
|
||||
```tsx
|
||||
import { useJsonRenderMessage } from "@json-render/react";
|
||||
|
||||
function ChatMessage({ message }) {
|
||||
const { spec, text, hasSpec } = useJsonRenderMessage(message.parts);
|
||||
return (
|
||||
<div>
|
||||
{text && <Markdown>{text}</Markdown>}
|
||||
{hasSpec && <Renderer spec={spec} registry={registry} />}
|
||||
</div>
|
||||
);
|
||||
}
|
||||
```
|
||||
|
||||
### New: AI SDK Integration
|
||||
|
||||
First-class Vercel AI SDK support with typed data parts and stream utilities.
|
||||
|
||||
- `SpecDataPart` type for `data-spec` stream parts (patch, flat, nested payloads)
|
||||
- `SPEC_DATA_PART` / `SPEC_DATA_PART_TYPE` constants for type-safe part filtering
|
||||
- `createJsonRenderTransform()` low-level TransformStream for custom pipelines
|
||||
- `createMixedStreamParser()` for parsing mixed text + JSONL streams
|
||||
|
||||
### New: Two-Way Binding
|
||||
|
||||
Props can now use `$bindState` and `$bindItem` expressions for two-way data binding. The renderer resolves bindings and passes a `bindings` map to components, enabling write-back to state without custom `valuePath` props.
|
||||
|
||||
```json
|
||||
{
|
||||
"type": "Input",
|
||||
"props": { "label": "Email", "value": { "$bindState": "/form/email" } }
|
||||
}
|
||||
```
|
||||
|
||||
```tsx
|
||||
import { useBoundProp } from "@json-render/react";
|
||||
|
||||
Input: ({ props, bindings }) => {
|
||||
const [value, setValue] = useBoundProp<string>(props.value, bindings?.value);
|
||||
return <input value={value ?? ""} onChange={(e) => setValue(e.target.value)} />;
|
||||
}
|
||||
```
|
||||
|
||||
### New: Expression-Based Props and Visibility
|
||||
|
||||
All dynamic expressions now use structured `$state`, `$item`, and `$index` objects instead of string token rewriting. This is simpler, more explicit, and works for both props and visibility conditions.
|
||||
|
||||
**Props:**
|
||||
|
||||
```json
|
||||
{ "title": { "$state": "/user/name" } }
|
||||
{ "label": { "$item": "title" } }
|
||||
{ "position": { "$index": true } }
|
||||
```
|
||||
|
||||
**Visibility:**
|
||||
|
||||
```json
|
||||
{ "$state": "/isAdmin" }
|
||||
{ "$state": "/role", "eq": "admin" }
|
||||
[{ "$state": "/isAdmin" }, { "$state": "/feature" }]
|
||||
{ "$or": [{ "$state": "/roleA" }, { "$state": "/roleB" }] }
|
||||
{ "$item": "isActive" }
|
||||
{ "$index": true, "gt": 0 }
|
||||
```
|
||||
|
||||
Comparison operators: `eq`, `neq`, `gt`, `gte`, `lt`, `lte`, `not`.
|
||||
|
||||
### New: React Chat Hooks
|
||||
|
||||
- `useChatUI()` — full chat hook with message history, streaming, and spec extraction
|
||||
- `useJsonRenderMessage()` — extract spec + text from a message's parts array
|
||||
- `buildSpecFromParts()` / `getTextFromParts()` — utilities for working with AI SDK message parts
|
||||
- `useBoundProp()` — two-way binding hook for `$bindState` / `$bindItem`
|
||||
|
||||
### New: Chat Example
|
||||
|
||||
Full-featured chat example (`examples/chat`) with AI agent, tool calls (crypto, GitHub, Hacker News, weather, search), theme toggle, and streaming inline UI generation.
|
||||
|
||||
### Improved: Renderer Performance
|
||||
|
||||
- `ElementRenderer` is now `React.memo`'d for better performance with repeat lists
|
||||
- `emit` is always defined (never `undefined`)
|
||||
- Repeat scope passes the actual item object, eliminating string token rewriting
|
||||
|
||||
### Improved: Utilities
|
||||
|
||||
- `applySpecPatch()` — typed wrapper for applying a single patch to a Spec
|
||||
- `nestedToFlat()` — convert nested tree specs to flat format
|
||||
- `resolveBindings()` / `resolveActionParam()` — resolve binding paths and action params
|
||||
|
||||
### Breaking Changes
|
||||
|
||||
- `{ $path }` and `{ path }` replaced by `{ $state }`, `{ $item }`, `{ $index }` in props
|
||||
- Visibility: `{ path }` -> `{ $state }`, `{ and/or/not }` -> `{ $and/$or }` with `not` as operator flag
|
||||
- `DynamicValue`: `{ path: string }` -> `{ $state: string }`
|
||||
- `repeat.path` -> `repeat.statePath`
|
||||
- Action params: `path` -> `statePath` in setState action
|
||||
- `actionHandlers` -> `handlers` on `JSONUIProvider` / `ActionProvider`
|
||||
- `AuthState` and `{ auth }` visibility conditions removed (model auth as regular state)
|
||||
- Legacy catalog API removed: `createCatalog`, `generateCatalogPrompt`, `generateSystemPrompt`
|
||||
- React exports removed: `createRendererFromCatalog`, `rewriteRepeatTokens`
|
||||
- Codegen: `traverseTree` -> `traverseSpec`
|
||||
|
||||
See the [Migration Guide](/docs/migration) for detailed upgrade instructions.
|
||||
|
||||
---
|
||||
|
||||
## v0.5.0
|
||||
|
||||
February 2026
|
||||
|
||||
### New: @json-render/react-native
|
||||
|
||||
Full React Native renderer with 25+ standard components, data binding, visibility, actions, and dynamic props. Build AI-generated native mobile UIs with the same catalog-driven approach as web.
|
||||
|
||||
```tsx
|
||||
import { defineCatalog } from "@json-render/core";
|
||||
import { schema } from "@json-render/react-native/schema";
|
||||
import {
|
||||
standardComponentDefinitions,
|
||||
standardActionDefinitions,
|
||||
} from "@json-render/react-native/catalog";
|
||||
import { defineRegistry, Renderer } from "@json-render/react-native";
|
||||
|
||||
const catalog = defineCatalog(schema, {
|
||||
components: { ...standardComponentDefinitions },
|
||||
actions: standardActionDefinitions,
|
||||
});
|
||||
|
||||
const { registry } = defineRegistry(catalog, { components: {} });
|
||||
|
||||
<Renderer spec={spec} registry={registry} />
|
||||
```
|
||||
|
||||
Includes standard components for layout (Container, Row, Column, ScrollContainer, SafeArea, Pressable, Spacer, Divider), content (Heading, Paragraph, Label, Image, Avatar, Badge, Chip), input (Button, TextInput, Switch, Checkbox, Slider, SearchBar), feedback (Spinner, ProgressBar), and composite (Card, ListItem, Modal).
|
||||
|
||||
### New: Event System
|
||||
|
||||
Components now use `emit` to fire named events instead of directly dispatching actions. The element's `on` field maps events to action bindings, decoupling component logic from action handling.
|
||||
|
||||
```tsx
|
||||
// Component emits a named event
|
||||
Button: ({ props, emit }) => (
|
||||
<button onClick={() => emit("press")}>{props.label}</button>
|
||||
),
|
||||
|
||||
// Element spec maps events to actions
|
||||
{
|
||||
"type": "Button",
|
||||
"props": { "label": "Submit" },
|
||||
"on": { "press": { "action": "submit", "params": { "formId": "main" } } }
|
||||
}
|
||||
```
|
||||
|
||||
### New: Repeat/List Rendering
|
||||
|
||||
Elements can now iterate over state arrays using the `repeat` field. Child elements use `{ "$item": "field" }` to read from the current item and `{ "$index": true }` for the current array index.
|
||||
|
||||
```json
|
||||
{
|
||||
"type": "Column",
|
||||
"repeat": { "statePath": "/posts", "key": "id" },
|
||||
"children": ["post-card"]
|
||||
}
|
||||
```
|
||||
|
||||
```json
|
||||
{
|
||||
"type": "Card",
|
||||
"props": { "title": { "$item": "title" } }
|
||||
}
|
||||
```
|
||||
|
||||
### New: User Prompt Builder
|
||||
|
||||
Build structured user prompts with optional spec refinement and state context:
|
||||
|
||||
```typescript
|
||||
import { buildUserPrompt } from "@json-render/core";
|
||||
|
||||
// Fresh generation
|
||||
buildUserPrompt({ prompt: "create a todo app" });
|
||||
|
||||
// Refinement (patch-only mode)
|
||||
buildUserPrompt({ prompt: "add a toggle", currentSpec: spec });
|
||||
|
||||
// With runtime state
|
||||
buildUserPrompt({ prompt: "show data", state: { todos: [] } });
|
||||
```
|
||||
|
||||
### New: Spec Validation
|
||||
|
||||
Validate spec structure and auto-fix common issues:
|
||||
|
||||
```typescript
|
||||
import { validateSpec, autoFixSpec } from "@json-render/core";
|
||||
|
||||
const { valid, issues } = validateSpec(spec);
|
||||
const fixed = autoFixSpec(spec);
|
||||
```
|
||||
|
||||
### Improved: State Management
|
||||
|
||||
`DataProvider` has been renamed to `StateProvider` with a clearer API. State is now a first-class part of specs. Elements can bind to state via `$state` expressions, and the built-in `setState` action updates state directly.
|
||||
|
||||
### Improved: AI Prompts
|
||||
|
||||
Schema prompts now include streaming best practices, repeat/list examples, and state patching guidance. Schemas can also define `defaultRules` that are always included in generated prompts.
|
||||
|
||||
### Improved: Documentation
|
||||
|
||||
- All documentation pages migrated to MDX
|
||||
- AI-powered documentation chat
|
||||
- Dynamic Open Graph images for all docs pages
|
||||
- Improved playground
|
||||
|
||||
### Breaking Changes
|
||||
|
||||
- `DataProvider` renamed to `StateProvider`
|
||||
- `useData` renamed to `useStateStore`, `useDataValue` to `useStateValue`, `useDataBinding` to `useStateBinding`
|
||||
- `onAction` renamed to `emit` in component context
|
||||
- `DataModel` type renamed to `StateModel`
|
||||
- `Action` type renamed to `ActionBinding` (old name still available but deprecated)
|
||||
|
||||
---
|
||||
|
||||
## v0.4.0
|
||||
|
||||
February 2026
|
||||
|
||||
### New: Custom Schema System
|
||||
|
||||
Create custom output formats with `defineSchema`. Each renderer now defines its own schema, enabling completely different spec formats for different use cases.
|
||||
|
||||
```typescript
|
||||
import { defineSchema } from "@json-render/core";
|
||||
|
||||
const mySchema = defineSchema((s) => ({
|
||||
spec: s.object({
|
||||
pages: s.array(s.object({
|
||||
title: s.string(),
|
||||
blocks: s.array(s.ref("catalog.blocks")),
|
||||
})),
|
||||
}),
|
||||
catalog: s.object({
|
||||
blocks: s.map({ props: s.zod(), description: s.string() }),
|
||||
}),
|
||||
}), {
|
||||
promptTemplate: myPromptTemplate,
|
||||
});
|
||||
```
|
||||
|
||||
### New: Component Slots
|
||||
|
||||
Components can now define which slots they accept. Use `["default"]` for regular children, or named slots like `["header", "footer"]` for more complex layouts.
|
||||
|
||||
```typescript
|
||||
const catalog = defineCatalog(schema, {
|
||||
components: {
|
||||
Card: {
|
||||
props: z.object({ title: z.string() }),
|
||||
slots: ["default"], // accepts children
|
||||
description: "A card container",
|
||||
},
|
||||
Layout: {
|
||||
props: z.object({}),
|
||||
slots: ["header", "content", "footer"], // named slots
|
||||
description: "Page layout with header, content, footer",
|
||||
},
|
||||
},
|
||||
});
|
||||
```
|
||||
|
||||
### New: AI Prompt Generation
|
||||
|
||||
Catalogs now generate AI system prompts automatically with `catalog.prompt()`. The prompt includes all component definitions, props schemas, and action descriptions - ensuring the AI only generates valid specs.
|
||||
|
||||
```typescript
|
||||
import { defineCatalog } from "@json-render/core";
|
||||
import { schema } from "@json-render/react/schema";
|
||||
|
||||
const catalog = defineCatalog(schema, {
|
||||
components: { /* ... */ },
|
||||
actions: { /* ... */ },
|
||||
});
|
||||
|
||||
// Generate system prompt for AI
|
||||
const systemPrompt = catalog.prompt();
|
||||
|
||||
// Use with any AI SDK
|
||||
const result = await streamText({
|
||||
model: "claude-haiku-4.5",
|
||||
system: systemPrompt,
|
||||
prompt: userMessage,
|
||||
});
|
||||
```
|
||||
|
||||
### New: @json-render/remotion
|
||||
|
||||
Generate AI-powered videos with Remotion. Define video catalogs, stream timeline specs, and render with the Remotion Player.
|
||||
|
||||
```tsx
|
||||
import { Player } from "@remotion/player";
|
||||
import { Renderer, schema, standardComponentDefinitions } from "@json-render/remotion";
|
||||
|
||||
const catalog = defineCatalog(schema, {
|
||||
components: standardComponentDefinitions,
|
||||
transitions: standardTransitionDefinitions,
|
||||
});
|
||||
|
||||
<Player
|
||||
component={Renderer}
|
||||
inputProps={{ spec }}
|
||||
durationInFrames={spec.composition.durationInFrames}
|
||||
fps={spec.composition.fps}
|
||||
compositionWidth={spec.composition.width}
|
||||
compositionHeight={spec.composition.height}
|
||||
/>
|
||||
```
|
||||
|
||||
Includes 10 standard video components (TitleCard, TypingText, SplitScreen, etc.), 7 transition types, and the ClipWrapper utility for custom components.
|
||||
|
||||
### New: SpecStream
|
||||
|
||||
SpecStream is json-render's streaming format for progressively building specs from JSONL patches. The new compiler API makes it easy to process streaming AI responses.
|
||||
|
||||
```typescript
|
||||
import { createSpecStreamCompiler } from "@json-render/core";
|
||||
|
||||
const compiler = createSpecStreamCompiler<MySpec>();
|
||||
|
||||
// Process streaming chunks
|
||||
const { result, newPatches } = compiler.push(chunk);
|
||||
setSpec(result); // Update UI with partial result
|
||||
```
|
||||
|
||||
### Improved: Dashboard Example
|
||||
|
||||
The dashboard example is now a full-featured accounting dashboard with:
|
||||
|
||||
- Persistent SQLite database with Drizzle ORM
|
||||
- RESTful API for customers, invoices, expenses, accounts
|
||||
- Draggable widget reordering
|
||||
- AI-powered widget generation with streaming
|
||||
- Real data binding to database records
|
||||
|
||||
### Improved: Documentation
|
||||
|
||||
- Interactive playground for testing specs
|
||||
- New guides: Custom Schema, Streaming, Code Export
|
||||
- Full API reference for all packages
|
||||
- Integration guides: A2UI, AG-UI, Adaptive Cards, OpenAPI
|
||||
|
||||
### Breaking Changes
|
||||
|
||||
- `UITree` type renamed to `Spec`
|
||||
- Schema is now imported from renderer packages (`@json-render/react`) not core
|
||||
- `defineCatalog` now requires a schema as first argument
|
||||
|
||||
---
|
||||
|
||||
## v0.3.0
|
||||
|
||||
January 2026
|
||||
|
||||
Internal release with codegen foundations.
|
||||
|
||||
- Added `@json-render/codegen` package (spec traversal and JSX serialization)
|
||||
- Configurable AI model via environment variables
|
||||
- Documentation improvements and bug fixes
|
||||
|
||||
*Note: Only @json-render/core was published to npm for this release.*
|
||||
|
||||
---
|
||||
|
||||
## v0.2.0
|
||||
|
||||
January 2026
|
||||
|
||||
Initial public release.
|
||||
|
||||
- Core catalog and spec types
|
||||
- React renderer with contexts for data, actions, visibility
|
||||
- AI prompt generation from catalogs
|
||||
- Basic streaming support
|
||||
- Dashboard example application
|
||||
@@ -1,207 +0,0 @@
|
||||
import { Code } from "@/components/code";
|
||||
|
||||
export const metadata = {
|
||||
title: "Changelog | json-render",
|
||||
};
|
||||
|
||||
export default function ChangelogPage() {
|
||||
return (
|
||||
<article>
|
||||
<h1 className="text-3xl font-bold mb-4">Changelog</h1>
|
||||
<p className="text-muted-foreground mb-8">
|
||||
Notable changes and updates to json-render.
|
||||
</p>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">v0.4.0</h2>
|
||||
<p className="text-sm text-muted-foreground mb-6">February 2026</p>
|
||||
|
||||
<h3 className="text-lg font-semibold mt-8 mb-4">
|
||||
New: Custom Schema System
|
||||
</h3>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
Create custom output formats with <code>defineSchema</code>. Each
|
||||
renderer now defines its own schema, enabling completely different spec
|
||||
formats for different use cases.
|
||||
</p>
|
||||
<Code lang="typescript">{`import { defineSchema } from "@json-render/core";
|
||||
|
||||
const mySchema = defineSchema((s) => ({
|
||||
spec: s.object({
|
||||
pages: s.array(s.object({
|
||||
title: s.string(),
|
||||
blocks: s.array(s.ref("catalog.blocks")),
|
||||
})),
|
||||
}),
|
||||
catalog: s.object({
|
||||
blocks: s.map({ props: s.zod(), description: s.string() }),
|
||||
}),
|
||||
}), {
|
||||
promptTemplate: myPromptTemplate,
|
||||
});`}</Code>
|
||||
|
||||
<h3 className="text-lg font-semibold mt-8 mb-4">New: Component Slots</h3>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
Components can now define which slots they accept. Use{" "}
|
||||
<code>["default"]</code> for regular children, or named slots
|
||||
like <code>["header", "footer"]</code> for more
|
||||
complex layouts.
|
||||
</p>
|
||||
<Code lang="typescript">{`const catalog = defineCatalog(schema, {
|
||||
components: {
|
||||
Card: {
|
||||
props: z.object({ title: z.string() }),
|
||||
slots: ["default"], // accepts children
|
||||
description: "A card container",
|
||||
},
|
||||
Layout: {
|
||||
props: z.object({}),
|
||||
slots: ["header", "content", "footer"], // named slots
|
||||
description: "Page layout with header, content, footer",
|
||||
},
|
||||
},
|
||||
});`}</Code>
|
||||
|
||||
<h3 className="text-lg font-semibold mt-8 mb-4">
|
||||
New: AI Prompt Generation
|
||||
</h3>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
Catalogs now generate AI system prompts automatically with{" "}
|
||||
<code>catalog.prompt()</code>. The prompt includes all component
|
||||
definitions, props schemas, and action descriptions - ensuring the AI
|
||||
only generates valid specs.
|
||||
</p>
|
||||
<Code lang="typescript">{`import { defineCatalog } from "@json-render/core";
|
||||
import { schema } from "@json-render/react/schema";
|
||||
|
||||
const catalog = defineCatalog(schema, {
|
||||
components: { /* ... */ },
|
||||
actions: { /* ... */ },
|
||||
});
|
||||
|
||||
// Generate system prompt for AI
|
||||
const systemPrompt = catalog.prompt();
|
||||
|
||||
// Use with any AI SDK
|
||||
const result = await streamText({
|
||||
model: "claude-haiku-4.5",
|
||||
system: systemPrompt,
|
||||
prompt: userMessage,
|
||||
});`}</Code>
|
||||
|
||||
<h3 className="text-lg font-semibold mt-8 mb-4">
|
||||
New: @json-render/remotion
|
||||
</h3>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
Generate AI-powered videos with Remotion. Define video catalogs, stream
|
||||
timeline specs, and render with the Remotion Player.
|
||||
</p>
|
||||
<Code lang="tsx">{`import { Player } from "@remotion/player";
|
||||
import { Renderer, schema, standardComponentDefinitions } from "@json-render/remotion";
|
||||
|
||||
const catalog = defineCatalog(schema, {
|
||||
components: standardComponentDefinitions,
|
||||
transitions: standardTransitionDefinitions,
|
||||
});
|
||||
|
||||
<Player
|
||||
component={Renderer}
|
||||
inputProps={{ spec }}
|
||||
durationInFrames={spec.composition.durationInFrames}
|
||||
fps={spec.composition.fps}
|
||||
compositionWidth={spec.composition.width}
|
||||
compositionHeight={spec.composition.height}
|
||||
/>`}</Code>
|
||||
<p className="text-sm text-muted-foreground mt-4 mb-4">
|
||||
Includes 10 standard video components (TitleCard, TypingText,
|
||||
SplitScreen, etc.), 7 transition types, and the ClipWrapper utility for
|
||||
custom components.
|
||||
</p>
|
||||
|
||||
<h3 className="text-lg font-semibold mt-8 mb-4">New: SpecStream</h3>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
SpecStream is json-render's streaming format for progressively
|
||||
building specs from JSONL patches. The new compiler API makes it easy to
|
||||
process streaming AI responses.
|
||||
</p>
|
||||
<Code lang="typescript">{`import { createSpecStreamCompiler } from "@json-render/core";
|
||||
|
||||
const compiler = createSpecStreamCompiler<MySpec>();
|
||||
|
||||
// Process streaming chunks
|
||||
const { result, newPatches } = compiler.push(chunk);
|
||||
setSpec(result); // Update UI with partial result`}</Code>
|
||||
|
||||
<h3 className="text-lg font-semibold mt-8 mb-4">
|
||||
Improved: Dashboard Example
|
||||
</h3>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
The dashboard example is now a full-featured accounting dashboard with:
|
||||
</p>
|
||||
<ul className="list-disc list-inside text-sm text-muted-foreground space-y-1 mb-4">
|
||||
<li>Persistent SQLite database with Drizzle ORM</li>
|
||||
<li>RESTful API for customers, invoices, expenses, accounts</li>
|
||||
<li>Draggable widget reordering</li>
|
||||
<li>AI-powered widget generation with streaming</li>
|
||||
<li>Real data binding to database records</li>
|
||||
</ul>
|
||||
|
||||
<h3 className="text-lg font-semibold mt-8 mb-4">
|
||||
Improved: Documentation
|
||||
</h3>
|
||||
<ul className="list-disc list-inside text-sm text-muted-foreground space-y-1 mb-4">
|
||||
<li>Interactive playground for testing specs</li>
|
||||
<li>New guides: Custom Schema, Streaming, Code Export</li>
|
||||
<li>Full API reference for all packages</li>
|
||||
<li>Integration guides: A2UI, AG-UI, Adaptive Cards, OpenAPI</li>
|
||||
</ul>
|
||||
|
||||
<h3 className="text-lg font-semibold mt-8 mb-4">Breaking Changes</h3>
|
||||
<ul className="list-disc list-inside text-sm text-muted-foreground space-y-1 mb-4">
|
||||
<li>
|
||||
<code>UITree</code> type renamed to <code>Spec</code>
|
||||
</li>
|
||||
<li>
|
||||
Schema is now imported from renderer packages (
|
||||
<code>@json-render/react</code>) not core
|
||||
</li>
|
||||
<li>
|
||||
<code>defineCatalog</code> now requires a schema as first argument
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<hr className="my-12 border-border" />
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">v0.3.0</h2>
|
||||
<p className="text-sm text-muted-foreground mb-6">January 2026</p>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
Internal release with codegen foundations.
|
||||
</p>
|
||||
<ul className="list-disc list-inside text-sm text-muted-foreground space-y-1 mb-4">
|
||||
<li>
|
||||
Added <code>@json-render/codegen</code> package (spec traversal and
|
||||
JSX serialization)
|
||||
</li>
|
||||
<li>Configurable AI model via environment variables</li>
|
||||
<li>Documentation improvements and bug fixes</li>
|
||||
</ul>
|
||||
<p className="text-sm text-muted-foreground italic">
|
||||
Note: Only @json-render/core was published to npm for this release.
|
||||
</p>
|
||||
|
||||
<hr className="my-12 border-border" />
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">v0.2.0</h2>
|
||||
<p className="text-sm text-muted-foreground mb-6">January 2026</p>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
Initial public release.
|
||||
</p>
|
||||
<ul className="list-disc list-inside text-sm text-muted-foreground space-y-1 mb-4">
|
||||
<li>Core catalog and spec types</li>
|
||||
<li>React renderer with contexts for data, actions, visibility</li>
|
||||
<li>AI prompt generation from catalogs</li>
|
||||
<li>Basic streaming support</li>
|
||||
<li>Dashboard example application</li>
|
||||
</ul>
|
||||
</article>
|
||||
);
|
||||
}
|
||||
@@ -0,0 +1,140 @@
|
||||
import { pageMetadata } from "@/lib/page-metadata"
|
||||
export const metadata = pageMetadata("docs/code-export")
|
||||
|
||||
# Code Export
|
||||
|
||||
Export generated UI as standalone code for your framework.
|
||||
|
||||
## Overview
|
||||
|
||||
While json-render is designed for dynamic rendering, you can export generated UI as static code. The code generation is intentionally project-specific so you have full control over:
|
||||
|
||||
- Component templates (standalone, no json-render dependencies)
|
||||
- Package.json and project structure
|
||||
- Framework-specific patterns (Next.js, Remix, etc.)
|
||||
- How data is passed to components
|
||||
|
||||
## Architecture
|
||||
|
||||
Code export is split into two parts:
|
||||
|
||||
### 1. @json-render/codegen (utilities)
|
||||
|
||||
Framework-agnostic utilities for building code generators:
|
||||
|
||||
```typescript
|
||||
import {
|
||||
traverseSpec, // Walk the UI spec
|
||||
collectUsedComponents, // Get all component types used
|
||||
collectStatePaths, // Get all data binding paths
|
||||
collectActions, // Get all action names
|
||||
serializeProps, // Convert props to JSX string
|
||||
} from '@json-render/codegen';
|
||||
```
|
||||
|
||||
### 2. Your Project (generator)
|
||||
|
||||
Custom code generator specific to your project and framework:
|
||||
|
||||
```typescript
|
||||
// lib/codegen/generator.ts
|
||||
import { collectUsedComponents, serializeProps } from '@json-render/codegen';
|
||||
|
||||
export function generateNextJSProject(spec: Spec): GeneratedFile[] {
|
||||
const components = collectUsedComponents(spec);
|
||||
|
||||
return [
|
||||
{ path: 'package.json', content: '...' },
|
||||
{ path: 'app/page.tsx', content: '...' },
|
||||
// ... component files
|
||||
];
|
||||
}
|
||||
```
|
||||
|
||||
## Example: Next.js Export
|
||||
|
||||
See the dashboard example for a complete implementation that exports:
|
||||
|
||||
- `package.json` - Dependencies and scripts
|
||||
- `tsconfig.json` - TypeScript config
|
||||
- `next.config.js` - Next.js config
|
||||
- `app/layout.tsx` - Root layout
|
||||
- `app/globals.css` - Global styles
|
||||
- `app/page.tsx` - Generated page with data
|
||||
- `components/ui/*.tsx` - Standalone components
|
||||
|
||||
## Standalone Components
|
||||
|
||||
The exported components are standalone with no json-render dependencies. They receive data as props instead of using hooks:
|
||||
|
||||
```tsx
|
||||
// Generated component (standalone)
|
||||
interface MetricProps {
|
||||
label: string;
|
||||
statePath: string;
|
||||
data?: Record<string, unknown>;
|
||||
}
|
||||
|
||||
export function Metric({ label, statePath, data }: MetricProps) {
|
||||
const value = data ? getByPath(data, statePath) : undefined;
|
||||
return (
|
||||
<div>
|
||||
<span>{label}</span>
|
||||
<span>{formatValue(value)}</span>
|
||||
</div>
|
||||
);
|
||||
}
|
||||
```
|
||||
|
||||
## Using the Utilities
|
||||
|
||||
### traverseSpec
|
||||
|
||||
```typescript
|
||||
import { traverseSpec } from '@json-render/codegen';
|
||||
|
||||
traverseSpec(spec, (element, key, depth, parent) => {
|
||||
console.log(' '.repeat(depth * 2) + `${key}: ${element.type}`);
|
||||
});
|
||||
```
|
||||
|
||||
### collectUsedComponents
|
||||
|
||||
```typescript
|
||||
import { collectUsedComponents } from '@json-render/codegen';
|
||||
|
||||
const components = collectUsedComponents(spec);
|
||||
// Set { 'Card', 'Metric', 'Chart', 'Table' }
|
||||
|
||||
// Generate only the needed component files
|
||||
for (const component of components) {
|
||||
files.push({
|
||||
path: `components/ui/${component.toLowerCase()}.tsx`,
|
||||
content: componentTemplates[component],
|
||||
});
|
||||
}
|
||||
```
|
||||
|
||||
### serializeProps
|
||||
|
||||
```typescript
|
||||
import { serializeProps } from '@json-render/codegen';
|
||||
|
||||
const propsStr = serializeProps({
|
||||
title: 'Dashboard',
|
||||
columns: 3,
|
||||
disabled: true,
|
||||
});
|
||||
// 'title="Dashboard" columns={3} disabled'
|
||||
```
|
||||
|
||||
## Try It
|
||||
|
||||
Run the dashboard example and click "Export Project" to see code generation in action:
|
||||
|
||||
```bash
|
||||
cd examples/dashboard
|
||||
pnpm dev
|
||||
# Open http://dashboard-demo.json-render.localhost:1355
|
||||
# Generate a widget, then click "Export Project"
|
||||
```
|
||||
@@ -1,170 +0,0 @@
|
||||
import { Code } from "@/components/code";
|
||||
|
||||
export const metadata = {
|
||||
title: "Code Export | json-render",
|
||||
};
|
||||
|
||||
export default function CodeExportPage() {
|
||||
return (
|
||||
<article>
|
||||
<h1 className="text-3xl font-bold mb-4">Code Export</h1>
|
||||
<p className="text-muted-foreground mb-8">
|
||||
Export generated UI as standalone code for your framework.
|
||||
</p>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">Overview</h2>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
While json-render is designed for dynamic rendering, you can export
|
||||
generated UI as static code. The code generation is intentionally
|
||||
project-specific so you have full control over:
|
||||
</p>
|
||||
<ul className="list-disc list-inside text-sm text-muted-foreground space-y-2 mb-8">
|
||||
<li>Component templates (standalone, no json-render dependencies)</li>
|
||||
<li>Package.json and project structure</li>
|
||||
<li>Framework-specific patterns (Next.js, Remix, etc.)</li>
|
||||
<li>How data is passed to components</li>
|
||||
</ul>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">Architecture</h2>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
Code export is split into two parts:
|
||||
</p>
|
||||
|
||||
<h3 className="text-lg font-semibold mt-8 mb-4">
|
||||
1. @json-render/codegen (utilities)
|
||||
</h3>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
Framework-agnostic utilities for building code generators:
|
||||
</p>
|
||||
<Code lang="typescript">{`import {
|
||||
traverseSpec, // Walk the UI spec
|
||||
collectUsedComponents, // Get all component types used
|
||||
collectDataPaths, // Get all data binding paths
|
||||
collectActions, // Get all action names
|
||||
serializeProps, // Convert props to JSX string
|
||||
} from '@json-render/codegen';`}</Code>
|
||||
|
||||
<h3 className="text-lg font-semibold mt-8 mb-4">
|
||||
2. Your Project (generator)
|
||||
</h3>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
Custom code generator specific to your project and framework:
|
||||
</p>
|
||||
<Code lang="typescript">{`// lib/codegen/generator.ts
|
||||
import { collectUsedComponents, serializeProps } from '@json-render/codegen';
|
||||
|
||||
export function generateNextJSProject(spec: Spec): GeneratedFile[] {
|
||||
const components = collectUsedComponents(spec);
|
||||
|
||||
return [
|
||||
{ path: 'package.json', content: '...' },
|
||||
{ path: 'app/page.tsx', content: '...' },
|
||||
// ... component files
|
||||
];
|
||||
}`}</Code>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">
|
||||
Example: Next.js Export
|
||||
</h2>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
See the dashboard example for a complete implementation that exports:
|
||||
</p>
|
||||
<ul className="list-disc list-inside text-sm text-muted-foreground space-y-2 mb-4">
|
||||
<li>
|
||||
<code className="text-foreground">package.json</code> - Dependencies
|
||||
and scripts
|
||||
</li>
|
||||
<li>
|
||||
<code className="text-foreground">tsconfig.json</code> - TypeScript
|
||||
config
|
||||
</li>
|
||||
<li>
|
||||
<code className="text-foreground">next.config.js</code> - Next.js
|
||||
config
|
||||
</li>
|
||||
<li>
|
||||
<code className="text-foreground">app/layout.tsx</code> - Root layout
|
||||
</li>
|
||||
<li>
|
||||
<code className="text-foreground">app/globals.css</code> - Global
|
||||
styles
|
||||
</li>
|
||||
<li>
|
||||
<code className="text-foreground">app/page.tsx</code> - Generated page
|
||||
with data
|
||||
</li>
|
||||
<li>
|
||||
<code className="text-foreground">components/ui/*.tsx</code> -
|
||||
Standalone components
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">
|
||||
Standalone Components
|
||||
</h2>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
The exported components are standalone with no json-render dependencies.
|
||||
They receive data as props instead of using hooks:
|
||||
</p>
|
||||
<Code lang="tsx">{`// Generated component (standalone)
|
||||
interface MetricProps {
|
||||
label: string;
|
||||
valuePath: string;
|
||||
data?: Record<string, unknown>;
|
||||
}
|
||||
|
||||
export function Metric({ label, valuePath, data }: MetricProps) {
|
||||
const value = data ? getByPath(data, valuePath) : undefined;
|
||||
return (
|
||||
<div>
|
||||
<span>{label}</span>
|
||||
<span>{formatValue(value)}</span>
|
||||
</div>
|
||||
);
|
||||
}`}</Code>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">Using the Utilities</h2>
|
||||
|
||||
<h3 className="text-lg font-semibold mt-8 mb-4">traverseSpec</h3>
|
||||
<Code lang="typescript">{`import { traverseSpec } from '@json-render/codegen';
|
||||
|
||||
traverseSpec(spec, (element, depth, parent) => {
|
||||
console.log(' '.repeat(depth * 2) + element.type);
|
||||
});`}</Code>
|
||||
|
||||
<h3 className="text-lg font-semibold mt-8 mb-4">collectUsedComponents</h3>
|
||||
<Code lang="typescript">{`import { collectUsedComponents } from '@json-render/codegen';
|
||||
|
||||
const components = collectUsedComponents(spec);
|
||||
// Set { 'Card', 'Metric', 'Chart', 'Table' }
|
||||
|
||||
// Generate only the needed component files
|
||||
for (const component of components) {
|
||||
files.push({
|
||||
path: \`components/ui/\${component.toLowerCase()}.tsx\`,
|
||||
content: componentTemplates[component],
|
||||
});
|
||||
}`}</Code>
|
||||
|
||||
<h3 className="text-lg font-semibold mt-8 mb-4">serializeProps</h3>
|
||||
<Code lang="typescript">{`import { serializeProps } from '@json-render/codegen';
|
||||
|
||||
const propsStr = serializeProps({
|
||||
title: 'Dashboard',
|
||||
columns: 3,
|
||||
disabled: true,
|
||||
});
|
||||
// 'title="Dashboard" columns={3} disabled'`}</Code>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">Try It</h2>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
Run the dashboard example and click "Export Project" to see
|
||||
code generation in action:
|
||||
</p>
|
||||
<Code lang="bash">{`cd examples/dashboard
|
||||
pnpm dev
|
||||
# Open http://localhost:3001
|
||||
# Generate a widget, then click "Export Project"`}</Code>
|
||||
</article>
|
||||
);
|
||||
}
|
||||
@@ -0,0 +1,119 @@
|
||||
import { pageMetadata } from "@/lib/page-metadata"
|
||||
export const metadata = pageMetadata("docs/computed-values")
|
||||
|
||||
# Computed Values
|
||||
|
||||
Derive dynamic prop values using registered functions or string templates.
|
||||
|
||||
## `$template` — String Interpolation
|
||||
|
||||
Use `{ "$template": "..." }` to embed state values into a string. References use `${/path}` syntax where the path is a JSON Pointer:
|
||||
|
||||
```json
|
||||
{
|
||||
"type": "Text",
|
||||
"props": {
|
||||
"text": { "$template": "Hello, ${/user/name}! You have ${/inbox/count} messages." }
|
||||
},
|
||||
"children": []
|
||||
}
|
||||
```
|
||||
|
||||
If state is `{ "user": { "name": "Alice" }, "inbox": { "count": 3 } }`, the text renders as "Hello, Alice! You have 3 messages."
|
||||
|
||||
Missing paths resolve to an empty string.
|
||||
|
||||
## `$computed` — Registered Functions
|
||||
|
||||
Use `{ "$computed": "<name>", "args": { ... } }` to call a named function registered in your catalog. Each arg can be a literal value or any prop expression (`$state`, `$item`, `$cond`, etc.):
|
||||
|
||||
```json
|
||||
{
|
||||
"type": "Text",
|
||||
"props": {
|
||||
"text": {
|
||||
"$computed": "fullName",
|
||||
"args": {
|
||||
"first": { "$state": "/form/firstName" },
|
||||
"last": { "$state": "/form/lastName" }
|
||||
}
|
||||
}
|
||||
},
|
||||
"children": []
|
||||
}
|
||||
```
|
||||
|
||||
### Registering Functions
|
||||
|
||||
Functions are registered in the catalog and provided at runtime.
|
||||
|
||||
**Catalog definition (for AI prompt generation):**
|
||||
|
||||
```typescript
|
||||
import { defineCatalog } from '@json-render/core';
|
||||
import { schema } from '@json-render/react/schema';
|
||||
|
||||
const catalog = defineCatalog(schema, {
|
||||
components: { /* ... */ },
|
||||
functions: {
|
||||
fullName: {
|
||||
description: 'Combines first and last name into a full name',
|
||||
},
|
||||
formatCurrency: {
|
||||
description: 'Formats a number as currency',
|
||||
},
|
||||
},
|
||||
});
|
||||
```
|
||||
|
||||
**Runtime implementation:**
|
||||
|
||||
```tsx
|
||||
import { JSONUIProvider } from '@json-render/react';
|
||||
|
||||
const functions = {
|
||||
fullName: (args) => `${args.first ?? ''} ${args.last ?? ''}`.trim(),
|
||||
formatCurrency: (args) => {
|
||||
const value = Number(args.value ?? 0);
|
||||
return new Intl.NumberFormat('en-US', {
|
||||
style: 'currency',
|
||||
currency: (args.currency as string) ?? 'USD',
|
||||
}).format(value);
|
||||
},
|
||||
};
|
||||
|
||||
<JSONUIProvider registry={registry} functions={functions}>
|
||||
<Renderer spec={spec} registry={registry} />
|
||||
</JSONUIProvider>
|
||||
```
|
||||
|
||||
### Using with `createRenderer`
|
||||
|
||||
```tsx
|
||||
const MyRenderer = createRenderer(catalog, components);
|
||||
|
||||
<MyRenderer
|
||||
spec={spec}
|
||||
functions={functions}
|
||||
/>
|
||||
```
|
||||
|
||||
## Combining Expressions
|
||||
|
||||
`$computed` args can use any expression type. This example computes a total from repeat item fields:
|
||||
|
||||
```json
|
||||
{
|
||||
"$computed": "lineTotal",
|
||||
"args": {
|
||||
"price": { "$item": "price" },
|
||||
"quantity": { "$item": "quantity" }
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Next
|
||||
|
||||
- [Watchers](/docs/watchers) — react to state changes with cascading actions
|
||||
- [Data Binding](/docs/data-binding) — all expression types
|
||||
- [Validation](/docs/validation) — validate form inputs
|
||||
+71
-105
@@ -1,37 +1,20 @@
|
||||
import Link from "next/link";
|
||||
import { Code } from "@/components/code";
|
||||
import { pageMetadata } from "@/lib/page-metadata"
|
||||
export const metadata = pageMetadata("docs/custom-schema")
|
||||
|
||||
export const metadata = {
|
||||
title: "Custom Schema & Renderer | json-render",
|
||||
};
|
||||
# Custom Schema & Renderer
|
||||
|
||||
export default function CustomSchemaPage() {
|
||||
return (
|
||||
<article>
|
||||
<h1 className="text-3xl font-bold mb-4">Custom Schema & Renderer</h1>
|
||||
<p className="text-muted-foreground mb-8">
|
||||
Build your own schema and renderer with{" "}
|
||||
<code className="text-foreground">@json-render/core</code>.
|
||||
</p>
|
||||
Build your own schema and renderer with `@json-render/core`.
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">Overview</h2>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
<code className="text-foreground">@json-render/core</code> is
|
||||
schema-agnostic. While{" "}
|
||||
<code className="text-foreground">@json-render/react</code> provides a
|
||||
ready-to-use schema and renderer, you can create your own to match any
|
||||
JSON structure - whether it's a domain-specific format, an existing
|
||||
protocol, or something entirely custom.
|
||||
</p>
|
||||
## Overview
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">
|
||||
1. Define Your Schema
|
||||
</h2>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
Start by defining the JSON structure your system will use. Here's
|
||||
an example of a simple dashboard schema:
|
||||
</p>
|
||||
<Code lang="json">{`{
|
||||
`@json-render/core` is schema-agnostic. While `@json-render/react` provides a ready-to-use schema and renderer, you can create your own to match any JSON structure - whether it's a domain-specific format, an existing protocol, or something entirely custom.
|
||||
|
||||
## 1. Define Your Schema
|
||||
|
||||
Start by defining the JSON structure your system will use. Here's an example of a simple dashboard schema:
|
||||
|
||||
```json
|
||||
{
|
||||
"layout": "grid",
|
||||
"columns": 2,
|
||||
"widgets": [
|
||||
@@ -54,18 +37,18 @@ export default function CustomSchemaPage() {
|
||||
"dataKey": "orders"
|
||||
}
|
||||
]
|
||||
}`}</Code>
|
||||
}
|
||||
```
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">
|
||||
2. Create the Catalog
|
||||
</h2>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
Define a catalog that describes your components and validates props:
|
||||
</p>
|
||||
<Code lang="typescript">{`import { createCatalog } from '@json-render/core';
|
||||
## 2. Create the Catalog
|
||||
|
||||
Define a catalog that describes your components and validates props using `defineCatalog` — see [Catalog](/docs/catalog).
|
||||
|
||||
```typescript
|
||||
import { defineCatalog } from '@json-render/core';
|
||||
import { z } from 'zod';
|
||||
|
||||
export const dashboardCatalog = createCatalog({
|
||||
export const dashboardCatalog = defineCatalog(mySchema, {
|
||||
components: {
|
||||
metric: {
|
||||
description: 'Displays a single metric value',
|
||||
@@ -102,15 +85,15 @@ export const dashboardCatalog = createCatalog({
|
||||
}),
|
||||
},
|
||||
},
|
||||
});`}</Code>
|
||||
});
|
||||
```
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">
|
||||
3. Define the Root Schema
|
||||
</h2>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
Create a schema for the overall document structure:
|
||||
</p>
|
||||
<Code lang="typescript">{`import { z } from 'zod';
|
||||
## 3. Define the Root Schema
|
||||
|
||||
Create a schema for the overall document structure:
|
||||
|
||||
```typescript
|
||||
import { z } from 'zod';
|
||||
|
||||
const WidgetSchema = z.object({
|
||||
type: z.string(),
|
||||
@@ -125,15 +108,15 @@ export const DashboardSchema = z.object({
|
||||
});
|
||||
|
||||
export type Dashboard = z.infer<typeof DashboardSchema>;
|
||||
export type Widget = z.infer<typeof WidgetSchema>;`}</Code>
|
||||
export type Widget = z.infer<typeof WidgetSchema>;
|
||||
```
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">
|
||||
4. Build the Renderer
|
||||
</h2>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
Create a renderer that maps your schema to React components:
|
||||
</p>
|
||||
<Code lang="tsx">{`import React from 'react';
|
||||
## 4. Build the Renderer
|
||||
|
||||
Create a renderer that maps your schema to React components:
|
||||
|
||||
```tsx
|
||||
import React from 'react';
|
||||
import { dashboardCatalog } from './catalog';
|
||||
import type { Dashboard, Widget } from './schema';
|
||||
|
||||
@@ -144,7 +127,7 @@ const widgetComponents: Record<string, React.FC<any>> = {
|
||||
<p className="text-sm text-muted-foreground">{title}</p>
|
||||
<p className="text-2xl font-bold">{value}</p>
|
||||
{trend && (
|
||||
<p className={\`text-sm \${trend === 'up' ? 'text-green-500' : 'text-red-500'}\`}>
|
||||
<p className={`text-sm ${trend === 'up' ? 'text-green-500' : 'text-red-500'}`}>
|
||||
{trend === 'up' ? '+' : '-'}{change}
|
||||
</p>
|
||||
)}
|
||||
@@ -204,7 +187,7 @@ export function DashboardRenderer({
|
||||
data?: Record<string, any>;
|
||||
}) {
|
||||
const layoutClass = {
|
||||
grid: \`grid gap-4 \${spec.columns ? \`grid-cols-\${spec.columns}\` : 'grid-cols-2'}\`,
|
||||
grid: `grid gap-4 ${spec.columns ? `grid-cols-${spec.columns}` : 'grid-cols-2'}`,
|
||||
stack: 'flex flex-col gap-4',
|
||||
tabs: 'space-y-4',
|
||||
}[spec.layout];
|
||||
@@ -214,7 +197,7 @@ export function DashboardRenderer({
|
||||
{spec.widgets.map((widget, index) => {
|
||||
const Component = widgetComponents[widget.type];
|
||||
if (!Component) {
|
||||
console.warn(\`Unknown widget type: \${widget.type}\`);
|
||||
console.warn(`Unknown widget type: ${widget.type}`);
|
||||
return null;
|
||||
}
|
||||
|
||||
@@ -231,15 +214,15 @@ export function DashboardRenderer({
|
||||
})}
|
||||
</div>
|
||||
);
|
||||
}`}</Code>
|
||||
}
|
||||
```
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">
|
||||
5. Generate LLM Prompts
|
||||
</h2>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
Use the catalog to generate system prompts for AI:
|
||||
</p>
|
||||
<Code lang="typescript">{`const systemPrompt = dashboardCatalog.prompt({
|
||||
## 5. Generate LLM Prompts
|
||||
|
||||
Use the catalog to generate system prompts for AI:
|
||||
|
||||
```typescript
|
||||
const systemPrompt = dashboardCatalog.prompt({
|
||||
customRules: [
|
||||
'Use metric widgets for single KPI values',
|
||||
'Use chart widgets for time-series data',
|
||||
@@ -253,14 +236,14 @@ const response = await generateText({
|
||||
model: 'gpt-4',
|
||||
system: systemPrompt,
|
||||
prompt: 'Create a sales dashboard with revenue, orders, and a chart',
|
||||
});`}</Code>
|
||||
});
|
||||
```
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">6. Validate Specs</h2>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
Validate incoming specs against your schema:
|
||||
</p>
|
||||
<Code lang="typescript">{`import { validate } from '@json-render/core';
|
||||
## 6. Validate Specs
|
||||
|
||||
Validate incoming specs against your schema. Use `catalog.validate()` to check AI output against the catalog's Zod schema:
|
||||
|
||||
```typescript
|
||||
function validateDashboard(spec: unknown) {
|
||||
// Validate root structure
|
||||
const rootResult = DashboardSchema.safeParse(spec);
|
||||
@@ -268,23 +251,20 @@ function validateDashboard(spec: unknown) {
|
||||
return { valid: false, errors: rootResult.error.errors };
|
||||
}
|
||||
|
||||
// Validate each widget against catalog
|
||||
const errors: string[] = [];
|
||||
for (const widget of rootResult.data.widgets) {
|
||||
const result = validate(
|
||||
{ type: widget.type, props: widget },
|
||||
dashboardCatalog
|
||||
);
|
||||
if (!result.valid) {
|
||||
errors.push(...result.errors.map(e => \`\${widget.type}: \${e}\`));
|
||||
}
|
||||
// Validate each widget's props against the catalog
|
||||
const result = dashboardCatalog.validate(spec);
|
||||
if (!result.success) {
|
||||
return { valid: false, errors: result.error.errors };
|
||||
}
|
||||
|
||||
return { valid: errors.length === 0, errors };
|
||||
}`}</Code>
|
||||
return { valid: true, errors: [] };
|
||||
}
|
||||
```
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">Usage Example</h2>
|
||||
<Code lang="tsx">{`'use client';
|
||||
## Usage Example
|
||||
|
||||
```tsx
|
||||
'use client';
|
||||
|
||||
import { useState } from 'react';
|
||||
import { DashboardRenderer } from './renderer';
|
||||
@@ -313,23 +293,9 @@ export function MyDashboard() {
|
||||
const [spec, setSpec] = useState(initialSpec);
|
||||
|
||||
return <DashboardRenderer spec={spec} data={data} />;
|
||||
}`}</Code>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">Next</h2>
|
||||
<p className="text-sm text-muted-foreground">
|
||||
See how to integrate with{" "}
|
||||
<Link href="/docs/a2ui" className="text-foreground hover:underline">
|
||||
A2UI
|
||||
</Link>{" "}
|
||||
or{" "}
|
||||
<Link
|
||||
href="/docs/adaptive-cards"
|
||||
className="text-foreground hover:underline"
|
||||
>
|
||||
Adaptive Cards
|
||||
</Link>{" "}
|
||||
protocols.
|
||||
</p>
|
||||
</article>
|
||||
);
|
||||
}
|
||||
```
|
||||
|
||||
## Next
|
||||
|
||||
See how to integrate with [A2UI](/docs/a2ui) or [Adaptive Cards](/docs/adaptive-cards) protocols.
|
||||
@@ -0,0 +1,311 @@
|
||||
import { pageMetadata } from "@/lib/page-metadata"
|
||||
export const metadata = pageMetadata("docs/data-binding")
|
||||
|
||||
# Data Binding
|
||||
|
||||
Connect UI elements to dynamic data using expressions in your JSON specs.
|
||||
|
||||
## State Model
|
||||
|
||||
Every spec can include a `state` object that holds the data your UI reads from:
|
||||
|
||||
```json
|
||||
{
|
||||
"root": "greeting",
|
||||
"elements": {
|
||||
"greeting": {
|
||||
"type": "Text",
|
||||
"props": { "content": { "$state": "/user/name" } },
|
||||
"children": []
|
||||
}
|
||||
},
|
||||
"state": {
|
||||
"user": { "name": "Alice" }
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
State can also be provided programmatically at runtime. In `@json-render/react`, this is done via `StateProvider` and hooks like `useStateStore`. See the [React API reference](/docs/api/react) for details.
|
||||
|
||||
## JSON Pointer Paths
|
||||
|
||||
All paths in json-render follow JSON Pointer (RFC 6901). A path is a string of `/`-separated tokens starting from the root:
|
||||
|
||||
```
|
||||
Given this state:
|
||||
{
|
||||
"user": { "name": "Alice", "email": "alice@example.com" },
|
||||
"todos": [
|
||||
{ "title": "Buy milk", "done": false },
|
||||
{ "title": "Walk dog", "done": true }
|
||||
]
|
||||
}
|
||||
|
||||
"/user/name" -> "Alice"
|
||||
"/user/email" -> "alice@example.com"
|
||||
"/todos/0/title" -> "Buy milk"
|
||||
"/todos/1/done" -> true
|
||||
```
|
||||
|
||||
## Expressions
|
||||
|
||||
Expressions are special objects you place in props to read dynamic values instead of hardcoding them. There are six expression types.
|
||||
|
||||
### `$state` — Read from state
|
||||
|
||||
Use `{ "$state": "/path" }` in any prop to read a value from the state model:
|
||||
|
||||
```json
|
||||
{
|
||||
"type": "Card",
|
||||
"props": {
|
||||
"title": { "$state": "/user/name" },
|
||||
"subtitle": { "$state": "/user/email" }
|
||||
},
|
||||
"children": []
|
||||
}
|
||||
```
|
||||
|
||||
If state contains `{ "user": { "name": "Alice", "email": "alice@example.com" } }`, the Card renders with title "Alice" and subtitle "alice@example.com".
|
||||
|
||||
### `$item` — Read from the current repeat item
|
||||
|
||||
Use `{ "$item": "field" }` inside a [repeat](#repeat) to read a field from the current array item:
|
||||
|
||||
```json
|
||||
{
|
||||
"type": "Text",
|
||||
"props": { "content": { "$item": "title" } },
|
||||
"children": []
|
||||
}
|
||||
```
|
||||
|
||||
Use `{ "$item": "" }` to get the entire item object.
|
||||
|
||||
### `$index` — Current repeat index
|
||||
|
||||
Use `{ "$index": true }` inside a [repeat](#repeat) to get the current array index (zero-based number):
|
||||
|
||||
```json
|
||||
{
|
||||
"type": "Text",
|
||||
"props": { "content": { "$index": true } },
|
||||
"children": []
|
||||
}
|
||||
```
|
||||
|
||||
## Repeat
|
||||
|
||||
The `repeat` field on an element renders its children once per item in a state array. It is a top-level field on the element, sibling of `type`, `props`, and `children` — not inside `props`.
|
||||
|
||||
```json
|
||||
{
|
||||
"root": "todo-list",
|
||||
"elements": {
|
||||
"todo-list": {
|
||||
"type": "Column",
|
||||
"props": { "gap": 8 },
|
||||
"repeat": { "statePath": "/todos", "key": "id" },
|
||||
"children": ["todo-item"]
|
||||
},
|
||||
"todo-item": {
|
||||
"type": "Card",
|
||||
"props": {
|
||||
"title": { "$item": "title" },
|
||||
"subtitle": { "$item": "description" }
|
||||
},
|
||||
"children": []
|
||||
}
|
||||
},
|
||||
"state": {
|
||||
"todos": [
|
||||
{ "id": "1", "title": "Buy milk", "description": "2% or whole" },
|
||||
{ "id": "2", "title": "Walk dog", "description": "Around the park" }
|
||||
]
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
- `repeat.statePath` — JSON Pointer to the state array
|
||||
- `repeat.key` — field name on each item to use as a stable key for rendering
|
||||
|
||||
Inside `todo-item`, `{ "$item": "title" }` reads the `title` field from whichever array item is currently being rendered. `{ "$index": true }` would return `0` for the first item, `1` for the second, and so on.
|
||||
|
||||
## Two-Way Binding with `$bindState`
|
||||
|
||||
Form components use `{ "$bindState": "/path" }` on their natural value prop for two-way binding. The component reads from and writes to the state path.
|
||||
|
||||
### Value prop (text inputs)
|
||||
|
||||
```json
|
||||
{
|
||||
"type": "TextInput",
|
||||
"props": {
|
||||
"value": { "$bindState": "/form/email" },
|
||||
"placeholder": "Enter your email"
|
||||
},
|
||||
"children": []
|
||||
}
|
||||
```
|
||||
|
||||
### Checked prop (switches, checkboxes)
|
||||
|
||||
```json
|
||||
{
|
||||
"type": "Switch",
|
||||
"props": {
|
||||
"label": "Enable notifications",
|
||||
"checked": { "$bindState": "/settings/notifications" }
|
||||
},
|
||||
"children": []
|
||||
}
|
||||
```
|
||||
|
||||
### Pressed prop (toggle buttons)
|
||||
|
||||
```json
|
||||
{
|
||||
"type": "ToggleButton",
|
||||
"props": {
|
||||
"label": "Bold",
|
||||
"pressed": { "$bindState": "/editor/bold" }
|
||||
},
|
||||
"children": []
|
||||
}
|
||||
```
|
||||
|
||||
## Two-Way Binding with `$bindItem`
|
||||
|
||||
Inside a repeat scope, use `{ "$bindItem": "field" }` to bind to a field on the current item:
|
||||
|
||||
```json
|
||||
{
|
||||
"type": "Switch",
|
||||
"props": {
|
||||
"label": "Done",
|
||||
"checked": { "$bindItem": "completed" }
|
||||
},
|
||||
"children": []
|
||||
}
|
||||
```
|
||||
|
||||
Use `{ "$bindItem": "" }` to bind to the entire item.
|
||||
|
||||
`statePath` is not used for component binding. It remains for `repeat.statePath` (array iteration path) and action params like `setState.statePath` (target path for mutations).
|
||||
|
||||
## Conditional Props
|
||||
|
||||
Use `$cond` / `$then` / `$else` to pick a prop value based on a condition:
|
||||
|
||||
```json
|
||||
{
|
||||
"type": "Badge",
|
||||
"props": {
|
||||
"label": {
|
||||
"$cond": { "$state": "/user/isAdmin" },
|
||||
"$then": "Admin",
|
||||
"$else": "Member"
|
||||
}
|
||||
},
|
||||
"children": []
|
||||
}
|
||||
```
|
||||
|
||||
The condition uses the same [visibility](/docs/visibility) expression format.
|
||||
|
||||
## Template Strings
|
||||
|
||||
Use `{ "$template": "..." }` to interpolate state values into a string using `${/path}` syntax:
|
||||
|
||||
```json
|
||||
{
|
||||
"type": "Text",
|
||||
"props": {
|
||||
"text": { "$template": "Welcome back, ${/user/name}!" }
|
||||
},
|
||||
"children": []
|
||||
}
|
||||
```
|
||||
|
||||
See [Computed Values](/docs/computed-values) for details on `$template` and `$computed` expressions.
|
||||
|
||||
## Quick Reference
|
||||
|
||||
<div className="my-6 overflow-x-auto">
|
||||
<table className="mdx-table w-full text-sm border-collapse">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Expression</th>
|
||||
<th>Syntax</th>
|
||||
<th>Context</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>{"$state"}</code></td>
|
||||
<td><code>{'{ "$state": "/path" }'}</code></td>
|
||||
<td>Anywhere</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>{"$item"}</code></td>
|
||||
<td><code>{'{ "$item": "field" }'}</code></td>
|
||||
<td>Inside repeat only</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>{"$index"}</code></td>
|
||||
<td><code>{'{ "$index": true }'}</code></td>
|
||||
<td>Inside repeat only</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>{"$cond"}</code></td>
|
||||
<td><code>{'{ "$cond": ..., "$then": ..., "$else": ... }'}</code></td>
|
||||
<td>Anywhere</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>{"$bindState"}</code></td>
|
||||
<td><code>{'{ "$bindState": "/path" }'}</code></td>
|
||||
<td>Form components (value, checked, pressed)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>{"$bindItem"}</code></td>
|
||||
<td><code>{'{ "$bindItem": "field" }'}</code></td>
|
||||
<td>Form components inside repeat</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>{"$template"}</code></td>
|
||||
<td><code>{'{ "$template": "Hello, ${/name}!" }'}</code></td>
|
||||
<td>Anywhere (string props)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>{"$computed"}</code></td>
|
||||
<td><code>{'{ "$computed": "fn", "args": { ... } }'}</code></td>
|
||||
<td>Anywhere (requires registered function)</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
## External Store (Controlled Mode)
|
||||
|
||||
For advanced use cases, you can pass a `StateStore` to `StateProvider` to use your own state management (Redux, Zustand, XState, etc.) instead of the built-in internal store:
|
||||
|
||||
```tsx
|
||||
import { createStateStore, type StateStore } from "@json-render/react";
|
||||
|
||||
const store = createStateStore({ user: { name: "Alice" } });
|
||||
|
||||
<StateProvider store={store}>
|
||||
{children}
|
||||
</StateProvider>
|
||||
|
||||
// Mutate from anywhere — React re-renders automatically:
|
||||
store.set("/user/name", "Bob");
|
||||
```
|
||||
|
||||
When `store` is provided, `initialState` and `onStateChange` are ignored. The store is the single source of truth. See the [React API reference](/docs/api/react#external-store-controlled-mode) for the full `StateStore` interface.
|
||||
|
||||
## Next
|
||||
|
||||
- [Visibility](/docs/visibility) — conditionally show or hide elements
|
||||
- [Action handlers](/docs/registry#action-handlers) — respond to user interactions
|
||||
- [React API reference](/docs/api/react) — React-specific hooks for programmatic state access
|
||||
@@ -1,133 +0,0 @@
|
||||
import Link from "next/link";
|
||||
import { Code } from "@/components/code";
|
||||
|
||||
export const metadata = {
|
||||
title: "Data Binding | json-render",
|
||||
};
|
||||
|
||||
export default function DataBindingPage() {
|
||||
return (
|
||||
<article>
|
||||
<h1 className="text-3xl font-bold mb-4">Data Binding</h1>
|
||||
<p className="text-muted-foreground mb-8">
|
||||
Connect UI components to your application data using JSON Pointer paths.
|
||||
</p>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">JSON Pointer Paths</h2>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
json-render uses JSON Pointer (RFC 6901) for data paths:
|
||||
</p>
|
||||
<Code lang="json">{`// Given this data:
|
||||
{
|
||||
"user": {
|
||||
"name": "Alice",
|
||||
"email": "alice@example.com"
|
||||
},
|
||||
"metrics": {
|
||||
"revenue": 125000,
|
||||
"growth": 0.15
|
||||
}
|
||||
}
|
||||
|
||||
// These paths access:
|
||||
"/user/name" -> "Alice"
|
||||
"/metrics/revenue" -> 125000
|
||||
"/metrics/growth" -> 0.15`}</Code>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">DataProvider</h2>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
Wrap your app with DataProvider to enable data binding:
|
||||
</p>
|
||||
<Code lang="tsx">{`import { DataProvider } from '@json-render/react';
|
||||
|
||||
function App() {
|
||||
const initialData = {
|
||||
user: { name: 'Alice' },
|
||||
form: { email: '', message: '' },
|
||||
};
|
||||
|
||||
return (
|
||||
<DataProvider initialData={initialData}>
|
||||
{/* Your UI */}
|
||||
</DataProvider>
|
||||
);
|
||||
}`}</Code>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">Reading Data</h2>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
Use <code className="text-foreground">useDataValue</code> for read-only
|
||||
access:
|
||||
</p>
|
||||
<Code lang="tsx">{`import { useDataValue } from '@json-render/react';
|
||||
|
||||
function UserGreeting() {
|
||||
const name = useDataValue('/user/name');
|
||||
return <h1>Hello, {name}!</h1>;
|
||||
}`}</Code>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">Two-Way Binding</h2>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
Use <code className="text-foreground">useDataBinding</code> for
|
||||
read-write access:
|
||||
</p>
|
||||
<Code lang="tsx">{`import { useDataBinding } from '@json-render/react';
|
||||
|
||||
function EmailInput() {
|
||||
const [email, setEmail] = useDataBinding('/form/email');
|
||||
|
||||
return (
|
||||
<input
|
||||
type="email"
|
||||
value={email || ''}
|
||||
onChange={(e) => setEmail(e.target.value)}
|
||||
/>
|
||||
);
|
||||
}`}</Code>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">
|
||||
Using the Data Context
|
||||
</h2>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
Access the full data context for advanced use cases:
|
||||
</p>
|
||||
<Code lang="tsx">{`import { useData } from '@json-render/react';
|
||||
|
||||
function DataDebugger() {
|
||||
const { data, setData, getValue, setValue } = useData();
|
||||
|
||||
// Read any path
|
||||
const revenue = getValue('/metrics/revenue');
|
||||
|
||||
// Write any path
|
||||
const updateRevenue = () => setValue('/metrics/revenue', 150000);
|
||||
|
||||
// Replace all data
|
||||
const resetData = () => setData({ user: {}, form: {} });
|
||||
|
||||
return <pre>{JSON.stringify(data, null, 2)}</pre>;
|
||||
}`}</Code>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">In JSON UI Trees</h2>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
AI can reference data paths in component props:
|
||||
</p>
|
||||
<Code lang="json">{`{
|
||||
"type": "Metric",
|
||||
"props": {
|
||||
"label": "Total Revenue",
|
||||
"valuePath": "/metrics/revenue",
|
||||
"format": "currency"
|
||||
}
|
||||
}`}</Code>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">Next</h2>
|
||||
<p className="text-sm text-muted-foreground">
|
||||
Learn about{" "}
|
||||
<Link href="/docs/actions" className="text-foreground hover:underline">
|
||||
actions
|
||||
</Link>{" "}
|
||||
for user interactions.
|
||||
</p>
|
||||
</article>
|
||||
);
|
||||
}
|
||||
@@ -0,0 +1,222 @@
|
||||
import { pageMetadata } from "@/lib/page-metadata"
|
||||
export const metadata = pageMetadata("docs/generation-modes")
|
||||
|
||||
# Generation Modes
|
||||
|
||||
json-render supports two modes for AI-generated UI: **Generate mode** for standalone UI and **Chat mode** for inline UI within a conversation.
|
||||
|
||||
The mode controls how the AI formats its output and how your app processes the stream. The underlying JSONL patch format is the same in both modes.
|
||||
|
||||
<GenerationModesDiagram />
|
||||
|
||||
## Generate Mode (Standalone)
|
||||
|
||||
In generate mode, the AI outputs **only JSONL patches** — no prose, no markdown. The entire response is a UI spec.
|
||||
|
||||
This is the default mode and is ideal for:
|
||||
|
||||
- Playground and builder tools
|
||||
- Form generators
|
||||
- Dashboard builders
|
||||
- Any UI where the generated interface is the whole response
|
||||
|
||||
### Setup
|
||||
|
||||
```typescript
|
||||
import { streamText } from "ai";
|
||||
|
||||
// Generate mode is the default (no mode option needed)
|
||||
const systemPrompt = catalog.prompt({
|
||||
customRules: [
|
||||
"Use Card as root for forms and small UIs.",
|
||||
"Use Grid for multi-column layouts.",
|
||||
],
|
||||
});
|
||||
|
||||
const result = streamText({
|
||||
model: "anthropic/claude-haiku-4.5",
|
||||
system: systemPrompt,
|
||||
prompt: userPrompt,
|
||||
});
|
||||
```
|
||||
|
||||
### Client
|
||||
|
||||
On the client, use `useUIStream` from `@json-render/react` or the lower-level `createSpecStreamCompiler` from `@json-render/core` to compile the JSONL stream into a spec:
|
||||
|
||||
```tsx
|
||||
import { useUIStream } from "@json-render/react";
|
||||
|
||||
function Playground() {
|
||||
const { spec, isStreaming, send } = useUIStream({
|
||||
api: "/api/generate",
|
||||
});
|
||||
|
||||
return (
|
||||
<Renderer
|
||||
spec={spec}
|
||||
registry={registry}
|
||||
loading={isStreaming}
|
||||
/>
|
||||
);
|
||||
}
|
||||
```
|
||||
|
||||
### Example output
|
||||
|
||||
The AI outputs only JSONL — one patch per line, no surrounding text:
|
||||
|
||||
```
|
||||
{"op":"add","path":"/root","value":"card-1"}
|
||||
{"op":"add","path":"/elements/card-1","value":{"type":"Card","props":{"title":"Sign In"},"children":["email","password","submit"]}}
|
||||
{"op":"add","path":"/elements/email","value":{"type":"Input","props":{"label":"Email","name":"email","type":"email"}}}
|
||||
{"op":"add","path":"/elements/password","value":{"type":"Input","props":{"label":"Password","name":"password","type":"password"}}}
|
||||
{"op":"add","path":"/elements/submit","value":{"type":"Button","props":{"label":"Sign In"}}}
|
||||
```
|
||||
|
||||
## Chat Mode (Inline)
|
||||
|
||||
In chat mode, the AI responds **conversationally first**, then outputs JSONL patches on their own lines. Text-only replies are allowed when no UI is needed (e.g. greetings, clarifying questions).
|
||||
|
||||
This is ideal for:
|
||||
|
||||
- AI chatbots with rich UI responses
|
||||
- Copilot experiences
|
||||
- Educational assistants
|
||||
- Any conversational interface where generated UI is embedded in chat messages
|
||||
|
||||
### Setup
|
||||
|
||||
```typescript
|
||||
import { streamText } from "ai";
|
||||
import { pipeJsonRender } from "@json-render/core";
|
||||
import { createUIMessageStream, createUIMessageStreamResponse } from "ai";
|
||||
|
||||
// Enable chat mode
|
||||
const systemPrompt = catalog.prompt({ mode: "chat" });
|
||||
|
||||
const result = streamText({
|
||||
model: yourModel,
|
||||
system: systemPrompt,
|
||||
messages,
|
||||
});
|
||||
|
||||
// In your API route, pipe the stream through pipeJsonRender
|
||||
// to separate text from JSONL patches
|
||||
const stream = createUIMessageStream({
|
||||
execute: async ({ writer }) => {
|
||||
writer.merge(pipeJsonRender(result.toUIMessageStream()));
|
||||
},
|
||||
});
|
||||
|
||||
return createUIMessageStreamResponse({ stream });
|
||||
```
|
||||
|
||||
`pipeJsonRender` inspects each line of the AI's response. Lines that parse as JSONL patches are emitted as `data-spec` parts (which the renderer picks up). Everything else is passed through as text.
|
||||
|
||||
### Client
|
||||
|
||||
On the client, use `useJsonRenderMessage` from `@json-render/react` to extract the spec from a chat message's parts:
|
||||
|
||||
```tsx
|
||||
import { useChat } from "@ai-sdk/react";
|
||||
import { useJsonRenderMessage } from "@json-render/react";
|
||||
|
||||
function Chat() {
|
||||
const { messages, input, handleInputChange, handleSubmit } = useChat();
|
||||
|
||||
return (
|
||||
<div>
|
||||
{messages.map((msg) => (
|
||||
<ChatMessage key={msg.id} message={msg} />
|
||||
))}
|
||||
{/* input form */}
|
||||
</div>
|
||||
);
|
||||
}
|
||||
|
||||
function ChatMessage({ message }) {
|
||||
const { spec } = useJsonRenderMessage(message.parts);
|
||||
|
||||
return (
|
||||
<div>
|
||||
{/* Render text parts */}
|
||||
{message.parts
|
||||
.filter((p) => p.type === "text")
|
||||
.map((p, i) => <p key={i}>{p.text}</p>)}
|
||||
|
||||
{/* Render the generated UI inline */}
|
||||
{spec && (
|
||||
<Renderer
|
||||
spec={spec}
|
||||
registry={registry}
|
||||
/>
|
||||
)}
|
||||
</div>
|
||||
);
|
||||
}
|
||||
```
|
||||
|
||||
### Example output
|
||||
|
||||
The AI writes a brief explanation, then JSONL patches on their own lines:
|
||||
|
||||
```
|
||||
Here's a dashboard showing the latest crypto prices:
|
||||
|
||||
{"op":"add","path":"/root","value":"dashboard"}
|
||||
{"op":"add","path":"/state/prices","value":[{"name":"Bitcoin","price":98450},{"name":"Ethereum","price":3120}]}
|
||||
{"op":"add","path":"/elements/dashboard","value":{"type":"Grid","props":{"columns":"2"},"children":["btc","eth"]}}
|
||||
{"op":"add","path":"/elements/btc","value":{"type":"Metric","props":{"label":"Bitcoin","value":{"$state":"/prices/0/price"}}}}
|
||||
{"op":"add","path":"/elements/eth","value":{"type":"Metric","props":{"label":"Ethereum","value":{"$state":"/prices/1/price"}}}}
|
||||
```
|
||||
|
||||
If the user asks a simple question ("what does BTC stand for?"), the AI replies with text only — no JSONL.
|
||||
|
||||
## Quick Comparison
|
||||
|
||||
<div className="my-6 overflow-x-auto">
|
||||
<table className="mdx-table w-full text-sm border-collapse">
|
||||
<thead>
|
||||
<tr>
|
||||
<th />
|
||||
<th>Generate</th>
|
||||
<th>Chat</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>Output format</td>
|
||||
<td>JSONL only</td>
|
||||
<td>Text + JSONL</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Text-only replies</td>
|
||||
<td>No</td>
|
||||
<td>Yes</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>System prompt</td>
|
||||
<td><code>{"catalog.prompt()"}</code></td>
|
||||
<td><code>{'catalog.prompt({ mode: "chat" })'}</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Stream utility</td>
|
||||
<td><code>{"useUIStream"}</code></td>
|
||||
<td><code>{"pipeJsonRender"}</code>{" + "}<code>{"useJsonRenderMessage"}</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Typical use case</td>
|
||||
<td>Playground, builders</td>
|
||||
<td>Chatbots, copilots</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
Both modes use the same JSONL patch format (RFC 6902) and the same catalog/registry system. The only difference is whether the AI is allowed to include prose alongside the patches.
|
||||
|
||||
## Next
|
||||
|
||||
- Learn about the [JSONL streaming format](/docs/streaming)
|
||||
- See the [AI SDK integration](/docs/ai-sdk) for setup with the Vercel AI SDK
|
||||
@@ -0,0 +1,53 @@
|
||||
import { pageMetadata } from "@/lib/page-metadata"
|
||||
export const metadata = pageMetadata("docs/installation")
|
||||
|
||||
# Installation
|
||||
|
||||
Install the core package plus your renderer of choice.
|
||||
|
||||
## For React UI
|
||||
|
||||
<PackageInstall packages="@json-render/core @json-render/react" />
|
||||
|
||||
## For React UI with shadcn/ui
|
||||
|
||||
Pre-built components for fast prototyping and production use:
|
||||
|
||||
<PackageInstall packages="@json-render/core @json-render/react @json-render/shadcn" />
|
||||
|
||||
Requires Tailwind CSS in your project. See the [@json-render/shadcn API reference](/docs/api/shadcn) for usage.
|
||||
|
||||
## For React Native
|
||||
|
||||
<PackageInstall packages="@json-render/core @json-render/react-native" />
|
||||
|
||||
## For Remotion Video
|
||||
|
||||
<PackageInstall packages="@json-render/core @json-render/remotion remotion @remotion/player" />
|
||||
|
||||
## For External State Management (Optional)
|
||||
|
||||
If you want to wire json-render to an existing state management library instead of the built-in store, install the adapter for your library:
|
||||
|
||||
<PackageInstall packages="@json-render/zustand" />
|
||||
|
||||
<PackageInstall packages="@json-render/redux" />
|
||||
|
||||
<PackageInstall packages="@json-render/jotai" />
|
||||
|
||||
See the [Data Binding](/docs/data-binding#external-store-controlled-mode) guide for usage.
|
||||
|
||||
## Peer Dependencies
|
||||
|
||||
json-render requires the following peer dependencies:
|
||||
|
||||
- `react` ^19.0.0
|
||||
- `zod` ^4.0.0
|
||||
|
||||
<PackageInstall packages="react zod" />
|
||||
|
||||
## For AI Integration
|
||||
|
||||
To use json-render with AI models, you'll also need the Vercel AI SDK:
|
||||
|
||||
<PackageInstall packages="ai" />
|
||||
@@ -1,43 +0,0 @@
|
||||
import { PackageInstall } from "@/components/package-install";
|
||||
|
||||
export const metadata = {
|
||||
title: "Installation | json-render",
|
||||
};
|
||||
|
||||
export default function InstallationPage() {
|
||||
return (
|
||||
<article>
|
||||
<h1 className="text-3xl font-bold mb-4">Installation</h1>
|
||||
<p className="text-muted-foreground mb-8">
|
||||
Install the core package plus your renderer of choice.
|
||||
</p>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">For React UI</h2>
|
||||
<PackageInstall packages="@json-render/core @json-render/react" />
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">For Remotion Video</h2>
|
||||
<PackageInstall packages="@json-render/core @json-render/remotion remotion @remotion/player" />
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">Peer Dependencies</h2>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
json-render requires the following peer dependencies:
|
||||
</p>
|
||||
<ul className="list-disc list-inside text-sm text-muted-foreground space-y-1 mb-4">
|
||||
<li>
|
||||
<code className="text-foreground">react</code> ^19.0.0
|
||||
</li>
|
||||
<li>
|
||||
<code className="text-foreground">zod</code> ^4.0.0
|
||||
</li>
|
||||
</ul>
|
||||
<PackageInstall packages="react zod" />
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">For AI Integration</h2>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
To use json-render with AI models, you'll also need the Vercel AI
|
||||
SDK:
|
||||
</p>
|
||||
<PackageInstall packages="ai" />
|
||||
</article>
|
||||
);
|
||||
}
|
||||
@@ -1,5 +1,6 @@
|
||||
import { DocsMobileNav } from "@/components/docs-mobile-nav";
|
||||
import { DocsSidebar } from "@/components/docs-sidebar";
|
||||
import { CopyPageButton } from "@/components/copy-page-button";
|
||||
|
||||
export default function DocsLayout({
|
||||
children,
|
||||
@@ -16,7 +17,12 @@ export default function DocsLayout({
|
||||
</aside>
|
||||
|
||||
{/* Content */}
|
||||
<div className="flex-1 min-w-0 max-w-2xl">{children}</div>
|
||||
<div className="flex-1 min-w-0 max-w-2xl pb-20">
|
||||
<div className="flex justify-end mb-4">
|
||||
<CopyPageButton />
|
||||
</div>
|
||||
<article>{children}</article>
|
||||
</div>
|
||||
</div>
|
||||
</>
|
||||
);
|
||||
|
||||
@@ -0,0 +1,413 @@
|
||||
import { pageMetadata } from "@/lib/page-metadata"
|
||||
export const metadata = pageMetadata("docs/migration")
|
||||
|
||||
# Migration Guide
|
||||
|
||||
This guide covers breaking changes introduced in v0.6.0 and how to update your code.
|
||||
|
||||
## State Provider
|
||||
|
||||
`DataProvider` has been renamed to `StateProvider`, and its props have changed.
|
||||
|
||||
**Before:**
|
||||
|
||||
```tsx
|
||||
import { DataProvider } from "@json-render/react";
|
||||
|
||||
<DataProvider data={myData} getValue={getter} setValue={setter}>
|
||||
{children}
|
||||
</DataProvider>
|
||||
```
|
||||
|
||||
**After:**
|
||||
|
||||
```tsx
|
||||
import { StateProvider } from "@json-render/react";
|
||||
|
||||
<StateProvider initialState={myData} onStateChange={(path, value) => console.log(path, value)}>
|
||||
{children}
|
||||
</StateProvider>
|
||||
```
|
||||
|
||||
`StateProvider` now manages state internally. Use `useStateStore()` to access `get`, `set`, and `update`.
|
||||
|
||||
| Before | After |
|
||||
|--------|-------|
|
||||
| `DataProvider` | `StateProvider` |
|
||||
| `data` prop | `initialState` prop |
|
||||
| `getValue` / `setValue` props | Removed (use `useStateStore()` hook for `get` / `set`) |
|
||||
| `useData` | `useStateStore` |
|
||||
| `useDataValue` | `useStateValue` |
|
||||
| `useDataBinding` | `useStateBinding` (deprecated, use `useBoundProp` instead) |
|
||||
| `DataModel` type | `StateModel` type |
|
||||
|
||||
## Dynamic Expressions
|
||||
|
||||
All dynamic value expressions have been renamed to use `$state`, `$item`, and `$index`.
|
||||
|
||||
**Before:**
|
||||
|
||||
```json
|
||||
{
|
||||
"type": "Text",
|
||||
"props": {
|
||||
"label": { "$path": "/user/name" },
|
||||
"count": { "$data": "/items/length" }
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**After:**
|
||||
|
||||
```json
|
||||
{
|
||||
"type": "Text",
|
||||
"props": {
|
||||
"label": { "$state": "/user/name" },
|
||||
"count": { "$state": "/items/length" }
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Inside repeat scopes, use `$item` and `$index`:
|
||||
|
||||
```json
|
||||
{
|
||||
"type": "Card",
|
||||
"props": {
|
||||
"title": { "$item": "name" },
|
||||
"subtitle": { "$index": true }
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
| Before | After |
|
||||
|--------|-------|
|
||||
| `{ "$path": "/..." }` | `{ "$state": "/..." }` |
|
||||
| `{ "$data": "/..." }` | `{ "$state": "/..." }` |
|
||||
|
||||
## Two-Way Binding
|
||||
|
||||
Form components no longer use `valuePath` / `statePath` props. Instead, use `$bindState` expressions on the value prop, and `useBoundProp` in your registry.
|
||||
|
||||
**Before (catalog):**
|
||||
|
||||
```typescript
|
||||
Input: {
|
||||
props: z.object({
|
||||
label: z.string(),
|
||||
valuePath: z.string(),
|
||||
placeholder: z.string().optional(),
|
||||
}),
|
||||
}
|
||||
```
|
||||
|
||||
**Before (spec):**
|
||||
|
||||
```json
|
||||
{
|
||||
"type": "Input",
|
||||
"props": { "label": "Email", "valuePath": "/form/email" }
|
||||
}
|
||||
```
|
||||
|
||||
**Before (registry):**
|
||||
|
||||
```tsx
|
||||
Input: ({ props }) => {
|
||||
const [value, setValue] = useStateBinding(props.valuePath);
|
||||
return <input value={value ?? ""} onChange={(e) => setValue(e.target.value)} />;
|
||||
}
|
||||
```
|
||||
|
||||
**After (catalog):**
|
||||
|
||||
```typescript
|
||||
Input: {
|
||||
props: z.object({
|
||||
label: z.string(),
|
||||
value: z.string().optional(),
|
||||
placeholder: z.string().optional(),
|
||||
}),
|
||||
}
|
||||
```
|
||||
|
||||
**After (spec):**
|
||||
|
||||
```json
|
||||
{
|
||||
"type": "Input",
|
||||
"props": { "label": "Email", "value": { "$bindState": "/form/email" } }
|
||||
}
|
||||
```
|
||||
|
||||
**After (registry):**
|
||||
|
||||
```tsx
|
||||
Input: ({ props, bindings }) => {
|
||||
const [value, setValue] = useBoundProp<string>(props.value, bindings?.value);
|
||||
return <input value={value ?? ""} onChange={(e) => setValue(e.target.value)} />;
|
||||
}
|
||||
```
|
||||
|
||||
`$bindState` reads from and writes to the given state path. Inside repeat scopes, use `$bindItem` to bind to a field on the current item:
|
||||
|
||||
```json
|
||||
{
|
||||
"type": "Checkbox",
|
||||
"props": { "checked": { "$bindItem": "completed" } }
|
||||
}
|
||||
```
|
||||
|
||||
## Visibility Conditions
|
||||
|
||||
Visibility conditions have been renamed to use `$state`, `$and`, and `$or`.
|
||||
|
||||
**Before:**
|
||||
|
||||
```json
|
||||
{ "path": "/isAdmin" }
|
||||
{ "eq": [{ "path": "/role" }, "admin"] }
|
||||
{ "and": [{ "path": "/isAdmin" }, { "path": "/feature" }] }
|
||||
{ "or": [{ "path": "/roleA" }, { "path": "/roleB" }] }
|
||||
```
|
||||
|
||||
**After:**
|
||||
|
||||
```json
|
||||
{ "$state": "/isAdmin" }
|
||||
{ "$state": "/role", "eq": "admin" }
|
||||
{ "$and": [{ "$state": "/isAdmin" }, { "$state": "/feature" }] }
|
||||
{ "$or": [{ "$state": "/roleA" }, { "$state": "/roleB" }] }
|
||||
```
|
||||
|
||||
You can also use an array as shorthand for `$and`:
|
||||
|
||||
```json
|
||||
[{ "$state": "/isAdmin" }, { "$state": "/feature" }]
|
||||
```
|
||||
|
||||
Inside repeat scopes, use `$item` and `$index`:
|
||||
|
||||
```json
|
||||
{ "$item": "isActive" }
|
||||
{ "$index": true, "eq": 0 }
|
||||
```
|
||||
|
||||
## Event System
|
||||
|
||||
Components now use `emit` to fire named events. `onAction` has been removed.
|
||||
|
||||
**Before:**
|
||||
|
||||
```tsx
|
||||
Button: ({ props, onAction }) => (
|
||||
<button onClick={() => onAction?.("press")}>{props.label}</button>
|
||||
)
|
||||
```
|
||||
|
||||
**After:**
|
||||
|
||||
```tsx
|
||||
Button: ({ props, emit }) => (
|
||||
<button onClick={() => emit("press")}>{props.label}</button>
|
||||
)
|
||||
```
|
||||
|
||||
`emit` is always defined (never `undefined`), so optional chaining is not needed.
|
||||
|
||||
## Actions Context
|
||||
|
||||
`dispatch` has been renamed to `execute`, and the provider prop has been renamed from `actionHandlers` to `handlers`.
|
||||
|
||||
**Before:**
|
||||
|
||||
```tsx
|
||||
const { dispatch } = useActions();
|
||||
dispatch({ action: "submit", params: {} });
|
||||
|
||||
<ActionProvider actionHandlers={myHandlers}>
|
||||
```
|
||||
|
||||
**After:**
|
||||
|
||||
```tsx
|
||||
const { execute } = useActions();
|
||||
execute({ action: "submit", params: {} });
|
||||
|
||||
<ActionProvider handlers={myHandlers}>
|
||||
```
|
||||
|
||||
## Repeat / List Rendering
|
||||
|
||||
The `repeat` field now uses `statePath` instead of `path`.
|
||||
|
||||
**Before:**
|
||||
|
||||
```json
|
||||
{
|
||||
"type": "Column",
|
||||
"repeat": { "path": "/todos", "key": "id" },
|
||||
"children": ["todo-item"]
|
||||
}
|
||||
```
|
||||
|
||||
**After:**
|
||||
|
||||
```json
|
||||
{
|
||||
"type": "Column",
|
||||
"repeat": { "statePath": "/todos", "key": "id" },
|
||||
"children": ["todo-item"]
|
||||
}
|
||||
```
|
||||
|
||||
## Catalog Creation
|
||||
|
||||
`createCatalog` and `generateSystemPrompt` have been replaced by `defineSchema` + `defineCatalog`.
|
||||
|
||||
**Before:**
|
||||
|
||||
```typescript
|
||||
import { createCatalog, generateSystemPrompt } from "@json-render/core";
|
||||
|
||||
const catalog = createCatalog({
|
||||
name: "my-app",
|
||||
components: { /* ... */ },
|
||||
actions: { /* ... */ },
|
||||
});
|
||||
|
||||
const prompt = generateSystemPrompt(catalog);
|
||||
```
|
||||
|
||||
**After:**
|
||||
|
||||
```typescript
|
||||
import { defineCatalog } from "@json-render/core";
|
||||
import { schema } from "@json-render/react/schema";
|
||||
|
||||
const catalog = defineCatalog(schema, {
|
||||
components: { /* ... */ },
|
||||
actions: { /* ... */ },
|
||||
});
|
||||
|
||||
const prompt = catalog.prompt();
|
||||
|
||||
// Chat mode prompt
|
||||
const chatPrompt = catalog.prompt({ mode: "chat" });
|
||||
```
|
||||
|
||||
## Validation
|
||||
|
||||
`ValidationCheck` now uses `type` instead of `fn`, `ValidationProvider` uses `customFunctions` instead of `functions`, and `useFieldValidation` takes a config object instead of a checks array.
|
||||
|
||||
**Before:**
|
||||
|
||||
```json
|
||||
{ "fn": "required", "message": "Required" }
|
||||
{ "fn": "minLength", "args": { "length": 8 }, "message": "Too short" }
|
||||
```
|
||||
|
||||
**After:**
|
||||
|
||||
```json
|
||||
{ "type": "required", "message": "Required" }
|
||||
{ "type": "minLength", "args": { "min": 8 }, "message": "Too short" }
|
||||
```
|
||||
|
||||
| Before | After |
|
||||
|--------|-------|
|
||||
| `{ fn: "required" }` | `{ type: "required" }` |
|
||||
| `ValidationProvider functions={...}` | `ValidationProvider customFunctions={...}` |
|
||||
| `useFieldValidation(path, checks)` | `useFieldValidation(path, config)` where config is `{ checks, validateOn? }` |
|
||||
|
||||
## Visibility Provider
|
||||
|
||||
The `auth` prop has been removed from `VisibilityProvider`. Auth state should be modeled as regular state.
|
||||
|
||||
**Before:**
|
||||
|
||||
```tsx
|
||||
<VisibilityProvider auth={{ isSignedIn: true, role: "admin" }}>
|
||||
```
|
||||
|
||||
```json
|
||||
{ "auth": "signedIn" }
|
||||
```
|
||||
|
||||
**After:**
|
||||
|
||||
```tsx
|
||||
<StateProvider initialState={{ auth: { isSignedIn: true, role: "admin" } }}>
|
||||
<VisibilityProvider>
|
||||
```
|
||||
|
||||
```json
|
||||
{ "$state": "/auth/isSignedIn" }
|
||||
```
|
||||
|
||||
## Codegen
|
||||
|
||||
`traverseTree` has been renamed to `traverseSpec`, `SpecVisitor` to `TreeVisitor`, and the visitor callback now receives a `key` parameter.
|
||||
|
||||
**Before:**
|
||||
|
||||
```typescript
|
||||
import { traverseTree } from "@json-render/codegen";
|
||||
|
||||
traverseTree(tree, (element) => {
|
||||
// ...
|
||||
});
|
||||
```
|
||||
|
||||
**After:**
|
||||
|
||||
```typescript
|
||||
import { traverseSpec } from "@json-render/codegen";
|
||||
|
||||
traverseSpec(spec, (element, key) => {
|
||||
// ...
|
||||
});
|
||||
```
|
||||
|
||||
## Action Params
|
||||
|
||||
Action params in specs now use `statePath` instead of `path`.
|
||||
|
||||
**Before:**
|
||||
|
||||
```json
|
||||
{
|
||||
"on": {
|
||||
"press": { "action": "setState", "params": { "path": "/count", "value": 0 } }
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**After:**
|
||||
|
||||
```json
|
||||
{
|
||||
"on": {
|
||||
"press": { "action": "setState", "params": { "statePath": "/count", "value": 0 } }
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Removed Exports
|
||||
|
||||
The following exports have been removed from `@json-render/core`:
|
||||
|
||||
| Removed | Replacement |
|
||||
|---------|-------------|
|
||||
| `createCatalog` | `defineCatalog(schema, config)` |
|
||||
| `generateCatalogPrompt` | `catalog.prompt()` |
|
||||
| `generateSystemPrompt` | `catalog.prompt()` |
|
||||
| `ComponentDefinition` | Use catalog component config directly |
|
||||
| `CatalogConfig` | Use `defineCatalog` parameters |
|
||||
| `SystemPromptOptions` | Use `PromptOptions` |
|
||||
| `LogicExpression` | Use `VisibilityCondition` |
|
||||
| `AuthState` | Model auth as regular state (e.g. `/auth/isSignedIn`) |
|
||||
| `evaluateLogicExpression` | Use `evaluateVisibility` |
|
||||
| `createRendererFromCatalog` | Use `defineRegistry` |
|
||||
| `traverseTree` (codegen) | Use `traverseSpec` |
|
||||
@@ -0,0 +1,283 @@
|
||||
import { pageMetadata } from "@/lib/page-metadata"
|
||||
export const metadata = pageMetadata("docs/openapi")
|
||||
|
||||
# OpenAPI Integration
|
||||
|
||||
Use json-render to generate dynamic forms and UIs from [OpenAPI/Swagger](https://swagger.io/specification/) schemas.
|
||||
|
||||
<div className="rounded-lg border border-amber-500/50 bg-amber-500/10 p-4 mb-8">
|
||||
<p className="text-sm text-amber-700 dark:text-amber-300">
|
||||
<strong>Concept:</strong> This page demonstrates how json-render can support OpenAPI schemas. The examples are illustrative and may require adaptation for production use.
|
||||
</p>
|
||||
</div>
|
||||
|
||||
## Why OpenAPI?
|
||||
|
||||
OpenAPI specifications describe your API's endpoints, request bodies, and response schemas. By converting OpenAPI schemas to json-render specs, you can:
|
||||
|
||||
- Automatically generate forms for API endpoints
|
||||
- Display API responses with type-aware rendering
|
||||
- Keep your UI in sync with your API schema
|
||||
- Let AI generate UIs that match your API contracts
|
||||
|
||||
## Example OpenAPI Schema
|
||||
|
||||
A typical OpenAPI schema for a request body:
|
||||
|
||||
```json
|
||||
{
|
||||
"openapi": "3.0.0",
|
||||
"paths": {
|
||||
"/users": {
|
||||
"post": {
|
||||
"summary": "Create a new user",
|
||||
"operationId": "createUser",
|
||||
"requestBody": {
|
||||
"required": true,
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/CreateUserRequest"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"components": {
|
||||
"schemas": {
|
||||
"CreateUserRequest": {
|
||||
"type": "object",
|
||||
"required": ["email", "name"],
|
||||
"properties": {
|
||||
"name": {
|
||||
"type": "string",
|
||||
"description": "User's full name",
|
||||
"minLength": 1,
|
||||
"maxLength": 100
|
||||
},
|
||||
"email": {
|
||||
"type": "string",
|
||||
"format": "email",
|
||||
"description": "User's email address"
|
||||
},
|
||||
"age": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 150,
|
||||
"description": "User's age"
|
||||
},
|
||||
"role": {
|
||||
"type": "string",
|
||||
"enum": ["admin", "user", "guest"],
|
||||
"default": "user",
|
||||
"description": "User's role"
|
||||
},
|
||||
"preferences": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"newsletter": {
|
||||
"type": "boolean",
|
||||
"default": false
|
||||
},
|
||||
"theme": {
|
||||
"type": "string",
|
||||
"enum": ["light", "dark", "system"]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Define an OpenAPI-to-UI Catalog
|
||||
|
||||
Create components that map to OpenAPI data types:
|
||||
|
||||
```typescript
|
||||
import { defineCatalog } from '@json-render/core';
|
||||
import { schema } from '@json-render/react/schema';
|
||||
import { z } from 'zod';
|
||||
|
||||
export const openapiCatalog = defineCatalog(schema, {
|
||||
components: {
|
||||
Form: {
|
||||
description: 'API form container',
|
||||
props: z.object({
|
||||
operationId: z.string(),
|
||||
endpoint: z.string(),
|
||||
method: z.enum(['GET', 'POST', 'PUT', 'PATCH', 'DELETE']),
|
||||
title: z.string().optional(),
|
||||
description: z.string().optional(),
|
||||
}),
|
||||
},
|
||||
StringField: {
|
||||
description: 'String input field',
|
||||
props: z.object({
|
||||
name: z.string(),
|
||||
label: z.string(),
|
||||
description: z.string().optional(),
|
||||
required: z.boolean().optional(),
|
||||
format: z.enum(['text', 'email', 'uri', 'uuid', 'date', 'date-time', 'password']).optional(),
|
||||
minLength: z.number().optional(),
|
||||
maxLength: z.number().optional(),
|
||||
pattern: z.string().optional(),
|
||||
placeholder: z.string().optional(),
|
||||
defaultValue: z.string().optional(),
|
||||
}),
|
||||
},
|
||||
NumberField: {
|
||||
description: 'Number input field',
|
||||
props: z.object({
|
||||
name: z.string(),
|
||||
label: z.string(),
|
||||
description: z.string().optional(),
|
||||
required: z.boolean().optional(),
|
||||
type: z.enum(['integer', 'number']).optional(),
|
||||
minimum: z.number().optional(),
|
||||
maximum: z.number().optional(),
|
||||
defaultValue: z.number().optional(),
|
||||
}),
|
||||
},
|
||||
BooleanField: {
|
||||
description: 'Boolean toggle field',
|
||||
props: z.object({
|
||||
name: z.string(),
|
||||
label: z.string(),
|
||||
description: z.string().optional(),
|
||||
defaultValue: z.boolean().optional(),
|
||||
}),
|
||||
},
|
||||
EnumField: {
|
||||
description: 'Enum selection field',
|
||||
props: z.object({
|
||||
name: z.string(),
|
||||
label: z.string(),
|
||||
description: z.string().optional(),
|
||||
required: z.boolean().optional(),
|
||||
options: z.array(z.object({
|
||||
value: z.string(),
|
||||
label: z.string().optional(),
|
||||
})),
|
||||
defaultValue: z.string().optional(),
|
||||
}),
|
||||
},
|
||||
ObjectField: {
|
||||
description: 'Nested object group',
|
||||
props: z.object({
|
||||
name: z.string(),
|
||||
label: z.string(),
|
||||
description: z.string().optional(),
|
||||
collapsible: z.boolean().optional(),
|
||||
}),
|
||||
},
|
||||
},
|
||||
actions: {
|
||||
submit: {
|
||||
description: 'Submit form to API endpoint',
|
||||
params: z.object({ operationId: z.string() }),
|
||||
},
|
||||
reset: {
|
||||
description: 'Reset form to defaults',
|
||||
params: z.object({}),
|
||||
},
|
||||
},
|
||||
});
|
||||
```
|
||||
|
||||
## Convert OpenAPI Schema to Spec
|
||||
|
||||
Transform OpenAPI schemas into json-render specs by recursively walking the schema properties and mapping each type to the corresponding catalog component. The converter handles nested objects, enums, arrays, and all primitive types.
|
||||
|
||||
## Usage Example
|
||||
|
||||
```tsx
|
||||
'use client';
|
||||
|
||||
import { OpenAPIForm } from './openapi-form';
|
||||
import { operationToSpec } from './openapi-to-spec';
|
||||
|
||||
// Your OpenAPI schema (typically loaded from your API)
|
||||
const createUserSchema = {
|
||||
type: 'object',
|
||||
required: ['email', 'name'],
|
||||
properties: {
|
||||
name: { type: 'string', description: "User's full name" },
|
||||
email: { type: 'string', format: 'email', description: "User's email" },
|
||||
age: { type: 'integer', minimum: 0, maximum: 150 },
|
||||
role: { type: 'string', enum: ['admin', 'user', 'guest'], default: 'user' },
|
||||
},
|
||||
};
|
||||
|
||||
// Convert to spec
|
||||
const spec = operationToSpec(
|
||||
'createUser',
|
||||
'POST',
|
||||
'/api/users',
|
||||
createUserSchema,
|
||||
'Create User',
|
||||
'Add a new user to the system',
|
||||
);
|
||||
|
||||
export function CreateUserForm() {
|
||||
const handleSubmit = async (data: Record<string, unknown>) => {
|
||||
const response = await fetch('/api/users', {
|
||||
method: 'POST',
|
||||
headers: { 'Content-Type': 'application/json' },
|
||||
body: JSON.stringify(data),
|
||||
});
|
||||
|
||||
if (response.ok) {
|
||||
console.log('User created!');
|
||||
}
|
||||
};
|
||||
|
||||
return <OpenAPIForm spec={spec} onSubmit={handleSubmit} />;
|
||||
}
|
||||
```
|
||||
|
||||
## Auto-generating from OpenAPI Document
|
||||
|
||||
Load and parse an OpenAPI document to generate forms for all operations:
|
||||
|
||||
```typescript
|
||||
import SwaggerParser from '@apidevtools/swagger-parser';
|
||||
import { operationToSpec } from './openapi-to-spec';
|
||||
|
||||
export async function loadOpenAPISpecs(specUrl: string) {
|
||||
const api = await SwaggerParser.dereference(specUrl);
|
||||
const specs: Record<string, any> = {};
|
||||
|
||||
for (const [path, methods] of Object.entries(api.paths)) {
|
||||
for (const [method, operation] of Object.entries(methods)) {
|
||||
if (!operation.requestBody?.content?.['application/json']?.schema) continue;
|
||||
|
||||
const schema = operation.requestBody.content['application/json'].schema;
|
||||
const operationId = operation.operationId || `${method}_${path.replace(/\//g, '_')}`;
|
||||
|
||||
specs[operationId] = operationToSpec(
|
||||
operationId,
|
||||
method,
|
||||
path,
|
||||
schema,
|
||||
operation.summary,
|
||||
operation.description,
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
return specs;
|
||||
}
|
||||
|
||||
// Usage
|
||||
const specs = await loadOpenAPISpecs('https://api.example.com/openapi.json');
|
||||
// specs.createUser, specs.updateUser, etc.
|
||||
```
|
||||
|
||||
## Next
|
||||
|
||||
Learn about [streaming](/docs/streaming) for progressive UI rendering.
|
||||
@@ -1,718 +0,0 @@
|
||||
import Link from "next/link";
|
||||
import { Code } from "@/components/code";
|
||||
|
||||
export const metadata = {
|
||||
title: "OpenAPI Integration | json-render",
|
||||
};
|
||||
|
||||
export default function OpenAPIPage() {
|
||||
return (
|
||||
<article>
|
||||
<h1 className="text-3xl font-bold mb-4">OpenAPI Integration</h1>
|
||||
<p className="text-muted-foreground mb-8">
|
||||
Use json-render to generate dynamic forms and UIs from{" "}
|
||||
<a
|
||||
href="https://swagger.io/specification/"
|
||||
target="_blank"
|
||||
rel="noopener noreferrer"
|
||||
className="text-foreground hover:underline"
|
||||
>
|
||||
OpenAPI/Swagger
|
||||
</a>{" "}
|
||||
schemas.
|
||||
</p>
|
||||
|
||||
<div className="rounded-lg border border-amber-500/50 bg-amber-500/10 p-4 mb-8">
|
||||
<p className="text-sm text-amber-700 dark:text-amber-300">
|
||||
<strong>Concept:</strong> This page demonstrates how json-render can
|
||||
support OpenAPI schemas. The examples are illustrative and may require
|
||||
adaptation for production use.
|
||||
</p>
|
||||
</div>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">Why OpenAPI?</h2>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
OpenAPI specifications describe your API{"'"}s endpoints, request
|
||||
bodies, and response schemas. By converting OpenAPI schemas to
|
||||
json-render specs, you can:
|
||||
</p>
|
||||
<ul className="list-disc list-inside text-sm text-muted-foreground space-y-1 mb-4">
|
||||
<li>Automatically generate forms for API endpoints</li>
|
||||
<li>Display API responses with type-aware rendering</li>
|
||||
<li>Keep your UI in sync with your API schema</li>
|
||||
<li>Let AI generate UIs that match your API contracts</li>
|
||||
</ul>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">
|
||||
Example OpenAPI Schema
|
||||
</h2>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
A typical OpenAPI schema for a request body:
|
||||
</p>
|
||||
<Code lang="json">{`{
|
||||
"openapi": "3.0.0",
|
||||
"paths": {
|
||||
"/users": {
|
||||
"post": {
|
||||
"summary": "Create a new user",
|
||||
"operationId": "createUser",
|
||||
"requestBody": {
|
||||
"required": true,
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/CreateUserRequest"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"components": {
|
||||
"schemas": {
|
||||
"CreateUserRequest": {
|
||||
"type": "object",
|
||||
"required": ["email", "name"],
|
||||
"properties": {
|
||||
"name": {
|
||||
"type": "string",
|
||||
"description": "User's full name",
|
||||
"minLength": 1,
|
||||
"maxLength": 100
|
||||
},
|
||||
"email": {
|
||||
"type": "string",
|
||||
"format": "email",
|
||||
"description": "User's email address"
|
||||
},
|
||||
"age": {
|
||||
"type": "integer",
|
||||
"minimum": 0,
|
||||
"maximum": 150,
|
||||
"description": "User's age"
|
||||
},
|
||||
"role": {
|
||||
"type": "string",
|
||||
"enum": ["admin", "user", "guest"],
|
||||
"default": "user",
|
||||
"description": "User's role"
|
||||
},
|
||||
"preferences": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"newsletter": {
|
||||
"type": "boolean",
|
||||
"default": false
|
||||
},
|
||||
"theme": {
|
||||
"type": "string",
|
||||
"enum": ["light", "dark", "system"]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}`}</Code>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">
|
||||
Define an OpenAPI-to-UI Catalog
|
||||
</h2>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
Create components that map to OpenAPI data types:
|
||||
</p>
|
||||
<Code lang="typescript">{`import { createCatalog } from '@json-render/core';
|
||||
import { z } from 'zod';
|
||||
|
||||
export const openapiCatalog = createCatalog({
|
||||
components: {
|
||||
// Form container
|
||||
Form: {
|
||||
description: 'API form container',
|
||||
props: z.object({
|
||||
operationId: z.string(),
|
||||
endpoint: z.string(),
|
||||
method: z.enum(['GET', 'POST', 'PUT', 'PATCH', 'DELETE']),
|
||||
title: z.string().optional(),
|
||||
description: z.string().optional(),
|
||||
}),
|
||||
},
|
||||
|
||||
// Field components mapped to OpenAPI types
|
||||
StringField: {
|
||||
description: 'String input field',
|
||||
props: z.object({
|
||||
name: z.string(),
|
||||
label: z.string(),
|
||||
description: z.string().optional(),
|
||||
required: z.boolean().optional(),
|
||||
format: z.enum(['text', 'email', 'uri', 'uuid', 'date', 'date-time', 'password']).optional(),
|
||||
minLength: z.number().optional(),
|
||||
maxLength: z.number().optional(),
|
||||
pattern: z.string().optional(),
|
||||
placeholder: z.string().optional(),
|
||||
defaultValue: z.string().optional(),
|
||||
}),
|
||||
},
|
||||
|
||||
NumberField: {
|
||||
description: 'Number input field',
|
||||
props: z.object({
|
||||
name: z.string(),
|
||||
label: z.string(),
|
||||
description: z.string().optional(),
|
||||
required: z.boolean().optional(),
|
||||
type: z.enum(['integer', 'number']).optional(),
|
||||
minimum: z.number().optional(),
|
||||
maximum: z.number().optional(),
|
||||
exclusiveMinimum: z.number().optional(),
|
||||
exclusiveMaximum: z.number().optional(),
|
||||
multipleOf: z.number().optional(),
|
||||
defaultValue: z.number().optional(),
|
||||
}),
|
||||
},
|
||||
|
||||
BooleanField: {
|
||||
description: 'Boolean toggle field',
|
||||
props: z.object({
|
||||
name: z.string(),
|
||||
label: z.string(),
|
||||
description: z.string().optional(),
|
||||
defaultValue: z.boolean().optional(),
|
||||
}),
|
||||
},
|
||||
|
||||
EnumField: {
|
||||
description: 'Enum selection field',
|
||||
props: z.object({
|
||||
name: z.string(),
|
||||
label: z.string(),
|
||||
description: z.string().optional(),
|
||||
required: z.boolean().optional(),
|
||||
options: z.array(z.object({
|
||||
value: z.string(),
|
||||
label: z.string().optional(),
|
||||
})),
|
||||
defaultValue: z.string().optional(),
|
||||
}),
|
||||
},
|
||||
|
||||
ArrayField: {
|
||||
description: 'Array of items',
|
||||
props: z.object({
|
||||
name: z.string(),
|
||||
label: z.string(),
|
||||
description: z.string().optional(),
|
||||
minItems: z.number().optional(),
|
||||
maxItems: z.number().optional(),
|
||||
uniqueItems: z.boolean().optional(),
|
||||
}),
|
||||
},
|
||||
|
||||
ObjectField: {
|
||||
description: 'Nested object group',
|
||||
props: z.object({
|
||||
name: z.string(),
|
||||
label: z.string(),
|
||||
description: z.string().optional(),
|
||||
collapsible: z.boolean().optional(),
|
||||
}),
|
||||
},
|
||||
|
||||
// Response display components
|
||||
ResponseDisplay: {
|
||||
description: 'Displays API response',
|
||||
props: z.object({
|
||||
status: z.number(),
|
||||
statusText: z.string().optional(),
|
||||
}),
|
||||
},
|
||||
|
||||
SchemaTable: {
|
||||
description: 'Displays data matching a schema',
|
||||
props: z.object({
|
||||
schema: z.string(),
|
||||
data: z.array(z.record(z.unknown())),
|
||||
}),
|
||||
},
|
||||
},
|
||||
|
||||
actions: {
|
||||
submit: {
|
||||
description: 'Submit form to API endpoint',
|
||||
params: z.object({
|
||||
operationId: z.string(),
|
||||
}),
|
||||
},
|
||||
reset: {
|
||||
description: 'Reset form to defaults',
|
||||
params: z.object({}),
|
||||
},
|
||||
},
|
||||
});`}</Code>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">
|
||||
Convert OpenAPI Schema to Spec
|
||||
</h2>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
Transform OpenAPI schemas into json-render specs:
|
||||
</p>
|
||||
<Code lang="typescript">{`interface OpenAPISchema {
|
||||
type?: string;
|
||||
format?: string;
|
||||
enum?: string[];
|
||||
properties?: Record<string, OpenAPISchema>;
|
||||
items?: OpenAPISchema;
|
||||
required?: string[];
|
||||
description?: string;
|
||||
minimum?: number;
|
||||
maximum?: number;
|
||||
minLength?: number;
|
||||
maxLength?: number;
|
||||
default?: unknown;
|
||||
}
|
||||
|
||||
interface SpecElement {
|
||||
key: string;
|
||||
type: string;
|
||||
props: Record<string, unknown>;
|
||||
children: string[];
|
||||
parentKey: string;
|
||||
}
|
||||
|
||||
function schemaToSpec(
|
||||
schema: OpenAPISchema,
|
||||
name: string,
|
||||
required: string[] = [],
|
||||
parentKey: string = '',
|
||||
elements: Map<string, SpecElement> = new Map(),
|
||||
): string {
|
||||
const key = parentKey ? \`\${parentKey}-\${name}\` : name;
|
||||
const isRequired = required.includes(name);
|
||||
const label = name.charAt(0).toUpperCase() + name.slice(1).replace(/([A-Z])/g, ' $1');
|
||||
|
||||
if (schema.enum) {
|
||||
elements.set(key, {
|
||||
key,
|
||||
type: 'EnumField',
|
||||
props: {
|
||||
name,
|
||||
label,
|
||||
description: schema.description,
|
||||
required: isRequired,
|
||||
options: schema.enum.map(v => ({ value: v, label: v })),
|
||||
defaultValue: schema.default as string,
|
||||
},
|
||||
children: [],
|
||||
parentKey,
|
||||
});
|
||||
} else if (schema.type === 'string') {
|
||||
elements.set(key, {
|
||||
key,
|
||||
type: 'StringField',
|
||||
props: {
|
||||
name,
|
||||
label,
|
||||
description: schema.description,
|
||||
required: isRequired,
|
||||
format: schema.format || 'text',
|
||||
minLength: schema.minLength,
|
||||
maxLength: schema.maxLength,
|
||||
defaultValue: schema.default as string,
|
||||
},
|
||||
children: [],
|
||||
parentKey,
|
||||
});
|
||||
} else if (schema.type === 'integer' || schema.type === 'number') {
|
||||
elements.set(key, {
|
||||
key,
|
||||
type: 'NumberField',
|
||||
props: {
|
||||
name,
|
||||
label,
|
||||
description: schema.description,
|
||||
required: isRequired,
|
||||
type: schema.type,
|
||||
minimum: schema.minimum,
|
||||
maximum: schema.maximum,
|
||||
defaultValue: schema.default as number,
|
||||
},
|
||||
children: [],
|
||||
parentKey,
|
||||
});
|
||||
} else if (schema.type === 'boolean') {
|
||||
elements.set(key, {
|
||||
key,
|
||||
type: 'BooleanField',
|
||||
props: {
|
||||
name,
|
||||
label,
|
||||
description: schema.description,
|
||||
defaultValue: schema.default as boolean,
|
||||
},
|
||||
children: [],
|
||||
parentKey,
|
||||
});
|
||||
} else if (schema.type === 'array' && schema.items) {
|
||||
const childKeys: string[] = [];
|
||||
const itemKey = schemaToSpec(schema.items, 'item', [], key, elements);
|
||||
childKeys.push(itemKey);
|
||||
|
||||
elements.set(key, {
|
||||
key,
|
||||
type: 'ArrayField',
|
||||
props: {
|
||||
name,
|
||||
label,
|
||||
description: schema.description,
|
||||
},
|
||||
children: childKeys,
|
||||
parentKey,
|
||||
});
|
||||
} else if (schema.type === 'object' && schema.properties) {
|
||||
const childKeys: string[] = [];
|
||||
|
||||
for (const [propName, propSchema] of Object.entries(schema.properties)) {
|
||||
const childKey = schemaToSpec(
|
||||
propSchema,
|
||||
propName,
|
||||
schema.required || [],
|
||||
key,
|
||||
elements,
|
||||
);
|
||||
childKeys.push(childKey);
|
||||
}
|
||||
|
||||
elements.set(key, {
|
||||
key,
|
||||
type: 'ObjectField',
|
||||
props: {
|
||||
name,
|
||||
label,
|
||||
description: schema.description,
|
||||
},
|
||||
children: childKeys,
|
||||
parentKey,
|
||||
});
|
||||
}
|
||||
|
||||
return key;
|
||||
}
|
||||
|
||||
// Convert full OpenAPI operation to spec
|
||||
export function operationToSpec(
|
||||
operationId: string,
|
||||
method: string,
|
||||
path: string,
|
||||
schema: OpenAPISchema,
|
||||
title?: string,
|
||||
description?: string,
|
||||
) {
|
||||
const elements = new Map<string, SpecElement>();
|
||||
const rootKey = 'form';
|
||||
const childKeys: string[] = [];
|
||||
|
||||
if (schema.properties) {
|
||||
for (const [name, propSchema] of Object.entries(schema.properties)) {
|
||||
const childKey = schemaToSpec(
|
||||
propSchema,
|
||||
name,
|
||||
schema.required || [],
|
||||
rootKey,
|
||||
elements,
|
||||
);
|
||||
childKeys.push(childKey);
|
||||
}
|
||||
}
|
||||
|
||||
elements.set(rootKey, {
|
||||
key: rootKey,
|
||||
type: 'Form',
|
||||
props: {
|
||||
operationId,
|
||||
endpoint: path,
|
||||
method: method.toUpperCase(),
|
||||
title,
|
||||
description,
|
||||
},
|
||||
children: childKeys,
|
||||
parentKey: '',
|
||||
});
|
||||
|
||||
return {
|
||||
root: rootKey,
|
||||
elements: Object.fromEntries(elements),
|
||||
};
|
||||
}`}</Code>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">
|
||||
Build an OpenAPI Form Renderer
|
||||
</h2>
|
||||
<Code lang="tsx">{`'use client';
|
||||
|
||||
import React, { useState } from 'react';
|
||||
|
||||
interface FieldProps {
|
||||
name: string;
|
||||
value: unknown;
|
||||
onChange: (name: string, value: unknown) => void;
|
||||
}
|
||||
|
||||
const fields: Record<string, React.FC<any>> = {
|
||||
StringField: ({ name, label, description, required, format, value, onChange }) => (
|
||||
<div className="space-y-1">
|
||||
<label className="text-sm font-medium">
|
||||
{label} {required && <span className="text-red-500">*</span>}
|
||||
</label>
|
||||
{description && <p className="text-xs text-muted-foreground">{description}</p>}
|
||||
<input
|
||||
type={format === 'email' ? 'email' : format === 'password' ? 'password' : 'text'}
|
||||
className="w-full px-3 py-2 border rounded text-sm"
|
||||
value={(value as string) || ''}
|
||||
onChange={(e) => onChange(name, e.target.value)}
|
||||
required={required}
|
||||
/>
|
||||
</div>
|
||||
),
|
||||
|
||||
NumberField: ({ name, label, description, required, minimum, maximum, value, onChange }) => (
|
||||
<div className="space-y-1">
|
||||
<label className="text-sm font-medium">
|
||||
{label} {required && <span className="text-red-500">*</span>}
|
||||
</label>
|
||||
{description && <p className="text-xs text-muted-foreground">{description}</p>}
|
||||
<input
|
||||
type="number"
|
||||
className="w-full px-3 py-2 border rounded text-sm"
|
||||
value={(value as number) ?? ''}
|
||||
min={minimum}
|
||||
max={maximum}
|
||||
onChange={(e) => onChange(name, e.target.value ? parseFloat(e.target.value) : undefined)}
|
||||
required={required}
|
||||
/>
|
||||
</div>
|
||||
),
|
||||
|
||||
BooleanField: ({ name, label, description, value, onChange }) => (
|
||||
<div className="flex items-start gap-2">
|
||||
<input
|
||||
type="checkbox"
|
||||
id={name}
|
||||
checked={Boolean(value)}
|
||||
onChange={(e) => onChange(name, e.target.checked)}
|
||||
className="mt-1"
|
||||
/>
|
||||
<div>
|
||||
<label htmlFor={name} className="text-sm font-medium">{label}</label>
|
||||
{description && <p className="text-xs text-muted-foreground">{description}</p>}
|
||||
</div>
|
||||
</div>
|
||||
),
|
||||
|
||||
EnumField: ({ name, label, description, required, options, value, onChange }) => (
|
||||
<div className="space-y-1">
|
||||
<label className="text-sm font-medium">
|
||||
{label} {required && <span className="text-red-500">*</span>}
|
||||
</label>
|
||||
{description && <p className="text-xs text-muted-foreground">{description}</p>}
|
||||
<select
|
||||
className="w-full px-3 py-2 border rounded text-sm"
|
||||
value={(value as string) || ''}
|
||||
onChange={(e) => onChange(name, e.target.value)}
|
||||
required={required}
|
||||
>
|
||||
<option value="">Select...</option>
|
||||
{options?.map((opt: any) => (
|
||||
<option key={opt.value} value={opt.value}>
|
||||
{opt.label || opt.value}
|
||||
</option>
|
||||
))}
|
||||
</select>
|
||||
</div>
|
||||
),
|
||||
|
||||
ObjectField: ({ name, label, description, children }) => (
|
||||
<fieldset className="border rounded p-4 space-y-4">
|
||||
<legend className="text-sm font-medium px-2">{label}</legend>
|
||||
{description && <p className="text-xs text-muted-foreground">{description}</p>}
|
||||
{children}
|
||||
</fieldset>
|
||||
),
|
||||
|
||||
Form: ({ title, description, endpoint, method, children, onSubmit }) => (
|
||||
<form
|
||||
className="space-y-4 max-w-md"
|
||||
onSubmit={(e) => {
|
||||
e.preventDefault();
|
||||
onSubmit?.();
|
||||
}}
|
||||
>
|
||||
{title && <h2 className="text-lg font-semibold">{title}</h2>}
|
||||
{description && <p className="text-sm text-muted-foreground">{description}</p>}
|
||||
{children}
|
||||
<button
|
||||
type="submit"
|
||||
className="px-4 py-2 bg-primary text-primary-foreground rounded text-sm"
|
||||
>
|
||||
{method === 'POST' ? 'Create' : method === 'PUT' ? 'Update' : 'Submit'}
|
||||
</button>
|
||||
</form>
|
||||
),
|
||||
};
|
||||
|
||||
interface OpenAPIFormProps {
|
||||
spec: {
|
||||
root: string;
|
||||
elements: Record<string, any>;
|
||||
};
|
||||
onSubmit: (data: Record<string, unknown>) => void;
|
||||
}
|
||||
|
||||
export function OpenAPIForm({ spec, onSubmit }: OpenAPIFormProps) {
|
||||
const [formData, setFormData] = useState<Record<string, unknown>>({});
|
||||
|
||||
const handleChange = (name: string, value: unknown) => {
|
||||
setFormData(prev => ({ ...prev, [name]: value }));
|
||||
};
|
||||
|
||||
function renderElement(key: string): React.ReactNode {
|
||||
const element = spec.elements[key];
|
||||
if (!element) return null;
|
||||
|
||||
const Field = fields[element.type];
|
||||
if (!Field) return null;
|
||||
|
||||
const children = element.children?.map(renderElement);
|
||||
|
||||
return (
|
||||
<Field
|
||||
key={key}
|
||||
{...element.props}
|
||||
value={formData[element.props.name]}
|
||||
onChange={handleChange}
|
||||
onSubmit={() => onSubmit(formData)}
|
||||
>
|
||||
{children}
|
||||
</Field>
|
||||
);
|
||||
}
|
||||
|
||||
return <>{renderElement(spec.root)}</>;
|
||||
}`}</Code>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">Usage Example</h2>
|
||||
<Code lang="tsx">{`'use client';
|
||||
|
||||
import { OpenAPIForm } from './openapi-form';
|
||||
import { operationToSpec } from './openapi-to-spec';
|
||||
|
||||
// Your OpenAPI schema (typically loaded from your API)
|
||||
const createUserSchema = {
|
||||
type: 'object',
|
||||
required: ['email', 'name'],
|
||||
properties: {
|
||||
name: { type: 'string', description: "User's full name" },
|
||||
email: { type: 'string', format: 'email', description: "User's email" },
|
||||
age: { type: 'integer', minimum: 0, maximum: 150 },
|
||||
role: { type: 'string', enum: ['admin', 'user', 'guest'], default: 'user' },
|
||||
},
|
||||
};
|
||||
|
||||
// Convert to spec
|
||||
const spec = operationToSpec(
|
||||
'createUser',
|
||||
'POST',
|
||||
'/api/users',
|
||||
createUserSchema,
|
||||
'Create User',
|
||||
'Add a new user to the system',
|
||||
);
|
||||
|
||||
export function CreateUserForm() {
|
||||
const handleSubmit = async (data: Record<string, unknown>) => {
|
||||
const response = await fetch('/api/users', {
|
||||
method: 'POST',
|
||||
headers: { 'Content-Type': 'application/json' },
|
||||
body: JSON.stringify(data),
|
||||
});
|
||||
|
||||
if (response.ok) {
|
||||
console.log('User created!');
|
||||
}
|
||||
};
|
||||
|
||||
return <OpenAPIForm spec={spec} onSubmit={handleSubmit} />;
|
||||
}`}</Code>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">
|
||||
Auto-generating from OpenAPI Document
|
||||
</h2>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
Load and parse an OpenAPI document to generate forms for all operations:
|
||||
</p>
|
||||
<Code lang="typescript">{`import SwaggerParser from '@apidevtools/swagger-parser';
|
||||
import { operationToSpec } from './openapi-to-spec';
|
||||
|
||||
interface OpenAPIDocument {
|
||||
paths: Record<string, Record<string, {
|
||||
operationId?: string;
|
||||
summary?: string;
|
||||
description?: string;
|
||||
requestBody?: {
|
||||
content?: {
|
||||
'application/json'?: {
|
||||
schema?: any;
|
||||
};
|
||||
};
|
||||
};
|
||||
}>>;
|
||||
components?: {
|
||||
schemas?: Record<string, any>;
|
||||
};
|
||||
}
|
||||
|
||||
export async function loadOpenAPISpecs(specUrl: string) {
|
||||
const api = await SwaggerParser.dereference(specUrl) as OpenAPIDocument;
|
||||
const specs: Record<string, any> = {};
|
||||
|
||||
for (const [path, methods] of Object.entries(api.paths)) {
|
||||
for (const [method, operation] of Object.entries(methods)) {
|
||||
if (!operation.requestBody?.content?.['application/json']?.schema) continue;
|
||||
|
||||
const schema = operation.requestBody.content['application/json'].schema;
|
||||
const operationId = operation.operationId || \`\${method}_\${path.replace(/\\//g, '_')}\`;
|
||||
|
||||
specs[operationId] = operationToSpec(
|
||||
operationId,
|
||||
method,
|
||||
path,
|
||||
schema,
|
||||
operation.summary,
|
||||
operation.description,
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
return specs;
|
||||
}
|
||||
|
||||
// Usage
|
||||
const specs = await loadOpenAPISpecs('https://api.example.com/openapi.json');
|
||||
// specs.createUser, specs.updateUser, etc.`}</Code>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">Next</h2>
|
||||
<p className="text-sm text-muted-foreground">
|
||||
Learn about{" "}
|
||||
<Link
|
||||
href="/docs/streaming"
|
||||
className="text-foreground hover:underline"
|
||||
>
|
||||
streaming
|
||||
</Link>{" "}
|
||||
for progressive UI rendering.
|
||||
</p>
|
||||
</article>
|
||||
);
|
||||
}
|
||||
@@ -0,0 +1,99 @@
|
||||
import { pageMetadata } from "@/lib/page-metadata"
|
||||
export const metadata = pageMetadata("docs")
|
||||
|
||||
# Introduction
|
||||
|
||||
json-render is a framework for **Generative UI** — AI-generated interfaces that are safe, predictable, and render natively on any platform.
|
||||
|
||||
## What is Generative UI?
|
||||
|
||||
Most AI integrations treat the interface as fixed. Developers build layouts ahead of time, and AI fills in the data — a chatbot response, a summary, a recommendation. The UI itself never changes.
|
||||
|
||||
**Generative UI is different.** The AI generates the interface itself: which components to show, how to arrange them, what data to bind, what actions to wire up. Every response can produce a unique, purpose-built UI tailored to the user's request.
|
||||
|
||||
The challenge is that unconstrained AI output is unpredictable. It can hallucinate component names, produce invalid structures, or generate unsafe code. You need a way to let AI be creative with layout and composition while keeping it within boundaries you control.
|
||||
|
||||
That is what json-render does. You define a **catalog** of components and actions. AI generates JSON constrained to that catalog. Your components render the result natively — on web or mobile — with full type safety and no arbitrary code execution.
|
||||
|
||||
## How json-render Works
|
||||
|
||||
### 1. Define your catalog
|
||||
|
||||
A catalog declares what AI can use: components with typed props, actions with typed params.
|
||||
|
||||
```typescript
|
||||
import { defineCatalog } from '@json-render/core';
|
||||
import { schema } from '@json-render/react/schema';
|
||||
import { z } from 'zod';
|
||||
|
||||
export const catalog = defineCatalog(schema, {
|
||||
components: {
|
||||
Card: {
|
||||
props: z.object({ title: z.string() }),
|
||||
slots: ["default"],
|
||||
},
|
||||
Metric: {
|
||||
props: z.object({
|
||||
label: z.string(),
|
||||
value: z.string(),
|
||||
}),
|
||||
},
|
||||
},
|
||||
});
|
||||
```
|
||||
|
||||
### 2. AI generates a spec
|
||||
|
||||
Given a prompt like "show me a revenue dashboard", AI outputs a JSON spec — a flat tree of elements constrained to your catalog:
|
||||
|
||||
```json
|
||||
{
|
||||
"root": "card-1",
|
||||
"elements": {
|
||||
"card-1": {
|
||||
"type": "Card",
|
||||
"props": { "title": "Revenue Dashboard" },
|
||||
"children": ["metric-1", "metric-2"]
|
||||
},
|
||||
"metric-1": {
|
||||
"type": "Metric",
|
||||
"props": { "label": "Total Revenue", "value": "$48,200" }
|
||||
},
|
||||
"metric-2": {
|
||||
"type": "Metric",
|
||||
"props": { "label": "Growth", "value": "+12%" }
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 3. Your components render it
|
||||
|
||||
Map catalog types to real components with a registry, then render the spec:
|
||||
|
||||
```tsx
|
||||
import { Renderer, StateProvider, VisibilityProvider } from '@json-render/react';
|
||||
|
||||
<StateProvider initialState={{}}>
|
||||
<VisibilityProvider>
|
||||
<Renderer spec={spec} registry={registry} />
|
||||
</VisibilityProvider>
|
||||
</StateProvider>
|
||||
```
|
||||
|
||||
The result is a native UI built from your own components — not an iframe, not markdown, not generated code. The AI chose the structure; you control everything else.
|
||||
|
||||
## Key Concepts
|
||||
|
||||
- **[Catalog](/docs/catalog)** — Define the components, actions, and validation functions AI can use. This is the contract between your app and the AI.
|
||||
- **[Registry](/docs/registry)** — Map catalog types to platform-specific implementations. React components on web, React Native views on mobile.
|
||||
- **[Specs](/docs/specs)** — The JSON output AI generates. A flat tree of typed elements with props, children, data bindings, and visibility conditions.
|
||||
- **[Streaming](/docs/streaming)** — Render progressively as the AI responds. Each JSONL patch adds to the spec and the UI updates in real time.
|
||||
- **[Data Binding](/docs/data-binding)** — Bind props to runtime data with `$state` paths, repeat elements over arrays, and wire two-way input bindings.
|
||||
- **[Visibility](/docs/visibility)** — Show or hide elements based on state conditions. The AI can generate conditional UIs without writing logic.
|
||||
- **[Generation Modes](/docs/generation-modes)** — Generate standalone UI (playground/builder) or inline UI within a chat conversation.
|
||||
|
||||
## Next
|
||||
|
||||
- [Installation](/docs/installation) — Add json-render to your project
|
||||
- [Quick Start](/docs/quick-start) — Build your first generative UI in 5 minutes
|
||||
@@ -1,67 +0,0 @@
|
||||
export const metadata = {
|
||||
title: "Introduction | json-render",
|
||||
};
|
||||
|
||||
export default function DocsPage() {
|
||||
return (
|
||||
<article>
|
||||
<h1 className="text-3xl font-bold mb-4">Introduction</h1>
|
||||
<p className="text-muted-foreground mb-8">
|
||||
Predictable. Guardrailed. Fast. Let users generate dashboards, widgets,
|
||||
apps, and data visualizations from prompts.
|
||||
</p>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">What is json-render?</h2>
|
||||
<p className="text-sm text-muted-foreground mb-4 leading-relaxed">
|
||||
json-render lets end users generate UI from natural language prompts —
|
||||
safely constrained to components you define. You set the guardrails:
|
||||
what components exist, what props they take, what actions are available.
|
||||
AI generates JSON that matches your schema, and your components render
|
||||
it natively.
|
||||
</p>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">Why json-render?</h2>
|
||||
<div className="space-y-4 mb-8">
|
||||
<div>
|
||||
<h3 className="font-medium mb-1">Guardrailed</h3>
|
||||
<p className="text-sm text-muted-foreground">
|
||||
AI can only use components in your catalog. No arbitrary code
|
||||
generation.
|
||||
</p>
|
||||
</div>
|
||||
<div>
|
||||
<h3 className="font-medium mb-1">Predictable</h3>
|
||||
<p className="text-sm text-muted-foreground">
|
||||
JSON output matches your schema, every time. Actions are declared by
|
||||
name, you control what they do.
|
||||
</p>
|
||||
</div>
|
||||
<div>
|
||||
<h3 className="font-medium mb-1">Fast</h3>
|
||||
<p className="text-sm text-muted-foreground">
|
||||
Stream and render progressively as the model responds. No waiting
|
||||
for completion.
|
||||
</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">How it works</h2>
|
||||
<ol className="list-decimal list-inside space-y-2 text-sm text-muted-foreground">
|
||||
<li>
|
||||
Define the guardrails — what components, actions, and data bindings AI
|
||||
can use
|
||||
</li>
|
||||
<li>
|
||||
Users prompt — end users describe what they want in natural language
|
||||
</li>
|
||||
<li>
|
||||
AI generates JSON — output is always predictable, constrained to your
|
||||
catalog
|
||||
</li>
|
||||
<li>
|
||||
Render fast — stream and render progressively as the model responds
|
||||
</li>
|
||||
</ol>
|
||||
</article>
|
||||
);
|
||||
}
|
||||
@@ -0,0 +1,214 @@
|
||||
import { pageMetadata } from "@/lib/page-metadata"
|
||||
export const metadata = pageMetadata("docs/quick-start")
|
||||
|
||||
# Quick Start
|
||||
|
||||
Get up and running with json-render in 5 minutes.
|
||||
|
||||
## 1. Define your catalog
|
||||
|
||||
Create a catalog that defines what components AI can use:
|
||||
|
||||
```typescript
|
||||
// lib/catalog.ts
|
||||
import { defineCatalog } from '@json-render/core';
|
||||
import { schema } from '@json-render/react/schema';
|
||||
import { z } from 'zod';
|
||||
|
||||
export const catalog = defineCatalog(schema, {
|
||||
components: {
|
||||
Card: {
|
||||
props: z.object({
|
||||
title: z.string(),
|
||||
description: z.string().nullable(),
|
||||
}),
|
||||
slots: ["default"],
|
||||
description: "Container card with optional title",
|
||||
},
|
||||
Button: {
|
||||
props: z.object({
|
||||
label: z.string(),
|
||||
action: z.string().nullable(),
|
||||
}),
|
||||
description: "Clickable button that triggers an action",
|
||||
},
|
||||
Text: {
|
||||
props: z.object({
|
||||
content: z.string(),
|
||||
}),
|
||||
description: "Text paragraph",
|
||||
},
|
||||
},
|
||||
actions: {
|
||||
submit: {
|
||||
params: z.object({ formId: z.string() }),
|
||||
description: "Submit a form",
|
||||
},
|
||||
navigate: {
|
||||
params: z.object({ url: z.string() }),
|
||||
description: "Navigate to a URL",
|
||||
},
|
||||
},
|
||||
});
|
||||
```
|
||||
|
||||
## 2. Define your components
|
||||
|
||||
Use `defineRegistry` to map catalog types to React components. Each component receives type-safe `props`, `children`, and `emit`:
|
||||
|
||||
```tsx
|
||||
// lib/registry.tsx
|
||||
import { defineRegistry } from '@json-render/react';
|
||||
import { catalog } from './catalog';
|
||||
|
||||
export const { registry } = defineRegistry(catalog, {
|
||||
components: {
|
||||
Card: ({ props, children }) => (
|
||||
<div className="p-4 border rounded-lg">
|
||||
<h2 className="font-bold">{props.title}</h2>
|
||||
{props.description && (
|
||||
<p className="text-gray-600">{props.description}</p>
|
||||
)}
|
||||
{children}
|
||||
</div>
|
||||
),
|
||||
Button: ({ props, emit }) => (
|
||||
<button
|
||||
className="px-4 py-2 bg-blue-500 text-white rounded"
|
||||
onClick={() => emit("press")}
|
||||
>
|
||||
{props.label}
|
||||
</button>
|
||||
),
|
||||
Text: ({ props }) => (
|
||||
<p>{props.content}</p>
|
||||
),
|
||||
},
|
||||
});
|
||||
```
|
||||
|
||||
## 3. Create an API route
|
||||
|
||||
Set up a streaming API route for AI generation:
|
||||
|
||||
```typescript
|
||||
// app/api/generate/route.ts
|
||||
import { streamText } from 'ai';
|
||||
import { catalog } from '@/lib/catalog';
|
||||
|
||||
export async function POST(req: Request) {
|
||||
const { prompt } = await req.json();
|
||||
|
||||
// Generate system prompt from catalog
|
||||
const systemPrompt = catalog.prompt();
|
||||
|
||||
const result = streamText({
|
||||
model: 'anthropic/claude-haiku-4.5',
|
||||
system: systemPrompt,
|
||||
prompt,
|
||||
});
|
||||
|
||||
return result.toTextStreamResponse();
|
||||
}
|
||||
```
|
||||
|
||||
## 4. Render the UI
|
||||
|
||||
Use providers and the `Renderer` with your registry to display AI-generated UI:
|
||||
|
||||
```tsx
|
||||
// app/page.tsx
|
||||
'use client';
|
||||
|
||||
import { Renderer, StateProvider, ActionProvider, VisibilityProvider, ValidationProvider, useUIStream } from '@json-render/react';
|
||||
import { registry } from '@/lib/registry';
|
||||
|
||||
export default function Page() {
|
||||
const { spec, isStreaming, send } = useUIStream({
|
||||
api: '/api/generate',
|
||||
});
|
||||
|
||||
const handleSubmit = (e: React.FormEvent<HTMLFormElement>) => {
|
||||
e.preventDefault();
|
||||
const formData = new FormData(e.currentTarget);
|
||||
send(formData.get('prompt') as string);
|
||||
};
|
||||
|
||||
return (
|
||||
<StateProvider initialState={{}}>
|
||||
<VisibilityProvider>
|
||||
<ActionProvider handlers={{
|
||||
submit: (params) => console.log('Submit:', params),
|
||||
navigate: (params) => console.log('Navigate:', params),
|
||||
}}>
|
||||
<ValidationProvider customFunctions={{}}>
|
||||
<form onSubmit={handleSubmit}>
|
||||
<input
|
||||
name="prompt"
|
||||
placeholder="Describe what you want..."
|
||||
className="border p-2 rounded"
|
||||
/>
|
||||
<button type="submit" disabled={isStreaming}>
|
||||
Generate
|
||||
</button>
|
||||
</form>
|
||||
|
||||
<div className="mt-8">
|
||||
<Renderer spec={spec} registry={registry} loading={isStreaming} />
|
||||
</div>
|
||||
</ValidationProvider>
|
||||
</ActionProvider>
|
||||
</VisibilityProvider>
|
||||
</StateProvider>
|
||||
);
|
||||
}
|
||||
```
|
||||
|
||||
## Quick Start with shadcn/ui
|
||||
|
||||
If you want to skip defining components from scratch, use `@json-render/shadcn` for 36 pre-built components:
|
||||
|
||||
```typescript
|
||||
// lib/catalog.ts
|
||||
import { defineCatalog } from '@json-render/core';
|
||||
import { schema } from '@json-render/react/schema';
|
||||
import { shadcnComponentDefinitions } from '@json-render/shadcn/catalog';
|
||||
|
||||
export const catalog = defineCatalog(schema, {
|
||||
components: {
|
||||
Card: shadcnComponentDefinitions.Card,
|
||||
Stack: shadcnComponentDefinitions.Stack,
|
||||
Heading: shadcnComponentDefinitions.Heading,
|
||||
Button: shadcnComponentDefinitions.Button,
|
||||
Input: shadcnComponentDefinitions.Input,
|
||||
},
|
||||
actions: {},
|
||||
});
|
||||
```
|
||||
|
||||
```tsx
|
||||
// lib/registry.tsx
|
||||
import { defineRegistry } from '@json-render/react';
|
||||
import { shadcnComponents } from '@json-render/shadcn';
|
||||
import { catalog } from './catalog';
|
||||
|
||||
export const { registry } = defineRegistry(catalog, {
|
||||
components: {
|
||||
Card: shadcnComponents.Card,
|
||||
Stack: shadcnComponents.Stack,
|
||||
Heading: shadcnComponents.Heading,
|
||||
Button: shadcnComponents.Button,
|
||||
Input: shadcnComponents.Input,
|
||||
},
|
||||
});
|
||||
```
|
||||
|
||||
See the [@json-render/shadcn API reference](/docs/api/shadcn) for the full component list.
|
||||
|
||||
## Next steps
|
||||
|
||||
- Learn about [catalogs](/docs/catalog) in depth
|
||||
- Explore [data binding](/docs/data-binding) for dynamic values
|
||||
- Add [action handlers](/docs/registry#action-handlers) for interactivity
|
||||
- Implement [conditional visibility](/docs/visibility)
|
||||
- Use [pre-built shadcn/ui components](/docs/api/shadcn) for fast prototyping
|
||||
@@ -1,220 +0,0 @@
|
||||
import Link from "next/link";
|
||||
import { Code } from "@/components/code";
|
||||
|
||||
export const metadata = {
|
||||
title: "Quick Start | json-render",
|
||||
};
|
||||
|
||||
export default function QuickStartPage() {
|
||||
return (
|
||||
<article>
|
||||
<h1 className="text-3xl font-bold mb-4">Quick Start</h1>
|
||||
<p className="text-muted-foreground mb-8">
|
||||
Get up and running with json-render in 5 minutes.
|
||||
</p>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">
|
||||
1. Define your catalog
|
||||
</h2>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
Create a catalog that defines what components AI can use:
|
||||
</p>
|
||||
<Code lang="typescript">{`// lib/catalog.ts
|
||||
import { defineCatalog } from '@json-render/core';
|
||||
import { schema } from '@json-render/react';
|
||||
import { z } from 'zod';
|
||||
|
||||
export const catalog = defineCatalog(schema, {
|
||||
components: {
|
||||
Card: {
|
||||
props: z.object({
|
||||
title: z.string(),
|
||||
description: z.string().nullable(),
|
||||
}),
|
||||
slots: ["default"],
|
||||
description: "Container card with optional title",
|
||||
},
|
||||
Button: {
|
||||
props: z.object({
|
||||
label: z.string(),
|
||||
action: z.string().nullable(),
|
||||
}),
|
||||
description: "Clickable button that triggers an action",
|
||||
},
|
||||
Text: {
|
||||
props: z.object({
|
||||
content: z.string(),
|
||||
}),
|
||||
description: "Text paragraph",
|
||||
},
|
||||
},
|
||||
actions: {
|
||||
submit: {
|
||||
params: z.object({ formId: z.string() }),
|
||||
description: "Submit a form",
|
||||
},
|
||||
navigate: {
|
||||
params: z.object({ url: z.string() }),
|
||||
description: "Navigate to a URL",
|
||||
},
|
||||
},
|
||||
});`}</Code>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">
|
||||
2. Define your components
|
||||
</h2>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
Use <code className="text-foreground">defineRegistry</code> to map
|
||||
catalog types to React components. Each component receives type-safe{" "}
|
||||
<code className="text-foreground">props</code>,{" "}
|
||||
<code className="text-foreground">children</code>, and{" "}
|
||||
<code className="text-foreground">onAction</code>:
|
||||
</p>
|
||||
<Code lang="tsx">{`// lib/registry.tsx
|
||||
import { defineRegistry } from '@json-render/react';
|
||||
import { catalog } from './catalog';
|
||||
|
||||
export const { registry } = defineRegistry(catalog, {
|
||||
components: {
|
||||
Card: ({ props, children }) => (
|
||||
<div className="p-4 border rounded-lg">
|
||||
<h2 className="font-bold">{props.title}</h2>
|
||||
{props.description && (
|
||||
<p className="text-gray-600">{props.description}</p>
|
||||
)}
|
||||
{children}
|
||||
</div>
|
||||
),
|
||||
Button: ({ props, onAction }) => (
|
||||
<button
|
||||
className="px-4 py-2 bg-blue-500 text-white rounded"
|
||||
onClick={() => onAction?.({ name: props.action })}
|
||||
>
|
||||
{props.label}
|
||||
</button>
|
||||
),
|
||||
Text: ({ props }) => (
|
||||
<p>{props.content}</p>
|
||||
),
|
||||
},
|
||||
});`}</Code>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">
|
||||
3. Create an API route
|
||||
</h2>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
Set up a streaming API route for AI generation:
|
||||
</p>
|
||||
<Code lang="typescript">{`// app/api/generate/route.ts
|
||||
import { streamText } from 'ai';
|
||||
import { catalog } from '@/lib/catalog';
|
||||
|
||||
export async function POST(req: Request) {
|
||||
const { prompt } = await req.json();
|
||||
|
||||
// Generate system prompt from catalog
|
||||
const systemPrompt = catalog.prompt();
|
||||
|
||||
const result = streamText({
|
||||
model: 'anthropic/claude-haiku-4.5',
|
||||
system: systemPrompt,
|
||||
prompt,
|
||||
});
|
||||
|
||||
return result.toTextStreamResponse();
|
||||
}`}</Code>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">4. Render the UI</h2>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
Use providers and the <code className="text-foreground">Renderer</code>{" "}
|
||||
with your registry to display AI-generated UI:
|
||||
</p>
|
||||
<Code lang="tsx">{`// app/page.tsx
|
||||
'use client';
|
||||
|
||||
import { Renderer, DataProvider, ActionProvider, VisibilityProvider, useUIStream } from '@json-render/react';
|
||||
import { registry } from '@/lib/registry';
|
||||
|
||||
export default function Page() {
|
||||
const { spec, isStreaming, send } = useUIStream({
|
||||
api: '/api/generate',
|
||||
});
|
||||
|
||||
const handleSubmit = (e: React.FormEvent<HTMLFormElement>) => {
|
||||
e.preventDefault();
|
||||
const formData = new FormData(e.currentTarget);
|
||||
send(formData.get('prompt') as string);
|
||||
};
|
||||
|
||||
return (
|
||||
<DataProvider initialData={{}}>
|
||||
<VisibilityProvider>
|
||||
<ActionProvider handlers={{
|
||||
submit: (params) => console.log('Submit:', params),
|
||||
navigate: (params) => console.log('Navigate:', params),
|
||||
}}>
|
||||
<form onSubmit={handleSubmit}>
|
||||
<input
|
||||
name="prompt"
|
||||
placeholder="Describe what you want..."
|
||||
className="border p-2 rounded"
|
||||
/>
|
||||
<button type="submit" disabled={isStreaming}>
|
||||
Generate
|
||||
</button>
|
||||
</form>
|
||||
|
||||
<div className="mt-8">
|
||||
<Renderer spec={spec} registry={registry} loading={isStreaming} />
|
||||
</div>
|
||||
</ActionProvider>
|
||||
</VisibilityProvider>
|
||||
</DataProvider>
|
||||
);
|
||||
}`}</Code>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">Next steps</h2>
|
||||
<ul className="list-disc list-inside text-sm text-muted-foreground space-y-2">
|
||||
<li>
|
||||
Learn about{" "}
|
||||
<Link
|
||||
href="/docs/catalog"
|
||||
className="text-foreground hover:underline"
|
||||
>
|
||||
catalogs
|
||||
</Link>{" "}
|
||||
in depth
|
||||
</li>
|
||||
<li>
|
||||
Explore{" "}
|
||||
<Link
|
||||
href="/docs/data-binding"
|
||||
className="text-foreground hover:underline"
|
||||
>
|
||||
data binding
|
||||
</Link>{" "}
|
||||
for dynamic values
|
||||
</li>
|
||||
<li>
|
||||
Add{" "}
|
||||
<Link
|
||||
href="/docs/actions"
|
||||
className="text-foreground hover:underline"
|
||||
>
|
||||
actions
|
||||
</Link>{" "}
|
||||
for interactivity
|
||||
</li>
|
||||
<li>
|
||||
Implement{" "}
|
||||
<Link
|
||||
href="/docs/visibility"
|
||||
className="text-foreground hover:underline"
|
||||
>
|
||||
conditional visibility
|
||||
</Link>
|
||||
</li>
|
||||
</ul>
|
||||
</article>
|
||||
);
|
||||
}
|
||||
@@ -0,0 +1,304 @@
|
||||
import { pageMetadata } from "@/lib/page-metadata"
|
||||
export const metadata = pageMetadata("docs/registry")
|
||||
|
||||
# Registry
|
||||
|
||||
A registry maps your [catalog](/docs/catalog) definitions to platform-specific implementations. The catalog defines *what* AI can generate — the registry provides the *how*.
|
||||
|
||||
What a registry contains depends on the schema you use. Each package defines its own schema, which determines the shape of both the catalog and the registry.
|
||||
|
||||
- **`@json-render/react`** — Components (React elements) and action handlers
|
||||
- **`@json-render/react-native`** — Components (React Native elements) and action handlers
|
||||
- **`@json-render/remotion`** — Clip components, transitions, and effects
|
||||
|
||||
## @json-render/react
|
||||
|
||||
### defineRegistry
|
||||
|
||||
Use `defineRegistry` to create a type-safe registry from your catalog. Pass your components, actions, or both:
|
||||
|
||||
```tsx
|
||||
import { defineRegistry } from '@json-render/react';
|
||||
import { myCatalog } from './catalog';
|
||||
|
||||
export const { registry, handlers, executeAction } = defineRegistry(myCatalog, {
|
||||
components: {
|
||||
Card: ({ props, children }) => (
|
||||
<div className="card">
|
||||
<h2>{props.title}</h2>
|
||||
{props.description && <p>{props.description}</p>}
|
||||
{children}
|
||||
</div>
|
||||
),
|
||||
|
||||
Button: ({ props, emit }) => (
|
||||
<button onClick={() => emit("press")}>
|
||||
{props.label}
|
||||
</button>
|
||||
),
|
||||
},
|
||||
|
||||
actions: {
|
||||
submit_form: async (params, setState) => {
|
||||
const res = await fetch('/api/submit', {
|
||||
method: 'POST',
|
||||
body: JSON.stringify(params),
|
||||
});
|
||||
const result = await res.json();
|
||||
setState((prev) => ({ ...prev, formResult: result }));
|
||||
},
|
||||
|
||||
export_data: async (params) => {
|
||||
const blob = await generateExport(params.format);
|
||||
downloadBlob(blob, `export.${params.format}`);
|
||||
},
|
||||
},
|
||||
});
|
||||
```
|
||||
|
||||
The returned object contains:
|
||||
|
||||
- `registry` — component registry for `<Renderer />`
|
||||
- `handlers` — factory for ActionProvider-compatible handlers
|
||||
- `executeAction` — imperative action dispatch (for use outside the React tree)
|
||||
|
||||
### Component Props
|
||||
|
||||
Each component receives a `ComponentContext` object:
|
||||
|
||||
```typescript
|
||||
interface ComponentContext {
|
||||
props: T; // Type-safe props from your catalog
|
||||
children?: React.ReactNode; // Rendered children (for slot components)
|
||||
emit: (event: string) => void; // Emit a named event (always defined)
|
||||
on: (event: string) => EventHandle; // Get event handle with metadata
|
||||
loading?: boolean; // Whether the renderer is in a loading state
|
||||
bindings?: Record<string, string>; // State paths from $bindState/$bindItem expressions
|
||||
}
|
||||
|
||||
interface EventHandle {
|
||||
emit: () => void; // Fire the event
|
||||
shouldPreventDefault: boolean; // Whether any binding requested preventDefault
|
||||
bound: boolean; // Whether any handler is bound
|
||||
}
|
||||
```
|
||||
|
||||
Props are automatically inferred from your catalog, so `props.title` is typed as `string` if your catalog defines it that way.
|
||||
|
||||
Use `emit("press")` for simple event firing. Use `on("click")` when you need to inspect event metadata:
|
||||
|
||||
```tsx
|
||||
Link: ({ props, on }) => {
|
||||
const click = on("click");
|
||||
return (
|
||||
<a
|
||||
href={props.href}
|
||||
onClick={(e) => {
|
||||
if (click.shouldPreventDefault) e.preventDefault();
|
||||
click.emit();
|
||||
}}
|
||||
>
|
||||
{props.label}
|
||||
</a>
|
||||
);
|
||||
},
|
||||
```
|
||||
|
||||
#### Using `bindings` for two-way binding
|
||||
|
||||
When a spec uses `{ "$bindState": "/path" }` or `{ "$bindItem": "field" }` on a prop, the renderer resolves the **value** into `props` and provides the **write-back path** in `bindings`. Use the `useBoundProp` hook to wire both together:
|
||||
|
||||
```tsx
|
||||
import { useBoundProp, defineRegistry } from '@json-render/react';
|
||||
|
||||
// Inside your registry:
|
||||
TextInput: ({ props, bindings }) => {
|
||||
const [value, setValue] = useBoundProp<string>(props.value, bindings?.value);
|
||||
return (
|
||||
<input
|
||||
value={value ?? ""}
|
||||
onChange={(e) => setValue(e.target.value)}
|
||||
/>
|
||||
);
|
||||
},
|
||||
```
|
||||
|
||||
`useBoundProp` returns `[resolvedValue, setter]`. The setter writes to the bound state path. If no binding exists (the prop is a literal), the setter is a no-op.
|
||||
|
||||
### Action Handlers
|
||||
|
||||
Instead of AI generating arbitrary code, it declares *intent* by name. Your application provides the implementation. This is a core guardrail.
|
||||
|
||||
Actions are declared in your [catalog](/docs/catalog). The `@json-render/react` schema supports an `actions` key where you define what operations AI can trigger:
|
||||
|
||||
```typescript
|
||||
import { defineCatalog } from '@json-render/core';
|
||||
import { schema } from '@json-render/react/schema';
|
||||
import { z } from 'zod';
|
||||
|
||||
const catalog = defineCatalog(schema, {
|
||||
components: { /* ... */ },
|
||||
actions: {
|
||||
submit_form: {
|
||||
params: z.object({
|
||||
formId: z.string(),
|
||||
}),
|
||||
description: 'Submit a form',
|
||||
},
|
||||
export_data: {
|
||||
params: z.object({
|
||||
format: z.enum(['csv', 'pdf', 'json']),
|
||||
}),
|
||||
},
|
||||
navigate: {
|
||||
params: z.object({
|
||||
url: z.string(),
|
||||
}),
|
||||
},
|
||||
},
|
||||
});
|
||||
```
|
||||
|
||||
Action handlers receive `(params, setState, state)` and are defined inside `defineRegistry`:
|
||||
|
||||
```tsx
|
||||
export const { handlers, executeAction } = defineRegistry(catalog, {
|
||||
actions: {
|
||||
submit_form: async (params, setState) => {
|
||||
const response = await fetch('/api/submit', {
|
||||
method: 'POST',
|
||||
body: JSON.stringify({ formId: params.formId }),
|
||||
});
|
||||
const result = await response.json();
|
||||
setState((prev) => ({ ...prev, formResult: result }));
|
||||
},
|
||||
|
||||
export_data: async (params) => {
|
||||
const blob = await generateExport(params.format);
|
||||
downloadBlob(blob, `export.${params.format}`);
|
||||
},
|
||||
|
||||
navigate: (params) => {
|
||||
window.location.href = params.url;
|
||||
},
|
||||
},
|
||||
});
|
||||
```
|
||||
|
||||
### Data Binding
|
||||
|
||||
Most data binding is handled automatically by the renderer — `$state`, `$item`, and `$index` expressions in props are resolved before your component receives them. See the [Data Binding](/docs/data-binding) guide for the full reference.
|
||||
|
||||
For two-way binding (form inputs), use `{ "$bindState": "/path" }` on the natural value prop (or `{ "$bindItem": "field" }` inside repeat scopes). The renderer provides a `bindings` map with the state path for each bound prop. Use `useBoundProp` to get `[value, setValue]`:
|
||||
|
||||
```tsx
|
||||
import { useBoundProp } from '@json-render/react';
|
||||
|
||||
// Inside defineRegistry components:
|
||||
|
||||
Input: ({ props, bindings }) => {
|
||||
const [value, setValue] = useBoundProp<string>(
|
||||
props.value,
|
||||
bindings?.value
|
||||
);
|
||||
return (
|
||||
<input
|
||||
value={value ?? ''}
|
||||
onChange={(e) => setValue(e.target.value)}
|
||||
placeholder={props.placeholder}
|
||||
/>
|
||||
);
|
||||
},
|
||||
```
|
||||
|
||||
For read-only state access (e.g. displaying a value from state), use `$state` expressions in props — they are resolved before the component receives them. For custom logic, use `useStateStore` and `getByPath` from `@json-render/core`.
|
||||
|
||||
### Using the Renderer
|
||||
|
||||
Wire everything together with providers and the `<Renderer />` component:
|
||||
|
||||
```tsx
|
||||
import { useMemo, useRef } from 'react';
|
||||
import {
|
||||
Renderer,
|
||||
StateProvider,
|
||||
VisibilityProvider,
|
||||
ActionProvider,
|
||||
} from '@json-render/react';
|
||||
import { registry, handlers } from './registry';
|
||||
|
||||
function App({ spec, state, setState }) {
|
||||
const stateRef = useRef(state);
|
||||
const setStateRef = useRef(setState);
|
||||
stateRef.current = state;
|
||||
setStateRef.current = setState;
|
||||
|
||||
const actionHandlers = useMemo(
|
||||
() => handlers(() => setStateRef.current, () => stateRef.current),
|
||||
[],
|
||||
);
|
||||
|
||||
return (
|
||||
<StateProvider initialState={state}>
|
||||
<VisibilityProvider>
|
||||
<ActionProvider handlers={actionHandlers}>
|
||||
<Renderer spec={spec} registry={registry} />
|
||||
</ActionProvider>
|
||||
</VisibilityProvider>
|
||||
</StateProvider>
|
||||
);
|
||||
}
|
||||
```
|
||||
|
||||
## @json-render/react-native
|
||||
|
||||
`@json-render/react-native` uses the same `defineRegistry` API. The only difference is that components return React Native elements instead of HTML:
|
||||
|
||||
```tsx
|
||||
import { defineRegistry } from '@json-render/react-native';
|
||||
import { View, Text, Pressable } from 'react-native';
|
||||
|
||||
export const { registry } = defineRegistry(catalog, {
|
||||
components: {
|
||||
Card: ({ props, children }) => (
|
||||
<View style={styles.card}>
|
||||
<Text style={styles.title}>{props.title}</Text>
|
||||
{children}
|
||||
</View>
|
||||
),
|
||||
|
||||
Button: ({ props, emit }) => (
|
||||
<Pressable onPress={() => emit("press")}>
|
||||
<Text>{props.label}</Text>
|
||||
</Pressable>
|
||||
),
|
||||
},
|
||||
});
|
||||
```
|
||||
|
||||
See the [@json-render/react-native API reference](/docs/api/react-native) for the full API.
|
||||
|
||||
## @json-render/remotion
|
||||
|
||||
`@json-render/remotion` takes a different approach. Instead of `defineRegistry`, it uses a plain component registry with built-in standard components for video production:
|
||||
|
||||
```tsx
|
||||
import { Renderer, standardComponents } from '@json-render/remotion';
|
||||
|
||||
// Use the standard components directly
|
||||
<Renderer spec={timelineSpec} components={standardComponents} />
|
||||
|
||||
// Or extend with your own
|
||||
const components = {
|
||||
...standardComponents,
|
||||
CustomSlide: ({ clip }) => <AbsoluteFill>{/* ... */}</AbsoluteFill>,
|
||||
};
|
||||
```
|
||||
|
||||
The Remotion schema also supports `transitions` and `effects` in the catalog rather than actions.
|
||||
|
||||
See the [@json-render/remotion API reference](/docs/api/remotion) for the full API.
|
||||
|
||||
## Next
|
||||
|
||||
Learn about [data binding](/docs/data-binding) for dynamic values.
|
||||
@@ -1,248 +0,0 @@
|
||||
import Link from "next/link";
|
||||
import { Code } from "@/components/code";
|
||||
|
||||
export const metadata = {
|
||||
title: "Registry | json-render",
|
||||
};
|
||||
|
||||
export default function RegistryPage() {
|
||||
return (
|
||||
<article>
|
||||
<h1 className="text-3xl font-bold mb-4">Registry</h1>
|
||||
<p className="text-muted-foreground mb-8">
|
||||
Register React components and action handlers to bring your catalog to
|
||||
life.
|
||||
</p>
|
||||
|
||||
{/* defineRegistry */}
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">defineRegistry</h2>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
Use <code>defineRegistry</code> to create a type-safe registry from your
|
||||
catalog. Pass your components, actions, or both in a single call:
|
||||
</p>
|
||||
<Code lang="tsx">{`import { defineRegistry } from '@json-render/react';
|
||||
import { myCatalog } from './catalog';
|
||||
|
||||
export const { registry, handlers, executeAction } = defineRegistry(myCatalog, {
|
||||
components: {
|
||||
Card: ({ props, children }) => (
|
||||
<div className="card">
|
||||
<h2>{props.title}</h2>
|
||||
{props.description && <p>{props.description}</p>}
|
||||
{children}
|
||||
</div>
|
||||
),
|
||||
|
||||
Button: ({ props, onAction }) => (
|
||||
<button onClick={() => onAction?.({ name: props.action })}>
|
||||
{props.label}
|
||||
</button>
|
||||
),
|
||||
},
|
||||
|
||||
actions: {
|
||||
submit_form: async (params, setData) => {
|
||||
const res = await fetch('/api/submit', {
|
||||
method: 'POST',
|
||||
body: JSON.stringify(params),
|
||||
});
|
||||
const result = await res.json();
|
||||
setData((prev) => ({ ...prev, formResult: result }));
|
||||
},
|
||||
|
||||
export_data: async (params) => {
|
||||
const blob = await generateExport(params.format);
|
||||
downloadBlob(blob, \`export.\${params.format}\`);
|
||||
},
|
||||
},
|
||||
});`}</Code>
|
||||
|
||||
<p className="text-sm text-muted-foreground mt-4 mb-4">
|
||||
The returned object contains:
|
||||
</p>
|
||||
<ul className="list-disc list-inside text-sm text-muted-foreground mb-4 space-y-1">
|
||||
<li>
|
||||
<code>registry</code> - component registry for{" "}
|
||||
<code>{"<Renderer />"}</code>
|
||||
</li>
|
||||
<li>
|
||||
<code>handlers</code> - factory for ActionProvider-compatible handlers
|
||||
</li>
|
||||
<li>
|
||||
<code>executeAction</code> - imperative action dispatch (for use
|
||||
outside the React tree)
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
{/* Component Props */}
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">Component Props</h2>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
Each component in the registry receives a <code>ComponentContext</code>{" "}
|
||||
object:
|
||||
</p>
|
||||
<Code lang="typescript">{`interface ComponentContext {
|
||||
props: T; // Type-safe props from your catalog
|
||||
children?: React.ReactNode; // Rendered children (for slot components)
|
||||
onAction?: (action: ActionTrigger) => void; // Dispatch an action
|
||||
loading?: boolean; // Whether the renderer is in a loading state
|
||||
}`}</Code>
|
||||
|
||||
<p className="text-sm text-muted-foreground mt-4 mb-4">
|
||||
Props are automatically inferred from your catalog, so{" "}
|
||||
<code>props.title</code> is typed as <code>string</code> if your catalog
|
||||
defines it that way.
|
||||
</p>
|
||||
|
||||
{/* Action Handlers */}
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">Action Handlers</h2>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
Instead of AI generating arbitrary code, it declares <em>intent</em> by
|
||||
name. Your application provides the implementation. This is a core
|
||||
guardrail.
|
||||
</p>
|
||||
|
||||
<h3 className="text-lg font-medium mt-8 mb-3">Defining Actions</h3>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
Define available actions in your catalog:
|
||||
</p>
|
||||
<Code lang="typescript">{`import { defineCatalog } from '@json-render/core';
|
||||
import { schema } from '@json-render/react';
|
||||
import { z } from 'zod';
|
||||
|
||||
const catalog = defineCatalog(schema, {
|
||||
components: { /* ... */ },
|
||||
actions: {
|
||||
submit_form: {
|
||||
params: z.object({
|
||||
formId: z.string(),
|
||||
}),
|
||||
description: 'Submit a form',
|
||||
},
|
||||
export_data: {
|
||||
params: z.object({
|
||||
format: z.enum(['csv', 'pdf', 'json']),
|
||||
}),
|
||||
},
|
||||
navigate: {
|
||||
params: z.object({
|
||||
url: z.string(),
|
||||
}),
|
||||
},
|
||||
},
|
||||
});`}</Code>
|
||||
|
||||
<h3 className="text-lg font-medium mt-8 mb-3">
|
||||
Implementing Action Handlers
|
||||
</h3>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
Action handlers receive <code>(params, setData, data)</code> and are
|
||||
defined inside <code>defineRegistry</code>:
|
||||
</p>
|
||||
<Code lang="tsx">{`export const { handlers, executeAction } = defineRegistry(catalog, {
|
||||
actions: {
|
||||
submit_form: async (params, setData) => {
|
||||
const response = await fetch('/api/submit', {
|
||||
method: 'POST',
|
||||
body: JSON.stringify({ formId: params.formId }),
|
||||
});
|
||||
const result = await response.json();
|
||||
setData((prev) => ({ ...prev, formResult: result }));
|
||||
},
|
||||
|
||||
export_data: async (params) => {
|
||||
const blob = await generateExport(params.format);
|
||||
downloadBlob(blob, \`export.\${params.format}\`);
|
||||
},
|
||||
|
||||
navigate: (params) => {
|
||||
window.location.href = params.url;
|
||||
},
|
||||
},
|
||||
});`}</Code>
|
||||
|
||||
{/* Using Data Binding */}
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">Using Data Binding</h2>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
Use hooks inside your registry components to read and write data:
|
||||
</p>
|
||||
<Code lang="tsx">{`import { useData } from '@json-render/react';
|
||||
import { getByPath } from '@json-render/core';
|
||||
|
||||
// Inside defineRegistry components:
|
||||
|
||||
Metric: ({ props }) => {
|
||||
const { data } = useData();
|
||||
const value = getByPath(data, props.valuePath);
|
||||
|
||||
return (
|
||||
<div className="metric">
|
||||
<span className="label">{props.label}</span>
|
||||
<span className="value">{formatValue(value)}</span>
|
||||
</div>
|
||||
);
|
||||
},
|
||||
|
||||
TextField: ({ props }) => {
|
||||
const { data, set } = useData();
|
||||
const value = getByPath(data, props.valuePath) as string;
|
||||
|
||||
return (
|
||||
<input
|
||||
value={value || ''}
|
||||
onChange={(e) => set(props.valuePath, e.target.value)}
|
||||
placeholder={props.placeholder}
|
||||
/>
|
||||
);
|
||||
},`}</Code>
|
||||
|
||||
{/* Renderer Section */}
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">Using the Renderer</h2>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
Wire everything together with providers and the{" "}
|
||||
<code>{"<Renderer />"}</code> component:
|
||||
</p>
|
||||
<Code lang="tsx">{`import { useMemo, useRef } from 'react';
|
||||
import {
|
||||
Renderer,
|
||||
DataProvider,
|
||||
VisibilityProvider,
|
||||
ActionProvider,
|
||||
} from '@json-render/react';
|
||||
import { registry, handlers } from './registry';
|
||||
|
||||
function App({ spec, data, setData }) {
|
||||
const dataRef = useRef(data);
|
||||
const setDataRef = useRef(setData);
|
||||
dataRef.current = data;
|
||||
setDataRef.current = setData;
|
||||
|
||||
const actionHandlers = useMemo(
|
||||
() => handlers(() => setDataRef.current, () => dataRef.current),
|
||||
[],
|
||||
);
|
||||
|
||||
return (
|
||||
<DataProvider initialData={data}>
|
||||
<VisibilityProvider>
|
||||
<ActionProvider handlers={actionHandlers}>
|
||||
<Renderer spec={spec} registry={registry} />
|
||||
</ActionProvider>
|
||||
</VisibilityProvider>
|
||||
</DataProvider>
|
||||
);
|
||||
}`}</Code>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">Next</h2>
|
||||
<p className="text-sm text-muted-foreground">
|
||||
Learn about{" "}
|
||||
<Link
|
||||
href="/docs/data-binding"
|
||||
className="text-foreground hover:underline"
|
||||
>
|
||||
data binding
|
||||
</Link>{" "}
|
||||
for dynamic values.
|
||||
</p>
|
||||
</article>
|
||||
);
|
||||
}
|
||||
@@ -0,0 +1,148 @@
|
||||
import { pageMetadata } from "@/lib/page-metadata"
|
||||
export const metadata = pageMetadata("docs/schemas")
|
||||
|
||||
# Schemas
|
||||
|
||||
Schemas define the structure and validation rules for your UI specs.
|
||||
|
||||
## What is a Schema?
|
||||
|
||||
A schema defines the JSON structure that describes your UI. It includes:
|
||||
|
||||
- **Element structure** — How components are nested and referenced
|
||||
- **Property types** — What props each component accepts
|
||||
- **Data binding syntax** — How to reference dynamic data
|
||||
- **Action format** — How user interactions are defined
|
||||
|
||||
## Schema-Agnostic by Design
|
||||
|
||||
json-render can work with any JSON schema. `@json-render/core` provides the primitives to define catalogs and renderers for any format:
|
||||
|
||||
- **@json-render/react** — The built-in flat element tree schema
|
||||
- **[A2UI](/docs/a2ui)** — Google's Agent-to-User Interaction protocol
|
||||
- **[Adaptive Cards](/docs/adaptive-cards)** — Microsoft's platform-agnostic UI format
|
||||
- **AG-UI** — CopilotKit's Agent User Interaction Protocol
|
||||
- **OpenAPI/Swagger** — API documentation schemas for dynamic forms
|
||||
- **Custom schemas** — Design your own format tailored to your domain
|
||||
|
||||
See the [Custom Schema guide](/docs/custom-schema) to learn how to implement support for any schema.
|
||||
|
||||
## Built-in Schema
|
||||
|
||||
`@json-render/react` uses a flat element tree schema with a root key and elements map:
|
||||
|
||||
```json
|
||||
{
|
||||
"root": "card-1",
|
||||
"elements": {
|
||||
"card-1": {
|
||||
"type": "Card",
|
||||
"props": { "title": "Dashboard" },
|
||||
"children": ["text-1", "button-1"]
|
||||
},
|
||||
"text-1": {
|
||||
"type": "Text",
|
||||
"props": { "content": { "$state": "/user/name" } },
|
||||
"children": []
|
||||
},
|
||||
"button-1": {
|
||||
"type": "Button",
|
||||
"props": { "label": "Click me" },
|
||||
"children": []
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Schema Components
|
||||
|
||||
### Element Structure
|
||||
|
||||
In the built-in schema, each element in the elements map has this structure:
|
||||
|
||||
```typescript
|
||||
interface Element {
|
||||
type: string; // Component type from catalog
|
||||
props: Record<string, any>; // Component properties
|
||||
children: string[]; // Array of child element keys
|
||||
visible?: VisibilityCondition; // Conditional display
|
||||
}
|
||||
```
|
||||
|
||||
### Data Binding Syntax
|
||||
|
||||
Reference dynamic data using `$state` expressions in props. The value is a JSON Pointer path into the state model:
|
||||
|
||||
```json
|
||||
{
|
||||
"type": "Text",
|
||||
"props": {
|
||||
"content": { "$state": "/user/name" },
|
||||
"count": { "$state": "/items/count" }
|
||||
},
|
||||
"children": []
|
||||
}
|
||||
```
|
||||
|
||||
json-render also supports `$item` and `$index` expressions for lists, two-way binding via `$bindState` / `$bindItem`, and conditional props. See [Data Binding](/docs/data-binding) for the full reference.
|
||||
|
||||
### Action Format
|
||||
|
||||
Actions are defined in the catalog and referenced from components. The renderer handles action execution:
|
||||
|
||||
```typescript
|
||||
// In your catalog
|
||||
actions: {
|
||||
navigate: {
|
||||
params: z.object({ url: z.string() }),
|
||||
description: 'Navigate to a URL',
|
||||
},
|
||||
apiCall: {
|
||||
params: z.object({
|
||||
endpoint: z.string(),
|
||||
method: z.enum(['GET', 'POST', 'PUT', 'DELETE']),
|
||||
}),
|
||||
description: 'Make an API request',
|
||||
},
|
||||
}
|
||||
```
|
||||
|
||||
## Custom Schemas
|
||||
|
||||
`@json-render/core` is schema-agnostic. You can define any JSON structure:
|
||||
|
||||
```typescript
|
||||
import { z } from 'zod';
|
||||
|
||||
// Define your own element schema
|
||||
const MyElementSchema = z.object({
|
||||
component: z.string(),
|
||||
settings: z.record(z.unknown()),
|
||||
nested: z.array(z.lazy(() => MyElementSchema)).optional(),
|
||||
});
|
||||
|
||||
// Define your own data binding format
|
||||
const BoundValue = z.object({
|
||||
literal: z.string().optional(),
|
||||
source: z.string().optional(), // e.g., "/users/0/name"
|
||||
});
|
||||
|
||||
// Define your own action format
|
||||
const ActionSchema = z.object({
|
||||
name: z.string(),
|
||||
context: z.record(z.unknown()).optional(),
|
||||
});
|
||||
```
|
||||
|
||||
## Schema vs Catalog
|
||||
|
||||
The schema and catalog work together but serve different purposes:
|
||||
|
||||
- **Schema** — Defines the JSON structure (how elements are organized)
|
||||
- **Catalog** — Defines available components and their props (what can be used)
|
||||
|
||||
The schema is the grammar; the catalog is the vocabulary.
|
||||
|
||||
## Next
|
||||
|
||||
Learn about [specs](/docs/specs) — the actual JSON documents that describe your UI.
|
||||
@@ -1,230 +0,0 @@
|
||||
import Link from "next/link";
|
||||
import { Code } from "@/components/code";
|
||||
|
||||
export const metadata = {
|
||||
title: "Schemas | json-render",
|
||||
};
|
||||
|
||||
export default function SchemasPage() {
|
||||
return (
|
||||
<article>
|
||||
<h1 className="text-3xl font-bold mb-4">Schemas</h1>
|
||||
<p className="text-muted-foreground mb-8">
|
||||
Schemas define the structure and validation rules for your UI specs.
|
||||
</p>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">What is a Schema?</h2>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
A schema defines the JSON structure that describes your UI. It includes:
|
||||
</p>
|
||||
<ul className="list-disc list-inside text-sm text-muted-foreground space-y-1 mb-4">
|
||||
<li>
|
||||
<strong className="text-foreground">Element structure</strong> — How
|
||||
components are nested and referenced
|
||||
</li>
|
||||
<li>
|
||||
<strong className="text-foreground">Property types</strong> — What
|
||||
props each component accepts
|
||||
</li>
|
||||
<li>
|
||||
<strong className="text-foreground">Data binding syntax</strong> — How
|
||||
to reference dynamic data
|
||||
</li>
|
||||
<li>
|
||||
<strong className="text-foreground">Action format</strong> — How user
|
||||
interactions are defined
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">
|
||||
Schema-Agnostic by Design
|
||||
</h2>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
json-render can work with any JSON schema.{" "}
|
||||
<code className="text-foreground">@json-render/core</code> provides the
|
||||
primitives to define catalogs and renderers for any format:
|
||||
</p>
|
||||
<ul className="list-disc list-inside text-sm text-muted-foreground space-y-1 mb-4">
|
||||
<li>
|
||||
<strong className="text-foreground">@json-render/react</strong> — The
|
||||
built-in flat element tree schema
|
||||
</li>
|
||||
<li>
|
||||
<strong className="text-foreground">
|
||||
<Link href="/docs/a2ui" className="hover:underline">
|
||||
A2UI
|
||||
</Link>
|
||||
</strong>{" "}
|
||||
— Google{"'"}s Agent-to-User Interaction protocol
|
||||
</li>
|
||||
<li>
|
||||
<strong className="text-foreground">
|
||||
<Link href="/docs/adaptive-cards" className="hover:underline">
|
||||
Adaptive Cards
|
||||
</Link>
|
||||
</strong>{" "}
|
||||
— Microsoft{"'"}s platform-agnostic UI format
|
||||
</li>
|
||||
<li>
|
||||
<strong className="text-foreground">AG-UI</strong> — CopilotKit{"'"}s
|
||||
Agent User Interaction Protocol
|
||||
</li>
|
||||
<li>
|
||||
<strong className="text-foreground">OpenAPI/Swagger</strong> — API
|
||||
documentation schemas for dynamic forms
|
||||
</li>
|
||||
<li>
|
||||
<strong className="text-foreground">Custom schemas</strong> — Design
|
||||
your own format tailored to your domain
|
||||
</li>
|
||||
</ul>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
See the{" "}
|
||||
<Link
|
||||
href="/docs/custom-schema"
|
||||
className="text-foreground hover:underline"
|
||||
>
|
||||
Custom Schema guide
|
||||
</Link>{" "}
|
||||
to learn how to implement support for any schema.
|
||||
</p>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">Built-in Schema</h2>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
<code className="text-foreground">@json-render/react</code> uses a flat
|
||||
element tree schema with a root key and elements map:
|
||||
</p>
|
||||
<Code lang="json">{`{
|
||||
"root": "card-1",
|
||||
"elements": {
|
||||
"card-1": {
|
||||
"key": "card-1",
|
||||
"type": "Card",
|
||||
"props": { "title": "Dashboard" },
|
||||
"children": ["text-1", "button-1"],
|
||||
"parentKey": ""
|
||||
},
|
||||
"text-1": {
|
||||
"key": "text-1",
|
||||
"type": "Text",
|
||||
"props": { "content": "Welcome, $data.user.name" },
|
||||
"children": [],
|
||||
"parentKey": "card-1"
|
||||
},
|
||||
"button-1": {
|
||||
"key": "button-1",
|
||||
"type": "Button",
|
||||
"props": { "label": "Click me" },
|
||||
"children": [],
|
||||
"parentKey": "card-1"
|
||||
}
|
||||
}
|
||||
}`}</Code>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">Schema Components</h2>
|
||||
|
||||
<h3 className="text-lg font-medium mt-8 mb-3">Element Structure</h3>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
In the built-in schema, each element in the elements map has this
|
||||
structure:
|
||||
</p>
|
||||
<Code lang="typescript">{`interface Element {
|
||||
key: string; // Unique identifier
|
||||
type: string; // Component type from catalog
|
||||
props: Record<string, any>; // Component properties
|
||||
children: string[]; // Array of child element keys
|
||||
parentKey: string; // Parent element key (empty for root)
|
||||
visible?: VisibilityRule; // Conditional display
|
||||
}`}</Code>
|
||||
|
||||
<h3 className="text-lg font-medium mt-8 mb-3">Data Binding Syntax</h3>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
Reference dynamic data using the{" "}
|
||||
<code className="text-foreground">$data</code> prefix in props:
|
||||
</p>
|
||||
<Code lang="json">{`{
|
||||
"key": "greeting",
|
||||
"type": "Text",
|
||||
"props": {
|
||||
"content": "$data.user.name",
|
||||
"count": "$data.items.length"
|
||||
},
|
||||
"children": [],
|
||||
"parentKey": "card-1"
|
||||
}`}</Code>
|
||||
|
||||
<h3 className="text-lg font-medium mt-8 mb-3">Action Format</h3>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
Actions are defined in the catalog and referenced from components. The
|
||||
renderer handles action execution:
|
||||
</p>
|
||||
<Code lang="typescript">{`// In your catalog
|
||||
actions: {
|
||||
navigate: {
|
||||
params: z.object({ url: z.string() }),
|
||||
description: 'Navigate to a URL',
|
||||
},
|
||||
apiCall: {
|
||||
params: z.object({
|
||||
endpoint: z.string(),
|
||||
method: z.enum(['GET', 'POST', 'PUT', 'DELETE']),
|
||||
}),
|
||||
description: 'Make an API request',
|
||||
},
|
||||
}`}</Code>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">Custom Schemas</h2>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
<code className="text-foreground">@json-render/core</code> is
|
||||
schema-agnostic. You can define any JSON structure:
|
||||
</p>
|
||||
<Code lang="typescript">{`import { z } from 'zod';
|
||||
|
||||
// Define your own element schema
|
||||
const MyElementSchema = z.object({
|
||||
component: z.string(),
|
||||
settings: z.record(z.unknown()),
|
||||
nested: z.array(z.lazy(() => MyElementSchema)).optional(),
|
||||
});
|
||||
|
||||
// Define your own data binding format
|
||||
const BoundValue = z.object({
|
||||
literal: z.string().optional(),
|
||||
path: z.string().optional(), // e.g., "/users/0/name"
|
||||
});
|
||||
|
||||
// Define your own action format
|
||||
const ActionSchema = z.object({
|
||||
name: z.string(),
|
||||
context: z.record(z.unknown()).optional(),
|
||||
});`}</Code>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">Schema vs Catalog</h2>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
The schema and catalog work together but serve different purposes:
|
||||
</p>
|
||||
<ul className="list-disc list-inside text-sm text-muted-foreground space-y-1 mb-4">
|
||||
<li>
|
||||
<strong className="text-foreground">Schema</strong> — Defines the JSON
|
||||
structure (how elements are organized)
|
||||
</li>
|
||||
<li>
|
||||
<strong className="text-foreground">Catalog</strong> — Defines
|
||||
available components and their props (what can be used)
|
||||
</li>
|
||||
</ul>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
The schema is the grammar; the catalog is the vocabulary.
|
||||
</p>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">Next</h2>
|
||||
<p className="text-sm text-muted-foreground">
|
||||
Learn about{" "}
|
||||
<Link href="/docs/specs" className="text-foreground hover:underline">
|
||||
specs
|
||||
</Link>{" "}
|
||||
— the actual JSON documents that describe your UI.
|
||||
</p>
|
||||
</article>
|
||||
);
|
||||
}
|
||||
@@ -0,0 +1,293 @@
|
||||
import { pageMetadata } from "@/lib/page-metadata"
|
||||
export const metadata = pageMetadata("docs/specs")
|
||||
|
||||
# Specs
|
||||
|
||||
A spec is a JSON document that describes your UI.
|
||||
|
||||
## What is a Spec?
|
||||
|
||||
A spec (specification) is the actual JSON that describes a UI. It uses components from a [catalog](/docs/catalog) and can optionally follow a [schema](/docs/schemas). Specs can be:
|
||||
|
||||
- Generated by AI in real-time
|
||||
- Stored in a database
|
||||
- Streamed progressively from a server
|
||||
- Hand-authored as JSON files
|
||||
|
||||
json-render is schema-agnostic — your specs can follow any JSON structure you choose.
|
||||
|
||||
## Example Specs
|
||||
|
||||
### Simple Spec
|
||||
|
||||
A basic spec using the `@json-render/react` schema. Note the flat structure with a `root` key and `elements` map:
|
||||
|
||||
```json
|
||||
{
|
||||
"root": "card-1",
|
||||
"elements": {
|
||||
"card-1": {
|
||||
"type": "Card",
|
||||
"props": { "title": "Welcome" },
|
||||
"children": ["text-1"]
|
||||
},
|
||||
"text-1": {
|
||||
"type": "Text",
|
||||
"props": { "content": { "$state": "/user/greeting" } },
|
||||
"children": []
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Complex Spec
|
||||
|
||||
A more complex spec with multiple nested elements:
|
||||
|
||||
```json
|
||||
{
|
||||
"root": "card-1",
|
||||
"elements": {
|
||||
"card-1": {
|
||||
"type": "Card",
|
||||
"props": { "title": "User Profile", "padding": "md" },
|
||||
"children": ["row-1", "button-1"]
|
||||
},
|
||||
"row-1": {
|
||||
"type": "Row",
|
||||
"props": { "gap": "md" },
|
||||
"children": ["avatar-1", "stack-1"]
|
||||
},
|
||||
"avatar-1": {
|
||||
"type": "Avatar",
|
||||
"props": { "src": { "$state": "/user/avatar" }, "alt": { "$state": "/user/name" } },
|
||||
"children": []
|
||||
},
|
||||
"stack-1": {
|
||||
"type": "Stack",
|
||||
"props": { "gap": "sm" },
|
||||
"children": ["name-text", "email-text"]
|
||||
},
|
||||
"name-text": {
|
||||
"type": "Text",
|
||||
"props": { "content": { "$state": "/user/name" }, "variant": "heading" },
|
||||
"children": []
|
||||
},
|
||||
"email-text": {
|
||||
"type": "Text",
|
||||
"props": { "content": { "$state": "/user/email" }, "variant": "caption" },
|
||||
"children": []
|
||||
},
|
||||
"button-1": {
|
||||
"type": "Button",
|
||||
"props": { "label": "Edit Profile" },
|
||||
"children": []
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Block-Level Spec
|
||||
|
||||
A high-level spec using semantic blocks for page layouts:
|
||||
|
||||
```json
|
||||
{
|
||||
"root": "page",
|
||||
"elements": {
|
||||
"page": {
|
||||
"type": "Page",
|
||||
"props": {},
|
||||
"children": ["header", "hero", "features", "footer"]
|
||||
},
|
||||
"header": {
|
||||
"type": "Header",
|
||||
"props": { "logo": "/logo.svg", "navItems": ["Products", "Pricing", "Docs"] },
|
||||
"children": []
|
||||
},
|
||||
"hero": {
|
||||
"type": "Hero",
|
||||
"props": {
|
||||
"title": "Build UIs with JSON",
|
||||
"subtitle": "Let AI generate your interfaces",
|
||||
"ctaLabel": "Get Started",
|
||||
"ctaHref": "/docs"
|
||||
},
|
||||
"children": []
|
||||
},
|
||||
"features": {
|
||||
"type": "Features",
|
||||
"props": { "columns": 3 },
|
||||
"children": ["feature-1", "feature-2", "feature-3"]
|
||||
},
|
||||
"feature-1": {
|
||||
"type": "Feature",
|
||||
"props": { "icon": "zap", "title": "Fast", "description": "Render UIs in milliseconds" },
|
||||
"children": []
|
||||
},
|
||||
"feature-2": {
|
||||
"type": "Feature",
|
||||
"props": { "icon": "shield", "title": "Secure", "description": "Validate all specs against your catalog" },
|
||||
"children": []
|
||||
},
|
||||
"feature-3": {
|
||||
"type": "Feature",
|
||||
"props": { "icon": "sparkles", "title": "AI-Ready", "description": "Generate prompts from your catalog" },
|
||||
"children": []
|
||||
},
|
||||
"footer": {
|
||||
"type": "Footer",
|
||||
"props": { "copyright": "2025 Acme Inc", "links": ["Privacy", "Terms", "Contact"] },
|
||||
"children": []
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Spec Anatomy
|
||||
|
||||
Specs are schema-agnostic — the JSON structure is entirely up to you. The examples below use the `root` + `elements` flat tree format from the `@json-render/react` schema, which is optimized for AI generation and streaming.
|
||||
|
||||
### Root and Elements
|
||||
|
||||
In the React schema, a spec has a `root` key pointing to the entry element, and an `elements` map containing all elements:
|
||||
|
||||
```json
|
||||
{
|
||||
"root": "card-1",
|
||||
"elements": {
|
||||
"card-1": {
|
||||
"type": "Card",
|
||||
"props": { "title": "My Card" },
|
||||
"children": ["text-1"]
|
||||
},
|
||||
"text-1": { ... }
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Element Structure
|
||||
|
||||
Each element in the map has a consistent shape:
|
||||
|
||||
```json
|
||||
{
|
||||
"type": "ComponentName",
|
||||
"props": { "label": "Hello" },
|
||||
"children": ["child-1", "child-2"]
|
||||
}
|
||||
```
|
||||
|
||||
- `type` — Component type from your catalog
|
||||
- `props` — Component properties
|
||||
- `children` — Array of child element keys
|
||||
|
||||
### Dynamic Data
|
||||
|
||||
Props can reference data from the state model using `$state` expressions. The value is a JSON Pointer (RFC 6901) path into the state:
|
||||
|
||||
```json
|
||||
{
|
||||
"type": "Metric",
|
||||
"props": {
|
||||
"label": "Total Revenue",
|
||||
"value": { "$state": "/metrics/revenue" },
|
||||
"change": { "$state": "/metrics/revenueChange" }
|
||||
},
|
||||
"children": []
|
||||
}
|
||||
```
|
||||
|
||||
See [Data Binding](/docs/data-binding) for the full reference including `$item`, `$index`, repeat, and two-way binding.
|
||||
|
||||
### Conditional Visibility
|
||||
|
||||
Control when elements appear using the `visible` property:
|
||||
|
||||
```json
|
||||
{
|
||||
"type": "Alert",
|
||||
"props": {
|
||||
"message": "You have unsaved changes"
|
||||
},
|
||||
"children": [],
|
||||
"visible": {
|
||||
"$state": "/form/isDirty",
|
||||
"eq": true
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Working with Specs
|
||||
|
||||
### Validating a Spec
|
||||
|
||||
Use `validateSpec` from `@json-render/core` to check a spec for structural issues:
|
||||
|
||||
```typescript
|
||||
import { validateSpec } from '@json-render/core';
|
||||
|
||||
const result = validateSpec(spec);
|
||||
|
||||
if (!result.valid) {
|
||||
console.error('Invalid spec:', result.issues);
|
||||
}
|
||||
```
|
||||
|
||||
### Rendering a Spec (React)
|
||||
|
||||
With `@json-render/react`, wrap the `Renderer` in providers to supply state and visibility:
|
||||
|
||||
```tsx
|
||||
import { Renderer, StateProvider, VisibilityProvider } from '@json-render/react';
|
||||
import { registry } from './registry';
|
||||
|
||||
function MyApp({ spec, initialState }) {
|
||||
return (
|
||||
<StateProvider initialState={initialState}>
|
||||
<VisibilityProvider>
|
||||
<Renderer spec={spec} registry={registry} />
|
||||
</VisibilityProvider>
|
||||
</StateProvider>
|
||||
);
|
||||
}
|
||||
```
|
||||
|
||||
See the [@json-render/react API reference](/docs/api/react) for full provider and hook documentation.
|
||||
|
||||
### Streaming a Spec (React)
|
||||
|
||||
With `@json-render/react`, use the `useUIStream` hook to stream specs incrementally:
|
||||
|
||||
```tsx
|
||||
import { useUIStream } from '@json-render/react';
|
||||
|
||||
function GenerativeUI() {
|
||||
const { spec, isStreaming } = useUIStream({
|
||||
api: '/api/generate',
|
||||
});
|
||||
|
||||
return (
|
||||
<Renderer
|
||||
spec={spec}
|
||||
registry={registry}
|
||||
loading={isStreaming}
|
||||
/>
|
||||
);
|
||||
}
|
||||
```
|
||||
|
||||
See [Streaming](/docs/streaming) for the full SpecStream format and server-side setup.
|
||||
|
||||
## Spec Sources
|
||||
|
||||
Specs can come from various sources:
|
||||
|
||||
- **AI Generation** — LLMs generate specs based on prompts and catalog
|
||||
- **Database** — Store specs as JSON and load dynamically
|
||||
- **API Response** — Server returns specs based on user/context
|
||||
- **Static Files** — Pre-built specs for known UI patterns
|
||||
|
||||
## Next
|
||||
|
||||
Learn about [catalogs](/docs/catalog) — the vocabulary of components available in your specs.
|
||||
@@ -1,369 +0,0 @@
|
||||
import Link from "next/link";
|
||||
import { Code } from "@/components/code";
|
||||
|
||||
export const metadata = {
|
||||
title: "Specs | json-render",
|
||||
};
|
||||
|
||||
export default function SpecsPage() {
|
||||
return (
|
||||
<article>
|
||||
<h1 className="text-3xl font-bold mb-4">Specs</h1>
|
||||
<p className="text-muted-foreground mb-8">
|
||||
A spec is a JSON document that describes your UI.
|
||||
</p>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">What is a Spec?</h2>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
A spec (specification) is the actual JSON that describes a UI. It
|
||||
conforms to a{" "}
|
||||
<Link href="/docs/schemas" className="text-foreground hover:underline">
|
||||
schema
|
||||
</Link>{" "}
|
||||
and uses components from a{" "}
|
||||
<Link href="/docs/catalog" className="text-foreground hover:underline">
|
||||
catalog
|
||||
</Link>
|
||||
. Specs can be:
|
||||
</p>
|
||||
<ul className="list-disc list-inside text-sm text-muted-foreground space-y-1 mb-4">
|
||||
<li>Generated by AI in real-time</li>
|
||||
<li>Stored in a database</li>
|
||||
<li>Streamed progressively from a server</li>
|
||||
<li>Hand-authored as JSON files</li>
|
||||
</ul>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
json-render is schema-agnostic — your specs can follow any JSON
|
||||
structure you choose.
|
||||
</p>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">Example Specs</h2>
|
||||
|
||||
<h3 className="text-lg font-medium mt-8 mb-3">Simple Spec</h3>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
A basic spec using the{" "}
|
||||
<code className="text-foreground">@json-render/react</code> schema. Note
|
||||
the flat structure with a <code className="text-foreground">root</code>{" "}
|
||||
key and <code className="text-foreground">elements</code> map:
|
||||
</p>
|
||||
<Code lang="json">{`{
|
||||
"root": "card-1",
|
||||
"elements": {
|
||||
"card-1": {
|
||||
"key": "card-1",
|
||||
"type": "Card",
|
||||
"props": { "title": "Welcome" },
|
||||
"children": ["text-1"],
|
||||
"parentKey": ""
|
||||
},
|
||||
"text-1": {
|
||||
"key": "text-1",
|
||||
"type": "Text",
|
||||
"props": { "content": "Hello, $data.user.name!" },
|
||||
"children": [],
|
||||
"parentKey": "card-1"
|
||||
}
|
||||
}
|
||||
}`}</Code>
|
||||
|
||||
<h3 className="text-lg font-medium mt-8 mb-3">Complex Spec</h3>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
A more complex spec with multiple nested elements:
|
||||
</p>
|
||||
<Code lang="json">{`{
|
||||
"root": "card-1",
|
||||
"elements": {
|
||||
"card-1": {
|
||||
"key": "card-1",
|
||||
"type": "Card",
|
||||
"props": { "title": "User Profile", "padding": "md" },
|
||||
"children": ["row-1", "button-1"],
|
||||
"parentKey": ""
|
||||
},
|
||||
"row-1": {
|
||||
"key": "row-1",
|
||||
"type": "Row",
|
||||
"props": { "gap": "md" },
|
||||
"children": ["avatar-1", "stack-1"],
|
||||
"parentKey": "card-1"
|
||||
},
|
||||
"avatar-1": {
|
||||
"key": "avatar-1",
|
||||
"type": "Avatar",
|
||||
"props": { "src": "$data.user.avatar", "alt": "$data.user.name" },
|
||||
"children": [],
|
||||
"parentKey": "row-1"
|
||||
},
|
||||
"stack-1": {
|
||||
"key": "stack-1",
|
||||
"type": "Stack",
|
||||
"props": { "gap": "sm" },
|
||||
"children": ["name-text", "email-text"],
|
||||
"parentKey": "row-1"
|
||||
},
|
||||
"name-text": {
|
||||
"key": "name-text",
|
||||
"type": "Text",
|
||||
"props": { "content": "$data.user.name", "variant": "heading" },
|
||||
"children": [],
|
||||
"parentKey": "stack-1"
|
||||
},
|
||||
"email-text": {
|
||||
"key": "email-text",
|
||||
"type": "Text",
|
||||
"props": { "content": "$data.user.email", "variant": "caption" },
|
||||
"children": [],
|
||||
"parentKey": "stack-1"
|
||||
},
|
||||
"button-1": {
|
||||
"key": "button-1",
|
||||
"type": "Button",
|
||||
"props": { "label": "Edit Profile" },
|
||||
"children": [],
|
||||
"parentKey": "card-1"
|
||||
}
|
||||
}
|
||||
}`}</Code>
|
||||
|
||||
<h3 className="text-lg font-medium mt-8 mb-3">Block-Level Spec</h3>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
A high-level spec using semantic blocks for page layouts:
|
||||
</p>
|
||||
<Code lang="json">{`{
|
||||
"root": "page",
|
||||
"elements": {
|
||||
"page": {
|
||||
"key": "page",
|
||||
"type": "Page",
|
||||
"props": {},
|
||||
"children": ["header", "hero", "features", "footer"],
|
||||
"parentKey": ""
|
||||
},
|
||||
"header": {
|
||||
"key": "header",
|
||||
"type": "Header",
|
||||
"props": { "logo": "/logo.svg", "navItems": ["Products", "Pricing", "Docs"] },
|
||||
"children": [],
|
||||
"parentKey": "page"
|
||||
},
|
||||
"hero": {
|
||||
"key": "hero",
|
||||
"type": "Hero",
|
||||
"props": {
|
||||
"title": "Build UIs with JSON",
|
||||
"subtitle": "Let AI generate your interfaces",
|
||||
"ctaLabel": "Get Started",
|
||||
"ctaHref": "/docs"
|
||||
},
|
||||
"children": [],
|
||||
"parentKey": "page"
|
||||
},
|
||||
"features": {
|
||||
"key": "features",
|
||||
"type": "Features",
|
||||
"props": { "columns": 3 },
|
||||
"children": ["feature-1", "feature-2", "feature-3"],
|
||||
"parentKey": "page"
|
||||
},
|
||||
"feature-1": {
|
||||
"key": "feature-1",
|
||||
"type": "Feature",
|
||||
"props": { "icon": "zap", "title": "Fast", "description": "Render UIs in milliseconds" },
|
||||
"children": [],
|
||||
"parentKey": "features"
|
||||
},
|
||||
"feature-2": {
|
||||
"key": "feature-2",
|
||||
"type": "Feature",
|
||||
"props": { "icon": "shield", "title": "Secure", "description": "Validate all specs against your catalog" },
|
||||
"children": [],
|
||||
"parentKey": "features"
|
||||
},
|
||||
"feature-3": {
|
||||
"key": "feature-3",
|
||||
"type": "Feature",
|
||||
"props": { "icon": "sparkles", "title": "AI-Ready", "description": "Generate prompts from your catalog" },
|
||||
"children": [],
|
||||
"parentKey": "features"
|
||||
},
|
||||
"footer": {
|
||||
"key": "footer",
|
||||
"type": "Footer",
|
||||
"props": { "copyright": "2025 Acme Inc", "links": ["Privacy", "Terms", "Contact"] },
|
||||
"children": [],
|
||||
"parentKey": "page"
|
||||
}
|
||||
}
|
||||
}`}</Code>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">Spec Anatomy</h2>
|
||||
|
||||
<h3 className="text-lg font-medium mt-8 mb-3">Root and Elements</h3>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
Every spec has a <code className="text-foreground">root</code> key
|
||||
pointing to the entry element, and an{" "}
|
||||
<code className="text-foreground">elements</code> map containing all
|
||||
elements:
|
||||
</p>
|
||||
<Code lang="json">{`{
|
||||
"root": "card-1",
|
||||
"elements": {
|
||||
"card-1": {
|
||||
"key": "card-1",
|
||||
"type": "Card",
|
||||
"props": { "title": "My Card" },
|
||||
"children": ["text-1"],
|
||||
"parentKey": ""
|
||||
},
|
||||
"text-1": { ... }
|
||||
}
|
||||
}`}</Code>
|
||||
|
||||
<h3 className="text-lg font-medium mt-8 mb-3">Element Structure</h3>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
Each element in the map has a consistent shape:
|
||||
</p>
|
||||
<Code lang="json">{`{
|
||||
"key": "unique-id",
|
||||
"type": "ComponentName",
|
||||
"props": { "label": "Hello" },
|
||||
"children": ["child-1", "child-2"],
|
||||
"parentKey": "parent-id"
|
||||
}`}</Code>
|
||||
<ul className="list-disc list-inside text-sm text-muted-foreground space-y-1 mt-3 mb-4">
|
||||
<li>
|
||||
<code className="text-foreground">key</code> — Unique identifier for
|
||||
this element
|
||||
</li>
|
||||
<li>
|
||||
<code className="text-foreground">type</code> — Component type from
|
||||
your catalog
|
||||
</li>
|
||||
<li>
|
||||
<code className="text-foreground">props</code> — Component properties
|
||||
</li>
|
||||
<li>
|
||||
<code className="text-foreground">children</code> — Array of child
|
||||
element keys
|
||||
</li>
|
||||
<li>
|
||||
<code className="text-foreground">parentKey</code> — Key of parent
|
||||
element (empty string for root)
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h3 className="text-lg font-medium mt-8 mb-3">Dynamic Data</h3>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
Props can reference data using{" "}
|
||||
<code className="text-foreground">$data</code> paths:
|
||||
</p>
|
||||
<Code lang="json">{`{
|
||||
"key": "metric-1",
|
||||
"type": "Metric",
|
||||
"props": {
|
||||
"label": "Total Revenue",
|
||||
"value": "$data.metrics.revenue",
|
||||
"change": "$data.metrics.revenueChange"
|
||||
},
|
||||
"children": [],
|
||||
"parentKey": "dashboard"
|
||||
}`}</Code>
|
||||
|
||||
<h3 className="text-lg font-medium mt-8 mb-3">Conditional Visibility</h3>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
Control when elements appear using the{" "}
|
||||
<code className="text-foreground">visible</code> property:
|
||||
</p>
|
||||
<Code lang="json">{`{
|
||||
"key": "alert-1",
|
||||
"type": "Alert",
|
||||
"props": {
|
||||
"message": "You have unsaved changes"
|
||||
},
|
||||
"children": [],
|
||||
"parentKey": "form",
|
||||
"visible": {
|
||||
"path": "$data.form.isDirty",
|
||||
"operator": "eq",
|
||||
"value": true
|
||||
}
|
||||
}`}</Code>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">Working with Specs</h2>
|
||||
|
||||
<h3 className="text-lg font-medium mt-8 mb-3">Rendering a Spec</h3>
|
||||
<Code lang="tsx">{`import { Renderer } from '@json-render/react';
|
||||
|
||||
function MyApp({ spec, data }) {
|
||||
return (
|
||||
<Renderer
|
||||
spec={spec}
|
||||
data={data}
|
||||
registry={registry}
|
||||
/>
|
||||
);
|
||||
}`}</Code>
|
||||
|
||||
<h3 className="text-lg font-medium mt-8 mb-3">Validating a Spec</h3>
|
||||
<Code lang="typescript">{`import { validate } from '@json-render/core';
|
||||
|
||||
const result = validate(spec, catalog);
|
||||
|
||||
if (!result.valid) {
|
||||
console.error('Invalid spec:', result.errors);
|
||||
}`}</Code>
|
||||
|
||||
<h3 className="text-lg font-medium mt-8 mb-3">Streaming Specs</h3>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
Specs can be streamed incrementally for progressive rendering:
|
||||
</p>
|
||||
<Code lang="tsx">{`import { useUIStream } from '@json-render/react';
|
||||
|
||||
function GenerativeUI() {
|
||||
const { spec, isStreaming } = useUIStream({
|
||||
api: '/api/generate',
|
||||
});
|
||||
|
||||
return (
|
||||
<Renderer
|
||||
spec={spec}
|
||||
registry={registry}
|
||||
loading={isStreaming}
|
||||
/>
|
||||
);
|
||||
}`}</Code>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">Spec Sources</h2>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
Specs can come from various sources:
|
||||
</p>
|
||||
<ul className="list-disc list-inside text-sm text-muted-foreground space-y-1 mb-4">
|
||||
<li>
|
||||
<strong className="text-foreground">AI Generation</strong> — LLMs
|
||||
generate specs based on prompts and catalog
|
||||
</li>
|
||||
<li>
|
||||
<strong className="text-foreground">Database</strong> — Store specs as
|
||||
JSON and load dynamically
|
||||
</li>
|
||||
<li>
|
||||
<strong className="text-foreground">API Response</strong> — Server
|
||||
returns specs based on user/context
|
||||
</li>
|
||||
<li>
|
||||
<strong className="text-foreground">Static Files</strong> — Pre-built
|
||||
specs for known UI patterns
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">Next</h2>
|
||||
<p className="text-sm text-muted-foreground">
|
||||
Learn about{" "}
|
||||
<Link href="/docs/catalog" className="text-foreground hover:underline">
|
||||
catalogs
|
||||
</Link>{" "}
|
||||
— the vocabulary of components available in your specs.
|
||||
</p>
|
||||
</article>
|
||||
);
|
||||
}
|
||||
@@ -0,0 +1,171 @@
|
||||
import { pageMetadata } from "@/lib/page-metadata"
|
||||
export const metadata = pageMetadata("docs/streaming")
|
||||
|
||||
# Streaming
|
||||
|
||||
Progressively render UI as AI generates it.
|
||||
|
||||
## SpecStream Format
|
||||
|
||||
json-render uses **SpecStream**, a JSONL-based streaming format where each line is a JSON patch operation that progressively builds your spec:
|
||||
|
||||
```json
|
||||
{"op":"add","path":"/root","value":"root"}
|
||||
{"op":"add","path":"/elements/root","value":{"type":"Card","props":{"title":"Dashboard"},"children":["metric-1","metric-2"]}}
|
||||
{"op":"add","path":"/elements/metric-1","value":{"type":"Metric","props":{"label":"Revenue"}}}
|
||||
{"op":"add","path":"/elements/metric-2","value":{"type":"Metric","props":{"label":"Users"}}}
|
||||
```
|
||||
|
||||
## Patch Operations (RFC 6902)
|
||||
|
||||
SpecStream uses [RFC 6902 JSON Patch](https://datatracker.ietf.org/doc/html/rfc6902) operations:
|
||||
|
||||
- `add` — Add a value at a path (creates or replaces for objects, inserts for arrays)
|
||||
- `remove` — Remove the value at a path
|
||||
- `replace` — Replace an existing value at a path
|
||||
- `move` — Move a value from one path to another (requires `from`)
|
||||
- `copy` — Copy a value from one path to another (requires `from`)
|
||||
- `test` — Assert that a value at a path equals the given value
|
||||
|
||||
## Path Format
|
||||
|
||||
Paths follow JSON Pointer (RFC 6901) into the spec object:
|
||||
|
||||
```bash
|
||||
/root -> Root element key (string)
|
||||
/elements/card-1 -> Element with key "card-1"
|
||||
/elements/card-1/props -> Props of card-1
|
||||
/elements/card-1/children -> Children of card-1
|
||||
```
|
||||
|
||||
## Server-Side Setup
|
||||
|
||||
Ensure your API route streams properly:
|
||||
|
||||
```typescript
|
||||
import { streamText } from 'ai';
|
||||
import { catalog } from '@/lib/catalog';
|
||||
|
||||
export async function POST(req: Request) {
|
||||
const { prompt } = await req.json();
|
||||
|
||||
const result = streamText({
|
||||
model: 'anthropic/claude-haiku-4.5',
|
||||
system: catalog.prompt(),
|
||||
prompt,
|
||||
});
|
||||
|
||||
// Return as a streaming response
|
||||
return result.toTextStreamResponse();
|
||||
}
|
||||
```
|
||||
|
||||
## Low-Level SpecStream API
|
||||
|
||||
For custom or framework-agnostic streaming implementations, use the SpecStream compiler from `@json-render/core` directly:
|
||||
|
||||
```typescript
|
||||
import { createSpecStreamCompiler } from '@json-render/core';
|
||||
|
||||
// Create a compiler for your spec type
|
||||
const compiler = createSpecStreamCompiler<MySpec>();
|
||||
const decoder = new TextDecoder();
|
||||
|
||||
// Process streaming chunks from AI
|
||||
async function processStream(reader: ReadableStreamDefaultReader<Uint8Array>) {
|
||||
while (true) {
|
||||
const { done, value } = await reader.read();
|
||||
if (done) break;
|
||||
|
||||
// Decode the Uint8Array chunk to a string
|
||||
const chunk = decoder.decode(value, { stream: true });
|
||||
const { result, newPatches } = compiler.push(chunk);
|
||||
|
||||
if (newPatches.length > 0) {
|
||||
// Update UI with partial result
|
||||
setSpec(result);
|
||||
}
|
||||
}
|
||||
|
||||
// Get final compiled result
|
||||
return compiler.getResult();
|
||||
}
|
||||
```
|
||||
|
||||
### One-Shot Compilation
|
||||
|
||||
For non-streaming scenarios, compile entire SpecStream at once:
|
||||
|
||||
```typescript
|
||||
import { compileSpecStream } from '@json-render/core';
|
||||
|
||||
const jsonl = `{"op":"add","path":"/root","value":"card-1"}
|
||||
{"op":"add","path":"/elements/card-1","value":{"type":"Card","props":{"title":"Hello"},"children":[]}}`;
|
||||
|
||||
const spec = compileSpecStream<Spec>(jsonl);
|
||||
// { root: "card-1", elements: { "card-1": { type: "Card", props: { title: "Hello" }, children: [] } } }
|
||||
```
|
||||
|
||||
## Usage with React
|
||||
|
||||
`@json-render/react` provides the `useUIStream` hook, which wraps the low-level compiler in a React-friendly API with state management, error handling, and abort support.
|
||||
|
||||
### useUIStream Hook
|
||||
|
||||
```tsx
|
||||
import { useUIStream } from '@json-render/react';
|
||||
|
||||
function App() {
|
||||
const {
|
||||
spec, // Current UI spec state
|
||||
isStreaming, // True while streaming
|
||||
error, // Any error that occurred
|
||||
send, // Function to start generation
|
||||
clear, // Function to reset spec and error
|
||||
} = useUIStream({
|
||||
api: '/api/generate',
|
||||
onComplete: (spec) => {}, // Optional: called when streaming completes
|
||||
onError: (error) => {}, // Optional: called when an error occurs
|
||||
});
|
||||
}
|
||||
```
|
||||
|
||||
### Progressive Rendering
|
||||
|
||||
The Renderer automatically updates as the spec changes:
|
||||
|
||||
```tsx
|
||||
function App() {
|
||||
const { spec, isStreaming } = useUIStream({ api: '/api/generate' });
|
||||
|
||||
return (
|
||||
<div>
|
||||
{isStreaming && <LoadingIndicator />}
|
||||
<Renderer spec={spec} registry={registry} loading={isStreaming} />
|
||||
</div>
|
||||
);
|
||||
}
|
||||
```
|
||||
|
||||
### Aborting Streams
|
||||
|
||||
Calling `send` again automatically aborts the previous request. Use `clear` to reset the spec and error state:
|
||||
|
||||
```tsx
|
||||
function App() {
|
||||
const { isStreaming, send, clear } = useUIStream({
|
||||
api: '/api/generate',
|
||||
});
|
||||
|
||||
return (
|
||||
<div>
|
||||
<button onClick={() => send('Create dashboard')}>
|
||||
Generate
|
||||
</button>
|
||||
<button onClick={clear}>Reset</button>
|
||||
</div>
|
||||
);
|
||||
}
|
||||
```
|
||||
|
||||
See the [@json-render/react API reference](/docs/api/react) for full `useUIStream` documentation.
|
||||
@@ -1,175 +0,0 @@
|
||||
import { Code } from "@/components/code";
|
||||
|
||||
export const metadata = {
|
||||
title: "Streaming | json-render",
|
||||
};
|
||||
|
||||
export default function StreamingPage() {
|
||||
return (
|
||||
<article>
|
||||
<h1 className="text-3xl font-bold mb-4">Streaming</h1>
|
||||
<p className="text-muted-foreground mb-8">
|
||||
Progressively render UI as AI generates it.
|
||||
</p>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">SpecStream Format</h2>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
json-render uses <strong>SpecStream</strong>, a JSONL-based streaming
|
||||
format where each line is a JSON patch operation that progressively
|
||||
builds your spec:
|
||||
</p>
|
||||
<Code lang="json">{`{"op":"set","path":"/root","value":{"key":"root","type":"Card","props":{"title":"Dashboard"}}}
|
||||
{"op":"set","path":"/root/children/0","value":{"key":"metric-1","type":"Metric","props":{"label":"Revenue"}}}
|
||||
{"op":"set","path":"/root/children/1","value":{"key":"metric-2","type":"Metric","props":{"label":"Users"}}}`}</Code>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">useUIStream Hook</h2>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
The hook handles parsing and state management:
|
||||
</p>
|
||||
<Code lang="tsx">{`import { useUIStream } from '@json-render/react';
|
||||
|
||||
function App() {
|
||||
const {
|
||||
spec, // Current UI spec state
|
||||
isStreaming, // True while streaming
|
||||
error, // Any error that occurred
|
||||
send, // Function to start generation
|
||||
abort, // Function to cancel streaming
|
||||
} = useUIStream({
|
||||
api: '/api/generate',
|
||||
onChunk: (chunk) => {}, // Optional: called for each chunk
|
||||
onFinish: (spec) => {}, // Optional: called when complete
|
||||
});
|
||||
}`}</Code>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">Patch Operations</h2>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
Supported operations:
|
||||
</p>
|
||||
<ul className="list-disc list-inside text-sm text-muted-foreground space-y-2 mb-4">
|
||||
<li>
|
||||
<code className="text-foreground">set</code> — Set the value at a path
|
||||
(creates if needed)
|
||||
</li>
|
||||
<li>
|
||||
<code className="text-foreground">add</code> — Add to an array at a
|
||||
path
|
||||
</li>
|
||||
<li>
|
||||
<code className="text-foreground">replace</code> — Replace value at a
|
||||
path
|
||||
</li>
|
||||
<li>
|
||||
<code className="text-foreground">remove</code> — Remove value at a
|
||||
path
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">Path Format</h2>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
Paths use a key-based format for elements:
|
||||
</p>
|
||||
<Code lang="bash">{`/root -> Root element
|
||||
/root/children -> Children of root
|
||||
/elements/card-1 -> Element with key "card-1"
|
||||
/elements/card-1/children -> Children of card-1`}</Code>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">Server-Side Setup</h2>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
Ensure your API route streams properly:
|
||||
</p>
|
||||
<Code lang="typescript">{`import { streamText } from 'ai';
|
||||
import { catalog } from '@/lib/catalog';
|
||||
|
||||
export async function POST(req: Request) {
|
||||
const { prompt } = await req.json();
|
||||
|
||||
const result = streamText({
|
||||
model: 'anthropic/claude-haiku-4.5',
|
||||
system: catalog.prompt(),
|
||||
prompt,
|
||||
});
|
||||
|
||||
// Return as a streaming response
|
||||
return result.toTextStreamResponse();
|
||||
}`}</Code>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">
|
||||
Progressive Rendering
|
||||
</h2>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
The Renderer automatically updates as the spec changes:
|
||||
</p>
|
||||
<Code lang="tsx">{`function App() {
|
||||
const { spec, isStreaming } = useUIStream({ api: '/api/generate' });
|
||||
|
||||
return (
|
||||
<div>
|
||||
{isStreaming && <LoadingIndicator />}
|
||||
<Renderer spec={spec} registry={registry} loading={isStreaming} />
|
||||
</div>
|
||||
);
|
||||
}`}</Code>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">Aborting Streams</h2>
|
||||
<Code lang="tsx">{`function App() {
|
||||
const { isStreaming, send, abort } = useUIStream({
|
||||
api: '/api/generate',
|
||||
});
|
||||
|
||||
return (
|
||||
<div>
|
||||
<button onClick={() => send('Create dashboard')}>
|
||||
Generate
|
||||
</button>
|
||||
{isStreaming && (
|
||||
<button onClick={abort}>Cancel</button>
|
||||
)}
|
||||
</div>
|
||||
);
|
||||
}`}</Code>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">
|
||||
Low-Level SpecStream API
|
||||
</h2>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
For custom streaming implementations, use the SpecStream compiler
|
||||
directly:
|
||||
</p>
|
||||
<Code lang="typescript">{`import { createSpecStreamCompiler } from '@json-render/core';
|
||||
|
||||
// Create a compiler for your spec type
|
||||
const compiler = createSpecStreamCompiler<MySpec>();
|
||||
|
||||
// Process streaming chunks from AI
|
||||
async function processStream(reader: ReadableStreamDefaultReader) {
|
||||
while (true) {
|
||||
const { done, value } = await reader.read();
|
||||
if (done) break;
|
||||
|
||||
const { result, newPatches } = compiler.push(value);
|
||||
|
||||
if (newPatches.length > 0) {
|
||||
// Update UI with partial result
|
||||
setSpec(result);
|
||||
}
|
||||
}
|
||||
|
||||
// Get final compiled result
|
||||
return compiler.getResult();
|
||||
}`}</Code>
|
||||
|
||||
<h3 className="text-lg font-semibold mt-8 mb-4">One-Shot Compilation</h3>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
For non-streaming scenarios, compile entire SpecStream at once:
|
||||
</p>
|
||||
<Code lang="typescript">{`import { compileSpecStream } from '@json-render/core';
|
||||
|
||||
const jsonl = \`{"op":"set","path":"/root","value":{"type":"Card"}}
|
||||
{"op":"set","path":"/root/props","value":{"title":"Hello"}}\`;
|
||||
|
||||
const spec = compileSpecStream<MySpec>(jsonl);
|
||||
// { root: { type: "Card", props: { title: "Hello" } } }`}</Code>
|
||||
</article>
|
||||
);
|
||||
}
|
||||
@@ -0,0 +1,263 @@
|
||||
import { pageMetadata } from "@/lib/page-metadata"
|
||||
export const metadata = pageMetadata("docs/validation")
|
||||
|
||||
# Validation
|
||||
|
||||
Validate form inputs with built-in and custom functions.
|
||||
|
||||
## Built-in Validators
|
||||
|
||||
json-render includes common validation functions:
|
||||
|
||||
- `required` — Value must be non-empty
|
||||
- `email` — Valid email format
|
||||
- `minLength` — Minimum string length (args: `{ "min": N }`)
|
||||
- `maxLength` — Maximum string length (args: `{ "max": N }`)
|
||||
- `pattern` — Match a regex pattern (args: `{ "pattern": "regex" }`)
|
||||
- `min` — Minimum numeric value (args: `{ "min": N }`)
|
||||
- `max` — Maximum numeric value (args: `{ "max": N }`)
|
||||
- `numeric` — Value must be a number
|
||||
- `url` — Valid URL format
|
||||
- `matches` — Must equal another field (args: `{ "other": { "$state": "/path" } }`)
|
||||
- `equalTo` — Alias for matches (args: `{ "other": { "$state": "/path" } }`)
|
||||
- `lessThan` — Value must be less than another field (args: `{ "other": { "$state": "/path" } }`)
|
||||
- `greaterThan` — Value must be greater than another field (args: `{ "other": { "$state": "/path" } }`)
|
||||
- `requiredIf` — Required only when another field is truthy (args: `{ "field": { "$state": "/path" } }`)
|
||||
|
||||
## Using Validation in JSON
|
||||
|
||||
Use `{ "$bindState": "/path" }` on the value prop for two-way binding. Validation checks run against the value at the bound path (available as `bindings?.value` in components):
|
||||
|
||||
```json
|
||||
{
|
||||
"type": "TextField",
|
||||
"props": {
|
||||
"label": "Email",
|
||||
"value": { "$bindState": "/form/email" },
|
||||
"checks": [
|
||||
{ "type": "required", "message": "Email is required" },
|
||||
{ "type": "email", "message": "Invalid email format" }
|
||||
],
|
||||
"validateOn": "blur"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Validation with Parameters
|
||||
|
||||
```json
|
||||
{
|
||||
"type": "TextField",
|
||||
"props": {
|
||||
"label": "Password",
|
||||
"value": { "$bindState": "/form/password" },
|
||||
"checks": [
|
||||
{ "type": "required", "message": "Password is required" },
|
||||
{
|
||||
"type": "minLength",
|
||||
"args": { "min": 8 },
|
||||
"message": "Password must be at least 8 characters"
|
||||
},
|
||||
{
|
||||
"type": "pattern",
|
||||
"args": { "pattern": "[A-Z]" },
|
||||
"message": "Must contain at least one uppercase letter"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Custom Validation Functions
|
||||
|
||||
Define custom validators in your catalog's `functions` field. The catalog itself is framework-agnostic — only the `schema` import varies by platform:
|
||||
|
||||
```typescript
|
||||
import { defineCatalog } from '@json-render/core';
|
||||
import { schema } from '@json-render/react/schema'; // or '@json-render/react-native/schema'
|
||||
import { z } from 'zod';
|
||||
|
||||
const catalog = defineCatalog(schema, {
|
||||
components: { /* ... */ },
|
||||
functions: {
|
||||
isValidPhone: {
|
||||
description: 'Validates phone number format',
|
||||
},
|
||||
isUniqueEmail: {
|
||||
description: 'Checks if email is not already registered',
|
||||
},
|
||||
},
|
||||
});
|
||||
```
|
||||
|
||||
## Usage with React
|
||||
|
||||
In `@json-render/react`, use `ValidationProvider` to supply implementations for your custom validators:
|
||||
|
||||
```tsx
|
||||
import { ValidationProvider } from '@json-render/react';
|
||||
|
||||
function App() {
|
||||
const customValidators = {
|
||||
isValidPhone: (value) => {
|
||||
const phoneRegex = /^\+?[1-9]\d{1,14}$/;
|
||||
return phoneRegex.test(value);
|
||||
},
|
||||
isUniqueEmail: async (value) => {
|
||||
const response = await fetch(`/api/check-email?email=${value}`);
|
||||
const { available } = await response.json();
|
||||
return available;
|
||||
},
|
||||
};
|
||||
|
||||
return (
|
||||
<ValidationProvider customFunctions={customValidators}>
|
||||
{/* Your UI */}
|
||||
</ValidationProvider>
|
||||
);
|
||||
}
|
||||
```
|
||||
|
||||
### Using in Components
|
||||
|
||||
The `useFieldValidation` and `useBoundProp` hooks wire validation into your registry components. Validation uses the path from `bindings?.value` (the bound state path):
|
||||
|
||||
```tsx
|
||||
import { useFieldValidation, useBoundProp } from '@json-render/react';
|
||||
|
||||
function TextField({ props, bindings }) {
|
||||
const [value, setValue] = useBoundProp(props.value, bindings?.value);
|
||||
const { errors, isValid, validate, touch, clear } = useFieldValidation(
|
||||
bindings?.value ?? null,
|
||||
{ checks: props.checks, validateOn: props.validateOn }
|
||||
);
|
||||
|
||||
return (
|
||||
<div>
|
||||
<label>{props.label}</label>
|
||||
<input
|
||||
value={value || ''}
|
||||
onChange={(e) => setValue(e.target.value)}
|
||||
onBlur={() => validate()}
|
||||
/>
|
||||
{errors.map((error, i) => (
|
||||
<p key={i} className="text-red-500 text-sm">{error}</p>
|
||||
))}
|
||||
</div>
|
||||
);
|
||||
}
|
||||
```
|
||||
|
||||
See the [@json-render/react API reference](/docs/api/react) for full `ValidationProvider` and `useFieldValidation` documentation.
|
||||
|
||||
## Cross-Field Validation
|
||||
|
||||
Validation args support `{ "$state": "/path" }` references to compare against other fields. This enables cross-field rules like "confirm password must match password":
|
||||
|
||||
```json
|
||||
{
|
||||
"type": "Input",
|
||||
"props": {
|
||||
"label": "Confirm Password",
|
||||
"value": { "$bindState": "/form/confirmPassword" },
|
||||
"checks": [
|
||||
{ "type": "required", "message": "Please confirm your password" },
|
||||
{
|
||||
"type": "matches",
|
||||
"args": { "other": { "$state": "/form/password" } },
|
||||
"message": "Passwords must match"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Other cross-field examples:
|
||||
|
||||
```json
|
||||
{
|
||||
"checks": [
|
||||
{
|
||||
"type": "greaterThan",
|
||||
"args": { "other": { "$state": "/form/startDate" } },
|
||||
"message": "End date must be after start date"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
```json
|
||||
{
|
||||
"checks": [
|
||||
{
|
||||
"type": "requiredIf",
|
||||
"args": { "field": { "$state": "/form/enableNotifications" } },
|
||||
"message": "Email is required when notifications are enabled"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
## Conditional Validation
|
||||
|
||||
Use the `enabled` field in the validation config to only run checks when a condition is met:
|
||||
|
||||
```json
|
||||
{
|
||||
"type": "Input",
|
||||
"props": {
|
||||
"label": "Company Name",
|
||||
"value": { "$bindState": "/form/company" },
|
||||
"checks": [
|
||||
{ "type": "required", "message": "Company name is required" }
|
||||
]
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
In the component implementation, you can pass `enabled` to `useFieldValidation`:
|
||||
|
||||
```typescript
|
||||
useFieldValidation(bindings?.value ?? "", {
|
||||
checks: props.checks ?? [],
|
||||
enabled: { "$state": "/form/accountType", eq: "business" },
|
||||
});
|
||||
```
|
||||
|
||||
This only validates the company name when the account type is "business".
|
||||
|
||||
## Validation Timing
|
||||
|
||||
Control when validation runs with `validateOn`:
|
||||
|
||||
- `change` — Validate on every input change
|
||||
- `blur` — Validate when field loses focus (default for Input, Textarea)
|
||||
- `submit` — Validate only on form submission
|
||||
|
||||
## Form-Level Validation
|
||||
|
||||
Use the built-in `validateForm` action to validate all registered fields at once. This is useful for a "Submit" button that should validate the entire form before proceeding:
|
||||
|
||||
```json
|
||||
{
|
||||
"type": "Button",
|
||||
"props": { "label": "Submit" },
|
||||
"on": {
|
||||
"press": [
|
||||
{ "action": "validateForm", "params": { "statePath": "/formResult" } },
|
||||
{ "action": "submitForm" }
|
||||
]
|
||||
},
|
||||
"children": []
|
||||
}
|
||||
```
|
||||
|
||||
The `validateForm` action runs `validateAll()` and writes `{ valid: boolean }` to the specified state path (defaults to `/formValidation`). Your submit handler can then check `{ "$state": "/formResult/valid" }` to decide whether to proceed.
|
||||
|
||||
> **Note:** Actions in a list execute sequentially, but `submitForm` does not automatically gate on validation. Guard submission with a `$cond` visibility condition on the button or check `{ "$state": "/formResult/valid" }` inside your action handler to skip submission when the form is invalid.
|
||||
|
||||
## Next
|
||||
|
||||
- [Computed Values](/docs/computed-values) — derive dynamic prop values
|
||||
- [Watchers](/docs/watchers) — react to state changes
|
||||
- [Generation Modes](/docs/generation-modes) — how AI generates specs
|
||||
@@ -1,189 +0,0 @@
|
||||
import Link from "next/link";
|
||||
import { Code } from "@/components/code";
|
||||
|
||||
export const metadata = {
|
||||
title: "Validation | json-render",
|
||||
};
|
||||
|
||||
export default function ValidationPage() {
|
||||
return (
|
||||
<article>
|
||||
<h1 className="text-3xl font-bold mb-4">Validation</h1>
|
||||
<p className="text-muted-foreground mb-8">
|
||||
Validate form inputs with built-in and custom functions.
|
||||
</p>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">Built-in Validators</h2>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
json-render includes common validation functions:
|
||||
</p>
|
||||
<ul className="list-disc list-inside text-sm text-muted-foreground space-y-1 mb-4">
|
||||
<li>
|
||||
<code className="text-foreground">required</code> — Value must be
|
||||
non-empty
|
||||
</li>
|
||||
<li>
|
||||
<code className="text-foreground">email</code> — Valid email format
|
||||
</li>
|
||||
<li>
|
||||
<code className="text-foreground">minLength</code> — Minimum string
|
||||
length
|
||||
</li>
|
||||
<li>
|
||||
<code className="text-foreground">maxLength</code> — Maximum string
|
||||
length
|
||||
</li>
|
||||
<li>
|
||||
<code className="text-foreground">pattern</code> — Match a regex
|
||||
pattern
|
||||
</li>
|
||||
<li>
|
||||
<code className="text-foreground">min</code> — Minimum numeric value
|
||||
</li>
|
||||
<li>
|
||||
<code className="text-foreground">max</code> — Maximum numeric value
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">
|
||||
Using Validation in JSON
|
||||
</h2>
|
||||
<Code lang="json">{`{
|
||||
"type": "TextField",
|
||||
"props": {
|
||||
"label": "Email",
|
||||
"valuePath": "/form/email",
|
||||
"checks": [
|
||||
{ "fn": "required", "message": "Email is required" },
|
||||
{ "fn": "email", "message": "Invalid email format" }
|
||||
],
|
||||
"validateOn": "blur"
|
||||
}
|
||||
}`}</Code>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">
|
||||
Validation with Parameters
|
||||
</h2>
|
||||
<Code lang="json">{`{
|
||||
"type": "TextField",
|
||||
"props": {
|
||||
"label": "Password",
|
||||
"valuePath": "/form/password",
|
||||
"checks": [
|
||||
{ "fn": "required", "message": "Password is required" },
|
||||
{
|
||||
"fn": "minLength",
|
||||
"args": { "length": 8 },
|
||||
"message": "Password must be at least 8 characters"
|
||||
},
|
||||
{
|
||||
"fn": "pattern",
|
||||
"args": { "pattern": "[A-Z]" },
|
||||
"message": "Must contain at least one uppercase letter"
|
||||
}
|
||||
]
|
||||
}
|
||||
}`}</Code>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">
|
||||
Custom Validation Functions
|
||||
</h2>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
Define custom validators in your catalog:
|
||||
</p>
|
||||
<Code lang="typescript">{`import { defineCatalog } from '@json-render/core';
|
||||
import { schema } from '@json-render/react';
|
||||
import { z } from 'zod';
|
||||
|
||||
const catalog = defineCatalog(schema, {
|
||||
components: { /* ... */ },
|
||||
functions: {
|
||||
isValidPhone: {
|
||||
description: 'Validates phone number format',
|
||||
},
|
||||
isUniqueEmail: {
|
||||
description: 'Checks if email is not already registered',
|
||||
},
|
||||
},
|
||||
});`}</Code>
|
||||
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
Then implement them in your ValidationProvider:
|
||||
</p>
|
||||
<Code lang="tsx">{`import { ValidationProvider } from '@json-render/react';
|
||||
|
||||
function App() {
|
||||
const customValidators = {
|
||||
isValidPhone: (value) => {
|
||||
const phoneRegex = /^\\+?[1-9]\\d{1,14}$/;
|
||||
return phoneRegex.test(value);
|
||||
},
|
||||
isUniqueEmail: async (value) => {
|
||||
const response = await fetch(\`/api/check-email?email=\${value}\`);
|
||||
const { available } = await response.json();
|
||||
return available;
|
||||
},
|
||||
};
|
||||
|
||||
return (
|
||||
<ValidationProvider functions={customValidators}>
|
||||
{/* Your UI */}
|
||||
</ValidationProvider>
|
||||
);
|
||||
}`}</Code>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">Using in Components</h2>
|
||||
<Code lang="tsx">{`import { useFieldValidation } from '@json-render/react';
|
||||
|
||||
function TextField({ props }) {
|
||||
const { value, setValue, errors, validate } = useFieldValidation(
|
||||
props.valuePath,
|
||||
props.checks
|
||||
);
|
||||
|
||||
return (
|
||||
<div>
|
||||
<label>{props.label}</label>
|
||||
<input
|
||||
value={value || ''}
|
||||
onChange={(e) => setValue(e.target.value)}
|
||||
onBlur={() => validate()}
|
||||
/>
|
||||
{errors.map((error, i) => (
|
||||
<p key={i} className="text-red-500 text-sm">{error}</p>
|
||||
))}
|
||||
</div>
|
||||
);
|
||||
}`}</Code>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">Validation Timing</h2>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
Control when validation runs with{" "}
|
||||
<code className="text-foreground">validateOn</code>:
|
||||
</p>
|
||||
<ul className="list-disc list-inside text-sm text-muted-foreground space-y-1">
|
||||
<li>
|
||||
<code className="text-foreground">change</code> — Validate on every
|
||||
input change
|
||||
</li>
|
||||
<li>
|
||||
<code className="text-foreground">blur</code> — Validate when field
|
||||
loses focus
|
||||
</li>
|
||||
<li>
|
||||
<code className="text-foreground">submit</code> — Validate only on
|
||||
form submission
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">Next</h2>
|
||||
<p className="text-sm text-muted-foreground">
|
||||
Learn about{" "}
|
||||
<Link href="/docs/ai-sdk" className="text-foreground hover:underline">
|
||||
AI SDK integration
|
||||
</Link>
|
||||
.
|
||||
</p>
|
||||
</article>
|
||||
);
|
||||
}
|
||||
@@ -0,0 +1,339 @@
|
||||
import { pageMetadata } from "@/lib/page-metadata"
|
||||
export const metadata = pageMetadata("docs/visibility")
|
||||
|
||||
# Visibility
|
||||
|
||||
Conditionally show or hide components based on state values and logic.
|
||||
|
||||
## State-Based Visibility
|
||||
|
||||
Show/hide based on state values. Use `$state` with a JSON Pointer path:
|
||||
|
||||
```json
|
||||
{
|
||||
"type": "Alert",
|
||||
"props": { "message": "Form has errors" },
|
||||
"visible": { "$state": "/form/hasErrors" }
|
||||
}
|
||||
```
|
||||
|
||||
Visible when `/form/hasErrors` is truthy.
|
||||
|
||||
### Negation
|
||||
|
||||
Use `not: true` to invert a condition:
|
||||
|
||||
```json
|
||||
{
|
||||
"type": "WelcomeBanner",
|
||||
"visible": { "$state": "/user/hasSeenWelcome", "not": true }
|
||||
}
|
||||
```
|
||||
|
||||
Visible when `/user/hasSeenWelcome` is falsy.
|
||||
|
||||
## Auth-Based Visibility
|
||||
|
||||
Show/hide based on authentication state. Expose your auth state in the state model (e.g. at `/auth/isSignedIn`):
|
||||
|
||||
```json
|
||||
{
|
||||
"type": "AdminPanel",
|
||||
"visible": { "$state": "/auth/isSignedIn" }
|
||||
}
|
||||
```
|
||||
|
||||
For signed-out only:
|
||||
|
||||
```json
|
||||
{
|
||||
"type": "LoginPrompt",
|
||||
"visible": { "$state": "/auth/isSignedIn", "not": true }
|
||||
}
|
||||
```
|
||||
|
||||
## Comparison Operators
|
||||
|
||||
Compare a state value to a literal or another state path. Use **one operator per condition** -- if multiple are provided, only the first one is evaluated (precedence: `eq` > `neq` > `gt` > `gte` > `lt` > `lte`). Add `"not": true` to invert the result of any condition.
|
||||
|
||||
```json
|
||||
// Equal
|
||||
{
|
||||
"visible": { "$state": "/user/role", "eq": "admin" }
|
||||
}
|
||||
|
||||
// Not equal
|
||||
{
|
||||
"visible": { "$state": "/tab", "neq": "home" }
|
||||
}
|
||||
|
||||
// Greater than
|
||||
{
|
||||
"visible": { "$state": "/cart/total", "gt": 100 }
|
||||
}
|
||||
|
||||
// Greater than or equal
|
||||
{
|
||||
"visible": { "$state": "/cart/itemCount", "gte": 1 }
|
||||
}
|
||||
|
||||
// Less than
|
||||
{
|
||||
"visible": { "$state": "/cart/total", "lt": 1000 }
|
||||
}
|
||||
|
||||
// Less than or equal
|
||||
{
|
||||
"visible": { "$state": "/cart/itemCount", "lte": 10 }
|
||||
}
|
||||
```
|
||||
|
||||
Comparison values can be literals or state references:
|
||||
|
||||
```json
|
||||
{
|
||||
"visible": { "$state": "/user/balance", "gte": { "$state": "/order/minimum" } }
|
||||
}
|
||||
```
|
||||
|
||||
## Combining Conditions (AND)
|
||||
|
||||
Place multiple conditions in an array for implicit AND:
|
||||
|
||||
```json
|
||||
{
|
||||
"type": "SubmitButton",
|
||||
"visible": [
|
||||
{ "$state": "/form/isValid" },
|
||||
{ "$state": "/form/hasChanges" }
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
All conditions must be true for the element to be visible.
|
||||
|
||||
## OR Conditions
|
||||
|
||||
Use `$or` when at least one condition should be true:
|
||||
|
||||
```json
|
||||
{
|
||||
"type": "SpecialOffer",
|
||||
"visible": { "$or": [
|
||||
{ "$state": "/user/isVIP" },
|
||||
{ "$state": "/cart/total", "gt": 200 }
|
||||
]}
|
||||
}
|
||||
```
|
||||
|
||||
Visible when the user is VIP **or** the cart total exceeds 200. `$or` can contain any visibility conditions, including nested arrays (AND) and comparisons.
|
||||
|
||||
## Explicit AND
|
||||
|
||||
Use `$and` when you need to nest AND logic inside `$or`:
|
||||
|
||||
```json
|
||||
{
|
||||
"type": "PromoCard",
|
||||
"visible": { "$or": [
|
||||
{ "$and": [
|
||||
{ "$state": "/user/isVIP" },
|
||||
{ "$state": "/cart/total", "gt": 50 }
|
||||
]},
|
||||
{ "$state": "/promo/active" }
|
||||
]}
|
||||
}
|
||||
```
|
||||
|
||||
For top-level AND, the implicit array form is simpler: `[condition, condition]`. Use `$and` only when nesting inside `$or`.
|
||||
|
||||
## Always / Never
|
||||
|
||||
Use boolean literals for constant visibility:
|
||||
|
||||
```json
|
||||
{
|
||||
"type": "Footer",
|
||||
"visible": true
|
||||
}
|
||||
```
|
||||
|
||||
```json
|
||||
{
|
||||
"type": "DeprecatedPanel",
|
||||
"visible": false
|
||||
}
|
||||
```
|
||||
|
||||
## Repeat-Scoped Conditions
|
||||
|
||||
Inside a [repeat](/docs/data-binding#repeat), use `$item` and `$index` conditions to show/hide based on the current item:
|
||||
|
||||
### `$item` — Condition on item field
|
||||
|
||||
```json
|
||||
{
|
||||
"type": "Badge",
|
||||
"props": { "label": "Overdue" },
|
||||
"visible": { "$item": "isOverdue" }
|
||||
}
|
||||
```
|
||||
|
||||
With comparison:
|
||||
|
||||
```json
|
||||
{
|
||||
"type": "DiscountTag",
|
||||
"visible": { "$item": "price", "gt": 100 }
|
||||
}
|
||||
```
|
||||
|
||||
### `$index` — Condition on array index
|
||||
|
||||
```json
|
||||
{
|
||||
"type": "Divider",
|
||||
"visible": { "$index": true, "gt": 0 }
|
||||
}
|
||||
```
|
||||
|
||||
This shows the divider for every item except the first (index 0).
|
||||
|
||||
`$item` and `$index` conditions support the same comparison operators as `$state` (`eq`, `neq`, `gt`, `gte`, `lt`, `lte`, `not`).
|
||||
|
||||
## Complex Example
|
||||
|
||||
```json
|
||||
{
|
||||
"type": "RefundButton",
|
||||
"props": { "label": "Process Refund" },
|
||||
"visible": [
|
||||
{ "$state": "/auth/isSignedIn" },
|
||||
{ "$state": "/user/role", "eq": "support" },
|
||||
{ "$state": "/order/amount", "gt": 0 },
|
||||
{ "$state": "/order/isRefunded", "not": true }
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
## Quick Reference
|
||||
|
||||
<div className="my-6 overflow-x-auto">
|
||||
<table className="mdx-table w-full text-sm border-collapse">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Condition</th>
|
||||
<th>Syntax</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>Truthiness</td>
|
||||
<td><code>{'{ "$state": "/path" }'}</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Falsy (not)</td>
|
||||
<td><code>{'{ "$state": "/path", "not": true }'}</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Equal</td>
|
||||
<td><code>{'{ "$state": "/path", "eq": value }'}</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Not equal</td>
|
||||
<td><code>{'{ "$state": "/path", "neq": value }'}</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Greater than</td>
|
||||
<td><code>{'{ "$state": "/path", "gt": number }'}</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Greater or equal</td>
|
||||
<td><code>{'{ "$state": "/path", "gte": number }'}</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Less than</td>
|
||||
<td><code>{'{ "$state": "/path", "lt": number }'}</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Less or equal</td>
|
||||
<td><code>{'{ "$state": "/path", "lte": number }'}</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Item field (repeat)</td>
|
||||
<td><code>{'{ "$item": "field" }'}</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Item comparison</td>
|
||||
<td><code>{'{ "$item": "field", "eq": value }'}</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Index (repeat)</td>
|
||||
<td><code>{'{ "$index": true, "gt": 0 }'}</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>AND (implicit)</td>
|
||||
<td><code>{"[ condition, condition ]"}</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>AND (explicit)</td>
|
||||
<td><code>{'{ "$and": [ condition, condition ] }'}</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>OR</td>
|
||||
<td><code>{'{ "$or": [ condition, condition ] }'}</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Always</td>
|
||||
<td><code>{"true"}</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Never</td>
|
||||
<td><code>{"false"}</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
Comparison values can be literals or state references for state-to-state comparisons:
|
||||
|
||||
```json
|
||||
{ "$state": "/a", "eq": { "$state": "/b" } }
|
||||
```
|
||||
|
||||
## Usage with React
|
||||
|
||||
In `@json-render/react`, wrap your app with `VisibilityProvider` to enable conditional rendering. The `Renderer` handles visibility automatically — elements with unmet conditions are not rendered.
|
||||
|
||||
```tsx
|
||||
import { VisibilityProvider, StateProvider } from '@json-render/react';
|
||||
|
||||
function App() {
|
||||
return (
|
||||
<StateProvider initialState={data}>
|
||||
<VisibilityProvider>
|
||||
{/* Components can now use visibility conditions */}
|
||||
</VisibilityProvider>
|
||||
</StateProvider>
|
||||
);
|
||||
}
|
||||
```
|
||||
|
||||
For advanced use cases, the `useIsVisible` hook lets you evaluate visibility conditions programmatically:
|
||||
|
||||
```tsx
|
||||
import { useIsVisible } from '@json-render/react';
|
||||
|
||||
function ConditionalContent({ condition, children }) {
|
||||
const isVisible = useIsVisible(condition);
|
||||
|
||||
if (!isVisible) return null;
|
||||
return <div>{children}</div>;
|
||||
}
|
||||
```
|
||||
|
||||
See the [@json-render/react API reference](/docs/api/react) for full details.
|
||||
|
||||
## Next
|
||||
|
||||
Learn about [form validation](/docs/validation).
|
||||
@@ -1,148 +0,0 @@
|
||||
import Link from "next/link";
|
||||
import { Code } from "@/components/code";
|
||||
|
||||
export const metadata = {
|
||||
title: "Visibility | json-render",
|
||||
};
|
||||
|
||||
export default function VisibilityPage() {
|
||||
return (
|
||||
<article>
|
||||
<h1 className="text-3xl font-bold mb-4">Visibility</h1>
|
||||
<p className="text-muted-foreground mb-8">
|
||||
Conditionally show or hide components based on data, auth, or logic.
|
||||
</p>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">VisibilityProvider</h2>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
Wrap your app with VisibilityProvider to enable conditional rendering:
|
||||
</p>
|
||||
<Code lang="tsx">{`import { VisibilityProvider } from '@json-render/react';
|
||||
|
||||
function App() {
|
||||
return (
|
||||
<DataProvider initialData={data}>
|
||||
<VisibilityProvider>
|
||||
{/* Components can now use visibility conditions */}
|
||||
</VisibilityProvider>
|
||||
</DataProvider>
|
||||
);
|
||||
}`}</Code>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">
|
||||
Path-Based Visibility
|
||||
</h2>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
Show/hide based on data values:
|
||||
</p>
|
||||
<Code lang="json">{`{
|
||||
"type": "Alert",
|
||||
"props": { "message": "Form has errors" },
|
||||
"visible": { "path": "/form/hasErrors" }
|
||||
}
|
||||
|
||||
// Visible when /form/hasErrors is truthy`}</Code>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">
|
||||
Auth-Based Visibility
|
||||
</h2>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
Show/hide based on authentication state:
|
||||
</p>
|
||||
<Code lang="json">{`{
|
||||
"type": "AdminPanel",
|
||||
"visible": { "auth": "signedIn" }
|
||||
}
|
||||
|
||||
// Options: "signedIn", "signedOut", "admin", etc.`}</Code>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">Logic Expressions</h2>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
Combine conditions with logic operators:
|
||||
</p>
|
||||
<Code lang="json">{`// AND - all conditions must be true
|
||||
{
|
||||
"type": "SubmitButton",
|
||||
"visible": {
|
||||
"and": [
|
||||
{ "path": "/form/isValid" },
|
||||
{ "path": "/form/hasChanges" }
|
||||
]
|
||||
}
|
||||
}
|
||||
|
||||
// OR - any condition must be true
|
||||
{
|
||||
"type": "HelpText",
|
||||
"visible": {
|
||||
"or": [
|
||||
{ "path": "/user/isNew" },
|
||||
{ "path": "/settings/showHelp" }
|
||||
]
|
||||
}
|
||||
}
|
||||
|
||||
// NOT - invert a condition
|
||||
{
|
||||
"type": "WelcomeBanner",
|
||||
"visible": {
|
||||
"not": { "path": "/user/hasSeenWelcome" }
|
||||
}
|
||||
}`}</Code>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">Comparison Operators</h2>
|
||||
<Code lang="json">{`// Equal
|
||||
{
|
||||
"visible": {
|
||||
"eq": [{ "path": "/user/role" }, "admin"]
|
||||
}
|
||||
}
|
||||
|
||||
// Greater than
|
||||
{
|
||||
"visible": {
|
||||
"gt": [{ "path": "/cart/total" }, 100]
|
||||
}
|
||||
}
|
||||
|
||||
// Available: eq, ne, gt, gte, lt, lte`}</Code>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">Complex Example</h2>
|
||||
<Code lang="json">{`{
|
||||
"type": "RefundButton",
|
||||
"props": { "label": "Process Refund" },
|
||||
"visible": {
|
||||
"and": [
|
||||
{ "auth": "signedIn" },
|
||||
{ "eq": [{ "path": "/user/role" }, "support"] },
|
||||
{ "gt": [{ "path": "/order/amount" }, 0] },
|
||||
{ "not": { "path": "/order/isRefunded" } }
|
||||
]
|
||||
}
|
||||
}`}</Code>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">Using in Components</h2>
|
||||
<Code lang="tsx">{`import { useIsVisible } from '@json-render/react';
|
||||
|
||||
// The Renderer handles visibility automatically, but you can also use the hook
|
||||
function ConditionalContent({ condition, children }) {
|
||||
const isVisible = useIsVisible(condition);
|
||||
|
||||
if (!isVisible) return null;
|
||||
return <div>{children}</div>;
|
||||
}`}</Code>
|
||||
|
||||
<h2 className="text-xl font-semibold mt-12 mb-4">Next</h2>
|
||||
<p className="text-sm text-muted-foreground">
|
||||
Learn about{" "}
|
||||
<Link
|
||||
href="/docs/validation"
|
||||
className="text-foreground hover:underline"
|
||||
>
|
||||
form validation
|
||||
</Link>
|
||||
.
|
||||
</p>
|
||||
</article>
|
||||
);
|
||||
}
|
||||
@@ -0,0 +1,150 @@
|
||||
import { pageMetadata } from "@/lib/page-metadata"
|
||||
export const metadata = pageMetadata("docs/watchers")
|
||||
|
||||
# Watchers
|
||||
|
||||
React to state changes by triggering actions when watched paths update.
|
||||
|
||||
## The `watch` Field
|
||||
|
||||
Elements can have an optional `watch` field that maps state paths to action bindings. When the value at a watched path changes, the bound actions fire automatically.
|
||||
|
||||
`watch` is a **top-level field** on the element (sibling of `type`, `props`, `children`) — not inside `props`.
|
||||
|
||||
```json
|
||||
{
|
||||
"type": "Select",
|
||||
"props": {
|
||||
"label": "Country",
|
||||
"value": { "$bindState": "/form/country" },
|
||||
"options": ["US", "Canada", "UK"]
|
||||
},
|
||||
"watch": {
|
||||
"/form/country": {
|
||||
"action": "loadCities",
|
||||
"params": { "country": { "$state": "/form/country" } }
|
||||
}
|
||||
},
|
||||
"children": []
|
||||
}
|
||||
```
|
||||
|
||||
When the user selects a different country, the `loadCities` action fires with the new country value. The action handler can fetch city data and update state, causing a dependent city Select to re-render with new options.
|
||||
|
||||
## Cascading Selects
|
||||
|
||||
A common pattern is cascading dropdowns where selecting a value in one field loads options for another:
|
||||
|
||||
```json
|
||||
{
|
||||
"root": "form",
|
||||
"elements": {
|
||||
"form": {
|
||||
"type": "Stack",
|
||||
"props": { "direction": "vertical", "gap": "md" },
|
||||
"children": ["country-select", "city-select"]
|
||||
},
|
||||
"country-select": {
|
||||
"type": "Select",
|
||||
"props": {
|
||||
"label": "Country",
|
||||
"value": { "$bindState": "/form/country" },
|
||||
"options": ["US", "Canada", "UK"]
|
||||
},
|
||||
"watch": {
|
||||
"/form/country": [
|
||||
{ "action": "loadCities", "params": { "country": { "$state": "/form/country" } } },
|
||||
{ "action": "setState", "params": { "statePath": "/form/city", "value": "" } }
|
||||
]
|
||||
},
|
||||
"children": []
|
||||
},
|
||||
"city-select": {
|
||||
"type": "Select",
|
||||
"props": {
|
||||
"label": "City",
|
||||
"value": { "$bindState": "/form/city" },
|
||||
"options": { "$state": "/availableCities" },
|
||||
"placeholder": "Select a city"
|
||||
},
|
||||
"children": []
|
||||
}
|
||||
},
|
||||
"state": {
|
||||
"form": { "country": "", "city": "" },
|
||||
"availableCities": []
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
The watcher on `country-select` fires two actions when the country changes:
|
||||
1. `loadCities` — fetches and writes city options to `/availableCities`
|
||||
2. `setState` — resets the city selection
|
||||
|
||||
The city Select reads its options from `{ "$state": "/availableCities" }`, so it automatically updates when the data is loaded.
|
||||
|
||||
### Action Handler
|
||||
|
||||
```typescript
|
||||
const handlers = {
|
||||
loadCities: async (params) => {
|
||||
const cities = await fetchCities(params.country);
|
||||
// setState is called by the runtime to write the result
|
||||
return cities;
|
||||
},
|
||||
};
|
||||
```
|
||||
|
||||
Or with `defineRegistry`:
|
||||
|
||||
```typescript
|
||||
const { registry, handlers } = defineRegistry(catalog, {
|
||||
components: { /* ... */ },
|
||||
actions: {
|
||||
loadCities: async (params, setState) => {
|
||||
const response = await fetch(`/api/cities?country=${params.country}`);
|
||||
const cities = await response.json();
|
||||
setState('/availableCities', cities);
|
||||
},
|
||||
},
|
||||
});
|
||||
```
|
||||
|
||||
## Multiple Watchers
|
||||
|
||||
An element can watch multiple state paths. Each path maps to one or more action bindings:
|
||||
|
||||
```json
|
||||
{
|
||||
"watch": {
|
||||
"/form/startDate": { "action": "validateDateRange" },
|
||||
"/form/endDate": { "action": "validateDateRange" },
|
||||
"/form/quantity": [
|
||||
{ "action": "recalculateTotal" },
|
||||
{ "action": "checkInventory", "params": { "qty": { "$state": "/form/quantity" } } }
|
||||
]
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Behavior
|
||||
|
||||
- Watchers only fire on **value changes**, not on the initial render
|
||||
- Comparison is by reference (`===`), not deep equality
|
||||
- Action params support the same expressions as event bindings (`$state`, `$item`, `$index`)
|
||||
- Multiple action bindings on the same path execute sequentially
|
||||
|
||||
## When to Use `watch` vs `on`
|
||||
|
||||
| Mechanism | Trigger | Use Case |
|
||||
|-----------|---------|----------|
|
||||
| `on` | User interaction (press, change, blur) | Button clicks, input changes, form submissions |
|
||||
| `watch` | State value change (any source) | Cascading data, derived state, cross-field sync |
|
||||
|
||||
Use `on` when reacting to direct user actions. Use `watch` when a state change (from any source — user input, action handler, or external store update) should trigger side effects.
|
||||
|
||||
## Next
|
||||
|
||||
- [Data Binding](/docs/data-binding) — connect elements to state
|
||||
- [Computed Values](/docs/computed-values) — derive prop values
|
||||
- [Visibility](/docs/visibility) — conditionally show or hide elements
|
||||
@@ -9,12 +9,16 @@ export default function Home() {
|
||||
<>
|
||||
{/* Hero */}
|
||||
<section className="max-w-5xl mx-auto px-6 pt-24 pb-16 text-center">
|
||||
<h1 className="text-5xl sm:text-6xl md:text-7xl font-bold tracking-tighter mb-6">
|
||||
<p className="text-xs sm:text-sm font-medium text-muted-foreground tracking-widest uppercase mb-4">
|
||||
The Generative UI Framework
|
||||
</p>
|
||||
<h1 className="text-4xl sm:text-6xl md:text-7xl font-bold tracking-tighter mb-6">
|
||||
AI → json-render → UI
|
||||
</h1>
|
||||
<p className="text-lg text-muted-foreground max-w-2xl mx-auto mb-12 leading-relaxed">
|
||||
Define a component catalog. Users prompt. AI outputs JSON constrained
|
||||
to your catalog. Your components render it.
|
||||
Generate dynamic, personalized UIs from prompts without sacrificing
|
||||
reliability. Predefined components and actions for safe, predictable
|
||||
output.
|
||||
</p>
|
||||
|
||||
<Demo />
|
||||
@@ -65,10 +69,10 @@ export default function Home() {
|
||||
<div className="text-xs text-muted-foreground font-mono mb-3">
|
||||
02
|
||||
</div>
|
||||
<h3 className="text-lg font-semibold mb-2">Users Prompt</h3>
|
||||
<h3 className="text-lg font-semibold mb-2">AI Generates</h3>
|
||||
<p className="text-sm text-muted-foreground leading-relaxed">
|
||||
End users describe what they want. AI generates JSON constrained
|
||||
to your catalog.
|
||||
Describe what you want. AI generates JSON constrained to your
|
||||
catalog. Every interface is unique.
|
||||
</p>
|
||||
</div>
|
||||
<div>
|
||||
@@ -96,10 +100,12 @@ export default function Home() {
|
||||
<p className="text-muted-foreground mb-6">
|
||||
Components, actions, and validation functions.
|
||||
</p>
|
||||
<Code lang="typescript">{`import { createCatalog } from '@json-render/core';
|
||||
<Code lang="typescript">{`import { defineSchema, defineCatalog } from '@json-render/core';
|
||||
import { z } from 'zod';
|
||||
|
||||
export const catalog = createCatalog({
|
||||
const schema = defineSchema({ /* ... */ });
|
||||
|
||||
export const catalog = defineCatalog(schema, {
|
||||
components: {
|
||||
Card: {
|
||||
props: z.object({
|
||||
@@ -111,7 +117,7 @@ export const catalog = createCatalog({
|
||||
Metric: {
|
||||
props: z.object({
|
||||
label: z.string(),
|
||||
valuePath: z.string(),
|
||||
statePath: z.string(),
|
||||
format: z.enum(['currency', 'percent']),
|
||||
}),
|
||||
},
|
||||
@@ -127,23 +133,24 @@ export const catalog = createCatalog({
|
||||
Constrained output that your components render natively.
|
||||
</p>
|
||||
<Code lang="json">{`{
|
||||
"key": "dashboard",
|
||||
"type": "Card",
|
||||
"props": {
|
||||
"title": "Revenue Dashboard",
|
||||
"description": null
|
||||
},
|
||||
"children": [
|
||||
{
|
||||
"key": "revenue",
|
||||
"root": "dashboard",
|
||||
"elements": {
|
||||
"dashboard": {
|
||||
"type": "Card",
|
||||
"props": {
|
||||
"title": "Revenue Dashboard"
|
||||
},
|
||||
"children": ["revenue"]
|
||||
},
|
||||
"revenue": {
|
||||
"type": "Metric",
|
||||
"props": {
|
||||
"label": "Total Revenue",
|
||||
"valuePath": "/metrics/revenue",
|
||||
"statePath": "/metrics/revenue",
|
||||
"format": "currency"
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
}`}</Code>
|
||||
</div>
|
||||
</div>
|
||||
@@ -170,25 +177,22 @@ export const catalog = createCatalog({
|
||||
"root": "card",
|
||||
"elements": {
|
||||
"card": {
|
||||
"key": "card",
|
||||
"type": "Card",
|
||||
"props": { "title": "Revenue" },
|
||||
"children": ["metric", "chart"]
|
||||
},
|
||||
"metric": {
|
||||
"key": "metric",
|
||||
"type": "Metric",
|
||||
"props": {
|
||||
"label": "Total Revenue",
|
||||
"valuePath": "analytics/revenue",
|
||||
"statePath": "analytics/revenue",
|
||||
"format": "currency"
|
||||
}
|
||||
},
|
||||
"chart": {
|
||||
"key": "chart",
|
||||
"type": "Chart",
|
||||
"props": {
|
||||
"dataPath": "analytics/salesByRegion"
|
||||
"statePath": "analytics/salesByRegion"
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -221,10 +225,10 @@ export default function Page() {
|
||||
<Metric
|
||||
data={data}
|
||||
label="Total Revenue"
|
||||
valuePath="analytics/revenue"
|
||||
statePath="analytics/revenue"
|
||||
format="currency"
|
||||
/>
|
||||
<Chart data={data} dataPath="analytics/salesByRegion" />
|
||||
<Chart data={data} statePath="analytics/salesByRegion" />
|
||||
</Card>
|
||||
);
|
||||
}`}</Code>
|
||||
@@ -246,6 +250,10 @@ export default function Page() {
|
||||
<h2 className="text-2xl font-semibold mb-12 text-center">Features</h2>
|
||||
<div className="grid sm:grid-cols-2 lg:grid-cols-3 gap-8">
|
||||
{[
|
||||
{
|
||||
title: "Generative UI",
|
||||
desc: "Generate dynamic, personalized interfaces from prompts with AI",
|
||||
},
|
||||
{
|
||||
title: "Guardrails",
|
||||
desc: "AI can only use components you define in the catalog",
|
||||
@@ -255,20 +263,16 @@ export default function Page() {
|
||||
desc: "Progressive rendering as JSON streams from the model",
|
||||
},
|
||||
{
|
||||
title: "Code Export",
|
||||
desc: "Export as standalone React code with no runtime dependencies",
|
||||
title: "React & React Native",
|
||||
desc: "Render on web and mobile from the same catalog and spec format",
|
||||
},
|
||||
{
|
||||
title: "Data Binding",
|
||||
desc: "Two-way binding with JSON Pointer paths",
|
||||
desc: "Connect props to state with $state, $item, $index, and two-way binding",
|
||||
},
|
||||
{
|
||||
title: "Actions",
|
||||
desc: "Named actions handled by your application",
|
||||
},
|
||||
{
|
||||
title: "Visibility",
|
||||
desc: "Conditional show/hide based on data or auth",
|
||||
title: "Code Export",
|
||||
desc: "Export as standalone React code with no runtime dependencies",
|
||||
},
|
||||
].map((feature) => (
|
||||
<div key={feature.title}>
|
||||
|
||||
@@ -0,0 +1,130 @@
|
||||
import { readFile } from "fs/promises";
|
||||
import { join } from "path";
|
||||
import { convertToModelMessages, stepCountIs, streamText } from "ai";
|
||||
import type { ModelMessage, UIMessage } from "ai";
|
||||
import { createBashTool } from "bash-tool";
|
||||
import { headers } from "next/headers";
|
||||
import { allDocsPages } from "@/lib/docs-navigation";
|
||||
import { mdxToCleanMarkdown } from "@/lib/mdx-to-markdown";
|
||||
import { minuteRateLimit, dailyRateLimit } from "@/lib/rate-limit";
|
||||
|
||||
export const maxDuration = 60;
|
||||
|
||||
const DEFAULT_MODEL = "anthropic/claude-haiku-4.5";
|
||||
|
||||
const SYSTEM_PROMPT = `You are a helpful documentation assistant for json-render, a library for AI-generated UI with guardrails.
|
||||
|
||||
GitHub repository: https://github.com/vercel-labs/json-render
|
||||
Documentation: https://json-render.dev/docs
|
||||
npm packages: @json-render/core, @json-render/react, @json-render/remotion, @json-render/codegen
|
||||
|
||||
You have access to the full json-render documentation via the bash and readFile tools. The docs are available as markdown files in the /workspace/docs/ directory.
|
||||
|
||||
When answering questions:
|
||||
- Use the bash tool to list files (ls /workspace/docs/) or search for content (grep -r "keyword" /workspace/docs/)
|
||||
- Use the readFile tool to read specific documentation pages (e.g. readFile with path "/workspace/docs/index.md")
|
||||
- Do NOT use bash to write, create, modify, or delete files (no tee, cat >, sed -i, echo >, cp, mv, rm, mkdir, touch, etc.) — you are read-only
|
||||
- Always base your answers on the actual documentation content
|
||||
- Be concise and accurate
|
||||
- If the docs don't cover a topic, say so honestly
|
||||
- Do NOT include source references or file paths in your response
|
||||
- Do NOT use emojis in your responses`;
|
||||
|
||||
async function loadDocsFiles(): Promise<Record<string, string>> {
|
||||
const files: Record<string, string> = {};
|
||||
|
||||
const results = await Promise.allSettled(
|
||||
allDocsPages.map(async (page) => {
|
||||
const slug =
|
||||
page.href === "/docs" ? "" : page.href.replace(/^\/docs\/?/, "");
|
||||
const filePath = slug
|
||||
? join(
|
||||
process.cwd(),
|
||||
"app",
|
||||
"(main)",
|
||||
"docs",
|
||||
...slug.split("/"),
|
||||
"page.mdx",
|
||||
)
|
||||
: join(process.cwd(), "app", "(main)", "docs", "page.mdx");
|
||||
|
||||
const raw = await readFile(filePath, "utf-8");
|
||||
const md = mdxToCleanMarkdown(raw);
|
||||
const fileName = slug ? `/docs/${slug}.md` : "/docs/index.md";
|
||||
return { fileName, md };
|
||||
}),
|
||||
);
|
||||
|
||||
for (const result of results) {
|
||||
if (result.status === "fulfilled") {
|
||||
files[result.value.fileName] = result.value.md;
|
||||
}
|
||||
}
|
||||
|
||||
return files;
|
||||
}
|
||||
|
||||
function addCacheControl(messages: ModelMessage[]): ModelMessage[] {
|
||||
if (messages.length === 0) return messages;
|
||||
return messages.map((message, index) => {
|
||||
if (index === messages.length - 1) {
|
||||
return {
|
||||
...message,
|
||||
providerOptions: {
|
||||
...message.providerOptions,
|
||||
anthropic: { cacheControl: { type: "ephemeral" } },
|
||||
},
|
||||
};
|
||||
}
|
||||
return message;
|
||||
});
|
||||
}
|
||||
|
||||
export async function POST(req: Request) {
|
||||
const headersList = await headers();
|
||||
const ip = headersList.get("x-forwarded-for")?.split(",")[0] ?? "anonymous";
|
||||
|
||||
const [minuteResult, dailyResult] = await Promise.all([
|
||||
minuteRateLimit.limit(ip),
|
||||
dailyRateLimit.limit(ip),
|
||||
]);
|
||||
|
||||
if (!minuteResult.success || !dailyResult.success) {
|
||||
const isMinuteLimit = !minuteResult.success;
|
||||
return new Response(
|
||||
JSON.stringify({
|
||||
error: "Rate limit exceeded",
|
||||
message: isMinuteLimit
|
||||
? "Too many requests. Please wait a moment before trying again."
|
||||
: "Daily limit reached. Please try again tomorrow.",
|
||||
}),
|
||||
{
|
||||
status: 429,
|
||||
headers: { "Content-Type": "application/json" },
|
||||
},
|
||||
);
|
||||
}
|
||||
|
||||
const { messages }: { messages: UIMessage[] } = await req.json();
|
||||
|
||||
const docsFiles = await loadDocsFiles();
|
||||
const {
|
||||
tools: { bash, readFile },
|
||||
} = await createBashTool({ files: docsFiles });
|
||||
|
||||
const result = streamText({
|
||||
model: DEFAULT_MODEL,
|
||||
system: SYSTEM_PROMPT,
|
||||
messages: await convertToModelMessages(messages),
|
||||
stopWhen: stepCountIs(5),
|
||||
tools: {
|
||||
bash,
|
||||
readFile,
|
||||
},
|
||||
prepareStep: ({ messages: stepMessages }) => ({
|
||||
messages: addCacheControl(stepMessages),
|
||||
}),
|
||||
});
|
||||
|
||||
return result.toUIMessageStreamResponse();
|
||||
}
|
||||
@@ -0,0 +1,55 @@
|
||||
import { readFile } from "fs/promises";
|
||||
import { join } from "path";
|
||||
import { NextRequest, NextResponse } from "next/server";
|
||||
import { mdxToCleanMarkdown } from "@/lib/mdx-to-markdown";
|
||||
|
||||
export async function GET(req: NextRequest) {
|
||||
const { searchParams } = new URL(req.url);
|
||||
const docPath = searchParams.get("path");
|
||||
|
||||
if (!docPath) {
|
||||
return NextResponse.json(
|
||||
{ error: "Missing ?path= parameter" },
|
||||
{ status: 400 },
|
||||
);
|
||||
}
|
||||
|
||||
// Sanitize path: only allow docs paths, no traversal
|
||||
const normalized = docPath
|
||||
.replace(/^\//, "")
|
||||
.replace(/\.\./g, "")
|
||||
.replace(/[^a-zA-Z0-9/-]/g, "");
|
||||
|
||||
if (!normalized.startsWith("docs")) {
|
||||
return NextResponse.json({ error: "Invalid path" }, { status: 400 });
|
||||
}
|
||||
|
||||
// Map URL path to file path
|
||||
// /docs -> /app/(main)/docs/page.mdx
|
||||
// /docs/installation -> /app/(main)/docs/installation/page.mdx
|
||||
const slug = normalized === "docs" ? "" : normalized.replace(/^docs\/?/, "");
|
||||
const filePath = slug
|
||||
? join(
|
||||
process.cwd(),
|
||||
"app",
|
||||
"(main)",
|
||||
"docs",
|
||||
...slug.split("/"),
|
||||
"page.mdx",
|
||||
)
|
||||
: join(process.cwd(), "app", "(main)", "docs", "page.mdx");
|
||||
|
||||
try {
|
||||
const raw = await readFile(filePath, "utf-8");
|
||||
const markdown = mdxToCleanMarkdown(raw);
|
||||
|
||||
return new NextResponse(markdown, {
|
||||
headers: {
|
||||
"Content-Type": "text/markdown; charset=utf-8",
|
||||
"Cache-Control": "public, max-age=3600",
|
||||
},
|
||||
});
|
||||
} catch {
|
||||
return NextResponse.json({ error: "Page not found" }, { status: 404 });
|
||||
}
|
||||
}
|
||||
@@ -1,15 +1,20 @@
|
||||
import { streamText } from "ai";
|
||||
import { headers } from "next/headers";
|
||||
import { buildUserPrompt } from "@json-render/core";
|
||||
import { minuteRateLimit, dailyRateLimit } from "@/lib/rate-limit";
|
||||
import { playgroundCatalog } from "@/lib/catalog";
|
||||
import { playgroundCatalog } from "@/lib/render/catalog";
|
||||
|
||||
export const maxDuration = 30;
|
||||
|
||||
const SYSTEM_PROMPT = playgroundCatalog.prompt({
|
||||
customRules: [
|
||||
"For forms: Card should be the root element, not wrapped in a centering Stack",
|
||||
"NEVER use viewport height classes (min-h-screen, h-screen) - breaks the container",
|
||||
"NEVER use page background colors (bg-gray-50) - container has its own background",
|
||||
"NEVER use viewport height classes (min-h-screen, h-screen) - the UI renders inside a fixed-size container.",
|
||||
"NEVER use page background colors (bg-gray-50) - the container has its own background.",
|
||||
"For forms or small UIs: use Card as root with maxWidth:'sm' or 'md' and centered:true.",
|
||||
"For content-heavy UIs (blogs, dashboards, product listings): use Stack or Grid as root. Use Grid with 2-3 columns for card layouts.",
|
||||
"Wrap each repeated item in a Card for visual separation and structure.",
|
||||
"Use realistic, professional sample data. Include 3-5 items with varied content. Never leave state arrays empty.",
|
||||
'For form inputs (Input, Textarea, Select), always include checks for validation (e.g. required, email, minLength). Always pair checks with a $bindState expression on the value prop (e.g. { "$bindState": "/path" }).',
|
||||
],
|
||||
});
|
||||
|
||||
@@ -44,30 +49,12 @@ export async function POST(req: Request) {
|
||||
}
|
||||
|
||||
const { prompt, context } = await req.json();
|
||||
const previousSpec = context?.previousSpec;
|
||||
|
||||
const sanitizedPrompt = String(prompt || "").slice(0, MAX_PROMPT_LENGTH);
|
||||
|
||||
// Build the user prompt, including previous tree for iteration
|
||||
let userPrompt = sanitizedPrompt;
|
||||
if (
|
||||
previousSpec &&
|
||||
previousSpec.root &&
|
||||
Object.keys(previousSpec.elements || {}).length > 0
|
||||
) {
|
||||
userPrompt = `CURRENT UI STATE (already loaded, DO NOT recreate existing elements):
|
||||
${JSON.stringify(previousSpec, null, 2)}
|
||||
|
||||
USER REQUEST: ${sanitizedPrompt}
|
||||
|
||||
IMPORTANT: The current UI is already loaded. Output ONLY the patches needed to make the requested change:
|
||||
- To add a new element: {"op":"add","path":"/elements/new-key","value":{...}}
|
||||
- To modify an existing element: {"op":"set","path":"/elements/existing-key","value":{...}}
|
||||
- To update the root: {"op":"set","path":"/root","value":"new-root-key"}
|
||||
- To add children: update the parent element with new children array
|
||||
|
||||
DO NOT output patches for elements that don't need to change. Only output what's necessary for the requested modification.`;
|
||||
}
|
||||
const userPrompt = buildUserPrompt({
|
||||
prompt,
|
||||
currentSpec: context?.previousSpec,
|
||||
maxPromptLength: MAX_PROMPT_LENGTH,
|
||||
});
|
||||
|
||||
const result = streamText({
|
||||
model: process.env.AI_GATEWAY_MODEL || DEFAULT_MODEL,
|
||||
@@ -76,5 +63,33 @@ DO NOT output patches for elements that don't need to change. Only output what's
|
||||
temperature: 0.7,
|
||||
});
|
||||
|
||||
return result.toTextStreamResponse();
|
||||
// Stream the text, then append token usage metadata at the end
|
||||
const encoder = new TextEncoder();
|
||||
const textStream = result.textStream;
|
||||
|
||||
const stream = new ReadableStream({
|
||||
async start(controller) {
|
||||
for await (const chunk of textStream) {
|
||||
controller.enqueue(encoder.encode(chunk));
|
||||
}
|
||||
// Append usage metadata after stream completes
|
||||
try {
|
||||
const usage = await result.usage;
|
||||
const meta = JSON.stringify({
|
||||
__meta: "usage",
|
||||
promptTokens: usage.inputTokens,
|
||||
completionTokens: usage.outputTokens,
|
||||
totalTokens: usage.totalTokens,
|
||||
});
|
||||
controller.enqueue(encoder.encode(`\n${meta}\n`));
|
||||
} catch {
|
||||
// Usage not available — skip silently
|
||||
}
|
||||
controller.close();
|
||||
},
|
||||
});
|
||||
|
||||
return new Response(stream, {
|
||||
headers: { "Content-Type": "text/plain; charset=utf-8" },
|
||||
});
|
||||
}
|
||||
|
||||
+66
-13
@@ -1,6 +1,8 @@
|
||||
@import "tailwindcss";
|
||||
@import "tw-animate-css";
|
||||
|
||||
@source "../node_modules/streamdown/dist/index.js";
|
||||
|
||||
@custom-variant dark (&:is(.dark *));
|
||||
|
||||
:root {
|
||||
@@ -26,6 +28,7 @@
|
||||
--border: oklch(0.85 0 0);
|
||||
--input: oklch(0.85 0 0);
|
||||
--ring: oklch(0.6 0 0);
|
||||
--chat-bg: oklch(0.95 0 0);
|
||||
}
|
||||
|
||||
.dark {
|
||||
@@ -50,6 +53,7 @@
|
||||
--border: oklch(0.25 0 0);
|
||||
--input: oklch(0.25 0 0);
|
||||
--ring: oklch(0.4 0 0);
|
||||
--chat-bg: oklch(0.25 0 0);
|
||||
}
|
||||
|
||||
@theme inline {
|
||||
@@ -107,29 +111,77 @@
|
||||
@apply bg-transparent p-0;
|
||||
}
|
||||
|
||||
/* Custom scrollbar */
|
||||
::-webkit-scrollbar {
|
||||
width: 8px;
|
||||
height: 8px;
|
||||
/* Hide page scrollbar */
|
||||
html {
|
||||
scrollbar-width: none;
|
||||
}
|
||||
|
||||
::-webkit-scrollbar-track {
|
||||
@apply bg-background;
|
||||
html::-webkit-scrollbar {
|
||||
display: none;
|
||||
}
|
||||
|
||||
::-webkit-scrollbar-thumb {
|
||||
@apply bg-border rounded;
|
||||
}
|
||||
|
||||
::-webkit-scrollbar-thumb:hover {
|
||||
@apply bg-muted-foreground;
|
||||
}
|
||||
}
|
||||
|
||||
button {
|
||||
cursor: pointer;
|
||||
}
|
||||
|
||||
/* Tool call shimmer animation */
|
||||
@keyframes tool-shimmer {
|
||||
0% { opacity: 0.5; }
|
||||
50% { opacity: 1; }
|
||||
100% { opacity: 0.5; }
|
||||
}
|
||||
|
||||
.animate-tool-shimmer {
|
||||
animation: tool-shimmer 1.5s ease-in-out infinite;
|
||||
}
|
||||
|
||||
/* Fix list rendering in chat content */
|
||||
.docs-chat-content ul,
|
||||
.docs-chat-content ol {
|
||||
list-style-position: outside;
|
||||
padding-left: 1.25em;
|
||||
}
|
||||
|
||||
.docs-chat-content li > p {
|
||||
display: inline;
|
||||
margin: 0;
|
||||
}
|
||||
|
||||
.docs-chat-content li {
|
||||
margin-top: 0.5em;
|
||||
margin-bottom: 0.5em;
|
||||
}
|
||||
|
||||
/* MDX table styles — applies to both GFM pipe tables and raw HTML tables */
|
||||
.mdx-table th,
|
||||
.mdx-table td,
|
||||
article table th,
|
||||
article table td {
|
||||
border: 1px solid var(--border);
|
||||
padding: 0.75rem 1rem;
|
||||
text-align: left;
|
||||
}
|
||||
|
||||
.mdx-table th,
|
||||
article table th {
|
||||
font-weight: 600;
|
||||
background-color: var(--muted);
|
||||
}
|
||||
|
||||
.mdx-table td,
|
||||
article table td {
|
||||
color: var(--muted-foreground);
|
||||
}
|
||||
|
||||
article table {
|
||||
width: 100%;
|
||||
font-size: 0.875rem;
|
||||
border-collapse: collapse;
|
||||
margin: 1.5rem 0;
|
||||
}
|
||||
|
||||
/* Shiki dual theme support */
|
||||
.shiki,
|
||||
.shiki span {
|
||||
@@ -142,3 +194,4 @@ button {
|
||||
color: var(--shiki-dark) !important;
|
||||
background-color: var(--shiki-dark-bg) !important;
|
||||
}
|
||||
|
||||
|
||||
+35
-11
@@ -1,9 +1,13 @@
|
||||
import type { Metadata } from "next";
|
||||
import localFont from "next/font/local";
|
||||
import { GeistPixelSquare } from "geist/font/pixel";
|
||||
import "./globals.css";
|
||||
import { ThemeProvider } from "@/components/theme-provider";
|
||||
import { DocsChat } from "@/components/docs-chat";
|
||||
import { Analytics } from "@vercel/analytics/next";
|
||||
import { SpeedInsights } from "@vercel/speed-insights/next";
|
||||
import { PAGE_TITLES } from "@/lib/page-titles";
|
||||
import { cookies } from "next/headers";
|
||||
|
||||
const geistSans = localFont({
|
||||
src: "./fonts/GeistVF.woff",
|
||||
@@ -17,15 +21,18 @@ const geistMono = localFont({
|
||||
export const metadata: Metadata = {
|
||||
metadataBase: new URL("https://json-render.dev"),
|
||||
title: {
|
||||
default: "json-render | AI-generated UI with guardrails",
|
||||
default: `json-render | ${PAGE_TITLES[""]}`,
|
||||
template: "%s | json-render",
|
||||
},
|
||||
description:
|
||||
"Let users generate dashboards, widgets, apps, and data visualizations from prompts — safely constrained to components you define.",
|
||||
"The Generative UI framework. Generate dashboards, widgets, and apps from prompts — safely constrained to components you define.",
|
||||
keywords: [
|
||||
"json-render",
|
||||
"generative UI",
|
||||
"AI UI generation",
|
||||
"user-generated interfaces",
|
||||
"React components",
|
||||
"React Native",
|
||||
"guardrails",
|
||||
"structured output",
|
||||
"dashboard builder",
|
||||
@@ -37,25 +44,24 @@ export const metadata: Metadata = {
|
||||
locale: "en_US",
|
||||
url: "https://json-render.dev",
|
||||
siteName: "json-render",
|
||||
title: "json-render | AI-generated UI with guardrails",
|
||||
title: "json-render | The Generative UI Framework",
|
||||
description:
|
||||
"Let users generate dashboards, widgets, apps, and data visualizations from prompts — safely constrained to components you define.",
|
||||
"The Generative UI framework. Generate dashboards, widgets, and apps from prompts — safely constrained to components you define.",
|
||||
images: [
|
||||
{
|
||||
url: "/og",
|
||||
width: 1200,
|
||||
height: 630,
|
||||
alt: "json-render - AI-generated UI with guardrails",
|
||||
alt: "json-render - The Generative UI Framework",
|
||||
},
|
||||
],
|
||||
},
|
||||
twitter: {
|
||||
card: "summary_large_image",
|
||||
title: "json-render | AI-generated UI with guardrails",
|
||||
title: "json-render | The Generative UI Framework",
|
||||
description:
|
||||
"Let users generate dashboards, widgets, apps, and data visualizations from prompts — safely constrained to components you define.",
|
||||
"The Generative UI framework. Generate dashboards, widgets, and apps from prompts — safely constrained to components you define.",
|
||||
images: ["/og"],
|
||||
creator: "@verabornnot",
|
||||
},
|
||||
robots: {
|
||||
index: true,
|
||||
@@ -66,15 +72,33 @@ export const metadata: Metadata = {
|
||||
},
|
||||
};
|
||||
|
||||
export default function RootLayout({
|
||||
export default async function RootLayout({
|
||||
children,
|
||||
}: Readonly<{
|
||||
children: React.ReactNode;
|
||||
}>) {
|
||||
const cookieStore = await cookies();
|
||||
const chatOpen = cookieStore.get("docs-chat-open")?.value === "true";
|
||||
const chatWidth = Number(cookieStore.get("docs-chat-width")?.value) || 400;
|
||||
|
||||
return (
|
||||
<html lang="en" suppressHydrationWarning>
|
||||
<body className={`${geistSans.variable} ${geistMono.variable}`}>
|
||||
<ThemeProvider>{children}</ThemeProvider>
|
||||
<head>
|
||||
{chatOpen && (
|
||||
<style
|
||||
dangerouslySetInnerHTML={{
|
||||
__html: `@media(min-width:640px){body{padding-right:${chatWidth}px}}`,
|
||||
}}
|
||||
/>
|
||||
)}
|
||||
</head>
|
||||
<body
|
||||
className={`${geistSans.variable} ${geistMono.variable} ${GeistPixelSquare.variable}`}
|
||||
>
|
||||
<ThemeProvider>
|
||||
{children}
|
||||
<DocsChat defaultOpen={chatOpen} defaultWidth={chatWidth} />
|
||||
</ThemeProvider>
|
||||
<Analytics />
|
||||
<SpeedInsights />
|
||||
</body>
|
||||
|
||||
@@ -0,0 +1,22 @@
|
||||
import Link from "next/link";
|
||||
import { Header } from "@/components/header";
|
||||
|
||||
export default function NotFound() {
|
||||
return (
|
||||
<div className="flex min-h-screen flex-col">
|
||||
<Header />
|
||||
<main className="flex flex-1 flex-col items-center justify-center gap-4 px-4 text-center">
|
||||
<h1 className="text-6xl font-bold tracking-tight">404</h1>
|
||||
<p className="text-lg text-muted-foreground">
|
||||
This page could not be found.
|
||||
</p>
|
||||
<Link
|
||||
href="/"
|
||||
className="mt-2 inline-flex items-center rounded-md bg-primary px-4 py-2 text-sm font-medium text-primary-foreground hover:bg-primary/90 transition-colors"
|
||||
>
|
||||
Go home
|
||||
</Link>
|
||||
</main>
|
||||
</div>
|
||||
);
|
||||
}
|
||||
@@ -0,0 +1,16 @@
|
||||
import { NextResponse } from "next/server";
|
||||
import { getPageTitle, renderOgImage } from "../og-image";
|
||||
|
||||
export async function GET(
|
||||
_request: Request,
|
||||
{ params }: { params: Promise<{ slug: string[] }> },
|
||||
) {
|
||||
const { slug } = await params;
|
||||
const title = getPageTitle(slug.join("/"));
|
||||
|
||||
if (!title) {
|
||||
return NextResponse.json({ error: "Not found" }, { status: 404 });
|
||||
}
|
||||
|
||||
return renderOgImage(title);
|
||||
}
|
||||
@@ -0,0 +1,112 @@
|
||||
import { ImageResponse } from "next/og";
|
||||
import { readFile } from "node:fs/promises";
|
||||
import { join } from "node:path";
|
||||
|
||||
export { getPageTitle } from "@/lib/page-titles";
|
||||
|
||||
// Cache font data in memory after first load
|
||||
let fontCache: { geistRegular: Buffer; geistPixelSquare: Buffer } | null = null;
|
||||
|
||||
async function loadFonts() {
|
||||
if (fontCache) return fontCache;
|
||||
const [geistRegular, geistPixelSquare] = await Promise.all([
|
||||
readFile(join(process.cwd(), "public/Geist-Regular.ttf")),
|
||||
readFile(join(process.cwd(), "public/GeistPixel-Square.ttf")),
|
||||
]);
|
||||
fontCache = { geistRegular, geistPixelSquare };
|
||||
return fontCache;
|
||||
}
|
||||
|
||||
export async function renderOgImage(title: string) {
|
||||
const { geistRegular, geistPixelSquare } = await loadFonts();
|
||||
|
||||
return new ImageResponse(
|
||||
<div
|
||||
style={{
|
||||
width: "100%",
|
||||
height: "100%",
|
||||
display: "flex",
|
||||
flexDirection: "column",
|
||||
backgroundColor: "black",
|
||||
padding: "60px 80px",
|
||||
}}
|
||||
>
|
||||
<div
|
||||
style={{
|
||||
display: "flex",
|
||||
alignItems: "center",
|
||||
gap: "16px",
|
||||
}}
|
||||
>
|
||||
<svg width="36" height="36" viewBox="0 0 16 16" fill="white">
|
||||
<path fillRule="evenodd" clipRule="evenodd" d="M8 1L16 15H0L8 1Z" />
|
||||
</svg>
|
||||
<span
|
||||
style={{
|
||||
fontSize: 36,
|
||||
color: "#666",
|
||||
fontFamily: "Geist",
|
||||
fontWeight: 400,
|
||||
}}
|
||||
>
|
||||
/
|
||||
</span>
|
||||
<span
|
||||
style={{
|
||||
fontSize: 36,
|
||||
fontFamily: "Geist Pixel Square",
|
||||
fontWeight: 500,
|
||||
color: "white",
|
||||
}}
|
||||
>
|
||||
json-render
|
||||
</span>
|
||||
</div>
|
||||
|
||||
<div
|
||||
style={{
|
||||
display: "flex",
|
||||
flex: 1,
|
||||
flexDirection: "column",
|
||||
alignItems: "center",
|
||||
justifyContent: "center",
|
||||
}}
|
||||
>
|
||||
{title.split("\n").map((line, i) => (
|
||||
<span
|
||||
key={i}
|
||||
style={{
|
||||
fontSize: 72,
|
||||
fontFamily: "Geist",
|
||||
fontWeight: 400,
|
||||
color: "white",
|
||||
letterSpacing: "-0.02em",
|
||||
textAlign: "center",
|
||||
lineHeight: 1.2,
|
||||
}}
|
||||
>
|
||||
{line}
|
||||
</span>
|
||||
))}
|
||||
</div>
|
||||
</div>,
|
||||
{
|
||||
width: 1200,
|
||||
height: 630,
|
||||
fonts: [
|
||||
{
|
||||
name: "Geist",
|
||||
data: geistRegular.buffer as ArrayBuffer,
|
||||
style: "normal",
|
||||
weight: 400,
|
||||
},
|
||||
{
|
||||
name: "Geist Pixel Square",
|
||||
data: geistPixelSquare.buffer as ArrayBuffer,
|
||||
style: "normal",
|
||||
weight: 500,
|
||||
},
|
||||
],
|
||||
},
|
||||
);
|
||||
}
|
||||
@@ -1,44 +1,6 @@
|
||||
import { ImageResponse } from "next/og";
|
||||
import { getPageTitle, renderOgImage } from "./og-image";
|
||||
|
||||
export async function GET(request: Request) {
|
||||
const geist = await fetch(new URL("/Geist-Regular.ttf", request.url)).then(
|
||||
(res) => res.arrayBuffer(),
|
||||
);
|
||||
|
||||
return new ImageResponse(
|
||||
<div
|
||||
style={{
|
||||
width: "100%",
|
||||
height: "100%",
|
||||
display: "flex",
|
||||
alignItems: "center",
|
||||
justifyContent: "center",
|
||||
backgroundColor: "black",
|
||||
}}
|
||||
>
|
||||
<span
|
||||
style={{
|
||||
fontSize: 144,
|
||||
fontFamily: "Geist",
|
||||
fontWeight: 400,
|
||||
color: "white",
|
||||
letterSpacing: "-0.02em",
|
||||
}}
|
||||
>
|
||||
json-render
|
||||
</span>
|
||||
</div>,
|
||||
{
|
||||
width: 1200,
|
||||
height: 630,
|
||||
fonts: [
|
||||
{
|
||||
name: "Geist",
|
||||
data: geist,
|
||||
style: "normal",
|
||||
weight: 400,
|
||||
},
|
||||
],
|
||||
},
|
||||
);
|
||||
export async function GET() {
|
||||
const title = getPageTitle("")!;
|
||||
return renderOgImage(title);
|
||||
}
|
||||
|
||||
@@ -1,8 +1,7 @@
|
||||
import { Playground } from "@/components/playground";
|
||||
import { pageMetadata } from "@/lib/page-metadata";
|
||||
|
||||
export const metadata = {
|
||||
title: "Playground | json-render",
|
||||
};
|
||||
export const metadata = pageMetadata("playground");
|
||||
|
||||
export default function PlaygroundPage() {
|
||||
return <Playground />;
|
||||
|
||||
@@ -0,0 +1,71 @@
|
||||
"use client";
|
||||
|
||||
import { useState } from "react";
|
||||
import { usePathname } from "next/navigation";
|
||||
|
||||
export function CopyPageButton() {
|
||||
const pathname = usePathname();
|
||||
const [state, setState] = useState<"idle" | "loading" | "copied">("idle");
|
||||
|
||||
const handleCopy = async () => {
|
||||
setState("loading");
|
||||
try {
|
||||
const response = await fetch(
|
||||
`/api/docs-markdown?path=${encodeURIComponent(pathname)}`,
|
||||
);
|
||||
if (!response.ok) {
|
||||
throw new Error("Failed to fetch markdown");
|
||||
}
|
||||
const markdown = await response.text();
|
||||
await navigator.clipboard.writeText(markdown);
|
||||
setState("copied");
|
||||
setTimeout(() => setState("idle"), 2000);
|
||||
} catch {
|
||||
setState("idle");
|
||||
}
|
||||
};
|
||||
|
||||
return (
|
||||
<button
|
||||
onClick={handleCopy}
|
||||
disabled={state === "loading"}
|
||||
className="flex items-center gap-1.5 px-2.5 py-1.5 text-xs text-muted-foreground hover:text-foreground border border-border rounded-md hover:bg-muted transition-colors disabled:opacity-50"
|
||||
aria-label="Copy page as Markdown"
|
||||
>
|
||||
{state === "copied" ? (
|
||||
<>
|
||||
<svg
|
||||
width="14"
|
||||
height="14"
|
||||
viewBox="0 0 24 24"
|
||||
fill="none"
|
||||
stroke="currentColor"
|
||||
strokeWidth="2"
|
||||
strokeLinecap="round"
|
||||
strokeLinejoin="round"
|
||||
>
|
||||
<polyline points="20 6 9 17 4 12" />
|
||||
</svg>
|
||||
Copied
|
||||
</>
|
||||
) : (
|
||||
<>
|
||||
<svg
|
||||
width="14"
|
||||
height="14"
|
||||
viewBox="0 0 24 24"
|
||||
fill="none"
|
||||
stroke="currentColor"
|
||||
strokeWidth="2"
|
||||
strokeLinecap="round"
|
||||
strokeLinejoin="round"
|
||||
>
|
||||
<rect x="9" y="9" width="13" height="13" rx="2" ry="2" />
|
||||
<path d="M5 15H4a2 2 0 0 1-2-2V4a2 2 0 0 1 2-2h9a2 2 0 0 1 2 2v1" />
|
||||
</svg>
|
||||
Copy Page
|
||||
</>
|
||||
)}
|
||||
</button>
|
||||
);
|
||||
}
|
||||
+283
-89
@@ -14,7 +14,9 @@ import { toast } from "sonner";
|
||||
import { CodeBlock } from "./code-block";
|
||||
import { CopyButton } from "./copy-button";
|
||||
import { Toaster } from "./ui/sonner";
|
||||
import { PlaygroundRenderer } from "@/lib/renderer";
|
||||
import { PlaygroundRenderer } from "@/lib/render/renderer";
|
||||
import { playgroundCatalog } from "@/lib/render/catalog";
|
||||
import { buildCatalogDisplayData } from "@/lib/render/catalog-display";
|
||||
|
||||
const SIMULATION_PROMPT = "Create a contact form with name, email, and message";
|
||||
|
||||
@@ -23,136 +25,139 @@ interface SimulationStage {
|
||||
stream: string;
|
||||
}
|
||||
|
||||
// Shared state & element definitions for the progressive simulation stages.
|
||||
const FORM_STATE = { form: { name: "", email: "", message: "" } };
|
||||
|
||||
const NAME_INPUT = {
|
||||
type: "Input",
|
||||
props: {
|
||||
label: "Name",
|
||||
name: "name",
|
||||
statePath: "/form/name",
|
||||
checks: [{ type: "required", message: "Name is required" }],
|
||||
},
|
||||
} as const;
|
||||
|
||||
const EMAIL_INPUT = {
|
||||
type: "Input",
|
||||
props: {
|
||||
label: "Email",
|
||||
name: "email",
|
||||
type: "email",
|
||||
statePath: "/form/email",
|
||||
checks: [
|
||||
{ type: "required", message: "Email is required" },
|
||||
{ type: "email", message: "Please enter a valid email" },
|
||||
],
|
||||
},
|
||||
} as const;
|
||||
|
||||
const MESSAGE_INPUT = {
|
||||
type: "Textarea",
|
||||
props: {
|
||||
label: "Message",
|
||||
name: "message",
|
||||
statePath: "/form/message",
|
||||
checks: [{ type: "required", message: "Message is required" }],
|
||||
},
|
||||
} as const;
|
||||
|
||||
const SUBMIT_BUTTON = {
|
||||
type: "Button",
|
||||
props: { label: "Send Message", variant: "primary" },
|
||||
on: { press: { action: "formSubmit" } },
|
||||
} as const;
|
||||
|
||||
const SIMULATION_STAGES: SimulationStage[] = [
|
||||
{
|
||||
tree: {
|
||||
root: "card",
|
||||
state: FORM_STATE,
|
||||
elements: {
|
||||
card: {
|
||||
key: "card",
|
||||
type: "Card",
|
||||
props: { title: "Contact Us", maxWidth: "md" },
|
||||
children: [],
|
||||
},
|
||||
},
|
||||
},
|
||||
stream: '{"op":"set","path":"/root","value":"card"}',
|
||||
stream: '{"op":"add","path":"/root","value":"card"}',
|
||||
},
|
||||
{
|
||||
tree: {
|
||||
root: "card",
|
||||
state: FORM_STATE,
|
||||
elements: {
|
||||
card: {
|
||||
key: "card",
|
||||
type: "Card",
|
||||
props: { title: "Contact Us", maxWidth: "md" },
|
||||
children: ["name"],
|
||||
},
|
||||
name: {
|
||||
key: "name",
|
||||
type: "Input",
|
||||
props: { label: "Name", name: "name" },
|
||||
},
|
||||
name: NAME_INPUT,
|
||||
},
|
||||
},
|
||||
stream:
|
||||
'{"op":"add","path":"/elements/card","value":{"key":"card","type":"Card","props":{"title":"Contact Us","maxWidth":"md"},"children":["name"]}}',
|
||||
'{"op":"add","path":"/elements/name","value":{"type":"Input","props":{"label":"Name","name":"name","statePath":"/form/name","checks":[{"type":"required","message":"Name is required"}]}}}',
|
||||
},
|
||||
{
|
||||
tree: {
|
||||
root: "card",
|
||||
state: FORM_STATE,
|
||||
elements: {
|
||||
card: {
|
||||
key: "card",
|
||||
type: "Card",
|
||||
props: { title: "Contact Us", maxWidth: "md" },
|
||||
children: ["name", "email"],
|
||||
},
|
||||
name: {
|
||||
key: "name",
|
||||
type: "Input",
|
||||
props: { label: "Name", name: "name" },
|
||||
},
|
||||
email: {
|
||||
key: "email",
|
||||
type: "Input",
|
||||
props: { label: "Email", name: "email" },
|
||||
},
|
||||
name: NAME_INPUT,
|
||||
email: EMAIL_INPUT,
|
||||
},
|
||||
},
|
||||
stream:
|
||||
'{"op":"add","path":"/elements/email","value":{"key":"email","type":"Input","props":{"label":"Email","name":"email"}}}',
|
||||
'{"op":"add","path":"/elements/email","value":{"type":"Input","props":{"label":"Email","name":"email","type":"email","statePath":"/form/email","checks":[{"type":"required","message":"Email is required"},{"type":"email","message":"Please enter a valid email"}]}}}',
|
||||
},
|
||||
{
|
||||
tree: {
|
||||
root: "card",
|
||||
state: FORM_STATE,
|
||||
elements: {
|
||||
card: {
|
||||
key: "card",
|
||||
type: "Card",
|
||||
props: { title: "Contact Us", maxWidth: "md" },
|
||||
children: ["name", "email", "message"],
|
||||
},
|
||||
name: {
|
||||
key: "name",
|
||||
type: "Input",
|
||||
props: { label: "Name", name: "name" },
|
||||
},
|
||||
email: {
|
||||
key: "email",
|
||||
type: "Input",
|
||||
props: { label: "Email", name: "email" },
|
||||
},
|
||||
message: {
|
||||
key: "message",
|
||||
type: "Textarea",
|
||||
props: { label: "Message", name: "message" },
|
||||
},
|
||||
name: NAME_INPUT,
|
||||
email: EMAIL_INPUT,
|
||||
message: MESSAGE_INPUT,
|
||||
},
|
||||
},
|
||||
stream:
|
||||
'{"op":"add","path":"/elements/message","value":{"key":"message","type":"Textarea","props":{"label":"Message","name":"message"}}}',
|
||||
'{"op":"add","path":"/elements/message","value":{"type":"Textarea","props":{"label":"Message","name":"message","statePath":"/form/message","checks":[{"type":"required","message":"Message is required"}]}}}',
|
||||
},
|
||||
{
|
||||
tree: {
|
||||
root: "card",
|
||||
state: FORM_STATE,
|
||||
elements: {
|
||||
card: {
|
||||
key: "card",
|
||||
type: "Card",
|
||||
props: { title: "Contact Us", maxWidth: "md" },
|
||||
children: ["name", "email", "message", "submit"],
|
||||
},
|
||||
name: {
|
||||
key: "name",
|
||||
type: "Input",
|
||||
props: { label: "Name", name: "name" },
|
||||
},
|
||||
email: {
|
||||
key: "email",
|
||||
type: "Input",
|
||||
props: { label: "Email", name: "email" },
|
||||
},
|
||||
message: {
|
||||
key: "message",
|
||||
type: "Textarea",
|
||||
props: { label: "Message", name: "message" },
|
||||
},
|
||||
submit: {
|
||||
key: "submit",
|
||||
type: "Button",
|
||||
props: { label: "Send Message", variant: "primary" },
|
||||
},
|
||||
name: NAME_INPUT,
|
||||
email: EMAIL_INPUT,
|
||||
message: MESSAGE_INPUT,
|
||||
submit: SUBMIT_BUTTON,
|
||||
},
|
||||
},
|
||||
stream:
|
||||
'{"op":"add","path":"/elements/submit","value":{"key":"submit","type":"Button","props":{"label":"Send Message","variant":"primary"}}}',
|
||||
'{"op":"add","path":"/elements/submit","value":{"type":"Button","props":{"label":"Send Message","variant":"primary"},"on":{"press":{"action":"formSubmit"}}}}',
|
||||
},
|
||||
];
|
||||
|
||||
type Mode = "simulation" | "interactive";
|
||||
type Phase = "typing" | "streaming" | "complete";
|
||||
type Tab = "stream" | "json";
|
||||
type Tab = "stream" | "json" | "nested" | "catalog";
|
||||
type RenderView = "dynamic" | "static";
|
||||
|
||||
interface DemoProps {
|
||||
@@ -160,6 +165,51 @@ interface DemoProps {
|
||||
skipSimulation?: boolean;
|
||||
}
|
||||
|
||||
/**
|
||||
* Convert a flat Spec into a nested tree structure that is easier for humans
|
||||
* to read. Children keys are resolved recursively into inline objects.
|
||||
*/
|
||||
function specToNested(spec: Spec): Record<string, unknown> {
|
||||
function resolve(key: string): Record<string, unknown> {
|
||||
const el = spec.elements[key];
|
||||
if (!el) return { _key: key, _missing: true };
|
||||
|
||||
const node: Record<string, unknown> = { type: el.type };
|
||||
|
||||
if (el.props && Object.keys(el.props).length > 0) {
|
||||
node.props = el.props;
|
||||
}
|
||||
|
||||
if (el.visible !== undefined) {
|
||||
node.visible = el.visible;
|
||||
}
|
||||
|
||||
if (el.on && Object.keys(el.on).length > 0) {
|
||||
node.on = el.on;
|
||||
}
|
||||
|
||||
if (el.repeat) {
|
||||
node.repeat = el.repeat;
|
||||
}
|
||||
|
||||
if (el.children && el.children.length > 0) {
|
||||
node.children = el.children.map(resolve);
|
||||
}
|
||||
|
||||
return node;
|
||||
}
|
||||
|
||||
const result: Record<string, unknown> = {};
|
||||
|
||||
if (spec.state && Object.keys(spec.state).length > 0) {
|
||||
result.state = spec.state;
|
||||
}
|
||||
|
||||
result.elements = resolve(spec.root);
|
||||
|
||||
return result;
|
||||
}
|
||||
|
||||
const EXAMPLE_PROMPTS = [
|
||||
"Create a login form with email and password",
|
||||
"Build a feedback form with rating stars",
|
||||
@@ -194,6 +244,15 @@ export function Demo({
|
||||
new Set(),
|
||||
);
|
||||
const inputRef = useRef<HTMLInputElement>(null);
|
||||
const [catalogSection, setCatalogSection] = useState<
|
||||
"components" | "actions"
|
||||
>("components");
|
||||
|
||||
// Catalog data for the catalog tab
|
||||
const catalogData = useMemo(
|
||||
() => buildCatalogDisplayData(playgroundCatalog.data),
|
||||
[],
|
||||
);
|
||||
|
||||
// Disable body scroll when any modal is open
|
||||
useEffect(() => {
|
||||
@@ -213,6 +272,7 @@ export function Demo({
|
||||
isStreaming,
|
||||
send,
|
||||
clear,
|
||||
rawLines: apiRawLines,
|
||||
} = useUIStream({
|
||||
api: "/api/generate",
|
||||
onError: (err: Error) => {
|
||||
@@ -285,25 +345,12 @@ export function Demo({
|
||||
return () => clearInterval(interval);
|
||||
}, [mode, phase]);
|
||||
|
||||
// Track stream lines from real API
|
||||
// Track stream lines from real API (use raw JSONL patch lines)
|
||||
useEffect(() => {
|
||||
if (mode === "interactive" && apiSpec) {
|
||||
// Convert tree to stream line for display
|
||||
const streamLine = JSON.stringify({ tree: apiSpec });
|
||||
if (
|
||||
!streamLines.includes(streamLine) &&
|
||||
Object.keys(apiSpec.elements).length > 0
|
||||
) {
|
||||
setStreamLines((prev) => {
|
||||
const lastLine = prev[prev.length - 1];
|
||||
if (lastLine !== streamLine) {
|
||||
return [...prev, streamLine];
|
||||
}
|
||||
return prev;
|
||||
});
|
||||
}
|
||||
if (mode === "interactive" && apiRawLines.length > 0) {
|
||||
setStreamLines(apiRawLines);
|
||||
}
|
||||
}, [mode, apiSpec, streamLines]);
|
||||
}, [mode, apiRawLines]);
|
||||
|
||||
const handleSubmit = useCallback(async () => {
|
||||
if (!userPrompt.trim() || isStreaming) return;
|
||||
@@ -315,6 +362,11 @@ export function Demo({
|
||||
? JSON.stringify(currentTree, null, 2)
|
||||
: "// waiting...";
|
||||
|
||||
const nestedCode = useMemo(() => {
|
||||
if (!currentTree || !currentTree.root) return "// waiting...";
|
||||
return JSON.stringify(specToNested(currentTree), null, 2);
|
||||
}, [currentTree]);
|
||||
|
||||
// Generate all export files for Next.js project
|
||||
const exportedFiles = useMemo(() => {
|
||||
if (!currentTree || !currentTree.root) {
|
||||
@@ -915,7 +967,13 @@ Open [http://localhost:3000](http://localhost:3000) to view.
|
||||
setMode("interactive");
|
||||
setPhase("complete");
|
||||
setUserPrompt(prompt);
|
||||
setTimeout(() => inputRef.current?.focus(), 0);
|
||||
setTimeout(() => {
|
||||
const el = inputRef.current;
|
||||
if (el) {
|
||||
el.focus();
|
||||
el.setSelectionRange(prompt.length, prompt.length);
|
||||
}
|
||||
}, 0);
|
||||
}, []);
|
||||
|
||||
return (
|
||||
@@ -1044,7 +1102,7 @@ Open [http://localhost:3000](http://localhost:3000) to view.
|
||||
{/* Tabbed code/stream/json panel */}
|
||||
<div className={`min-w-0 ${fullscreen ? "flex flex-col" : ""}`}>
|
||||
<div className="flex items-center gap-4 mb-2 h-6 shrink-0">
|
||||
{(["json", "stream"] as const).map((tab) => (
|
||||
{(["json", "nested", "stream", "catalog"] as const).map((tab) => (
|
||||
<button
|
||||
key={tab}
|
||||
onClick={() => setActiveTab(tab)}
|
||||
@@ -1061,14 +1119,20 @@ Open [http://localhost:3000](http://localhost:3000) to view.
|
||||
<div
|
||||
className={`border border-border rounded bg-background font-mono text-xs text-left grid relative group ${fullscreen ? "flex-1 min-h-0" : "h-[28rem]"}`}
|
||||
>
|
||||
<div className="absolute top-2 right-2 z-10">
|
||||
<CopyButton
|
||||
text={
|
||||
activeTab === "stream" ? streamLines.join("\n") : jsonCode
|
||||
}
|
||||
className="opacity-0 group-hover:opacity-100 text-muted-foreground"
|
||||
/>
|
||||
</div>
|
||||
{activeTab !== "catalog" && (
|
||||
<div className="absolute top-2 right-2 z-10">
|
||||
<CopyButton
|
||||
text={
|
||||
activeTab === "stream"
|
||||
? streamLines.join("\n")
|
||||
: activeTab === "nested"
|
||||
? nestedCode
|
||||
: jsonCode
|
||||
}
|
||||
className="opacity-0 group-hover:opacity-100 text-muted-foreground"
|
||||
/>
|
||||
</div>
|
||||
)}
|
||||
<div
|
||||
className={`overflow-auto ${activeTab === "stream" ? "" : "hidden"}`}
|
||||
>
|
||||
@@ -1104,6 +1168,136 @@ Open [http://localhost:3000](http://localhost:3000) to view.
|
||||
hideCopyButton
|
||||
/>
|
||||
</div>
|
||||
<div
|
||||
className={`overflow-auto ${activeTab === "nested" ? "" : "hidden"}`}
|
||||
>
|
||||
<CodeBlock
|
||||
code={nestedCode}
|
||||
lang="json"
|
||||
fillHeight
|
||||
hideCopyButton
|
||||
/>
|
||||
</div>
|
||||
<div
|
||||
className={`overflow-auto ${activeTab === "catalog" ? "" : "hidden"}`}
|
||||
>
|
||||
<div className="h-full flex flex-col text-sm font-sans">
|
||||
<div className="flex items-center gap-3 px-3 h-9 border-b border-border">
|
||||
{(
|
||||
[
|
||||
{
|
||||
key: "components",
|
||||
label: `components (${catalogData.components.length})`,
|
||||
},
|
||||
{
|
||||
key: "actions",
|
||||
label: `actions (${catalogData.actions.length})`,
|
||||
},
|
||||
] as const
|
||||
).map(({ key, label }) => (
|
||||
<button
|
||||
key={key}
|
||||
onClick={() => setCatalogSection(key)}
|
||||
className={`text-xs font-mono transition-colors ${
|
||||
catalogSection === key
|
||||
? "text-foreground"
|
||||
: "text-muted-foreground hover:text-foreground"
|
||||
}`}
|
||||
>
|
||||
{label}
|
||||
</button>
|
||||
))}
|
||||
</div>
|
||||
<div className="flex-1 overflow-auto p-3">
|
||||
{catalogSection === "components" ? (
|
||||
<div className="space-y-3">
|
||||
{catalogData.components.map((comp) => (
|
||||
<div
|
||||
key={comp.name}
|
||||
className="pb-3 border-b border-border last:border-b-0"
|
||||
>
|
||||
<div className="flex items-baseline gap-2 mb-1">
|
||||
<span className="font-mono font-medium text-foreground">
|
||||
{comp.name}
|
||||
</span>
|
||||
{comp.slots.length > 0 && (
|
||||
<span className="text-[10px] font-mono px-1.5 py-0.5 rounded bg-muted text-muted-foreground">
|
||||
slots: {comp.slots.join(", ")}
|
||||
</span>
|
||||
)}
|
||||
</div>
|
||||
{comp.description && (
|
||||
<p className="text-xs text-muted-foreground mb-2">
|
||||
{comp.description}
|
||||
</p>
|
||||
)}
|
||||
{comp.props.length > 0 && (
|
||||
<div className="flex flex-wrap gap-1 mb-1">
|
||||
{comp.props.map((p) => (
|
||||
<span
|
||||
key={p.name}
|
||||
className="text-[11px] font-mono px-1.5 py-0.5 rounded bg-green-500/10 text-green-700 dark:text-green-400"
|
||||
>
|
||||
{p.name}
|
||||
<span className="text-green-700/50 dark:text-green-400/50">
|
||||
: {p.type}
|
||||
</span>
|
||||
</span>
|
||||
))}
|
||||
</div>
|
||||
)}
|
||||
{comp.events.length > 0 && (
|
||||
<div className="flex flex-wrap gap-1 mt-1.5">
|
||||
{comp.events.map((e) => (
|
||||
<span
|
||||
key={e}
|
||||
className="text-[11px] font-mono px-1.5 py-0.5 rounded bg-blue-500/10 text-blue-600 dark:text-blue-400"
|
||||
>
|
||||
on.{e}
|
||||
</span>
|
||||
))}
|
||||
</div>
|
||||
)}
|
||||
</div>
|
||||
))}
|
||||
</div>
|
||||
) : (
|
||||
<div className="space-y-3">
|
||||
{catalogData.actions.map((action) => (
|
||||
<div
|
||||
key={action.name}
|
||||
className="pb-3 border-b border-border last:border-b-0"
|
||||
>
|
||||
<span className="font-mono font-medium text-foreground">
|
||||
{action.name}
|
||||
</span>
|
||||
{action.description && (
|
||||
<p className="text-xs text-muted-foreground mt-1 mb-2">
|
||||
{action.description}
|
||||
</p>
|
||||
)}
|
||||
{action.params.length > 0 && (
|
||||
<div className="flex flex-wrap gap-1">
|
||||
{action.params.map((p) => (
|
||||
<span
|
||||
key={p.name}
|
||||
className="text-[11px] font-mono px-1.5 py-0.5 rounded bg-green-500/10 text-green-700 dark:text-green-400"
|
||||
>
|
||||
{p.name}
|
||||
<span className="text-green-700/50 dark:text-green-400/50">
|
||||
: {p.type}
|
||||
</span>
|
||||
</span>
|
||||
))}
|
||||
</div>
|
||||
)}
|
||||
</div>
|
||||
))}
|
||||
</div>
|
||||
)}
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
@@ -0,0 +1,540 @@
|
||||
"use client";
|
||||
|
||||
import {
|
||||
useRef,
|
||||
useEffect,
|
||||
useState,
|
||||
useCallback,
|
||||
type PointerEvent as ReactPointerEvent,
|
||||
} from "react";
|
||||
import { useChat } from "@ai-sdk/react";
|
||||
import { DefaultChatTransport } from "ai";
|
||||
import { Streamdown } from "streamdown";
|
||||
import Link from "next/link";
|
||||
import { Sheet, SheetContent, SheetTitle } from "@/components/ui/sheet";
|
||||
|
||||
const STORAGE_KEY = "docs-chat-messages";
|
||||
const transport = new DefaultChatTransport({ api: "/api/docs-chat" });
|
||||
|
||||
const DESKTOP_DEFAULT_WIDTH = 400;
|
||||
const DESKTOP_MIN_WIDTH = 300;
|
||||
const DESKTOP_MAX_WIDTH = 700;
|
||||
|
||||
function setCookie(name: string, value: string) {
|
||||
document.cookie = `${name}=${encodeURIComponent(value)};path=/;max-age=${60 * 60 * 24 * 365};samesite=lax`;
|
||||
}
|
||||
|
||||
const TOOL_LABELS: Record<
|
||||
string,
|
||||
{ label: string; pastLabel: string; argKey?: string }
|
||||
> = {
|
||||
readFile: { label: "Reading", pastLabel: "Read", argKey: "path" },
|
||||
bash: { label: "Running", pastLabel: "Ran", argKey: "command" },
|
||||
};
|
||||
|
||||
function isToolPart(part: { type: string }): part is {
|
||||
type: string;
|
||||
toolCallId: string;
|
||||
toolName?: string;
|
||||
state: string;
|
||||
input?: Record<string, unknown>;
|
||||
output?: unknown;
|
||||
errorText?: string;
|
||||
} {
|
||||
return part.type.startsWith("tool-") || part.type === "dynamic-tool";
|
||||
}
|
||||
|
||||
function getToolName(part: { type: string; toolName?: string }): string {
|
||||
if (part.type === "dynamic-tool") return part.toolName ?? "tool";
|
||||
return part.type.replace(/^tool-/, "");
|
||||
}
|
||||
|
||||
function ToolCallDisplay({
|
||||
part,
|
||||
}: {
|
||||
part: {
|
||||
type: string;
|
||||
toolCallId: string;
|
||||
toolName?: string;
|
||||
state: string;
|
||||
input?: Record<string, unknown>;
|
||||
output?: unknown;
|
||||
errorText?: string;
|
||||
};
|
||||
}) {
|
||||
const toolName = getToolName(part);
|
||||
const config = TOOL_LABELS[toolName] ?? {
|
||||
label: toolName,
|
||||
pastLabel: toolName,
|
||||
};
|
||||
const isDone = part.state === "output-available";
|
||||
const isError = part.state === "output-error";
|
||||
const isRunning = !isDone && !isError;
|
||||
const displayLabel = isRunning ? config.label : config.pastLabel;
|
||||
|
||||
const args = (part.input ?? {}) as Record<string, unknown>;
|
||||
const argValue = config.argKey ? args[config.argKey] : undefined;
|
||||
const argPreview =
|
||||
argValue != null
|
||||
? String(argValue)
|
||||
.replace(/\/workspace\//g, "/")
|
||||
.replace(/\.md$/, "")
|
||||
.replace(/\/index$/, "")
|
||||
: "";
|
||||
|
||||
// Link to the docs page if it's a /docs/ path from readFile
|
||||
const docsLink =
|
||||
toolName === "readFile" &&
|
||||
(argPreview === "/docs" || argPreview.startsWith("/docs/"))
|
||||
? argPreview
|
||||
: null;
|
||||
|
||||
const argEl = argPreview ? (
|
||||
docsLink ? (
|
||||
<Link href={docsLink} className="truncate underline underline-offset-2">
|
||||
{argPreview}
|
||||
</Link>
|
||||
) : (
|
||||
<span className="truncate">{argPreview}</span>
|
||||
)
|
||||
) : null;
|
||||
|
||||
return (
|
||||
<div className="text-xs py-0.5 min-w-0">
|
||||
{isRunning ? (
|
||||
<span className="inline-flex items-center gap-1 font-mono text-muted-foreground animate-tool-shimmer min-w-0 max-w-full">
|
||||
<span className="shrink-0">{displayLabel}</span>
|
||||
{argEl}
|
||||
</span>
|
||||
) : (
|
||||
<span className="inline-flex items-center gap-1 font-mono text-muted-foreground/60 min-w-0 max-w-full">
|
||||
<span className="shrink-0">{displayLabel}</span>
|
||||
{argEl}
|
||||
{isError && <span className="text-destructive">failed</span>}
|
||||
</span>
|
||||
)}
|
||||
</div>
|
||||
);
|
||||
}
|
||||
|
||||
const SUGGESTIONS = [
|
||||
"What is json-render?",
|
||||
"How do I install it?",
|
||||
"How does streaming work?",
|
||||
"What components are available?",
|
||||
"How do I create a custom schema?",
|
||||
];
|
||||
|
||||
export function DocsChat({
|
||||
defaultOpen = false,
|
||||
defaultWidth = DESKTOP_DEFAULT_WIDTH,
|
||||
}: {
|
||||
defaultOpen?: boolean;
|
||||
defaultWidth?: number;
|
||||
}) {
|
||||
const [open, setOpen] = useState(defaultOpen);
|
||||
const [input, setInput] = useState("");
|
||||
const [isDesktop, setIsDesktop] = useState(false);
|
||||
const [hasMounted, setHasMounted] = useState(false);
|
||||
const [desktopWidth, setDesktopWidth] = useState(
|
||||
Math.min(DESKTOP_MAX_WIDTH, Math.max(DESKTOP_MIN_WIDTH, defaultWidth)),
|
||||
);
|
||||
const messagesScrollRef = useRef<HTMLDivElement>(null);
|
||||
const inputRef = useRef<HTMLTextAreaElement>(null);
|
||||
const restoredRef = useRef(false);
|
||||
const isDraggingRef = useRef(false);
|
||||
|
||||
const { messages, sendMessage, status, setMessages, error } = useChat({
|
||||
transport,
|
||||
});
|
||||
|
||||
const isLoading = status === "streaming" || status === "submitted";
|
||||
const showMessages = messages.length > 0 || !!error || isLoading;
|
||||
|
||||
// Detect desktop vs mobile. Close sidebar on mobile if it was open from cookie.
|
||||
useEffect(() => {
|
||||
const mq = window.matchMedia("(min-width: 640px)");
|
||||
setIsDesktop(mq.matches);
|
||||
setHasMounted(true);
|
||||
// If on mobile but sidebar was open from cookie, close it
|
||||
if (!mq.matches && defaultOpen) {
|
||||
setOpen(false);
|
||||
}
|
||||
const handler = (e: MediaQueryListEvent) => setIsDesktop(e.matches);
|
||||
mq.addEventListener("change", handler);
|
||||
return () => mq.removeEventListener("change", handler);
|
||||
// eslint-disable-next-line react-hooks/exhaustive-deps
|
||||
}, []);
|
||||
|
||||
// Persist open state to cookie (only after mount to avoid overwriting on mobile)
|
||||
useEffect(() => {
|
||||
if (hasMounted) {
|
||||
setCookie("docs-chat-open", String(open));
|
||||
}
|
||||
}, [open, hasMounted]);
|
||||
|
||||
// Push page content on desktop when pane is open.
|
||||
// Use padding on body so the page scrollbar stays at the viewport edge (behind the sidebar)
|
||||
// instead of appearing right next to the sidebar's scrollbar.
|
||||
useEffect(() => {
|
||||
const body = document.body;
|
||||
if (isDesktop && open) {
|
||||
body.style.paddingRight = `${desktopWidth}px`;
|
||||
if (!isDraggingRef.current) {
|
||||
body.style.transition = "padding-right 150ms ease";
|
||||
}
|
||||
} else if (isDesktop) {
|
||||
body.style.paddingRight = "0px";
|
||||
body.style.transition = "padding-right 150ms ease";
|
||||
}
|
||||
return () => {
|
||||
body.style.paddingRight = "0px";
|
||||
body.style.transition = "";
|
||||
};
|
||||
}, [isDesktop, open, desktopWidth]);
|
||||
|
||||
// Resize handle drag
|
||||
const handleResizePointerDown = useCallback(
|
||||
(e: ReactPointerEvent<HTMLDivElement>) => {
|
||||
e.preventDefault();
|
||||
isDraggingRef.current = true;
|
||||
document.documentElement.style.transition = "none";
|
||||
const startX = e.clientX;
|
||||
const startWidth = desktopWidth;
|
||||
|
||||
const onPointerMove = (ev: globalThis.PointerEvent) => {
|
||||
const delta = startX - ev.clientX;
|
||||
const newWidth = Math.min(
|
||||
DESKTOP_MAX_WIDTH,
|
||||
Math.max(DESKTOP_MIN_WIDTH, startWidth + delta),
|
||||
);
|
||||
setDesktopWidth(newWidth);
|
||||
};
|
||||
|
||||
const onPointerUp = () => {
|
||||
isDraggingRef.current = false;
|
||||
document.documentElement.style.transition = "";
|
||||
document.removeEventListener("pointermove", onPointerMove);
|
||||
document.removeEventListener("pointerup", onPointerUp);
|
||||
};
|
||||
|
||||
document.addEventListener("pointermove", onPointerMove);
|
||||
document.addEventListener("pointerup", onPointerUp);
|
||||
},
|
||||
[desktopWidth],
|
||||
);
|
||||
|
||||
// Persist width to cookie
|
||||
useEffect(() => {
|
||||
setCookie("docs-chat-width", String(desktopWidth));
|
||||
}, [desktopWidth]);
|
||||
|
||||
// Restore messages from sessionStorage on mount
|
||||
useEffect(() => {
|
||||
if (restoredRef.current) return;
|
||||
restoredRef.current = true;
|
||||
try {
|
||||
const stored = sessionStorage.getItem(STORAGE_KEY);
|
||||
if (stored) {
|
||||
const parsed = JSON.parse(stored);
|
||||
if (Array.isArray(parsed) && parsed.length > 0) {
|
||||
setMessages(parsed);
|
||||
}
|
||||
}
|
||||
} catch {
|
||||
// ignore parse errors
|
||||
}
|
||||
}, [setMessages]);
|
||||
|
||||
// Save completed messages to sessionStorage
|
||||
useEffect(() => {
|
||||
if (!restoredRef.current) return;
|
||||
if (isLoading) return;
|
||||
if (messages.length === 0) {
|
||||
sessionStorage.removeItem(STORAGE_KEY);
|
||||
return;
|
||||
}
|
||||
try {
|
||||
sessionStorage.setItem(STORAGE_KEY, JSON.stringify(messages));
|
||||
} catch {
|
||||
// ignore quota errors
|
||||
}
|
||||
}, [messages, isLoading]);
|
||||
|
||||
// Cmd+K to open sidebar and focus prompt, Escape to close
|
||||
useEffect(() => {
|
||||
const handleKeyDown = (e: KeyboardEvent) => {
|
||||
if (e.key === "k" && (e.metaKey || e.ctrlKey)) {
|
||||
e.preventDefault();
|
||||
setOpen((prev) => {
|
||||
if (!prev) {
|
||||
setTimeout(() => inputRef.current?.focus(), 200);
|
||||
}
|
||||
return !prev;
|
||||
});
|
||||
}
|
||||
if (e.key === "Escape" && open && isDesktop) {
|
||||
setOpen(false);
|
||||
}
|
||||
};
|
||||
document.addEventListener("keydown", handleKeyDown);
|
||||
return () => document.removeEventListener("keydown", handleKeyDown);
|
||||
}, [open, isDesktop]);
|
||||
|
||||
// Auto-focus input when opened
|
||||
useEffect(() => {
|
||||
if (open) {
|
||||
const timer = setTimeout(() => inputRef.current?.focus(), 200);
|
||||
return () => clearTimeout(timer);
|
||||
}
|
||||
}, [open]);
|
||||
|
||||
// Auto-open when error occurs
|
||||
useEffect(() => {
|
||||
if (error) setOpen(true);
|
||||
}, [error]);
|
||||
|
||||
// Scroll to bottom when messages change or error occurs
|
||||
useEffect(() => {
|
||||
const el = messagesScrollRef.current;
|
||||
if (!el) return;
|
||||
requestAnimationFrame(() => {
|
||||
el.scrollTop = el.scrollHeight;
|
||||
});
|
||||
}, [messages, error]);
|
||||
|
||||
const handleSubmit = useCallback(
|
||||
(e: React.FormEvent) => {
|
||||
e.preventDefault();
|
||||
if (!input.trim() || isLoading) return;
|
||||
sendMessage({ text: input });
|
||||
setInput("");
|
||||
},
|
||||
[input, isLoading, sendMessage],
|
||||
);
|
||||
|
||||
const handleClear = useCallback(() => {
|
||||
setMessages([]);
|
||||
sessionStorage.removeItem(STORAGE_KEY);
|
||||
}, [setMessages]);
|
||||
|
||||
const hasVisibleContent = (
|
||||
parts: (typeof messages)[number]["parts"],
|
||||
): boolean => {
|
||||
return parts.some(
|
||||
(p) => (p.type === "text" && p.text.length > 0) || isToolPart(p),
|
||||
);
|
||||
};
|
||||
|
||||
// Shared chat panel content used by both desktop and mobile
|
||||
const chatPanel = (
|
||||
<>
|
||||
{/* Header */}
|
||||
<div className="flex items-center justify-between px-4 py-3 border-b shrink-0">
|
||||
<span className="text-sm font-medium">json-render Docs</span>
|
||||
<div className="flex items-center gap-3">
|
||||
{showMessages && (
|
||||
<button
|
||||
onClick={handleClear}
|
||||
className="text-xs text-muted-foreground hover:text-foreground transition-colors"
|
||||
aria-label="Clear conversation"
|
||||
>
|
||||
Clear
|
||||
</button>
|
||||
)}
|
||||
<button
|
||||
onClick={() => setOpen(false)}
|
||||
className="text-muted-foreground hover:text-foreground transition-colors"
|
||||
aria-label="Close panel"
|
||||
>
|
||||
<svg
|
||||
width="14"
|
||||
height="14"
|
||||
viewBox="0 0 24 24"
|
||||
fill="none"
|
||||
stroke="currentColor"
|
||||
strokeWidth="2"
|
||||
strokeLinecap="round"
|
||||
strokeLinejoin="round"
|
||||
>
|
||||
<line x1="18" y1="6" x2="6" y2="18" />
|
||||
<line x1="6" y1="6" x2="18" y2="18" />
|
||||
</svg>
|
||||
</button>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
{/* Content: suggestions or messages */}
|
||||
{showMessages ? (
|
||||
<div
|
||||
ref={messagesScrollRef}
|
||||
className="flex-1 min-h-0 p-4 space-y-4 overflow-y-auto"
|
||||
>
|
||||
{messages.map((message) => {
|
||||
if (!hasVisibleContent(message.parts)) return null;
|
||||
return (
|
||||
<div key={message.id}>
|
||||
{message.role === "user" ? (
|
||||
<div className="text-sm text-muted-foreground whitespace-pre-wrap leading-relaxed">
|
||||
{message.parts
|
||||
.filter(
|
||||
(p): p is Extract<typeof p, { type: "text" }> =>
|
||||
p.type === "text",
|
||||
)
|
||||
.map((p) => p.text)
|
||||
.join("")}
|
||||
</div>
|
||||
) : (
|
||||
<div className="space-y-2">
|
||||
{message.parts.map((part, i) => {
|
||||
if (part.type === "text" && part.text) {
|
||||
return (
|
||||
<div
|
||||
key={i}
|
||||
className="docs-chat-content text-sm text-foreground/90 leading-relaxed prose prose-sm dark:prose-invert max-w-none"
|
||||
>
|
||||
<Streamdown>{part.text}</Streamdown>
|
||||
</div>
|
||||
);
|
||||
}
|
||||
if (isToolPart(part)) {
|
||||
return (
|
||||
<ToolCallDisplay key={part.toolCallId} part={part} />
|
||||
);
|
||||
}
|
||||
return null;
|
||||
})}
|
||||
</div>
|
||||
)}
|
||||
</div>
|
||||
);
|
||||
})}
|
||||
{error && (
|
||||
<div className="text-sm text-destructive/80 bg-destructive/10 rounded-md px-3 py-2">
|
||||
{(() => {
|
||||
try {
|
||||
const parsed = JSON.parse(error.message);
|
||||
return parsed.message || parsed.error || error.message;
|
||||
} catch {
|
||||
return (
|
||||
error.message || "Something went wrong. Please try again."
|
||||
);
|
||||
}
|
||||
})()}
|
||||
</div>
|
||||
)}
|
||||
</div>
|
||||
) : (
|
||||
<div className="flex-1 min-h-0 flex flex-col">
|
||||
<div className="flex flex-wrap gap-2 p-4">
|
||||
{SUGGESTIONS.map((s) => (
|
||||
<button
|
||||
key={s}
|
||||
type="button"
|
||||
onClick={() => {
|
||||
sendMessage({ text: s });
|
||||
}}
|
||||
className="text-xs px-3 py-1.5 rounded-full border bg-secondary font-medium text-muted-foreground hover:text-foreground transition-colors"
|
||||
>
|
||||
{s}
|
||||
</button>
|
||||
))}
|
||||
</div>
|
||||
</div>
|
||||
)}
|
||||
|
||||
{/* Input bar */}
|
||||
<form
|
||||
onSubmit={handleSubmit}
|
||||
className="flex items-end gap-2 px-4 py-3 border-t shrink-0"
|
||||
>
|
||||
<textarea
|
||||
ref={inputRef}
|
||||
value={input}
|
||||
onChange={(e) => {
|
||||
setInput(e.target.value);
|
||||
e.target.style.height = "auto";
|
||||
e.target.style.height = `${e.target.scrollHeight}px`;
|
||||
}}
|
||||
rows={1}
|
||||
enterKeyHint="send"
|
||||
placeholder="Ask a question..."
|
||||
onKeyDown={(e) => {
|
||||
if (e.key === "Enter" && !e.shiftKey) {
|
||||
e.preventDefault();
|
||||
handleSubmit(e);
|
||||
}
|
||||
}}
|
||||
className="flex-1 bg-transparent text-base sm:text-sm text-foreground outline-none disabled:opacity-50 resize-none max-h-32 leading-relaxed placeholder:text-muted-foreground"
|
||||
/>
|
||||
<button
|
||||
type="submit"
|
||||
disabled={isLoading || !input.trim()}
|
||||
className="bg-primary text-primary-foreground rounded-full p-1.5 hover:bg-primary/90 transition-colors disabled:opacity-30 shrink-0"
|
||||
aria-label="Send message"
|
||||
>
|
||||
<svg
|
||||
width="16"
|
||||
height="16"
|
||||
viewBox="0 0 24 24"
|
||||
fill="none"
|
||||
stroke="currentColor"
|
||||
strokeWidth="2"
|
||||
strokeLinecap="round"
|
||||
strokeLinejoin="round"
|
||||
>
|
||||
<line x1="12" y1="19" x2="12" y2="5" />
|
||||
<polyline points="5 12 12 5 19 12" />
|
||||
</svg>
|
||||
</button>
|
||||
</form>
|
||||
</>
|
||||
);
|
||||
|
||||
return (
|
||||
<>
|
||||
{/* Ask AI trigger button */}
|
||||
{!open && (
|
||||
<button
|
||||
onClick={() => setOpen(true)}
|
||||
className="fixed z-50 bottom-4 left-1/2 -translate-x-1/2 sm:left-auto sm:translate-x-0 sm:right-4 flex items-center gap-2 px-4 py-2 rounded-lg border bg-background text-primary shadow-lg hover:bg-primary hover:text-primary-foreground transition-colors text-sm font-medium"
|
||||
aria-label="Ask AI"
|
||||
>
|
||||
Ask AI
|
||||
<kbd className="hidden sm:inline-flex items-center gap-0.5 text-xs opacity-60 font-mono">
|
||||
<span>⌘</span>K
|
||||
</kbd>
|
||||
</button>
|
||||
)}
|
||||
|
||||
{/* Desktop: resizable side pane — always rendered, hidden on mobile via CSS */}
|
||||
<aside
|
||||
className={`hidden sm:flex fixed top-0 right-0 bottom-0 z-40 border-l bg-background transition-transform duration-150 ease-in-out ${open ? "translate-x-0" : "translate-x-full"}`}
|
||||
style={{ width: desktopWidth }}
|
||||
aria-hidden={!open}
|
||||
>
|
||||
{/* Resize handle */}
|
||||
<div
|
||||
onPointerDown={handleResizePointerDown}
|
||||
className="absolute top-0 bottom-0 left-0 w-1.5 cursor-col-resize hover:bg-ring/30 active:bg-ring/50 transition-colors z-10"
|
||||
/>
|
||||
<div className="flex flex-col flex-1 min-w-0">{chatPanel}</div>
|
||||
</aside>
|
||||
|
||||
{/* Mobile: Sheet overlay/drawer — only after mount to avoid flash on desktop */}
|
||||
{hasMounted && !isDesktop && (
|
||||
<Sheet open={open} onOpenChange={setOpen}>
|
||||
<SheetContent
|
||||
side="right"
|
||||
overlayClassName="!bg-background"
|
||||
className="!inset-0 !w-full !h-full !max-w-none p-0 flex flex-col"
|
||||
style={{ backgroundColor: "var(--background)", opacity: 1 }}
|
||||
>
|
||||
<SheetTitle className="sr-only">AI Chat</SheetTitle>
|
||||
{chatPanel}
|
||||
</SheetContent>
|
||||
</Sheet>
|
||||
)}
|
||||
</>
|
||||
);
|
||||
}
|
||||
@@ -0,0 +1,115 @@
|
||||
"use client";
|
||||
|
||||
function Skeleton({ className = "" }: { className?: string }) {
|
||||
return <div className={`rounded bg-muted-foreground/10 ${className}`} />;
|
||||
}
|
||||
|
||||
/** Simple form wireframe reused in both diagrams */
|
||||
function FormUI() {
|
||||
return (
|
||||
<div className="border border-border rounded-lg p-2.5 space-y-1.5 bg-muted/30">
|
||||
{/* Title */}
|
||||
<Skeleton className="h-2.5 w-14 mb-1" />
|
||||
{/* Input fields */}
|
||||
<Skeleton className="h-4 w-full rounded-sm" />
|
||||
<Skeleton className="h-4 w-full rounded-sm" />
|
||||
{/* Submit button */}
|
||||
<Skeleton className="h-4 w-16 rounded-sm bg-muted-foreground/20 mt-1" />
|
||||
</div>
|
||||
);
|
||||
}
|
||||
|
||||
function ChatModeDiagram() {
|
||||
return (
|
||||
<div className="flex flex-col h-full">
|
||||
<div className="text-xs font-medium text-muted-foreground mb-3 text-center">
|
||||
Chat Mode
|
||||
</div>
|
||||
<div className="flex-1 border border-border rounded-lg bg-background overflow-hidden flex flex-col">
|
||||
{/* Chat area */}
|
||||
<div className="flex-1 p-3 overflow-hidden flex justify-center">
|
||||
<div className="w-1/3 min-w-[120px] space-y-3">
|
||||
{/* User message */}
|
||||
<div className="flex justify-end">
|
||||
<div className="bg-muted rounded-xl px-3 py-2">
|
||||
<Skeleton className="h-2 w-14" />
|
||||
</div>
|
||||
</div>
|
||||
|
||||
{/* Assistant text */}
|
||||
<div className="space-y-2">
|
||||
<div className="space-y-1.5">
|
||||
<Skeleton className="h-2 w-full" />
|
||||
<Skeleton className="h-2 w-3/4" />
|
||||
</div>
|
||||
|
||||
{/* Inline UI */}
|
||||
<FormUI />
|
||||
|
||||
{/* More text after UI */}
|
||||
<div className="space-y-1.5">
|
||||
<Skeleton className="h-2 w-4/5" />
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
{/* Input bar */}
|
||||
<div className="p-2 flex justify-center">
|
||||
<div className="w-1/3 min-w-[120px] flex items-center gap-2">
|
||||
<Skeleton className="h-7 flex-1 rounded-md" />
|
||||
<Skeleton className="h-7 w-7 rounded-md" />
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div className="text-[10px] text-muted-foreground/60 mt-2 text-center">
|
||||
Text + UI interleaved in messages
|
||||
</div>
|
||||
</div>
|
||||
);
|
||||
}
|
||||
|
||||
function GenerateModeDiagram() {
|
||||
return (
|
||||
<div className="flex flex-col h-full">
|
||||
<div className="text-xs font-medium text-muted-foreground mb-3 text-center">
|
||||
Generate Mode
|
||||
</div>
|
||||
<div className="flex-1 border border-border rounded-lg bg-background overflow-hidden flex flex-row">
|
||||
{/* Left panel - prompt */}
|
||||
<div className="w-[38%] border-r border-border flex flex-col">
|
||||
<div className="flex-1" />
|
||||
<div className="p-3 space-y-2">
|
||||
<Skeleton className="h-7 w-full rounded-md" />
|
||||
<Skeleton className="h-5 w-16 rounded-md" />
|
||||
</div>
|
||||
</div>
|
||||
|
||||
{/* Right panel - UI preview */}
|
||||
<div className="flex-1 p-3 flex items-center justify-center">
|
||||
<div className="w-3/4">
|
||||
<FormUI />
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div className="text-[10px] text-muted-foreground/60 mt-2 text-center">
|
||||
Prompt separate from UI preview
|
||||
</div>
|
||||
</div>
|
||||
);
|
||||
}
|
||||
|
||||
export function GenerationModesDiagram() {
|
||||
return (
|
||||
<div className="not-prose my-8">
|
||||
<div className="grid grid-cols-1 sm:grid-cols-2 gap-6">
|
||||
<div className="h-[280px]">
|
||||
<ChatModeDiagram />
|
||||
</div>
|
||||
<div className="h-[280px]">
|
||||
<GenerateModeDiagram />
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
);
|
||||
}
|
||||
@@ -57,7 +57,7 @@ export function Header() {
|
||||
</svg>
|
||||
</span>
|
||||
<Link href="/">
|
||||
<span className="font-medium tracking-tight text-lg">
|
||||
<span className="font-medium tracking-tight text-lg font-(family-name:--font-geist-pixel-square)">
|
||||
json-render
|
||||
</span>
|
||||
</Link>
|
||||
@@ -100,7 +100,7 @@ export function Header() {
|
||||
>
|
||||
<path d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0016 8c0-4.42-3.58-8-8-8z" />
|
||||
</svg>
|
||||
<span>10k</span>
|
||||
<span>11k</span>
|
||||
</a>
|
||||
<ThemeToggle />
|
||||
</nav>
|
||||
|
||||
+725
-113
@@ -1,7 +1,8 @@
|
||||
"use client";
|
||||
|
||||
import { useEffect, useState, useCallback, useRef, useMemo } from "react";
|
||||
import { useUIStream } from "@json-render/react";
|
||||
import { flushSync } from "react-dom";
|
||||
import { useUIStream, type TokenUsage } from "@json-render/react";
|
||||
import type { Spec } from "@json-render/core";
|
||||
import { collectUsedComponents, serializeProps } from "@json-render/codegen";
|
||||
import { toast } from "sonner";
|
||||
@@ -14,17 +15,76 @@ import { CodeBlock } from "./code-block";
|
||||
import { CopyButton } from "./copy-button";
|
||||
import { Toaster } from "./ui/sonner";
|
||||
import { Header } from "./header";
|
||||
import { PlaygroundRenderer } from "@/lib/renderer";
|
||||
import { Sheet, SheetContent, SheetTitle } from "./ui/sheet";
|
||||
import { JsonEditor } from "@visual-json/react";
|
||||
import type { JsonValue } from "@visual-json/react";
|
||||
import { PlaygroundRenderer } from "@/lib/render/renderer";
|
||||
import { playgroundCatalog } from "@/lib/render/catalog";
|
||||
import { buildCatalogDisplayData } from "@/lib/render/catalog-display";
|
||||
|
||||
type Tab = "json" | "stream";
|
||||
type Tab = "json" | "nested" | "stream" | "catalog" | "visual";
|
||||
type RenderView = "preview" | "code";
|
||||
type MobilePane = "chat" | "code" | "preview";
|
||||
type MobileView =
|
||||
| "json"
|
||||
| "nested"
|
||||
| "stream"
|
||||
| "catalog"
|
||||
| "visual"
|
||||
| "preview"
|
||||
| "generated-code";
|
||||
|
||||
interface Version {
|
||||
id: string;
|
||||
prompt: string;
|
||||
tree: Spec | null;
|
||||
status: "generating" | "complete" | "error";
|
||||
usage: TokenUsage | null;
|
||||
rawLines: string[];
|
||||
}
|
||||
|
||||
/**
|
||||
* Convert a flat Spec into a nested tree structure that is easier for humans
|
||||
* to read. Children keys are resolved recursively into inline objects.
|
||||
*/
|
||||
function specToNested(spec: Spec): Record<string, unknown> {
|
||||
function resolve(key: string): Record<string, unknown> {
|
||||
const el = spec.elements[key];
|
||||
if (!el) return { _key: key, _missing: true };
|
||||
|
||||
const node: Record<string, unknown> = { type: el.type };
|
||||
|
||||
if (el.props && Object.keys(el.props).length > 0) {
|
||||
node.props = el.props;
|
||||
}
|
||||
|
||||
if (el.visible !== undefined) {
|
||||
node.visible = el.visible;
|
||||
}
|
||||
|
||||
if (el.on && Object.keys(el.on).length > 0) {
|
||||
node.on = el.on;
|
||||
}
|
||||
|
||||
if (el.repeat) {
|
||||
node.repeat = el.repeat;
|
||||
}
|
||||
|
||||
if (el.children && el.children.length > 0) {
|
||||
node.children = el.children.map(resolve);
|
||||
}
|
||||
|
||||
return node;
|
||||
}
|
||||
|
||||
const result: Record<string, unknown> = {};
|
||||
|
||||
if (spec.state && Object.keys(spec.state).length > 0) {
|
||||
result.state = spec.state;
|
||||
}
|
||||
|
||||
result.elements = resolve(spec.root);
|
||||
|
||||
return result;
|
||||
}
|
||||
|
||||
const EXAMPLE_PROMPTS = [
|
||||
@@ -40,11 +100,15 @@ export function Playground() {
|
||||
null,
|
||||
);
|
||||
const [inputValue, setInputValue] = useState("");
|
||||
const [streamLines, setStreamLines] = useState<string[]>([]);
|
||||
const [activeTab, setActiveTab] = useState<Tab>("json");
|
||||
const [catalogSection, setCatalogSection] = useState<
|
||||
"components" | "actions"
|
||||
>("components");
|
||||
const [renderView, setRenderView] = useState<RenderView>("preview");
|
||||
const [mobilePane, setMobilePane] = useState<MobilePane>("chat");
|
||||
const [mobileView, setMobileView] = useState<MobileView>("preview");
|
||||
const [versionsSheetOpen, setVersionsSheetOpen] = useState(false);
|
||||
const inputRef = useRef<HTMLTextAreaElement>(null);
|
||||
const mobileInputRef = useRef<HTMLTextAreaElement>(null);
|
||||
const versionsEndRef = useRef<HTMLDivElement>(null);
|
||||
|
||||
// Track the currently generating version ID
|
||||
@@ -56,6 +120,8 @@ export function Playground() {
|
||||
const {
|
||||
spec: apiSpec,
|
||||
isStreaming,
|
||||
usage: streamUsage,
|
||||
rawLines: streamRawLines,
|
||||
send,
|
||||
clear,
|
||||
} = useUIStream({
|
||||
@@ -93,6 +159,11 @@ export function Playground() {
|
||||
: (selectedVersion?.tree ??
|
||||
(isSelectedVersionGenerating ? apiSpec : null));
|
||||
|
||||
// Raw JSONL lines: live from stream during generation, or stored per version
|
||||
const currentRawLines = isSelectedVersionGenerating
|
||||
? streamRawLines
|
||||
: (selectedVersion?.rawLines ?? []);
|
||||
|
||||
// Keep the ref updated with the current tree for use in handleSubmit
|
||||
if (
|
||||
currentTree &&
|
||||
@@ -107,24 +178,6 @@ export function Playground() {
|
||||
versionsEndRef.current?.scrollIntoView({ behavior: "smooth" });
|
||||
}, [versions]);
|
||||
|
||||
useEffect(() => {
|
||||
if (apiSpec) {
|
||||
const streamLine = JSON.stringify({ tree: apiSpec });
|
||||
if (
|
||||
!streamLines.includes(streamLine) &&
|
||||
Object.keys(apiSpec.elements).length > 0
|
||||
) {
|
||||
setStreamLines((prev) => {
|
||||
const lastLine = prev[prev.length - 1];
|
||||
if (lastLine !== streamLine) {
|
||||
return [...prev, streamLine];
|
||||
}
|
||||
return prev;
|
||||
});
|
||||
}
|
||||
}
|
||||
}, [apiSpec, streamLines]);
|
||||
|
||||
// Update version when streaming completes
|
||||
useEffect(() => {
|
||||
if (
|
||||
@@ -137,13 +190,19 @@ export function Playground() {
|
||||
setVersions((prev) =>
|
||||
prev.map((v) =>
|
||||
v.id === completedVersionId
|
||||
? { ...v, tree: apiSpec, status: "complete" as const }
|
||||
? {
|
||||
...v,
|
||||
tree: apiSpec,
|
||||
status: "complete" as const,
|
||||
usage: streamUsage,
|
||||
rawLines: streamRawLines,
|
||||
}
|
||||
: v,
|
||||
),
|
||||
);
|
||||
generatingVersionIdRef.current = null;
|
||||
}
|
||||
}, [isStreaming, apiSpec]);
|
||||
}, [isStreaming, apiSpec, streamUsage, streamRawLines]);
|
||||
|
||||
const handleSubmit = useCallback(async () => {
|
||||
if (!inputValue.trim() || isStreaming) return;
|
||||
@@ -154,13 +213,14 @@ export function Playground() {
|
||||
prompt: inputValue.trim(),
|
||||
tree: null,
|
||||
status: "generating",
|
||||
usage: null,
|
||||
rawLines: [],
|
||||
};
|
||||
|
||||
generatingVersionIdRef.current = newVersionId;
|
||||
setVersions((prev) => [...prev, newVersion]);
|
||||
setSelectedVersionId(newVersionId);
|
||||
setInputValue("");
|
||||
setStreamLines([]); // Reset stream lines for new generation
|
||||
|
||||
// Pass the current tree as context so the API can iterate on it
|
||||
await send(inputValue.trim(), { previousSpec: currentTreeRef.current });
|
||||
@@ -176,10 +236,29 @@ export function Playground() {
|
||||
[handleSubmit],
|
||||
);
|
||||
|
||||
const handleVisualChange = useCallback(
|
||||
(value: JsonValue) => {
|
||||
if (!selectedVersionId || isStreaming) return;
|
||||
setVersions((prev) =>
|
||||
prev.map((v) =>
|
||||
v.id === selectedVersionId
|
||||
? { ...v, tree: value as unknown as Spec }
|
||||
: v,
|
||||
),
|
||||
);
|
||||
},
|
||||
[selectedVersionId, isStreaming],
|
||||
);
|
||||
|
||||
const jsonCode = currentTree
|
||||
? JSON.stringify(currentTree, null, 2)
|
||||
: "// waiting...";
|
||||
|
||||
const nestedCode = useMemo(() => {
|
||||
if (!currentTree || !currentTree.root) return "// waiting...";
|
||||
return JSON.stringify(specToNested(currentTree), null, 2);
|
||||
}, [currentTree]);
|
||||
|
||||
const generatedCode = useMemo(() => {
|
||||
if (!currentTree || !currentTree.root) {
|
||||
return "// Generate a UI to see the code";
|
||||
@@ -262,17 +341,23 @@ ${jsx}
|
||||
{EXAMPLE_PROMPTS.map((prompt) => (
|
||||
<button
|
||||
key={prompt}
|
||||
onClick={() => {
|
||||
setInputValue(prompt);
|
||||
setTimeout(() => {
|
||||
if (inputRef.current) {
|
||||
inputRef.current.focus();
|
||||
inputRef.current.setSelectionRange(
|
||||
prompt.length,
|
||||
prompt.length,
|
||||
);
|
||||
}
|
||||
}, 0);
|
||||
onMouseDown={(e) => {
|
||||
e.preventDefault();
|
||||
flushSync(() => setInputValue(prompt));
|
||||
// chatPane is rendered in both desktop and mobile layouts,
|
||||
// so inputRef may point to the hidden instance. Find the
|
||||
// textarea in the same layout container as the clicked button.
|
||||
const container = (e.currentTarget as HTMLElement).closest(
|
||||
".h-full.flex.flex-col",
|
||||
);
|
||||
const el =
|
||||
container?.querySelector<HTMLTextAreaElement>(
|
||||
"textarea",
|
||||
) ?? inputRef.current;
|
||||
if (el) {
|
||||
el.focus();
|
||||
el.setSelectionRange(prompt.length, prompt.length);
|
||||
}
|
||||
}}
|
||||
className="text-xs px-2 py-1 rounded border border-border text-muted-foreground hover:text-foreground hover:border-foreground/30 transition-colors"
|
||||
>
|
||||
@@ -306,6 +391,13 @@ ${jsx}
|
||||
<span className="text-xs text-red-500 shrink-0">failed</span>
|
||||
)}
|
||||
</div>
|
||||
{version.usage && (
|
||||
<div className="flex items-center gap-2 mt-1 ml-6">
|
||||
<span className="text-[10px] font-mono text-muted-foreground/60">
|
||||
{version.usage.totalTokens.toLocaleString()} tokens
|
||||
</span>
|
||||
</div>
|
||||
)}
|
||||
</button>
|
||||
))
|
||||
)}
|
||||
@@ -330,6 +422,7 @@ ${jsx}
|
||||
placeholder="Describe changes..."
|
||||
className="w-full bg-background text-base sm:text-sm resize-none outline-none placeholder:text-muted-foreground/50"
|
||||
rows={2}
|
||||
autoFocus
|
||||
/>
|
||||
<div className="flex justify-between items-center mt-2">
|
||||
{versions.length > 0 ? (
|
||||
@@ -337,7 +430,6 @@ ${jsx}
|
||||
onClick={() => {
|
||||
setVersions([]);
|
||||
setSelectedVersionId(null);
|
||||
setStreamLines([]);
|
||||
clear();
|
||||
}}
|
||||
className="text-xs text-muted-foreground hover:text-foreground transition-colors"
|
||||
@@ -390,34 +482,203 @@ ${jsx}
|
||||
</div>
|
||||
);
|
||||
|
||||
// Catalog data for the catalog tab
|
||||
const catalogData = useMemo(
|
||||
() => buildCatalogDisplayData(playgroundCatalog.data),
|
||||
[],
|
||||
);
|
||||
|
||||
// Code pane content
|
||||
const copyText =
|
||||
activeTab === "stream"
|
||||
? currentRawLines.join("\n")
|
||||
: activeTab === "json"
|
||||
? jsonCode
|
||||
: activeTab === "nested"
|
||||
? nestedCode
|
||||
: activeTab === "visual"
|
||||
? jsonCode
|
||||
: "";
|
||||
|
||||
const codePane = (
|
||||
<div className="h-full flex flex-col border-t border-border">
|
||||
<div className="border-b border-border px-3 h-9 flex items-center gap-3">
|
||||
{(["json", "stream"] as const).map((tab) => (
|
||||
<button
|
||||
key={tab}
|
||||
onClick={() => setActiveTab(tab)}
|
||||
className={`text-xs font-mono transition-colors ${
|
||||
activeTab === tab
|
||||
? "text-foreground"
|
||||
: "text-muted-foreground hover:text-foreground"
|
||||
}`}
|
||||
>
|
||||
{tab}
|
||||
</button>
|
||||
))}
|
||||
{(["json", "visual", "nested", "stream", "catalog"] as const).map(
|
||||
(tab) => (
|
||||
<button
|
||||
key={tab}
|
||||
onClick={() => setActiveTab(tab)}
|
||||
className={`text-xs font-mono transition-colors ${
|
||||
activeTab === tab
|
||||
? "text-foreground"
|
||||
: "text-muted-foreground hover:text-foreground"
|
||||
}`}
|
||||
>
|
||||
{tab}
|
||||
</button>
|
||||
),
|
||||
)}
|
||||
<div className="flex-1" />
|
||||
<CopyButton
|
||||
text={activeTab === "stream" ? streamLines.join("\n") : jsonCode}
|
||||
className="text-muted-foreground"
|
||||
/>
|
||||
{activeTab !== "catalog" && activeTab !== "visual" && (
|
||||
<CopyButton text={copyText} className="text-muted-foreground" />
|
||||
)}
|
||||
</div>
|
||||
<div className="flex-1 overflow-auto">
|
||||
{activeTab === "stream" ? (
|
||||
streamLines.length > 0 ? (
|
||||
{activeTab === "visual" ? (
|
||||
currentTree ? (
|
||||
<JsonEditor
|
||||
value={currentTree as unknown as JsonValue}
|
||||
onChange={handleVisualChange}
|
||||
readOnly={isStreaming}
|
||||
sidebarOpen={false}
|
||||
height="100%"
|
||||
className="h-full"
|
||||
style={
|
||||
{
|
||||
"--vj-bg": "var(--background)",
|
||||
"--vj-bg-panel": "var(--background)",
|
||||
"--vj-bg-hover": "var(--muted)",
|
||||
"--vj-bg-selected": "var(--primary)",
|
||||
"--vj-bg-selected-muted": "var(--muted)",
|
||||
"--vj-text": "var(--foreground)",
|
||||
"--vj-text-selected": "var(--primary-foreground)",
|
||||
"--vj-text-muted": "var(--muted-foreground)",
|
||||
"--vj-text-dim": "var(--muted-foreground)",
|
||||
"--vj-border": "var(--border)",
|
||||
"--vj-border-subtle": "var(--border)",
|
||||
"--vj-accent": "var(--primary)",
|
||||
"--vj-accent-muted": "var(--muted)",
|
||||
"--vj-input-bg": "var(--secondary)",
|
||||
"--vj-input-border": "var(--border)",
|
||||
} as React.CSSProperties
|
||||
}
|
||||
/>
|
||||
) : (
|
||||
<div className="text-muted-foreground/50 p-3 text-sm font-mono">
|
||||
{"// generate a spec to edit visually"}
|
||||
</div>
|
||||
)
|
||||
) : activeTab === "catalog" ? (
|
||||
<div className="h-full flex flex-col text-sm">
|
||||
<div className="flex items-center gap-3 px-3 h-9 border-b border-border">
|
||||
{(
|
||||
[
|
||||
{
|
||||
key: "components",
|
||||
label: `components (${catalogData.components.length})`,
|
||||
},
|
||||
{
|
||||
key: "actions",
|
||||
label: `actions (${catalogData.actions.length})`,
|
||||
},
|
||||
] as const
|
||||
).map(({ key, label }) => (
|
||||
<button
|
||||
key={key}
|
||||
onClick={() => setCatalogSection(key)}
|
||||
className={`text-xs font-mono transition-colors ${
|
||||
catalogSection === key
|
||||
? "text-foreground"
|
||||
: "text-muted-foreground hover:text-foreground"
|
||||
}`}
|
||||
>
|
||||
{label}
|
||||
</button>
|
||||
))}
|
||||
</div>
|
||||
<div className="flex-1 overflow-auto p-3">
|
||||
{catalogSection === "components" ? (
|
||||
<div className="space-y-3">
|
||||
{catalogData.components.map((comp) => (
|
||||
<div
|
||||
key={comp.name}
|
||||
className="pb-3 border-b border-border last:border-b-0"
|
||||
>
|
||||
<div className="flex items-baseline gap-2 mb-1">
|
||||
<span className="font-mono font-medium text-foreground">
|
||||
{comp.name}
|
||||
</span>
|
||||
{comp.slots.length > 0 && (
|
||||
<span className="text-[10px] font-mono px-1.5 py-0.5 rounded bg-muted text-muted-foreground">
|
||||
slots: {comp.slots.join(", ")}
|
||||
</span>
|
||||
)}
|
||||
</div>
|
||||
{comp.description && (
|
||||
<p className="text-xs text-muted-foreground mb-2">
|
||||
{comp.description}
|
||||
</p>
|
||||
)}
|
||||
{comp.props.length > 0 && (
|
||||
<div className="flex flex-wrap gap-1 mb-1">
|
||||
{comp.props.map((p) => (
|
||||
<span
|
||||
key={p.name}
|
||||
className="text-[11px] font-mono px-1.5 py-0.5 rounded bg-green-500/10 text-green-700 dark:text-green-400"
|
||||
>
|
||||
{p.name}
|
||||
<span className="text-green-700/50 dark:text-green-400/50">
|
||||
: {p.type}
|
||||
</span>
|
||||
</span>
|
||||
))}
|
||||
</div>
|
||||
)}
|
||||
{comp.events.length > 0 && (
|
||||
<div className="flex flex-wrap gap-1 mt-1.5">
|
||||
{comp.events.map((e) => (
|
||||
<span
|
||||
key={e}
|
||||
className="text-[11px] font-mono px-1.5 py-0.5 rounded bg-blue-500/10 text-blue-600 dark:text-blue-400"
|
||||
>
|
||||
on.{e}
|
||||
</span>
|
||||
))}
|
||||
</div>
|
||||
)}
|
||||
</div>
|
||||
))}
|
||||
</div>
|
||||
) : (
|
||||
<div className="space-y-3">
|
||||
{catalogData.actions.map((action) => (
|
||||
<div
|
||||
key={action.name}
|
||||
className="pb-3 border-b border-border last:border-b-0"
|
||||
>
|
||||
<span className="font-mono font-medium text-foreground">
|
||||
{action.name}
|
||||
</span>
|
||||
{action.description && (
|
||||
<p className="text-xs text-muted-foreground mt-1 mb-2">
|
||||
{action.description}
|
||||
</p>
|
||||
)}
|
||||
{action.params.length > 0 && (
|
||||
<div className="flex flex-wrap gap-1">
|
||||
{action.params.map((p) => (
|
||||
<span
|
||||
key={p.name}
|
||||
className="text-[11px] font-mono px-1.5 py-0.5 rounded bg-green-500/10 text-green-700 dark:text-green-400"
|
||||
>
|
||||
{p.name}
|
||||
<span className="text-green-700/50 dark:text-green-400/50">
|
||||
: {p.type}
|
||||
</span>
|
||||
</span>
|
||||
))}
|
||||
</div>
|
||||
)}
|
||||
</div>
|
||||
))}
|
||||
</div>
|
||||
)}
|
||||
</div>
|
||||
</div>
|
||||
) : activeTab === "stream" ? (
|
||||
currentRawLines.length > 0 ? (
|
||||
<CodeBlock
|
||||
code={streamLines.join("\n")}
|
||||
code={currentRawLines.join("\n")}
|
||||
lang="json"
|
||||
fillHeight
|
||||
hideCopyButton
|
||||
@@ -427,6 +688,8 @@ ${jsx}
|
||||
{isStreaming ? "streaming..." : "// waiting for generation"}
|
||||
</div>
|
||||
)
|
||||
) : activeTab === "nested" ? (
|
||||
<CodeBlock code={nestedCode} lang="json" fillHeight hideCopyButton />
|
||||
) : (
|
||||
<CodeBlock code={jsonCode} lang="json" fillHeight hideCopyButton />
|
||||
)}
|
||||
@@ -465,7 +728,11 @@ ${jsx}
|
||||
{renderView === "preview" ? (
|
||||
currentTree && currentTree.root ? (
|
||||
<div className="w-full min-h-full flex items-center justify-center p-6">
|
||||
<PlaygroundRenderer spec={currentTree} loading={isStreaming} />
|
||||
<PlaygroundRenderer
|
||||
spec={currentTree}
|
||||
data={currentTree.state}
|
||||
loading={isStreaming}
|
||||
/>
|
||||
</div>
|
||||
) : (
|
||||
<div className="h-full flex items-center justify-center text-muted-foreground/50 text-sm">
|
||||
@@ -507,68 +774,413 @@ ${jsx}
|
||||
</ResizablePanelGroup>
|
||||
</div>
|
||||
|
||||
{/* Mobile: Single pane with bottom tabs */}
|
||||
{/* Mobile: toolbar + content + prompt input */}
|
||||
<div className="flex lg:hidden flex-col flex-1 min-h-0">
|
||||
{/* Panes - all in DOM, visibility controlled */}
|
||||
<div className="flex-1 min-h-0 relative">
|
||||
<div
|
||||
className={`absolute inset-0 ${mobilePane === "chat" ? "" : "invisible"}`}
|
||||
{/* Top toolbar */}
|
||||
<div className="border-b border-border px-3 h-9 flex items-center gap-3 shrink-0 overflow-x-auto">
|
||||
{/* Version badge */}
|
||||
<button
|
||||
onClick={() => setVersionsSheetOpen(true)}
|
||||
className="text-xs font-mono font-medium px-1.5 py-0.5 rounded bg-muted text-foreground shrink-0"
|
||||
>
|
||||
{chatPane}
|
||||
</div>
|
||||
<div
|
||||
className={`absolute inset-0 ${mobilePane === "code" ? "" : "invisible"}`}
|
||||
>
|
||||
{codePane}
|
||||
</div>
|
||||
<div
|
||||
className={`absolute inset-0 ${mobilePane === "preview" ? "" : "invisible"}`}
|
||||
>
|
||||
{previewPane}
|
||||
</div>
|
||||
</div>
|
||||
|
||||
{/* Bottom tab bar */}
|
||||
<div className="border-t border-border flex shrink-0">
|
||||
{(
|
||||
[
|
||||
{
|
||||
key: "chat",
|
||||
label: "Chat",
|
||||
icon: "M8 12h.01M12 12h.01M16 12h.01M21 12c0 4.418-4.03 8-9 8a9.863 9.863 0 01-4.255-.949L3 20l1.395-3.72C3.512 15.042 3 13.574 3 12c0-4.418 4.03-8 9-8s9 3.582 9 8z",
|
||||
},
|
||||
{
|
||||
key: "code",
|
||||
label: "Code",
|
||||
icon: "M10 20l4-16m4 4l4 4-4 4M6 16l-4-4 4-4",
|
||||
},
|
||||
{
|
||||
key: "preview",
|
||||
label: "Preview",
|
||||
icon: "M15 12a3 3 0 11-6 0 3 3 0 016 0z M2.458 12C3.732 7.943 7.523 5 12 5c4.478 0 8.268 2.943 9.542 7-1.274 4.057-5.064 7-9.542 7-4.477 0-8.268-2.943-9.542-7z",
|
||||
},
|
||||
] as const
|
||||
).map(({ key, label, icon }) => (
|
||||
v
|
||||
{versions.length > 0
|
||||
? versions.findIndex((v) => v.id === selectedVersionId) + 1 ||
|
||||
versions.length
|
||||
: 0}
|
||||
</button>
|
||||
{/* Code tabs */}
|
||||
{(["json", "visual", "nested", "stream", "catalog"] as const).map(
|
||||
(tab) => (
|
||||
<button
|
||||
key={tab}
|
||||
onClick={() => setMobileView(tab)}
|
||||
className={`text-xs font-mono transition-colors shrink-0 ${
|
||||
mobileView === tab
|
||||
? "text-foreground"
|
||||
: "text-muted-foreground hover:text-foreground"
|
||||
}`}
|
||||
>
|
||||
{tab}
|
||||
</button>
|
||||
),
|
||||
)}
|
||||
<div className="flex-1" />
|
||||
{/* Preview / code toggle */}
|
||||
{[
|
||||
{ key: "preview" as const, label: "preview" },
|
||||
{ key: "generated-code" as const, label: "code" },
|
||||
].map(({ key, label }) => (
|
||||
<button
|
||||
key={key}
|
||||
onClick={() => setMobilePane(key)}
|
||||
className={`flex-1 py-3 flex flex-col items-center gap-1 transition-colors ${
|
||||
mobilePane === key ? "text-foreground" : "text-muted-foreground"
|
||||
onClick={() => setMobileView(key)}
|
||||
className={`text-xs font-mono transition-colors shrink-0 ${
|
||||
mobileView === key
|
||||
? "text-foreground"
|
||||
: "text-muted-foreground hover:text-foreground"
|
||||
}`}
|
||||
>
|
||||
<svg
|
||||
className="w-5 h-5"
|
||||
fill="none"
|
||||
stroke="currentColor"
|
||||
viewBox="0 0 24 24"
|
||||
strokeWidth={1.5}
|
||||
>
|
||||
<path strokeLinecap="round" strokeLinejoin="round" d={icon} />
|
||||
</svg>
|
||||
<span className="text-xs">{label}</span>
|
||||
{label}
|
||||
</button>
|
||||
))}
|
||||
</div>
|
||||
|
||||
{/* Main content area */}
|
||||
<div className="flex-1 min-h-0 overflow-auto">
|
||||
{mobileView === "visual" ? (
|
||||
currentTree ? (
|
||||
<JsonEditor
|
||||
value={currentTree as unknown as JsonValue}
|
||||
onChange={handleVisualChange}
|
||||
readOnly={isStreaming}
|
||||
sidebarOpen={false}
|
||||
height="100%"
|
||||
className="h-full"
|
||||
style={
|
||||
{
|
||||
"--vj-bg": "var(--background)",
|
||||
"--vj-bg-panel": "var(--background)",
|
||||
"--vj-bg-hover": "var(--muted)",
|
||||
"--vj-bg-selected": "var(--primary)",
|
||||
"--vj-bg-selected-muted": "var(--muted)",
|
||||
"--vj-text": "var(--foreground)",
|
||||
"--vj-text-selected": "var(--primary-foreground)",
|
||||
"--vj-text-muted": "var(--muted-foreground)",
|
||||
"--vj-text-dim": "var(--muted-foreground)",
|
||||
"--vj-border": "var(--border)",
|
||||
"--vj-border-subtle": "var(--border)",
|
||||
"--vj-accent": "var(--primary)",
|
||||
"--vj-accent-muted": "var(--muted)",
|
||||
"--vj-input-bg": "var(--secondary)",
|
||||
"--vj-input-border": "var(--border)",
|
||||
} as React.CSSProperties
|
||||
}
|
||||
/>
|
||||
) : (
|
||||
<div className="text-muted-foreground/50 p-3 text-sm font-mono">
|
||||
{"// generate a spec to edit visually"}
|
||||
</div>
|
||||
)
|
||||
) : mobileView === "catalog" ? (
|
||||
<div className="h-full flex flex-col text-sm">
|
||||
<div className="flex items-center gap-3 px-3 h-9 border-b border-border">
|
||||
{(
|
||||
[
|
||||
{
|
||||
key: "components",
|
||||
label: `components (${catalogData.components.length})`,
|
||||
},
|
||||
{
|
||||
key: "actions",
|
||||
label: `actions (${catalogData.actions.length})`,
|
||||
},
|
||||
] as const
|
||||
).map(({ key, label }) => (
|
||||
<button
|
||||
key={key}
|
||||
onClick={() => setCatalogSection(key)}
|
||||
className={`text-xs font-mono transition-colors ${
|
||||
catalogSection === key
|
||||
? "text-foreground"
|
||||
: "text-muted-foreground hover:text-foreground"
|
||||
}`}
|
||||
>
|
||||
{label}
|
||||
</button>
|
||||
))}
|
||||
</div>
|
||||
<div className="flex-1 overflow-auto p-3">
|
||||
{catalogSection === "components" ? (
|
||||
<div className="space-y-3">
|
||||
{catalogData.components.map((comp) => (
|
||||
<div
|
||||
key={comp.name}
|
||||
className="pb-3 border-b border-border last:border-b-0"
|
||||
>
|
||||
<div className="flex items-baseline gap-2 mb-1">
|
||||
<span className="font-mono font-medium text-foreground">
|
||||
{comp.name}
|
||||
</span>
|
||||
{comp.slots.length > 0 && (
|
||||
<span className="text-[10px] font-mono px-1.5 py-0.5 rounded bg-muted text-muted-foreground">
|
||||
slots: {comp.slots.join(", ")}
|
||||
</span>
|
||||
)}
|
||||
</div>
|
||||
{comp.description && (
|
||||
<p className="text-xs text-muted-foreground mb-2">
|
||||
{comp.description}
|
||||
</p>
|
||||
)}
|
||||
{comp.props.length > 0 && (
|
||||
<div className="flex flex-wrap gap-1 mb-1">
|
||||
{comp.props.map((p) => (
|
||||
<span
|
||||
key={p.name}
|
||||
className="text-[11px] font-mono px-1.5 py-0.5 rounded bg-green-500/10 text-green-700 dark:text-green-400"
|
||||
>
|
||||
{p.name}
|
||||
<span className="text-green-700/50 dark:text-green-400/50">
|
||||
: {p.type}
|
||||
</span>
|
||||
</span>
|
||||
))}
|
||||
</div>
|
||||
)}
|
||||
{comp.events.length > 0 && (
|
||||
<div className="flex flex-wrap gap-1 mt-1.5">
|
||||
{comp.events.map((e) => (
|
||||
<span
|
||||
key={e}
|
||||
className="text-[11px] font-mono px-1.5 py-0.5 rounded bg-blue-500/10 text-blue-600 dark:text-blue-400"
|
||||
>
|
||||
on.{e}
|
||||
</span>
|
||||
))}
|
||||
</div>
|
||||
)}
|
||||
</div>
|
||||
))}
|
||||
</div>
|
||||
) : (
|
||||
<div className="space-y-3">
|
||||
{catalogData.actions.map((action) => (
|
||||
<div
|
||||
key={action.name}
|
||||
className="pb-3 border-b border-border last:border-b-0"
|
||||
>
|
||||
<span className="font-mono font-medium text-foreground">
|
||||
{action.name}
|
||||
</span>
|
||||
{action.description && (
|
||||
<p className="text-xs text-muted-foreground mt-1 mb-2">
|
||||
{action.description}
|
||||
</p>
|
||||
)}
|
||||
{action.params.length > 0 && (
|
||||
<div className="flex flex-wrap gap-1">
|
||||
{action.params.map((p) => (
|
||||
<span
|
||||
key={p.name}
|
||||
className="text-[11px] font-mono px-1.5 py-0.5 rounded bg-green-500/10 text-green-700 dark:text-green-400"
|
||||
>
|
||||
{p.name}
|
||||
<span className="text-green-700/50 dark:text-green-400/50">
|
||||
: {p.type}
|
||||
</span>
|
||||
</span>
|
||||
))}
|
||||
</div>
|
||||
)}
|
||||
</div>
|
||||
))}
|
||||
</div>
|
||||
)}
|
||||
</div>
|
||||
</div>
|
||||
) : mobileView === "stream" ? (
|
||||
currentRawLines.length > 0 ? (
|
||||
<CodeBlock
|
||||
code={currentRawLines.join("\n")}
|
||||
lang="json"
|
||||
fillHeight
|
||||
hideCopyButton
|
||||
/>
|
||||
) : (
|
||||
<div className="text-muted-foreground/50 p-3 text-sm font-mono">
|
||||
{isStreaming ? "streaming..." : "// waiting for generation"}
|
||||
</div>
|
||||
)
|
||||
) : mobileView === "nested" ? (
|
||||
<CodeBlock
|
||||
code={nestedCode}
|
||||
lang="json"
|
||||
fillHeight
|
||||
hideCopyButton
|
||||
/>
|
||||
) : mobileView === "json" ? (
|
||||
<CodeBlock code={jsonCode} lang="json" fillHeight hideCopyButton />
|
||||
) : mobileView === "preview" ? (
|
||||
currentTree && currentTree.root ? (
|
||||
<div className="w-full min-h-full flex items-center justify-center p-6">
|
||||
<PlaygroundRenderer
|
||||
spec={currentTree}
|
||||
data={currentTree.state}
|
||||
loading={isStreaming}
|
||||
/>
|
||||
</div>
|
||||
) : (
|
||||
<div className="h-full flex flex-col items-center justify-center text-center px-4">
|
||||
{isStreaming ? (
|
||||
<p className="text-sm text-muted-foreground/50">
|
||||
generating...
|
||||
</p>
|
||||
) : (
|
||||
<>
|
||||
<p className="text-sm text-muted-foreground mb-4">
|
||||
Describe what you want to build, then iterate on it.
|
||||
</p>
|
||||
<div className="flex flex-wrap gap-2 justify-center">
|
||||
{EXAMPLE_PROMPTS.map((prompt) => (
|
||||
<button
|
||||
key={prompt}
|
||||
onMouseDown={(e) => {
|
||||
e.preventDefault();
|
||||
flushSync(() => setInputValue(prompt));
|
||||
mobileInputRef.current?.focus();
|
||||
mobileInputRef.current?.setSelectionRange(
|
||||
prompt.length,
|
||||
prompt.length,
|
||||
);
|
||||
}}
|
||||
className="text-xs px-2 py-1 rounded border border-border text-muted-foreground hover:text-foreground hover:border-foreground/30 transition-colors"
|
||||
>
|
||||
{prompt}
|
||||
</button>
|
||||
))}
|
||||
</div>
|
||||
</>
|
||||
)}
|
||||
</div>
|
||||
)
|
||||
) : (
|
||||
/* generated-code */
|
||||
<CodeBlock
|
||||
code={generatedCode}
|
||||
lang="tsx"
|
||||
fillHeight
|
||||
hideCopyButton
|
||||
/>
|
||||
)}
|
||||
</div>
|
||||
|
||||
{/* Prompt input pinned to bottom */}
|
||||
<div
|
||||
className="border-t border-border p-3 shrink-0 cursor-text"
|
||||
onMouseDown={(e) => {
|
||||
const target = e.target as HTMLElement;
|
||||
if (!target.closest("button") && target.tagName !== "TEXTAREA") {
|
||||
e.preventDefault();
|
||||
mobileInputRef.current?.focus();
|
||||
}
|
||||
}}
|
||||
>
|
||||
<textarea
|
||||
ref={mobileInputRef}
|
||||
value={inputValue}
|
||||
onChange={(e) => setInputValue(e.target.value)}
|
||||
onKeyDown={handleKeyDown}
|
||||
placeholder="Describe changes..."
|
||||
className="w-full bg-background text-base resize-none outline-none placeholder:text-muted-foreground/50"
|
||||
rows={2}
|
||||
/>
|
||||
<div className="flex justify-between items-center mt-2">
|
||||
{versions.length > 0 ? (
|
||||
<button
|
||||
onClick={() => {
|
||||
setVersions([]);
|
||||
setSelectedVersionId(null);
|
||||
clear();
|
||||
}}
|
||||
className="text-xs text-muted-foreground hover:text-foreground transition-colors"
|
||||
>
|
||||
Clear
|
||||
</button>
|
||||
) : (
|
||||
<div />
|
||||
)}
|
||||
{isStreaming ? (
|
||||
<button
|
||||
onClick={() => clear()}
|
||||
className="w-7 h-7 rounded-full bg-primary text-primary-foreground flex items-center justify-center hover:bg-primary/90 transition-colors"
|
||||
aria-label="Stop"
|
||||
>
|
||||
<svg
|
||||
width="14"
|
||||
height="14"
|
||||
viewBox="0 0 24 24"
|
||||
fill="currentColor"
|
||||
stroke="none"
|
||||
>
|
||||
<rect x="6" y="6" width="12" height="12" />
|
||||
</svg>
|
||||
</button>
|
||||
) : (
|
||||
<button
|
||||
onClick={handleSubmit}
|
||||
disabled={!inputValue.trim()}
|
||||
className="w-7 h-7 rounded-full bg-primary text-primary-foreground flex items-center justify-center hover:bg-primary/90 transition-colors disabled:opacity-30"
|
||||
aria-label="Send"
|
||||
>
|
||||
<svg
|
||||
width="14"
|
||||
height="14"
|
||||
viewBox="0 0 24 24"
|
||||
fill="none"
|
||||
stroke="currentColor"
|
||||
strokeWidth="2"
|
||||
strokeLinecap="round"
|
||||
strokeLinejoin="round"
|
||||
>
|
||||
<path d="M5 12h14" />
|
||||
<path d="m12 5 7 7-7 7" />
|
||||
</svg>
|
||||
</button>
|
||||
)}
|
||||
</div>
|
||||
</div>
|
||||
|
||||
{/* Versions sheet */}
|
||||
<Sheet open={versionsSheetOpen} onOpenChange={setVersionsSheetOpen}>
|
||||
<SheetContent>
|
||||
<SheetTitle className="text-sm font-mono mb-4">Versions</SheetTitle>
|
||||
<div className="flex-1 overflow-y-auto space-y-1">
|
||||
{versions.map((version, index) => (
|
||||
<button
|
||||
key={version.id}
|
||||
onClick={() => {
|
||||
setSelectedVersionId(version.id);
|
||||
setVersionsSheetOpen(false);
|
||||
}}
|
||||
className={`w-full text-left px-3 py-2 rounded text-sm transition-colors ${
|
||||
selectedVersionId === version.id
|
||||
? "bg-muted text-foreground"
|
||||
: "text-muted-foreground hover:bg-muted/50 hover:text-foreground"
|
||||
}`}
|
||||
>
|
||||
<div className="flex items-center gap-2">
|
||||
<span className="text-xs font-mono text-muted-foreground/70 shrink-0">
|
||||
v{index + 1}
|
||||
</span>
|
||||
<span className="truncate flex-1">{version.prompt}</span>
|
||||
{version.status === "generating" && (
|
||||
<span className="text-xs text-muted-foreground shrink-0 animate-pulse">
|
||||
...
|
||||
</span>
|
||||
)}
|
||||
{version.status === "error" && (
|
||||
<span className="text-xs text-red-500 shrink-0">
|
||||
failed
|
||||
</span>
|
||||
)}
|
||||
</div>
|
||||
{version.usage && (
|
||||
<div className="flex items-center gap-2 mt-1 ml-6">
|
||||
<span className="text-[10px] font-mono text-muted-foreground/60">
|
||||
{version.usage.totalTokens.toLocaleString()} tokens
|
||||
</span>
|
||||
</div>
|
||||
)}
|
||||
</button>
|
||||
))}
|
||||
{versions.length === 0 && (
|
||||
<p className="text-sm text-muted-foreground px-3">
|
||||
No versions yet. Enter a prompt to get started.
|
||||
</p>
|
||||
)}
|
||||
</div>
|
||||
</SheetContent>
|
||||
</Sheet>
|
||||
</div>
|
||||
|
||||
<Toaster position="bottom-right" />
|
||||
|
||||
@@ -0,0 +1,66 @@
|
||||
"use client";
|
||||
|
||||
import * as React from "react";
|
||||
import { ChevronDownIcon } from "lucide-react";
|
||||
import { Accordion as AccordionPrimitive } from "radix-ui";
|
||||
|
||||
import { cn } from "@/lib/utils";
|
||||
|
||||
function Accordion({
|
||||
...props
|
||||
}: React.ComponentProps<typeof AccordionPrimitive.Root>) {
|
||||
return <AccordionPrimitive.Root data-slot="accordion" {...props} />;
|
||||
}
|
||||
|
||||
function AccordionItem({
|
||||
className,
|
||||
...props
|
||||
}: React.ComponentProps<typeof AccordionPrimitive.Item>) {
|
||||
return (
|
||||
<AccordionPrimitive.Item
|
||||
data-slot="accordion-item"
|
||||
className={cn("border-b last:border-b-0", className)}
|
||||
{...props}
|
||||
/>
|
||||
);
|
||||
}
|
||||
|
||||
function AccordionTrigger({
|
||||
className,
|
||||
children,
|
||||
...props
|
||||
}: React.ComponentProps<typeof AccordionPrimitive.Trigger>) {
|
||||
return (
|
||||
<AccordionPrimitive.Header className="flex">
|
||||
<AccordionPrimitive.Trigger
|
||||
data-slot="accordion-trigger"
|
||||
className={cn(
|
||||
"focus-visible:border-ring focus-visible:ring-ring/50 flex flex-1 items-start justify-between gap-4 rounded-md py-4 text-left text-sm font-medium transition-all outline-none hover:underline focus-visible:ring-[3px] disabled:pointer-events-none disabled:opacity-50 [&[data-state=open]>svg]:rotate-180",
|
||||
className,
|
||||
)}
|
||||
{...props}
|
||||
>
|
||||
{children}
|
||||
<ChevronDownIcon className="text-muted-foreground pointer-events-none size-4 shrink-0 translate-y-0.5 transition-transform duration-200" />
|
||||
</AccordionPrimitive.Trigger>
|
||||
</AccordionPrimitive.Header>
|
||||
);
|
||||
}
|
||||
|
||||
function AccordionContent({
|
||||
className,
|
||||
children,
|
||||
...props
|
||||
}: React.ComponentProps<typeof AccordionPrimitive.Content>) {
|
||||
return (
|
||||
<AccordionPrimitive.Content
|
||||
data-slot="accordion-content"
|
||||
className="data-[state=closed]:animate-accordion-up data-[state=open]:animate-accordion-down overflow-hidden text-sm"
|
||||
{...props}
|
||||
>
|
||||
<div className={cn("pt-0 pb-4", className)}>{children}</div>
|
||||
</AccordionPrimitive.Content>
|
||||
);
|
||||
}
|
||||
|
||||
export { Accordion, AccordionItem, AccordionTrigger, AccordionContent };
|
||||
@@ -1,6 +1,6 @@
|
||||
import * as React from "react";
|
||||
import { Slot } from "@radix-ui/react-slot";
|
||||
import { cva, type VariantProps } from "class-variance-authority";
|
||||
import { Slot } from "radix-ui";
|
||||
|
||||
import { cn } from "@/lib/utils";
|
||||
|
||||
@@ -22,9 +22,11 @@ const buttonVariants = cva(
|
||||
},
|
||||
size: {
|
||||
default: "h-9 px-4 py-2 has-[>svg]:px-3",
|
||||
xs: "h-6 gap-1 rounded-md px-2 text-xs has-[>svg]:px-1.5 [&_svg:not([class*='size-'])]:size-3",
|
||||
sm: "h-8 rounded-md gap-1.5 px-3 has-[>svg]:px-2.5",
|
||||
lg: "h-10 rounded-md px-6 has-[>svg]:px-4",
|
||||
icon: "size-9",
|
||||
"icon-xs": "size-6 rounded-md [&_svg:not([class*='size-'])]:size-3",
|
||||
"icon-sm": "size-8",
|
||||
"icon-lg": "size-10",
|
||||
},
|
||||
@@ -46,7 +48,7 @@ function Button({
|
||||
VariantProps<typeof buttonVariants> & {
|
||||
asChild?: boolean;
|
||||
}) {
|
||||
const Comp = asChild ? Slot : "button";
|
||||
const Comp = asChild ? Slot.Root : "button";
|
||||
|
||||
return (
|
||||
<Comp
|
||||
|
||||
@@ -0,0 +1,241 @@
|
||||
"use client";
|
||||
|
||||
import * as React from "react";
|
||||
import useEmblaCarousel, {
|
||||
type UseEmblaCarouselType,
|
||||
} from "embla-carousel-react";
|
||||
import { ArrowLeft, ArrowRight } from "lucide-react";
|
||||
|
||||
import { cn } from "@/lib/utils";
|
||||
import { Button } from "@/components/ui/button";
|
||||
|
||||
type CarouselApi = UseEmblaCarouselType[1];
|
||||
type UseCarouselParameters = Parameters<typeof useEmblaCarousel>;
|
||||
type CarouselOptions = UseCarouselParameters[0];
|
||||
type CarouselPlugin = UseCarouselParameters[1];
|
||||
|
||||
type CarouselProps = {
|
||||
opts?: CarouselOptions;
|
||||
plugins?: CarouselPlugin;
|
||||
orientation?: "horizontal" | "vertical";
|
||||
setApi?: (api: CarouselApi) => void;
|
||||
};
|
||||
|
||||
type CarouselContextProps = {
|
||||
carouselRef: ReturnType<typeof useEmblaCarousel>[0];
|
||||
api: ReturnType<typeof useEmblaCarousel>[1];
|
||||
scrollPrev: () => void;
|
||||
scrollNext: () => void;
|
||||
canScrollPrev: boolean;
|
||||
canScrollNext: boolean;
|
||||
} & CarouselProps;
|
||||
|
||||
const CarouselContext = React.createContext<CarouselContextProps | null>(null);
|
||||
|
||||
function useCarousel() {
|
||||
const context = React.useContext(CarouselContext);
|
||||
|
||||
if (!context) {
|
||||
throw new Error("useCarousel must be used within a <Carousel />");
|
||||
}
|
||||
|
||||
return context;
|
||||
}
|
||||
|
||||
function Carousel({
|
||||
orientation = "horizontal",
|
||||
opts,
|
||||
setApi,
|
||||
plugins,
|
||||
className,
|
||||
children,
|
||||
...props
|
||||
}: React.ComponentProps<"div"> & CarouselProps) {
|
||||
const [carouselRef, api] = useEmblaCarousel(
|
||||
{
|
||||
...opts,
|
||||
axis: orientation === "horizontal" ? "x" : "y",
|
||||
},
|
||||
plugins,
|
||||
);
|
||||
const [canScrollPrev, setCanScrollPrev] = React.useState(false);
|
||||
const [canScrollNext, setCanScrollNext] = React.useState(false);
|
||||
|
||||
const onSelect = React.useCallback((api: CarouselApi) => {
|
||||
if (!api) return;
|
||||
setCanScrollPrev(api.canScrollPrev());
|
||||
setCanScrollNext(api.canScrollNext());
|
||||
}, []);
|
||||
|
||||
const scrollPrev = React.useCallback(() => {
|
||||
api?.scrollPrev();
|
||||
}, [api]);
|
||||
|
||||
const scrollNext = React.useCallback(() => {
|
||||
api?.scrollNext();
|
||||
}, [api]);
|
||||
|
||||
const handleKeyDown = React.useCallback(
|
||||
(event: React.KeyboardEvent<HTMLDivElement>) => {
|
||||
if (event.key === "ArrowLeft") {
|
||||
event.preventDefault();
|
||||
scrollPrev();
|
||||
} else if (event.key === "ArrowRight") {
|
||||
event.preventDefault();
|
||||
scrollNext();
|
||||
}
|
||||
},
|
||||
[scrollPrev, scrollNext],
|
||||
);
|
||||
|
||||
React.useEffect(() => {
|
||||
if (!api || !setApi) return;
|
||||
setApi(api);
|
||||
}, [api, setApi]);
|
||||
|
||||
React.useEffect(() => {
|
||||
if (!api) return;
|
||||
onSelect(api);
|
||||
api.on("reInit", onSelect);
|
||||
api.on("select", onSelect);
|
||||
|
||||
return () => {
|
||||
api?.off("select", onSelect);
|
||||
};
|
||||
}, [api, onSelect]);
|
||||
|
||||
return (
|
||||
<CarouselContext.Provider
|
||||
value={{
|
||||
carouselRef,
|
||||
api: api,
|
||||
opts,
|
||||
orientation:
|
||||
orientation || (opts?.axis === "y" ? "vertical" : "horizontal"),
|
||||
scrollPrev,
|
||||
scrollNext,
|
||||
canScrollPrev,
|
||||
canScrollNext,
|
||||
}}
|
||||
>
|
||||
<div
|
||||
onKeyDownCapture={handleKeyDown}
|
||||
className={cn("relative", className)}
|
||||
role="region"
|
||||
aria-roledescription="carousel"
|
||||
data-slot="carousel"
|
||||
{...props}
|
||||
>
|
||||
{children}
|
||||
</div>
|
||||
</CarouselContext.Provider>
|
||||
);
|
||||
}
|
||||
|
||||
function CarouselContent({ className, ...props }: React.ComponentProps<"div">) {
|
||||
const { carouselRef, orientation } = useCarousel();
|
||||
|
||||
return (
|
||||
<div
|
||||
ref={carouselRef}
|
||||
className="overflow-hidden"
|
||||
data-slot="carousel-content"
|
||||
>
|
||||
<div
|
||||
className={cn(
|
||||
"flex",
|
||||
orientation === "horizontal" ? "-ml-4" : "-mt-4 flex-col",
|
||||
className,
|
||||
)}
|
||||
{...props}
|
||||
/>
|
||||
</div>
|
||||
);
|
||||
}
|
||||
|
||||
function CarouselItem({ className, ...props }: React.ComponentProps<"div">) {
|
||||
const { orientation } = useCarousel();
|
||||
|
||||
return (
|
||||
<div
|
||||
role="group"
|
||||
aria-roledescription="slide"
|
||||
data-slot="carousel-item"
|
||||
className={cn(
|
||||
"min-w-0 shrink-0 grow-0 basis-full",
|
||||
orientation === "horizontal" ? "pl-4" : "pt-4",
|
||||
className,
|
||||
)}
|
||||
{...props}
|
||||
/>
|
||||
);
|
||||
}
|
||||
|
||||
function CarouselPrevious({
|
||||
className,
|
||||
variant = "outline",
|
||||
size = "icon",
|
||||
...props
|
||||
}: React.ComponentProps<typeof Button>) {
|
||||
const { orientation, scrollPrev, canScrollPrev } = useCarousel();
|
||||
|
||||
return (
|
||||
<Button
|
||||
data-slot="carousel-previous"
|
||||
variant={variant}
|
||||
size={size}
|
||||
className={cn(
|
||||
"absolute size-8 rounded-full",
|
||||
orientation === "horizontal"
|
||||
? "top-1/2 -left-12 -translate-y-1/2"
|
||||
: "-top-12 left-1/2 -translate-x-1/2 rotate-90",
|
||||
className,
|
||||
)}
|
||||
disabled={!canScrollPrev}
|
||||
onClick={scrollPrev}
|
||||
{...props}
|
||||
>
|
||||
<ArrowLeft />
|
||||
<span className="sr-only">Previous slide</span>
|
||||
</Button>
|
||||
);
|
||||
}
|
||||
|
||||
function CarouselNext({
|
||||
className,
|
||||
variant = "outline",
|
||||
size = "icon",
|
||||
...props
|
||||
}: React.ComponentProps<typeof Button>) {
|
||||
const { orientation, scrollNext, canScrollNext } = useCarousel();
|
||||
|
||||
return (
|
||||
<Button
|
||||
data-slot="carousel-next"
|
||||
variant={variant}
|
||||
size={size}
|
||||
className={cn(
|
||||
"absolute size-8 rounded-full",
|
||||
orientation === "horizontal"
|
||||
? "top-1/2 -right-12 -translate-y-1/2"
|
||||
: "-bottom-12 left-1/2 -translate-x-1/2 rotate-90",
|
||||
className,
|
||||
)}
|
||||
disabled={!canScrollNext}
|
||||
onClick={scrollNext}
|
||||
{...props}
|
||||
>
|
||||
<ArrowRight />
|
||||
<span className="sr-only">Next slide</span>
|
||||
</Button>
|
||||
);
|
||||
}
|
||||
|
||||
export {
|
||||
type CarouselApi,
|
||||
Carousel,
|
||||
CarouselContent,
|
||||
CarouselItem,
|
||||
CarouselPrevious,
|
||||
CarouselNext,
|
||||
};
|
||||
@@ -0,0 +1,33 @@
|
||||
"use client";
|
||||
|
||||
import { Collapsible as CollapsiblePrimitive } from "radix-ui";
|
||||
|
||||
function Collapsible({
|
||||
...props
|
||||
}: React.ComponentProps<typeof CollapsiblePrimitive.Root>) {
|
||||
return <CollapsiblePrimitive.Root data-slot="collapsible" {...props} />;
|
||||
}
|
||||
|
||||
function CollapsibleTrigger({
|
||||
...props
|
||||
}: React.ComponentProps<typeof CollapsiblePrimitive.CollapsibleTrigger>) {
|
||||
return (
|
||||
<CollapsiblePrimitive.CollapsibleTrigger
|
||||
data-slot="collapsible-trigger"
|
||||
{...props}
|
||||
/>
|
||||
);
|
||||
}
|
||||
|
||||
function CollapsibleContent({
|
||||
...props
|
||||
}: React.ComponentProps<typeof CollapsiblePrimitive.CollapsibleContent>) {
|
||||
return (
|
||||
<CollapsiblePrimitive.CollapsibleContent
|
||||
data-slot="collapsible-content"
|
||||
{...props}
|
||||
/>
|
||||
);
|
||||
}
|
||||
|
||||
export { Collapsible, CollapsibleTrigger, CollapsibleContent };
|
||||
@@ -0,0 +1,158 @@
|
||||
"use client";
|
||||
|
||||
import * as React from "react";
|
||||
import { XIcon } from "lucide-react";
|
||||
import { Dialog as DialogPrimitive } from "radix-ui";
|
||||
|
||||
import { cn } from "@/lib/utils";
|
||||
import { Button } from "@/components/ui/button";
|
||||
|
||||
function Dialog({
|
||||
...props
|
||||
}: React.ComponentProps<typeof DialogPrimitive.Root>) {
|
||||
return <DialogPrimitive.Root data-slot="dialog" {...props} />;
|
||||
}
|
||||
|
||||
function DialogTrigger({
|
||||
...props
|
||||
}: React.ComponentProps<typeof DialogPrimitive.Trigger>) {
|
||||
return <DialogPrimitive.Trigger data-slot="dialog-trigger" {...props} />;
|
||||
}
|
||||
|
||||
function DialogPortal({
|
||||
...props
|
||||
}: React.ComponentProps<typeof DialogPrimitive.Portal>) {
|
||||
return <DialogPrimitive.Portal data-slot="dialog-portal" {...props} />;
|
||||
}
|
||||
|
||||
function DialogClose({
|
||||
...props
|
||||
}: React.ComponentProps<typeof DialogPrimitive.Close>) {
|
||||
return <DialogPrimitive.Close data-slot="dialog-close" {...props} />;
|
||||
}
|
||||
|
||||
function DialogOverlay({
|
||||
className,
|
||||
...props
|
||||
}: React.ComponentProps<typeof DialogPrimitive.Overlay>) {
|
||||
return (
|
||||
<DialogPrimitive.Overlay
|
||||
data-slot="dialog-overlay"
|
||||
className={cn(
|
||||
"data-[state=open]:animate-in data-[state=closed]:animate-out data-[state=closed]:fade-out-0 data-[state=open]:fade-in-0 fixed inset-0 z-50 bg-black/50",
|
||||
className,
|
||||
)}
|
||||
{...props}
|
||||
/>
|
||||
);
|
||||
}
|
||||
|
||||
function DialogContent({
|
||||
className,
|
||||
children,
|
||||
showCloseButton = true,
|
||||
...props
|
||||
}: React.ComponentProps<typeof DialogPrimitive.Content> & {
|
||||
showCloseButton?: boolean;
|
||||
}) {
|
||||
return (
|
||||
<DialogPortal data-slot="dialog-portal">
|
||||
<DialogOverlay />
|
||||
<DialogPrimitive.Content
|
||||
data-slot="dialog-content"
|
||||
className={cn(
|
||||
"bg-background data-[state=open]:animate-in data-[state=closed]:animate-out data-[state=closed]:fade-out-0 data-[state=open]:fade-in-0 data-[state=closed]:zoom-out-95 data-[state=open]:zoom-in-95 fixed top-[50%] left-[50%] z-50 grid w-full max-w-[calc(100%-2rem)] translate-x-[-50%] translate-y-[-50%] gap-4 rounded-lg border p-6 shadow-lg duration-200 outline-none sm:max-w-lg",
|
||||
className,
|
||||
)}
|
||||
{...props}
|
||||
>
|
||||
{children}
|
||||
{showCloseButton && (
|
||||
<DialogPrimitive.Close
|
||||
data-slot="dialog-close"
|
||||
className="ring-offset-background focus:ring-ring data-[state=open]:bg-accent data-[state=open]:text-muted-foreground absolute top-4 right-4 rounded-xs opacity-70 transition-opacity hover:opacity-100 focus:ring-2 focus:ring-offset-2 focus:outline-hidden disabled:pointer-events-none [&_svg]:pointer-events-none [&_svg]:shrink-0 [&_svg:not([class*='size-'])]:size-4"
|
||||
>
|
||||
<XIcon />
|
||||
<span className="sr-only">Close</span>
|
||||
</DialogPrimitive.Close>
|
||||
)}
|
||||
</DialogPrimitive.Content>
|
||||
</DialogPortal>
|
||||
);
|
||||
}
|
||||
|
||||
function DialogHeader({ className, ...props }: React.ComponentProps<"div">) {
|
||||
return (
|
||||
<div
|
||||
data-slot="dialog-header"
|
||||
className={cn("flex flex-col gap-2 text-center sm:text-left", className)}
|
||||
{...props}
|
||||
/>
|
||||
);
|
||||
}
|
||||
|
||||
function DialogFooter({
|
||||
className,
|
||||
showCloseButton = false,
|
||||
children,
|
||||
...props
|
||||
}: React.ComponentProps<"div"> & {
|
||||
showCloseButton?: boolean;
|
||||
}) {
|
||||
return (
|
||||
<div
|
||||
data-slot="dialog-footer"
|
||||
className={cn(
|
||||
"flex flex-col-reverse gap-2 sm:flex-row sm:justify-end",
|
||||
className,
|
||||
)}
|
||||
{...props}
|
||||
>
|
||||
{children}
|
||||
{showCloseButton && (
|
||||
<DialogPrimitive.Close asChild>
|
||||
<Button variant="outline">Close</Button>
|
||||
</DialogPrimitive.Close>
|
||||
)}
|
||||
</div>
|
||||
);
|
||||
}
|
||||
|
||||
function DialogTitle({
|
||||
className,
|
||||
...props
|
||||
}: React.ComponentProps<typeof DialogPrimitive.Title>) {
|
||||
return (
|
||||
<DialogPrimitive.Title
|
||||
data-slot="dialog-title"
|
||||
className={cn("text-lg leading-none font-semibold", className)}
|
||||
{...props}
|
||||
/>
|
||||
);
|
||||
}
|
||||
|
||||
function DialogDescription({
|
||||
className,
|
||||
...props
|
||||
}: React.ComponentProps<typeof DialogPrimitive.Description>) {
|
||||
return (
|
||||
<DialogPrimitive.Description
|
||||
data-slot="dialog-description"
|
||||
className={cn("text-muted-foreground text-sm", className)}
|
||||
{...props}
|
||||
/>
|
||||
);
|
||||
}
|
||||
|
||||
export {
|
||||
Dialog,
|
||||
DialogClose,
|
||||
DialogContent,
|
||||
DialogDescription,
|
||||
DialogFooter,
|
||||
DialogHeader,
|
||||
DialogOverlay,
|
||||
DialogPortal,
|
||||
DialogTitle,
|
||||
DialogTrigger,
|
||||
};
|
||||
@@ -0,0 +1,135 @@
|
||||
"use client";
|
||||
|
||||
import * as React from "react";
|
||||
import { Drawer as DrawerPrimitive } from "vaul";
|
||||
|
||||
import { cn } from "@/lib/utils";
|
||||
|
||||
function Drawer({
|
||||
...props
|
||||
}: React.ComponentProps<typeof DrawerPrimitive.Root>) {
|
||||
return <DrawerPrimitive.Root data-slot="drawer" {...props} />;
|
||||
}
|
||||
|
||||
function DrawerTrigger({
|
||||
...props
|
||||
}: React.ComponentProps<typeof DrawerPrimitive.Trigger>) {
|
||||
return <DrawerPrimitive.Trigger data-slot="drawer-trigger" {...props} />;
|
||||
}
|
||||
|
||||
function DrawerPortal({
|
||||
...props
|
||||
}: React.ComponentProps<typeof DrawerPrimitive.Portal>) {
|
||||
return <DrawerPrimitive.Portal data-slot="drawer-portal" {...props} />;
|
||||
}
|
||||
|
||||
function DrawerClose({
|
||||
...props
|
||||
}: React.ComponentProps<typeof DrawerPrimitive.Close>) {
|
||||
return <DrawerPrimitive.Close data-slot="drawer-close" {...props} />;
|
||||
}
|
||||
|
||||
function DrawerOverlay({
|
||||
className,
|
||||
...props
|
||||
}: React.ComponentProps<typeof DrawerPrimitive.Overlay>) {
|
||||
return (
|
||||
<DrawerPrimitive.Overlay
|
||||
data-slot="drawer-overlay"
|
||||
className={cn(
|
||||
"data-[state=open]:animate-in data-[state=closed]:animate-out data-[state=closed]:fade-out-0 data-[state=open]:fade-in-0 fixed inset-0 z-50 bg-black/50",
|
||||
className,
|
||||
)}
|
||||
{...props}
|
||||
/>
|
||||
);
|
||||
}
|
||||
|
||||
function DrawerContent({
|
||||
className,
|
||||
children,
|
||||
...props
|
||||
}: React.ComponentProps<typeof DrawerPrimitive.Content>) {
|
||||
return (
|
||||
<DrawerPortal data-slot="drawer-portal">
|
||||
<DrawerOverlay />
|
||||
<DrawerPrimitive.Content
|
||||
data-slot="drawer-content"
|
||||
className={cn(
|
||||
"group/drawer-content bg-background fixed z-50 flex h-auto flex-col",
|
||||
"data-[vaul-drawer-direction=top]:inset-x-0 data-[vaul-drawer-direction=top]:top-0 data-[vaul-drawer-direction=top]:mb-24 data-[vaul-drawer-direction=top]:max-h-[80vh] data-[vaul-drawer-direction=top]:rounded-b-lg data-[vaul-drawer-direction=top]:border-b",
|
||||
"data-[vaul-drawer-direction=bottom]:inset-x-0 data-[vaul-drawer-direction=bottom]:bottom-0 data-[vaul-drawer-direction=bottom]:mt-24 data-[vaul-drawer-direction=bottom]:max-h-[80vh] data-[vaul-drawer-direction=bottom]:rounded-t-lg data-[vaul-drawer-direction=bottom]:border-t",
|
||||
"data-[vaul-drawer-direction=right]:inset-y-0 data-[vaul-drawer-direction=right]:right-0 data-[vaul-drawer-direction=right]:w-3/4 data-[vaul-drawer-direction=right]:border-l data-[vaul-drawer-direction=right]:sm:max-w-sm",
|
||||
"data-[vaul-drawer-direction=left]:inset-y-0 data-[vaul-drawer-direction=left]:left-0 data-[vaul-drawer-direction=left]:w-3/4 data-[vaul-drawer-direction=left]:border-r data-[vaul-drawer-direction=left]:sm:max-w-sm",
|
||||
className,
|
||||
)}
|
||||
{...props}
|
||||
>
|
||||
<div className="bg-muted mx-auto mt-4 hidden h-2 w-[100px] shrink-0 rounded-full group-data-[vaul-drawer-direction=bottom]/drawer-content:block" />
|
||||
{children}
|
||||
</DrawerPrimitive.Content>
|
||||
</DrawerPortal>
|
||||
);
|
||||
}
|
||||
|
||||
function DrawerHeader({ className, ...props }: React.ComponentProps<"div">) {
|
||||
return (
|
||||
<div
|
||||
data-slot="drawer-header"
|
||||
className={cn(
|
||||
"flex flex-col gap-0.5 p-4 group-data-[vaul-drawer-direction=bottom]/drawer-content:text-center group-data-[vaul-drawer-direction=top]/drawer-content:text-center md:gap-1.5 md:text-left",
|
||||
className,
|
||||
)}
|
||||
{...props}
|
||||
/>
|
||||
);
|
||||
}
|
||||
|
||||
function DrawerFooter({ className, ...props }: React.ComponentProps<"div">) {
|
||||
return (
|
||||
<div
|
||||
data-slot="drawer-footer"
|
||||
className={cn("mt-auto flex flex-col gap-2 p-4", className)}
|
||||
{...props}
|
||||
/>
|
||||
);
|
||||
}
|
||||
|
||||
function DrawerTitle({
|
||||
className,
|
||||
...props
|
||||
}: React.ComponentProps<typeof DrawerPrimitive.Title>) {
|
||||
return (
|
||||
<DrawerPrimitive.Title
|
||||
data-slot="drawer-title"
|
||||
className={cn("text-foreground font-semibold", className)}
|
||||
{...props}
|
||||
/>
|
||||
);
|
||||
}
|
||||
|
||||
function DrawerDescription({
|
||||
className,
|
||||
...props
|
||||
}: React.ComponentProps<typeof DrawerPrimitive.Description>) {
|
||||
return (
|
||||
<DrawerPrimitive.Description
|
||||
data-slot="drawer-description"
|
||||
className={cn("text-muted-foreground text-sm", className)}
|
||||
{...props}
|
||||
/>
|
||||
);
|
||||
}
|
||||
|
||||
export {
|
||||
Drawer,
|
||||
DrawerPortal,
|
||||
DrawerOverlay,
|
||||
DrawerTrigger,
|
||||
DrawerClose,
|
||||
DrawerContent,
|
||||
DrawerHeader,
|
||||
DrawerFooter,
|
||||
DrawerTitle,
|
||||
DrawerDescription,
|
||||
};
|
||||
@@ -0,0 +1,257 @@
|
||||
"use client";
|
||||
|
||||
import * as React from "react";
|
||||
import { CheckIcon, ChevronRightIcon, CircleIcon } from "lucide-react";
|
||||
import { DropdownMenu as DropdownMenuPrimitive } from "radix-ui";
|
||||
|
||||
import { cn } from "@/lib/utils";
|
||||
|
||||
function DropdownMenu({
|
||||
...props
|
||||
}: React.ComponentProps<typeof DropdownMenuPrimitive.Root>) {
|
||||
return <DropdownMenuPrimitive.Root data-slot="dropdown-menu" {...props} />;
|
||||
}
|
||||
|
||||
function DropdownMenuPortal({
|
||||
...props
|
||||
}: React.ComponentProps<typeof DropdownMenuPrimitive.Portal>) {
|
||||
return (
|
||||
<DropdownMenuPrimitive.Portal data-slot="dropdown-menu-portal" {...props} />
|
||||
);
|
||||
}
|
||||
|
||||
function DropdownMenuTrigger({
|
||||
...props
|
||||
}: React.ComponentProps<typeof DropdownMenuPrimitive.Trigger>) {
|
||||
return (
|
||||
<DropdownMenuPrimitive.Trigger
|
||||
data-slot="dropdown-menu-trigger"
|
||||
{...props}
|
||||
/>
|
||||
);
|
||||
}
|
||||
|
||||
function DropdownMenuContent({
|
||||
className,
|
||||
sideOffset = 4,
|
||||
...props
|
||||
}: React.ComponentProps<typeof DropdownMenuPrimitive.Content>) {
|
||||
return (
|
||||
<DropdownMenuPrimitive.Portal>
|
||||
<DropdownMenuPrimitive.Content
|
||||
data-slot="dropdown-menu-content"
|
||||
sideOffset={sideOffset}
|
||||
className={cn(
|
||||
"bg-popover text-popover-foreground data-[state=open]:animate-in data-[state=closed]:animate-out data-[state=closed]:fade-out-0 data-[state=open]:fade-in-0 data-[state=closed]:zoom-out-95 data-[state=open]:zoom-in-95 data-[side=bottom]:slide-in-from-top-2 data-[side=left]:slide-in-from-right-2 data-[side=right]:slide-in-from-left-2 data-[side=top]:slide-in-from-bottom-2 z-50 max-h-(--radix-dropdown-menu-content-available-height) min-w-[8rem] origin-(--radix-dropdown-menu-content-transform-origin) overflow-x-hidden overflow-y-auto rounded-md border p-1 shadow-md",
|
||||
className,
|
||||
)}
|
||||
{...props}
|
||||
/>
|
||||
</DropdownMenuPrimitive.Portal>
|
||||
);
|
||||
}
|
||||
|
||||
function DropdownMenuGroup({
|
||||
...props
|
||||
}: React.ComponentProps<typeof DropdownMenuPrimitive.Group>) {
|
||||
return (
|
||||
<DropdownMenuPrimitive.Group data-slot="dropdown-menu-group" {...props} />
|
||||
);
|
||||
}
|
||||
|
||||
function DropdownMenuItem({
|
||||
className,
|
||||
inset,
|
||||
variant = "default",
|
||||
...props
|
||||
}: React.ComponentProps<typeof DropdownMenuPrimitive.Item> & {
|
||||
inset?: boolean;
|
||||
variant?: "default" | "destructive";
|
||||
}) {
|
||||
return (
|
||||
<DropdownMenuPrimitive.Item
|
||||
data-slot="dropdown-menu-item"
|
||||
data-inset={inset}
|
||||
data-variant={variant}
|
||||
className={cn(
|
||||
"focus:bg-accent focus:text-accent-foreground data-[variant=destructive]:text-destructive data-[variant=destructive]:focus:bg-destructive/10 dark:data-[variant=destructive]:focus:bg-destructive/20 data-[variant=destructive]:focus:text-destructive data-[variant=destructive]:*:[svg]:!text-destructive [&_svg:not([class*='text-'])]:text-muted-foreground relative flex cursor-default items-center gap-2 rounded-sm px-2 py-1.5 text-sm outline-hidden select-none data-[disabled]:pointer-events-none data-[disabled]:opacity-50 data-[inset]:pl-8 [&_svg]:pointer-events-none [&_svg]:shrink-0 [&_svg:not([class*='size-'])]:size-4",
|
||||
className,
|
||||
)}
|
||||
{...props}
|
||||
/>
|
||||
);
|
||||
}
|
||||
|
||||
function DropdownMenuCheckboxItem({
|
||||
className,
|
||||
children,
|
||||
checked,
|
||||
...props
|
||||
}: React.ComponentProps<typeof DropdownMenuPrimitive.CheckboxItem>) {
|
||||
return (
|
||||
<DropdownMenuPrimitive.CheckboxItem
|
||||
data-slot="dropdown-menu-checkbox-item"
|
||||
className={cn(
|
||||
"focus:bg-accent focus:text-accent-foreground relative flex cursor-default items-center gap-2 rounded-sm py-1.5 pr-2 pl-8 text-sm outline-hidden select-none data-[disabled]:pointer-events-none data-[disabled]:opacity-50 [&_svg]:pointer-events-none [&_svg]:shrink-0 [&_svg:not([class*='size-'])]:size-4",
|
||||
className,
|
||||
)}
|
||||
checked={checked}
|
||||
{...props}
|
||||
>
|
||||
<span className="pointer-events-none absolute left-2 flex size-3.5 items-center justify-center">
|
||||
<DropdownMenuPrimitive.ItemIndicator>
|
||||
<CheckIcon className="size-4" />
|
||||
</DropdownMenuPrimitive.ItemIndicator>
|
||||
</span>
|
||||
{children}
|
||||
</DropdownMenuPrimitive.CheckboxItem>
|
||||
);
|
||||
}
|
||||
|
||||
function DropdownMenuRadioGroup({
|
||||
...props
|
||||
}: React.ComponentProps<typeof DropdownMenuPrimitive.RadioGroup>) {
|
||||
return (
|
||||
<DropdownMenuPrimitive.RadioGroup
|
||||
data-slot="dropdown-menu-radio-group"
|
||||
{...props}
|
||||
/>
|
||||
);
|
||||
}
|
||||
|
||||
function DropdownMenuRadioItem({
|
||||
className,
|
||||
children,
|
||||
...props
|
||||
}: React.ComponentProps<typeof DropdownMenuPrimitive.RadioItem>) {
|
||||
return (
|
||||
<DropdownMenuPrimitive.RadioItem
|
||||
data-slot="dropdown-menu-radio-item"
|
||||
className={cn(
|
||||
"focus:bg-accent focus:text-accent-foreground relative flex cursor-default items-center gap-2 rounded-sm py-1.5 pr-2 pl-8 text-sm outline-hidden select-none data-[disabled]:pointer-events-none data-[disabled]:opacity-50 [&_svg]:pointer-events-none [&_svg]:shrink-0 [&_svg:not([class*='size-'])]:size-4",
|
||||
className,
|
||||
)}
|
||||
{...props}
|
||||
>
|
||||
<span className="pointer-events-none absolute left-2 flex size-3.5 items-center justify-center">
|
||||
<DropdownMenuPrimitive.ItemIndicator>
|
||||
<CircleIcon className="size-2 fill-current" />
|
||||
</DropdownMenuPrimitive.ItemIndicator>
|
||||
</span>
|
||||
{children}
|
||||
</DropdownMenuPrimitive.RadioItem>
|
||||
);
|
||||
}
|
||||
|
||||
function DropdownMenuLabel({
|
||||
className,
|
||||
inset,
|
||||
...props
|
||||
}: React.ComponentProps<typeof DropdownMenuPrimitive.Label> & {
|
||||
inset?: boolean;
|
||||
}) {
|
||||
return (
|
||||
<DropdownMenuPrimitive.Label
|
||||
data-slot="dropdown-menu-label"
|
||||
data-inset={inset}
|
||||
className={cn(
|
||||
"px-2 py-1.5 text-sm font-medium data-[inset]:pl-8",
|
||||
className,
|
||||
)}
|
||||
{...props}
|
||||
/>
|
||||
);
|
||||
}
|
||||
|
||||
function DropdownMenuSeparator({
|
||||
className,
|
||||
...props
|
||||
}: React.ComponentProps<typeof DropdownMenuPrimitive.Separator>) {
|
||||
return (
|
||||
<DropdownMenuPrimitive.Separator
|
||||
data-slot="dropdown-menu-separator"
|
||||
className={cn("bg-border -mx-1 my-1 h-px", className)}
|
||||
{...props}
|
||||
/>
|
||||
);
|
||||
}
|
||||
|
||||
function DropdownMenuShortcut({
|
||||
className,
|
||||
...props
|
||||
}: React.ComponentProps<"span">) {
|
||||
return (
|
||||
<span
|
||||
data-slot="dropdown-menu-shortcut"
|
||||
className={cn(
|
||||
"text-muted-foreground ml-auto text-xs tracking-widest",
|
||||
className,
|
||||
)}
|
||||
{...props}
|
||||
/>
|
||||
);
|
||||
}
|
||||
|
||||
function DropdownMenuSub({
|
||||
...props
|
||||
}: React.ComponentProps<typeof DropdownMenuPrimitive.Sub>) {
|
||||
return <DropdownMenuPrimitive.Sub data-slot="dropdown-menu-sub" {...props} />;
|
||||
}
|
||||
|
||||
function DropdownMenuSubTrigger({
|
||||
className,
|
||||
inset,
|
||||
children,
|
||||
...props
|
||||
}: React.ComponentProps<typeof DropdownMenuPrimitive.SubTrigger> & {
|
||||
inset?: boolean;
|
||||
}) {
|
||||
return (
|
||||
<DropdownMenuPrimitive.SubTrigger
|
||||
data-slot="dropdown-menu-sub-trigger"
|
||||
data-inset={inset}
|
||||
className={cn(
|
||||
"focus:bg-accent focus:text-accent-foreground data-[state=open]:bg-accent data-[state=open]:text-accent-foreground [&_svg:not([class*='text-'])]:text-muted-foreground flex cursor-default items-center gap-2 rounded-sm px-2 py-1.5 text-sm outline-hidden select-none data-[inset]:pl-8 [&_svg]:pointer-events-none [&_svg]:shrink-0 [&_svg:not([class*='size-'])]:size-4",
|
||||
className,
|
||||
)}
|
||||
{...props}
|
||||
>
|
||||
{children}
|
||||
<ChevronRightIcon className="ml-auto size-4" />
|
||||
</DropdownMenuPrimitive.SubTrigger>
|
||||
);
|
||||
}
|
||||
|
||||
function DropdownMenuSubContent({
|
||||
className,
|
||||
...props
|
||||
}: React.ComponentProps<typeof DropdownMenuPrimitive.SubContent>) {
|
||||
return (
|
||||
<DropdownMenuPrimitive.SubContent
|
||||
data-slot="dropdown-menu-sub-content"
|
||||
className={cn(
|
||||
"bg-popover text-popover-foreground data-[state=open]:animate-in data-[state=closed]:animate-out data-[state=closed]:fade-out-0 data-[state=open]:fade-in-0 data-[state=closed]:zoom-out-95 data-[state=open]:zoom-in-95 data-[side=bottom]:slide-in-from-top-2 data-[side=left]:slide-in-from-right-2 data-[side=right]:slide-in-from-left-2 data-[side=top]:slide-in-from-bottom-2 z-50 min-w-[8rem] origin-(--radix-dropdown-menu-content-transform-origin) overflow-hidden rounded-md border p-1 shadow-lg",
|
||||
className,
|
||||
)}
|
||||
{...props}
|
||||
/>
|
||||
);
|
||||
}
|
||||
|
||||
export {
|
||||
DropdownMenu,
|
||||
DropdownMenuPortal,
|
||||
DropdownMenuTrigger,
|
||||
DropdownMenuContent,
|
||||
DropdownMenuGroup,
|
||||
DropdownMenuLabel,
|
||||
DropdownMenuItem,
|
||||
DropdownMenuCheckboxItem,
|
||||
DropdownMenuRadioGroup,
|
||||
DropdownMenuRadioItem,
|
||||
DropdownMenuSeparator,
|
||||
DropdownMenuShortcut,
|
||||
DropdownMenuSub,
|
||||
DropdownMenuSubTrigger,
|
||||
DropdownMenuSubContent,
|
||||
};
|
||||
@@ -0,0 +1,127 @@
|
||||
import * as React from "react";
|
||||
import {
|
||||
ChevronLeftIcon,
|
||||
ChevronRightIcon,
|
||||
MoreHorizontalIcon,
|
||||
} from "lucide-react";
|
||||
|
||||
import { cn } from "@/lib/utils";
|
||||
import { buttonVariants, type Button } from "@/components/ui/button";
|
||||
|
||||
function Pagination({ className, ...props }: React.ComponentProps<"nav">) {
|
||||
return (
|
||||
<nav
|
||||
role="navigation"
|
||||
aria-label="pagination"
|
||||
data-slot="pagination"
|
||||
className={cn("mx-auto flex w-full justify-center", className)}
|
||||
{...props}
|
||||
/>
|
||||
);
|
||||
}
|
||||
|
||||
function PaginationContent({
|
||||
className,
|
||||
...props
|
||||
}: React.ComponentProps<"ul">) {
|
||||
return (
|
||||
<ul
|
||||
data-slot="pagination-content"
|
||||
className={cn("flex flex-row items-center gap-1", className)}
|
||||
{...props}
|
||||
/>
|
||||
);
|
||||
}
|
||||
|
||||
function PaginationItem({ ...props }: React.ComponentProps<"li">) {
|
||||
return <li data-slot="pagination-item" {...props} />;
|
||||
}
|
||||
|
||||
type PaginationLinkProps = {
|
||||
isActive?: boolean;
|
||||
} & Pick<React.ComponentProps<typeof Button>, "size"> &
|
||||
React.ComponentProps<"a">;
|
||||
|
||||
function PaginationLink({
|
||||
className,
|
||||
isActive,
|
||||
size = "icon",
|
||||
...props
|
||||
}: PaginationLinkProps) {
|
||||
return (
|
||||
<a
|
||||
aria-current={isActive ? "page" : undefined}
|
||||
data-slot="pagination-link"
|
||||
data-active={isActive}
|
||||
className={cn(
|
||||
buttonVariants({
|
||||
variant: isActive ? "outline" : "ghost",
|
||||
size,
|
||||
}),
|
||||
className,
|
||||
)}
|
||||
{...props}
|
||||
/>
|
||||
);
|
||||
}
|
||||
|
||||
function PaginationPrevious({
|
||||
className,
|
||||
...props
|
||||
}: React.ComponentProps<typeof PaginationLink>) {
|
||||
return (
|
||||
<PaginationLink
|
||||
aria-label="Go to previous page"
|
||||
size="default"
|
||||
className={cn("gap-1 px-2.5 sm:pl-2.5", className)}
|
||||
{...props}
|
||||
>
|
||||
<ChevronLeftIcon />
|
||||
<span className="hidden sm:block">Previous</span>
|
||||
</PaginationLink>
|
||||
);
|
||||
}
|
||||
|
||||
function PaginationNext({
|
||||
className,
|
||||
...props
|
||||
}: React.ComponentProps<typeof PaginationLink>) {
|
||||
return (
|
||||
<PaginationLink
|
||||
aria-label="Go to next page"
|
||||
size="default"
|
||||
className={cn("gap-1 px-2.5 sm:pr-2.5", className)}
|
||||
{...props}
|
||||
>
|
||||
<span className="hidden sm:block">Next</span>
|
||||
<ChevronRightIcon />
|
||||
</PaginationLink>
|
||||
);
|
||||
}
|
||||
|
||||
function PaginationEllipsis({
|
||||
className,
|
||||
...props
|
||||
}: React.ComponentProps<"span">) {
|
||||
return (
|
||||
<span
|
||||
aria-hidden
|
||||
data-slot="pagination-ellipsis"
|
||||
className={cn("flex size-9 items-center justify-center", className)}
|
||||
{...props}
|
||||
>
|
||||
<MoreHorizontalIcon className="size-4" />
|
||||
<span className="sr-only">More pages</span>
|
||||
</span>
|
||||
);
|
||||
}
|
||||
|
||||
export {
|
||||
Pagination,
|
||||
PaginationContent,
|
||||
PaginationLink,
|
||||
PaginationItem,
|
||||
PaginationPrevious,
|
||||
PaginationNext,
|
||||
PaginationEllipsis,
|
||||
};
|
||||
@@ -0,0 +1,89 @@
|
||||
"use client";
|
||||
|
||||
import * as React from "react";
|
||||
import { Popover as PopoverPrimitive } from "radix-ui";
|
||||
|
||||
import { cn } from "@/lib/utils";
|
||||
|
||||
function Popover({
|
||||
...props
|
||||
}: React.ComponentProps<typeof PopoverPrimitive.Root>) {
|
||||
return <PopoverPrimitive.Root data-slot="popover" {...props} />;
|
||||
}
|
||||
|
||||
function PopoverTrigger({
|
||||
...props
|
||||
}: React.ComponentProps<typeof PopoverPrimitive.Trigger>) {
|
||||
return <PopoverPrimitive.Trigger data-slot="popover-trigger" {...props} />;
|
||||
}
|
||||
|
||||
function PopoverContent({
|
||||
className,
|
||||
align = "center",
|
||||
sideOffset = 4,
|
||||
...props
|
||||
}: React.ComponentProps<typeof PopoverPrimitive.Content>) {
|
||||
return (
|
||||
<PopoverPrimitive.Portal>
|
||||
<PopoverPrimitive.Content
|
||||
data-slot="popover-content"
|
||||
align={align}
|
||||
sideOffset={sideOffset}
|
||||
className={cn(
|
||||
"bg-popover text-popover-foreground data-[state=open]:animate-in data-[state=closed]:animate-out data-[state=closed]:fade-out-0 data-[state=open]:fade-in-0 data-[state=closed]:zoom-out-95 data-[state=open]:zoom-in-95 data-[side=bottom]:slide-in-from-top-2 data-[side=left]:slide-in-from-right-2 data-[side=right]:slide-in-from-left-2 data-[side=top]:slide-in-from-bottom-2 z-50 w-72 origin-(--radix-popover-content-transform-origin) rounded-md border p-4 shadow-md outline-hidden",
|
||||
className,
|
||||
)}
|
||||
{...props}
|
||||
/>
|
||||
</PopoverPrimitive.Portal>
|
||||
);
|
||||
}
|
||||
|
||||
function PopoverAnchor({
|
||||
...props
|
||||
}: React.ComponentProps<typeof PopoverPrimitive.Anchor>) {
|
||||
return <PopoverPrimitive.Anchor data-slot="popover-anchor" {...props} />;
|
||||
}
|
||||
|
||||
function PopoverHeader({ className, ...props }: React.ComponentProps<"div">) {
|
||||
return (
|
||||
<div
|
||||
data-slot="popover-header"
|
||||
className={cn("flex flex-col gap-1 text-sm", className)}
|
||||
{...props}
|
||||
/>
|
||||
);
|
||||
}
|
||||
|
||||
function PopoverTitle({ className, ...props }: React.ComponentProps<"h2">) {
|
||||
return (
|
||||
<div
|
||||
data-slot="popover-title"
|
||||
className={cn("font-medium", className)}
|
||||
{...props}
|
||||
/>
|
||||
);
|
||||
}
|
||||
|
||||
function PopoverDescription({
|
||||
className,
|
||||
...props
|
||||
}: React.ComponentProps<"p">) {
|
||||
return (
|
||||
<p
|
||||
data-slot="popover-description"
|
||||
className={cn("text-muted-foreground", className)}
|
||||
{...props}
|
||||
/>
|
||||
);
|
||||
}
|
||||
|
||||
export {
|
||||
Popover,
|
||||
PopoverTrigger,
|
||||
PopoverContent,
|
||||
PopoverAnchor,
|
||||
PopoverHeader,
|
||||
PopoverTitle,
|
||||
PopoverDescription,
|
||||
};
|
||||
@@ -18,7 +18,7 @@ const SheetOverlay = React.forwardRef<
|
||||
>(({ className, ...props }, ref) => (
|
||||
<SheetPrimitive.Overlay
|
||||
className={cn(
|
||||
"fixed inset-0 z-50 bg-black/50 data-[state=open]:animate-in data-[state=closed]:animate-out data-[state=closed]:fade-out-0 data-[state=open]:fade-in-0 data-[state=closed]:duration-150 data-[state=open]:duration-150",
|
||||
"fixed inset-0 z-50 bg-black/75 data-[state=open]:animate-in data-[state=closed]:animate-out data-[state=closed]:fade-out-0 data-[state=open]:fade-in-0 data-[state=closed]:duration-150 data-[state=open]:duration-150",
|
||||
className,
|
||||
)}
|
||||
{...props}
|
||||
@@ -27,17 +27,26 @@ const SheetOverlay = React.forwardRef<
|
||||
));
|
||||
SheetOverlay.displayName = SheetPrimitive.Overlay.displayName;
|
||||
|
||||
const sheetSideVariants = {
|
||||
left: "inset-y-0 left-0 h-full w-3/4 max-w-xs border-r data-[state=closed]:slide-out-to-left data-[state=open]:slide-in-from-left",
|
||||
right:
|
||||
"inset-y-0 right-0 h-full w-3/4 max-w-xs data-[state=closed]:slide-out-to-right data-[state=open]:slide-in-from-right",
|
||||
};
|
||||
|
||||
const SheetContent = React.forwardRef<
|
||||
React.ComponentRef<typeof SheetPrimitive.Content>,
|
||||
React.ComponentPropsWithoutRef<typeof SheetPrimitive.Content>
|
||||
>(({ className, children, ...props }, ref) => (
|
||||
React.ComponentPropsWithoutRef<typeof SheetPrimitive.Content> & {
|
||||
side?: "left" | "right";
|
||||
overlayClassName?: string;
|
||||
}
|
||||
>(({ className, children, side = "left", overlayClassName, ...props }, ref) => (
|
||||
<SheetPortal>
|
||||
<SheetOverlay />
|
||||
<SheetOverlay className={overlayClassName} />
|
||||
<SheetPrimitive.Content
|
||||
ref={ref}
|
||||
className={cn(
|
||||
"fixed z-50 gap-4 bg-background p-6 shadow-lg transition ease-in-out data-[state=closed]:duration-150 data-[state=open]:duration-150 data-[state=open]:animate-in data-[state=closed]:animate-out focus:outline-none",
|
||||
"inset-y-0 left-0 h-full w-3/4 max-w-xs border-r data-[state=closed]:slide-out-to-left data-[state=open]:slide-in-from-left",
|
||||
sheetSideVariants[side],
|
||||
className,
|
||||
)}
|
||||
{...props}
|
||||
|
||||
@@ -0,0 +1,13 @@
|
||||
import { cn } from "@/lib/utils";
|
||||
|
||||
function Skeleton({ className, ...props }: React.ComponentProps<"div">) {
|
||||
return (
|
||||
<div
|
||||
data-slot="skeleton"
|
||||
className={cn("bg-accent animate-pulse rounded-md", className)}
|
||||
{...props}
|
||||
/>
|
||||
);
|
||||
}
|
||||
|
||||
export { Skeleton };
|
||||
@@ -0,0 +1,63 @@
|
||||
"use client";
|
||||
|
||||
import * as React from "react";
|
||||
import { Slider as SliderPrimitive } from "radix-ui";
|
||||
|
||||
import { cn } from "@/lib/utils";
|
||||
|
||||
function Slider({
|
||||
className,
|
||||
defaultValue,
|
||||
value,
|
||||
min = 0,
|
||||
max = 100,
|
||||
...props
|
||||
}: React.ComponentProps<typeof SliderPrimitive.Root>) {
|
||||
const _values = React.useMemo(
|
||||
() =>
|
||||
Array.isArray(value)
|
||||
? value
|
||||
: Array.isArray(defaultValue)
|
||||
? defaultValue
|
||||
: [min, max],
|
||||
[value, defaultValue, min, max],
|
||||
);
|
||||
|
||||
return (
|
||||
<SliderPrimitive.Root
|
||||
data-slot="slider"
|
||||
defaultValue={defaultValue}
|
||||
value={value}
|
||||
min={min}
|
||||
max={max}
|
||||
className={cn(
|
||||
"relative flex w-full touch-none items-center select-none data-[disabled]:opacity-50 data-[orientation=vertical]:h-full data-[orientation=vertical]:min-h-44 data-[orientation=vertical]:w-auto data-[orientation=vertical]:flex-col",
|
||||
className,
|
||||
)}
|
||||
{...props}
|
||||
>
|
||||
<SliderPrimitive.Track
|
||||
data-slot="slider-track"
|
||||
className={cn(
|
||||
"bg-muted relative grow overflow-hidden rounded-full data-[orientation=horizontal]:h-1.5 data-[orientation=horizontal]:w-full data-[orientation=vertical]:h-full data-[orientation=vertical]:w-1.5",
|
||||
)}
|
||||
>
|
||||
<SliderPrimitive.Range
|
||||
data-slot="slider-range"
|
||||
className={cn(
|
||||
"bg-primary absolute data-[orientation=horizontal]:h-full data-[orientation=vertical]:w-full",
|
||||
)}
|
||||
/>
|
||||
</SliderPrimitive.Track>
|
||||
{Array.from({ length: _values.length }, (_, index) => (
|
||||
<SliderPrimitive.Thumb
|
||||
data-slot="slider-thumb"
|
||||
key={index}
|
||||
className="border-primary ring-ring/50 block size-4 shrink-0 rounded-full border bg-white shadow-sm transition-[color,box-shadow] hover:ring-4 focus-visible:ring-4 focus-visible:outline-hidden disabled:pointer-events-none disabled:opacity-50"
|
||||
/>
|
||||
))}
|
||||
</SliderPrimitive.Root>
|
||||
);
|
||||
}
|
||||
|
||||
export { Slider };
|
||||
@@ -1,15 +1,29 @@
|
||||
"use client";
|
||||
|
||||
import {
|
||||
CircleCheckIcon,
|
||||
InfoIcon,
|
||||
Loader2Icon,
|
||||
OctagonXIcon,
|
||||
TriangleAlertIcon,
|
||||
} from "lucide-react";
|
||||
import { useTheme } from "next-themes";
|
||||
import { Toaster as Sonner, type ToasterProps } from "sonner";
|
||||
|
||||
const Toaster = ({ ...props }: ToasterProps) => {
|
||||
const { resolvedTheme } = useTheme();
|
||||
const { theme = "system" } = useTheme();
|
||||
|
||||
return (
|
||||
<Sonner
|
||||
theme={resolvedTheme as ToasterProps["theme"]}
|
||||
theme={theme as ToasterProps["theme"]}
|
||||
className="toaster group"
|
||||
icons={{
|
||||
success: <CircleCheckIcon className="size-4" />,
|
||||
info: <InfoIcon className="size-4" />,
|
||||
warning: <TriangleAlertIcon className="size-4" />,
|
||||
error: <OctagonXIcon className="size-4" />,
|
||||
loading: <Loader2Icon className="size-4 animate-spin" />,
|
||||
}}
|
||||
style={
|
||||
{
|
||||
"--normal-bg": "var(--popover)",
|
||||
|
||||
@@ -0,0 +1,116 @@
|
||||
"use client";
|
||||
|
||||
import * as React from "react";
|
||||
|
||||
import { cn } from "@/lib/utils";
|
||||
|
||||
function Table({ className, ...props }: React.ComponentProps<"table">) {
|
||||
return (
|
||||
<div
|
||||
data-slot="table-container"
|
||||
className="relative w-full overflow-x-auto"
|
||||
>
|
||||
<table
|
||||
data-slot="table"
|
||||
className={cn("w-full caption-bottom text-sm", className)}
|
||||
{...props}
|
||||
/>
|
||||
</div>
|
||||
);
|
||||
}
|
||||
|
||||
function TableHeader({ className, ...props }: React.ComponentProps<"thead">) {
|
||||
return (
|
||||
<thead
|
||||
data-slot="table-header"
|
||||
className={cn("[&_tr]:border-b", className)}
|
||||
{...props}
|
||||
/>
|
||||
);
|
||||
}
|
||||
|
||||
function TableBody({ className, ...props }: React.ComponentProps<"tbody">) {
|
||||
return (
|
||||
<tbody
|
||||
data-slot="table-body"
|
||||
className={cn("[&_tr:last-child]:border-0", className)}
|
||||
{...props}
|
||||
/>
|
||||
);
|
||||
}
|
||||
|
||||
function TableFooter({ className, ...props }: React.ComponentProps<"tfoot">) {
|
||||
return (
|
||||
<tfoot
|
||||
data-slot="table-footer"
|
||||
className={cn(
|
||||
"bg-muted/50 border-t font-medium [&>tr]:last:border-b-0",
|
||||
className,
|
||||
)}
|
||||
{...props}
|
||||
/>
|
||||
);
|
||||
}
|
||||
|
||||
function TableRow({ className, ...props }: React.ComponentProps<"tr">) {
|
||||
return (
|
||||
<tr
|
||||
data-slot="table-row"
|
||||
className={cn(
|
||||
"hover:bg-muted/50 data-[state=selected]:bg-muted border-b transition-colors",
|
||||
className,
|
||||
)}
|
||||
{...props}
|
||||
/>
|
||||
);
|
||||
}
|
||||
|
||||
function TableHead({ className, ...props }: React.ComponentProps<"th">) {
|
||||
return (
|
||||
<th
|
||||
data-slot="table-head"
|
||||
className={cn(
|
||||
"text-foreground h-10 px-2 text-left align-middle font-medium whitespace-nowrap [&:has([role=checkbox])]:pr-0 [&>[role=checkbox]]:translate-y-[2px]",
|
||||
className,
|
||||
)}
|
||||
{...props}
|
||||
/>
|
||||
);
|
||||
}
|
||||
|
||||
function TableCell({ className, ...props }: React.ComponentProps<"td">) {
|
||||
return (
|
||||
<td
|
||||
data-slot="table-cell"
|
||||
className={cn(
|
||||
"p-2 align-middle whitespace-nowrap [&:has([role=checkbox])]:pr-0 [&>[role=checkbox]]:translate-y-[2px]",
|
||||
className,
|
||||
)}
|
||||
{...props}
|
||||
/>
|
||||
);
|
||||
}
|
||||
|
||||
function TableCaption({
|
||||
className,
|
||||
...props
|
||||
}: React.ComponentProps<"caption">) {
|
||||
return (
|
||||
<caption
|
||||
data-slot="table-caption"
|
||||
className={cn("text-muted-foreground mt-4 text-sm", className)}
|
||||
{...props}
|
||||
/>
|
||||
);
|
||||
}
|
||||
|
||||
export {
|
||||
Table,
|
||||
TableHeader,
|
||||
TableBody,
|
||||
TableFooter,
|
||||
TableHead,
|
||||
TableRow,
|
||||
TableCell,
|
||||
TableCaption,
|
||||
};
|
||||
@@ -0,0 +1,83 @@
|
||||
"use client";
|
||||
|
||||
import * as React from "react";
|
||||
import { type VariantProps } from "class-variance-authority";
|
||||
import { ToggleGroup as ToggleGroupPrimitive } from "radix-ui";
|
||||
|
||||
import { cn } from "@/lib/utils";
|
||||
import { toggleVariants } from "@/components/ui/toggle";
|
||||
|
||||
const ToggleGroupContext = React.createContext<
|
||||
VariantProps<typeof toggleVariants> & {
|
||||
spacing?: number;
|
||||
}
|
||||
>({
|
||||
size: "default",
|
||||
variant: "default",
|
||||
spacing: 0,
|
||||
});
|
||||
|
||||
function ToggleGroup({
|
||||
className,
|
||||
variant,
|
||||
size,
|
||||
spacing = 0,
|
||||
children,
|
||||
...props
|
||||
}: React.ComponentProps<typeof ToggleGroupPrimitive.Root> &
|
||||
VariantProps<typeof toggleVariants> & {
|
||||
spacing?: number;
|
||||
}) {
|
||||
return (
|
||||
<ToggleGroupPrimitive.Root
|
||||
data-slot="toggle-group"
|
||||
data-variant={variant}
|
||||
data-size={size}
|
||||
data-spacing={spacing}
|
||||
style={{ "--gap": spacing } as React.CSSProperties}
|
||||
className={cn(
|
||||
"group/toggle-group flex w-fit items-center gap-[--spacing(var(--gap))] rounded-md data-[spacing=default]:data-[variant=outline]:shadow-xs",
|
||||
className,
|
||||
)}
|
||||
{...props}
|
||||
>
|
||||
<ToggleGroupContext.Provider value={{ variant, size, spacing }}>
|
||||
{children}
|
||||
</ToggleGroupContext.Provider>
|
||||
</ToggleGroupPrimitive.Root>
|
||||
);
|
||||
}
|
||||
|
||||
function ToggleGroupItem({
|
||||
className,
|
||||
children,
|
||||
variant,
|
||||
size,
|
||||
...props
|
||||
}: React.ComponentProps<typeof ToggleGroupPrimitive.Item> &
|
||||
VariantProps<typeof toggleVariants>) {
|
||||
const context = React.useContext(ToggleGroupContext);
|
||||
|
||||
return (
|
||||
<ToggleGroupPrimitive.Item
|
||||
data-slot="toggle-group-item"
|
||||
data-variant={context.variant || variant}
|
||||
data-size={context.size || size}
|
||||
data-spacing={context.spacing}
|
||||
className={cn(
|
||||
toggleVariants({
|
||||
variant: context.variant || variant,
|
||||
size: context.size || size,
|
||||
}),
|
||||
"w-auto min-w-0 shrink-0 px-3 focus:z-10 focus-visible:z-10",
|
||||
"data-[spacing=0]:rounded-none data-[spacing=0]:shadow-none data-[spacing=0]:first:rounded-l-md data-[spacing=0]:last:rounded-r-md data-[spacing=0]:data-[variant=outline]:border-l-0 data-[spacing=0]:data-[variant=outline]:first:border-l",
|
||||
className,
|
||||
)}
|
||||
{...props}
|
||||
>
|
||||
{children}
|
||||
</ToggleGroupPrimitive.Item>
|
||||
);
|
||||
}
|
||||
|
||||
export { ToggleGroup, ToggleGroupItem };
|
||||
@@ -0,0 +1,47 @@
|
||||
"use client";
|
||||
|
||||
import * as React from "react";
|
||||
import { cva, type VariantProps } from "class-variance-authority";
|
||||
import { Toggle as TogglePrimitive } from "radix-ui";
|
||||
|
||||
import { cn } from "@/lib/utils";
|
||||
|
||||
const toggleVariants = cva(
|
||||
"inline-flex items-center justify-center gap-2 rounded-md text-sm font-medium hover:bg-muted hover:text-muted-foreground disabled:pointer-events-none disabled:opacity-50 data-[state=on]:bg-accent data-[state=on]:text-accent-foreground [&_svg]:pointer-events-none [&_svg:not([class*='size-'])]:size-4 [&_svg]:shrink-0 focus-visible:border-ring focus-visible:ring-ring/50 focus-visible:ring-[3px] outline-none transition-[color,box-shadow] aria-invalid:ring-destructive/20 dark:aria-invalid:ring-destructive/40 aria-invalid:border-destructive whitespace-nowrap",
|
||||
{
|
||||
variants: {
|
||||
variant: {
|
||||
default: "bg-transparent",
|
||||
outline:
|
||||
"border border-input bg-transparent shadow-xs hover:bg-accent hover:text-accent-foreground",
|
||||
},
|
||||
size: {
|
||||
default: "h-9 px-2 min-w-9",
|
||||
sm: "h-8 px-1.5 min-w-8",
|
||||
lg: "h-10 px-2.5 min-w-10",
|
||||
},
|
||||
},
|
||||
defaultVariants: {
|
||||
variant: "default",
|
||||
size: "default",
|
||||
},
|
||||
},
|
||||
);
|
||||
|
||||
function Toggle({
|
||||
className,
|
||||
variant,
|
||||
size,
|
||||
...props
|
||||
}: React.ComponentProps<typeof TogglePrimitive.Root> &
|
||||
VariantProps<typeof toggleVariants>) {
|
||||
return (
|
||||
<TogglePrimitive.Root
|
||||
data-slot="toggle"
|
||||
className={cn(toggleVariants({ variant, size, className }))}
|
||||
{...props}
|
||||
/>
|
||||
);
|
||||
}
|
||||
|
||||
export { Toggle, toggleVariants };
|
||||
@@ -0,0 +1,57 @@
|
||||
"use client";
|
||||
|
||||
import * as React from "react";
|
||||
import { Tooltip as TooltipPrimitive } from "radix-ui";
|
||||
|
||||
import { cn } from "@/lib/utils";
|
||||
|
||||
function TooltipProvider({
|
||||
delayDuration = 0,
|
||||
...props
|
||||
}: React.ComponentProps<typeof TooltipPrimitive.Provider>) {
|
||||
return (
|
||||
<TooltipPrimitive.Provider
|
||||
data-slot="tooltip-provider"
|
||||
delayDuration={delayDuration}
|
||||
{...props}
|
||||
/>
|
||||
);
|
||||
}
|
||||
|
||||
function Tooltip({
|
||||
...props
|
||||
}: React.ComponentProps<typeof TooltipPrimitive.Root>) {
|
||||
return <TooltipPrimitive.Root data-slot="tooltip" {...props} />;
|
||||
}
|
||||
|
||||
function TooltipTrigger({
|
||||
...props
|
||||
}: React.ComponentProps<typeof TooltipPrimitive.Trigger>) {
|
||||
return <TooltipPrimitive.Trigger data-slot="tooltip-trigger" {...props} />;
|
||||
}
|
||||
|
||||
function TooltipContent({
|
||||
className,
|
||||
sideOffset = 0,
|
||||
children,
|
||||
...props
|
||||
}: React.ComponentProps<typeof TooltipPrimitive.Content>) {
|
||||
return (
|
||||
<TooltipPrimitive.Portal>
|
||||
<TooltipPrimitive.Content
|
||||
data-slot="tooltip-content"
|
||||
sideOffset={sideOffset}
|
||||
className={cn(
|
||||
"bg-foreground text-background animate-in fade-in-0 zoom-in-95 data-[state=closed]:animate-out data-[state=closed]:fade-out-0 data-[state=closed]:zoom-out-95 data-[side=bottom]:slide-in-from-top-2 data-[side=left]:slide-in-from-right-2 data-[side=right]:slide-in-from-left-2 data-[side=top]:slide-in-from-bottom-2 z-50 w-fit origin-(--radix-tooltip-content-transform-origin) rounded-md px-3 py-1.5 text-xs text-balance",
|
||||
className,
|
||||
)}
|
||||
{...props}
|
||||
>
|
||||
{children}
|
||||
<TooltipPrimitive.Arrow className="bg-foreground fill-foreground z-50 size-2.5 translate-y-[calc(-50%_-_2px)] rotate-45 rounded-[2px]" />
|
||||
</TooltipPrimitive.Content>
|
||||
</TooltipPrimitive.Portal>
|
||||
);
|
||||
}
|
||||
|
||||
export { Tooltip, TooltipTrigger, TooltipContent, TooltipProvider };
|
||||
@@ -1,4 +1,4 @@
|
||||
import { nextJsConfig } from "@repo/eslint-config/next-js";
|
||||
import { nextJsConfig } from "@internal/eslint-config/next-js";
|
||||
|
||||
/** @type {import("eslint").Linter.Config[]} */
|
||||
export default [
|
||||
|
||||
@@ -1,266 +0,0 @@
|
||||
import { defineCatalog } from "@json-render/core";
|
||||
import { schema } from "@json-render/react/schema";
|
||||
import { z } from "zod";
|
||||
|
||||
/**
|
||||
* Web playground component catalog
|
||||
*
|
||||
* This defines the components available for AI generation in the playground.
|
||||
* Components map to implementations in lib/catalog/components.tsx
|
||||
* Actions map to handlers in lib/catalog/actions.ts
|
||||
*/
|
||||
export const playgroundCatalog = defineCatalog(schema, {
|
||||
components: {
|
||||
// Layout Components
|
||||
Card: {
|
||||
props: z.object({
|
||||
title: z.string().nullable(),
|
||||
description: z.string().nullable(),
|
||||
maxWidth: z.enum(["sm", "md", "lg", "full"]).nullable(),
|
||||
centered: z.boolean().nullable(),
|
||||
}),
|
||||
slots: ["default"],
|
||||
description:
|
||||
"Container card for content sections. Use for forms/content boxes, NOT for page headers.",
|
||||
},
|
||||
|
||||
Stack: {
|
||||
props: z.object({
|
||||
direction: z.enum(["horizontal", "vertical"]).nullable(),
|
||||
gap: z.enum(["none", "sm", "md", "lg"]).nullable(),
|
||||
align: z.enum(["start", "center", "end", "stretch"]).nullable(),
|
||||
justify: z
|
||||
.enum(["start", "center", "end", "between", "around"])
|
||||
.nullable(),
|
||||
}),
|
||||
slots: ["default"],
|
||||
description: "Flex container for layouts",
|
||||
},
|
||||
|
||||
Grid: {
|
||||
props: z.object({
|
||||
columns: z
|
||||
.union([
|
||||
z.literal(1),
|
||||
z.literal(2),
|
||||
z.literal(3),
|
||||
z.literal(4),
|
||||
z.literal(5),
|
||||
z.literal(6),
|
||||
])
|
||||
.nullable(),
|
||||
gap: z.enum(["sm", "md", "lg"]).nullable(),
|
||||
}),
|
||||
slots: ["default"],
|
||||
description: "Grid layout (1-6 columns)",
|
||||
},
|
||||
|
||||
Divider: {
|
||||
props: z.object({}),
|
||||
description: "Horizontal separator line",
|
||||
},
|
||||
|
||||
// Form Inputs
|
||||
Input: {
|
||||
props: z.object({
|
||||
label: z.string(),
|
||||
name: z.string(),
|
||||
type: z.enum(["text", "email", "password", "number"]).nullable(),
|
||||
placeholder: z.string().nullable(),
|
||||
}),
|
||||
description: "Text input field",
|
||||
},
|
||||
|
||||
Textarea: {
|
||||
props: z.object({
|
||||
label: z.string(),
|
||||
name: z.string(),
|
||||
placeholder: z.string().nullable(),
|
||||
rows: z.number().nullable(),
|
||||
}),
|
||||
description: "Multi-line text input",
|
||||
},
|
||||
|
||||
Select: {
|
||||
props: z.object({
|
||||
label: z.string(),
|
||||
name: z.string(),
|
||||
options: z.array(z.string()),
|
||||
placeholder: z.string().nullable(),
|
||||
}),
|
||||
description: "Dropdown select input",
|
||||
},
|
||||
|
||||
Checkbox: {
|
||||
props: z.object({
|
||||
label: z.string(),
|
||||
name: z.string(),
|
||||
checked: z.boolean().nullable(),
|
||||
}),
|
||||
description: "Checkbox input",
|
||||
},
|
||||
|
||||
Radio: {
|
||||
props: z.object({
|
||||
label: z.string(),
|
||||
name: z.string(),
|
||||
options: z.array(z.string()),
|
||||
}),
|
||||
description: "Radio button group",
|
||||
},
|
||||
|
||||
Switch: {
|
||||
props: z.object({
|
||||
label: z.string(),
|
||||
name: z.string(),
|
||||
checked: z.boolean().nullable(),
|
||||
}),
|
||||
description: "Toggle switch input",
|
||||
},
|
||||
|
||||
// Actions
|
||||
Button: {
|
||||
props: z.object({
|
||||
label: z.string(),
|
||||
variant: z.enum(["primary", "secondary", "danger"]).nullable(),
|
||||
action: z.string().nullable(),
|
||||
actionParams: z.record(z.string(), z.unknown()).nullable(),
|
||||
}),
|
||||
description:
|
||||
"Clickable button. Use action to specify the action name and actionParams for parameters.",
|
||||
},
|
||||
|
||||
Link: {
|
||||
props: z.object({
|
||||
label: z.string(),
|
||||
href: z.string(),
|
||||
}),
|
||||
description: "Anchor link",
|
||||
},
|
||||
|
||||
// Typography
|
||||
Heading: {
|
||||
props: z.object({
|
||||
text: z.string(),
|
||||
level: z.enum(["h1", "h2", "h3", "h4"]).nullable(),
|
||||
}),
|
||||
description: "Heading text (h1-h4)",
|
||||
},
|
||||
|
||||
Text: {
|
||||
props: z.object({
|
||||
text: z.string(),
|
||||
variant: z.enum(["body", "caption", "muted"]).nullable(),
|
||||
}),
|
||||
description: "Paragraph text",
|
||||
},
|
||||
|
||||
// Data Display
|
||||
Image: {
|
||||
props: z.object({
|
||||
alt: z.string(),
|
||||
width: z.number().nullable(),
|
||||
height: z.number().nullable(),
|
||||
}),
|
||||
description: "Placeholder image (displays alt text in a styled box)",
|
||||
},
|
||||
|
||||
Avatar: {
|
||||
props: z.object({
|
||||
src: z.string().nullable(),
|
||||
name: z.string(),
|
||||
size: z.enum(["sm", "md", "lg"]).nullable(),
|
||||
}),
|
||||
description: "User avatar with fallback initials",
|
||||
},
|
||||
|
||||
Badge: {
|
||||
props: z.object({
|
||||
text: z.string(),
|
||||
variant: z.enum(["default", "success", "warning", "danger"]).nullable(),
|
||||
}),
|
||||
description: "Status badge",
|
||||
},
|
||||
|
||||
Alert: {
|
||||
props: z.object({
|
||||
title: z.string(),
|
||||
message: z.string().nullable(),
|
||||
type: z.enum(["info", "success", "warning", "error"]).nullable(),
|
||||
}),
|
||||
description: "Alert banner",
|
||||
},
|
||||
|
||||
Progress: {
|
||||
props: z.object({
|
||||
value: z.number(),
|
||||
max: z.number().nullable(),
|
||||
label: z.string().nullable(),
|
||||
}),
|
||||
description: "Progress bar (value 0-100)",
|
||||
},
|
||||
|
||||
Rating: {
|
||||
props: z.object({
|
||||
value: z.number(),
|
||||
max: z.number().nullable(),
|
||||
label: z.string().nullable(),
|
||||
}),
|
||||
description: "Star rating display",
|
||||
},
|
||||
|
||||
// Charts
|
||||
BarGraph: {
|
||||
props: z.object({
|
||||
title: z.string().nullable(),
|
||||
data: z.array(
|
||||
z.object({
|
||||
label: z.string(),
|
||||
value: z.number(),
|
||||
}),
|
||||
),
|
||||
}),
|
||||
description: "Vertical bar chart",
|
||||
},
|
||||
|
||||
LineGraph: {
|
||||
props: z.object({
|
||||
title: z.string().nullable(),
|
||||
data: z.array(
|
||||
z.object({
|
||||
label: z.string(),
|
||||
value: z.number(),
|
||||
}),
|
||||
),
|
||||
}),
|
||||
description: "Line chart with points",
|
||||
},
|
||||
},
|
||||
|
||||
actions: {
|
||||
// Demo actions for the playground
|
||||
buttonClick: {
|
||||
params: z.object({
|
||||
message: z.string().nullable(),
|
||||
}),
|
||||
description:
|
||||
"Triggered when a button is clicked. Shows a toast with the message.",
|
||||
},
|
||||
|
||||
formSubmit: {
|
||||
params: z.object({
|
||||
formName: z.string().nullable(),
|
||||
}),
|
||||
description:
|
||||
"Triggered when a form is submitted. Shows a toast confirming submission.",
|
||||
},
|
||||
|
||||
linkClick: {
|
||||
params: z.object({
|
||||
href: z.string(),
|
||||
}),
|
||||
description:
|
||||
"Triggered when a link is clicked. Shows a toast with the destination.",
|
||||
},
|
||||
},
|
||||
});
|
||||
@@ -1,47 +0,0 @@
|
||||
import { toast } from "sonner";
|
||||
|
||||
type ActionHandler = (
|
||||
params: Record<string, unknown> | undefined,
|
||||
) => Promise<void>;
|
||||
|
||||
/**
|
||||
* Demo action handlers for the playground
|
||||
*
|
||||
* These show toast notifications to demonstrate actions work.
|
||||
* In a real app, these would call APIs or perform state updates.
|
||||
*/
|
||||
export const actionHandlers: Record<string, ActionHandler> = {
|
||||
buttonClick: async (params) => {
|
||||
const message = (params?.message as string) || "Button clicked!";
|
||||
toast.success(message);
|
||||
},
|
||||
|
||||
formSubmit: async (params) => {
|
||||
const formName = (params?.formName as string) || "Form";
|
||||
toast.success(`${formName} submitted successfully!`);
|
||||
},
|
||||
|
||||
linkClick: async (params) => {
|
||||
const href = (params?.href as string) || "#";
|
||||
toast.info(`Navigating to: ${href}`);
|
||||
},
|
||||
};
|
||||
|
||||
/**
|
||||
* Execute an action by name with the given parameters
|
||||
*/
|
||||
export async function executeAction(
|
||||
actionName: string,
|
||||
params?: Record<string, unknown>,
|
||||
): Promise<void> {
|
||||
const handler = actionHandlers[actionName];
|
||||
|
||||
if (handler) {
|
||||
await handler(params);
|
||||
} else {
|
||||
// Fallback for unknown actions - just show a toast
|
||||
toast.info(`Action: ${actionName}`, {
|
||||
description: params ? JSON.stringify(params) : undefined,
|
||||
});
|
||||
}
|
||||
}
|
||||
@@ -1,588 +0,0 @@
|
||||
"use client";
|
||||
|
||||
import { useState, type ReactNode } from "react";
|
||||
import type { z } from "zod";
|
||||
|
||||
// shadcn components
|
||||
import { Button } from "@/components/ui/button";
|
||||
import { Input } from "@/components/ui/input";
|
||||
import { Label } from "@/components/ui/label";
|
||||
import { Textarea } from "@/components/ui/textarea";
|
||||
import { Checkbox } from "@/components/ui/checkbox";
|
||||
import { Switch } from "@/components/ui/switch";
|
||||
import { Progress } from "@/components/ui/progress";
|
||||
import { Separator } from "@/components/ui/separator";
|
||||
import { Alert, AlertTitle, AlertDescription } from "@/components/ui/alert";
|
||||
import { Badge } from "@/components/ui/badge";
|
||||
import { RadioGroup, RadioGroupItem } from "@/components/ui/radio-group";
|
||||
import {
|
||||
Select,
|
||||
SelectContent,
|
||||
SelectItem,
|
||||
SelectTrigger,
|
||||
SelectValue,
|
||||
} from "@/components/ui/select";
|
||||
|
||||
import { playgroundCatalog } from "../catalog";
|
||||
|
||||
// =============================================================================
|
||||
// Types - Inferred from Catalog
|
||||
// =============================================================================
|
||||
|
||||
type CatalogComponents = typeof playgroundCatalog.data.components;
|
||||
|
||||
export type InferProps<K extends keyof CatalogComponents> =
|
||||
CatalogComponents[K] extends { props: z.ZodType<infer P> } ? P : never;
|
||||
|
||||
export interface ComponentContext<K extends keyof CatalogComponents> {
|
||||
props: InferProps<K>;
|
||||
children?: ReactNode;
|
||||
onAction?: (action: {
|
||||
name: string;
|
||||
params?: Record<string, unknown>;
|
||||
}) => void;
|
||||
loading?: boolean;
|
||||
}
|
||||
|
||||
export type ComponentFn<K extends keyof CatalogComponents> = (
|
||||
ctx: ComponentContext<K>,
|
||||
) => ReactNode;
|
||||
|
||||
// =============================================================================
|
||||
// Components - Type-safe with Catalog using shadcn/ui
|
||||
// =============================================================================
|
||||
|
||||
export const components: { [K in keyof CatalogComponents]: ComponentFn<K> } = {
|
||||
// Layout Components
|
||||
Card: ({ props, children }) => {
|
||||
const maxWidthClass =
|
||||
props.maxWidth === "sm"
|
||||
? "max-w-xs sm:min-w-[280px]"
|
||||
: props.maxWidth === "md"
|
||||
? "max-w-sm sm:min-w-[320px]"
|
||||
: props.maxWidth === "lg"
|
||||
? "max-w-md sm:min-w-[360px]"
|
||||
: "w-full";
|
||||
const centeredClass = props.centered ? "mx-auto" : "";
|
||||
|
||||
return (
|
||||
<div
|
||||
className={`border border-border rounded-lg p-4 bg-card text-card-foreground overflow-hidden ${maxWidthClass} ${centeredClass}`}
|
||||
>
|
||||
{props.title && (
|
||||
<div className="font-semibold text-sm mb-1 text-left">
|
||||
{props.title}
|
||||
</div>
|
||||
)}
|
||||
{props.description && (
|
||||
<div className="text-xs text-muted-foreground mb-3 text-left">
|
||||
{props.description}
|
||||
</div>
|
||||
)}
|
||||
<div className="space-y-3">{children}</div>
|
||||
</div>
|
||||
);
|
||||
},
|
||||
|
||||
Stack: ({ props, children }) => {
|
||||
const isHorizontal = props.direction === "horizontal";
|
||||
|
||||
const gapClass =
|
||||
props.gap === "lg"
|
||||
? "gap-4"
|
||||
: props.gap === "md"
|
||||
? "gap-3"
|
||||
: props.gap === "sm"
|
||||
? "gap-2"
|
||||
: props.gap === "none"
|
||||
? "gap-0"
|
||||
: "gap-3";
|
||||
|
||||
const alignClass =
|
||||
props.align === "center"
|
||||
? "items-center"
|
||||
: props.align === "end"
|
||||
? "items-end"
|
||||
: props.align === "stretch"
|
||||
? "items-stretch"
|
||||
: "items-start";
|
||||
|
||||
const justifyClass =
|
||||
props.justify === "center"
|
||||
? "justify-center"
|
||||
: props.justify === "end"
|
||||
? "justify-end"
|
||||
: props.justify === "between"
|
||||
? "justify-between"
|
||||
: props.justify === "around"
|
||||
? "justify-around"
|
||||
: "";
|
||||
|
||||
return (
|
||||
<div
|
||||
className={`flex ${isHorizontal ? "flex-row flex-wrap" : "flex-col"} ${gapClass} ${alignClass} ${justifyClass}`}
|
||||
>
|
||||
{children}
|
||||
</div>
|
||||
);
|
||||
},
|
||||
|
||||
Grid: ({ props, children }) => {
|
||||
const cols =
|
||||
props.columns === 6
|
||||
? "grid-cols-6"
|
||||
: props.columns === 5
|
||||
? "grid-cols-5"
|
||||
: props.columns === 4
|
||||
? "grid-cols-4"
|
||||
: props.columns === 3
|
||||
? "grid-cols-3"
|
||||
: props.columns === 2
|
||||
? "grid-cols-2"
|
||||
: "grid-cols-1";
|
||||
const gridGap =
|
||||
props.gap === "lg" ? "gap-4" : props.gap === "sm" ? "gap-2" : "gap-3";
|
||||
|
||||
return <div className={`grid ${cols} ${gridGap}`}>{children}</div>;
|
||||
},
|
||||
|
||||
Divider: () => <Separator className="my-3" />,
|
||||
|
||||
// Form Inputs
|
||||
Input: ({ props }) => (
|
||||
<div className="space-y-2">
|
||||
<Label htmlFor={props.name}>{props.label}</Label>
|
||||
<Input
|
||||
id={props.name}
|
||||
name={props.name}
|
||||
type={props.type ?? "text"}
|
||||
placeholder={props.placeholder ?? ""}
|
||||
/>
|
||||
</div>
|
||||
),
|
||||
|
||||
Textarea: ({ props }) => (
|
||||
<div className="space-y-2">
|
||||
<Label htmlFor={props.name}>{props.label}</Label>
|
||||
<Textarea
|
||||
id={props.name}
|
||||
name={props.name}
|
||||
placeholder={props.placeholder ?? ""}
|
||||
rows={props.rows ?? 3}
|
||||
/>
|
||||
</div>
|
||||
),
|
||||
|
||||
Select: ({ props }) => {
|
||||
const [value, setValue] = useState<string>("");
|
||||
|
||||
return (
|
||||
<div className="space-y-2">
|
||||
<Label>{props.label}</Label>
|
||||
<Select value={value} onValueChange={setValue}>
|
||||
<SelectTrigger className="w-full">
|
||||
<SelectValue placeholder={props.placeholder ?? "Select..."} />
|
||||
</SelectTrigger>
|
||||
<SelectContent>
|
||||
{props.options.map((opt) => (
|
||||
<SelectItem key={opt} value={opt}>
|
||||
{opt}
|
||||
</SelectItem>
|
||||
))}
|
||||
</SelectContent>
|
||||
</Select>
|
||||
</div>
|
||||
);
|
||||
},
|
||||
|
||||
Checkbox: ({ props }) => {
|
||||
const [checked, setChecked] = useState(!!props.checked);
|
||||
|
||||
return (
|
||||
<div className="flex items-center space-x-2">
|
||||
<Checkbox
|
||||
id={props.name}
|
||||
checked={checked}
|
||||
onCheckedChange={(c) => setChecked(c === true)}
|
||||
/>
|
||||
<Label htmlFor={props.name} className="cursor-pointer">
|
||||
{props.label}
|
||||
</Label>
|
||||
</div>
|
||||
);
|
||||
},
|
||||
|
||||
Radio: ({ props }) => {
|
||||
const [value, setValue] = useState(props.options[0] ?? "");
|
||||
|
||||
return (
|
||||
<div className="space-y-2">
|
||||
{props.label && <Label>{props.label}</Label>}
|
||||
<RadioGroup value={value} onValueChange={setValue}>
|
||||
{props.options.map((opt) => (
|
||||
<div key={opt} className="flex items-center space-x-2">
|
||||
<RadioGroupItem value={opt} id={`${props.name}-${opt}`} />
|
||||
<Label
|
||||
htmlFor={`${props.name}-${opt}`}
|
||||
className="cursor-pointer"
|
||||
>
|
||||
{opt}
|
||||
</Label>
|
||||
</div>
|
||||
))}
|
||||
</RadioGroup>
|
||||
</div>
|
||||
);
|
||||
},
|
||||
|
||||
Switch: ({ props }) => {
|
||||
const [checked, setChecked] = useState(!!props.checked);
|
||||
|
||||
return (
|
||||
<div className="flex items-center justify-between space-x-2">
|
||||
<Label htmlFor={props.name} className="cursor-pointer">
|
||||
{props.label}
|
||||
</Label>
|
||||
<Switch
|
||||
id={props.name}
|
||||
checked={checked}
|
||||
onCheckedChange={setChecked}
|
||||
/>
|
||||
</div>
|
||||
);
|
||||
},
|
||||
|
||||
// Actions
|
||||
Button: ({ props, onAction, loading }) => {
|
||||
const variant =
|
||||
props.variant === "danger"
|
||||
? "destructive"
|
||||
: props.variant === "secondary"
|
||||
? "secondary"
|
||||
: "default";
|
||||
|
||||
return (
|
||||
<Button
|
||||
variant={variant}
|
||||
disabled={loading}
|
||||
onClick={() =>
|
||||
onAction?.({
|
||||
name: props.action ?? "buttonClick",
|
||||
params: props.actionParams ?? { message: props.label },
|
||||
})
|
||||
}
|
||||
>
|
||||
{loading ? "..." : props.label}
|
||||
</Button>
|
||||
);
|
||||
},
|
||||
|
||||
Link: ({ props, onAction }) => (
|
||||
<Button
|
||||
variant="link"
|
||||
className="h-auto p-0"
|
||||
onClick={() =>
|
||||
onAction?.({
|
||||
name: "linkClick",
|
||||
params: { href: props.href },
|
||||
})
|
||||
}
|
||||
>
|
||||
{props.label}
|
||||
</Button>
|
||||
),
|
||||
|
||||
// Typography
|
||||
Heading: ({ props }) => {
|
||||
const level = props.level ?? "h2";
|
||||
const headingClass =
|
||||
level === "h1"
|
||||
? "text-2xl font-bold"
|
||||
: level === "h3"
|
||||
? "text-base font-semibold"
|
||||
: level === "h4"
|
||||
? "text-sm font-semibold"
|
||||
: "text-lg font-semibold";
|
||||
|
||||
if (level === "h1")
|
||||
return <h1 className={`${headingClass} text-left`}>{props.text}</h1>;
|
||||
if (level === "h3")
|
||||
return <h3 className={`${headingClass} text-left`}>{props.text}</h3>;
|
||||
if (level === "h4")
|
||||
return <h4 className={`${headingClass} text-left`}>{props.text}</h4>;
|
||||
return <h2 className={`${headingClass} text-left`}>{props.text}</h2>;
|
||||
},
|
||||
|
||||
Text: ({ props }) => {
|
||||
const textClass =
|
||||
props.variant === "caption"
|
||||
? "text-xs"
|
||||
: props.variant === "muted"
|
||||
? "text-sm text-muted-foreground"
|
||||
: "text-sm";
|
||||
|
||||
return <p className={`${textClass} text-left`}>{props.text}</p>;
|
||||
},
|
||||
|
||||
// Data Display
|
||||
Image: ({ props }) => {
|
||||
const imgStyle = {
|
||||
width: props.width ?? 80,
|
||||
height: props.height ?? 60,
|
||||
};
|
||||
|
||||
return (
|
||||
<div
|
||||
className="bg-muted border border-border rounded flex items-center justify-center text-xs text-muted-foreground aspect-video"
|
||||
style={imgStyle}
|
||||
>
|
||||
{props.alt || "img"}
|
||||
</div>
|
||||
);
|
||||
},
|
||||
|
||||
Avatar: ({ props }) => {
|
||||
const name = props.name || "?";
|
||||
const initials = name
|
||||
.split(" ")
|
||||
.map((n) => n[0])
|
||||
.join("")
|
||||
.slice(0, 2)
|
||||
.toUpperCase();
|
||||
const avatarSize =
|
||||
props.size === "lg"
|
||||
? "w-12 h-12 text-base"
|
||||
: props.size === "sm"
|
||||
? "w-8 h-8 text-xs"
|
||||
: "w-10 h-10 text-sm";
|
||||
|
||||
return (
|
||||
<div
|
||||
className={`${avatarSize} rounded-full bg-muted flex items-center justify-center font-medium`}
|
||||
>
|
||||
{initials}
|
||||
</div>
|
||||
);
|
||||
},
|
||||
|
||||
Badge: ({ props }) => {
|
||||
const variant =
|
||||
props.variant === "success" || props.variant === "warning"
|
||||
? "secondary"
|
||||
: props.variant === "danger"
|
||||
? "destructive"
|
||||
: "default";
|
||||
|
||||
// Add custom colors for success/warning
|
||||
const customClass =
|
||||
props.variant === "success"
|
||||
? "bg-green-100 text-green-800 dark:bg-green-900 dark:text-green-100"
|
||||
: props.variant === "warning"
|
||||
? "bg-yellow-100 text-yellow-800 dark:bg-yellow-900 dark:text-yellow-100"
|
||||
: "";
|
||||
|
||||
return (
|
||||
<Badge variant={variant} className={customClass}>
|
||||
{props.text}
|
||||
</Badge>
|
||||
);
|
||||
},
|
||||
|
||||
Alert: ({ props }) => {
|
||||
const variant = props.type === "error" ? "destructive" : "default";
|
||||
|
||||
// Custom colors for different alert types
|
||||
const customClass =
|
||||
props.type === "success"
|
||||
? "border-green-200 bg-green-50 text-green-900 dark:border-green-800 dark:bg-green-950 dark:text-green-100"
|
||||
: props.type === "warning"
|
||||
? "border-yellow-200 bg-yellow-50 text-yellow-900 dark:border-yellow-800 dark:bg-yellow-950 dark:text-yellow-100"
|
||||
: props.type === "info"
|
||||
? "border-blue-200 bg-blue-50 text-blue-900 dark:border-blue-800 dark:bg-blue-950 dark:text-blue-100"
|
||||
: "";
|
||||
|
||||
return (
|
||||
<Alert variant={variant} className={customClass}>
|
||||
<AlertTitle>{props.title}</AlertTitle>
|
||||
{props.message && <AlertDescription>{props.message}</AlertDescription>}
|
||||
</Alert>
|
||||
);
|
||||
},
|
||||
|
||||
Progress: ({ props }) => {
|
||||
const value = Math.min(100, Math.max(0, props.value || 0));
|
||||
|
||||
return (
|
||||
<div className="space-y-2">
|
||||
{props.label && (
|
||||
<Label className="text-sm text-muted-foreground">{props.label}</Label>
|
||||
)}
|
||||
<Progress value={value} />
|
||||
</div>
|
||||
);
|
||||
},
|
||||
|
||||
Rating: ({ props }) => {
|
||||
const ratingValue = props.value || 0;
|
||||
const maxRating = props.max ?? 5;
|
||||
|
||||
return (
|
||||
<div className="space-y-2">
|
||||
{props.label && (
|
||||
<Label className="text-sm text-muted-foreground">{props.label}</Label>
|
||||
)}
|
||||
<div className="flex gap-1">
|
||||
{Array.from({ length: maxRating }).map((_, i) => (
|
||||
<span
|
||||
key={i}
|
||||
className={`text-lg ${i < ratingValue ? "text-yellow-400" : "text-muted"}`}
|
||||
>
|
||||
*
|
||||
</span>
|
||||
))}
|
||||
</div>
|
||||
</div>
|
||||
);
|
||||
},
|
||||
|
||||
// Charts
|
||||
BarGraph: ({ props }) => {
|
||||
const data = props.data || [];
|
||||
const maxValue = Math.max(...data.map((d) => d.value), 1);
|
||||
|
||||
return (
|
||||
<div className="space-y-2">
|
||||
{props.title && (
|
||||
<div className="text-sm font-medium text-left">{props.title}</div>
|
||||
)}
|
||||
<div className="flex gap-2">
|
||||
{data.map((d, i) => (
|
||||
<div key={i} className="flex-1 flex flex-col items-center gap-1">
|
||||
<div className="text-xs text-muted-foreground">{d.value}</div>
|
||||
<div className="w-full h-24 flex items-end">
|
||||
<div
|
||||
className="w-full bg-primary rounded-t transition-all"
|
||||
style={{
|
||||
height: `${(d.value / maxValue) * 100}%`,
|
||||
minHeight: 2,
|
||||
}}
|
||||
/>
|
||||
</div>
|
||||
<div className="text-xs text-muted-foreground truncate w-full text-center">
|
||||
{d.label}
|
||||
</div>
|
||||
</div>
|
||||
))}
|
||||
</div>
|
||||
</div>
|
||||
);
|
||||
},
|
||||
|
||||
LineGraph: ({ props }) => {
|
||||
const data = props.data || [];
|
||||
const maxValue = Math.max(...data.map((d) => d.value));
|
||||
const minValue = Math.min(...data.map((d) => d.value));
|
||||
const range = maxValue - minValue || 1;
|
||||
|
||||
const width = 300;
|
||||
const height = 100;
|
||||
const padding = { top: 10, right: 10, bottom: 10, left: 10 };
|
||||
const chartWidth = width - padding.left - padding.right;
|
||||
const chartHeight = height - padding.top - padding.bottom;
|
||||
|
||||
const points = data.map((d, i) => {
|
||||
const x =
|
||||
padding.left +
|
||||
(data.length > 1
|
||||
? (i / (data.length - 1)) * chartWidth
|
||||
: chartWidth / 2);
|
||||
const y =
|
||||
padding.top +
|
||||
chartHeight -
|
||||
((d.value - minValue) / range) * chartHeight;
|
||||
return { x, y, ...d };
|
||||
});
|
||||
|
||||
const pathD =
|
||||
points.length > 0
|
||||
? `M ${points.map((p) => `${p.x} ${p.y}`).join(" L ")}`
|
||||
: "";
|
||||
|
||||
return (
|
||||
<div className="space-y-2">
|
||||
{props.title && (
|
||||
<div className="text-sm font-medium text-left">{props.title}</div>
|
||||
)}
|
||||
<div className="relative h-28">
|
||||
<svg viewBox={`0 0 ${width} ${height}`} className="w-full h-full">
|
||||
<line
|
||||
x1={padding.left}
|
||||
y1={padding.top + chartHeight / 2}
|
||||
x2={width - padding.right}
|
||||
y2={padding.top + chartHeight / 2}
|
||||
stroke="currentColor"
|
||||
strokeOpacity="0.1"
|
||||
strokeWidth="1"
|
||||
/>
|
||||
<line
|
||||
x1={padding.left}
|
||||
y1={padding.top}
|
||||
x2={width - padding.right}
|
||||
y2={padding.top}
|
||||
stroke="currentColor"
|
||||
strokeOpacity="0.1"
|
||||
strokeWidth="1"
|
||||
/>
|
||||
<line
|
||||
x1={padding.left}
|
||||
y1={height - padding.bottom}
|
||||
x2={width - padding.right}
|
||||
y2={height - padding.bottom}
|
||||
stroke="currentColor"
|
||||
strokeOpacity="0.1"
|
||||
strokeWidth="1"
|
||||
/>
|
||||
{pathD && (
|
||||
<path
|
||||
d={pathD}
|
||||
fill="none"
|
||||
stroke="currentColor"
|
||||
strokeWidth="2"
|
||||
strokeLinecap="round"
|
||||
strokeLinejoin="round"
|
||||
className="text-primary"
|
||||
/>
|
||||
)}
|
||||
{points.map((p, i) => (
|
||||
<circle
|
||||
key={i}
|
||||
cx={p.x}
|
||||
cy={p.y}
|
||||
r="4"
|
||||
className="fill-primary"
|
||||
/>
|
||||
))}
|
||||
</svg>
|
||||
</div>
|
||||
{data.length > 0 && (
|
||||
<div className="flex justify-between">
|
||||
{data.map((d, i) => (
|
||||
<div
|
||||
key={i}
|
||||
className="text-xs text-muted-foreground text-center"
|
||||
style={{ width: `${100 / data.length}%` }}
|
||||
>
|
||||
{d.label}
|
||||
</div>
|
||||
))}
|
||||
</div>
|
||||
)}
|
||||
</div>
|
||||
);
|
||||
},
|
||||
};
|
||||
|
||||
// Fallback component for unknown types
|
||||
export function Fallback({ type }: { type: string }) {
|
||||
return <div className="text-xs text-muted-foreground">[{type}]</div>;
|
||||
}
|
||||
@@ -16,29 +16,54 @@ export const docsNavigation: NavSection[] = [
|
||||
{ title: "Introduction", href: "/docs" },
|
||||
{ title: "Installation", href: "/docs/installation" },
|
||||
{ title: "Quick Start", href: "/docs/quick-start" },
|
||||
{ title: "Migration Guide", href: "/docs/migration" },
|
||||
{ title: "Changelog", href: "/docs/changelog" },
|
||||
],
|
||||
},
|
||||
{
|
||||
title: "Core Concepts",
|
||||
title: "Core",
|
||||
items: [
|
||||
{ title: "Specs", href: "/docs/specs" },
|
||||
{ title: "Schemas", href: "/docs/schemas" },
|
||||
{ title: "Catalog", href: "/docs/catalog" },
|
||||
{ title: "Registry", href: "/docs/registry" },
|
||||
{ title: "Data Binding", href: "/docs/data-binding" },
|
||||
{ title: "Computed Values", href: "/docs/computed-values" },
|
||||
{ title: "Visibility", href: "/docs/visibility" },
|
||||
{ title: "Watchers", href: "/docs/watchers" },
|
||||
{ title: "Validation", href: "/docs/validation" },
|
||||
],
|
||||
},
|
||||
{
|
||||
title: "Rendering",
|
||||
items: [
|
||||
{ title: "Registry", href: "/docs/registry" },
|
||||
{ title: "Streaming", href: "/docs/streaming" },
|
||||
{ title: "Generation Modes", href: "/docs/generation-modes" },
|
||||
],
|
||||
},
|
||||
{
|
||||
title: "Examples",
|
||||
items: [
|
||||
{
|
||||
title: "Chat",
|
||||
href: "https://github.com/vercel-labs/json-render/tree/main/examples/chat",
|
||||
external: true,
|
||||
},
|
||||
{
|
||||
title: "Dashboard",
|
||||
href: "https://github.com/vercel-labs/json-render/tree/main/examples/dashboard",
|
||||
external: true,
|
||||
},
|
||||
{
|
||||
title: "React Native",
|
||||
href: "https://github.com/vercel-labs/json-render/tree/main/examples/react-native",
|
||||
external: true,
|
||||
},
|
||||
{
|
||||
title: "React PDF",
|
||||
href: "https://github.com/vercel-labs/json-render/tree/main/examples/react-pdf",
|
||||
external: true,
|
||||
},
|
||||
{
|
||||
title: "Remotion",
|
||||
href: "https://github.com/vercel-labs/json-render/tree/main/examples/remotion",
|
||||
@@ -50,7 +75,6 @@ export const docsNavigation: NavSection[] = [
|
||||
title: "Guides",
|
||||
items: [
|
||||
{ title: "Custom Schema", href: "/docs/custom-schema" },
|
||||
{ title: "Streaming", href: "/docs/streaming" },
|
||||
{ title: "Code Export", href: "/docs/code-export" },
|
||||
],
|
||||
},
|
||||
@@ -69,6 +93,9 @@ export const docsNavigation: NavSection[] = [
|
||||
items: [
|
||||
{ title: "@json-render/core", href: "/docs/api/core" },
|
||||
{ title: "@json-render/react", href: "/docs/api/react" },
|
||||
{ title: "@json-render/react-pdf", href: "/docs/api/react-pdf" },
|
||||
{ title: "@json-render/shadcn", href: "/docs/api/shadcn" },
|
||||
{ title: "@json-render/react-native", href: "/docs/api/react-native" },
|
||||
{ title: "@json-render/remotion", href: "/docs/api/remotion" },
|
||||
{ title: "@json-render/codegen", href: "/docs/api/codegen" },
|
||||
],
|
||||
|
||||
@@ -0,0 +1,68 @@
|
||||
/**
|
||||
* Converts raw MDX content to clean Markdown suitable for AI agents.
|
||||
*
|
||||
* Transformations:
|
||||
* - Remove `export` statements (metadata, etc.)
|
||||
* - Remove `import` statements
|
||||
* - Replace `<PackageInstall packages="x y" />` with a fenced bash code block
|
||||
* - Strip standalone JSX callout divs (the amber concept boxes)
|
||||
* - Pass everything else through as-is (already valid Markdown)
|
||||
*/
|
||||
export function mdxToCleanMarkdown(raw: string): string {
|
||||
const lines = raw.split("\n");
|
||||
const out: string[] = [];
|
||||
let inJsxBlock = false;
|
||||
let jsxDepth = 0;
|
||||
|
||||
for (const line of lines) {
|
||||
const trimmed = line.trim();
|
||||
|
||||
// Skip export and import statements
|
||||
if (trimmed.startsWith("export ") || trimmed.startsWith("import ")) {
|
||||
continue;
|
||||
}
|
||||
|
||||
// Handle PackageInstall component
|
||||
const pkgMatch = trimmed.match(
|
||||
/<PackageInstall\s+packages="([^"]+)"\s*\/>/,
|
||||
);
|
||||
if (pkgMatch) {
|
||||
const packages = pkgMatch[1];
|
||||
out.push("```bash");
|
||||
out.push(`pnpm add ${packages}`);
|
||||
out.push("```");
|
||||
out.push("");
|
||||
continue;
|
||||
}
|
||||
|
||||
// Track JSX blocks (like the callout divs) and skip them
|
||||
if (
|
||||
!inJsxBlock &&
|
||||
trimmed.startsWith("<div ") &&
|
||||
trimmed.includes("className=")
|
||||
) {
|
||||
inJsxBlock = true;
|
||||
jsxDepth = 1;
|
||||
continue;
|
||||
}
|
||||
|
||||
if (inJsxBlock) {
|
||||
// Count opening/closing div tags to handle nesting
|
||||
const opens = (line.match(/<div[\s>]/g) || []).length;
|
||||
const closes = (line.match(/<\/div>/g) || []).length;
|
||||
jsxDepth += opens - closes;
|
||||
if (jsxDepth <= 0) {
|
||||
inJsxBlock = false;
|
||||
jsxDepth = 0;
|
||||
}
|
||||
continue;
|
||||
}
|
||||
|
||||
out.push(line);
|
||||
}
|
||||
|
||||
// Clean up leading blank lines
|
||||
let result = out.join("\n");
|
||||
result = result.replace(/^\n+/, "\n").trim();
|
||||
return result;
|
||||
}
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user