mirror of
https://github.com/vercel-labs/json-render.git
synced 2026-10-02 12:00:58 +08:00
Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
9adcc09204 | ||
|
|
519a538aae | ||
|
|
a99d68c481 | ||
|
|
40892a6af0 | ||
|
|
7628640984 | ||
|
|
bf3a7ec61d | ||
|
|
453484985a | ||
|
|
d69a59ea9d | ||
|
|
c43b36e01c | ||
|
|
c538bb1604 | ||
|
|
e73146e622 | ||
|
|
f4d13b6612 | ||
|
|
b7993ed4ae | ||
|
|
4bb1151b6c | ||
|
|
ad557b2309 | ||
|
|
43b7515a24 | ||
|
|
e16c5ef477 | ||
|
|
22545b49cc | ||
|
|
a8afd8bfe2 | ||
|
|
dc489601be | ||
|
|
7758d4bbd5 | ||
|
|
6225fc41eb | ||
|
|
5b32de8720 | ||
|
|
f6d1c5134b | ||
|
|
316439fcd7 | ||
|
|
c180f529a0 | ||
|
|
c3c0a36f20 | ||
|
|
9bb82604f0 | ||
|
|
caa90b8b84 | ||
|
|
54a1ecf817 | ||
|
|
dc9e9d17f3 | ||
|
|
1977fb3a11 | ||
|
|
4606c01085 | ||
|
|
c1a700d719 | ||
|
|
6f15faaae0 | ||
|
|
63c339b4bb | ||
|
|
1cc87310c9 | ||
|
|
5b929dffa6 | ||
|
|
512f7fe5c5 | ||
|
|
b6f12d4d53 | ||
|
|
f29b1c2ef6 | ||
|
|
8968bd648a | ||
|
|
023ca789b2 | ||
|
|
3f1e71e779 | ||
|
|
553c803422 | ||
|
|
9f58d8712c | ||
|
|
c2b397510e | ||
|
|
8506cfaa03 | ||
|
|
9cef4e9142 | ||
|
|
3c11f19be4 | ||
|
|
db3a8b41e9 | ||
|
|
ea47b66dfc | ||
|
|
cd82f969c8 | ||
|
|
6bcaaad57d | ||
|
|
0b7d767cdd | ||
|
|
b1036763d2 | ||
|
|
c502d5517e | ||
|
|
8740deb018 | ||
|
|
1d755c104a | ||
|
|
d904d45150 | ||
|
|
a110c6e0ea | ||
|
|
7de08ccdf7 | ||
|
|
3201854481 | ||
|
|
64c889221e | ||
|
|
49838fa353 | ||
|
|
fa47b08869 | ||
|
|
5ccb109c08 | ||
|
|
62932f6516 | ||
|
|
ee28d548c1 | ||
|
|
0e6f2afc6c | ||
|
|
bccedc2459 | ||
|
|
0a404302ef | ||
|
|
09376db2f6 |
+18
-2
@@ -6,10 +6,26 @@
|
||||
[
|
||||
"@json-render/core",
|
||||
"@json-render/react",
|
||||
"@json-render/react-email",
|
||||
"@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",
|
||||
"@json-render/vue",
|
||||
"@json-render/xstate",
|
||||
"@json-render/image",
|
||||
"@json-render/mcp",
|
||||
"@json-render/svelte",
|
||||
"@json-render/solid",
|
||||
"@json-render/react-three-fiber",
|
||||
"@json-render/yaml",
|
||||
"@json-render/shadcn-svelte",
|
||||
"@json-render/ink",
|
||||
"@json-render/next"
|
||||
]
|
||||
],
|
||||
"linked": [],
|
||||
@@ -17,7 +33,7 @@
|
||||
"baseBranch": "main",
|
||||
"updateInternalDependencies": "patch",
|
||||
"privatePackages": {
|
||||
"version": false,
|
||||
"version": true,
|
||||
"tag": false
|
||||
}
|
||||
}
|
||||
|
||||
@@ -0,0 +1,8 @@
|
||||
{
|
||||
"mcpServers": {
|
||||
"json-render": {
|
||||
"command": "npx",
|
||||
"args": ["tsx", "examples/mcp/server.ts", "--stdio"]
|
||||
}
|
||||
}
|
||||
}
|
||||
+34
-25
@@ -13,34 +13,43 @@ concurrency:
|
||||
cancel-in-progress: true
|
||||
|
||||
jobs:
|
||||
ci:
|
||||
name: Lint, Type Check & Build
|
||||
lint:
|
||||
name: Lint
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Install pnpm
|
||||
uses: pnpm/action-setup@v4
|
||||
|
||||
- name: Setup Node.js
|
||||
uses: actions/setup-node@v4
|
||||
- uses: actions/checkout@v4
|
||||
- uses: pnpm/action-setup@v4
|
||||
- uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: 20
|
||||
cache: "pnpm"
|
||||
cache: pnpm
|
||||
- run: pnpm install --frozen-lockfile
|
||||
- run: pnpm lint
|
||||
|
||||
- name: Install dependencies
|
||||
run: pnpm install --frozen-lockfile
|
||||
test:
|
||||
name: Test
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- uses: pnpm/action-setup@v4
|
||||
- uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: 20
|
||||
cache: pnpm
|
||||
- run: pnpm install --frozen-lockfile
|
||||
- name: Build packages
|
||||
run: pnpm turbo run build --filter='./packages/*'
|
||||
- run: pnpm test
|
||||
|
||||
- name: Lint
|
||||
run: pnpm lint
|
||||
|
||||
- name: Type check
|
||||
run: pnpm type-check
|
||||
|
||||
- name: Test
|
||||
run: pnpm test
|
||||
|
||||
- name: Build
|
||||
run: pnpm build
|
||||
typecheck:
|
||||
name: Type Check
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- uses: pnpm/action-setup@v4
|
||||
- uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: 20
|
||||
cache: pnpm
|
||||
- run: pnpm install --frozen-lockfile
|
||||
- run: pnpm type-check
|
||||
|
||||
+4
-9
@@ -4,13 +4,11 @@
|
||||
node_modules
|
||||
.pnp
|
||||
.pnp.js
|
||||
.pnpm-store/
|
||||
|
||||
# Local env files
|
||||
.env
|
||||
.env.local
|
||||
.env.development.local
|
||||
.env.test.local
|
||||
.env.production.local
|
||||
.env*
|
||||
!.env.example
|
||||
|
||||
# Testing
|
||||
coverage
|
||||
@@ -30,6 +28,7 @@ out/
|
||||
build
|
||||
dist
|
||||
*.tsbuildinfo
|
||||
.svelte-kit/
|
||||
|
||||
|
||||
# Debug
|
||||
@@ -44,10 +43,6 @@ yarn-error.log*
|
||||
# opensrc - source code for packages
|
||||
opensrc/
|
||||
|
||||
# json-studio (separate repo)
|
||||
json-studio/
|
||||
.env*.local
|
||||
|
||||
# Stripe apps (generated from template + build artifacts)
|
||||
examples/stripe-app/*/stripe-app.json
|
||||
examples/stripe-app/*/.build
|
||||
|
||||
Vendored
+9
@@ -0,0 +1,9 @@
|
||||
{
|
||||
"servers": {
|
||||
"json-render": {
|
||||
"type": "stdio",
|
||||
"command": "npx",
|
||||
"args": ["tsx", "examples/mcp/server.ts", "--stdio"]
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -26,6 +26,42 @@ This ensures we don't install outdated versions that may have incompatible types
|
||||
|
||||
- Do not use emojis in code or UI
|
||||
- Use shadcn CLI to add shadcn/ui components: `pnpm dlx shadcn@latest add <component>`
|
||||
- **Web app docs (`apps/web/`):** Never use Markdown table syntax (`| col | col |`). Always use HTML `<table>` with `<thead>`, `<tbody>`, `<tr>`, `<th>`, `<td>`. Markdown tables do not render correctly in the web app. Inside HTML table cells, curly braces must be escaped as JSX expressions (e.g. `<code>{'{ "$state": "/path" }'}</code>`) because MDX parses `{` as a JSX expression boundary.
|
||||
|
||||
## 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
|
||||
|
||||
@@ -33,9 +69,45 @@ This ensures we don't install outdated versions that may have incompatible types
|
||||
- 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)
|
||||
|
||||
## Releases
|
||||
|
||||
This monorepo uses [Changesets](https://github.com/changesets/changesets) for versioning and publishing.
|
||||
|
||||
### Fixed version group
|
||||
|
||||
All public `@json-render/*` packages are in a **fixed** group (see `.changeset/config.json`). A changeset that bumps any one of them bumps all of them to the same version. You only need to list the packages that actually changed in the changeset front matter — the fixed group handles the rest.
|
||||
|
||||
### Preparing a release
|
||||
|
||||
When asked to prepare a release (e.g. "prepare v0.12.0"):
|
||||
|
||||
1. **Create a changeset file** at `.changeset/v0-<N>-release.md` following the existing pattern:
|
||||
- YAML front matter listing changed packages with bump type (`minor` for feature releases, `patch` for bug-fix-only releases)
|
||||
- A one-line summary, then `### New:` / `### Improved:` / `### Fixed:` sections describing each change
|
||||
- Always list `@json-render/core` plus any packages with actual code changes
|
||||
2. **Do NOT bump versions** in `package.json` files — CI runs `pnpm ci:version` (which calls `changeset version`) to do that automatically
|
||||
3. **Do NOT manually write `CHANGELOG.md`** entries — `changeset version` generates them from the changeset file
|
||||
4. **Add new packages to the fixed group** in `.changeset/config.json` if they should be versioned together with the rest
|
||||
5. **Fill documentation gaps** — every public package should have:
|
||||
- A row in the root `README.md` packages table
|
||||
- A renderer section in the root `README.md` (if it's a renderer)
|
||||
- An API reference page at `apps/web/app/(main)/docs/api/<name>/page.mdx`
|
||||
- An entry in `apps/web/lib/page-titles.ts` and `apps/web/lib/docs-navigation.ts`
|
||||
- An entry in the docs-chat system prompt (`apps/web/app/api/docs-chat/route.ts`)
|
||||
- A skill at `skills/<name>/SKILL.md`
|
||||
- A `packages/<name>/README.md`
|
||||
6. **Run `pnpm type-check`** after all changes to verify nothing is broken
|
||||
|
||||
### CI scripts
|
||||
|
||||
- `pnpm changeset` — interactively create a new changeset
|
||||
- `pnpm ci:version` — run `changeset version` + lockfile update (CI only)
|
||||
- `pnpm ci:publish` — build all packages and publish to npm (CI only)
|
||||
|
||||
<!-- opensrc:start -->
|
||||
|
||||
## Source Code Reference
|
||||
|
||||
@@ -5,15 +5,30 @@
|
||||
Generate dynamic, personalized UIs from prompts without sacrificing reliability. Predefined components and actions for safe, predictable output.
|
||||
|
||||
```bash
|
||||
# for React
|
||||
npm install @json-render/core @json-render/react
|
||||
# pre-built shadcn/ui components
|
||||
# for React with pre-built shadcn/ui components
|
||||
npm install @json-render/shadcn
|
||||
# or for mobile
|
||||
# or for React Native
|
||||
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
|
||||
# or for HTML email
|
||||
npm install @json-render/core @json-render/react-email @react-email/components @react-email/render
|
||||
# or for Vue
|
||||
npm install @json-render/core @json-render/vue
|
||||
# or for Svelte
|
||||
npm install @json-render/core @json-render/svelte
|
||||
# or for SolidJS
|
||||
npm install @json-render/core @json-render/solid
|
||||
# or for terminal UIs
|
||||
npm install @json-render/core @json-render/ink ink react
|
||||
# or for full Next.js apps (routes, layouts, SSR, metadata)
|
||||
npm install @json-render/core @json-render/react @json-render/next
|
||||
# or for 3D scenes
|
||||
npm install @json-render/core @json-render/react-three-fiber @react-three/fiber @react-three/drei three
|
||||
```
|
||||
|
||||
## Why json-render?
|
||||
@@ -23,7 +38,7 @@ json-render is a **Generative UI** framework: AI generates interfaces from natur
|
||||
- **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
|
||||
- **Cross-Platform** - React, Vue, Svelte, Solid (web), React Native (mobile) from the same catalog
|
||||
- **Batteries Included** - 36 pre-built shadcn/ui components ready to use
|
||||
|
||||
## Quick Start
|
||||
@@ -32,7 +47,7 @@ json-render is a **Generative UI** framework: AI generates interfaces from natur
|
||||
|
||||
```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, {
|
||||
@@ -84,9 +99,7 @@ const { registry } = defineRegistry(catalog, {
|
||||
</div>
|
||||
),
|
||||
Button: ({ props, emit }) => (
|
||||
<button onClick={() => emit("press")}>
|
||||
{props.label}
|
||||
</button>
|
||||
<button onClick={() => emit("press")}>{props.label}</button>
|
||||
),
|
||||
},
|
||||
});
|
||||
@@ -106,14 +119,30 @@ function Dashboard({ spec }) {
|
||||
|
||||
## Packages
|
||||
|
||||
| Package | Description |
|
||||
|---------|-------------|
|
||||
| `@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 |
|
||||
| Package | Description |
|
||||
| --------------------------- | ---------------------------------------------------------------------- |
|
||||
| `@json-render/core` | Schemas, catalogs, AI prompts, dynamic props, SpecStream utilities |
|
||||
| `@json-render/react` | React renderer, contexts, hooks |
|
||||
| `@json-render/vue` | Vue 3 renderer, composables, providers |
|
||||
| `@json-render/svelte` | Svelte 5 renderer with runes-based reactivity |
|
||||
| `@json-render/solid` | SolidJS renderer with fine-grained reactive contexts |
|
||||
| `@json-render/shadcn` | 36 pre-built shadcn/ui components (Radix UI + Tailwind CSS) |
|
||||
| `@json-render/shadcn-svelte`| 36 pre-built shadcn-svelte components (Svelte 5 + Tailwind CSS) |
|
||||
| `@json-render/react-three-fiber` | React Three Fiber renderer for 3D scenes (19 built-in components) |
|
||||
| `@json-render/react-native` | React Native renderer with standard mobile components |
|
||||
| `@json-render/next` | Next.js renderer — JSON becomes full apps with routes, layouts, SSR |
|
||||
| `@json-render/remotion` | Remotion video renderer, timeline schema |
|
||||
| `@json-render/react-pdf` | React PDF renderer for generating PDF documents from specs |
|
||||
| `@json-render/react-email` | React Email renderer for HTML/plain-text emails from specs |
|
||||
| `@json-render/ink` | Ink terminal renderer with built-in components for interactive TUIs. |
|
||||
| `@json-render/image` | Image renderer for SVG/PNG output (OG images, social cards) via Satori |
|
||||
| `@json-render/codegen` | Utilities for generating code from json-render UI trees |
|
||||
| `@json-render/redux` | Redux / Redux Toolkit adapter for `StateStore` |
|
||||
| `@json-render/zustand` | Zustand adapter for `StateStore` |
|
||||
| `@json-render/jotai` | Jotai adapter for `StateStore` |
|
||||
| `@json-render/xstate` | XState Store (atom) adapter for `StateStore` |
|
||||
| `@json-render/mcp` | MCP Apps integration for Claude, ChatGPT, Cursor, VS Code |
|
||||
| `@json-render/yaml` | YAML wire format with streaming parser, edit modes, AI SDK transform |
|
||||
|
||||
## Renderers
|
||||
|
||||
@@ -121,7 +150,7 @@ function Dashboard({ spec }) {
|
||||
|
||||
```tsx
|
||||
import { defineRegistry, Renderer } from "@json-render/react";
|
||||
import { schema } from "@json-render/react";
|
||||
import { schema } from "@json-render/react/schema";
|
||||
|
||||
// Flat spec format (root key + elements map)
|
||||
const spec = {
|
||||
@@ -142,14 +171,72 @@ const spec = {
|
||||
|
||||
// defineRegistry creates a type-safe component registry
|
||||
const { registry } = defineRegistry(catalog, { components });
|
||||
<Renderer spec={spec} registry={registry} />
|
||||
<Renderer spec={spec} registry={registry} />;
|
||||
```
|
||||
|
||||
### Vue (UI)
|
||||
|
||||
```typescript
|
||||
import { h } from "vue";
|
||||
import { defineRegistry, Renderer } from "@json-render/vue";
|
||||
import { schema } from "@json-render/vue/schema";
|
||||
|
||||
const { registry } = defineRegistry(catalog, {
|
||||
components: {
|
||||
Card: ({ props, children }) =>
|
||||
h("div", { class: "card" }, [h("h3", null, props.title), children]),
|
||||
Button: ({ props, emit }) =>
|
||||
h("button", { onClick: () => emit("press") }, props.label),
|
||||
},
|
||||
});
|
||||
|
||||
// In your Vue component template:
|
||||
// <Renderer :spec="spec" :registry="registry" />
|
||||
```
|
||||
|
||||
### Svelte (UI)
|
||||
|
||||
```typescript
|
||||
import { defineRegistry, Renderer } from "@json-render/svelte";
|
||||
import { schema } from "@json-render/svelte/schema";
|
||||
|
||||
const { registry } = defineRegistry(catalog, {
|
||||
components: {
|
||||
Card: ({ props, children }) => /* Svelte 5 snippet */,
|
||||
Button: ({ props, emit }) => /* Svelte 5 snippet */,
|
||||
},
|
||||
});
|
||||
|
||||
// In your Svelte component:
|
||||
// <Renderer spec={spec} registry={registry} />
|
||||
```
|
||||
|
||||
### Solid (UI)
|
||||
|
||||
```tsx
|
||||
import { defineRegistry, Renderer } from "@json-render/solid";
|
||||
import { schema } from "@json-render/solid/schema";
|
||||
|
||||
const { registry } = defineRegistry(catalog, {
|
||||
components: {
|
||||
Card: (renderProps) => <div>{renderProps.children}</div>,
|
||||
Button: (renderProps) => (
|
||||
<button onClick={() => renderProps.emit("press")}>
|
||||
{renderProps.element.props.label as string}
|
||||
</button>
|
||||
),
|
||||
},
|
||||
});
|
||||
|
||||
<Renderer spec={spec} registry={registry} />;
|
||||
```
|
||||
|
||||
### shadcn/ui (Web)
|
||||
|
||||
```tsx
|
||||
import { defineCatalog } from "@json-render/core";
|
||||
import { schema, defineRegistry, Renderer } from "@json-render/react";
|
||||
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";
|
||||
|
||||
@@ -174,7 +261,7 @@ const { registry } = defineRegistry(catalog, {
|
||||
},
|
||||
});
|
||||
|
||||
<Renderer spec={spec} registry={registry} />
|
||||
<Renderer spec={spec} registry={registry} />;
|
||||
```
|
||||
|
||||
### React Native (Mobile)
|
||||
@@ -195,23 +282,40 @@ const catalog = defineCatalog(schema, {
|
||||
});
|
||||
|
||||
const { registry } = defineRegistry(catalog, { components: {} });
|
||||
<Renderer spec={spec} registry={registry} />
|
||||
<Renderer spec={spec} registry={registry} />;
|
||||
```
|
||||
|
||||
### Remotion (Video)
|
||||
|
||||
```tsx
|
||||
import { Player } from "@remotion/player";
|
||||
import { Renderer, schema, standardComponentDefinitions } from "@json-render/remotion";
|
||||
import {
|
||||
Renderer,
|
||||
schema,
|
||||
standardComponentDefinitions,
|
||||
} from "@json-render/remotion";
|
||||
|
||||
// Timeline spec format
|
||||
const spec = {
|
||||
composition: { id: "video", fps: 30, width: 1920, height: 1080, durationInFrames: 300 },
|
||||
composition: {
|
||||
id: "video",
|
||||
fps: 30,
|
||||
width: 1920,
|
||||
height: 1080,
|
||||
durationInFrames: 300,
|
||||
},
|
||||
tracks: [{ id: "main", name: "Main", type: "video", enabled: true }],
|
||||
clips: [
|
||||
{ id: "clip-1", trackId: "main", component: "TitleCard", props: { title: "Hello" }, from: 0, durationInFrames: 90 }
|
||||
{
|
||||
id: "clip-1",
|
||||
trackId: "main",
|
||||
component: "TitleCard",
|
||||
props: { title: "Hello" },
|
||||
from: 0,
|
||||
durationInFrames: 90,
|
||||
},
|
||||
],
|
||||
audio: { tracks: [] }
|
||||
audio: { tracks: [] },
|
||||
};
|
||||
|
||||
<Player
|
||||
@@ -221,7 +325,7 @@ const spec = {
|
||||
fps={spec.composition.fps}
|
||||
compositionWidth={spec.composition.width}
|
||||
compositionHeight={spec.composition.height}
|
||||
/>
|
||||
/>;
|
||||
```
|
||||
|
||||
### React PDF (Documents)
|
||||
@@ -232,7 +336,11 @@ import { renderToBuffer } from "@json-render/react-pdf";
|
||||
const spec = {
|
||||
root: "doc",
|
||||
elements: {
|
||||
doc: { type: "Document", props: { title: "Invoice" }, children: ["page-1"] },
|
||||
doc: {
|
||||
type: "Document",
|
||||
props: { title: "Invoice" },
|
||||
children: ["page-1"],
|
||||
},
|
||||
"page-1": {
|
||||
type: "Page",
|
||||
props: { size: "A4" },
|
||||
@@ -246,8 +354,14 @@ const spec = {
|
||||
"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"]],
|
||||
columns: [
|
||||
{ header: "Item", width: "60%" },
|
||||
{ header: "Price", width: "40%", align: "right" },
|
||||
],
|
||||
rows: [
|
||||
["Widget A", "$10.00"],
|
||||
["Widget B", "$25.00"],
|
||||
],
|
||||
},
|
||||
children: [],
|
||||
},
|
||||
@@ -258,6 +372,235 @@ const spec = {
|
||||
const buffer = await renderToBuffer(spec);
|
||||
```
|
||||
|
||||
### React Email (Email)
|
||||
|
||||
```typescript
|
||||
import { renderToHtml } from "@json-render/react-email";
|
||||
import { schema, standardComponentDefinitions } from "@json-render/react-email";
|
||||
import { defineCatalog } from "@json-render/core";
|
||||
|
||||
const catalog = defineCatalog(schema, {
|
||||
components: standardComponentDefinitions,
|
||||
});
|
||||
|
||||
const spec = {
|
||||
root: "html-1",
|
||||
elements: {
|
||||
"html-1": {
|
||||
type: "Html",
|
||||
props: { lang: "en", dir: "ltr" },
|
||||
children: ["head-1", "body-1"],
|
||||
},
|
||||
"head-1": { type: "Head", props: {}, children: [] },
|
||||
"body-1": {
|
||||
type: "Body",
|
||||
props: { style: { backgroundColor: "#f6f9fc" } },
|
||||
children: ["container-1"],
|
||||
},
|
||||
"container-1": {
|
||||
type: "Container",
|
||||
props: {
|
||||
style: { maxWidth: "600px", margin: "0 auto", padding: "20px" },
|
||||
},
|
||||
children: ["heading-1", "text-1"],
|
||||
},
|
||||
"heading-1": { type: "Heading", props: { text: "Welcome" }, children: [] },
|
||||
"text-1": {
|
||||
type: "Text",
|
||||
props: { text: "Thanks for signing up." },
|
||||
children: [],
|
||||
},
|
||||
},
|
||||
};
|
||||
|
||||
const html = await renderToHtml(spec);
|
||||
```
|
||||
|
||||
### Image (SVG/PNG)
|
||||
|
||||
```typescript
|
||||
import { renderToPng } from "@json-render/image/render";
|
||||
|
||||
const spec = {
|
||||
root: "frame",
|
||||
elements: {
|
||||
frame: {
|
||||
type: "Frame",
|
||||
props: { width: 1200, height: 630, backgroundColor: "#1a1a2e" },
|
||||
children: ["heading"],
|
||||
},
|
||||
heading: {
|
||||
type: "Heading",
|
||||
props: { text: "Hello World", level: "h1", color: "#ffffff" },
|
||||
children: [],
|
||||
},
|
||||
},
|
||||
};
|
||||
|
||||
// Render to PNG (requires @resvg/resvg-js)
|
||||
const png = await renderToPng(spec, { fonts });
|
||||
|
||||
// Or render to SVG string
|
||||
import { renderToSvg } from "@json-render/image/render";
|
||||
const svg = await renderToSvg(spec, { fonts });
|
||||
```
|
||||
|
||||
### Three.js (3D)
|
||||
|
||||
```tsx
|
||||
import { defineCatalog } from "@json-render/core";
|
||||
import { schema, defineRegistry } from "@json-render/react";
|
||||
import {
|
||||
threeComponentDefinitions,
|
||||
threeComponents,
|
||||
ThreeCanvas,
|
||||
} from "@json-render/react-three-fiber";
|
||||
|
||||
const catalog = defineCatalog(schema, {
|
||||
components: {
|
||||
Box: threeComponentDefinitions.Box,
|
||||
Sphere: threeComponentDefinitions.Sphere,
|
||||
AmbientLight: threeComponentDefinitions.AmbientLight,
|
||||
DirectionalLight: threeComponentDefinitions.DirectionalLight,
|
||||
OrbitControls: threeComponentDefinitions.OrbitControls,
|
||||
},
|
||||
actions: {},
|
||||
});
|
||||
|
||||
const { registry } = defineRegistry(catalog, {
|
||||
components: {
|
||||
Box: threeComponents.Box,
|
||||
Sphere: threeComponents.Sphere,
|
||||
AmbientLight: threeComponents.AmbientLight,
|
||||
DirectionalLight: threeComponents.DirectionalLight,
|
||||
OrbitControls: threeComponents.OrbitControls,
|
||||
},
|
||||
});
|
||||
|
||||
<ThreeCanvas
|
||||
spec={spec}
|
||||
registry={registry}
|
||||
shadows
|
||||
camera={{ position: [5, 5, 5], fov: 50 }}
|
||||
style={{ width: "100%", height: "100vh" }}
|
||||
/>;
|
||||
```
|
||||
|
||||
### Next.js (Full Apps)
|
||||
|
||||
```typescript
|
||||
import type { NextAppSpec } from "@json-render/next";
|
||||
import { createNextApp } from "@json-render/next/server";
|
||||
import { NextAppProvider } from "@json-render/next";
|
||||
|
||||
const spec: NextAppSpec = {
|
||||
metadata: { title: { default: "My App", template: "%s | My App" } },
|
||||
layouts: {
|
||||
main: {
|
||||
root: "shell",
|
||||
elements: {
|
||||
shell: { type: "Container", props: {}, children: ["nav", "slot"] },
|
||||
nav: { type: "NavBar", props: {}, children: [] },
|
||||
slot: { type: "Slot", props: {}, children: [] },
|
||||
},
|
||||
},
|
||||
},
|
||||
routes: {
|
||||
"/": {
|
||||
layout: "main",
|
||||
metadata: { title: "Home" },
|
||||
page: {
|
||||
root: "hero",
|
||||
elements: {
|
||||
hero: { type: "Card", props: { title: "Welcome" }, children: [] },
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
};
|
||||
|
||||
// Server: creates Page, generateMetadata, generateStaticParams
|
||||
const app = createNextApp({ spec });
|
||||
|
||||
// Client: wrap your layout with NextAppProvider
|
||||
// <NextAppProvider registry={registry} handlers={handlers}>
|
||||
// {children}
|
||||
// </NextAppProvider>
|
||||
```
|
||||
|
||||
### shadcn-svelte (Svelte)
|
||||
|
||||
```typescript
|
||||
import { defineCatalog } from "@json-render/core";
|
||||
import { schema } from "@json-render/svelte/schema";
|
||||
import { defineRegistry, Renderer } from "@json-render/svelte";
|
||||
import { shadcnComponentDefinitions } from "@json-render/shadcn-svelte/catalog";
|
||||
import { shadcnComponents } from "@json-render/shadcn-svelte";
|
||||
|
||||
const catalog = defineCatalog(schema, {
|
||||
components: {
|
||||
Card: shadcnComponentDefinitions.Card,
|
||||
Stack: shadcnComponentDefinitions.Stack,
|
||||
Heading: shadcnComponentDefinitions.Heading,
|
||||
Button: shadcnComponentDefinitions.Button,
|
||||
},
|
||||
actions: {},
|
||||
});
|
||||
|
||||
const { registry } = defineRegistry(catalog, {
|
||||
components: {
|
||||
Card: shadcnComponents.Card,
|
||||
Stack: shadcnComponents.Stack,
|
||||
Heading: shadcnComponents.Heading,
|
||||
Button: shadcnComponents.Button,
|
||||
},
|
||||
});
|
||||
|
||||
// In your Svelte component:
|
||||
// <Renderer spec={spec} registry={registry} />
|
||||
```
|
||||
|
||||
### Ink (Terminal)
|
||||
|
||||
```tsx
|
||||
import { defineCatalog } from "@json-render/core";
|
||||
import {
|
||||
schema,
|
||||
standardComponentDefinitions,
|
||||
standardActionDefinitions,
|
||||
defineRegistry,
|
||||
Renderer,
|
||||
JSONUIProvider,
|
||||
} from "@json-render/ink";
|
||||
|
||||
const catalog = defineCatalog(schema, {
|
||||
components: { ...standardComponentDefinitions },
|
||||
actions: standardActionDefinitions,
|
||||
});
|
||||
|
||||
const { registry } = defineRegistry(catalog, { components: {} });
|
||||
|
||||
const spec = {
|
||||
root: "card-1",
|
||||
elements: {
|
||||
"card-1": {
|
||||
type: "Card",
|
||||
props: { title: "Status" },
|
||||
children: ["status-1"],
|
||||
},
|
||||
"status-1": {
|
||||
type: "StatusLine",
|
||||
props: { label: "Build", status: "success" },
|
||||
children: [],
|
||||
},
|
||||
},
|
||||
};
|
||||
|
||||
<JSONUIProvider initialState={{}}>
|
||||
<Renderer spec={spec} registry={registry} />
|
||||
</JSONUIProvider>;
|
||||
```
|
||||
|
||||
## Features
|
||||
|
||||
### Streaming (SpecStream)
|
||||
@@ -307,16 +650,26 @@ Any prop value can be data-driven using expressions:
|
||||
{
|
||||
"type": "Icon",
|
||||
"props": {
|
||||
"name": { "$cond": { "$state": "/activeTab", "eq": "home" }, "$then": "home", "$else": "home-outline" },
|
||||
"color": { "$cond": { "$state": "/activeTab", "eq": "home" }, "$then": "#007AFF", "$else": "#8E8E93" }
|
||||
"name": {
|
||||
"$cond": { "$state": "/activeTab", "eq": "home" },
|
||||
"$then": "home",
|
||||
"$else": "home-outline"
|
||||
},
|
||||
"color": {
|
||||
"$cond": { "$state": "/activeTab", "eq": "home" },
|
||||
"$then": "#007AFF",
|
||||
"$else": "#8E8E93"
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Two expression forms:
|
||||
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
|
||||
- **`{ "$cond": <condition>, "$then": <value>, "$else": <value> }`** - evaluates a condition and picks a branch
|
||||
- **`{ "$template": "Hello, ${/user/name}!" }`** - interpolates state values into strings
|
||||
- **`{ "$computed": "fn", "args": { ... } }`** - calls a registered function with resolved args
|
||||
|
||||
### Actions
|
||||
|
||||
@@ -325,13 +678,38 @@ Components can trigger actions, including the built-in `setState` action:
|
||||
```json
|
||||
{
|
||||
"type": "Pressable",
|
||||
"props": { "action": "setState", "actionParams": { "statePath": "/activeTab", "value": "home" } },
|
||||
"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.
|
||||
|
||||
### State Watchers
|
||||
|
||||
React to state changes by triggering actions:
|
||||
|
||||
```json
|
||||
{
|
||||
"type": "Select",
|
||||
"props": {
|
||||
"value": { "$bindState": "/form/country" },
|
||||
"options": ["US", "Canada", "UK"]
|
||||
},
|
||||
"watch": {
|
||||
"/form/country": {
|
||||
"action": "loadCities",
|
||||
"params": { "country": { "$state": "/form/country" } }
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
`watch` is a top-level field on elements (sibling of `type`/`props`/`children`). Watchers fire when the watched value changes, not on initial render.
|
||||
|
||||
---
|
||||
|
||||
## Demo
|
||||
@@ -343,10 +721,14 @@ 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://react-email-demo.json-render.localhost:1355 - React Email Example
|
||||
- http://remotion-demo.json-render.localhost:1355 - Remotion Video Example
|
||||
- Chat Example: run `pnpm dev` in `examples/chat`
|
||||
- Svelte Example: run `pnpm dev` in `examples/svelte` or `examples/svelte-chat`
|
||||
- Vue Example: run `pnpm dev` in `examples/vue`
|
||||
- Vite Renderers (React + Vue + Svelte + Solid): run `pnpm dev` in `examples/vite-renderers`
|
||||
- React Native example: run `npx expo start` in `examples/react-native`
|
||||
|
||||
## How It Works
|
||||
@@ -356,7 +738,7 @@ flowchart LR
|
||||
A[User Prompt] --> B[AI + Catalog]
|
||||
B --> C[JSON Spec]
|
||||
C --> D[Renderer]
|
||||
|
||||
|
||||
B -.- E([guardrailed])
|
||||
C -.- F([predictable])
|
||||
D -.- G([streamed])
|
||||
|
||||
@@ -0,0 +1,104 @@
|
||||
# web
|
||||
|
||||
## 0.1.11
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [519a538]
|
||||
- @json-render/core@0.16.0
|
||||
- @json-render/codegen@0.16.0
|
||||
- @json-render/react@0.16.0
|
||||
- @json-render/yaml@0.16.0
|
||||
|
||||
## 0.1.10
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [bf3a7ec]
|
||||
- @json-render/core@0.15.0
|
||||
- @json-render/codegen@0.15.0
|
||||
- @json-render/react@0.15.0
|
||||
- @json-render/yaml@0.15.0
|
||||
|
||||
## 0.1.9
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [43b7515]
|
||||
- @json-render/core@0.14.1
|
||||
- @json-render/codegen@0.14.1
|
||||
- @json-render/react@0.14.1
|
||||
- @json-render/yaml@0.14.1
|
||||
|
||||
## 0.1.8
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [a8afd8b]
|
||||
- @json-render/core@0.14.0
|
||||
- @json-render/yaml@0.14.0
|
||||
- @json-render/codegen@0.14.0
|
||||
- @json-render/react@0.14.0
|
||||
|
||||
## 0.1.7
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [5b32de8]
|
||||
- @json-render/core@0.13.0
|
||||
- @json-render/codegen@0.13.0
|
||||
- @json-render/react@0.13.0
|
||||
|
||||
## 0.1.6
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [54a1ecf]
|
||||
- @json-render/core@0.12.1
|
||||
- @json-render/codegen@0.12.1
|
||||
- @json-render/react@0.12.1
|
||||
|
||||
## 0.1.5
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [63c339b]
|
||||
- @json-render/core@0.12.0
|
||||
- @json-render/codegen@0.12.0
|
||||
- @json-render/react@0.12.0
|
||||
|
||||
## 0.1.4
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [3f1e71e]
|
||||
- @json-render/core@0.11.0
|
||||
- @json-render/codegen@0.11.0
|
||||
- @json-render/react@0.11.0
|
||||
|
||||
## 0.1.3
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [9cef4e9]
|
||||
- @json-render/core@0.10.0
|
||||
- @json-render/react@0.10.0
|
||||
- @json-render/codegen@0.10.0
|
||||
|
||||
## 0.1.2
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [b103676]
|
||||
- @json-render/react@0.9.1
|
||||
- @json-render/core@0.9.1
|
||||
- @json-render/codegen@0.9.1
|
||||
|
||||
## 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,4 +1,5 @@
|
||||
export const metadata = { title: "A2UI Integration" }
|
||||
import { pageMetadata } from "@/lib/page-metadata"
|
||||
export const metadata = pageMetadata("docs/a2ui")
|
||||
|
||||
# A2UI Integration
|
||||
|
||||
@@ -66,7 +67,7 @@ A2UI uses an adjacency list model - a flat list of components with ID references
|
||||
|
||||
```typescript
|
||||
import { defineCatalog } from '@json-render/core';
|
||||
import { schema } from '@json-render/react';
|
||||
import { schema } from '@json-render/react/schema';
|
||||
import { z } from 'zod';
|
||||
|
||||
// A2UI BoundValue schema
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
export const metadata = { title: "Adaptive Cards Integration" }
|
||||
import { pageMetadata } from "@/lib/page-metadata"
|
||||
export const metadata = pageMetadata("docs/adaptive-cards")
|
||||
|
||||
# Adaptive Cards Integration
|
||||
|
||||
@@ -89,7 +90,7 @@ Define a catalog matching the Adaptive Cards element types:
|
||||
|
||||
```typescript
|
||||
import { defineCatalog } from '@json-render/core';
|
||||
import { schema } from '@json-render/react';
|
||||
import { schema } from '@json-render/react/schema';
|
||||
import { z } from 'zod';
|
||||
|
||||
// Common Adaptive Cards properties
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
export const metadata = { title: "AG-UI Integration" }
|
||||
import { pageMetadata } from "@/lib/page-metadata"
|
||||
export const metadata = pageMetadata("docs/ag-ui")
|
||||
|
||||
# AG-UI Integration
|
||||
|
||||
@@ -150,7 +151,7 @@ Create a catalog for UI components that agents can render:
|
||||
|
||||
```typescript
|
||||
import { defineCatalog } from '@json-render/core';
|
||||
import { schema } from '@json-render/react';
|
||||
import { schema } from '@json-render/react/schema';
|
||||
import { z } from 'zod';
|
||||
|
||||
export const aguiCatalog = defineCatalog(schema, {
|
||||
|
||||
@@ -1,8 +1,9 @@
|
||||
export const metadata = { title: "AI SDK Integration" }
|
||||
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.
|
||||
Use json-render with the [Vercel AI SDK](https://sdk.vercel.ai) for seamless streaming. json-render supports two modes: **Standalone** (standalone UI) and **Inline** (UI embedded in conversation). See [Generation Modes](/docs/generation-modes) for a detailed comparison.
|
||||
|
||||
## Installation
|
||||
|
||||
@@ -10,9 +11,9 @@ Use json-render with the [Vercel AI SDK](https://sdk.vercel.ai) for seamless str
|
||||
npm install ai @ai-sdk/react
|
||||
```
|
||||
|
||||
## Generate Mode
|
||||
## Standalone 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.
|
||||
In standalone 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
|
||||
|
||||
@@ -72,9 +73,9 @@ function GenerativeUI() {
|
||||
}
|
||||
```
|
||||
|
||||
## Chat Mode
|
||||
## Inline 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.
|
||||
In inline 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
|
||||
|
||||
@@ -95,7 +96,7 @@ export async function POST(req: Request) {
|
||||
|
||||
const result = streamText({
|
||||
model: yourModel,
|
||||
system: catalog.prompt({ mode: "chat" }),
|
||||
system: catalog.prompt({ mode: "inline" }),
|
||||
messages,
|
||||
});
|
||||
|
||||
@@ -181,13 +182,13 @@ const systemPrompt = catalog.prompt({
|
||||
});
|
||||
```
|
||||
|
||||
### Chat Mode Prompt
|
||||
### Inline Mode Prompt
|
||||
|
||||
```typescript
|
||||
const chatPrompt = catalog.prompt({ mode: "chat" });
|
||||
const inlinePrompt = catalog.prompt({ mode: "inline" });
|
||||
```
|
||||
|
||||
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.
|
||||
In inline 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?
|
||||
|
||||
@@ -196,8 +197,8 @@ In chat mode, the prompt instructs the AI to respond conversationally first, the
|
||||
<thead>
|
||||
<tr>
|
||||
<th></th>
|
||||
<th>Generate</th>
|
||||
<th>Chat</th>
|
||||
<th>Standalone</th>
|
||||
<th>Inline</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
@@ -214,7 +215,7 @@ In chat mode, the prompt instructs the AI to respond conversationally first, the
|
||||
<tr>
|
||||
<td>System prompt</td>
|
||||
<td><code>catalog.prompt()</code></td>
|
||||
<td><code>{"catalog.prompt({ mode: \"chat\" })"}</code></td>
|
||||
<td><code>{"catalog.prompt({ mode: \"inline\" })"}</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Stream utility</td>
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
export const metadata = { title: "@json-render/codegen API" }
|
||||
import { pageMetadata } from "@/lib/page-metadata"
|
||||
export const metadata = pageMetadata("docs/api/codegen")
|
||||
|
||||
# @json-render/codegen
|
||||
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
export const metadata = { title: "@json-render/core API" }
|
||||
import { pageMetadata } from "@/lib/page-metadata"
|
||||
export const metadata = pageMetadata("docs/api/core")
|
||||
|
||||
# @json-render/core
|
||||
|
||||
@@ -10,7 +11,7 @@ Creates a type-safe catalog definition with schema validation.
|
||||
|
||||
```typescript
|
||||
import { defineCatalog } from '@json-render/core';
|
||||
import { schema } from '@json-render/react';
|
||||
import { schema } from '@json-render/react/schema';
|
||||
|
||||
function defineCatalog<T extends ZodType>(
|
||||
s: T,
|
||||
@@ -74,7 +75,8 @@ interface Catalog {
|
||||
interface PromptOptions {
|
||||
system?: string; // Custom system message intro
|
||||
customRules?: string[]; // Additional rules to append
|
||||
mode?: "generate" | "chat"; // Output mode (default: "generate")
|
||||
mode?: "standalone" | "inline" | "generate" | "chat"; // Output mode (default: "standalone")
|
||||
editModes?: EditMode[]; // Edit modes to document in prompt (default: ["patch"])
|
||||
}
|
||||
|
||||
interface SpecValidationResult<T> {
|
||||
@@ -118,7 +120,7 @@ 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';
|
||||
import { schema } from '@json-render/react/schema';
|
||||
|
||||
// schema defines:
|
||||
// - Spec shape: { root: string, elements: Record<string, UIElement> }
|
||||
@@ -369,7 +371,7 @@ Most users should use `pipeJsonRender()` instead, which wraps this transform for
|
||||
|
||||
### createMixedStreamParser
|
||||
|
||||
Parse a mixed stream of text and JSONL patches (used for Chat + GenUI mode):
|
||||
Parse a mixed stream of text and JSONL patches (used for Inline mode):
|
||||
|
||||
```typescript
|
||||
import { createMixedStreamParser } from '@json-render/core';
|
||||
@@ -388,7 +390,7 @@ 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.
|
||||
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 Inline mode API routes.
|
||||
|
||||
```typescript
|
||||
import { pipeJsonRender } from '@json-render/core';
|
||||
@@ -402,7 +404,7 @@ const stream = createUIMessageStream({
|
||||
return createUIMessageStreamResponse({ stream });
|
||||
```
|
||||
|
||||
See [Generation Modes](/docs/generation-modes) for full Chat mode setup.
|
||||
See [Generation Modes](/docs/generation-modes) for full Inline mode setup.
|
||||
|
||||
### SpecStream Types
|
||||
|
||||
@@ -479,9 +481,10 @@ 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)
|
||||
currentSpec?: Spec | null; // Existing spec to refine (triggers edit mode)
|
||||
state?: Record<string, unknown> | null; // Runtime state context to include
|
||||
maxPromptLength?: number; // Max length for user text (truncates before wrapping)
|
||||
editModes?: EditMode[]; // Edit modes for refinement (default: ["patch"])
|
||||
}
|
||||
```
|
||||
|
||||
@@ -491,14 +494,15 @@ interface UserPromptOptions {
|
||||
const userPrompt = buildUserPrompt({ prompt: "create a todo app" });
|
||||
```
|
||||
|
||||
### Refinement (patch-only mode)
|
||||
### Refinement (edit modes)
|
||||
|
||||
When `currentSpec` is provided, the prompt instructs the AI to output only the patches needed for the change, not recreate the entire spec:
|
||||
When `currentSpec` is provided, the prompt instructs the AI to use the specified edit modes instead of recreating the entire spec. Available modes: `"patch"` (RFC 6902), `"merge"` (RFC 7396), and `"diff"` (unified diff).
|
||||
|
||||
```typescript
|
||||
const userPrompt = buildUserPrompt({
|
||||
prompt: "add a dark mode toggle",
|
||||
currentSpec: existingSpec,
|
||||
editModes: ["patch", "merge"],
|
||||
});
|
||||
```
|
||||
|
||||
@@ -513,6 +517,93 @@ const userPrompt = buildUserPrompt({
|
||||
});
|
||||
```
|
||||
|
||||
## Edit Modes
|
||||
|
||||
Universal edit mode utilities for modifying existing specs. Used by `buildUserPrompt` internally and available for direct use.
|
||||
|
||||
```typescript
|
||||
import {
|
||||
buildEditInstructions,
|
||||
buildEditUserPrompt,
|
||||
isNonEmptySpec,
|
||||
type EditMode,
|
||||
type EditConfig,
|
||||
} from '@json-render/core';
|
||||
|
||||
type EditMode = "patch" | "merge" | "diff";
|
||||
```
|
||||
|
||||
### buildEditInstructions
|
||||
|
||||
Generate the prompt section describing available edit modes. Supports both JSON and YAML formats.
|
||||
|
||||
```typescript
|
||||
function buildEditInstructions(config: EditConfig, format: "json" | "yaml"): string
|
||||
|
||||
const instructions = buildEditInstructions({ modes: ["patch", "merge"] }, "json");
|
||||
```
|
||||
|
||||
### buildEditUserPrompt
|
||||
|
||||
Build a user prompt for editing an existing spec. Includes the current spec (with line numbers when diff mode is enabled) and mode-specific instructions.
|
||||
|
||||
```typescript
|
||||
function buildEditUserPrompt(options: BuildEditUserPromptOptions): string
|
||||
|
||||
interface BuildEditUserPromptOptions {
|
||||
prompt: string;
|
||||
currentSpec?: Spec | null;
|
||||
config?: EditConfig;
|
||||
format: "json" | "yaml";
|
||||
maxPromptLength?: number;
|
||||
serializer?: (spec: Spec) => string;
|
||||
}
|
||||
```
|
||||
|
||||
### isNonEmptySpec
|
||||
|
||||
Check whether a value is a non-empty spec (has a root string and at least one element).
|
||||
|
||||
```typescript
|
||||
function isNonEmptySpec(spec: unknown): spec is Spec
|
||||
```
|
||||
|
||||
## Deep Merge and Diff
|
||||
|
||||
Format-agnostic utilities for merging and diffing spec objects.
|
||||
|
||||
### deepMergeSpec
|
||||
|
||||
Deep-merge with RFC 7396 semantics: `null` deletes, arrays replace, objects recurse. Neither input is mutated.
|
||||
|
||||
```typescript
|
||||
import { deepMergeSpec } from '@json-render/core';
|
||||
|
||||
function deepMergeSpec(
|
||||
base: Record<string, unknown>,
|
||||
patch: Record<string, unknown>
|
||||
): Record<string, unknown>
|
||||
|
||||
const merged = deepMergeSpec(currentSpec, { elements: { main: { props: { title: "New" } } } });
|
||||
```
|
||||
|
||||
### diffToPatches
|
||||
|
||||
Generate RFC 6902 JSON Patch operations that transform one object into another. Arrays are compared shallowly and replaced atomically; plain objects recurse.
|
||||
|
||||
```typescript
|
||||
import { diffToPatches } from '@json-render/core';
|
||||
|
||||
function diffToPatches(
|
||||
oldObj: Record<string, unknown>,
|
||||
newObj: Record<string, unknown>,
|
||||
basePath?: string
|
||||
): JsonPatch[]
|
||||
|
||||
const patches = diffToPatches(oldSpec, newSpec);
|
||||
// [{ op: "replace", path: "/elements/main/props/title", value: "New Title" }]
|
||||
```
|
||||
|
||||
## evaluateVisibility
|
||||
|
||||
Evaluates a visibility condition against the state model.
|
||||
|
||||
@@ -0,0 +1,364 @@
|
||||
import { pageMetadata } from "@/lib/page-metadata"
|
||||
export const metadata = pageMetadata("docs/api/image")
|
||||
|
||||
# @json-render/image
|
||||
|
||||
Image renderer. Turn JSON specs into SVG and PNG images using [Satori](https://github.com/vercel/satori).
|
||||
|
||||
## Install
|
||||
|
||||
```bash
|
||||
npm install @json-render/core @json-render/image
|
||||
```
|
||||
|
||||
For PNG output, also install the optional peer dependency:
|
||||
|
||||
```bash
|
||||
npm install @resvg/resvg-js
|
||||
```
|
||||
|
||||
See the [Image example](https://github.com/vercel-labs/json-render/tree/main/examples/image) for a full working example.
|
||||
|
||||
## schema
|
||||
|
||||
The image element schema for image specs. Use with `defineCatalog` from core.
|
||||
|
||||
```typescript
|
||||
import { defineCatalog } from '@json-render/core';
|
||||
import { schema, standardComponentDefinitions } from '@json-render/image';
|
||||
|
||||
const catalog = defineCatalog(schema, {
|
||||
components: standardComponentDefinitions,
|
||||
});
|
||||
```
|
||||
|
||||
## Render Functions
|
||||
|
||||
Server-side functions for producing image output. Both accept a spec and optional `RenderOptions`.
|
||||
|
||||
```typescript
|
||||
import { renderToSvg, renderToPng } from '@json-render/image/render';
|
||||
|
||||
const svg = await renderToSvg(spec, { fonts });
|
||||
|
||||
const png = await renderToPng(spec, { fonts });
|
||||
await writeFile('output.png', png);
|
||||
```
|
||||
|
||||
### RenderOptions
|
||||
|
||||
```typescript
|
||||
interface RenderOptions {
|
||||
registry?: ComponentRegistry;
|
||||
includeStandard?: boolean; // default: true
|
||||
state?: Record<string, unknown>;
|
||||
fonts?: SatoriOptions['fonts'];
|
||||
width?: number;
|
||||
height?: number;
|
||||
}
|
||||
```
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Option</th>
|
||||
<th>Type</th>
|
||||
<th>Default</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>fonts</code></td>
|
||||
<td><code>{"SatoriOptions['fonts']"}</code></td>
|
||||
<td><code>[]</code></td>
|
||||
<td>Font data for text rendering (required for meaningful output)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>width</code></td>
|
||||
<td><code>number</code></td>
|
||||
<td>Frame prop</td>
|
||||
<td>Override the output image width</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>height</code></td>
|
||||
<td><code>number</code></td>
|
||||
<td>Frame prop</td>
|
||||
<td>Override the output image height</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>registry</code></td>
|
||||
<td><code>{"Record<string, ComponentRenderer>"}</code></td>
|
||||
<td><code>{"{}"}</code></td>
|
||||
<td>Custom component map (merged with standard components)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>includeStandard</code></td>
|
||||
<td><code>boolean</code></td>
|
||||
<td><code>true</code></td>
|
||||
<td>Include built-in standard components</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>state</code></td>
|
||||
<td><code>{"Record<string, unknown>"}</code></td>
|
||||
<td><code>{"{}"}</code></td>
|
||||
<td>Initial state for <code>$state</code> / <code>$cond</code> dynamic prop resolution</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
## Standard Components
|
||||
|
||||
### Root
|
||||
|
||||
#### Frame
|
||||
|
||||
Root image container. Defines the output image dimensions and background. Must be the root element.
|
||||
|
||||
```typescript
|
||||
{
|
||||
width: number;
|
||||
height: number;
|
||||
backgroundColor: string | null;
|
||||
padding: number | null;
|
||||
display: "flex" | "none" | null;
|
||||
flexDirection: "row" | "column" | null;
|
||||
alignItems: "flex-start" | "center" | "flex-end" | "stretch" | null;
|
||||
justifyContent: "flex-start" | "center" | "flex-end" | "space-between" | "space-around" | null;
|
||||
}
|
||||
```
|
||||
|
||||
### Layout
|
||||
|
||||
#### Box
|
||||
|
||||
Generic container with padding, margin, background, border, and flex alignment. Supports absolute positioning.
|
||||
|
||||
```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;
|
||||
width: number | string | null;
|
||||
height: number | string | null;
|
||||
alignItems: "flex-start" | "center" | "flex-end" | "stretch" | null;
|
||||
justifyContent: "flex-start" | "center" | "flex-end" | "space-between" | "space-around" | null;
|
||||
flexDirection: "row" | "column" | null;
|
||||
position: "relative" | "absolute" | null;
|
||||
top: number | null;
|
||||
left: number | null;
|
||||
right: number | null;
|
||||
bottom: number | null;
|
||||
overflow: "visible" | "hidden" | 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
|
||||
|
||||
Heading text at various levels. h1 is largest, h4 is smallest.
|
||||
|
||||
```typescript
|
||||
{
|
||||
text: string;
|
||||
level: "h1" | "h2" | "h3" | "h4" | null;
|
||||
color: string | null;
|
||||
align: "left" | "center" | "right" | null;
|
||||
letterSpacing: number | string | null;
|
||||
lineHeight: number | null;
|
||||
}
|
||||
```
|
||||
|
||||
#### Text
|
||||
|
||||
Body text with configurable size, color, weight, and alignment.
|
||||
|
||||
```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;
|
||||
letterSpacing: number | string | null;
|
||||
textDecoration: "none" | "underline" | "line-through" | null;
|
||||
}
|
||||
```
|
||||
|
||||
#### Image
|
||||
|
||||
Image from a URL with optional dimensions and fit.
|
||||
|
||||
```typescript
|
||||
{
|
||||
src: string;
|
||||
width: number | null;
|
||||
height: number | null;
|
||||
borderRadius: number | null;
|
||||
objectFit: "contain" | "cover" | "fill" | "none" | 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;
|
||||
}
|
||||
```
|
||||
|
||||
## Catalog Definitions
|
||||
|
||||
Pre-built definitions for creating image catalogs:
|
||||
|
||||
```typescript
|
||||
import { standardComponentDefinitions } from '@json-render/image/catalog';
|
||||
import { defineCatalog } from '@json-render/core';
|
||||
import { schema } from '@json-render/image';
|
||||
|
||||
const catalog = defineCatalog(schema, {
|
||||
components: {
|
||||
...standardComponentDefinitions,
|
||||
// Add custom components
|
||||
},
|
||||
});
|
||||
```
|
||||
|
||||
## Server-Safe Import
|
||||
|
||||
Import schema and catalog definitions without pulling in React or Satori:
|
||||
|
||||
```typescript
|
||||
import { schema, standardComponentDefinitions } from '@json-render/image/server';
|
||||
```
|
||||
|
||||
## Sub-path Exports
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Export</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>@json-render/image</code></td>
|
||||
<td>Full package: schema, renderer, components, render functions</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>@json-render/image/server</code></td>
|
||||
<td>Schema and catalog definitions only (no React or Satori)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>@json-render/image/catalog</code></td>
|
||||
<td>Standard component definitions and types</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>@json-render/image/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>ImageSchema</code></td>
|
||||
<td>Schema type for image specs</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>ImageSpec</code></td>
|
||||
<td>Spec type for image output</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>RenderOptions</code></td>
|
||||
<td>Options for render functions</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>ComponentRenderProps</code></td>
|
||||
<td>Props passed to component render functions</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>ComponentRenderer</code></td>
|
||||
<td>Component render function type</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>ComponentRegistry</code></td>
|
||||
<td>Map of component names to render functions</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,293 @@
|
||||
import { pageMetadata } from "@/lib/page-metadata"
|
||||
export const metadata = pageMetadata("docs/api/ink")
|
||||
|
||||
# @json-render/ink
|
||||
|
||||
Terminal renderer for [Ink](https://github.com/vadimdemedes/ink) with multiple standard components, providers, hooks, and streaming support.
|
||||
|
||||
## Installation
|
||||
|
||||
<PackageInstall packages="@json-render/core @json-render/ink" />
|
||||
|
||||
Peer dependencies: `react ^18.0.0 || ^19.0.0`, `ink ^6.0.0`, and `zod ^4.0.0`.
|
||||
|
||||
<PackageInstall packages="react ink zod" />
|
||||
|
||||
## Standard Components
|
||||
|
||||
### Layout
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Component</th><th>Props</th><th>Description</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td><code>Box</code></td><td><code>flexDirection</code>, <code>alignItems</code>, <code>justifyContent</code>, <code>gap</code>, <code>padding</code>, <code>margin</code>, <code>borderStyle</code>, <code>borderColor</code>, <code>width</code>, <code>height</code>, <code>display</code>, <code>overflow</code></td><td>Flexbox layout container (like a terminal div)</td></tr>
|
||||
<tr><td><code>Spacer</code></td><td>(none)</td><td>Flexible empty space that expands to fill available room</td></tr>
|
||||
<tr><td><code>Newline</code></td><td><code>count</code></td><td>Insert blank lines</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
### Content
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Component</th><th>Props</th><th>Description</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td><code>Text</code></td><td><code>text</code>, <code>color</code>, <code>bold</code>, <code>italic</code>, <code>underline</code>, <code>strikethrough</code>, <code>dimColor</code>, <code>inverse</code>, <code>wrap</code></td><td>Text output with styling</td></tr>
|
||||
<tr><td><code>Heading</code></td><td><code>text</code>, <code>level</code> (h1-h4), <code>color</code></td><td>Section heading</td></tr>
|
||||
<tr><td><code>Divider</code></td><td><code>character</code>, <code>color</code>, <code>dimColor</code>, <code>title</code>, <code>width</code></td><td>Horizontal separator line with optional title</td></tr>
|
||||
<tr><td><code>Badge</code></td><td><code>label</code>, <code>variant</code></td><td>Colored inline label (default, info, success, warning, error)</td></tr>
|
||||
<tr><td><code>Spinner</code></td><td><code>label</code>, <code>color</code></td><td>Animated loading spinner</td></tr>
|
||||
<tr><td><code>ProgressBar</code></td><td><code>progress</code> (0-1), <code>width</code>, <code>color</code>, <code>label</code></td><td>Horizontal progress bar</td></tr>
|
||||
<tr><td><code>StatusLine</code></td><td><code>text</code>, <code>status</code>, <code>icon</code></td><td>Status message with colored icon</td></tr>
|
||||
<tr><td><code>KeyValue</code></td><td><code>label</code>, <code>value</code>, <code>labelColor</code>, <code>separator</code></td><td>Key-value pair display</td></tr>
|
||||
<tr><td><code>Link</code></td><td><code>url</code>, <code>label</code>, <code>color</code></td><td>Renders a URL as underlined text. Shows "label (url)" when label is provided.</td></tr>
|
||||
<tr><td><code>Markdown</code></td><td><code>text</code></td><td>Renders markdown with terminal styling (headings, bold, italic, code, lists, blockquotes, horizontal rules)</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
### Data
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Component</th><th>Props</th><th>Description</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td><code>Table</code></td><td><code>columns</code>, <code>rows</code>, <code>borderStyle</code>, <code>headerColor</code></td><td>Tabular data with headers</td></tr>
|
||||
<tr><td><code>List</code></td><td><code>items</code>, <code>ordered</code>, <code>bulletChar</code>, <code>spacing</code></td><td>Bulleted or numbered list</td></tr>
|
||||
<tr><td><code>ListItem</code></td><td><code>title</code>, <code>subtitle</code>, <code>leading</code>, <code>trailing</code></td><td>Structured list row</td></tr>
|
||||
<tr><td><code>Card</code></td><td><code>title</code>, <code>borderStyle</code>, <code>borderColor</code>, <code>padding</code></td><td>Bordered container with optional title</td></tr>
|
||||
<tr><td><code>Sparkline</code></td><td><code>data</code>, <code>width</code>, <code>color</code>, <code>label</code>, <code>min</code>, <code>max</code></td><td>Inline sparkline chart using Unicode blocks (▁▂▃▄▅▆▇█)</td></tr>
|
||||
<tr><td><code>BarChart</code></td><td><code>data</code> (label/value/color), <code>width</code>, <code>showValues</code>, <code>showPercentage</code></td><td>Horizontal bar chart for comparing values</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
### Interactive
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Component</th><th>Props</th><th>Description</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td><code>TextInput</code></td><td><code>placeholder</code>, <code>value</code> (use <code>$bindState</code>), <code>label</code>, <code>mask</code></td><td>Text input field. Press Enter to submit.</td></tr>
|
||||
<tr><td><code>Select</code></td><td><code>options</code>, <code>value</code> (use <code>$bindState</code>), <code>label</code></td><td>Arrow-key selection menu</td></tr>
|
||||
<tr><td><code>MultiSelect</code></td><td><code>options</code>, <code>value</code> (use <code>$bindState</code>), <code>label</code>, <code>min</code>, <code>max</code></td><td>Multi-selection menu. Space to toggle, Enter to confirm.</td></tr>
|
||||
<tr><td><code>ConfirmInput</code></td><td><code>message</code>, <code>defaultValue</code>, <code>yesLabel</code>, <code>noLabel</code></td><td>Yes/No confirmation prompt. Press Y or N.</td></tr>
|
||||
<tr><td><code>Tabs</code></td><td><code>tabs</code>, <code>value</code> (use <code>$bindState</code>), <code>color</code></td><td>Tab bar navigation with left/right arrow keys. Place child content inside with visible conditions.</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
## Providers
|
||||
|
||||
### JSONUIProvider
|
||||
|
||||
Convenience wrapper around all providers: `StateProvider` → `VisibilityProvider` → `ValidationProvider` → `ActionProvider` → `FocusProvider`.
|
||||
|
||||
```tsx
|
||||
import { JSONUIProvider, Renderer } from "@json-render/ink";
|
||||
|
||||
<JSONUIProvider initialState={{}} handlers={handlers}>
|
||||
<Renderer spec={spec} registry={registry} />
|
||||
</JSONUIProvider>
|
||||
```
|
||||
|
||||
### StateProvider
|
||||
|
||||
```tsx
|
||||
<StateProvider initialState={object} onStateChange={fn}>
|
||||
{children}
|
||||
</StateProvider>
|
||||
```
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Prop</th><th>Type</th><th>Description</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td><code>store</code></td><td><code>StateStore</code></td><td>External store (controlled mode). When provided, <code>initialState</code> and <code>onStateChange</code> are ignored.</td></tr>
|
||||
<tr><td><code>initialState</code></td><td><code>Record<string, unknown></code></td><td>Initial state model (uncontrolled mode).</td></tr>
|
||||
<tr><td><code>onStateChange</code></td><td><code>{'(changes: Array<{ path: string; value: unknown }>) => void'}</code></td><td>Callback when state changes (uncontrolled mode).</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
#### External Store (Controlled Mode)
|
||||
|
||||
Pass a `StateStore` to bypass internal state and wire json-render to any state management:
|
||||
|
||||
```tsx
|
||||
import { createStateStore } from "@json-render/ink";
|
||||
|
||||
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>} navigate={fn}>
|
||||
{children}
|
||||
</ActionProvider>
|
||||
```
|
||||
|
||||
Built-in actions: `setState`, `pushState`, `removeState`, `log`, `exit`. Custom handlers override built-ins. Includes a terminal confirmation dialog (press Y/N) for actions with `confirm`.
|
||||
|
||||
### VisibilityProvider
|
||||
|
||||
```tsx
|
||||
<VisibilityProvider>
|
||||
{children}
|
||||
</VisibilityProvider>
|
||||
```
|
||||
|
||||
### ValidationProvider
|
||||
|
||||
```tsx
|
||||
<ValidationProvider>
|
||||
{children}
|
||||
</ValidationProvider>
|
||||
```
|
||||
|
||||
### FocusProvider
|
||||
|
||||
```tsx
|
||||
<FocusProvider>
|
||||
{children}
|
||||
</FocusProvider>
|
||||
```
|
||||
|
||||
Manages Tab-cycling focus between interactive components (TextInput, Select). Supports `useFocusDisable` to suppress cycling during modal dialogs.
|
||||
|
||||
## defineRegistry
|
||||
|
||||
Create a type-safe component registry. Standard components are built-in; only register custom components.
|
||||
|
||||
```tsx
|
||||
import { defineRegistry, type Components } from "@json-render/ink";
|
||||
|
||||
const { registry, handlers, executeAction } = defineRegistry(catalog, {
|
||||
components: {
|
||||
MyWidget: ({ props }) => <Text>{props.label}</Text>,
|
||||
} as Components<typeof catalog>,
|
||||
actions: {
|
||||
submit: async (params, setState, state) => {
|
||||
// custom action logic
|
||||
},
|
||||
},
|
||||
});
|
||||
```
|
||||
|
||||
`handlers` is designed for `JSONUIProvider`/`ActionProvider`. `executeAction` is an imperative helper.
|
||||
|
||||
## createRenderer
|
||||
|
||||
Higher-level helper that wraps `Renderer` + all providers into a single component.
|
||||
|
||||
```tsx
|
||||
import { createRenderer } from "@json-render/ink";
|
||||
|
||||
const UIRenderer = createRenderer(catalog, components);
|
||||
|
||||
<UIRenderer spec={spec} state={initialState} />;
|
||||
```
|
||||
|
||||
## 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>
|
||||
stop, // () => void - abort the current stream
|
||||
clear, // () => void - reset spec and error
|
||||
} = useUIStream({
|
||||
api: string,
|
||||
onComplete?: (spec: Spec) => void,
|
||||
onError?: (error: Error) => void,
|
||||
fetch?: (url: string, init?: RequestInit) => Promise<Response>,
|
||||
validate?: boolean,
|
||||
maxRetries?: number,
|
||||
});
|
||||
```
|
||||
|
||||
### useStateStore
|
||||
|
||||
```typescript
|
||||
const { state, get, set, update } = useStateStore();
|
||||
```
|
||||
|
||||
### useStateValue
|
||||
|
||||
```typescript
|
||||
const value = useStateValue(path: string);
|
||||
```
|
||||
|
||||
### useBoundProp
|
||||
|
||||
```typescript
|
||||
const [value, setValue] = useBoundProp(resolvedValue, bindingPath);
|
||||
```
|
||||
|
||||
### useActions
|
||||
|
||||
```typescript
|
||||
const { execute } = useActions();
|
||||
```
|
||||
|
||||
### useIsVisible
|
||||
|
||||
```typescript
|
||||
const isVisible = useIsVisible(condition?: VisibilityCondition);
|
||||
```
|
||||
|
||||
### useFocus
|
||||
|
||||
```typescript
|
||||
const { isActive, id } = useFocus();
|
||||
```
|
||||
|
||||
### useFocusDisable
|
||||
|
||||
```typescript
|
||||
useFocusDisable(disabled: boolean);
|
||||
```
|
||||
|
||||
Suppresses Tab-cycling while `disabled` is true (e.g., during a modal dialog).
|
||||
|
||||
## Catalog Exports
|
||||
|
||||
```typescript
|
||||
import { standardComponentDefinitions, standardActionDefinitions } from "@json-render/ink/catalog";
|
||||
import { schema } from "@json-render/ink/schema";
|
||||
```
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Export</th><th>Purpose</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td><code>standardComponentDefinitions</code></td><td>Catalog definitions for all 19 standard components</td></tr>
|
||||
<tr><td><code>standardActionDefinitions</code></td><td>Catalog definitions for standard actions (setState, pushState, removeState, log, exit)</td></tr>
|
||||
<tr><td><code>schema</code></td><td>Ink element tree schema</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
## Server Export
|
||||
|
||||
```typescript
|
||||
import { schema, standardComponentDefinitions, standardActionDefinitions } from "@json-render/ink/server";
|
||||
```
|
||||
|
||||
Re-exports the schema and catalog definitions for server-side usage (e.g., building system prompts).
|
||||
@@ -0,0 +1,104 @@
|
||||
import { pageMetadata } from "@/lib/page-metadata"
|
||||
export const metadata = pageMetadata("docs/api/jotai")
|
||||
|
||||
# @json-render/jotai
|
||||
|
||||
Jotai adapter for json-render's `StateStore` interface.
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
npm install @json-render/jotai @json-render/core @json-render/react jotai
|
||||
```
|
||||
|
||||
## jotaiStateStore
|
||||
|
||||
Create a `StateStore` backed by a Jotai atom.
|
||||
|
||||
```typescript
|
||||
import { jotaiStateStore } from "@json-render/jotai";
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Option</th>
|
||||
<th>Type</th>
|
||||
<th>Required</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>atom</code></td>
|
||||
<td><code>{'WritableAtom<StateModel, [StateModel], void>'}</code></td>
|
||||
<td>Yes</td>
|
||||
<td>A writable atom holding the state model.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>store</code></td>
|
||||
<td>Jotai <code>Store</code></td>
|
||||
<td>No</td>
|
||||
<td>The Jotai store instance. Defaults to a new store created internally. Pass your own to share state with <code>{'<Provider>'}</code>.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import { atom } from "jotai";
|
||||
import { jotaiStateStore } from "@json-render/jotai";
|
||||
import { StateProvider } from "@json-render/react";
|
||||
|
||||
const uiAtom = atom<Record<string, unknown>>({ count: 0 });
|
||||
const store = jotaiStateStore({ atom: uiAtom });
|
||||
```
|
||||
|
||||
```tsx
|
||||
<StateProvider store={store}>
|
||||
{/* json-render reads/writes go through Jotai */}
|
||||
</StateProvider>
|
||||
```
|
||||
|
||||
### Shared Jotai Store
|
||||
|
||||
If your app already uses a Jotai `<Provider>` with a custom store, pass it so both json-render and your components share the same state:
|
||||
|
||||
```typescript
|
||||
import { atom, createStore } from "jotai";
|
||||
import { Provider as JotaiProvider } from "jotai/react";
|
||||
import { jotaiStateStore } from "@json-render/jotai";
|
||||
import { StateProvider } from "@json-render/react";
|
||||
|
||||
const jStore = createStore();
|
||||
const uiAtom = atom<Record<string, unknown>>({ count: 0 });
|
||||
const store = jotaiStateStore({ atom: uiAtom, store: jStore });
|
||||
```
|
||||
|
||||
```tsx
|
||||
<JotaiProvider store={jStore}>
|
||||
<StateProvider store={store}>
|
||||
{/* Both json-render and useAtom() see the same state */}
|
||||
</StateProvider>
|
||||
</JotaiProvider>
|
||||
```
|
||||
|
||||
## Re-exports
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Export</th>
|
||||
<th>Source</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>StateStore</code></td>
|
||||
<td><code>@json-render/core</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
@@ -0,0 +1,247 @@
|
||||
import { pageMetadata } from "@/lib/page-metadata"
|
||||
export const metadata = pageMetadata("docs/api/mcp")
|
||||
|
||||
# @json-render/mcp
|
||||
|
||||
MCP Apps integration for json-render. Serve json-render UIs as interactive [MCP Apps](https://modelcontextprotocol.io/docs/extensions/apps) inside Claude, ChatGPT, Cursor, VS Code, and other MCP-capable clients.
|
||||
|
||||
## Install
|
||||
|
||||
```bash
|
||||
npm install @json-render/mcp @json-render/core @modelcontextprotocol/sdk
|
||||
```
|
||||
|
||||
For the iframe-side React UI, also install:
|
||||
|
||||
```bash
|
||||
npm install @json-render/react react react-dom
|
||||
```
|
||||
|
||||
See the [MCP example](https://github.com/vercel-labs/json-render/tree/main/examples/mcp) for a full working example.
|
||||
|
||||
## Overview
|
||||
|
||||
MCP Apps let MCP servers return interactive HTML UIs that render directly inside chat conversations. `@json-render/mcp` bridges json-render catalogs with the MCP Apps protocol:
|
||||
|
||||
1. Your **catalog** defines which components and actions the AI can use
|
||||
2. The **MCP server** exposes the catalog as a tool with the spec schema
|
||||
3. The **bundled HTML** renders json-render specs inside the host's sandboxed iframe
|
||||
4. The AI generates a spec, the host renders it, and users interact with the live UI
|
||||
|
||||
## Server API
|
||||
|
||||
### createMcpApp
|
||||
|
||||
Create a fully-configured MCP server. This is the main entry point.
|
||||
|
||||
```typescript
|
||||
import { createMcpApp } from "@json-render/mcp";
|
||||
import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js";
|
||||
import fs from "node:fs";
|
||||
|
||||
const server = createMcpApp({
|
||||
name: "My Dashboard",
|
||||
version: "1.0.0",
|
||||
catalog: myCatalog,
|
||||
html: fs.readFileSync("dist/index.html", "utf-8"),
|
||||
});
|
||||
|
||||
await server.connect(new StdioServerTransport());
|
||||
```
|
||||
|
||||
#### CreateMcpAppOptions
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Option</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>name</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>Server name shown in client UIs</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>version</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>Server version</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>catalog</code></td>
|
||||
<td><code>Catalog</code></td>
|
||||
<td>json-render catalog defining available components</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>html</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>Self-contained HTML for the iframe UI</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>tool</code></td>
|
||||
<td><code>McpToolOptions</code></td>
|
||||
<td>Optional tool name/title/description overrides</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
### registerJsonRenderTool
|
||||
|
||||
Register a json-render tool on an existing `McpServer`. Use this when you need to add json-render to a server that has other tools.
|
||||
|
||||
```typescript
|
||||
import { registerJsonRenderTool } from "@json-render/mcp";
|
||||
|
||||
registerJsonRenderTool(server, {
|
||||
catalog,
|
||||
name: "render-ui",
|
||||
title: "Render UI",
|
||||
description: "Render an interactive UI",
|
||||
resourceUri: "ui://render-ui/view.html",
|
||||
});
|
||||
```
|
||||
|
||||
### registerJsonRenderResource
|
||||
|
||||
Register the UI resource that serves the bundled HTML.
|
||||
|
||||
```typescript
|
||||
import { registerJsonRenderResource } from "@json-render/mcp";
|
||||
|
||||
registerJsonRenderResource(server, {
|
||||
resourceUri: "ui://render-ui/view.html",
|
||||
html: bundledHtml,
|
||||
});
|
||||
```
|
||||
|
||||
## Client API (`@json-render/mcp/app`)
|
||||
|
||||
These exports run inside the sandboxed iframe rendered by the MCP host.
|
||||
|
||||
### useJsonRenderApp
|
||||
|
||||
React hook that connects to the MCP host, listens for tool results, and maintains the current json-render spec.
|
||||
|
||||
```tsx
|
||||
import { useJsonRenderApp } from "@json-render/mcp/app";
|
||||
import { JSONUIProvider, Renderer } from "@json-render/react";
|
||||
|
||||
function McpAppView({ registry }) {
|
||||
const { spec, loading, connected, error } = useJsonRenderApp({
|
||||
name: "my-app",
|
||||
version: "1.0.0",
|
||||
});
|
||||
|
||||
if (error) return <div>Error: {error.message}</div>;
|
||||
if (!spec) return <div>Waiting...</div>;
|
||||
|
||||
return (
|
||||
<JSONUIProvider registry={registry} initialState={spec.state ?? {}}>
|
||||
<Renderer spec={spec} registry={registry} loading={loading} />
|
||||
</JSONUIProvider>
|
||||
);
|
||||
}
|
||||
```
|
||||
|
||||
#### UseJsonRenderAppReturn
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Field</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>spec</code></td>
|
||||
<td><code>{'Spec | null'}</code></td>
|
||||
<td>Current json-render spec</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>loading</code></td>
|
||||
<td><code>boolean</code></td>
|
||||
<td>Whether the spec is still being received</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>connected</code></td>
|
||||
<td><code>boolean</code></td>
|
||||
<td>Whether connected to the host</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>connecting</code></td>
|
||||
<td><code>boolean</code></td>
|
||||
<td>Whether currently connecting</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>error</code></td>
|
||||
<td><code>{'Error | null'}</code></td>
|
||||
<td>Connection error, if any</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>app</code></td>
|
||||
<td><code>{'App | null'}</code></td>
|
||||
<td>The underlying MCP App instance</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>callServerTool</code></td>
|
||||
<td><code>{'(name, args?) => Promise<void>'}</code></td>
|
||||
<td>Call an MCP server tool and update spec from result</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
### buildAppHtml
|
||||
|
||||
Generate a self-contained HTML page from bundled JavaScript and CSS.
|
||||
|
||||
```typescript
|
||||
import { buildAppHtml } from "@json-render/mcp/app";
|
||||
import fs from "node:fs";
|
||||
|
||||
const html = buildAppHtml({
|
||||
title: "Dashboard",
|
||||
js: fs.readFileSync("dist/app.js", "utf-8"),
|
||||
css: fs.readFileSync("dist/app.css", "utf-8"),
|
||||
});
|
||||
```
|
||||
|
||||
## Client Configuration
|
||||
|
||||
### Cursor
|
||||
|
||||
Add to `.cursor/mcp.json`:
|
||||
|
||||
```json
|
||||
{
|
||||
"mcpServers": {
|
||||
"json-render": {
|
||||
"command": "npx",
|
||||
"args": ["tsx", "path/to/server.ts", "--stdio"]
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Claude Desktop
|
||||
|
||||
Add to `~/Library/Application Support/Claude/claude_desktop_config.json`:
|
||||
|
||||
```json
|
||||
{
|
||||
"mcpServers": {
|
||||
"json-render": {
|
||||
"command": "npx",
|
||||
"args": ["tsx", "/absolute/path/to/server.ts", "--stdio"]
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Supported Clients
|
||||
|
||||
MCP Apps are supported by Claude (web and desktop), ChatGPT, VS Code (GitHub Copilot), Cursor, Goose, and Postman.
|
||||
@@ -0,0 +1,280 @@
|
||||
import { pageMetadata } from "@/lib/page-metadata"
|
||||
export const metadata = pageMetadata("docs/api/next")
|
||||
|
||||
# @json-render/next
|
||||
|
||||
Next.js renderer. JSON becomes full Next.js applications with routes, layouts, metadata, and SSR.
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
npm install @json-render/core @json-render/react @json-render/next
|
||||
```
|
||||
|
||||
## schema
|
||||
|
||||
The Next.js app schema for multi-page specs. Use with `defineCatalog` from core.
|
||||
|
||||
```typescript
|
||||
import { defineCatalog } from '@json-render/core';
|
||||
import { schema } from '@json-render/next/server';
|
||||
import { z } from 'zod';
|
||||
|
||||
const catalog = defineCatalog(schema, {
|
||||
components: {
|
||||
Card: {
|
||||
props: z.object({ title: z.string() }),
|
||||
description: 'Card container',
|
||||
},
|
||||
NavBar: {
|
||||
props: z.object({ links: z.array(z.object({ href: z.string(), label: z.string() })) }),
|
||||
description: 'Navigation bar',
|
||||
},
|
||||
},
|
||||
actions: {},
|
||||
});
|
||||
```
|
||||
|
||||
## createNextApp
|
||||
|
||||
Create all exports needed for a Next.js `[[...slug]]` catch-all route.
|
||||
|
||||
```typescript
|
||||
import { createNextApp } from '@json-render/next/server';
|
||||
|
||||
const { Page, generateMetadata, generateStaticParams } = createNextApp({
|
||||
spec: myAppSpec,
|
||||
loaders: {
|
||||
loadPost: async ({ slug }) => {
|
||||
const post = await db.post.findUnique({ where: { slug } });
|
||||
return { post };
|
||||
},
|
||||
},
|
||||
});
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Option</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>spec</code></td>
|
||||
<td><code>{'NextAppSpec | (() => NextAppSpec | Promise<NextAppSpec>)'}</code></td>
|
||||
<td>The application spec (static or dynamic)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>loaders</code></td>
|
||||
<td><code>{'Record<string, LoaderFn>'}</code></td>
|
||||
<td>Server-side data loaders keyed by name</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
### Returns
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Export</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>Page</code></td>
|
||||
<td>Async Server Component for <code>page.tsx</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>generateMetadata</code></td>
|
||||
<td>Metadata generator for Next.js SEO</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>generateStaticParams</code></td>
|
||||
<td>Static params for pre-rendering at build time</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
## NextAppSpec
|
||||
|
||||
The top-level spec defining an entire Next.js application.
|
||||
|
||||
```typescript
|
||||
interface NextAppSpec {
|
||||
metadata?: NextMetadata;
|
||||
routes: Record<string, NextRouteSpec>;
|
||||
layouts?: Record<string, Spec>;
|
||||
state?: Record<string, unknown>;
|
||||
}
|
||||
```
|
||||
|
||||
### Route Patterns
|
||||
|
||||
Routes use Next.js URL conventions:
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Pattern</th>
|
||||
<th>Example Match</th>
|
||||
<th>Params</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>/</code></td>
|
||||
<td><code>/</code></td>
|
||||
<td><code>{'{}'}</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>/about</code></td>
|
||||
<td><code>/about</code></td>
|
||||
<td><code>{'{}'}</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>/blog/[slug]</code></td>
|
||||
<td><code>/blog/hello</code></td>
|
||||
<td><code>{'{ slug: "hello" }'}</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>/docs/[...path]</code></td>
|
||||
<td><code>/docs/a/b/c</code></td>
|
||||
<td><code>{'{ path: ["a","b","c"] }'}</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>/app/[[...path]]</code></td>
|
||||
<td><code>/app</code> or <code>/app/x/y</code></td>
|
||||
<td><code>{'{ path: [] }'}</code> or <code>{'{ path: ["x","y"] }'}</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
## NextAppProvider
|
||||
|
||||
Client component that provides the component registry and action handlers to all pages.
|
||||
|
||||
```tsx
|
||||
import { NextAppProvider } from '@json-render/next';
|
||||
|
||||
export default function Layout({ children }) {
|
||||
return (
|
||||
<NextAppProvider registry={registry} handlers={handlers}>
|
||||
{children}
|
||||
</NextAppProvider>
|
||||
);
|
||||
}
|
||||
```
|
||||
|
||||
## Built-in Components
|
||||
|
||||
### Slot
|
||||
|
||||
Placeholder in layouts where page content is rendered. Every layout MUST include a Slot.
|
||||
|
||||
```json
|
||||
{ "type": "Slot", "props": {}, "children": [] }
|
||||
```
|
||||
|
||||
### Link
|
||||
|
||||
Client-side navigation wrapping `next/link`.
|
||||
|
||||
```json
|
||||
{ "type": "Link", "props": { "href": "/about" }, "children": ["link-text"] }
|
||||
```
|
||||
|
||||
## Built-in Actions
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Action</th>
|
||||
<th>Params</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>setState</code></td>
|
||||
<td><code>{'{ statePath, value }'}</code></td>
|
||||
<td>Update a value in state</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>pushState</code></td>
|
||||
<td><code>{'{ statePath, value, clearStatePath? }'}</code></td>
|
||||
<td>Append to array in state</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>removeState</code></td>
|
||||
<td><code>{'{ statePath, index }'}</code></td>
|
||||
<td>Remove from array by index</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>navigate</code></td>
|
||||
<td><code>{'{ href }'}</code></td>
|
||||
<td>Client-side navigation</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
## Server Utilities
|
||||
|
||||
### matchRoute
|
||||
|
||||
Match a pathname against a spec's routes.
|
||||
|
||||
```typescript
|
||||
import { matchRoute } from '@json-render/next/server';
|
||||
|
||||
const matched = matchRoute(spec, '/blog/hello-world');
|
||||
// { route: NextRouteSpec, pattern: '/blog/[slug]', params: { slug: 'hello-world' } }
|
||||
```
|
||||
|
||||
### resolveMetadata
|
||||
|
||||
Resolve merged metadata for a route.
|
||||
|
||||
```typescript
|
||||
import { resolveMetadata } from '@json-render/next/server';
|
||||
|
||||
const metadata = resolveMetadata(spec, matchedRoute?.route);
|
||||
```
|
||||
|
||||
### slugToPath
|
||||
|
||||
Convert catch-all slug array to pathname.
|
||||
|
||||
```typescript
|
||||
import { slugToPath } from '@json-render/next/server';
|
||||
|
||||
slugToPath(undefined); // "/"
|
||||
slugToPath(['blog', 'hello']); // "/blog/hello"
|
||||
```
|
||||
|
||||
## Entry Points
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Import</th>
|
||||
<th>Contents</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>@json-render/next</code></td>
|
||||
<td>Client components (NextAppProvider, PageRenderer, Link)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>@json-render/next/server</code></td>
|
||||
<td>Server utilities (createNextApp, matchRoute, schema)</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
@@ -0,0 +1,310 @@
|
||||
import { pageMetadata } from "@/lib/page-metadata"
|
||||
export const metadata = pageMetadata("docs/api/react-email")
|
||||
|
||||
# @json-render/react-email
|
||||
|
||||
React Email renderer. Turn JSON specs into HTML or plain-text emails using `@react-email/components` and `@react-email/render`.
|
||||
|
||||
## Install
|
||||
|
||||
```bash
|
||||
npm install @json-render/core @json-render/react-email @react-email/components @react-email/render
|
||||
```
|
||||
|
||||
See the [React Email example](https://github.com/vercel-labs/json-render/tree/main/examples/react-email) for a full working example.
|
||||
|
||||
## schema
|
||||
|
||||
The email element schema for specs. Use with `defineCatalog` from core.
|
||||
|
||||
```typescript
|
||||
import { defineCatalog } from '@json-render/core';
|
||||
import { schema, standardComponentDefinitions } from '@json-render/react-email';
|
||||
|
||||
const catalog = defineCatalog(schema, {
|
||||
components: standardComponentDefinitions,
|
||||
});
|
||||
```
|
||||
|
||||
## Render Functions
|
||||
|
||||
Server-side functions for producing email output. All accept a spec and optional `RenderOptions`.
|
||||
|
||||
```typescript
|
||||
import { renderToHtml, renderToPlainText } from '@json-render/react-email';
|
||||
|
||||
const html = await renderToHtml(spec);
|
||||
|
||||
const plainText = await renderToPlainText(spec);
|
||||
```
|
||||
|
||||
### 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-email';
|
||||
import { Container, Heading, Text } from '@react-email/components';
|
||||
|
||||
const { registry } = defineRegistry(catalog, {
|
||||
components: {
|
||||
Card: ({ props, children }) => (
|
||||
<Container style={{ padding: 16, backgroundColor: '#fff' }}>
|
||||
<Heading>{props.title}</Heading>
|
||||
{children}
|
||||
</Container>
|
||||
),
|
||||
},
|
||||
});
|
||||
|
||||
const html = await renderToHtml(spec, { registry });
|
||||
```
|
||||
|
||||
## createRenderer
|
||||
|
||||
Create a standalone renderer component wired to state, actions, and validation (for interactive previews in the browser).
|
||||
|
||||
```typescript
|
||||
import { createRenderer } from '@json-render/react-email';
|
||||
|
||||
const EmailRenderer = createRenderer(catalog, components);
|
||||
```
|
||||
|
||||
## Renderer
|
||||
|
||||
The main component that renders a spec to React Email elements. Use inside `JSONUIProvider` when you need state, actions, or visibility.
|
||||
|
||||
```typescript
|
||||
interface RendererProps {
|
||||
spec: Spec | null;
|
||||
registry?: ComponentRegistry;
|
||||
includeStandard?: boolean; // default: true
|
||||
loading?: boolean;
|
||||
fallback?: ComponentRenderer;
|
||||
}
|
||||
```
|
||||
|
||||
## Standard Components
|
||||
|
||||
### Document structure
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Component</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>Html</code></td>
|
||||
<td>Top-level email wrapper. Must be the root element.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>Head</code></td>
|
||||
<td>Email head section. Place inside Html.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>Body</code></td>
|
||||
<td>Email body wrapper. Place inside Html.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
### Layout
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Component</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>Container</code></td>
|
||||
<td>Constrains content width (e.g. max-width 600px).</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>Section</code></td>
|
||||
<td>Groups related content.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>Row</code></td>
|
||||
<td>Horizontal layout row.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>Column</code></td>
|
||||
<td>Column within a Row.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
### Content
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Component</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>Heading</code></td>
|
||||
<td>Heading text (h1-h6).</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>Text</code></td>
|
||||
<td>Body text paragraph.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>Link</code></td>
|
||||
<td>Hyperlink with text and href.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>Button</code></td>
|
||||
<td>Call-to-action button (link styled as button).</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>Image</code></td>
|
||||
<td>Image from URL.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>Hr</code></td>
|
||||
<td>Horizontal rule separator.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
### Utility
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Component</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>Preview</code></td>
|
||||
<td>Preview text for inbox (inside Html).</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>Markdown</code></td>
|
||||
<td>Renders markdown content as email-safe HTML.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
## Server-Safe Import
|
||||
|
||||
Import schema and catalog definitions without pulling in React or `@react-email/components`:
|
||||
|
||||
```typescript
|
||||
import { schema, standardComponentDefinitions } from '@json-render/react-email/server';
|
||||
```
|
||||
|
||||
## Sub-path Exports
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Export</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>@json-render/react-email</code></td>
|
||||
<td>Full package: schema, renderer, components, render functions</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>@json-render/react-email/server</code></td>
|
||||
<td>Schema and catalog definitions only (no React)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>@json-render/react-email/catalog</code></td>
|
||||
<td>Standard component definitions and types</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>@json-render/react-email/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>ReactEmailSchema</code></td>
|
||||
<td>Schema type for email specs</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>ReactEmailSpec</code></td>
|
||||
<td>Spec type for email 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>
|
||||
@@ -1,4 +1,5 @@
|
||||
export const metadata = { title: "@json-render/react-native API" }
|
||||
import { pageMetadata } from "@/lib/page-metadata"
|
||||
export const metadata = pageMetadata("docs/api/react-native")
|
||||
|
||||
# @json-render/react-native
|
||||
|
||||
@@ -8,65 +9,120 @@ React Native renderer with standard components, providers, and hooks.
|
||||
|
||||
### 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 |
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Component</th><th>Props</th><th>Description</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td><code>Container</code></td><td><code>padding</code>, <code>background</code>, <code>borderRadius</code>, <code>borderColor</code>, <code>flex</code></td><td>Basic wrapper with styling</td></tr>
|
||||
<tr><td><code>Row</code></td><td><code>gap</code>, <code>align</code>, <code>justify</code>, <code>flex</code>, <code>wrap</code></td><td>Horizontal flex layout</td></tr>
|
||||
<tr><td><code>Column</code></td><td><code>gap</code>, <code>align</code>, <code>justify</code>, <code>flex</code></td><td>Vertical flex layout</td></tr>
|
||||
<tr><td><code>ScrollContainer</code></td><td><code>direction</code></td><td>Scrollable area (vertical or horizontal)</td></tr>
|
||||
<tr><td><code>SafeArea</code></td><td><code>edges</code></td><td>Safe area insets for notch/home indicator</td></tr>
|
||||
<tr><td><code>Pressable</code></td><td><code>action</code>, <code>actionParams</code></td><td>Touchable wrapper that triggers actions</td></tr>
|
||||
<tr><td><code>Spacer</code></td><td><code>size</code>, <code>flex</code></td><td>Fixed or flexible spacing</td></tr>
|
||||
<tr><td><code>Divider</code></td><td><code>color</code>, <code>thickness</code></td><td>Thin line separator</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
### 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 |
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Component</th><th>Props</th><th>Description</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td><code>Heading</code></td><td><code>text</code>, <code>level</code>, <code>align</code>, <code>color</code></td><td>Heading text (levels 1-6)</td></tr>
|
||||
<tr><td><code>Paragraph</code></td><td><code>text</code>, <code>align</code>, <code>color</code></td><td>Body text</td></tr>
|
||||
<tr><td><code>Label</code></td><td><code>text</code>, <code>color</code>, <code>bold</code></td><td>Small label text</td></tr>
|
||||
<tr><td><code>Image</code></td><td><code>uri</code>, <code>width</code>, <code>height</code>, <code>resizeMode</code>, <code>borderRadius</code></td><td>Image display</td></tr>
|
||||
<tr><td><code>Avatar</code></td><td><code>uri</code>, <code>size</code>, <code>fallback</code></td><td>Circular avatar</td></tr>
|
||||
<tr><td><code>Badge</code></td><td><code>label</code>, <code>color</code>, <code>textColor</code></td><td>Status badge</td></tr>
|
||||
<tr><td><code>Chip</code></td><td><code>label</code>, <code>selected</code>, <code>color</code></td><td>Tag/chip</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
### 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 |
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Component</th><th>Props</th><th>Description</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td><code>Button</code></td><td><code>label</code>, <code>variant</code>, <code>size</code>, <code>disabled</code>, <code>action</code>, <code>actionParams</code></td><td>Pressable button</td></tr>
|
||||
<tr><td><code>TextInput</code></td><td><code>placeholder</code>, <code>value</code> (use <code>$bindState</code>), <code>secure</code>, <code>keyboardType</code>, <code>multiline</code></td><td>Text input field</td></tr>
|
||||
<tr><td><code>Switch</code></td><td><code>checked</code> (use <code>$bindState</code>), <code>label</code></td><td>Toggle switch</td></tr>
|
||||
<tr><td><code>Checkbox</code></td><td><code>checked</code> (use <code>$bindState</code>), <code>label</code></td><td>Checkbox with label</td></tr>
|
||||
<tr><td><code>Slider</code></td><td><code>value</code> (use <code>$bindState</code>), <code>min</code>, <code>max</code>, <code>step</code></td><td>Range slider</td></tr>
|
||||
<tr><td><code>SearchBar</code></td><td><code>placeholder</code>, <code>value</code> (use <code>$bindState</code>)</td><td>Search input</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
### Feedback
|
||||
|
||||
| Component | Props | Description |
|
||||
|-----------|-------|-------------|
|
||||
| `Spinner` | `size`, `color` | Loading indicator |
|
||||
| `ProgressBar` | `progress`, `color`, `trackColor` | Progress indicator |
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Component</th><th>Props</th><th>Description</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td><code>Spinner</code></td><td><code>size</code>, <code>color</code></td><td>Loading indicator</td></tr>
|
||||
<tr><td><code>ProgressBar</code></td><td><code>progress</code>, <code>color</code>, <code>trackColor</code></td><td>Progress indicator</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
### 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 |
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Component</th><th>Props</th><th>Description</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td><code>Card</code></td><td><code>title</code>, <code>subtitle</code>, <code>padding</code></td><td>Card container</td></tr>
|
||||
<tr><td><code>ListItem</code></td><td><code>title</code>, <code>subtitle</code>, <code>leading</code>, <code>trailing</code>, <code>action</code>, <code>actionParams</code></td><td>List row</td></tr>
|
||||
<tr><td><code>Modal</code></td><td><code>visible</code>, <code>title</code></td><td>Bottom sheet modal</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
## Providers
|
||||
|
||||
### StateProvider
|
||||
|
||||
```tsx
|
||||
<StateProvider initialState={object}>
|
||||
<StateProvider initialState={object} onStateChange={fn}>
|
||||
{children}
|
||||
</StateProvider>
|
||||
```
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Prop</th><th>Type</th><th>Description</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td><code>store</code></td><td><code>StateStore</code></td><td>External store (controlled mode). When provided, <code>initialState</code> and <code>onStateChange</code> are ignored.</td></tr>
|
||||
<tr><td><code>initialState</code></td><td><code>Record<string, unknown></code></td><td>Initial state model (uncontrolled mode).</td></tr>
|
||||
<tr><td><code>onStateChange</code></td><td><code>{'(changes: Array<{ path: string; value: unknown }>) => void'}</code></td><td>Callback when state changes (uncontrolled mode). Called once per <code>set</code> or <code>update</code> with all changed entries.</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
#### 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
|
||||
@@ -164,8 +220,13 @@ import { standardComponentDefinitions, standardActionDefinitions } from "@json-r
|
||||
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 |
|
||||
<table>
|
||||
<thead>
|
||||
<tr><th>Export</th><th>Purpose</th></tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td><code>standardComponentDefinitions</code></td><td>Catalog definitions for all 25+ standard components</td></tr>
|
||||
<tr><td><code>standardActionDefinitions</code></td><td>Catalog definitions for standard actions (setState, navigate)</td></tr>
|
||||
<tr><td><code>schema</code></td><td>React Native element tree schema</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
@@ -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,416 @@
|
||||
import { pageMetadata } from "@/lib/page-metadata"
|
||||
export const metadata = pageMetadata("docs/api/react-three-fiber")
|
||||
|
||||
# @json-render/react-three-fiber
|
||||
|
||||
React Three Fiber renderer for json-render. 19 built-in 3D components for meshes, lights, models, environments, text, cameras, and controls.
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
npm install @json-render/react-three-fiber @json-render/core @json-render/react @react-three/fiber @react-three/drei three zod
|
||||
```
|
||||
|
||||
## Entry Points
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Entry Point</th>
|
||||
<th>Exports</th>
|
||||
<th>Use For</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>@json-render/react-three-fiber</code></td>
|
||||
<td><code>threeComponents</code>, <code>ThreeRenderer</code>, <code>ThreeCanvas</code>, schemas</td>
|
||||
<td>React Three Fiber implementations and renderer</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>@json-render/react-three-fiber/catalog</code></td>
|
||||
<td><code>threeComponentDefinitions</code></td>
|
||||
<td>Catalog schemas (no R3F dependency, safe for server)</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
## Usage
|
||||
|
||||
```tsx
|
||||
import {'{ defineCatalog }'} from "@json-render/core";
|
||||
import {'{ schema, defineRegistry }'} from "@json-render/react";
|
||||
import {'{'}
|
||||
threeComponentDefinitions,
|
||||
threeComponents,
|
||||
ThreeCanvas,
|
||||
{'}'} from "@json-render/react-three-fiber";
|
||||
|
||||
const catalog = defineCatalog(schema, {'{'}
|
||||
components: {'{'}
|
||||
Box: threeComponentDefinitions.Box,
|
||||
Sphere: threeComponentDefinitions.Sphere,
|
||||
AmbientLight: threeComponentDefinitions.AmbientLight,
|
||||
DirectionalLight: threeComponentDefinitions.DirectionalLight,
|
||||
OrbitControls: threeComponentDefinitions.OrbitControls,
|
||||
{'}'},
|
||||
actions: {'{}'},
|
||||
{'}'});
|
||||
|
||||
const {'{ registry }'} = defineRegistry(catalog, {'{'}
|
||||
components: {'{'}
|
||||
Box: threeComponents.Box,
|
||||
Sphere: threeComponents.Sphere,
|
||||
AmbientLight: threeComponents.AmbientLight,
|
||||
DirectionalLight: threeComponents.DirectionalLight,
|
||||
OrbitControls: threeComponents.OrbitControls,
|
||||
{'}'},
|
||||
{'}'});
|
||||
```
|
||||
|
||||
### ThreeCanvas (convenience)
|
||||
|
||||
```tsx
|
||||
<ThreeCanvas
|
||||
spec={'{spec}'}
|
||||
registry={'{registry}'}
|
||||
shadows
|
||||
camera={'{'}{'{ position: [5, 5, 5], fov: 50 }'}{'}'}
|
||||
style={'{'}{'{ width: "100%", height: "100vh" }'}{'}'}
|
||||
/>
|
||||
```
|
||||
|
||||
### Manual Canvas Setup
|
||||
|
||||
```tsx
|
||||
import {'{ Canvas }'} from "@react-three/fiber";
|
||||
import {'{ ThreeRenderer }'} from "@json-render/react-three-fiber";
|
||||
|
||||
<Canvas shadows>
|
||||
<ThreeRenderer spec={'{spec}'} registry={'{registry}'} />
|
||||
</Canvas>
|
||||
```
|
||||
|
||||
## Components
|
||||
|
||||
### Primitives
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Component</th>
|
||||
<th>Description</th>
|
||||
<th>Key Props</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>Box</code></td>
|
||||
<td>Box mesh (default 1x1x1)</td>
|
||||
<td><code>width</code>, <code>height</code>, <code>depth</code>, <code>material</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>Sphere</code></td>
|
||||
<td>Sphere mesh</td>
|
||||
<td><code>radius</code>, <code>widthSegments</code>, <code>heightSegments</code>, <code>material</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>Cylinder</code></td>
|
||||
<td>Cylinder mesh</td>
|
||||
<td><code>radiusTop</code>, <code>radiusBottom</code>, <code>height</code>, <code>material</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>Cone</code></td>
|
||||
<td>Cone mesh</td>
|
||||
<td><code>radius</code>, <code>height</code>, <code>material</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>Torus</code></td>
|
||||
<td>Torus (donut) mesh</td>
|
||||
<td><code>radius</code>, <code>tube</code>, <code>material</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>Plane</code></td>
|
||||
<td>Flat plane mesh</td>
|
||||
<td><code>width</code>, <code>height</code>, <code>material</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>Capsule</code></td>
|
||||
<td>Capsule mesh</td>
|
||||
<td><code>radius</code>, <code>length</code>, <code>material</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
All primitives share: <code>position</code>, <code>rotation</code>, <code>scale</code>, <code>castShadow</code>, <code>receiveShadow</code>, <code>material</code>.
|
||||
|
||||
### Material Schema
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Property</th>
|
||||
<th>Type</th>
|
||||
<th>Default</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>color</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td><code>"#ffffff"</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>metalness</code></td>
|
||||
<td><code>number</code></td>
|
||||
<td><code>0</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>roughness</code></td>
|
||||
<td><code>number</code></td>
|
||||
<td><code>1</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>emissive</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td><code>"#000000"</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>emissiveIntensity</code></td>
|
||||
<td><code>number</code></td>
|
||||
<td><code>1</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>opacity</code></td>
|
||||
<td><code>number</code></td>
|
||||
<td><code>1</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>transparent</code></td>
|
||||
<td><code>boolean</code></td>
|
||||
<td><code>false</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>wireframe</code></td>
|
||||
<td><code>boolean</code></td>
|
||||
<td><code>false</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
### Lights
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Component</th>
|
||||
<th>Description</th>
|
||||
<th>Key Props</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>AmbientLight</code></td>
|
||||
<td>Uniform illumination</td>
|
||||
<td><code>color</code>, <code>intensity</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>DirectionalLight</code></td>
|
||||
<td>Sunlight-style</td>
|
||||
<td><code>position</code>, <code>color</code>, <code>intensity</code>, <code>castShadow</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>PointLight</code></td>
|
||||
<td>Radiates from a point</td>
|
||||
<td><code>position</code>, <code>color</code>, <code>intensity</code>, <code>distance</code>, <code>decay</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>SpotLight</code></td>
|
||||
<td>Cone of light</td>
|
||||
<td><code>position</code>, <code>color</code>, <code>intensity</code>, <code>angle</code>, <code>penumbra</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
### Other Components
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Component</th>
|
||||
<th>Description</th>
|
||||
<th>Key Props</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>Group</code></td>
|
||||
<td>Container for children</td>
|
||||
<td><code>position</code>, <code>rotation</code>, <code>scale</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>Model</code></td>
|
||||
<td>GLTF/GLB model loader</td>
|
||||
<td><code>url</code>, <code>position</code>, <code>rotation</code>, <code>scale</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>Environment</code></td>
|
||||
<td>HDRI environment map</td>
|
||||
<td><code>preset</code>, <code>background</code>, <code>blur</code>, <code>intensity</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>Fog</code></td>
|
||||
<td>Linear fog effect</td>
|
||||
<td><code>color</code>, <code>near</code>, <code>far</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>GridHelper</code></td>
|
||||
<td>Reference grid</td>
|
||||
<td><code>size</code>, <code>divisions</code>, <code>color</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>Text3D</code></td>
|
||||
<td>3D text (SDF)</td>
|
||||
<td><code>text</code>, <code>fontSize</code>, <code>color</code>, <code>anchorX</code>, <code>anchorY</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>PerspectiveCamera</code></td>
|
||||
<td>Camera</td>
|
||||
<td><code>position</code>, <code>fov</code>, <code>near</code>, <code>far</code>, <code>makeDefault</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>OrbitControls</code></td>
|
||||
<td>Camera controls</td>
|
||||
<td><code>enableDamping</code>, <code>enableZoom</code>, <code>autoRotate</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
## Shared Schemas
|
||||
|
||||
Reusable Zod schemas for custom 3D components:
|
||||
|
||||
```tsx
|
||||
import {'{ vector3Schema, materialSchema, transformProps, shadowProps }'} from "@json-render/react-three-fiber";
|
||||
```
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Export</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>vector3Schema</code></td>
|
||||
<td><code>z.tuple([z.number(), z.number(), z.number()])</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>materialSchema</code></td>
|
||||
<td>Standard material props (color, metalness, roughness, etc.)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>transformProps</code></td>
|
||||
<td><code>{'{ position, rotation, scale }'}</code> schema fields</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>shadowProps</code></td>
|
||||
<td><code>{'{ castShadow, receiveShadow }'}</code> schema fields</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
## ThreeRenderer
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Prop</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>spec</code></td>
|
||||
<td><code>Spec | null</code></td>
|
||||
<td>The spec to render as a 3D scene</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>registry</code></td>
|
||||
<td><code>ComponentRegistry</code></td>
|
||||
<td>Component registry from <code>defineRegistry</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>store</code></td>
|
||||
<td><code>StateStore</code></td>
|
||||
<td>External state store (controlled mode)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>initialState</code></td>
|
||||
<td><code>Record<string, unknown></code></td>
|
||||
<td>Initial state (uncontrolled mode)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>handlers</code></td>
|
||||
<td><code>Record<string, Function></code></td>
|
||||
<td>Action handlers</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>loading</code></td>
|
||||
<td><code>boolean</code></td>
|
||||
<td>Whether the spec is streaming</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>children</code></td>
|
||||
<td><code>ReactNode</code></td>
|
||||
<td>Additional R3F elements alongside the spec</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
## ThreeCanvas
|
||||
|
||||
Extends <code>ThreeRendererProps</code> with Canvas options:
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Prop</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>shadows</code></td>
|
||||
<td><code>boolean</code></td>
|
||||
<td>Enable shadow maps</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>camera</code></td>
|
||||
<td><code>object</code></td>
|
||||
<td>Default camera config (position, fov, etc.)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>className</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td>CSS class for the canvas container</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>style</code></td>
|
||||
<td><code>CSSProperties</code></td>
|
||||
<td>Inline styles for the canvas container</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
## Type Helpers
|
||||
|
||||
```tsx
|
||||
import type {'{ ThreeProps }'} from "@json-render/react-three-fiber";
|
||||
|
||||
type BoxProps = ThreeProps<"Box">;
|
||||
type SphereProps = ThreeProps<"Sphere">;
|
||||
```
|
||||
@@ -1,4 +1,5 @@
|
||||
export const metadata = { title: "@json-render/react API" }
|
||||
import { pageMetadata } from "@/lib/page-metadata"
|
||||
export const metadata = pageMetadata("docs/api/react")
|
||||
|
||||
# @json-render/react
|
||||
|
||||
@@ -9,11 +10,57 @@ React components, providers, and hooks.
|
||||
### StateProvider
|
||||
|
||||
```tsx
|
||||
<StateProvider initialState={object}>
|
||||
<StateProvider initialState={object} onStateChange={fn}>
|
||||
{children}
|
||||
</StateProvider>
|
||||
```
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Prop</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>store</code></td>
|
||||
<td><code>StateStore</code></td>
|
||||
<td>External store (controlled mode). When provided, <code>initialState</code> and <code>onStateChange</code> are ignored.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>initialState</code></td>
|
||||
<td><code>Record<string, unknown></code></td>
|
||||
<td>Initial state model (uncontrolled mode).</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>onStateChange</code></td>
|
||||
<td><code>{'(changes: Array<{ path: string; value: unknown }>) => void'}</code></td>
|
||||
<td>Callback when state changes (uncontrolled mode). Called once per <code>set</code> or <code>update</code> with all changed entries.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
#### 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
|
||||
@@ -83,6 +130,40 @@ const { registry } = defineRegistry(catalog, {
|
||||
type Registry = Record<string, React.ComponentType<ComponentRenderProps>>;
|
||||
```
|
||||
|
||||
### JSONUIProvider
|
||||
|
||||
Convenience wrapper that combines `StateProvider`, `VisibilityProvider`, `ValidationProvider`, and `ActionProvider`. Accepts all their props plus:
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Prop</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>functions</code></td>
|
||||
<td><code>Record<string, ComputedFunction></code></td>
|
||||
<td>Named functions for <code>$computed</code> expressions in props</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
```tsx
|
||||
<JSONUIProvider
|
||||
spec={spec}
|
||||
catalog={catalog}
|
||||
handlers={{ submit: async () => { /* ... */ } }}
|
||||
functions={{ fullName: (args) => `${args.first} ${args.last}` }}
|
||||
>
|
||||
<Renderer spec={spec} registry={registry} />
|
||||
</JSONUIProvider>
|
||||
```
|
||||
|
||||
The `functions` prop is also available on `createRenderer`.
|
||||
|
||||
### Component Props (via defineRegistry)
|
||||
|
||||
```tsx
|
||||
@@ -211,6 +292,15 @@ const {
|
||||
|
||||
`ValidationConfig` is `{ checks?: ValidationCheck[], validateOn?: 'change' | 'blur' | 'submit' }`.
|
||||
|
||||
### useOptionalValidation
|
||||
|
||||
Non-throwing variant of `useValidation()`. Returns `null` when no `ValidationProvider` is present, instead of throwing. Useful in components that may or may not be rendered inside a validation context.
|
||||
|
||||
```typescript
|
||||
const validation = useOptionalValidation();
|
||||
// ValidationContextValue | null
|
||||
```
|
||||
|
||||
### useBoundProp
|
||||
|
||||
Two-way binding helper for `$bindState` / `$bindItem` expressions. Returns `[value, setValue]` where `setValue` writes back to the bound state path.
|
||||
|
||||
@@ -0,0 +1,104 @@
|
||||
import { pageMetadata } from "@/lib/page-metadata"
|
||||
export const metadata = pageMetadata("docs/api/redux")
|
||||
|
||||
# @json-render/redux
|
||||
|
||||
Redux / Redux Toolkit adapter for json-render's `StateStore` interface.
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
npm install @json-render/redux @json-render/core @json-render/react redux
|
||||
# or with Redux Toolkit (recommended):
|
||||
npm install @json-render/redux @json-render/core @json-render/react @reduxjs/toolkit
|
||||
```
|
||||
|
||||
## reduxStateStore
|
||||
|
||||
Create a `StateStore` backed by a Redux store.
|
||||
|
||||
```typescript
|
||||
import { reduxStateStore } from "@json-render/redux";
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Option</th>
|
||||
<th>Type</th>
|
||||
<th>Required</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>store</code></td>
|
||||
<td><code>Store</code></td>
|
||||
<td>Yes</td>
|
||||
<td>The Redux store instance.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>selector</code></td>
|
||||
<td><code>{'(state: S) => StateModel'}</code></td>
|
||||
<td>No</td>
|
||||
<td>Select the json-render slice from the Redux state tree. Defaults to <code>{'(state) => state'}</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>dispatch</code></td>
|
||||
<td><code>{'(nextState: StateModel, store: Store) => void'}</code></td>
|
||||
<td>Yes</td>
|
||||
<td>Dispatch an action that replaces the selected slice with the next state.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import { configureStore, createSlice } from "@reduxjs/toolkit";
|
||||
import { reduxStateStore } from "@json-render/redux";
|
||||
import { StateProvider } from "@json-render/react";
|
||||
|
||||
const uiSlice = createSlice({
|
||||
name: "ui",
|
||||
initialState: { count: 0 } as Record<string, unknown>,
|
||||
reducers: {
|
||||
replaceUiState: (_state, action) => action.payload,
|
||||
},
|
||||
});
|
||||
|
||||
const reduxStore = configureStore({
|
||||
reducer: { ui: uiSlice.reducer },
|
||||
});
|
||||
|
||||
const store = reduxStateStore({
|
||||
store: reduxStore,
|
||||
selector: (state) => state.ui,
|
||||
dispatch: (next, s) => s.dispatch(uiSlice.actions.replaceUiState(next)),
|
||||
});
|
||||
```
|
||||
|
||||
```tsx
|
||||
<StateProvider store={store}>
|
||||
{/* json-render reads/writes go through Redux */}
|
||||
</StateProvider>
|
||||
```
|
||||
|
||||
## Re-exports
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Export</th>
|
||||
<th>Source</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>StateStore</code></td>
|
||||
<td><code>@json-render/core</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
@@ -1,4 +1,5 @@
|
||||
export const metadata = { title: "@json-render/remotion API" }
|
||||
import { pageMetadata } from "@/lib/page-metadata"
|
||||
export const metadata = pageMetadata("docs/api/remotion")
|
||||
|
||||
# @json-render/remotion
|
||||
|
||||
|
||||
@@ -0,0 +1,320 @@
|
||||
import { pageMetadata } from "@/lib/page-metadata"
|
||||
export const metadata = pageMetadata("docs/api/shadcn-svelte")
|
||||
|
||||
# @json-render/shadcn-svelte
|
||||
|
||||
Pre-built [shadcn-svelte](https://www.shadcn-svelte.com/) components for json-render. 36 components built on Svelte 5 + Tailwind CSS, ready to use with `defineCatalog` and `defineRegistry`.
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
npm install @json-render/shadcn-svelte @json-render/core @json-render/svelte zod
|
||||
```
|
||||
|
||||
Your app must have Tailwind CSS configured.
|
||||
|
||||
## Entry Points
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Entry Point</th>
|
||||
<th>Exports</th>
|
||||
<th>Use For</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>@json-render/shadcn-svelte</code></td>
|
||||
<td><code>shadcnComponents</code>, <code>shadcnComponentDefinitions</code></td>
|
||||
<td>Svelte implementations + catalog schemas</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>@json-render/shadcn-svelte/catalog</code></td>
|
||||
<td><code>shadcnComponentDefinitions</code></td>
|
||||
<td>Catalog schemas only (no Svelte dependency, safe for server)</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
## Usage
|
||||
|
||||
Pick the components you need from the standard definitions:
|
||||
|
||||
```typescript
|
||||
import { defineCatalog } from "@json-render/core";
|
||||
import { schema } from "@json-render/svelte/schema";
|
||||
import { shadcnComponentDefinitions } from "@json-render/shadcn-svelte/catalog";
|
||||
import { defineRegistry } from "@json-render/svelte";
|
||||
import { shadcnComponents } from "@json-render/shadcn-svelte";
|
||||
|
||||
// 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,
|
||||
},
|
||||
});
|
||||
```
|
||||
|
||||
Then render in your Svelte component:
|
||||
|
||||
```svelte
|
||||
<script lang="ts">
|
||||
import { Renderer, JsonUIProvider } from "@json-render/svelte";
|
||||
|
||||
export let spec;
|
||||
export let registry;
|
||||
</script>
|
||||
|
||||
<JsonUIProvider initialState={spec?.state ?? {}}>
|
||||
<Renderer {spec} {registry} />
|
||||
</JsonUIProvider>
|
||||
```
|
||||
|
||||
## Available Components
|
||||
|
||||
### Layout
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Component</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>Card</code></td>
|
||||
<td>Container card with optional title, description, maxWidth, centered</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>Stack</code></td>
|
||||
<td>Flex container with direction, gap, align, justify</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>Grid</code></td>
|
||||
<td>Grid layout with columns (1-6) and gap</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>Separator</code></td>
|
||||
<td>Visual separator line with orientation</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
### Navigation
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Component</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>Tabs</code></td>
|
||||
<td>Tabbed navigation with tabs array, defaultValue, value</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>Accordion</code></td>
|
||||
<td>Collapsible sections with items array and type (single/multiple)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>Collapsible</code></td>
|
||||
<td>Single collapsible section with title and defaultOpen</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>Pagination</code></td>
|
||||
<td>Page navigation with totalPages and page</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
### Overlay
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Component</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>Dialog</code></td>
|
||||
<td>Modal dialog with title, description, openPath</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>Drawer</code></td>
|
||||
<td>Bottom drawer with title, description, openPath</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>Tooltip</code></td>
|
||||
<td>Hover tooltip with content and text</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>Popover</code></td>
|
||||
<td>Click-triggered popover with trigger and content</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>DropdownMenu</code></td>
|
||||
<td>Dropdown menu with label and items array</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
### Content
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Component</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>Heading</code></td>
|
||||
<td>Heading text with level (h1-h4)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>Text</code></td>
|
||||
<td>Paragraph with variant (body, caption, muted, lead, code)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>Image</code></td>
|
||||
<td>Image with alt, width, height</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>Avatar</code></td>
|
||||
<td>User avatar with src, name, size</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>Badge</code></td>
|
||||
<td>Status badge with text and variant</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>Alert</code></td>
|
||||
<td>Alert banner with title, message, type</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>Carousel</code></td>
|
||||
<td>Horizontally scrollable carousel with items</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>Table</code></td>
|
||||
<td>Data table with columns and rows</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
### Feedback
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Component</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>Progress</code></td>
|
||||
<td>Progress bar with value, max, label</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>Skeleton</code></td>
|
||||
<td>Loading placeholder with width, height, rounded</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>Spinner</code></td>
|
||||
<td>Loading spinner with size and label</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
### Input
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Component</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>Button</code></td>
|
||||
<td>Clickable button with label, variant, disabled</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>Link</code></td>
|
||||
<td>Anchor link with label and href</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>Input</code></td>
|
||||
<td>Text input with label, name, type, placeholder, value, checks</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>Textarea</code></td>
|
||||
<td>Multi-line text input with label, name, placeholder, rows, value, checks</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>Select</code></td>
|
||||
<td>Dropdown select with label, name, options, value, checks</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>Checkbox</code></td>
|
||||
<td>Checkbox with label, name, checked</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>Radio</code></td>
|
||||
<td>Radio button group with label, name, options, value</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>Switch</code></td>
|
||||
<td>Toggle switch with label, name, checked</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>Slider</code></td>
|
||||
<td>Range slider with label, min, max, step, value</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>Toggle</code></td>
|
||||
<td>Toggle button with label, pressed, variant</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>ToggleGroup</code></td>
|
||||
<td>Group of toggle buttons with items, type, value</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>ButtonGroup</code></td>
|
||||
<td>Group of buttons with buttons array and selected</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
## Notes
|
||||
|
||||
- The `/catalog` entry point has no Svelte dependency -- use it for server-side prompt generation
|
||||
- Components use Tailwind CSS classes -- your app must have Tailwind configured
|
||||
- Component implementations use bundled shadcn-svelte primitives (not your app's `$lib/components/ui/`)
|
||||
- Form inputs support `checks` for validation (type + message pairs) and `validateOn` for timing
|
||||
- Events: inputs emit `change`/`submit`/`focus`/`blur`; buttons emit `press`; selects emit `change`/`select`
|
||||
@@ -1,4 +1,5 @@
|
||||
export const metadata = { title: "@json-render/shadcn API" }
|
||||
import { pageMetadata } from "@/lib/page-metadata"
|
||||
export const metadata = pageMetadata("docs/api/shadcn")
|
||||
|
||||
# @json-render/shadcn
|
||||
|
||||
@@ -14,10 +15,27 @@ 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) |
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Entry Point</th>
|
||||
<th>Exports</th>
|
||||
<th>Use For</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>@json-render/shadcn</code></td>
|
||||
<td><code>shadcnComponents</code></td>
|
||||
<td>React implementations</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>@json-render/shadcn/catalog</code></td>
|
||||
<td><code>shadcnComponentDefinitions</code></td>
|
||||
<td>Catalog schemas (no React dependency, safe for server)</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
## Usage
|
||||
|
||||
@@ -102,69 +120,225 @@ const { registry } = defineRegistry(catalog, {
|
||||
|
||||
### 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 |
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Component</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>Card</code></td>
|
||||
<td>Container card with optional title, description, maxWidth, centered</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>Stack</code></td>
|
||||
<td>Flex container with direction, gap, align, justify</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>Grid</code></td>
|
||||
<td>Grid layout with columns (1-6) and gap</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>Separator</code></td>
|
||||
<td>Visual separator line with orientation</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
### 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 |
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Component</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>Tabs</code></td>
|
||||
<td>Tabbed navigation with tabs array, defaultValue, value</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>Accordion</code></td>
|
||||
<td>Collapsible sections with items array and type (single/multiple)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>Collapsible</code></td>
|
||||
<td>Single collapsible section with title and defaultOpen</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>Pagination</code></td>
|
||||
<td>Page navigation with totalPages and page</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
### 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 |
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Component</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>Dialog</code></td>
|
||||
<td>Modal dialog with title, description, openPath</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>Drawer</code></td>
|
||||
<td>Bottom drawer with title, description, openPath</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>Tooltip</code></td>
|
||||
<td>Hover tooltip with content and text</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>Popover</code></td>
|
||||
<td>Click-triggered popover with trigger and content</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>DropdownMenu</code></td>
|
||||
<td>Dropdown menu with label and items array</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
### 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 |
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Component</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>Heading</code></td>
|
||||
<td>Heading text with level (h1-h4)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>Text</code></td>
|
||||
<td>Paragraph with variant (body, caption, muted, lead, code)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>Image</code></td>
|
||||
<td>Image with alt, width, height</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>Avatar</code></td>
|
||||
<td>User avatar with src, name, size</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>Badge</code></td>
|
||||
<td>Status badge with text and variant</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>Alert</code></td>
|
||||
<td>Alert banner with title, message, type</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>Carousel</code></td>
|
||||
<td>Horizontally scrollable carousel with items</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>Table</code></td>
|
||||
<td>Data table with columns and rows</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
### Feedback
|
||||
|
||||
| Component | Description |
|
||||
|-----------|-------------|
|
||||
| `Progress` | Progress bar with value, max, label |
|
||||
| `Skeleton` | Loading placeholder with width, height, rounded |
|
||||
| `Spinner` | Loading spinner with size and label |
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Component</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>Progress</code></td>
|
||||
<td>Progress bar with value, max, label</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>Skeleton</code></td>
|
||||
<td>Loading placeholder with width, height, rounded</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>Spinner</code></td>
|
||||
<td>Loading spinner with size and label</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
### 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 |
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Component</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>Button</code></td>
|
||||
<td>Clickable button with label, variant, disabled</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>Link</code></td>
|
||||
<td>Anchor link with label and href</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>Input</code></td>
|
||||
<td>Text input with label, name, type, placeholder, value, checks</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>Textarea</code></td>
|
||||
<td>Multi-line text input with label, name, placeholder, rows, value, checks</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>Select</code></td>
|
||||
<td>Dropdown select with label, name, options, value, checks</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>Checkbox</code></td>
|
||||
<td>Checkbox with label, name, checked</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>Radio</code></td>
|
||||
<td>Radio button group with label, name, options, value</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>Switch</code></td>
|
||||
<td>Toggle switch with label, name, checked</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>Slider</code></td>
|
||||
<td>Range slider with label, min, max, step, value</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>Toggle</code></td>
|
||||
<td>Toggle button with label, pressed, variant</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>ToggleGroup</code></td>
|
||||
<td>Group of toggle buttons with items, type, value</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>ButtonGroup</code></td>
|
||||
<td>Group of buttons with buttons array and selected</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
## Notes
|
||||
|
||||
|
||||
@@ -0,0 +1,201 @@
|
||||
import { pageMetadata } from "@/lib/page-metadata";
|
||||
export const metadata = pageMetadata("docs/api/solid");
|
||||
|
||||
# @json-render/solid
|
||||
|
||||
SolidJS components, providers, and hooks for rendering json-render specs.
|
||||
|
||||
## Installation
|
||||
|
||||
<PackageInstall packages="@json-render/core @json-render/solid" />
|
||||
|
||||
Peer dependencies: `solid-js ^1.9.0` and `zod ^4.0.0`.
|
||||
|
||||
<PackageInstall packages="solid-js zod" />
|
||||
|
||||
## Providers
|
||||
|
||||
### StateProvider
|
||||
|
||||
```tsx
|
||||
<StateProvider
|
||||
initialState={{}}
|
||||
onStateChange={(changes) => console.log(changes)}
|
||||
>
|
||||
{/* children */}
|
||||
</StateProvider>
|
||||
```
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Prop</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<code>store</code>
|
||||
</td>
|
||||
<td>
|
||||
<code>StateStore</code>
|
||||
</td>
|
||||
<td>
|
||||
External store (controlled mode). When provided,{" "}
|
||||
<code>initialState</code> and <code>onStateChange</code> are ignored.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>initialState</code>
|
||||
</td>
|
||||
<td>
|
||||
<code>Record<string, unknown></code>
|
||||
</td>
|
||||
<td>Initial state model for uncontrolled mode.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<code>onStateChange</code>
|
||||
</td>
|
||||
<td>
|
||||
<code>
|
||||
{"(changes: Array<{ path: string; value: unknown }>) => void"}
|
||||
</code>
|
||||
</td>
|
||||
<td>Called for uncontrolled state updates.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
### ActionProvider
|
||||
|
||||
```tsx
|
||||
<ActionProvider
|
||||
handlers={{ submit: async (params) => {} }}
|
||||
navigate={(path) => {}}
|
||||
>
|
||||
{/* children */}
|
||||
</ActionProvider>
|
||||
```
|
||||
|
||||
### VisibilityProvider
|
||||
|
||||
```tsx
|
||||
<VisibilityProvider>{/* children */}</VisibilityProvider>
|
||||
```
|
||||
|
||||
### ValidationProvider
|
||||
|
||||
```tsx
|
||||
<ValidationProvider customFunctions={{ custom: (value) => Boolean(value) }}>
|
||||
{/* children */}
|
||||
</ValidationProvider>
|
||||
```
|
||||
|
||||
### JSONUIProvider
|
||||
|
||||
Combined provider wrapper for state, visibility, validation, and actions.
|
||||
|
||||
```tsx
|
||||
<JSONUIProvider
|
||||
registry={registry}
|
||||
initialState={{}}
|
||||
handlers={handlers}
|
||||
validationFunctions={validationFunctions}
|
||||
>
|
||||
<Renderer spec={spec} registry={registry} />
|
||||
</JSONUIProvider>
|
||||
```
|
||||
|
||||
## defineRegistry
|
||||
|
||||
Create a typed component registry and action helpers from a catalog.
|
||||
|
||||
```tsx
|
||||
const { registry, handlers, executeAction } = defineRegistry(catalog, {
|
||||
components: {
|
||||
Card: (renderProps) => <div>{renderProps.children}</div>,
|
||||
Button: (renderProps) => (
|
||||
<button onClick={() => renderProps.emit("press")}>
|
||||
{renderProps.element.props.label as string}
|
||||
</button>
|
||||
),
|
||||
},
|
||||
actions: {
|
||||
submit: async (params, setState, state) => {
|
||||
// custom action logic
|
||||
},
|
||||
},
|
||||
});
|
||||
```
|
||||
|
||||
## Components
|
||||
|
||||
### Renderer
|
||||
|
||||
```tsx
|
||||
<Renderer spec={spec} registry={registry} loading={false} />
|
||||
```
|
||||
|
||||
Renders a `Spec` tree using your registry.
|
||||
|
||||
### createRenderer
|
||||
|
||||
Build an app-level renderer from catalog + components:
|
||||
|
||||
```tsx
|
||||
const AppRenderer = createRenderer(catalog, {
|
||||
Card: (renderProps) => <div>{renderProps.children}</div>,
|
||||
});
|
||||
|
||||
<AppRenderer spec={spec} state={{}} onAction={(name, params) => {}} />;
|
||||
```
|
||||
|
||||
## Hooks
|
||||
|
||||
- `useStateStore()`
|
||||
- `useStateValue(path)` - returns an accessor
|
||||
- `useStateBinding(path)` - returns `[Accessor<T | undefined>, setValue]`
|
||||
- `useVisibility()` / `useIsVisible(condition)`
|
||||
- `useActions()` / `useAction(binding)`
|
||||
- `useValidation()` / `useOptionalValidation()`
|
||||
- `useFieldValidation(path, config)` - returns accessor-backed `state`, `errors`, and `isValid`
|
||||
- `useBoundProp(value, bindingPath)`
|
||||
- `useUIStream(options)`
|
||||
- `useChatUI(options)`
|
||||
|
||||
## Built-in Actions
|
||||
|
||||
`ActionProvider` handles these built-in actions:
|
||||
|
||||
- `setState`
|
||||
- `pushState`
|
||||
- `removeState`
|
||||
- `validateForm`
|
||||
|
||||
## Component Props
|
||||
|
||||
Registry components receive:
|
||||
|
||||
```ts
|
||||
interface ComponentRenderProps<P = Record<string, unknown>> {
|
||||
element: UIElement<string, P>;
|
||||
children?: JSX.Element;
|
||||
emit: (event: string) => void;
|
||||
on: (event: string) => EventHandle;
|
||||
bindings?: Record<string, string>;
|
||||
loading?: boolean;
|
||||
}
|
||||
```
|
||||
|
||||
Use `emit("event")` to dispatch event bindings. Use `on("event")` to access `EventHandle` metadata (`bound`, `shouldPreventDefault`, `emit`).
|
||||
|
||||
## Reactivity Notes
|
||||
|
||||
- Keep changing reads in JSX expressions, `createMemo`, or `createEffect`.
|
||||
- Avoid props destructuring in component signatures when you need live updates.
|
||||
- `StateProvider` and other contexts expose getter-backed values so consumers read live signals.
|
||||
- `useStateValue`, `useStateBinding`, and `useFieldValidation` expose reactive accessors; call them as functions.
|
||||
@@ -0,0 +1,126 @@
|
||||
import { pageMetadata } from "@/lib/page-metadata"
|
||||
export const metadata = pageMetadata("docs/api/svelte")
|
||||
|
||||
# @json-render/svelte
|
||||
|
||||
Svelte 5 components, providers, and helpers for rendering json-render specs.
|
||||
|
||||
## Installation
|
||||
|
||||
<PackageInstall packages="@json-render/core @json-render/svelte" />
|
||||
|
||||
Peer dependencies: `svelte ^5.0.0` and `zod ^4.0.0`.
|
||||
|
||||
<PackageInstall packages="svelte zod" />
|
||||
|
||||
## Components
|
||||
|
||||
### Renderer
|
||||
|
||||
```svelte
|
||||
<Renderer
|
||||
spec={spec} // Spec | null
|
||||
registry={registry}
|
||||
loading={false}
|
||||
/>
|
||||
```
|
||||
|
||||
Renders a spec with your component registry. If `spec` is `null`, it renders nothing.
|
||||
|
||||
### JsonUIProvider
|
||||
|
||||
Convenience wrapper around `StateProvider`, `VisibilityProvider`, `ValidationProvider`, and `ActionProvider`.
|
||||
|
||||
```svelte
|
||||
<JsonUIProvider
|
||||
initialState={{}}
|
||||
handlers={handlers}
|
||||
validationFunctions={validationFunctions}
|
||||
>
|
||||
<Renderer {spec} {registry} />
|
||||
</JsonUIProvider>
|
||||
```
|
||||
|
||||
## defineRegistry
|
||||
|
||||
Create a typed component registry and action handlers from a catalog.
|
||||
|
||||
```typescript
|
||||
import { defineRegistry } from "@json-render/svelte";
|
||||
|
||||
const { registry, handlers, executeAction } = defineRegistry(catalog, {
|
||||
components: {
|
||||
Card,
|
||||
Button,
|
||||
},
|
||||
actions: {
|
||||
submit: async (params, setState, state) => {
|
||||
// custom action logic
|
||||
},
|
||||
},
|
||||
});
|
||||
```
|
||||
|
||||
`handlers` is designed for `JsonUIProvider`/`ActionProvider`. `executeAction` is an imperative helper.
|
||||
|
||||
## Component Props
|
||||
|
||||
Registry components receive `BaseComponentProps<TProps>`:
|
||||
|
||||
```typescript
|
||||
interface BaseComponentProps<TProps> {
|
||||
props: TProps;
|
||||
children?: Snippet;
|
||||
emit: (event: string) => void;
|
||||
bindings?: Record<string, string>;
|
||||
loading?: boolean;
|
||||
}
|
||||
```
|
||||
|
||||
Use `emit("eventName")` to trigger handlers declared in the spec `on` bindings.
|
||||
|
||||
## Context Helpers
|
||||
|
||||
Use these helpers inside Svelte components:
|
||||
|
||||
- `getStateValue(path)` - read/write state via `.current`
|
||||
- `getBoundProp(() => value, () => bindingPath)` - write back resolved `$bindState` / `$bindItem` values
|
||||
- `isVisible(condition)` - evaluate visibility via `.current`
|
||||
- `getAction(name)` - read a registered action handler via `.current`
|
||||
- `getFieldValidation(ctx, path, config)` - get field validation state + actions
|
||||
|
||||
For advanced usage, access full contexts:
|
||||
|
||||
- `getStateContext()`
|
||||
- `getActionContext()`
|
||||
- `getVisibilityContext()`
|
||||
- `getValidationContext()`
|
||||
- `getOptionalValidationContext()`
|
||||
|
||||
## Streaming
|
||||
|
||||
### createUIStream
|
||||
|
||||
```typescript
|
||||
const stream = createUIStream({
|
||||
api: "/api/generate-ui",
|
||||
onComplete: (spec) => console.log(spec),
|
||||
});
|
||||
|
||||
await stream.send("Create a login form");
|
||||
|
||||
console.log(stream.spec);
|
||||
console.log(stream.isStreaming);
|
||||
```
|
||||
|
||||
### createChatUI
|
||||
|
||||
```typescript
|
||||
const chat = createChatUI({ api: "/api/chat-ui" });
|
||||
await chat.send("Build a settings panel");
|
||||
console.log(chat.messages, chat.isStreaming);
|
||||
```
|
||||
|
||||
## Schema Export
|
||||
|
||||
Use `schema` from `@json-render/svelte` when defining catalogs for Svelte specs.
|
||||
@@ -0,0 +1,337 @@
|
||||
import { pageMetadata } from "@/lib/page-metadata"
|
||||
export const metadata = pageMetadata("docs/api/vue")
|
||||
|
||||
# @json-render/vue
|
||||
|
||||
Vue 3 components, providers, and composables.
|
||||
|
||||
## Providers
|
||||
|
||||
### StateProvider
|
||||
|
||||
```vue
|
||||
<StateProvider :initial-state="object" :on-state-change="fn">
|
||||
<!-- children -->
|
||||
</StateProvider>
|
||||
```
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Prop</th>
|
||||
<th>Type</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>store</code></td>
|
||||
<td><code>StateStore</code></td>
|
||||
<td>External store (controlled mode). When provided, <code>initialState</code> and <code>onStateChange</code> are ignored.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>initialState</code></td>
|
||||
<td><code>Record<string, unknown></code></td>
|
||||
<td>Initial state model (uncontrolled mode).</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>onStateChange</code></td>
|
||||
<td><code>{'(changes: Array<{ path: string; value: unknown }>) => void'}</code></td>
|
||||
<td>Callback when state changes (uncontrolled mode). Called once per <code>set</code> or <code>update</code> with all changed entries.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
#### External Store (Controlled Mode)
|
||||
|
||||
Pass a `StateStore` to bypass the internal state and wire json-render to any state management library:
|
||||
|
||||
```typescript
|
||||
import { createStateStore, type StateStore } from "@json-render/vue";
|
||||
|
||||
const store = createStateStore({ count: 0 });
|
||||
```
|
||||
|
||||
```vue
|
||||
<StateProvider :store="store">
|
||||
<!-- children -->
|
||||
</StateProvider>
|
||||
```
|
||||
|
||||
```typescript
|
||||
// Mutate from anywhere — Vue re-renders automatically:
|
||||
store.set("/count", 1);
|
||||
```
|
||||
|
||||
### ActionProvider
|
||||
|
||||
```vue
|
||||
<ActionProvider :handlers="Record<string, ActionHandler>" :navigate="fn">
|
||||
<!-- children -->
|
||||
</ActionProvider>
|
||||
|
||||
// type ActionHandler = (params: Record<string, unknown>) => void | Promise<void>;
|
||||
```
|
||||
|
||||
### VisibilityProvider
|
||||
|
||||
```vue
|
||||
<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
|
||||
|
||||
```vue
|
||||
<ValidationProvider :custom-functions="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. When passing stubs, any `async () => {}` is sufficient.
|
||||
|
||||
```typescript
|
||||
import { h } from "vue";
|
||||
import { defineRegistry } from "@json-render/vue";
|
||||
|
||||
const { registry } = defineRegistry(catalog, {
|
||||
components: {
|
||||
Card: ({ props, children }) =>
|
||||
h("div", { class: "card" }, [h("h3", null, props.title), children]),
|
||||
Button: ({ props, emit }) =>
|
||||
h("button", { onClick: () => emit("press") }, props.label),
|
||||
},
|
||||
// Required when catalog declares actions:
|
||||
actions: {
|
||||
submit: async (params) => { /* ... */ },
|
||||
},
|
||||
});
|
||||
|
||||
// Pass to <Renderer>
|
||||
// <Renderer :spec="spec" :registry="registry" />
|
||||
```
|
||||
|
||||
## Components
|
||||
|
||||
### Renderer
|
||||
|
||||
```vue
|
||||
<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
|
||||
/>
|
||||
```
|
||||
|
||||
### Component Props (via defineRegistry)
|
||||
|
||||
```typescript
|
||||
import type { VNode } from "vue";
|
||||
|
||||
interface ComponentContext<P> {
|
||||
props: P; // Typed props from catalog
|
||||
children?: VNode | VNode[]; // Rendered children (for container 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 metadata like `shouldPreventDefault`:
|
||||
|
||||
```typescript
|
||||
Link: ({ props, on }) => {
|
||||
const click = on("click");
|
||||
return h("a", {
|
||||
href: props.href,
|
||||
onClick: (e: MouseEvent) => {
|
||||
if (click.shouldPreventDefault) e.preventDefault();
|
||||
click.emit();
|
||||
},
|
||||
}, props.label);
|
||||
},
|
||||
```
|
||||
|
||||
### BaseComponentProps
|
||||
|
||||
Catalog-agnostic base type for building reusable component libraries that are not tied to a specific catalog:
|
||||
|
||||
```typescript
|
||||
import type { BaseComponentProps } from "@json-render/vue";
|
||||
|
||||
const Card = ({ props, children }: BaseComponentProps<{ title?: string }>) =>
|
||||
h("div", null, [props.title, children]);
|
||||
```
|
||||
|
||||
## Composables
|
||||
|
||||
### useStateStore
|
||||
|
||||
```typescript
|
||||
const {
|
||||
state, // ShallowRef<StateModel> — access with state.value
|
||||
get, // (path: string) => unknown
|
||||
set, // (path: string, value: unknown) => void
|
||||
update, // (updates: Record<string, unknown>) => void
|
||||
} = useStateStore();
|
||||
```
|
||||
|
||||
> **Note:** `state` is a `ShallowRef<StateModel>`, not a plain object. Use `state.value` to read the current state. This differs from the React renderer.
|
||||
|
||||
### useStateValue
|
||||
|
||||
```typescript
|
||||
const value = useStateValue(path: string); // ComputedRef<T | undefined>
|
||||
```
|
||||
|
||||
Returns a `ComputedRef` that automatically updates when the state at `path` changes. Use `.value` to access the current value.
|
||||
|
||||
### useStateBinding (deprecated)
|
||||
|
||||
> **Deprecated.** Use `$bindState` expressions with `bindings` prop instead.
|
||||
|
||||
```typescript
|
||||
const [value, setValue] = useStateBinding(path: string);
|
||||
// value: ComputedRef<T | undefined>
|
||||
// setValue: (value: T) => void
|
||||
```
|
||||
|
||||
### useActions
|
||||
|
||||
```typescript
|
||||
const { execute } = useActions();
|
||||
// execute(binding: ActionBinding) => Promise<void>
|
||||
```
|
||||
|
||||
### useAction
|
||||
|
||||
```typescript
|
||||
const { execute, isLoading } = useAction(binding: ActionBinding);
|
||||
// execute: () => Promise<void>
|
||||
// isLoading: ComputedRef<boolean>
|
||||
```
|
||||
|
||||
### useIsVisible
|
||||
|
||||
```typescript
|
||||
const isVisible = useIsVisible(condition?: VisibilityCondition);
|
||||
```
|
||||
|
||||
### useFieldValidation
|
||||
|
||||
```typescript
|
||||
const {
|
||||
state, // ComputedRef<FieldValidationState>
|
||||
validate, // () => ValidationResult
|
||||
touch, // () => void
|
||||
clear, // () => void
|
||||
errors, // ComputedRef<string[]>
|
||||
isValid, // ComputedRef<boolean>
|
||||
} = useFieldValidation(path: string, config?: ValidationConfig);
|
||||
```
|
||||
|
||||
`ValidationConfig` is `{ checks?: ValidationCheck[], validateOn?: 'change' | 'blur' | 'submit' }`.
|
||||
|
||||
## Differences from `@json-render/react`
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>API</th>
|
||||
<th>React</th>
|
||||
<th>Vue</th>
|
||||
<th>Note</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>useStateStore().state</code></td>
|
||||
<td><code>StateModel</code> (plain object)</td>
|
||||
<td><code>ShallowRef<StateModel></code></td>
|
||||
<td>Vue reactivity; use <code>state.value</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>useStateValue()</code></td>
|
||||
<td><code>T | undefined</code></td>
|
||||
<td><code>ComputedRef<T | undefined></code></td>
|
||||
<td>Vue reactivity; use <code>.value</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>useStateBinding()</code></td>
|
||||
<td><code>[T | undefined, setter]</code></td>
|
||||
<td><code>[ComputedRef<T | undefined>, setter]</code></td>
|
||||
<td>Vue reactivity; use <code>value.value</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>useAction().isLoading</code></td>
|
||||
<td><code>boolean</code></td>
|
||||
<td><code>ComputedRef<boolean></code></td>
|
||||
<td>Vue reactivity; use <code>.value</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>useFieldValidation().state</code></td>
|
||||
<td><code>FieldValidationState</code></td>
|
||||
<td><code>ComputedRef<FieldValidationState></code></td>
|
||||
<td>Vue reactivity; use <code>.value</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>useFieldValidation().errors</code></td>
|
||||
<td><code>string[]</code></td>
|
||||
<td><code>ComputedRef<string[]></code></td>
|
||||
<td>Vue reactivity; use <code>.value</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>useFieldValidation().isValid</code></td>
|
||||
<td><code>boolean</code></td>
|
||||
<td><code>ComputedRef<boolean></code></td>
|
||||
<td>Vue reactivity; use <code>.value</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>VisibilityContextValue.ctx</code></td>
|
||||
<td><code>CoreVisibilityContext</code></td>
|
||||
<td><code>ComputedRef<CoreVisibilityContext></code></td>
|
||||
<td>Vue reactivity; use <code>ctx.value</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>children</code> type</td>
|
||||
<td><code>React.ReactNode</code></td>
|
||||
<td><code>VNode | VNode[]</code></td>
|
||||
<td>Platform-specific</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>useBoundProp</code></td>
|
||||
<td>exported</td>
|
||||
<td>exported</td>
|
||||
<td>Same API; returns <code>[value, setValue]</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>VisibilityProviderProps</code></td>
|
||||
<td>exported</td>
|
||||
<td>not exported (no props)</td>
|
||||
<td>Vue uses slot, no prop needed</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Streaming hooks</td>
|
||||
<td><code>useUIStream</code>, <code>useChatUI</code></td>
|
||||
<td><code>useUIStream</code>, <code>useChatUI</code></td>
|
||||
<td>Same API; returns Vue <code>Ref</code> values</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
@@ -0,0 +1,77 @@
|
||||
import { pageMetadata } from "@/lib/page-metadata"
|
||||
export const metadata = pageMetadata("docs/api/xstate")
|
||||
|
||||
# @json-render/xstate
|
||||
|
||||
[XState Store](https://stately.ai/docs/xstate-store) adapter for json-render's `StateStore` interface.
|
||||
|
||||
Requires `@xstate/store` v3+.
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
npm install @json-render/xstate @json-render/core @json-render/react @xstate/store
|
||||
```
|
||||
|
||||
## xstateStoreStateStore
|
||||
|
||||
Create a `StateStore` backed by an `@xstate/store` atom.
|
||||
|
||||
```typescript
|
||||
import { xstateStoreStateStore } from "@json-render/xstate";
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Option</th>
|
||||
<th>Type</th>
|
||||
<th>Required</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>atom</code></td>
|
||||
<td><code>{'Atom<StateModel>'}</code></td>
|
||||
<td>Yes</td>
|
||||
<td>An <code>@xstate/store</code> atom (from <code>createAtom</code>) holding the json-render state model.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import { createAtom } from "@xstate/store";
|
||||
import { xstateStoreStateStore } from "@json-render/xstate";
|
||||
import { StateProvider } from "@json-render/react";
|
||||
|
||||
const uiAtom = createAtom({ count: 0 });
|
||||
const store = xstateStoreStateStore({ atom: uiAtom });
|
||||
```
|
||||
|
||||
```tsx
|
||||
<StateProvider store={store}>
|
||||
{/* json-render reads/writes go through @xstate/store */}
|
||||
</StateProvider>
|
||||
```
|
||||
|
||||
## Re-exports
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Export</th>
|
||||
<th>Source</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>StateStore</code></td>
|
||||
<td><code>@json-render/core</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
@@ -0,0 +1,232 @@
|
||||
import { pageMetadata } from "@/lib/page-metadata"
|
||||
export const metadata = pageMetadata("docs/api/yaml")
|
||||
|
||||
# @json-render/yaml
|
||||
|
||||
YAML wire format for json-render. Progressive rendering and surgical edits via streaming YAML.
|
||||
|
||||
## Prompt Generation
|
||||
|
||||
### yamlPrompt
|
||||
|
||||
Generate a YAML-format system prompt from any json-render catalog. Works with catalogs from any renderer.
|
||||
|
||||
```typescript
|
||||
function yamlPrompt(
|
||||
catalog: Catalog,
|
||||
options?: YamlPromptOptions
|
||||
): string
|
||||
```
|
||||
|
||||
```typescript
|
||||
import { yamlPrompt } from "@json-render/yaml";
|
||||
|
||||
const systemPrompt = yamlPrompt(catalog, {
|
||||
mode: "standalone",
|
||||
customRules: ["Always use dark theme"],
|
||||
editModes: ["merge"],
|
||||
});
|
||||
```
|
||||
|
||||
### YamlPromptOptions
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Option</th>
|
||||
<th>Type</th>
|
||||
<th>Default</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>system</code></td>
|
||||
<td><code>string</code></td>
|
||||
<td><code>{'\"You are a UI generator that outputs YAML.\"'}</code></td>
|
||||
<td>Custom system message intro</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>mode</code></td>
|
||||
<td><code>{'\"standalone\" | \"inline\"'}</code></td>
|
||||
<td><code>{'\"standalone\"'}</code></td>
|
||||
<td>Standalone outputs only YAML; inline allows conversational responses with embedded YAML fences</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>customRules</code></td>
|
||||
<td><code>{'string[]'}</code></td>
|
||||
<td><code>{'[]'}</code></td>
|
||||
<td>Additional rules appended to the prompt</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>editModes</code></td>
|
||||
<td><code>{'EditMode[]'}</code></td>
|
||||
<td><code>{'[\"merge\"]'}</code></td>
|
||||
<td>Edit modes to document in the prompt (patch, merge, diff)</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
## AI SDK Transform
|
||||
|
||||
### createYamlTransform
|
||||
|
||||
Creates a `TransformStream` that intercepts AI SDK stream chunks and converts YAML spec/edit blocks into json-render patch data parts.
|
||||
|
||||
```typescript
|
||||
function createYamlTransform(
|
||||
options?: YamlTransformOptions
|
||||
): TransformStream<StreamChunk, StreamChunk>
|
||||
```
|
||||
|
||||
Recognized fence types:
|
||||
|
||||
- <code>{'```yaml-spec'}</code> -- Full YAML spec, parsed progressively
|
||||
- <code>{'```yaml-edit'}</code> -- Partial YAML, deep-merged with current spec
|
||||
- <code>{'```yaml-patch'}</code> -- RFC 6902 JSON Patch lines
|
||||
- <code>{'```diff'}</code> -- Unified diff against serialized spec
|
||||
|
||||
### pipeYamlRender
|
||||
|
||||
Convenience wrapper that pipes an AI SDK stream through the YAML transform. Drop-in replacement for `pipeJsonRender` from `@json-render/core`.
|
||||
|
||||
```typescript
|
||||
function pipeYamlRender<T>(
|
||||
stream: ReadableStream<T>,
|
||||
options?: YamlTransformOptions
|
||||
): ReadableStream<T>
|
||||
```
|
||||
|
||||
```typescript
|
||||
import { pipeYamlRender } from "@json-render/yaml";
|
||||
import { createUIMessageStream, createUIMessageStreamResponse } from "ai";
|
||||
|
||||
const stream = createUIMessageStream({
|
||||
execute: async ({ writer }) => {
|
||||
writer.merge(pipeYamlRender(result.toUIMessageStream()));
|
||||
},
|
||||
});
|
||||
return createUIMessageStreamResponse({ stream });
|
||||
```
|
||||
|
||||
## Streaming Parser
|
||||
|
||||
### createYamlStreamCompiler
|
||||
|
||||
Create a streaming YAML compiler that incrementally parses YAML text and emits JSON Patch operations by diffing each successful parse against the previous snapshot.
|
||||
|
||||
```typescript
|
||||
function createYamlStreamCompiler<T>(
|
||||
initial?: Partial<T>
|
||||
): YamlStreamCompiler<T>
|
||||
```
|
||||
|
||||
```typescript
|
||||
import { createYamlStreamCompiler } from "@json-render/yaml";
|
||||
|
||||
const compiler = createYamlStreamCompiler<Spec>();
|
||||
|
||||
compiler.push("root: main\n");
|
||||
compiler.push("elements:\n main:\n type: Card\n");
|
||||
|
||||
const { result, newPatches } = compiler.flush();
|
||||
```
|
||||
|
||||
### YamlStreamCompiler
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Method</th>
|
||||
<th>Returns</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>push(chunk)</code></td>
|
||||
<td><code>{'{ result: T; newPatches: JsonPatch[] }'}</code></td>
|
||||
<td>Push a chunk of text, returns current result and new patches</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>flush()</code></td>
|
||||
<td><code>{'{ result: T; newPatches: JsonPatch[] }'}</code></td>
|
||||
<td>Flush remaining buffer, return final result</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>getResult()</code></td>
|
||||
<td><code>T</code></td>
|
||||
<td>Get the current compiled result</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>getPatches()</code></td>
|
||||
<td><code>{'JsonPatch[]'}</code></td>
|
||||
<td>Get all patches applied so far</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>reset(initial?)</code></td>
|
||||
<td><code>void</code></td>
|
||||
<td>Reset to initial state</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
## Fence Constants
|
||||
|
||||
Exported string constants for fence detection in custom parsers:
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Constant</th>
|
||||
<th>Value</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>YAML_SPEC_FENCE</code></td>
|
||||
<td><code>{'\"```yaml-spec\"'}</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>YAML_EDIT_FENCE</code></td>
|
||||
<td><code>{'\"```yaml-edit\"'}</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>YAML_PATCH_FENCE</code></td>
|
||||
<td><code>{'\"```yaml-patch\"'}</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>DIFF_FENCE</code></td>
|
||||
<td><code>{'\"```diff\"'}</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>FENCE_CLOSE</code></td>
|
||||
<td><code>{'\"```\"'}</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
## Re-exports from @json-render/core
|
||||
|
||||
### diffToPatches
|
||||
|
||||
Generate RFC 6902 JSON Patch operations that transform one object into another.
|
||||
|
||||
```typescript
|
||||
function diffToPatches(
|
||||
oldObj: Record<string, unknown>,
|
||||
newObj: Record<string, unknown>,
|
||||
basePath?: string
|
||||
): JsonPatch[]
|
||||
```
|
||||
|
||||
### deepMergeSpec
|
||||
|
||||
Deep-merge with RFC 7396 semantics: `null` deletes, arrays replace, objects recurse.
|
||||
|
||||
```typescript
|
||||
function deepMergeSpec(
|
||||
base: Record<string, unknown>,
|
||||
patch: Record<string, unknown>
|
||||
): Record<string, unknown>
|
||||
```
|
||||
@@ -0,0 +1,108 @@
|
||||
import { pageMetadata } from "@/lib/page-metadata"
|
||||
export const metadata = pageMetadata("docs/api/zustand")
|
||||
|
||||
# @json-render/zustand
|
||||
|
||||
Zustand adapter for json-render's `StateStore` interface.
|
||||
|
||||
Requires Zustand v5+. Zustand v4 is not supported due to breaking API changes in the vanilla store interface.
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
npm install @json-render/zustand @json-render/core @json-render/react zustand
|
||||
```
|
||||
|
||||
## zustandStateStore
|
||||
|
||||
Create a `StateStore` backed by a Zustand vanilla store.
|
||||
|
||||
```typescript
|
||||
import { zustandStateStore } from "@json-render/zustand";
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Option</th>
|
||||
<th>Type</th>
|
||||
<th>Required</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>store</code></td>
|
||||
<td><code>{'StoreApi<S>'}</code></td>
|
||||
<td>Yes</td>
|
||||
<td>A Zustand vanilla store (from <code>createStore</code> in <code>zustand/vanilla</code>).</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>selector</code></td>
|
||||
<td><code>{'(state: S) => StateModel'}</code></td>
|
||||
<td>No</td>
|
||||
<td>Select the json-render slice from the store state. Defaults to the entire state.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>updater</code></td>
|
||||
<td><code>{'(nextState: StateModel, store: StoreApi<S>) => void'}</code></td>
|
||||
<td>No</td>
|
||||
<td>Apply a state change back to the store. Defaults to a shallow merge.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import { createStore } from "zustand/vanilla";
|
||||
import { zustandStateStore } from "@json-render/zustand";
|
||||
import { StateProvider } from "@json-render/react";
|
||||
|
||||
const bearStore = createStore(() => ({
|
||||
count: 0,
|
||||
name: "Bear",
|
||||
}));
|
||||
|
||||
const store = zustandStateStore({ store: bearStore });
|
||||
```
|
||||
|
||||
```tsx
|
||||
<StateProvider store={store}>
|
||||
{/* json-render reads/writes go through Zustand */}
|
||||
</StateProvider>
|
||||
```
|
||||
|
||||
### Nested Slice
|
||||
|
||||
```typescript
|
||||
const appStore = createStore(() => ({
|
||||
ui: { count: 0 },
|
||||
auth: { token: null },
|
||||
}));
|
||||
|
||||
const store = zustandStateStore({
|
||||
store: appStore,
|
||||
selector: (s) => s.ui,
|
||||
updater: (next, s) => s.setState({ ui: next }),
|
||||
});
|
||||
```
|
||||
|
||||
## Re-exports
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Export</th>
|
||||
<th>Source</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>StateStore</code></td>
|
||||
<td><code>@json-render/core</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
@@ -1,4 +1,5 @@
|
||||
export const metadata = { title: "Catalog" }
|
||||
import { pageMetadata } from "@/lib/page-metadata"
|
||||
export const metadata = pageMetadata("docs/catalog")
|
||||
|
||||
# Catalog
|
||||
|
||||
@@ -18,7 +19,7 @@ A catalog is the vocabulary for your UI. While the [schema](/docs/schemas) defin
|
||||
|
||||
```typescript
|
||||
import { defineCatalog } from '@json-render/core';
|
||||
import { schema } from '@json-render/react'; // or '@json-render/react-native'
|
||||
import { schema } from '@json-render/react/schema'; // or '@json-render/react-native/schema'
|
||||
import { z } from 'zod';
|
||||
|
||||
const catalog = defineCatalog(schema, {
|
||||
|
||||
@@ -1,9 +1,249 @@
|
||||
export const metadata = { title: "Changelog" }
|
||||
import { pageMetadata } from "@/lib/page-metadata"
|
||||
export const metadata = pageMetadata("docs/changelog")
|
||||
|
||||
# Changelog
|
||||
|
||||
Notable changes and updates to json-render.
|
||||
|
||||
## v0.10.0
|
||||
|
||||
February 2026
|
||||
|
||||
### New: `@json-render/vue`
|
||||
|
||||
Vue 3 renderer for json-render with full feature parity with `@json-render/react`. Data binding, visibility conditions, actions, validation, repeat scopes, streaming, and external store support.
|
||||
|
||||
```bash
|
||||
npm install @json-render/core @json-render/vue
|
||||
```
|
||||
|
||||
```typescript
|
||||
import { h } from "vue";
|
||||
import { defineRegistry, Renderer } from "@json-render/vue";
|
||||
import { schema } from "@json-render/vue/schema";
|
||||
|
||||
const { registry } = defineRegistry(catalog, {
|
||||
components: {
|
||||
Card: ({ props, children }) =>
|
||||
h("div", { class: "card" }, [h("h3", null, props.title), children]),
|
||||
Button: ({ props, emit }) =>
|
||||
h("button", { onClick: () => emit("press") }, props.label),
|
||||
},
|
||||
});
|
||||
```
|
||||
|
||||
Providers: `StateProvider`, `ActionProvider`, `VisibilityProvider`, `ValidationProvider`. Composables: `useStateStore`, `useStateValue`, `useActions`, `useAction`, `useIsVisible`, `useFieldValidation`, `useBoundProp`, `useUIStream`, `useChatUI`.
|
||||
|
||||
See the [Vue API reference](/docs/api/vue) for details.
|
||||
|
||||
### New: `@json-render/xstate`
|
||||
|
||||
[XState Store](https://stately.ai/docs/xstate-store) (atom) adapter for json-render's `StateStore` interface. Wire an `@xstate/store` atom as the state backend for any renderer.
|
||||
|
||||
```bash
|
||||
npm install @json-render/xstate @xstate/store
|
||||
```
|
||||
|
||||
```typescript
|
||||
import { createAtom } from "@xstate/store";
|
||||
import { xstateStoreStateStore } from "@json-render/xstate";
|
||||
|
||||
const atom = createAtom({ count: 0 });
|
||||
const store = xstateStoreStateStore({ atom });
|
||||
```
|
||||
|
||||
Requires `@xstate/store` v3+.
|
||||
|
||||
### New: `$computed` and `$template` Expressions
|
||||
|
||||
Two new prop expression types for dynamic values:
|
||||
|
||||
- **`$template`** -- interpolate state values into strings: `{ "$template": "Hello, ${/user/name}!" }`
|
||||
- **`$computed`** -- call registered functions: `{ "$computed": "fullName", "args": { "first": { "$state": "/form/firstName" } } }`
|
||||
|
||||
Register functions via the `functions` prop on `JSONUIProvider` or `createRenderer`. See [Computed Values](/docs/computed-values) for details.
|
||||
|
||||
### New: State Watchers
|
||||
|
||||
Elements can declare a `watch` field to trigger actions when state values change. Useful for cascading dependencies like country/city selects.
|
||||
|
||||
```json
|
||||
{
|
||||
"type": "Select",
|
||||
"props": { "value": { "$bindState": "/form/country" }, "options": ["US", "Canada"] },
|
||||
"watch": {
|
||||
"/form/country": { "action": "loadCities", "params": { "country": { "$state": "/form/country" } } }
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
`watch` is a top-level field on elements (sibling of type/props/children), not inside props. Watchers only fire on value changes, not on initial render. See [Watchers](/docs/watchers) for details.
|
||||
|
||||
### New: Cross-Field Validation
|
||||
|
||||
New built-in validation functions for cross-field comparisons:
|
||||
|
||||
- `equalTo` -- alias for `matches` with clearer semantics
|
||||
- `lessThan` -- value must be less than another field
|
||||
- `greaterThan` -- value must be greater than another field
|
||||
- `requiredIf` -- required only when a condition field is truthy
|
||||
|
||||
Validation check args now resolve through `resolvePropValue`, so `$state` expressions work consistently.
|
||||
|
||||
### New: `validateForm` Action
|
||||
|
||||
Built-in action (React) that validates all registered form fields at once and writes `{ valid, errors }` to state:
|
||||
|
||||
```json
|
||||
{
|
||||
"on": {
|
||||
"press": [
|
||||
{ "action": "validateForm", "params": { "statePath": "/formResult" } },
|
||||
{ "action": "submitForm" }
|
||||
]
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Improved: shadcn/ui Validation
|
||||
|
||||
All form components now support `checks` and `validateOn` props:
|
||||
- Checkbox, Radio, Switch added validation support
|
||||
- `validateOn` controls timing: `"change"` (default for Select, Checkbox, Radio, Switch), `"blur"` (default for Input, Textarea), or `"submit"`
|
||||
|
||||
### New Examples
|
||||
|
||||
- **Vue example** -- standalone Vue 3 app with custom components
|
||||
- **Vite Renderers** -- side-by-side React and Vue renderers with shared catalog
|
||||
|
||||
---
|
||||
|
||||
## v0.9.1
|
||||
|
||||
February 2026
|
||||
|
||||
### Fixed: Install failure due to private dependency
|
||||
|
||||
`@json-render/react`, `@json-render/react-pdf`, and `@json-render/react-native` v0.9.0 failed to install because `@internal/react-state` (a private workspace package) was published as a dependency. The internal package is now bundled into each renderer at build time, so it no longer needs to be resolved from npm.
|
||||
|
||||
---
|
||||
|
||||
## 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
|
||||
@@ -101,6 +341,8 @@ February 2026
|
||||
|
||||
### New: Chat Mode (Inline GenUI)
|
||||
|
||||
> **Note:** These modes were renamed in v0.12.1 — "Generate" is now "Standalone" and "Chat" is now "Inline". The old names are accepted as deprecated aliases.
|
||||
|
||||
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
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
export const metadata = { title: "Code Export" }
|
||||
import { pageMetadata } from "@/lib/page-metadata"
|
||||
export const metadata = pageMetadata("docs/code-export")
|
||||
|
||||
# Code Export
|
||||
|
||||
@@ -134,6 +135,6 @@ Run the dashboard example and click "Export Project" to see code generation in a
|
||||
```bash
|
||||
cd examples/dashboard
|
||||
pnpm dev
|
||||
# Open http://localhost:3001
|
||||
# Open http://dashboard-demo.json-render.localhost:1355
|
||||
# Generate a widget, then click "Export Project"
|
||||
```
|
||||
|
||||
@@ -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
|
||||
@@ -1,4 +1,5 @@
|
||||
export const metadata = { title: "Custom Schema & Renderer" }
|
||||
import { pageMetadata } from "@/lib/page-metadata"
|
||||
export const metadata = pageMetadata("docs/custom-schema")
|
||||
|
||||
# Custom Schema & Renderer
|
||||
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
export const metadata = { title: "Data Binding" }
|
||||
import { pageMetadata } from "@/lib/page-metadata"
|
||||
export const metadata = pageMetadata("docs/data-binding")
|
||||
|
||||
# Data Binding
|
||||
|
||||
@@ -212,6 +213,22 @@ Use `$cond` / `$then` / `$else` to pick a prop value based on a condition:
|
||||
|
||||
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">
|
||||
@@ -254,10 +271,39 @@ The condition uses the same [visibility](/docs/visibility) expression format.
|
||||
<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
|
||||
|
||||
@@ -1,16 +1,17 @@
|
||||
export const metadata = { title: "Generation Modes" }
|
||||
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.
|
||||
json-render supports two modes for AI-generated UI: **Standalone mode** for standalone UI and **Inline 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)
|
||||
## Standalone Mode
|
||||
|
||||
In generate mode, the AI outputs **only JSONL patches** — no prose, no markdown. The entire response is a UI spec.
|
||||
In standalone 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:
|
||||
|
||||
@@ -24,7 +25,7 @@ This is the default mode and is ideal for:
|
||||
```typescript
|
||||
import { streamText } from "ai";
|
||||
|
||||
// Generate mode is the default (no mode option needed)
|
||||
// Standalone mode is the default (no mode option needed)
|
||||
const systemPrompt = catalog.prompt({
|
||||
customRules: [
|
||||
"Use Card as root for forms and small UIs.",
|
||||
@@ -73,9 +74,9 @@ The AI outputs only JSONL — one patch per line, no surrounding text:
|
||||
{"op":"add","path":"/elements/submit","value":{"type":"Button","props":{"label":"Sign In"}}}
|
||||
```
|
||||
|
||||
## Chat Mode (Inline)
|
||||
## Inline Mode
|
||||
|
||||
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).
|
||||
In inline 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:
|
||||
|
||||
@@ -91,8 +92,8 @@ import { streamText } from "ai";
|
||||
import { pipeJsonRender } from "@json-render/core";
|
||||
import { createUIMessageStream, createUIMessageStreamResponse } from "ai";
|
||||
|
||||
// Enable chat mode
|
||||
const systemPrompt = catalog.prompt({ mode: "chat" });
|
||||
// Enable inline mode
|
||||
const systemPrompt = catalog.prompt({ mode: "inline" });
|
||||
|
||||
const result = streamText({
|
||||
model: yourModel,
|
||||
@@ -179,8 +180,8 @@ If the user asks a simple question ("what does BTC stand for?"), the AI replies
|
||||
<thead>
|
||||
<tr>
|
||||
<th />
|
||||
<th>Generate</th>
|
||||
<th>Chat</th>
|
||||
<th>Standalone</th>
|
||||
<th>Inline</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
@@ -197,7 +198,7 @@ If the user asks a simple question ("what does BTC stand for?"), the AI replies
|
||||
<tr>
|
||||
<td>System prompt</td>
|
||||
<td><code>{"catalog.prompt()"}</code></td>
|
||||
<td><code>{'catalog.prompt({ mode: "chat" })'}</code></td>
|
||||
<td><code>{'catalog.prompt({ mode: "inline" })'}</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Stream utility</td>
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
export const metadata = { title: "Installation" }
|
||||
import { pageMetadata } from "@/lib/page-metadata"
|
||||
export const metadata = pageMetadata("docs/installation")
|
||||
|
||||
# Installation
|
||||
|
||||
@@ -8,6 +9,26 @@ Install the core package plus your renderer of choice.
|
||||
|
||||
<PackageInstall packages="@json-render/core @json-render/react" />
|
||||
|
||||
Peer dependencies: `react ^19.0.0` and `zod ^4.0.0`.
|
||||
|
||||
<PackageInstall packages="react zod" />
|
||||
|
||||
## For Vue
|
||||
|
||||
<PackageInstall packages="@json-render/core @json-render/vue" />
|
||||
|
||||
Peer dependencies: `vue ^3.5.0` and `zod ^4.0.0`.
|
||||
|
||||
<PackageInstall packages="vue zod" />
|
||||
|
||||
## For Svelte
|
||||
|
||||
<PackageInstall packages="@json-render/core @json-render/svelte" />
|
||||
|
||||
Peer dependencies: `svelte ^5.0.0` and `zod ^4.0.0`.
|
||||
|
||||
<PackageInstall packages="svelte zod" />
|
||||
|
||||
## For React UI with shadcn/ui
|
||||
|
||||
Pre-built components for fast prototyping and production use:
|
||||
@@ -24,14 +45,23 @@ Requires Tailwind CSS in your project. See the [@json-render/shadcn API referenc
|
||||
|
||||
<PackageInstall packages="@json-render/core @json-render/remotion remotion @remotion/player" />
|
||||
|
||||
## Peer Dependencies
|
||||
## For React Email
|
||||
|
||||
json-render requires the following peer dependencies:
|
||||
<PackageInstall packages="@json-render/core @json-render/react-email @react-email/components @react-email/render" />
|
||||
|
||||
- `react` ^19.0.0
|
||||
- `zod` ^4.0.0
|
||||
## For External State Management (Optional)
|
||||
|
||||
<PackageInstall packages="react zod" />
|
||||
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" />
|
||||
|
||||
<PackageInstall packages="@json-render/xstate" />
|
||||
|
||||
See the [Data Binding](/docs/data-binding#external-store-controlled-mode) guide for usage.
|
||||
|
||||
## For AI Integration
|
||||
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
import { DocsMobileNav } from "@/components/docs-mobile-nav";
|
||||
import { DocsSidebar } from "@/components/docs-sidebar";
|
||||
import { CopyPageButton } from "@/components/copy-page-button";
|
||||
import { TableOfContents } from "@/components/table-of-contents";
|
||||
|
||||
export default function DocsLayout({
|
||||
children,
|
||||
@@ -10,7 +11,7 @@ export default function DocsLayout({
|
||||
return (
|
||||
<>
|
||||
<DocsMobileNav />
|
||||
<div className="max-w-5xl mx-auto px-6 py-8 lg:py-12 flex gap-16">
|
||||
<div className="max-w-7xl mx-auto px-6 py-8 lg:py-12 flex gap-12">
|
||||
{/* Sidebar */}
|
||||
<aside className="w-48 shrink-0 hidden lg:block sticky top-28 h-[calc(100vh-7rem)] overflow-y-auto">
|
||||
<DocsSidebar />
|
||||
@@ -23,6 +24,11 @@ export default function DocsLayout({
|
||||
</div>
|
||||
<article>{children}</article>
|
||||
</div>
|
||||
|
||||
{/* On this page */}
|
||||
<aside className="w-44 shrink-0 hidden xl:block sticky top-28 h-[calc(100vh-7rem)] overflow-y-auto">
|
||||
<TableOfContents />
|
||||
</aside>
|
||||
</div>
|
||||
</>
|
||||
);
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
export const metadata = { title: "Migration Guide" }
|
||||
import { pageMetadata } from "@/lib/page-metadata"
|
||||
export const metadata = pageMetadata("docs/migration")
|
||||
|
||||
# Migration Guide
|
||||
|
||||
@@ -30,15 +31,23 @@ import { StateProvider } from "@json-render/react";
|
||||
|
||||
`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 |
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Before</th>
|
||||
<th>After</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td><code>DataProvider</code></td><td><code>StateProvider</code></td></tr>
|
||||
<tr><td><code>data</code> prop</td><td><code>initialState</code> prop</td></tr>
|
||||
<tr><td><code>getValue</code> / <code>setValue</code> props</td><td>Removed (use <code>useStateStore()</code> hook for <code>get</code> / <code>set</code>)</td></tr>
|
||||
<tr><td><code>useData</code></td><td><code>useStateStore</code></td></tr>
|
||||
<tr><td><code>useDataValue</code></td><td><code>useStateValue</code></td></tr>
|
||||
<tr><td><code>useDataBinding</code></td><td><code>useStateBinding</code> (deprecated, use <code>useBoundProp</code> instead)</td></tr>
|
||||
<tr><td><code>DataModel</code> type</td><td><code>StateModel</code> type</td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
## Dynamic Expressions
|
||||
|
||||
@@ -80,10 +89,18 @@ Inside repeat scopes, use `$item` and `$index`:
|
||||
}
|
||||
```
|
||||
|
||||
| Before | After |
|
||||
|--------|-------|
|
||||
| `{ "$path": "/..." }` | `{ "$state": "/..." }` |
|
||||
| `{ "$data": "/..." }` | `{ "$state": "/..." }` |
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Before</th>
|
||||
<th>After</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td><code>{'{ "$path": "/..." }'}</code></td><td><code>{'{ "$state": "/..." }'}</code></td></tr>
|
||||
<tr><td><code>{'{ "$data": "/..." }'}</code></td><td><code>{'{ "$state": "/..." }'}</code></td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
## Two-Way Binding
|
||||
|
||||
@@ -292,10 +309,35 @@ const catalog = defineCatalog(schema, {
|
||||
|
||||
const prompt = catalog.prompt();
|
||||
|
||||
// Chat mode prompt
|
||||
// Inline mode prompt (formerly "chat")
|
||||
const inlinePrompt = catalog.prompt({ mode: "inline" });
|
||||
```
|
||||
|
||||
## Generation Modes
|
||||
|
||||
The generation mode values passed to `catalog.prompt()` have been renamed for clarity:
|
||||
|
||||
- `"generate"` is now `"standalone"`
|
||||
- `"chat"` is now `"inline"`
|
||||
|
||||
The old names are accepted as deprecated aliases, so existing code will continue to work. Update when convenient.
|
||||
|
||||
**Before:**
|
||||
|
||||
```typescript
|
||||
const prompt = catalog.prompt({ mode: "generate" });
|
||||
const chatPrompt = catalog.prompt({ mode: "chat" });
|
||||
```
|
||||
|
||||
**After:**
|
||||
|
||||
```typescript
|
||||
const prompt = catalog.prompt({ mode: "standalone" });
|
||||
const inlinePrompt = catalog.prompt({ mode: "inline" });
|
||||
```
|
||||
|
||||
The default mode (when no `mode` option is provided) is `"standalone"`, which behaves identically to the previous `"generate"` default.
|
||||
|
||||
## 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.
|
||||
@@ -314,11 +356,19 @@ const chatPrompt = catalog.prompt({ mode: "chat" });
|
||||
{ "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? }` |
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Before</th>
|
||||
<th>After</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr><td><code>{'{ fn: "required" }'}</code></td><td><code>{'{ type: "required" }'}</code></td></tr>
|
||||
<tr><td><code>{'ValidationProvider functions={...}'}</code></td><td><code>{'ValidationProvider customFunctions={...}'}</code></td></tr>
|
||||
<tr><td><code>useFieldValidation(path, checks)</code></td><td><code>useFieldValidation(path, config)</code> where config is <code>{'{ checks, validateOn? }'}</code></td></tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
## Visibility Provider
|
||||
|
||||
@@ -397,16 +447,57 @@ Action params in specs now use `statePath` instead of `path`.
|
||||
|
||||
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` |
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Removed</th>
|
||||
<th>Replacement</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>createCatalog</code></td>
|
||||
<td><code>defineCatalog(schema, config)</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>generateCatalogPrompt</code></td>
|
||||
<td><code>catalog.prompt()</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>generateSystemPrompt</code></td>
|
||||
<td><code>catalog.prompt()</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>ComponentDefinition</code></td>
|
||||
<td>Use catalog component config directly</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>CatalogConfig</code></td>
|
||||
<td>Use <code>defineCatalog</code> parameters</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>SystemPromptOptions</code></td>
|
||||
<td>Use <code>PromptOptions</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>LogicExpression</code></td>
|
||||
<td>Use <code>VisibilityCondition</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>AuthState</code></td>
|
||||
<td>Model auth as regular state (e.g. <code>/auth/isSignedIn</code>)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>evaluateLogicExpression</code></td>
|
||||
<td>Use <code>evaluateVisibility</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>createRendererFromCatalog</code></td>
|
||||
<td>Use <code>defineRegistry</code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>traverseTree</code> (codegen)</td>
|
||||
<td>Use <code>traverseSpec</code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
export const metadata = { title: "OpenAPI Integration" }
|
||||
import { pageMetadata } from "@/lib/page-metadata"
|
||||
export const metadata = pageMetadata("docs/openapi")
|
||||
|
||||
# OpenAPI Integration
|
||||
|
||||
@@ -99,7 +100,7 @@ Create components that map to OpenAPI data types:
|
||||
|
||||
```typescript
|
||||
import { defineCatalog } from '@json-render/core';
|
||||
import { schema } from '@json-render/react';
|
||||
import { schema } from '@json-render/react/schema';
|
||||
import { z } from 'zod';
|
||||
|
||||
export const openapiCatalog = defineCatalog(schema, {
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
export const metadata = { title: "Introduction" }
|
||||
import { pageMetadata } from "@/lib/page-metadata"
|
||||
export const metadata = pageMetadata("docs")
|
||||
|
||||
# Introduction
|
||||
|
||||
@@ -22,7 +23,7 @@ A catalog declares what AI can use: components with typed props, actions with ty
|
||||
|
||||
```typescript
|
||||
import { defineCatalog } from '@json-render/core';
|
||||
import { schema } from '@json-render/react';
|
||||
import { schema } from '@json-render/react/schema';
|
||||
import { z } from 'zod';
|
||||
|
||||
export const catalog = defineCatalog(schema, {
|
||||
@@ -90,7 +91,7 @@ The result is a native UI built from your own components — not an iframe, not
|
||||
- **[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.
|
||||
- **[Generation Modes](/docs/generation-modes)** — Standalone mode for full-page generated UI or inline mode for UI embedded in a conversation.
|
||||
|
||||
## Next
|
||||
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
export const metadata = { title: "Quick Start" }
|
||||
import { pageMetadata } from "@/lib/page-metadata"
|
||||
export const metadata = pageMetadata("docs/quick-start")
|
||||
|
||||
# Quick Start
|
||||
|
||||
@@ -11,7 +12,7 @@ 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';
|
||||
import { schema } from '@json-render/react/schema';
|
||||
import { z } from 'zod';
|
||||
|
||||
export const catalog = defineCatalog(schema, {
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
export const metadata = { title: "Registry" }
|
||||
import { pageMetadata } from "@/lib/page-metadata"
|
||||
export const metadata = pageMetadata("docs/registry")
|
||||
|
||||
# Registry
|
||||
|
||||
@@ -8,6 +9,7 @@ What a registry contains depends on the schema you use. Each package defines its
|
||||
|
||||
- **`@json-render/react`** — Components (React elements) and action handlers
|
||||
- **`@json-render/react-native`** — Components (React Native elements) and action handlers
|
||||
- **`@json-render/react-email`** — Email components (React Email / HTML)
|
||||
- **`@json-render/remotion`** — Clip components, transitions, and effects
|
||||
|
||||
## @json-render/react
|
||||
@@ -132,7 +134,7 @@ Actions are declared in your [catalog](/docs/catalog). The `@json-render/react`
|
||||
|
||||
```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, {
|
||||
@@ -277,6 +279,31 @@ export const { registry } = defineRegistry(catalog, {
|
||||
|
||||
See the [@json-render/react-native API reference](/docs/api/react-native) for the full API.
|
||||
|
||||
## @json-render/react-email
|
||||
|
||||
`@json-render/react-email` uses `defineRegistry` like React and React Native. Components render to React Email primitives (`@react-email/components`). Use `renderToHtml` or `renderToPlainText` for server-side email output:
|
||||
|
||||
```tsx
|
||||
import { defineRegistry } from '@json-render/react-email';
|
||||
import { renderToHtml } from '@json-render/react-email';
|
||||
import { Body, Container, Heading, Text } from '@react-email/components';
|
||||
|
||||
export const { registry } = defineRegistry(catalog, {
|
||||
components: {
|
||||
Card: ({ props, children }) => (
|
||||
<Container style={{ padding: 16, backgroundColor: '#fff' }}>
|
||||
<Heading>{props.title}</Heading>
|
||||
{children}
|
||||
</Container>
|
||||
),
|
||||
},
|
||||
});
|
||||
|
||||
const html = await renderToHtml(spec, { registry });
|
||||
```
|
||||
|
||||
See the [@json-render/react-email API reference](/docs/api/react-email) 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:
|
||||
|
||||
@@ -0,0 +1,299 @@
|
||||
import { pageMetadata } from "@/lib/page-metadata";
|
||||
export const metadata = pageMetadata("docs/renderers");
|
||||
|
||||
# Renderers
|
||||
|
||||
json-render supports multiple output targets. Each renderer takes the same core concept -- a JSON spec constrained to a catalog -- and renders it natively on a different platform or into a different format.
|
||||
|
||||
All renderers share the same workflow:
|
||||
|
||||
1. Define a catalog with `defineCatalog`
|
||||
2. AI generates a JSON spec
|
||||
3. The renderer turns the spec into platform-native output
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Renderer</th>
|
||||
<th>Package</th>
|
||||
<th>Output</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>React</td>
|
||||
<td>
|
||||
<code>@json-render/react</code>
|
||||
</td>
|
||||
<td>React component tree</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Vue</td>
|
||||
<td>
|
||||
<code>@json-render/vue</code>
|
||||
</td>
|
||||
<td>Vue 3 component tree</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Svelte</td>
|
||||
<td>
|
||||
<code>@json-render/svelte</code>
|
||||
</td>
|
||||
<td>Svelte 5 component tree</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Solid</td>
|
||||
<td>
|
||||
<code>@json-render/solid</code>
|
||||
</td>
|
||||
<td>SolidJS component tree</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>shadcn/ui</td>
|
||||
<td>
|
||||
<code>@json-render/shadcn</code>
|
||||
</td>
|
||||
<td>Pre-built Radix UI + Tailwind components (uses React renderer)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>React Native</td>
|
||||
<td>
|
||||
<code>@json-render/react-native</code>
|
||||
</td>
|
||||
<td>Native mobile views</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Image</td>
|
||||
<td>
|
||||
<code>@json-render/image</code>
|
||||
</td>
|
||||
<td>SVG / PNG (via Satori)</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>React PDF</td>
|
||||
<td>
|
||||
<code>@json-render/react-pdf</code>
|
||||
</td>
|
||||
<td>PDF documents</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Remotion</td>
|
||||
<td>
|
||||
<code>@json-render/remotion</code>
|
||||
</td>
|
||||
<td>Video compositions</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Ink</td>
|
||||
<td>
|
||||
<code>@json-render/ink</code>
|
||||
</td>
|
||||
<td>Terminal UI (via Ink)</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
## React
|
||||
|
||||
Render specs as React component trees in the browser. Supports data binding, streaming, actions, validation, visibility, and computed values.
|
||||
|
||||
```tsx
|
||||
import { defineRegistry, Renderer } from "@json-render/react";
|
||||
import { schema } from "@json-render/react/schema";
|
||||
|
||||
const { registry } = defineRegistry(catalog, { components });
|
||||
<Renderer spec={spec} registry={registry} />;
|
||||
```
|
||||
|
||||
Use `StateProvider`, `VisibilityProvider`, and `ActionProvider` for full interactivity. See the [@json-render/react API reference](/docs/api/react) for details.
|
||||
|
||||
## Vue
|
||||
|
||||
Vue 3 renderer with full feature parity with React: data binding, visibility, actions, validation, repeat scopes, and streaming.
|
||||
|
||||
```typescript
|
||||
import { defineRegistry, Renderer } from "@json-render/vue";
|
||||
import { schema } from "@json-render/vue/schema";
|
||||
|
||||
const { registry } = defineRegistry(catalog, {
|
||||
components: {
|
||||
Card: ({ props, children }) =>
|
||||
h("div", { class: "card" }, [h("h3", null, props.title), children]),
|
||||
},
|
||||
});
|
||||
```
|
||||
|
||||
Uses composables (`useStateStore`, `useStateBinding`, `useActions`, etc.) instead of React hooks. See the [@json-render/vue API reference](/docs/api/vue) for details.
|
||||
|
||||
## Svelte
|
||||
|
||||
Svelte 5 renderer with runes-compatible context helpers, visibility conditions, actions, and streaming support.
|
||||
|
||||
```typescript
|
||||
import { defineRegistry, Renderer } from "@json-render/svelte";
|
||||
import { schema } from "@json-render/svelte/schema";
|
||||
|
||||
const { registry } = defineRegistry(catalog, {
|
||||
components: {
|
||||
Card: ({ props, children }) => /* Svelte snippet */,
|
||||
},
|
||||
});
|
||||
```
|
||||
|
||||
See the [@json-render/svelte API reference](/docs/api/svelte) for details.
|
||||
|
||||
## Solid
|
||||
|
||||
SolidJS renderer with fine-grained reactivity, state bindings, validation, visibility, and event-driven actions.
|
||||
|
||||
```tsx
|
||||
import { defineRegistry, Renderer } from "@json-render/solid";
|
||||
import { schema } from "@json-render/solid/schema";
|
||||
|
||||
const { registry } = defineRegistry(catalog, {
|
||||
components: {
|
||||
Card: (renderProps) => <div>{renderProps.children}</div>,
|
||||
},
|
||||
});
|
||||
|
||||
<Renderer spec={spec} registry={registry} />;
|
||||
```
|
||||
|
||||
See the [@json-render/solid API reference](/docs/api/solid) for details.
|
||||
|
||||
## shadcn/ui
|
||||
|
||||
36 pre-built components using Radix UI and Tailwind CSS. Built on top of `@json-render/react` -- no custom renderer needed.
|
||||
|
||||
```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";
|
||||
|
||||
const catalog = defineCatalog(schema, {
|
||||
components: {
|
||||
Card: shadcnComponentDefinitions.Card,
|
||||
Button: shadcnComponentDefinitions.Button,
|
||||
},
|
||||
});
|
||||
|
||||
const { registry } = defineRegistry(catalog, {
|
||||
components: {
|
||||
Card: shadcnComponents.Card,
|
||||
Button: shadcnComponents.Button,
|
||||
},
|
||||
});
|
||||
```
|
||||
|
||||
See the [@json-render/shadcn API reference](/docs/api/shadcn) for the full component list.
|
||||
|
||||
## React Native
|
||||
|
||||
Render specs as native mobile views. Includes 25+ standard components and standard action definitions.
|
||||
|
||||
```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} />;
|
||||
```
|
||||
|
||||
See the [@json-render/react-native API reference](/docs/api/react-native) for details.
|
||||
|
||||
## Image
|
||||
|
||||
Generate SVG and PNG images from JSON specs using Satori. Ideal for OG images, social cards, and banners.
|
||||
|
||||
```typescript
|
||||
import { renderToSvg, renderToPng } from "@json-render/image/render";
|
||||
|
||||
const svg = await renderToSvg(spec, { fonts });
|
||||
const png = await renderToPng(spec, { fonts });
|
||||
```
|
||||
|
||||
Nine standard components: Frame, Box, Row, Column, Heading, Text, Image, Divider, Spacer. PNG output requires `@resvg/resvg-js` as an optional peer dependency.
|
||||
|
||||
See the [@json-render/image API reference](/docs/api/image) for details.
|
||||
|
||||
## React PDF
|
||||
|
||||
Generate PDF documents from JSON specs using `@react-pdf/renderer`. Render to buffer, stream, or file.
|
||||
|
||||
```typescript
|
||||
import {
|
||||
renderToBuffer,
|
||||
renderToStream,
|
||||
renderToFile,
|
||||
} from "@json-render/react-pdf";
|
||||
|
||||
const buffer = await renderToBuffer(spec);
|
||||
const stream = await renderToStream(spec);
|
||||
await renderToFile(spec, "./output.pdf");
|
||||
```
|
||||
|
||||
Standard components include Document, Page, View, Row, Column, Heading, Text, Image, Table, List, Divider, Spacer, Link, and PageNumber.
|
||||
|
||||
See the [@json-render/react-pdf API reference](/docs/api/react-pdf) for details.
|
||||
|
||||
## Remotion
|
||||
|
||||
Turn JSON timeline specs into video compositions with Remotion.
|
||||
|
||||
```tsx
|
||||
import { Player } from "@remotion/player";
|
||||
import { Renderer } from "@json-render/remotion";
|
||||
|
||||
<Player
|
||||
component={Renderer}
|
||||
inputProps={{ spec }}
|
||||
durationInFrames={spec.composition.durationInFrames}
|
||||
fps={spec.composition.fps}
|
||||
compositionWidth={spec.composition.width}
|
||||
compositionHeight={spec.composition.height}
|
||||
/>;
|
||||
```
|
||||
|
||||
Uses a timeline spec format with compositions, tracks, and clips. Includes standard components (TitleCard, TypingText, ImageSlide, etc.), transitions (fade, slide, zoom, wipe), and effects.
|
||||
|
||||
See the [@json-render/remotion API reference](/docs/api/remotion) for details.
|
||||
|
||||
## Ink (Terminal)
|
||||
|
||||
Render specs as terminal UIs using [Ink](https://github.com/vadimdemedes/ink). Multiple standard components including tables, progress bars, spinners, tabs, multi-select, and interactive inputs with Tab-cycling focus.
|
||||
|
||||
```tsx
|
||||
import { defineCatalog } from "@json-render/core";
|
||||
import { schema } from "@json-render/ink/schema";
|
||||
import {
|
||||
standardComponentDefinitions,
|
||||
standardActionDefinitions,
|
||||
} from "@json-render/ink/catalog";
|
||||
import { defineRegistry, Renderer } from "@json-render/ink";
|
||||
|
||||
const catalog = defineCatalog(schema, {
|
||||
components: { ...standardComponentDefinitions },
|
||||
actions: standardActionDefinitions,
|
||||
});
|
||||
|
||||
const { registry } = defineRegistry(catalog, { components: {} });
|
||||
<Renderer spec={spec} registry={registry} />;
|
||||
```
|
||||
|
||||
See the [@json-render/ink API reference](/docs/api/ink) for details.
|
||||
|
||||
## Custom Renderers
|
||||
|
||||
You can build your own renderer for any output target. See the [Custom Schema & Renderer](/docs/custom-schema) guide for how to define a custom schema and wire it to your own rendering logic.
|
||||
@@ -1,4 +1,5 @@
|
||||
export const metadata = { title: "Schemas" }
|
||||
import { pageMetadata } from "@/lib/page-metadata"
|
||||
export const metadata = pageMetadata("docs/schemas")
|
||||
|
||||
# Schemas
|
||||
|
||||
|
||||
@@ -0,0 +1,123 @@
|
||||
import { pageMetadata } from "@/lib/page-metadata";
|
||||
|
||||
export const metadata = pageMetadata("docs/skills");
|
||||
|
||||
# Skills
|
||||
|
||||
json-render ships with skills that teach AI coding agents how to use each package. Install a skill and your agent in Cursor, Claude Code, or Codex can generate json-render UIs without manual guidance.
|
||||
|
||||
## Available Skills
|
||||
|
||||
- **core** — Core schemas, catalogs, and AI prompt generation.
|
||||
- **react** — React renderer that turns JSON specs into React component trees.
|
||||
- **react-pdf** — PDF renderer using `@react-pdf/renderer`.
|
||||
- **react-email** — Email renderer that produces HTML or plain-text emails.
|
||||
- **react-native** — React Native renderer for native mobile UIs.
|
||||
- **shadcn** — Pre-built shadcn/ui components (Radix UI + Tailwind).
|
||||
- **image** — Image renderer that turns JSON specs into SVG and PNG via Satori.
|
||||
- **remotion** — Remotion renderer for video generation from JSON timeline specs.
|
||||
- **vue** — Vue 3 renderer for Vue component trees.
|
||||
- **svelte** — Svelte 5 renderer for Svelte component trees.
|
||||
- **solid** — SolidJS renderer for fine-grained reactive component trees.
|
||||
- **codegen** — Code generation utilities for building custom exporters.
|
||||
- **mcp** — MCP Apps integration for Claude, ChatGPT, Cursor, and VS Code.
|
||||
- **redux** — Redux adapter for json-render's `StateStore` interface.
|
||||
- **zustand** — Zustand adapter for json-render's `StateStore` interface.
|
||||
- **jotai** — Jotai adapter for json-render's `StateStore` interface.
|
||||
- **xstate** — XState Store adapter for json-render's `StateStore` interface.
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
npx skills add vercel-labs/json-render --skill core
|
||||
npx skills add vercel-labs/json-render --skill react
|
||||
npx skills add vercel-labs/json-render --skill react-pdf
|
||||
npx skills add vercel-labs/json-render --skill react-email
|
||||
npx skills add vercel-labs/json-render --skill react-native
|
||||
npx skills add vercel-labs/json-render --skill shadcn
|
||||
npx skills add vercel-labs/json-render --skill image
|
||||
npx skills add vercel-labs/json-render --skill remotion
|
||||
npx skills add vercel-labs/json-render --skill vue
|
||||
npx skills add vercel-labs/json-render --skill svelte
|
||||
npx skills add vercel-labs/json-render --skill solid
|
||||
npx skills add vercel-labs/json-render --skill codegen
|
||||
npx skills add vercel-labs/json-render --skill mcp
|
||||
npx skills add vercel-labs/json-render --skill redux
|
||||
npx skills add vercel-labs/json-render --skill zustand
|
||||
npx skills add vercel-labs/json-render --skill jotai
|
||||
npx skills add vercel-labs/json-render --skill xstate
|
||||
```
|
||||
|
||||
After installing, your AI agent will automatically activate the right skill when it encounters a matching request.
|
||||
|
||||
## core
|
||||
|
||||
The foundational skill. Teaches agents how to define catalogs, create schemas, build specs, and generate AI prompts. This is the starting point for any json-render project and covers `defineCatalog`, `defineSchema`, `specSchema`, `toPrompt`, and the full spec format.
|
||||
|
||||
## react
|
||||
|
||||
Teaches agents how to render JSON specs as React component trees using `JsonRender`, `JsonRenderClient`, and `useJsonRender`. Covers custom component registries, client-side interactivity, state management, and streaming integration.
|
||||
|
||||
## react-pdf
|
||||
|
||||
Teaches agents how to generate PDFs from JSON specs using `@react-pdf/renderer`. Covers the PDF-specific component registry, page layout, and styling.
|
||||
|
||||
## react-email
|
||||
|
||||
Teaches agents how to render JSON specs as HTML or plain-text emails using React Email components. Covers the email-specific registry and rendering pipeline.
|
||||
|
||||
## react-native
|
||||
|
||||
Teaches agents how to render JSON specs as native mobile UIs with React Native. Covers the native component registry and platform-specific considerations.
|
||||
|
||||
## shadcn
|
||||
|
||||
Teaches agents how to use the pre-built shadcn/ui component registry with json-render. Includes Radix UI primitives, Tailwind styling, and the full set of available shadcn components.
|
||||
|
||||
## image
|
||||
|
||||
Teaches agents how to turn JSON specs into SVG and PNG images using Satori. Covers the image-specific registry, dimensions, fonts, and rendering options.
|
||||
|
||||
## remotion
|
||||
|
||||
Teaches agents how to generate videos from JSON timeline specs using Remotion. Covers compositions, sequences, timeline structure, and video rendering.
|
||||
|
||||
## vue
|
||||
|
||||
Teaches agents how to render JSON specs as Vue 3 component trees. Covers the Vue renderer API, custom component registries, and reactivity integration.
|
||||
|
||||
## svelte
|
||||
|
||||
Teaches agents how to render JSON specs as Svelte 5 component trees. Covers the Svelte renderer API and component registration.
|
||||
|
||||
## solid
|
||||
|
||||
Teaches agents how to render JSON specs as SolidJS component trees. Covers Solid-specific reactive patterns, provider wiring, bindings, actions, and streaming.
|
||||
|
||||
## codegen
|
||||
|
||||
Teaches agents how to use code generation utilities to export UI specs as framework-specific source code. Covers the codegen pipeline and custom exporter creation.
|
||||
|
||||
## mcp
|
||||
|
||||
Teaches agents how to build MCP Apps that serve json-render UIs inside AI tools like Claude, ChatGPT, Cursor, and VS Code. Covers MCP server setup, tool definitions, and UI streaming.
|
||||
|
||||
## redux
|
||||
|
||||
Teaches agents how to connect a Redux store to json-render's `StateStore` interface for state-driven UIs.
|
||||
|
||||
## zustand
|
||||
|
||||
Teaches agents how to connect a Zustand store to json-render's `StateStore` interface for lightweight state management.
|
||||
|
||||
## jotai
|
||||
|
||||
Teaches agents how to connect Jotai atoms to json-render's `StateStore` interface for atomic state management.
|
||||
|
||||
## xstate
|
||||
|
||||
Teaches agents how to connect an XState Store to json-render's `StateStore` interface for state-machine-driven UIs.
|
||||
|
||||
## Source
|
||||
|
||||
All skill files are in the [`skills/`](https://github.com/vercel-labs/json-render/tree/main/skills) directory of the repository.
|
||||
@@ -1,4 +1,5 @@
|
||||
export const metadata = { title: "Specs" }
|
||||
import { pageMetadata } from "@/lib/page-metadata"
|
||||
export const metadata = pageMetadata("docs/specs")
|
||||
|
||||
# Specs
|
||||
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
export const metadata = { title: "Streaming" }
|
||||
import { pageMetadata } from "@/lib/page-metadata"
|
||||
export const metadata = pageMetadata("docs/streaming")
|
||||
|
||||
# Streaming
|
||||
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
export const metadata = { title: "Validation" }
|
||||
import { pageMetadata } from "@/lib/page-metadata"
|
||||
export const metadata = pageMetadata("docs/validation")
|
||||
|
||||
# Validation
|
||||
|
||||
@@ -10,11 +11,18 @@ json-render includes common validation functions:
|
||||
|
||||
- `required` — Value must be non-empty
|
||||
- `email` — Valid email format
|
||||
- `minLength` — Minimum string length
|
||||
- `maxLength` — Maximum string length
|
||||
- `pattern` — Match a regex pattern
|
||||
- `min` — Minimum numeric value
|
||||
- `max` — Maximum numeric value
|
||||
- `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
|
||||
|
||||
@@ -66,7 +74,7 @@ Define custom validators in your catalog's `functions` field. The catalog itself
|
||||
|
||||
```typescript
|
||||
import { defineCatalog } from '@json-render/core';
|
||||
import { schema } from '@json-render/react'; // or '@json-render/react-native'
|
||||
import { schema } from '@json-render/react/schema'; // or '@json-render/react-native/schema'
|
||||
import { z } from 'zod';
|
||||
|
||||
const catalog = defineCatalog(schema, {
|
||||
@@ -142,14 +150,114 @@ function TextField({ props, bindings }) {
|
||||
|
||||
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
|
||||
- `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
|
||||
|
||||
Learn about [generation modes](/docs/generation-modes).
|
||||
- [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,4 +1,5 @@
|
||||
export const metadata = { title: "Visibility" }
|
||||
import { pageMetadata } from "@/lib/page-metadata"
|
||||
export const metadata = pageMetadata("docs/visibility")
|
||||
|
||||
# Visibility
|
||||
|
||||
|
||||
@@ -0,0 +1,167 @@
|
||||
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`
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Mechanism</th>
|
||||
<th>Trigger</th>
|
||||
<th>Use Case</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>on</code></td>
|
||||
<td>User interaction (press, change, blur)</td>
|
||||
<td>Button clicks, input changes, form submissions</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>watch</code></td>
|
||||
<td>State value change (any source)</td>
|
||||
<td>Cascading data, derived state, cross-field sync</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
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
|
||||
@@ -0,0 +1,133 @@
|
||||
"use client";
|
||||
|
||||
import { useState } from "react";
|
||||
import { Badge } from "@/components/ui/badge";
|
||||
import { examples, allTags, getGitHubUrl, type Example } from "@/lib/examples";
|
||||
import { cn } from "@/lib/utils";
|
||||
|
||||
function ExampleCard({ example }: { example: Example }) {
|
||||
return (
|
||||
<div className="group flex flex-col rounded-xl border border-border bg-card text-card-foreground overflow-hidden transition-colors hover:border-foreground/25">
|
||||
<div className="flex flex-1 flex-col gap-3 p-5">
|
||||
<h3 className="font-semibold leading-none">{example.title}</h3>
|
||||
|
||||
<p className="text-sm text-muted-foreground leading-relaxed">
|
||||
{example.description}
|
||||
</p>
|
||||
|
||||
<div className="flex flex-wrap gap-1.5">
|
||||
{example.tags.map((tag) => (
|
||||
<Badge key={tag} variant="secondary" className="text-[11px]">
|
||||
{tag}
|
||||
</Badge>
|
||||
))}
|
||||
</div>
|
||||
|
||||
<div className="mt-auto flex items-center gap-3 pt-2">
|
||||
{example.demoUrl && (
|
||||
<a
|
||||
href={example.demoUrl}
|
||||
target="_blank"
|
||||
rel="noopener noreferrer"
|
||||
className="inline-flex items-center gap-1.5 text-sm text-foreground hover:text-primary transition-colors"
|
||||
>
|
||||
<svg
|
||||
xmlns="http://www.w3.org/2000/svg"
|
||||
width="14"
|
||||
height="14"
|
||||
viewBox="0 0 24 24"
|
||||
fill="none"
|
||||
stroke="currentColor"
|
||||
strokeWidth="2"
|
||||
strokeLinecap="round"
|
||||
strokeLinejoin="round"
|
||||
>
|
||||
<path d="M15 3h6v6" />
|
||||
<path d="M10 14 21 3" />
|
||||
<path d="M18 13v6a2 2 0 0 1-2 2H5a2 2 0 0 1-2-2V8a2 2 0 0 1 2-2h6" />
|
||||
</svg>
|
||||
Live Demo
|
||||
</a>
|
||||
)}
|
||||
<a
|
||||
href={getGitHubUrl(example)}
|
||||
target="_blank"
|
||||
rel="noopener noreferrer"
|
||||
className="inline-flex items-center gap-1.5 text-sm text-muted-foreground hover:text-foreground transition-colors"
|
||||
>
|
||||
<svg
|
||||
viewBox="0 0 16 16"
|
||||
className="h-3.5 w-3.5"
|
||||
fill="currentColor"
|
||||
aria-hidden="true"
|
||||
>
|
||||
<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>
|
||||
Source
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
);
|
||||
}
|
||||
|
||||
export default function ExamplesPage() {
|
||||
const [activeTag, setActiveTag] = useState<string | null>(null);
|
||||
|
||||
const filtered = activeTag
|
||||
? examples.filter((e) => e.tags.includes(activeTag))
|
||||
: examples;
|
||||
|
||||
return (
|
||||
<section className="mx-auto max-w-6xl px-6 py-16">
|
||||
<div className="mb-10">
|
||||
<h1 className="text-3xl font-bold tracking-tight sm:text-4xl">
|
||||
Examples
|
||||
</h1>
|
||||
<p className="mt-3 text-lg text-muted-foreground">
|
||||
Explore json-render across frameworks, renderers, and use cases.
|
||||
</p>
|
||||
</div>
|
||||
|
||||
<div className="mb-8 flex flex-wrap gap-2">
|
||||
<button
|
||||
onClick={() => setActiveTag(null)}
|
||||
className={cn(
|
||||
"rounded-full border px-3 py-1 text-xs font-medium transition-colors",
|
||||
activeTag === null
|
||||
? "border-foreground bg-foreground text-background"
|
||||
: "border-border text-muted-foreground hover:text-foreground hover:border-foreground/50",
|
||||
)}
|
||||
>
|
||||
All
|
||||
</button>
|
||||
{allTags.map((tag) => (
|
||||
<button
|
||||
key={tag}
|
||||
onClick={() => setActiveTag(activeTag === tag ? null : tag)}
|
||||
className={cn(
|
||||
"rounded-full border px-3 py-1 text-xs font-medium transition-colors",
|
||||
activeTag === tag
|
||||
? "border-foreground bg-foreground text-background"
|
||||
: "border-border text-muted-foreground hover:text-foreground hover:border-foreground/50",
|
||||
)}
|
||||
>
|
||||
{tag}
|
||||
</button>
|
||||
))}
|
||||
</div>
|
||||
|
||||
<div className="grid gap-6 sm:grid-cols-2 lg:grid-cols-3">
|
||||
{filtered.map((example) => (
|
||||
<ExampleCard key={example.slug} example={example} />
|
||||
))}
|
||||
</div>
|
||||
|
||||
{filtered.length === 0 && (
|
||||
<p className="py-12 text-center text-muted-foreground">
|
||||
No examples match the selected filter.
|
||||
</p>
|
||||
)}
|
||||
</section>
|
||||
);
|
||||
}
|
||||
@@ -16,7 +16,8 @@ const SYSTEM_PROMPT = `You are a helpful documentation assistant for json-render
|
||||
|
||||
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
|
||||
npm packages: @json-render/core, @json-render/react, @json-render/next, @json-render/ink, @json-render/vue, @json-render/svelte, @json-render/solid, @json-render/shadcn, @json-render/shadcn-svelte, @json-render/react-three-fiber, @json-render/react-native, @json-render/react-email, @json-render/react-pdf, @json-render/image, @json-render/remotion, @json-render/codegen, @json-render/mcp, @json-render/redux, @json-render/zustand, @json-render/jotai, @json-render/xstate, @json-render/yaml
|
||||
Skills: json-render ships AI agent skills that teach coding agents how to use each package. Install with "npx skills add vercel-labs/json-render --skill <name>". Available skills: core, react, next, ink, react-pdf, react-email, react-native, shadcn, shadcn-svelte, react-three-fiber, image, remotion, vue, svelte, solid, codegen, mcp, redux, zustand, jotai, xstate, yaml. See /docs/skills for details.
|
||||
|
||||
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.
|
||||
|
||||
|
||||
@@ -1,32 +1,73 @@
|
||||
import { streamText } from "ai";
|
||||
import { headers } from "next/headers";
|
||||
import { buildUserPrompt } from "@json-render/core";
|
||||
import type { Spec, EditMode } from "@json-render/core";
|
||||
import {
|
||||
buildUserPrompt,
|
||||
buildEditUserPrompt,
|
||||
isNonEmptySpec,
|
||||
} from "@json-render/core";
|
||||
import { yamlPrompt } from "@json-render/yaml";
|
||||
import { stringify as yamlStringify } from "yaml";
|
||||
import { minuteRateLimit, dailyRateLimit } from "@/lib/rate-limit";
|
||||
import { playgroundCatalog } from "@/lib/render/catalog";
|
||||
|
||||
export const maxDuration = 30;
|
||||
|
||||
const SYSTEM_PROMPT = playgroundCatalog.prompt({
|
||||
customRules: [
|
||||
"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" }).',
|
||||
],
|
||||
});
|
||||
const PLAYGROUND_RULES = [
|
||||
"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" }).',
|
||||
];
|
||||
|
||||
const MAX_PROMPT_LENGTH = 500;
|
||||
const DEFAULT_MODEL = "anthropic/claude-haiku-4.5";
|
||||
|
||||
function getSystemPrompt(isYaml: boolean, editModes?: EditMode[]): string {
|
||||
if (isYaml) {
|
||||
return yamlPrompt(playgroundCatalog, {
|
||||
mode: "standalone",
|
||||
customRules: PLAYGROUND_RULES,
|
||||
editModes: editModes ?? ["merge"],
|
||||
});
|
||||
}
|
||||
return playgroundCatalog.prompt({
|
||||
customRules: PLAYGROUND_RULES,
|
||||
editModes,
|
||||
});
|
||||
}
|
||||
|
||||
function buildYamlUserPrompt(
|
||||
prompt: string,
|
||||
previousSpec?: Spec | null,
|
||||
editModes?: EditMode[],
|
||||
): string {
|
||||
if (isNonEmptySpec(previousSpec)) {
|
||||
return buildEditUserPrompt({
|
||||
prompt,
|
||||
currentSpec: previousSpec,
|
||||
config: { modes: editModes ?? ["merge"] },
|
||||
format: "yaml",
|
||||
maxPromptLength: MAX_PROMPT_LENGTH,
|
||||
serializer: (s) => yamlStringify(s, { indent: 2 }).trimEnd(),
|
||||
});
|
||||
}
|
||||
|
||||
const userText = prompt.slice(0, MAX_PROMPT_LENGTH);
|
||||
return [
|
||||
userText,
|
||||
"",
|
||||
"Output the full spec in a ```yaml-spec fence. Stream progressively — output elements one at a time.",
|
||||
].join("\n");
|
||||
}
|
||||
|
||||
export async function POST(req: Request) {
|
||||
// Get client IP for rate limiting
|
||||
const headersList = await headers();
|
||||
const ip = headersList.get("x-forwarded-for")?.split(",")[0] ?? "anonymous";
|
||||
|
||||
// Check rate limits (minute and daily)
|
||||
const [minuteResult, dailyResult] = await Promise.all([
|
||||
minuteRateLimit.limit(ip),
|
||||
dailyRateLimit.limit(ip),
|
||||
@@ -48,22 +89,34 @@ export async function POST(req: Request) {
|
||||
);
|
||||
}
|
||||
|
||||
const { prompt, context } = await req.json();
|
||||
const { prompt, context, format, editModes } = await req.json();
|
||||
const isYaml = format === "yaml";
|
||||
|
||||
const userPrompt = buildUserPrompt({
|
||||
prompt,
|
||||
currentSpec: context?.previousSpec,
|
||||
maxPromptLength: MAX_PROMPT_LENGTH,
|
||||
});
|
||||
const systemPrompt = getSystemPrompt(isYaml, editModes);
|
||||
const userPrompt = isYaml
|
||||
? buildYamlUserPrompt(prompt, context?.previousSpec, editModes)
|
||||
: buildUserPrompt({
|
||||
prompt,
|
||||
currentSpec: context?.previousSpec,
|
||||
maxPromptLength: MAX_PROMPT_LENGTH,
|
||||
editModes,
|
||||
});
|
||||
|
||||
const result = streamText({
|
||||
model: process.env.AI_GATEWAY_MODEL || DEFAULT_MODEL,
|
||||
system: SYSTEM_PROMPT,
|
||||
system: [
|
||||
{
|
||||
role: "system",
|
||||
content: systemPrompt,
|
||||
providerOptions: {
|
||||
anthropic: { cacheControl: { type: "ephemeral" } },
|
||||
},
|
||||
},
|
||||
],
|
||||
prompt: userPrompt,
|
||||
temperature: 0.7,
|
||||
});
|
||||
|
||||
// Stream the text, then append token usage metadata at the end
|
||||
const encoder = new TextEncoder();
|
||||
const textStream = result.textStream;
|
||||
|
||||
@@ -72,7 +125,6 @@ export async function POST(req: Request) {
|
||||
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({
|
||||
@@ -80,10 +132,12 @@ export async function POST(req: Request) {
|
||||
promptTokens: usage.inputTokens,
|
||||
completionTokens: usage.outputTokens,
|
||||
totalTokens: usage.totalTokens,
|
||||
cachedTokens: usage.inputTokenDetails?.cacheReadTokens ?? 0,
|
||||
cacheWriteTokens: usage.inputTokenDetails?.cacheWriteTokens ?? 0,
|
||||
});
|
||||
controller.enqueue(encoder.encode(`\n${meta}\n`));
|
||||
} catch {
|
||||
// Usage not available — skip silently
|
||||
// Usage not available
|
||||
}
|
||||
controller.close();
|
||||
},
|
||||
|
||||
@@ -0,0 +1,74 @@
|
||||
import { NextRequest, NextResponse } from "next/server";
|
||||
import { getSearchIndex } from "@/lib/search-index";
|
||||
|
||||
export async function GET(req: NextRequest) {
|
||||
const q = req.nextUrl.searchParams.get("q")?.trim().toLowerCase();
|
||||
|
||||
if (!q) {
|
||||
return NextResponse.json({ results: [] });
|
||||
}
|
||||
|
||||
const index = await getSearchIndex();
|
||||
const terms = q.split(/\s+/).filter(Boolean);
|
||||
|
||||
const results = index
|
||||
.map((entry) => {
|
||||
const titleLower = entry.title.toLowerCase();
|
||||
const contentLower = entry.content.toLowerCase();
|
||||
|
||||
const titleMatch = terms.every((t) => titleLower.includes(t));
|
||||
const contentMatch = terms.every((t) => contentLower.includes(t));
|
||||
|
||||
if (!titleMatch && !contentMatch) return null;
|
||||
|
||||
let snippet = "";
|
||||
if (contentMatch) {
|
||||
const firstTermIdx = Math.min(
|
||||
...terms.map((t) => {
|
||||
const idx = contentLower.indexOf(t);
|
||||
return idx === -1 ? Infinity : idx;
|
||||
}),
|
||||
);
|
||||
if (firstTermIdx !== Infinity) {
|
||||
const start = Math.max(0, firstTermIdx - 40);
|
||||
const end = Math.min(entry.content.length, firstTermIdx + 120);
|
||||
snippet =
|
||||
(start > 0 ? "..." : "") +
|
||||
entry.content.slice(start, end).replace(/\n/g, " ") +
|
||||
(end < entry.content.length ? "..." : "");
|
||||
}
|
||||
}
|
||||
|
||||
return {
|
||||
title: entry.title,
|
||||
href: entry.href,
|
||||
section: entry.section,
|
||||
snippet,
|
||||
score: titleMatch ? 2 : 1,
|
||||
};
|
||||
})
|
||||
.filter(
|
||||
(
|
||||
r,
|
||||
): r is {
|
||||
title: string;
|
||||
href: string;
|
||||
section: string;
|
||||
snippet: string;
|
||||
score: number;
|
||||
} => r !== null,
|
||||
)
|
||||
.sort((a, b) => b.score - a.score)
|
||||
.slice(0, 20)
|
||||
.map(({ title, href, section, snippet }) => ({
|
||||
title,
|
||||
href,
|
||||
section,
|
||||
snippet,
|
||||
}));
|
||||
|
||||
return NextResponse.json(
|
||||
{ results },
|
||||
{ headers: { "Cache-Control": "public, max-age=60" } },
|
||||
);
|
||||
}
|
||||
@@ -154,23 +154,34 @@ button {
|
||||
margin-bottom: 0.5em;
|
||||
}
|
||||
|
||||
/* MDX table styles — fallback for GFM-generated tables */
|
||||
/* MDX table styles — applies to both GFM pipe tables and raw HTML tables */
|
||||
.mdx-table th,
|
||||
.mdx-table td {
|
||||
.mdx-table td,
|
||||
article table th,
|
||||
article table td {
|
||||
border: 1px solid var(--border);
|
||||
padding: 0.75rem 1rem;
|
||||
text-align: left;
|
||||
}
|
||||
|
||||
.mdx-table th {
|
||||
.mdx-table th,
|
||||
article table th {
|
||||
font-weight: 600;
|
||||
background-color: var(--muted);
|
||||
}
|
||||
|
||||
.mdx-table td {
|
||||
.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 {
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
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";
|
||||
@@ -61,7 +62,6 @@ export const metadata: Metadata = {
|
||||
description:
|
||||
"The Generative UI framework. Generate dashboards, widgets, and apps from prompts — safely constrained to components you define.",
|
||||
images: ["/og"],
|
||||
creator: "@verabornnot",
|
||||
},
|
||||
robots: {
|
||||
index: true,
|
||||
@@ -92,7 +92,9 @@ export default async function RootLayout({
|
||||
/>
|
||||
)}
|
||||
</head>
|
||||
<body className={`${geistSans.variable} ${geistMono.variable}`}>
|
||||
<body
|
||||
className={`${geistSans.variable} ${geistMono.variable} ${GeistPixelSquare.variable}`}
|
||||
>
|
||||
<ThemeProvider>
|
||||
{children}
|
||||
<DocsChat defaultOpen={chatOpen} defaultWidth={chatWidth} />
|
||||
|
||||
@@ -5,19 +5,20 @@ import { join } from "node:path";
|
||||
export { getPageTitle } from "@/lib/page-titles";
|
||||
|
||||
// Cache font data in memory after first load
|
||||
let fontCache: { geistRegular: Buffer } | null = null;
|
||||
let fontCache: { geistRegular: Buffer; geistPixelSquare: Buffer } | null = null;
|
||||
|
||||
async function loadFonts() {
|
||||
if (fontCache) return fontCache;
|
||||
const geistRegular = await readFile(
|
||||
join(process.cwd(), "public/Geist-Regular.ttf"),
|
||||
);
|
||||
fontCache = { geistRegular };
|
||||
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 } = await loadFonts();
|
||||
const { geistRegular, geistPixelSquare } = await loadFonts();
|
||||
|
||||
return new ImageResponse(
|
||||
<div
|
||||
@@ -53,8 +54,8 @@ export async function renderOgImage(title: string) {
|
||||
<span
|
||||
style={{
|
||||
fontSize: 36,
|
||||
fontFamily: "Geist",
|
||||
fontWeight: 400,
|
||||
fontFamily: "Geist Pixel Square",
|
||||
fontWeight: 500,
|
||||
color: "white",
|
||||
}}
|
||||
>
|
||||
@@ -99,6 +100,12 @@ export async function renderOgImage(title: string) {
|
||||
style: "normal",
|
||||
weight: 400,
|
||||
},
|
||||
{
|
||||
name: "Geist Pixel Square",
|
||||
data: geistPixelSquare.buffer as ArrayBuffer,
|
||||
style: "normal",
|
||||
weight: 500,
|
||||
},
|
||||
],
|
||||
},
|
||||
);
|
||||
|
||||
@@ -1,10 +1,7 @@
|
||||
import { Playground } from "@/components/playground";
|
||||
import { pageMetadata } from "@/lib/page-metadata";
|
||||
|
||||
import { PAGE_TITLES } from "@/lib/page-titles";
|
||||
|
||||
export const metadata = {
|
||||
title: PAGE_TITLES["playground"],
|
||||
};
|
||||
export const metadata = pageMetadata("playground");
|
||||
|
||||
export default function PlaygroundPage() {
|
||||
return <Playground />;
|
||||
|
||||
@@ -145,7 +145,7 @@ function getHighlighter() {
|
||||
if (!highlighterPromise) {
|
||||
highlighterPromise = createHighlighter({
|
||||
themes: [vercelLightTheme, vercelDarkTheme],
|
||||
langs: ["json", "tsx", "typescript"],
|
||||
langs: ["json", "tsx", "typescript", "yaml"],
|
||||
});
|
||||
}
|
||||
return highlighterPromise;
|
||||
@@ -158,7 +158,7 @@ if (typeof window !== "undefined") {
|
||||
|
||||
interface CodeBlockProps {
|
||||
code: string;
|
||||
lang: "json" | "tsx" | "typescript";
|
||||
lang: "json" | "tsx" | "typescript" | "yaml";
|
||||
fillHeight?: boolean;
|
||||
hideCopyButton?: boolean;
|
||||
}
|
||||
|
||||
@@ -261,10 +261,10 @@ export function DocsChat({
|
||||
}
|
||||
}, [messages, isLoading]);
|
||||
|
||||
// Cmd+K to open sidebar and focus prompt, Escape to close
|
||||
// Cmd+I to open sidebar and focus prompt, Escape to close
|
||||
useEffect(() => {
|
||||
const handleKeyDown = (e: KeyboardEvent) => {
|
||||
if (e.key === "k" && (e.metaKey || e.ctrlKey)) {
|
||||
if (e.key === "i" && (e.metaKey || e.ctrlKey)) {
|
||||
e.preventDefault();
|
||||
setOpen((prev) => {
|
||||
if (!prev) {
|
||||
@@ -497,12 +497,12 @@ export function DocsChat({
|
||||
{!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"
|
||||
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 border-primary bg-primary text-primary-foreground shadow-lg hover:bg-primary/90 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
|
||||
<span>⌘</span>I
|
||||
</kbd>
|
||||
</button>
|
||||
)}
|
||||
|
||||
@@ -1,100 +1,257 @@
|
||||
"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() {
|
||||
function ScheduleItem({
|
||||
time,
|
||||
label,
|
||||
color,
|
||||
}: {
|
||||
time: string;
|
||||
label: string;
|
||||
color: string;
|
||||
}) {
|
||||
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 className="flex items-center gap-2 py-1.5 border-t border-border/50 first:border-t-0">
|
||||
<span className="text-[10px] text-muted-foreground/60 w-12 shrink-0 tabular-nums">
|
||||
{time}
|
||||
</span>
|
||||
<span
|
||||
className="w-1.5 h-1.5 rounded-full shrink-0"
|
||||
style={{ background: color }}
|
||||
/>
|
||||
<span className="text-[11px] text-muted-foreground">{label}</span>
|
||||
</div>
|
||||
);
|
||||
}
|
||||
|
||||
function ChatModeDiagram() {
|
||||
function InlineModeDiagram() {
|
||||
return (
|
||||
<div className="flex flex-col h-full">
|
||||
<div className="text-xs font-medium text-muted-foreground mb-3 text-center">
|
||||
Chat Mode
|
||||
<div className="text-sm font-medium text-foreground text-center mb-3">
|
||||
Inline 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">
|
||||
<div className="flex-1 border border-border rounded-2xl bg-background overflow-hidden flex flex-col">
|
||||
<div className="flex-1 p-4 space-y-3 overflow-hidden">
|
||||
{/* User message */}
|
||||
<div className="flex justify-end">
|
||||
<div className="bg-muted-foreground/20 rounded-2xl rounded-br px-3.5 py-2 max-w-[85%]">
|
||||
<span className="text-[11px] text-foreground/80">
|
||||
I have back-to-back meetings today
|
||||
</span>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
{/* AI response */}
|
||||
<div className="space-y-2">
|
||||
<p className="text-[11px] text-muted-foreground/70">
|
||||
Packed day! Here's what you've got:
|
||||
</p>
|
||||
<div className="bg-muted/40 border border-border rounded-xl p-3 w-[92%]">
|
||||
<div className="text-[11px] font-semibold text-foreground/80 mb-2">
|
||||
Today's Schedule
|
||||
</div>
|
||||
<ScheduleItem
|
||||
time="10:00 AM"
|
||||
label="Design Review"
|
||||
color="#7aa2f7"
|
||||
/>
|
||||
<ScheduleItem
|
||||
time="1:00 PM"
|
||||
label="Sprint Planning"
|
||||
color="#bb9af7"
|
||||
/>
|
||||
<ScheduleItem
|
||||
time="3:30 PM"
|
||||
label="Team Standup"
|
||||
color="#9ece6a"
|
||||
/>
|
||||
<ScheduleItem
|
||||
time="4:30 PM"
|
||||
label="Eng All-Hands"
|
||||
color="#e0af68"
|
||||
/>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
{/* Prompt input */}
|
||||
<div className="p-2.5">
|
||||
<div className="bg-muted/50 border border-border rounded-xl px-2.5 py-1.5 flex items-center gap-1.5">
|
||||
<span className="text-[10px] text-muted-foreground/40 flex-1">
|
||||
Message...
|
||||
</span>
|
||||
<div className="w-5 h-5 rounded-md bg-muted-foreground/20 flex items-center justify-center">
|
||||
<svg
|
||||
className="w-2.5 h-2.5 text-muted-foreground/50"
|
||||
viewBox="0 0 24 24"
|
||||
fill="currentColor"
|
||||
>
|
||||
<path
|
||||
d="M12 4l-1.41 1.41L16.17 11H4v2h12.17l-5.58 5.59L12 20l8-8z"
|
||||
transform="rotate(-90 12 12)"
|
||||
/>
|
||||
</svg>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div className="mt-3 flex flex-col items-center gap-2">
|
||||
<div className="text-xs font-medium text-muted-foreground">
|
||||
AI decides when UI beats text
|
||||
</div>
|
||||
<div className="flex items-center gap-1.5 text-[10px] text-muted-foreground/50">
|
||||
<span>AI chatbots</span>
|
||||
<span className="text-muted-foreground/30">/</span>
|
||||
<span>Copilots</span>
|
||||
<span className="text-muted-foreground/30">/</span>
|
||||
<span>Assistants</span>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
);
|
||||
}
|
||||
|
||||
function LandingPage() {
|
||||
return (
|
||||
<div className="w-full h-full flex flex-col bg-muted/20">
|
||||
{/* Nav */}
|
||||
<div className="flex items-center justify-between px-3 py-2 border-b border-border/50">
|
||||
<svg
|
||||
width="12"
|
||||
height="12"
|
||||
viewBox="0 0 24 24"
|
||||
fill="none"
|
||||
className="shrink-0"
|
||||
>
|
||||
<rect
|
||||
x="2"
|
||||
y="14"
|
||||
width="5"
|
||||
height="8"
|
||||
rx="1"
|
||||
className="fill-muted-foreground/60"
|
||||
/>
|
||||
<rect
|
||||
x="9.5"
|
||||
y="8"
|
||||
width="5"
|
||||
height="14"
|
||||
rx="1"
|
||||
className="fill-muted-foreground/60"
|
||||
/>
|
||||
<rect
|
||||
x="17"
|
||||
y="2"
|
||||
width="5"
|
||||
height="20"
|
||||
rx="1"
|
||||
className="fill-muted-foreground/60"
|
||||
/>
|
||||
</svg>
|
||||
<div className="flex items-center gap-2">
|
||||
<span className="text-[9px] text-muted-foreground/50">Pricing</span>
|
||||
<span className="text-[9px] text-muted-foreground/50">Blog</span>
|
||||
<span className="text-[8px] font-semibold bg-foreground text-background rounded-md px-1.5 py-0.5 whitespace-nowrap">
|
||||
Get Started
|
||||
</span>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
{/* Hero */}
|
||||
<div className="flex-1 flex flex-col items-center justify-center gap-2.5 text-center px-4">
|
||||
<span className="text-[8px] font-medium text-green-400 bg-green-400/10 border border-green-400/15 rounded-full px-2 py-0.5">
|
||||
Trusted by 2,000+ teams
|
||||
</span>
|
||||
<div className="text-sm font-bold text-foreground leading-tight">
|
||||
Analytics that
|
||||
<br />
|
||||
move the needle
|
||||
</div>
|
||||
<div className="text-[10px] text-muted-foreground/50 leading-relaxed">
|
||||
Ship what matters. No setup required.
|
||||
</div>
|
||||
<div className="flex gap-1.5 mt-1">
|
||||
<button className="bg-foreground text-background text-[9px] font-semibold rounded-lg px-3 py-1.5 whitespace-nowrap">
|
||||
Start Free
|
||||
</button>
|
||||
<button className="border border-border text-muted-foreground text-[9px] font-medium rounded-lg px-3 py-1.5 whitespace-nowrap">
|
||||
Book Demo
|
||||
</button>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
{/* Footer */}
|
||||
<div className="flex justify-center gap-3 py-2 border-t border-border/50">
|
||||
<span className="text-[8px] text-muted-foreground/30">Privacy</span>
|
||||
<span className="text-[8px] text-muted-foreground/30">Terms</span>
|
||||
<span className="text-[8px] text-muted-foreground/30">Status</span>
|
||||
</div>
|
||||
</div>
|
||||
);
|
||||
}
|
||||
|
||||
function StandaloneModeDiagram() {
|
||||
return (
|
||||
<div className="flex flex-col h-full">
|
||||
<div className="text-sm font-medium text-foreground text-center mb-3">
|
||||
Standalone Mode
|
||||
</div>
|
||||
<div className="flex-1 border border-border rounded-2xl bg-background overflow-hidden flex flex-row">
|
||||
{/* Left panel - conversation */}
|
||||
<div className="w-[38%] border-r border-border/50 flex flex-col">
|
||||
<div className="flex-1 p-3 space-y-2.5">
|
||||
{/* User message */}
|
||||
<div className="flex justify-end">
|
||||
<div className="bg-muted rounded-xl px-3 py-2">
|
||||
<Skeleton className="h-2 w-14" />
|
||||
<div className="bg-muted-foreground/20 rounded-2xl rounded-br px-2.5 py-1.5">
|
||||
<span className="text-[10px] text-foreground/80 block leading-relaxed">
|
||||
A landing page for my analytics startup
|
||||
</span>
|
||||
</div>
|
||||
</div>
|
||||
{/* AI text */}
|
||||
<p className="text-[10px] text-muted-foreground/60 leading-relaxed">
|
||||
Here's a clean landing page with a hero, nav, and CTAs.
|
||||
</p>
|
||||
</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" />
|
||||
{/* Prompt input */}
|
||||
<div className="p-2.5">
|
||||
<div className="bg-muted/50 border border-border rounded-xl px-2.5 py-1.5 flex items-center gap-1.5">
|
||||
<span className="text-[10px] text-muted-foreground/40 flex-1">
|
||||
Message...
|
||||
</span>
|
||||
<div className="w-5 h-5 rounded-md bg-muted-foreground/20 flex items-center justify-center">
|
||||
<svg
|
||||
className="w-2.5 h-2.5 text-muted-foreground/50"
|
||||
viewBox="0 0 24 24"
|
||||
fill="currentColor"
|
||||
>
|
||||
<path
|
||||
d="M12 4l-1.41 1.41L16.17 11H4v2h12.17l-5.58 5.59L12 20l8-8z"
|
||||
transform="rotate(-90 12 12)"
|
||||
/>
|
||||
</svg>
|
||||
</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>
|
||||
{/* Right panel - landing page */}
|
||||
<div className="flex-1">
|
||||
<LandingPage />
|
||||
</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 className="mt-3 flex flex-col items-center gap-2">
|
||||
<div className="text-xs font-medium text-muted-foreground">
|
||||
Prompt in, UI out
|
||||
</div>
|
||||
|
||||
{/* Right panel - UI preview */}
|
||||
<div className="flex-1 p-3 flex items-center justify-center">
|
||||
<div className="w-3/4">
|
||||
<FormUI />
|
||||
</div>
|
||||
<div className="flex items-center gap-1.5 text-[10px] text-muted-foreground/50">
|
||||
<span>Website builders</span>
|
||||
<span className="text-muted-foreground/30">/</span>
|
||||
<span>Text-to-widget</span>
|
||||
<span className="text-muted-foreground/30">/</span>
|
||||
<span>Dashboards</span>
|
||||
</div>
|
||||
</div>
|
||||
<div className="text-[10px] text-muted-foreground/60 mt-2 text-center">
|
||||
Prompt separate from UI preview
|
||||
</div>
|
||||
</div>
|
||||
);
|
||||
}
|
||||
@@ -103,11 +260,11 @@ 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 className="h-[420px]">
|
||||
<InlineModeDiagram />
|
||||
</div>
|
||||
<div className="h-[280px]">
|
||||
<GenerateModeDiagram />
|
||||
<div className="h-[420px]">
|
||||
<StandaloneModeDiagram />
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
+115
-40
@@ -1,17 +1,59 @@
|
||||
"use client";
|
||||
|
||||
import { useState } from "react";
|
||||
import Link from "next/link";
|
||||
import { usePathname } from "next/navigation";
|
||||
import { ThemeToggle } from "./theme-toggle";
|
||||
import { Search } from "./search";
|
||||
import {
|
||||
Sheet,
|
||||
SheetTrigger,
|
||||
SheetContent,
|
||||
SheetTitle,
|
||||
} from "@/components/ui/sheet";
|
||||
import { cn } from "@/lib/utils";
|
||||
|
||||
const navLinks = [
|
||||
{ href: "/playground", label: "Playground" },
|
||||
{ href: "/examples", label: "Examples" },
|
||||
{ href: "/docs", label: "Docs" },
|
||||
];
|
||||
|
||||
function GitHubLink({ className }: { className?: string }) {
|
||||
return (
|
||||
<a
|
||||
href="https://github.com/vercel-labs/json-render"
|
||||
target="_blank"
|
||||
rel="noopener noreferrer"
|
||||
className={cn(
|
||||
"flex items-center gap-1.5 text-sm text-muted-foreground hover:text-foreground transition-colors",
|
||||
className,
|
||||
)}
|
||||
>
|
||||
<svg
|
||||
viewBox="0 0 16 16"
|
||||
className="h-4 w-4"
|
||||
fill="currentColor"
|
||||
aria-hidden="true"
|
||||
>
|
||||
<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>12k</span>
|
||||
</a>
|
||||
);
|
||||
}
|
||||
|
||||
export function Header() {
|
||||
const pathname = usePathname();
|
||||
const [mobileOpen, setMobileOpen] = useState(false);
|
||||
|
||||
const isActive = (href: string) => {
|
||||
if (href === "/playground") {
|
||||
return pathname === "/playground";
|
||||
}
|
||||
if (href === "/examples") {
|
||||
return pathname.startsWith("/examples");
|
||||
}
|
||||
if (href === "/docs") {
|
||||
return pathname.startsWith("/docs");
|
||||
}
|
||||
@@ -57,53 +99,86 @@ 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>
|
||||
</div>
|
||||
<nav className="flex items-center gap-4">
|
||||
<Link
|
||||
href="/playground"
|
||||
className={cn(
|
||||
"text-sm transition-colors",
|
||||
isActive("/playground")
|
||||
? "text-primary font-medium"
|
||||
: "text-muted-foreground hover:text-foreground",
|
||||
)}
|
||||
>
|
||||
<span className="sm:hidden">Play</span>
|
||||
<span className="hidden sm:inline">Playground</span>
|
||||
</Link>
|
||||
<Link
|
||||
href="/docs"
|
||||
className={cn(
|
||||
"text-sm transition-colors",
|
||||
isActive("/docs")
|
||||
? "text-primary font-medium"
|
||||
: "text-muted-foreground hover:text-foreground",
|
||||
)}
|
||||
>
|
||||
Docs
|
||||
</Link>
|
||||
<a
|
||||
href="https://github.com/vercel-labs/json-render"
|
||||
target="_blank"
|
||||
rel="noopener noreferrer"
|
||||
className="flex items-center gap-1.5 text-sm text-muted-foreground hover:text-foreground transition-colors"
|
||||
>
|
||||
<svg
|
||||
viewBox="0 0 16 16"
|
||||
className="h-4 w-4"
|
||||
fill="currentColor"
|
||||
aria-hidden="true"
|
||||
|
||||
{/* Desktop nav */}
|
||||
<nav className="hidden sm:flex items-center gap-4">
|
||||
{navLinks.map((link) => (
|
||||
<Link
|
||||
key={link.href}
|
||||
href={link.href}
|
||||
className={cn(
|
||||
"text-sm transition-colors",
|
||||
isActive(link.href)
|
||||
? "text-primary"
|
||||
: "text-muted-foreground hover:text-foreground",
|
||||
)}
|
||||
>
|
||||
<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>11k</span>
|
||||
</a>
|
||||
{link.label}
|
||||
</Link>
|
||||
))}
|
||||
<Search />
|
||||
<GitHubLink />
|
||||
<ThemeToggle />
|
||||
</nav>
|
||||
|
||||
{/* Mobile nav */}
|
||||
<div className="flex sm:hidden items-center gap-3">
|
||||
<Search />
|
||||
<GitHubLink />
|
||||
<Sheet open={mobileOpen} onOpenChange={setMobileOpen}>
|
||||
<SheetTrigger
|
||||
className="flex items-center justify-center"
|
||||
aria-label="Open menu"
|
||||
>
|
||||
<svg
|
||||
xmlns="http://www.w3.org/2000/svg"
|
||||
width="20"
|
||||
height="20"
|
||||
viewBox="0 0 24 24"
|
||||
fill="none"
|
||||
stroke="currentColor"
|
||||
strokeWidth="2"
|
||||
strokeLinecap="round"
|
||||
strokeLinejoin="round"
|
||||
className="text-muted-foreground"
|
||||
>
|
||||
<line x1="4" x2="20" y1="12" y2="12" />
|
||||
<line x1="4" x2="20" y1="6" y2="6" />
|
||||
<line x1="4" x2="20" y1="18" y2="18" />
|
||||
</svg>
|
||||
</SheetTrigger>
|
||||
<SheetContent side="right" className="overflow-y-auto p-6">
|
||||
<SheetTitle className="mb-6">Menu</SheetTitle>
|
||||
<nav className="flex flex-col gap-1">
|
||||
{navLinks.map((link) => (
|
||||
<Link
|
||||
key={link.href}
|
||||
href={link.href}
|
||||
onClick={() => setMobileOpen(false)}
|
||||
className={cn(
|
||||
"block py-2.5 text-sm transition-colors",
|
||||
isActive(link.href)
|
||||
? "text-primary"
|
||||
: "text-muted-foreground hover:text-foreground",
|
||||
)}
|
||||
>
|
||||
{link.label}
|
||||
</Link>
|
||||
))}
|
||||
<div className="my-3 border-t border-border" />
|
||||
<div className="flex items-center justify-between py-2.5">
|
||||
<span className="text-sm text-muted-foreground">Theme</span>
|
||||
<ThemeToggle />
|
||||
</div>
|
||||
</nav>
|
||||
</SheetContent>
|
||||
</Sheet>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
);
|
||||
|
||||
@@ -2,10 +2,16 @@
|
||||
|
||||
import { useEffect, useState, useCallback, useRef, useMemo } from "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";
|
||||
import { stringify as yamlStringify } from "yaml";
|
||||
import type { EditMode } from "@json-render/core";
|
||||
import {
|
||||
usePlaygroundStream,
|
||||
type StreamFormat,
|
||||
type TokenUsage,
|
||||
} from "@/lib/use-playground-stream";
|
||||
import {
|
||||
ResizablePanelGroup,
|
||||
ResizablePanel,
|
||||
@@ -16,17 +22,20 @@ import { CopyButton } from "./copy-button";
|
||||
import { Toaster } from "./ui/sonner";
|
||||
import { Header } from "./header";
|
||||
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" | "nested" | "stream" | "catalog";
|
||||
type Tab = "spec" | "nested" | "stream" | "catalog" | "visual";
|
||||
type RenderView = "preview" | "code";
|
||||
type MobileView =
|
||||
| "json"
|
||||
| "spec"
|
||||
| "nested"
|
||||
| "stream"
|
||||
| "catalog"
|
||||
| "visual"
|
||||
| "preview"
|
||||
| "generated-code";
|
||||
|
||||
@@ -37,6 +46,79 @@ interface Version {
|
||||
status: "generating" | "complete" | "error";
|
||||
usage: TokenUsage | null;
|
||||
rawLines: string[];
|
||||
format: StreamFormat;
|
||||
}
|
||||
|
||||
function formatTokens(n: number): string {
|
||||
if (n >= 1000) return `${(n / 1000).toFixed(1).replace(/\.0$/, "")}k`;
|
||||
return String(n);
|
||||
}
|
||||
|
||||
function PlaygroundControls({
|
||||
format,
|
||||
setFormat,
|
||||
editModes,
|
||||
setEditModes,
|
||||
showClear,
|
||||
onClear,
|
||||
}: {
|
||||
format: StreamFormat;
|
||||
setFormat: (f: StreamFormat) => void;
|
||||
editModes: EditMode[];
|
||||
setEditModes: React.Dispatch<React.SetStateAction<EditMode[]>>;
|
||||
showClear: boolean;
|
||||
onClear: () => void;
|
||||
}) {
|
||||
return (
|
||||
<div className="flex items-center gap-2">
|
||||
<div className="flex items-center rounded border border-border text-[10px] font-mono overflow-hidden">
|
||||
{(["jsonl", "yaml"] as const).map((f) => (
|
||||
<button
|
||||
key={f}
|
||||
onClick={() => setFormat(f)}
|
||||
className={`px-1.5 py-0.5 transition-colors ${
|
||||
format === f
|
||||
? "bg-muted text-foreground"
|
||||
: "text-muted-foreground hover:text-foreground"
|
||||
}`}
|
||||
>
|
||||
{f}
|
||||
</button>
|
||||
))}
|
||||
</div>
|
||||
<div className="flex items-center rounded border border-border text-[10px] font-mono overflow-hidden">
|
||||
{(["patch", "merge", "diff"] as const).map((m) => (
|
||||
<button
|
||||
key={m}
|
||||
onClick={() => {
|
||||
setEditModes((prev) =>
|
||||
prev.includes(m)
|
||||
? prev.length > 1
|
||||
? prev.filter((x) => x !== m)
|
||||
: prev
|
||||
: [...prev, m],
|
||||
);
|
||||
}}
|
||||
className={`px-1.5 py-0.5 transition-colors ${
|
||||
editModes.includes(m)
|
||||
? "bg-muted text-foreground"
|
||||
: "text-muted-foreground hover:text-foreground"
|
||||
}`}
|
||||
>
|
||||
{m}
|
||||
</button>
|
||||
))}
|
||||
</div>
|
||||
{showClear && (
|
||||
<button
|
||||
onClick={onClear}
|
||||
className="text-xs text-muted-foreground hover:text-foreground transition-colors"
|
||||
>
|
||||
Clear
|
||||
</button>
|
||||
)}
|
||||
</div>
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -97,13 +179,15 @@ export function Playground() {
|
||||
null,
|
||||
);
|
||||
const [inputValue, setInputValue] = useState("");
|
||||
const [activeTab, setActiveTab] = useState<Tab>("json");
|
||||
const [activeTab, setActiveTab] = useState<Tab>("spec");
|
||||
const [catalogSection, setCatalogSection] = useState<
|
||||
"components" | "actions"
|
||||
>("components");
|
||||
const [renderView, setRenderView] = useState<RenderView>("preview");
|
||||
const [mobileView, setMobileView] = useState<MobileView>("preview");
|
||||
const [versionsSheetOpen, setVersionsSheetOpen] = useState(false);
|
||||
const [format, setFormat] = useState<StreamFormat>("jsonl");
|
||||
const [editModes, setEditModes] = useState<EditMode[]>(["patch"]);
|
||||
const inputRef = useRef<HTMLTextAreaElement>(null);
|
||||
const mobileInputRef = useRef<HTMLTextAreaElement>(null);
|
||||
const versionsEndRef = useRef<HTMLDivElement>(null);
|
||||
@@ -121,12 +205,13 @@ export function Playground() {
|
||||
rawLines: streamRawLines,
|
||||
send,
|
||||
clear,
|
||||
} = useUIStream({
|
||||
} = usePlaygroundStream({
|
||||
api: "/api/generate",
|
||||
format,
|
||||
editModes,
|
||||
onError: (err: Error) => {
|
||||
console.error("Generation error:", err);
|
||||
toast.error(err.message || "Generation failed. Please try again.");
|
||||
// Mark the version as errored
|
||||
if (generatingVersionIdRef.current) {
|
||||
const erroredVersionId = generatingVersionIdRef.current;
|
||||
setVersions((prev) =>
|
||||
@@ -137,7 +222,7 @@ export function Playground() {
|
||||
generatingVersionIdRef.current = null;
|
||||
}
|
||||
},
|
||||
} as Parameters<typeof useUIStream>[0]);
|
||||
});
|
||||
|
||||
// Get the selected version
|
||||
const selectedVersion = versions.find((v) => v.id === selectedVersionId);
|
||||
@@ -212,6 +297,7 @@ export function Playground() {
|
||||
status: "generating",
|
||||
usage: null,
|
||||
rawLines: [],
|
||||
format,
|
||||
};
|
||||
|
||||
generatingVersionIdRef.current = newVersionId;
|
||||
@@ -221,7 +307,7 @@ export function Playground() {
|
||||
|
||||
// Pass the current tree as context so the API can iterate on it
|
||||
await send(inputValue.trim(), { previousSpec: currentTreeRef.current });
|
||||
}, [inputValue, isStreaming, send]);
|
||||
}, [inputValue, isStreaming, send, format]);
|
||||
|
||||
const handleKeyDown = useCallback(
|
||||
(e: React.KeyboardEvent) => {
|
||||
@@ -233,9 +319,30 @@ export function Playground() {
|
||||
[handleSubmit],
|
||||
);
|
||||
|
||||
const jsonCode = currentTree
|
||||
? JSON.stringify(currentTree, null, 2)
|
||||
: "// waiting...";
|
||||
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 specCode = useMemo(() => {
|
||||
if (!currentTree)
|
||||
return format === "yaml" ? "# waiting..." : "// waiting...";
|
||||
if (format === "yaml") {
|
||||
return yamlStringify(currentTree, { indent: 2 }).trimEnd();
|
||||
}
|
||||
return JSON.stringify(currentTree, null, 2);
|
||||
}, [currentTree, format]);
|
||||
|
||||
const specLang = format === "yaml" ? "yaml" : "json";
|
||||
|
||||
const nestedCode = useMemo(() => {
|
||||
if (!currentTree || !currentTree.root) return "// waiting...";
|
||||
@@ -258,7 +365,7 @@ export function Playground() {
|
||||
const componentName = element.type;
|
||||
|
||||
const propsObj: Record<string, unknown> = {};
|
||||
for (const [k, v] of Object.entries(element.props)) {
|
||||
for (const [k, v] of Object.entries(element.props ?? {})) {
|
||||
if (v !== null && v !== undefined) {
|
||||
propsObj[k] = v;
|
||||
}
|
||||
@@ -304,6 +411,15 @@ ${jsx}
|
||||
}`;
|
||||
}, [currentTree]);
|
||||
|
||||
// Determine syntax lang for raw stream based on selected version's format
|
||||
const streamLang = isSelectedVersionGenerating
|
||||
? format === "yaml"
|
||||
? "yaml"
|
||||
: "json"
|
||||
: selectedVersion?.format === "yaml"
|
||||
? "yaml"
|
||||
: "json";
|
||||
|
||||
// Chat pane content
|
||||
const chatPane = (
|
||||
<div className="h-full flex flex-col border-t border-border">
|
||||
@@ -375,9 +491,15 @@ ${jsx}
|
||||
)}
|
||||
</div>
|
||||
{version.usage && (
|
||||
<div className="flex items-center gap-2 mt-1 ml-6">
|
||||
<div className="mt-1 ml-6">
|
||||
<span className="text-[10px] font-mono text-muted-foreground/60">
|
||||
{version.usage.totalTokens.toLocaleString()} tokens
|
||||
{formatTokens(
|
||||
version.usage.promptTokens - version.usage.cachedTokens,
|
||||
)}{" "}
|
||||
in · {formatTokens(version.usage.completionTokens)} out
|
||||
{version.usage.cachedTokens > 0
|
||||
? ` · ${formatTokens(version.usage.cachedTokens)} cached`
|
||||
: ""}
|
||||
</span>
|
||||
</div>
|
||||
)}
|
||||
@@ -408,20 +530,18 @@ ${jsx}
|
||||
autoFocus
|
||||
/>
|
||||
<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 />
|
||||
)}
|
||||
<PlaygroundControls
|
||||
format={format}
|
||||
setFormat={setFormat}
|
||||
editModes={editModes}
|
||||
setEditModes={setEditModes}
|
||||
showClear={versions.length > 0}
|
||||
onClear={() => {
|
||||
setVersions([]);
|
||||
setSelectedVersionId(null);
|
||||
clear();
|
||||
}}
|
||||
/>
|
||||
{isStreaming ? (
|
||||
<button
|
||||
onClick={() => clear()}
|
||||
@@ -475,35 +595,73 @@ ${jsx}
|
||||
const copyText =
|
||||
activeTab === "stream"
|
||||
? currentRawLines.join("\n")
|
||||
: activeTab === "json"
|
||||
? jsonCode
|
||||
: activeTab === "spec"
|
||||
? specCode
|
||||
: activeTab === "nested"
|
||||
? nestedCode
|
||||
: "";
|
||||
: activeTab === "visual"
|
||||
? specCode
|
||||
: "";
|
||||
|
||||
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", "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>
|
||||
))}
|
||||
{(["spec", "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 === "spec" ? (format === "yaml" ? "yaml" : "json") : tab}
|
||||
</button>
|
||||
),
|
||||
)}
|
||||
<div className="flex-1" />
|
||||
{activeTab !== "catalog" && (
|
||||
{activeTab !== "catalog" && activeTab !== "visual" && (
|
||||
<CopyButton text={copyText} className="text-muted-foreground" />
|
||||
)}
|
||||
</div>
|
||||
<div className="flex-1 overflow-auto">
|
||||
{activeTab === "catalog" ? (
|
||||
{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">
|
||||
{(
|
||||
@@ -624,7 +782,7 @@ ${jsx}
|
||||
currentRawLines.length > 0 ? (
|
||||
<CodeBlock
|
||||
code={currentRawLines.join("\n")}
|
||||
lang="json"
|
||||
lang={streamLang}
|
||||
fillHeight
|
||||
hideCopyButton
|
||||
/>
|
||||
@@ -636,7 +794,12 @@ ${jsx}
|
||||
) : activeTab === "nested" ? (
|
||||
<CodeBlock code={nestedCode} lang="json" fillHeight hideCopyButton />
|
||||
) : (
|
||||
<CodeBlock code={jsonCode} lang="json" fillHeight hideCopyButton />
|
||||
<CodeBlock
|
||||
code={specCode}
|
||||
lang={specLang}
|
||||
fillHeight
|
||||
hideCopyButton
|
||||
/>
|
||||
)}
|
||||
</div>
|
||||
</div>
|
||||
@@ -735,19 +898,21 @@ ${jsx}
|
||||
: 0}
|
||||
</button>
|
||||
{/* Code tabs */}
|
||||
{(["json", "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>
|
||||
))}
|
||||
{(["spec", "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 === "spec" ? (format === "yaml" ? "yaml" : "json") : tab}
|
||||
</button>
|
||||
),
|
||||
)}
|
||||
<div className="flex-1" />
|
||||
{/* Preview / code toggle */}
|
||||
{[
|
||||
@@ -770,7 +935,41 @@ ${jsx}
|
||||
|
||||
{/* Main content area */}
|
||||
<div className="flex-1 min-h-0 overflow-auto">
|
||||
{mobileView === "catalog" ? (
|
||||
{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">
|
||||
{(
|
||||
@@ -891,7 +1090,7 @@ ${jsx}
|
||||
currentRawLines.length > 0 ? (
|
||||
<CodeBlock
|
||||
code={currentRawLines.join("\n")}
|
||||
lang="json"
|
||||
lang={streamLang}
|
||||
fillHeight
|
||||
hideCopyButton
|
||||
/>
|
||||
@@ -907,8 +1106,13 @@ ${jsx}
|
||||
fillHeight
|
||||
hideCopyButton
|
||||
/>
|
||||
) : mobileView === "json" ? (
|
||||
<CodeBlock code={jsonCode} lang="json" fillHeight hideCopyButton />
|
||||
) : mobileView === "spec" ? (
|
||||
<CodeBlock
|
||||
code={specCode}
|
||||
lang={specLang}
|
||||
fillHeight
|
||||
hideCopyButton
|
||||
/>
|
||||
) : mobileView === "preview" ? (
|
||||
currentTree && currentTree.root ? (
|
||||
<div className="w-full min-h-full flex items-center justify-center p-6">
|
||||
@@ -984,20 +1188,18 @@ ${jsx}
|
||||
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 />
|
||||
)}
|
||||
<PlaygroundControls
|
||||
format={format}
|
||||
setFormat={setFormat}
|
||||
editModes={editModes}
|
||||
setEditModes={setEditModes}
|
||||
showClear={versions.length > 0}
|
||||
onClear={() => {
|
||||
setVersions([]);
|
||||
setSelectedVersionId(null);
|
||||
clear();
|
||||
}}
|
||||
/>
|
||||
{isStreaming ? (
|
||||
<button
|
||||
onClick={() => clear()}
|
||||
@@ -1074,9 +1276,16 @@ ${jsx}
|
||||
)}
|
||||
</div>
|
||||
{version.usage && (
|
||||
<div className="flex items-center gap-2 mt-1 ml-6">
|
||||
<div className="mt-1 ml-6">
|
||||
<span className="text-[10px] font-mono text-muted-foreground/60">
|
||||
{version.usage.totalTokens.toLocaleString()} tokens
|
||||
{formatTokens(
|
||||
version.usage.promptTokens -
|
||||
version.usage.cachedTokens,
|
||||
)}{" "}
|
||||
in · {formatTokens(version.usage.completionTokens)} out
|
||||
{version.usage.cachedTokens > 0
|
||||
? ` · ${formatTokens(version.usage.cachedTokens)} cached`
|
||||
: ""}
|
||||
</span>
|
||||
</div>
|
||||
)}
|
||||
|
||||
@@ -0,0 +1,266 @@
|
||||
"use client";
|
||||
|
||||
import { useCallback, useEffect, useRef, useState } from "react";
|
||||
import { useRouter } from "next/navigation";
|
||||
import { Dialog, DialogContent, DialogTitle } from "@/components/ui/dialog";
|
||||
import { cn } from "@/lib/utils";
|
||||
|
||||
type SearchResult = {
|
||||
title: string;
|
||||
href: string;
|
||||
section: string;
|
||||
snippet: string;
|
||||
};
|
||||
|
||||
export function Search() {
|
||||
const router = useRouter();
|
||||
const [open, setOpen] = useState(false);
|
||||
const [query, setQuery] = useState("");
|
||||
const [results, setResults] = useState<SearchResult[]>([]);
|
||||
const [loading, setLoading] = useState(false);
|
||||
const [activeIndex, setActiveIndex] = useState(0);
|
||||
const inputRef = useRef<HTMLInputElement>(null);
|
||||
const listRef = useRef<HTMLDivElement>(null);
|
||||
const abortRef = useRef<AbortController | null>(null);
|
||||
|
||||
const navigate = useCallback(
|
||||
(href: string) => {
|
||||
setOpen(false);
|
||||
setQuery("");
|
||||
setResults([]);
|
||||
router.push(href);
|
||||
},
|
||||
[router],
|
||||
);
|
||||
|
||||
useEffect(() => {
|
||||
function onKeyDown(e: KeyboardEvent) {
|
||||
if ((e.metaKey || e.ctrlKey) && e.key === "k") {
|
||||
e.preventDefault();
|
||||
setOpen((prev) => !prev);
|
||||
}
|
||||
}
|
||||
document.addEventListener("keydown", onKeyDown);
|
||||
return () => document.removeEventListener("keydown", onKeyDown);
|
||||
}, []);
|
||||
|
||||
useEffect(() => {
|
||||
if (open) {
|
||||
setTimeout(() => inputRef.current?.focus(), 0);
|
||||
} else {
|
||||
setQuery("");
|
||||
setResults([]);
|
||||
}
|
||||
}, [open]);
|
||||
|
||||
useEffect(() => {
|
||||
const q = query.trim();
|
||||
if (!q) {
|
||||
setResults([]);
|
||||
setLoading(false);
|
||||
return;
|
||||
}
|
||||
|
||||
setLoading(true);
|
||||
abortRef.current?.abort();
|
||||
const controller = new AbortController();
|
||||
abortRef.current = controller;
|
||||
|
||||
const timeout = setTimeout(async () => {
|
||||
try {
|
||||
const res = await fetch(`/api/search?q=${encodeURIComponent(q)}`, {
|
||||
signal: controller.signal,
|
||||
});
|
||||
if (res.ok) {
|
||||
const data = await res.json();
|
||||
setResults(data.results);
|
||||
}
|
||||
} catch {
|
||||
// aborted or network error
|
||||
} finally {
|
||||
if (!controller.signal.aborted) {
|
||||
setLoading(false);
|
||||
}
|
||||
}
|
||||
}, 150);
|
||||
|
||||
return () => {
|
||||
clearTimeout(timeout);
|
||||
controller.abort();
|
||||
};
|
||||
}, [query]);
|
||||
|
||||
useEffect(() => {
|
||||
setActiveIndex(0);
|
||||
}, [results]);
|
||||
|
||||
function handleKeyDown(e: React.KeyboardEvent) {
|
||||
if (e.key === "ArrowDown") {
|
||||
e.preventDefault();
|
||||
setActiveIndex((i) => Math.min(i + 1, results.length - 1));
|
||||
} else if (e.key === "ArrowUp") {
|
||||
e.preventDefault();
|
||||
setActiveIndex((i) => Math.max(i - 1, 0));
|
||||
} else if (e.key === "Enter" && results[activeIndex]) {
|
||||
e.preventDefault();
|
||||
navigate(results[activeIndex].href);
|
||||
}
|
||||
}
|
||||
|
||||
useEffect(() => {
|
||||
const active = listRef.current?.querySelector("[data-active='true']");
|
||||
active?.scrollIntoView({ block: "nearest" });
|
||||
}, [activeIndex]);
|
||||
|
||||
const hasQuery = query.trim().length > 0;
|
||||
|
||||
return (
|
||||
<>
|
||||
<button
|
||||
onClick={() => setOpen(true)}
|
||||
className="hidden sm:flex items-center gap-2 rounded-md border border-border bg-muted/50 px-3 py-1.5 text-sm text-muted-foreground hover:text-foreground hover:border-foreground/25 transition-colors"
|
||||
>
|
||||
<svg
|
||||
xmlns="http://www.w3.org/2000/svg"
|
||||
width="14"
|
||||
height="14"
|
||||
viewBox="0 0 24 24"
|
||||
fill="none"
|
||||
stroke="currentColor"
|
||||
strokeWidth="2"
|
||||
strokeLinecap="round"
|
||||
strokeLinejoin="round"
|
||||
>
|
||||
<circle cx="11" cy="11" r="8" />
|
||||
<path d="m21 21-4.3-4.3" />
|
||||
</svg>
|
||||
Search docs
|
||||
<kbd className="pointer-events-none ml-1 inline-flex items-center gap-0.5 rounded border border-border bg-background px-1.5 py-0.5 font-mono text-[10px] text-muted-foreground">
|
||||
<span>⌘</span>K
|
||||
</kbd>
|
||||
</button>
|
||||
|
||||
<button
|
||||
onClick={() => setOpen(true)}
|
||||
className="sm:hidden flex items-center text-muted-foreground hover:text-foreground transition-colors"
|
||||
aria-label="Search docs"
|
||||
>
|
||||
<svg
|
||||
xmlns="http://www.w3.org/2000/svg"
|
||||
width="16"
|
||||
height="16"
|
||||
viewBox="0 0 24 24"
|
||||
fill="none"
|
||||
stroke="currentColor"
|
||||
strokeWidth="2"
|
||||
strokeLinecap="round"
|
||||
strokeLinejoin="round"
|
||||
>
|
||||
<circle cx="11" cy="11" r="8" />
|
||||
<path d="m21 21-4.3-4.3" />
|
||||
</svg>
|
||||
</button>
|
||||
|
||||
<Dialog open={open} onOpenChange={setOpen}>
|
||||
<DialogContent
|
||||
showCloseButton={false}
|
||||
className="gap-0 p-0 sm:max-w-lg"
|
||||
>
|
||||
<DialogTitle className="sr-only">Search documentation</DialogTitle>
|
||||
<div className="flex items-center gap-2 border-b px-3">
|
||||
<svg
|
||||
xmlns="http://www.w3.org/2000/svg"
|
||||
width="16"
|
||||
height="16"
|
||||
viewBox="0 0 24 24"
|
||||
fill="none"
|
||||
stroke="currentColor"
|
||||
strokeWidth="2"
|
||||
strokeLinecap="round"
|
||||
strokeLinejoin="round"
|
||||
className="shrink-0 text-muted-foreground"
|
||||
>
|
||||
<circle cx="11" cy="11" r="8" />
|
||||
<path d="m21 21-4.3-4.3" />
|
||||
</svg>
|
||||
<input
|
||||
ref={inputRef}
|
||||
value={query}
|
||||
onChange={(e) => setQuery(e.target.value)}
|
||||
onKeyDown={handleKeyDown}
|
||||
placeholder="Search docs..."
|
||||
className="flex-1 bg-transparent py-3 text-sm outline-none placeholder:text-muted-foreground"
|
||||
/>
|
||||
{query && (
|
||||
<button
|
||||
onClick={() => setQuery("")}
|
||||
className="text-muted-foreground hover:text-foreground"
|
||||
>
|
||||
<svg
|
||||
xmlns="http://www.w3.org/2000/svg"
|
||||
width="14"
|
||||
height="14"
|
||||
viewBox="0 0 24 24"
|
||||
fill="none"
|
||||
stroke="currentColor"
|
||||
strokeWidth="2"
|
||||
strokeLinecap="round"
|
||||
strokeLinejoin="round"
|
||||
>
|
||||
<path d="M18 6 6 18" />
|
||||
<path d="m6 6 12 12" />
|
||||
</svg>
|
||||
</button>
|
||||
)}
|
||||
</div>
|
||||
|
||||
<div
|
||||
ref={listRef}
|
||||
className="max-h-[min(60vh,400px)] overflow-y-auto p-2"
|
||||
>
|
||||
{loading && hasQuery ? (
|
||||
<div className="flex items-center justify-center py-6">
|
||||
<div className="h-4 w-4 animate-spin rounded-full border-2 border-muted-foreground border-t-transparent" />
|
||||
</div>
|
||||
) : hasQuery && results.length === 0 ? (
|
||||
<p className="py-6 text-center text-sm text-muted-foreground">
|
||||
No results found.
|
||||
</p>
|
||||
) : !hasQuery ? (
|
||||
<p className="py-6 text-center text-sm text-muted-foreground">
|
||||
Type to search documentation...
|
||||
</p>
|
||||
) : (
|
||||
results.map((item, i) => (
|
||||
<button
|
||||
key={item.href}
|
||||
data-active={i === activeIndex}
|
||||
onClick={() => navigate(item.href)}
|
||||
onMouseEnter={() => setActiveIndex(i)}
|
||||
className={cn(
|
||||
"flex w-full flex-col gap-1 rounded-md px-3 py-2 text-left transition-colors",
|
||||
i === activeIndex
|
||||
? "bg-accent text-accent-foreground"
|
||||
: "text-foreground",
|
||||
)}
|
||||
>
|
||||
<div className="flex items-center justify-between gap-2">
|
||||
<span className="text-sm font-medium">{item.title}</span>
|
||||
<span className="shrink-0 text-xs text-muted-foreground">
|
||||
{item.section}
|
||||
</span>
|
||||
</div>
|
||||
{item.snippet && (
|
||||
<span className="line-clamp-2 text-xs text-muted-foreground leading-relaxed">
|
||||
{item.snippet}
|
||||
</span>
|
||||
)}
|
||||
</button>
|
||||
))
|
||||
)}
|
||||
</div>
|
||||
</DialogContent>
|
||||
</Dialog>
|
||||
</>
|
||||
);
|
||||
}
|
||||
@@ -0,0 +1,83 @@
|
||||
"use client";
|
||||
|
||||
import { useEffect, useState } from "react";
|
||||
import { usePathname } from "next/navigation";
|
||||
import { cn } from "@/lib/utils";
|
||||
|
||||
type Heading = {
|
||||
id: string;
|
||||
text: string;
|
||||
level: number;
|
||||
};
|
||||
|
||||
function getHeadings(): Heading[] {
|
||||
const article = document.querySelector("article");
|
||||
if (!article) return [];
|
||||
const elements = article.querySelectorAll("h2[id], h3[id]");
|
||||
return Array.from(elements).map((el) => ({
|
||||
id: el.id,
|
||||
text: el.textContent?.replace(/#$/, "").trim() ?? "",
|
||||
level: el.tagName === "H3" ? 3 : 2,
|
||||
}));
|
||||
}
|
||||
|
||||
export function TableOfContents() {
|
||||
const pathname = usePathname();
|
||||
const [headings, setHeadings] = useState<Heading[]>([]);
|
||||
const [activeId, setActiveId] = useState<string>("");
|
||||
|
||||
useEffect(() => {
|
||||
const timer = setTimeout(() => setHeadings(getHeadings()), 100);
|
||||
return () => clearTimeout(timer);
|
||||
}, [pathname]);
|
||||
|
||||
useEffect(() => {
|
||||
if (headings.length === 0) return;
|
||||
|
||||
const observer = new IntersectionObserver(
|
||||
(entries) => {
|
||||
for (const entry of entries) {
|
||||
if (entry.isIntersecting) {
|
||||
setActiveId(entry.target.id);
|
||||
}
|
||||
}
|
||||
},
|
||||
{ rootMargin: "0px 0px -75% 0px", threshold: 0.1 },
|
||||
);
|
||||
|
||||
for (const h of headings) {
|
||||
const el = document.getElementById(h.id);
|
||||
if (el) observer.observe(el);
|
||||
}
|
||||
|
||||
return () => observer.disconnect();
|
||||
}, [headings]);
|
||||
|
||||
if (headings.length === 0) return null;
|
||||
|
||||
return (
|
||||
<nav aria-label="On this page">
|
||||
<h4 className="text-xs font-medium text-muted-foreground uppercase tracking-wider mb-3">
|
||||
On this page
|
||||
</h4>
|
||||
<ul className="space-y-1">
|
||||
{headings.map((h) => (
|
||||
<li key={h.id}>
|
||||
<a
|
||||
href={`#${h.id}`}
|
||||
className={cn(
|
||||
"block text-xs leading-relaxed py-0.5 transition-colors",
|
||||
h.level === 3 && "pl-3",
|
||||
activeId === h.id
|
||||
? "text-foreground"
|
||||
: "text-muted-foreground hover:text-foreground",
|
||||
)}
|
||||
>
|
||||
{h.text}
|
||||
</a>
|
||||
</li>
|
||||
))}
|
||||
</ul>
|
||||
</nav>
|
||||
);
|
||||
}
|
||||
@@ -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 [
|
||||
|
||||
@@ -16,6 +16,7 @@ export const docsNavigation: NavSection[] = [
|
||||
{ title: "Introduction", href: "/docs" },
|
||||
{ title: "Installation", href: "/docs/installation" },
|
||||
{ title: "Quick Start", href: "/docs/quick-start" },
|
||||
{ title: "Skills", href: "/docs/skills" },
|
||||
{ title: "Migration Guide", href: "/docs/migration" },
|
||||
{ title: "Changelog", href: "/docs/changelog" },
|
||||
],
|
||||
@@ -27,13 +28,16 @@ export const docsNavigation: NavSection[] = [
|
||||
{ title: "Schemas", href: "/docs/schemas" },
|
||||
{ title: "Catalog", href: "/docs/catalog" },
|
||||
{ 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: "Renderers", href: "/docs/renderers" },
|
||||
{ title: "Registry", href: "/docs/registry" },
|
||||
{ title: "Streaming", href: "/docs/streaming" },
|
||||
{ title: "Generation Modes", href: "/docs/generation-modes" },
|
||||
@@ -41,28 +45,7 @@ export const docsNavigation: NavSection[] = [
|
||||
},
|
||||
{
|
||||
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: "Remotion",
|
||||
href: "https://github.com/vercel-labs/json-render/tree/main/examples/remotion",
|
||||
external: true,
|
||||
},
|
||||
],
|
||||
items: [{ title: "Browse All Examples", href: "/examples" }],
|
||||
},
|
||||
{
|
||||
title: "Guides",
|
||||
@@ -86,10 +69,29 @@ export const docsNavigation: NavSection[] = [
|
||||
items: [
|
||||
{ title: "@json-render/core", href: "/docs/api/core" },
|
||||
{ title: "@json-render/react", href: "/docs/api/react" },
|
||||
{ title: "@json-render/next", href: "/docs/api/next" },
|
||||
{ title: "@json-render/react-pdf", href: "/docs/api/react-pdf" },
|
||||
{ title: "@json-render/react-email", href: "/docs/api/react-email" },
|
||||
{ title: "@json-render/shadcn", href: "/docs/api/shadcn" },
|
||||
{ title: "@json-render/shadcn-svelte", href: "/docs/api/shadcn-svelte" },
|
||||
{ title: "@json-render/react-native", href: "/docs/api/react-native" },
|
||||
{ title: "@json-render/image", href: "/docs/api/image" },
|
||||
{ title: "@json-render/remotion", href: "/docs/api/remotion" },
|
||||
{ title: "@json-render/ink", href: "/docs/api/ink" },
|
||||
{ title: "@json-render/vue", href: "/docs/api/vue" },
|
||||
{ title: "@json-render/svelte", href: "/docs/api/svelte" },
|
||||
{ title: "@json-render/solid", href: "/docs/api/solid" },
|
||||
{
|
||||
title: "@json-render/react-three-fiber",
|
||||
href: "/docs/api/react-three-fiber",
|
||||
},
|
||||
{ title: "@json-render/codegen", href: "/docs/api/codegen" },
|
||||
{ title: "@json-render/mcp", href: "/docs/api/mcp" },
|
||||
{ title: "@json-render/redux", href: "/docs/api/redux" },
|
||||
{ title: "@json-render/zustand", href: "/docs/api/zustand" },
|
||||
{ title: "@json-render/jotai", href: "/docs/api/jotai" },
|
||||
{ title: "@json-render/xstate", href: "/docs/api/xstate" },
|
||||
{ title: "@json-render/yaml", href: "/docs/api/yaml" },
|
||||
],
|
||||
},
|
||||
];
|
||||
|
||||
@@ -0,0 +1,160 @@
|
||||
export type Example = {
|
||||
slug: string;
|
||||
title: string;
|
||||
description: string;
|
||||
tags: string[];
|
||||
githubPath: string;
|
||||
demoUrl?: string;
|
||||
};
|
||||
|
||||
const GITHUB_BASE =
|
||||
"https://github.com/vercel-labs/json-render/tree/main/examples";
|
||||
|
||||
export const examples: Example[] = [
|
||||
{
|
||||
slug: "chat",
|
||||
title: "Chat",
|
||||
description:
|
||||
"AI chat app with tool calling, streaming UI, and rich components powered by the AI SDK.",
|
||||
tags: ["React", "Next.js", "AI"],
|
||||
githubPath: "examples/chat",
|
||||
demoUrl: "https://chat-demo.json-render.dev",
|
||||
},
|
||||
{
|
||||
slug: "dashboard",
|
||||
title: "Dashboard",
|
||||
description:
|
||||
"AI-generated dashboard with drag-and-drop, charts, and real-time data binding.",
|
||||
tags: ["React", "Next.js", "AI"],
|
||||
githubPath: "examples/dashboard",
|
||||
demoUrl: "https://dashboard-demo.json-render.dev",
|
||||
},
|
||||
{
|
||||
slug: "no-ai",
|
||||
title: "No AI",
|
||||
description:
|
||||
"Static specs rendered without any AI — forms, cards, tables, and more from hardcoded JSON.",
|
||||
tags: ["React", "Next.js"],
|
||||
githubPath: "examples/no-ai",
|
||||
demoUrl: "https://no-ai-demo.json-render.dev",
|
||||
},
|
||||
{
|
||||
slug: "svelte",
|
||||
title: "Svelte",
|
||||
description:
|
||||
"Svelte renderer demo with counter, todo list, and two-way data binding.",
|
||||
tags: ["Svelte", "Vite"],
|
||||
githubPath: "examples/svelte",
|
||||
demoUrl: "https://svelte-demo.json-render.dev",
|
||||
},
|
||||
{
|
||||
slug: "svelte-chat",
|
||||
title: "Svelte Chat",
|
||||
description: "AI chat app built with SvelteKit and the Svelte renderer.",
|
||||
tags: ["Svelte", "SvelteKit", "AI"],
|
||||
githubPath: "examples/svelte-chat",
|
||||
demoUrl: "https://json-render-svelte-chat-demo.labs.vercel.dev",
|
||||
},
|
||||
{
|
||||
slug: "vue",
|
||||
title: "Vue",
|
||||
description:
|
||||
"Vue renderer demo with counter, todo list, and two-way data binding.",
|
||||
tags: ["Vue", "Vite"],
|
||||
githubPath: "examples/vue",
|
||||
demoUrl: "https://vue-demo.json-render.dev",
|
||||
},
|
||||
{
|
||||
slug: "solid",
|
||||
title: "Solid",
|
||||
description:
|
||||
"Solid renderer demo with counter, todo list, and two-way data binding.",
|
||||
tags: ["Solid", "Vite"],
|
||||
githubPath: "examples/solid",
|
||||
demoUrl: "https://solid-demo.json-render.dev",
|
||||
},
|
||||
{
|
||||
slug: "vite-renderers",
|
||||
title: "Multi-Framework Renderers",
|
||||
description:
|
||||
"Same spec rendered with React, Vue, Svelte, and Solid side by side — hot-swappable at runtime.",
|
||||
tags: ["React", "Vue", "Svelte", "Solid", "Vite"],
|
||||
githubPath: "examples/vite-renderers",
|
||||
},
|
||||
{
|
||||
slug: "react-email",
|
||||
title: "React Email",
|
||||
description:
|
||||
"Generate HTML and plain-text emails from json-render specs using React Email.",
|
||||
tags: ["React", "Email"],
|
||||
githubPath: "examples/react-email",
|
||||
demoUrl: "https://react-email-demo.json-render.dev",
|
||||
},
|
||||
{
|
||||
slug: "react-pdf",
|
||||
title: "React PDF",
|
||||
description:
|
||||
"Generate PDF documents from json-render specs with @react-pdf/renderer.",
|
||||
tags: ["React", "PDF"],
|
||||
githubPath: "examples/react-pdf",
|
||||
demoUrl: "https://react-pdf-demo.json-render.dev",
|
||||
},
|
||||
{
|
||||
slug: "react-three-fiber",
|
||||
title: "React Three Fiber",
|
||||
description:
|
||||
"3D scenes generated from json-render specs using Three.js and React Three Fiber.",
|
||||
tags: ["React", "3D"],
|
||||
githubPath: "examples/react-three-fiber",
|
||||
demoUrl: "https://react-three-fiber-demo.json-render.dev",
|
||||
},
|
||||
{
|
||||
slug: "react-native",
|
||||
title: "React Native",
|
||||
description:
|
||||
"Mobile app rendering json-render specs with Expo and React Native.",
|
||||
tags: ["React Native", "Expo"],
|
||||
githubPath: "examples/react-native",
|
||||
},
|
||||
{
|
||||
slug: "remotion",
|
||||
title: "Remotion",
|
||||
description: "Generate videos from json-render specs using Remotion.",
|
||||
tags: ["React", "Video"],
|
||||
githubPath: "examples/remotion",
|
||||
demoUrl: "https://remotion-demo.json-render.dev",
|
||||
},
|
||||
{
|
||||
slug: "image",
|
||||
title: "Image",
|
||||
description:
|
||||
"Generate OG images and social cards from json-render specs using Satori.",
|
||||
tags: ["React", "Image"],
|
||||
githubPath: "examples/image",
|
||||
demoUrl: "https://image-demo.json-render.dev",
|
||||
},
|
||||
{
|
||||
slug: "ink-chat",
|
||||
title: "Ink Chat",
|
||||
description:
|
||||
"Terminal chat agent that streams rich json-render UIs using Ink and the AI Gateway.",
|
||||
tags: ["Ink", "Terminal", "AI"],
|
||||
githubPath: "examples/ink-chat",
|
||||
},
|
||||
{
|
||||
slug: "mcp",
|
||||
title: "MCP App",
|
||||
description:
|
||||
"MCP server that serves shadcn UIs to Claude, ChatGPT, Cursor, and VS Code.",
|
||||
tags: ["React", "MCP", "Vite"],
|
||||
githubPath: "examples/mcp",
|
||||
},
|
||||
];
|
||||
|
||||
export const allTags = Array.from(
|
||||
new Set(examples.flatMap((e) => e.tags)),
|
||||
).sort();
|
||||
|
||||
export function getGitHubUrl(example: Example): string {
|
||||
return `${GITHUB_BASE}/${example.slug}`;
|
||||
}
|
||||
@@ -0,0 +1,39 @@
|
||||
import type { Metadata } from "next";
|
||||
import { PAGE_TITLES } from "./page-titles";
|
||||
|
||||
const DESCRIPTION =
|
||||
"The Generative UI framework. Generate dashboards, widgets, and apps from prompts — safely constrained to components you define.";
|
||||
|
||||
export function pageMetadata(slug: string): Metadata {
|
||||
const title = PAGE_TITLES[slug];
|
||||
if (!title) return {};
|
||||
|
||||
const displayTitle = title.replace(/\n/g, " ");
|
||||
const fullTitle = `${displayTitle} | json-render`;
|
||||
const ogImageUrl = slug ? `/og/${slug}` : "/og";
|
||||
|
||||
return {
|
||||
title: displayTitle,
|
||||
openGraph: {
|
||||
type: "website",
|
||||
locale: "en_US",
|
||||
siteName: "json-render",
|
||||
title: fullTitle,
|
||||
description: DESCRIPTION,
|
||||
images: [
|
||||
{
|
||||
url: ogImageUrl,
|
||||
width: 1200,
|
||||
height: 630,
|
||||
alt: `${displayTitle} - json-render`,
|
||||
},
|
||||
],
|
||||
},
|
||||
twitter: {
|
||||
card: "summary_large_image",
|
||||
title: fullTitle,
|
||||
description: DESCRIPTION,
|
||||
images: [ogImageUrl],
|
||||
},
|
||||
};
|
||||
}
|
||||
@@ -11,6 +11,7 @@ export const PAGE_TITLES: Record<string, string> = {
|
||||
|
||||
// Top-level
|
||||
playground: "Playground",
|
||||
examples: "Examples",
|
||||
|
||||
// Docs
|
||||
docs: "Introduction",
|
||||
@@ -23,7 +24,10 @@ export const PAGE_TITLES: Record<string, string> = {
|
||||
"docs/streaming": "Streaming",
|
||||
"docs/validation": "Validation",
|
||||
"docs/data-binding": "Data Binding",
|
||||
"docs/computed-values": "Computed Values",
|
||||
"docs/visibility": "Visibility",
|
||||
"docs/watchers": "Watchers",
|
||||
"docs/renderers": "Renderers",
|
||||
"docs/generation-modes": "Generation Modes",
|
||||
"docs/code-export": "Code Export",
|
||||
"docs/custom-schema": "Custom Schema & Renderer",
|
||||
@@ -34,13 +38,31 @@ export const PAGE_TITLES: Record<string, string> = {
|
||||
"docs/ag-ui": "AG-UI Integration",
|
||||
"docs/migration": "Migration Guide",
|
||||
"docs/changelog": "Changelog",
|
||||
"docs/skills": "Skills",
|
||||
|
||||
// API references
|
||||
"docs/api/core": "@json-render/core API",
|
||||
"docs/api/react": "@json-render/react API",
|
||||
"docs/api/next": "@json-render/next API",
|
||||
"docs/api/vue": "@json-render/vue API",
|
||||
"docs/api/solid": "@json-render/solid API",
|
||||
"docs/api/react-pdf": "@json-render/react-pdf API",
|
||||
"docs/api/react-email": "@json-render/react-email API",
|
||||
"docs/api/react-native": "@json-render/react-native API",
|
||||
"docs/api/svelte": "@json-render/svelte API",
|
||||
"docs/api/codegen": "@json-render/codegen API",
|
||||
"docs/api/image": "@json-render/image API",
|
||||
"docs/api/remotion": "@json-render/remotion API",
|
||||
"docs/api/shadcn": "@json-render/shadcn API",
|
||||
"docs/api/shadcn-svelte": "@json-render/shadcn-svelte API",
|
||||
"docs/api/mcp": "@json-render/mcp API",
|
||||
"docs/api/redux": "@json-render/redux API",
|
||||
"docs/api/zustand": "@json-render/zustand API",
|
||||
"docs/api/jotai": "@json-render/jotai API",
|
||||
"docs/api/react-three-fiber": "@json-render/react-three-fiber API",
|
||||
"docs/api/xstate": "@json-render/xstate API",
|
||||
"docs/api/ink": "@json-render/ink API",
|
||||
"docs/api/yaml": "@json-render/yaml API",
|
||||
};
|
||||
|
||||
/**
|
||||
|
||||
@@ -0,0 +1,76 @@
|
||||
import { readFile } from "fs/promises";
|
||||
import { join } from "path";
|
||||
import { docsNavigation } from "./docs-navigation";
|
||||
import { mdxToCleanMarkdown } from "./mdx-to-markdown";
|
||||
|
||||
export type IndexEntry = {
|
||||
title: string;
|
||||
href: string;
|
||||
section: string;
|
||||
content: string;
|
||||
};
|
||||
|
||||
let cached: IndexEntry[] | null = null;
|
||||
|
||||
function stripMarkdown(md: string): string {
|
||||
return (
|
||||
md
|
||||
// Remove fenced code blocks entirely
|
||||
.replace(/```[\s\S]*?```/g, "")
|
||||
// Remove inline code
|
||||
.replace(/`[^`]+`/g, "")
|
||||
// Remove markdown links, keep text
|
||||
.replace(/\[([^\]]+)\]\([^)]+\)/g, "$1")
|
||||
// Remove heading markers
|
||||
.replace(/^#{1,6}\s+/gm, "")
|
||||
// Remove bold/italic markers
|
||||
.replace(/\*{1,3}([^*]+)\*{1,3}/g, "$1")
|
||||
// Remove HTML tags
|
||||
.replace(/<[^>]+>/g, "")
|
||||
// Collapse whitespace
|
||||
.replace(/\n{3,}/g, "\n\n")
|
||||
.trim()
|
||||
);
|
||||
}
|
||||
|
||||
function mdxFileForSlug(slug: string): string {
|
||||
const docsRoot = join(process.cwd(), "app", "(main)", "docs");
|
||||
if (slug === "/docs") {
|
||||
return join(docsRoot, "page.mdx");
|
||||
}
|
||||
const rest = slug.replace(/^\/docs\/?/, "");
|
||||
return join(docsRoot, ...rest.split("/"), "page.mdx");
|
||||
}
|
||||
|
||||
export async function getSearchIndex(): Promise<IndexEntry[]> {
|
||||
if (cached) return cached;
|
||||
|
||||
const entries: IndexEntry[] = [];
|
||||
|
||||
for (const section of docsNavigation) {
|
||||
for (const item of section.items) {
|
||||
if (item.external) continue;
|
||||
try {
|
||||
const raw = await readFile(mdxFileForSlug(item.href), "utf-8");
|
||||
const md = mdxToCleanMarkdown(raw);
|
||||
const content = stripMarkdown(md);
|
||||
entries.push({
|
||||
title: item.title,
|
||||
href: item.href,
|
||||
section: section.title,
|
||||
content,
|
||||
});
|
||||
} catch {
|
||||
entries.push({
|
||||
title: item.title,
|
||||
href: item.href,
|
||||
section: section.title,
|
||||
content: "",
|
||||
});
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
cached = entries;
|
||||
return entries;
|
||||
}
|
||||
@@ -0,0 +1,155 @@
|
||||
import type { Spec, JsonPatch } from "@json-render/core";
|
||||
import { setByPath, getByPath, removeByPath } from "@json-render/core";
|
||||
|
||||
export function setSpecValue(
|
||||
newSpec: Spec,
|
||||
path: string,
|
||||
value: unknown,
|
||||
): void {
|
||||
if (path === "/root") {
|
||||
newSpec.root = value as string;
|
||||
return;
|
||||
}
|
||||
if (path === "/state") {
|
||||
newSpec.state = value as Record<string, unknown>;
|
||||
return;
|
||||
}
|
||||
if (path.startsWith("/state/")) {
|
||||
if (!newSpec.state) newSpec.state = {};
|
||||
setByPath(
|
||||
newSpec.state as Record<string, unknown>,
|
||||
path.slice("/state".length),
|
||||
value,
|
||||
);
|
||||
return;
|
||||
}
|
||||
if (path.startsWith("/elements/")) {
|
||||
const pathParts = path.slice("/elements/".length).split("/");
|
||||
const elementKey = pathParts[0];
|
||||
if (!elementKey) return;
|
||||
if (pathParts.length === 1) {
|
||||
if (value == null || typeof value !== "object") return;
|
||||
const el = value as Record<string, unknown>;
|
||||
newSpec.elements[elementKey] = {
|
||||
...el,
|
||||
type: typeof el.type === "string" ? el.type : "",
|
||||
props: el.props != null && typeof el.props === "object" ? el.props : {},
|
||||
children: Array.isArray(el.children) ? el.children : [],
|
||||
} as Spec["elements"][string];
|
||||
} else {
|
||||
const element = newSpec.elements[elementKey];
|
||||
if (element) {
|
||||
const newElement = { ...element };
|
||||
setByPath(
|
||||
newElement as unknown as Record<string, unknown>,
|
||||
"/" + pathParts.slice(1).join("/"),
|
||||
value,
|
||||
);
|
||||
newSpec.elements[elementKey] = newElement;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export function removeSpecValue(newSpec: Spec, path: string): void {
|
||||
if (path === "/state") {
|
||||
delete newSpec.state;
|
||||
return;
|
||||
}
|
||||
if (path.startsWith("/state/") && newSpec.state) {
|
||||
removeByPath(
|
||||
newSpec.state as Record<string, unknown>,
|
||||
path.slice("/state".length),
|
||||
);
|
||||
return;
|
||||
}
|
||||
if (path.startsWith("/elements/")) {
|
||||
const pathParts = path.slice("/elements/".length).split("/");
|
||||
const elementKey = pathParts[0];
|
||||
if (!elementKey) return;
|
||||
if (pathParts.length === 1) {
|
||||
delete newSpec.elements[elementKey];
|
||||
} else {
|
||||
const element = newSpec.elements[elementKey];
|
||||
if (element) {
|
||||
const newElement = { ...element };
|
||||
removeByPath(
|
||||
newElement as unknown as Record<string, unknown>,
|
||||
"/" + pathParts.slice(1).join("/"),
|
||||
);
|
||||
newSpec.elements[elementKey] = newElement;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export function getSpecValue(spec: Spec, path: string): unknown {
|
||||
if (path === "/root") return spec.root;
|
||||
if (path === "/state") return spec.state;
|
||||
if (path.startsWith("/state/") && spec.state) {
|
||||
return getByPath(
|
||||
spec.state as Record<string, unknown>,
|
||||
path.slice("/state".length),
|
||||
);
|
||||
}
|
||||
return getByPath(spec as unknown as Record<string, unknown>, path);
|
||||
}
|
||||
|
||||
export function normalizeSpec(spec: Spec): void {
|
||||
if (
|
||||
spec.state === null ||
|
||||
(spec.state !== undefined && typeof spec.state !== "object")
|
||||
) {
|
||||
spec.state = undefined;
|
||||
}
|
||||
|
||||
for (const key of Object.keys(spec.elements)) {
|
||||
const el = spec.elements[key];
|
||||
if (!el || typeof el !== "object") {
|
||||
delete spec.elements[key];
|
||||
continue;
|
||||
}
|
||||
if (el.props == null || typeof el.props !== "object") {
|
||||
spec.elements[key] = { ...el, props: {} } as Spec["elements"][string];
|
||||
}
|
||||
if (!Array.isArray(spec.elements[key]!.children)) {
|
||||
spec.elements[key] = {
|
||||
...spec.elements[key]!,
|
||||
children: [],
|
||||
} as Spec["elements"][string];
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export function applySpecPatch(spec: Spec, patch: JsonPatch): Spec {
|
||||
const newSpec = {
|
||||
...spec,
|
||||
elements: { ...spec.elements },
|
||||
...(spec.state ? { state: { ...spec.state } } : {}),
|
||||
};
|
||||
switch (patch.op) {
|
||||
case "add":
|
||||
case "replace":
|
||||
setSpecValue(newSpec, patch.path, patch.value);
|
||||
break;
|
||||
case "remove":
|
||||
removeSpecValue(newSpec, patch.path);
|
||||
break;
|
||||
case "move":
|
||||
if (patch.from) {
|
||||
const moveValue = getSpecValue(newSpec, patch.from);
|
||||
removeSpecValue(newSpec, patch.from);
|
||||
setSpecValue(newSpec, patch.path, moveValue);
|
||||
}
|
||||
break;
|
||||
case "copy":
|
||||
if (patch.from) {
|
||||
setSpecValue(newSpec, patch.path, getSpecValue(newSpec, patch.from));
|
||||
}
|
||||
break;
|
||||
case "test":
|
||||
break;
|
||||
}
|
||||
normalizeSpec(newSpec);
|
||||
return newSpec;
|
||||
}
|
||||
@@ -0,0 +1,482 @@
|
||||
"use client";
|
||||
|
||||
import { useState, useCallback, useRef, useEffect } from "react";
|
||||
import type { Spec, JsonPatch, EditMode } from "@json-render/core";
|
||||
import { deepMergeSpec, diffToPatches } from "@json-render/core";
|
||||
import { parse as yamlParse, stringify as yamlStringify } from "yaml";
|
||||
import { applyPatch as applyUnifiedDiff } from "diff";
|
||||
import {
|
||||
createYamlStreamCompiler,
|
||||
YAML_SPEC_FENCE,
|
||||
YAML_EDIT_FENCE,
|
||||
YAML_PATCH_FENCE,
|
||||
DIFF_FENCE,
|
||||
FENCE_CLOSE,
|
||||
} from "@json-render/yaml";
|
||||
import { applySpecPatch } from "./spec-patch";
|
||||
|
||||
export type StreamFormat = "jsonl" | "yaml";
|
||||
|
||||
export interface TokenUsage {
|
||||
promptTokens: number;
|
||||
completionTokens: number;
|
||||
totalTokens: number;
|
||||
cachedTokens: number;
|
||||
cacheWriteTokens: number;
|
||||
}
|
||||
|
||||
export interface UsePlaygroundStreamOptions {
|
||||
api: string;
|
||||
format: StreamFormat;
|
||||
editModes?: EditMode[];
|
||||
onError?: (error: Error) => void;
|
||||
onComplete?: (spec: Spec) => void;
|
||||
}
|
||||
|
||||
export interface UsePlaygroundStreamReturn {
|
||||
spec: Spec | null;
|
||||
isStreaming: boolean;
|
||||
error: Error | null;
|
||||
usage: TokenUsage | null;
|
||||
rawLines: string[];
|
||||
send: (prompt: string, context?: Record<string, unknown>) => Promise<void>;
|
||||
clear: () => void;
|
||||
}
|
||||
|
||||
// ── JSONL helpers ──
|
||||
|
||||
type ParsedLine =
|
||||
| { type: "patch"; patch: JsonPatch }
|
||||
| { type: "usage"; usage: TokenUsage }
|
||||
| { type: "json-edit"; mergeObj: Record<string, unknown> }
|
||||
| null;
|
||||
|
||||
function parseLine(line: string): ParsedLine {
|
||||
try {
|
||||
const trimmed = line.trim();
|
||||
if (!trimmed || trimmed.startsWith("//")) return null;
|
||||
const parsed = JSON.parse(trimmed);
|
||||
if (parsed.__meta === "usage") {
|
||||
return {
|
||||
type: "usage",
|
||||
usage: {
|
||||
promptTokens: parsed.promptTokens ?? 0,
|
||||
completionTokens: parsed.completionTokens ?? 0,
|
||||
totalTokens: parsed.totalTokens ?? 0,
|
||||
cachedTokens: parsed.cachedTokens ?? 0,
|
||||
cacheWriteTokens: parsed.cacheWriteTokens ?? 0,
|
||||
},
|
||||
};
|
||||
}
|
||||
if (parsed.__json_edit === true) {
|
||||
const mergeObj = { ...parsed };
|
||||
delete mergeObj.__json_edit;
|
||||
return { type: "json-edit", mergeObj };
|
||||
}
|
||||
return { type: "patch", patch: parsed as JsonPatch };
|
||||
} catch {
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
type FenceState = "outside" | "yaml-spec" | "yaml-edit" | "yaml-patch" | "diff";
|
||||
|
||||
// ── Hook ──
|
||||
|
||||
export function usePlaygroundStream({
|
||||
api,
|
||||
format,
|
||||
editModes,
|
||||
onError,
|
||||
onComplete,
|
||||
}: UsePlaygroundStreamOptions): UsePlaygroundStreamReturn {
|
||||
const [spec, setSpec] = useState<Spec | null>(null);
|
||||
const [isStreaming, setIsStreaming] = useState(false);
|
||||
const [error, setError] = useState<Error | null>(null);
|
||||
const [usage, setUsage] = useState<TokenUsage | null>(null);
|
||||
const [rawLines, setRawLines] = useState<string[]>([]);
|
||||
const rawLinesRef = useRef<string[]>([]);
|
||||
const abortControllerRef = useRef<AbortController | null>(null);
|
||||
|
||||
const onCompleteRef = useRef(onComplete);
|
||||
onCompleteRef.current = onComplete;
|
||||
const onErrorRef = useRef(onError);
|
||||
onErrorRef.current = onError;
|
||||
const formatRef = useRef(format);
|
||||
formatRef.current = format;
|
||||
const editModesRef = useRef(editModes);
|
||||
editModesRef.current = editModes;
|
||||
|
||||
const clear = useCallback(() => {
|
||||
setSpec(null);
|
||||
setError(null);
|
||||
}, []);
|
||||
|
||||
const send = useCallback(
|
||||
async (prompt: string, context?: Record<string, unknown>) => {
|
||||
abortControllerRef.current = new AbortController();
|
||||
|
||||
setIsStreaming(true);
|
||||
setError(null);
|
||||
setUsage(null);
|
||||
rawLinesRef.current = [];
|
||||
setRawLines([]);
|
||||
|
||||
const previousSpec = context?.previousSpec as Spec | undefined;
|
||||
let currentSpec: Spec =
|
||||
previousSpec && previousSpec.root
|
||||
? { ...previousSpec, elements: { ...previousSpec.elements } }
|
||||
: { root: "", elements: {} };
|
||||
setSpec(currentSpec);
|
||||
|
||||
try {
|
||||
const response = await fetch(api, {
|
||||
method: "POST",
|
||||
headers: { "Content-Type": "application/json" },
|
||||
body: JSON.stringify({
|
||||
prompt,
|
||||
context,
|
||||
format: formatRef.current,
|
||||
editModes: editModesRef.current,
|
||||
}),
|
||||
signal: abortControllerRef.current.signal,
|
||||
});
|
||||
|
||||
if (!response.ok) {
|
||||
let errorMessage = `HTTP error: ${response.status}`;
|
||||
try {
|
||||
const errorData = await response.json();
|
||||
if (errorData.message) errorMessage = errorData.message;
|
||||
else if (errorData.error) errorMessage = errorData.error;
|
||||
} catch {
|
||||
// use default
|
||||
}
|
||||
throw new Error(errorMessage);
|
||||
}
|
||||
|
||||
const reader = response.body?.getReader();
|
||||
if (!reader) throw new Error("No response body");
|
||||
|
||||
const decoder = new TextDecoder();
|
||||
let buffer = "";
|
||||
|
||||
if (formatRef.current === "yaml") {
|
||||
// ── YAML streaming ──
|
||||
let fenceState: FenceState = "outside";
|
||||
const compiler = createYamlStreamCompiler<Record<string, unknown>>();
|
||||
let yamlEditAccumulated = "";
|
||||
let yamlPatchAccumulated = "";
|
||||
let diffAccumulated = "";
|
||||
|
||||
while (true) {
|
||||
const { done, value } = await reader.read();
|
||||
if (done) break;
|
||||
|
||||
buffer += decoder.decode(value, { stream: true });
|
||||
const lines = buffer.split("\n");
|
||||
buffer = lines.pop() ?? "";
|
||||
|
||||
for (const line of lines) {
|
||||
const trimmed = line.trim();
|
||||
|
||||
// Check for usage metadata (appended after stream)
|
||||
if (trimmed.startsWith("{") && trimmed.includes('"__meta"')) {
|
||||
try {
|
||||
const parsed = JSON.parse(trimmed);
|
||||
if (parsed.__meta === "usage") {
|
||||
setUsage({
|
||||
promptTokens: parsed.promptTokens ?? 0,
|
||||
completionTokens: parsed.completionTokens ?? 0,
|
||||
totalTokens: parsed.totalTokens ?? 0,
|
||||
cachedTokens: parsed.cachedTokens ?? 0,
|
||||
cacheWriteTokens: parsed.cacheWriteTokens ?? 0,
|
||||
});
|
||||
continue;
|
||||
}
|
||||
} catch {
|
||||
// not JSON
|
||||
}
|
||||
}
|
||||
|
||||
rawLinesRef.current.push(line);
|
||||
|
||||
if (fenceState === "outside") {
|
||||
if (
|
||||
trimmed === YAML_SPEC_FENCE ||
|
||||
trimmed.startsWith(YAML_SPEC_FENCE + " ")
|
||||
) {
|
||||
fenceState = "yaml-spec";
|
||||
compiler.reset();
|
||||
} else if (
|
||||
trimmed === YAML_EDIT_FENCE ||
|
||||
trimmed.startsWith(YAML_EDIT_FENCE + " ")
|
||||
) {
|
||||
fenceState = "yaml-edit";
|
||||
yamlEditAccumulated = "";
|
||||
} else if (
|
||||
trimmed === YAML_PATCH_FENCE ||
|
||||
trimmed.startsWith(YAML_PATCH_FENCE + " ")
|
||||
) {
|
||||
fenceState = "yaml-patch";
|
||||
yamlPatchAccumulated = "";
|
||||
} else if (
|
||||
trimmed === DIFF_FENCE ||
|
||||
trimmed.startsWith(DIFF_FENCE + " ")
|
||||
) {
|
||||
fenceState = "diff";
|
||||
diffAccumulated = "";
|
||||
}
|
||||
} else if (trimmed === FENCE_CLOSE || trimmed === "````") {
|
||||
if (fenceState === "yaml-spec") {
|
||||
const { result, newPatches } = compiler.flush();
|
||||
if (result && typeof result === "object" && result.root) {
|
||||
for (const patch of newPatches) {
|
||||
currentSpec = applySpecPatch(currentSpec, patch);
|
||||
}
|
||||
setSpec({ ...currentSpec });
|
||||
}
|
||||
} else if (fenceState === "yaml-edit") {
|
||||
try {
|
||||
const editObj = yamlParse(yamlEditAccumulated);
|
||||
if (editObj && typeof editObj === "object") {
|
||||
const merged = deepMergeSpec(
|
||||
currentSpec as unknown as Record<string, unknown>,
|
||||
editObj as Record<string, unknown>,
|
||||
);
|
||||
const patches = diffToPatches(
|
||||
currentSpec as unknown as Record<string, unknown>,
|
||||
merged,
|
||||
);
|
||||
for (const patch of patches) {
|
||||
currentSpec = applySpecPatch(currentSpec, patch);
|
||||
}
|
||||
setSpec({ ...currentSpec });
|
||||
}
|
||||
} catch {
|
||||
// Invalid YAML edit
|
||||
}
|
||||
} else if (fenceState === "yaml-patch") {
|
||||
for (const patchLine of yamlPatchAccumulated.split("\n")) {
|
||||
const t = patchLine.trim();
|
||||
if (!t) continue;
|
||||
try {
|
||||
const patch = JSON.parse(t) as JsonPatch;
|
||||
if (patch.op) {
|
||||
currentSpec = applySpecPatch(currentSpec, patch);
|
||||
}
|
||||
} catch {
|
||||
// Skip invalid JSON lines
|
||||
}
|
||||
}
|
||||
setSpec({ ...currentSpec });
|
||||
} else if (fenceState === "diff") {
|
||||
try {
|
||||
const specYaml = yamlStringify(currentSpec, { indent: 2 });
|
||||
const patched = applyUnifiedDiff(specYaml, diffAccumulated);
|
||||
if (typeof patched === "string") {
|
||||
const parsed = yamlParse(patched);
|
||||
if (parsed && typeof parsed === "object") {
|
||||
const patches = diffToPatches(
|
||||
currentSpec as unknown as Record<string, unknown>,
|
||||
parsed as Record<string, unknown>,
|
||||
);
|
||||
for (const patch of patches) {
|
||||
currentSpec = applySpecPatch(currentSpec, patch);
|
||||
}
|
||||
setSpec({ ...currentSpec });
|
||||
}
|
||||
}
|
||||
} catch {
|
||||
// Diff apply or reparse failed
|
||||
}
|
||||
}
|
||||
fenceState = "outside";
|
||||
} else if (fenceState === "yaml-spec") {
|
||||
const { newPatches } = compiler.push(line + "\n");
|
||||
if (newPatches.length > 0) {
|
||||
for (const patch of newPatches) {
|
||||
currentSpec = applySpecPatch(currentSpec, patch);
|
||||
}
|
||||
setSpec({ ...currentSpec });
|
||||
}
|
||||
} else if (fenceState === "yaml-edit") {
|
||||
yamlEditAccumulated += line + "\n";
|
||||
} else if (fenceState === "yaml-patch") {
|
||||
yamlPatchAccumulated += line + "\n";
|
||||
} else if (fenceState === "diff") {
|
||||
diffAccumulated += line + "\n";
|
||||
}
|
||||
}
|
||||
setRawLines([...rawLinesRef.current]);
|
||||
}
|
||||
|
||||
// Process remaining buffer
|
||||
if (buffer.trim()) {
|
||||
const trimmed = buffer.trim();
|
||||
if (trimmed.startsWith("{") && trimmed.includes('"__meta"')) {
|
||||
try {
|
||||
const parsed = JSON.parse(trimmed);
|
||||
if (parsed.__meta === "usage") {
|
||||
setUsage({
|
||||
promptTokens: parsed.promptTokens ?? 0,
|
||||
completionTokens: parsed.completionTokens ?? 0,
|
||||
totalTokens: parsed.totalTokens ?? 0,
|
||||
cachedTokens: parsed.cachedTokens ?? 0,
|
||||
cacheWriteTokens: parsed.cacheWriteTokens ?? 0,
|
||||
});
|
||||
}
|
||||
} catch {
|
||||
// not JSON
|
||||
}
|
||||
} else if (fenceState === "yaml-spec") {
|
||||
compiler.push(buffer);
|
||||
const { result, newPatches } = compiler.flush();
|
||||
if (result && typeof result === "object" && result.root) {
|
||||
for (const patch of newPatches) {
|
||||
currentSpec = applySpecPatch(currentSpec, patch);
|
||||
}
|
||||
setSpec({ ...currentSpec });
|
||||
}
|
||||
}
|
||||
}
|
||||
} else {
|
||||
// ── JSONL streaming ──
|
||||
let jsonlDiffState: "outside" | "diff" = "outside";
|
||||
let jsonlDiffAccumulated = "";
|
||||
|
||||
while (true) {
|
||||
const { done, value } = await reader.read();
|
||||
if (done) break;
|
||||
|
||||
buffer += decoder.decode(value, { stream: true });
|
||||
const lines = buffer.split("\n");
|
||||
buffer = lines.pop() ?? "";
|
||||
|
||||
for (const line of lines) {
|
||||
const trimmed = line.trim();
|
||||
if (!trimmed) continue;
|
||||
|
||||
// Diff fence detection within JSONL mode
|
||||
if (jsonlDiffState === "outside") {
|
||||
if (
|
||||
trimmed === DIFF_FENCE ||
|
||||
trimmed.startsWith(DIFF_FENCE + " ")
|
||||
) {
|
||||
jsonlDiffState = "diff";
|
||||
jsonlDiffAccumulated = "";
|
||||
continue;
|
||||
}
|
||||
} else if (
|
||||
jsonlDiffState === "diff" &&
|
||||
(trimmed === FENCE_CLOSE || trimmed === "````")
|
||||
) {
|
||||
try {
|
||||
const specJson = JSON.stringify(currentSpec, null, 2);
|
||||
const patched = applyUnifiedDiff(
|
||||
specJson,
|
||||
jsonlDiffAccumulated,
|
||||
);
|
||||
if (typeof patched === "string") {
|
||||
const parsed = JSON.parse(patched);
|
||||
if (parsed && typeof parsed === "object") {
|
||||
const patches = diffToPatches(
|
||||
currentSpec as unknown as Record<string, unknown>,
|
||||
parsed as Record<string, unknown>,
|
||||
);
|
||||
for (const patch of patches) {
|
||||
currentSpec = applySpecPatch(currentSpec, patch);
|
||||
}
|
||||
setSpec({ ...currentSpec });
|
||||
}
|
||||
}
|
||||
} catch {
|
||||
// Diff apply failed
|
||||
}
|
||||
jsonlDiffState = "outside";
|
||||
continue;
|
||||
}
|
||||
|
||||
if (jsonlDiffState === "diff") {
|
||||
jsonlDiffAccumulated += line + "\n";
|
||||
rawLinesRef.current.push(line);
|
||||
continue;
|
||||
}
|
||||
|
||||
// Standard JSONL line parsing
|
||||
const result = parseLine(trimmed);
|
||||
if (!result) continue;
|
||||
if (result.type === "usage") {
|
||||
setUsage(result.usage);
|
||||
} else if (result.type === "json-edit") {
|
||||
const merged = deepMergeSpec(
|
||||
currentSpec as unknown as Record<string, unknown>,
|
||||
result.mergeObj,
|
||||
);
|
||||
const patches = diffToPatches(
|
||||
currentSpec as unknown as Record<string, unknown>,
|
||||
merged,
|
||||
);
|
||||
for (const patch of patches) {
|
||||
currentSpec = applySpecPatch(currentSpec, patch);
|
||||
}
|
||||
rawLinesRef.current.push(trimmed);
|
||||
setSpec({ ...currentSpec });
|
||||
} else {
|
||||
rawLinesRef.current.push(trimmed);
|
||||
currentSpec = applySpecPatch(currentSpec, result.patch);
|
||||
setSpec({ ...currentSpec });
|
||||
}
|
||||
}
|
||||
setRawLines([...rawLinesRef.current]);
|
||||
}
|
||||
|
||||
if (buffer.trim()) {
|
||||
const trimmed = buffer.trim();
|
||||
const result = parseLine(trimmed);
|
||||
if (result) {
|
||||
if (result.type === "usage") {
|
||||
setUsage(result.usage);
|
||||
} else if (result.type === "json-edit") {
|
||||
const merged = deepMergeSpec(
|
||||
currentSpec as unknown as Record<string, unknown>,
|
||||
result.mergeObj,
|
||||
);
|
||||
const patches = diffToPatches(
|
||||
currentSpec as unknown as Record<string, unknown>,
|
||||
merged,
|
||||
);
|
||||
for (const patch of patches) {
|
||||
currentSpec = applySpecPatch(currentSpec, patch);
|
||||
}
|
||||
rawLinesRef.current.push(trimmed);
|
||||
setSpec({ ...currentSpec });
|
||||
} else {
|
||||
rawLinesRef.current.push(trimmed);
|
||||
currentSpec = applySpecPatch(currentSpec, result.patch);
|
||||
setSpec({ ...currentSpec });
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
onCompleteRef.current?.(currentSpec);
|
||||
} catch (err) {
|
||||
if ((err as Error).name === "AbortError") return;
|
||||
const error = err instanceof Error ? err : new Error(String(err));
|
||||
setError(error);
|
||||
onErrorRef.current?.(error);
|
||||
} finally {
|
||||
setIsStreaming(false);
|
||||
}
|
||||
},
|
||||
[api],
|
||||
);
|
||||
|
||||
useEffect(() => {
|
||||
return () => {
|
||||
abortControllerRef.current?.abort();
|
||||
};
|
||||
}, []);
|
||||
|
||||
return { spec, isStreaming, error, usage, rawLines, send, clear };
|
||||
}
|
||||
@@ -35,16 +35,26 @@ export function useMDXComponents(components: MDXComponents): MDXComponents {
|
||||
h2: ({ children }: { children?: React.ReactNode }) => {
|
||||
const id = slugify(extractText(children));
|
||||
return (
|
||||
<h2 id={id} className="text-xl font-semibold mt-12 mb-4">
|
||||
{children}
|
||||
<h2 id={id} className="group text-xl font-semibold mt-12 mb-4">
|
||||
<a href={`#${id}`} className="no-underline hover:no-underline">
|
||||
{children}
|
||||
<span className="ml-2 text-muted-foreground/0 group-hover:text-muted-foreground transition-colors select-none">
|
||||
#
|
||||
</span>
|
||||
</a>
|
||||
</h2>
|
||||
);
|
||||
},
|
||||
h3: ({ children }: { children?: React.ReactNode }) => {
|
||||
const id = slugify(extractText(children));
|
||||
return (
|
||||
<h3 id={id} className="text-lg font-medium mt-8 mb-3">
|
||||
{children}
|
||||
<h3 id={id} className="group text-lg font-medium mt-8 mb-3">
|
||||
<a href={`#${id}`} className="no-underline hover:no-underline">
|
||||
{children}
|
||||
<span className="ml-2 text-muted-foreground/0 group-hover:text-muted-foreground transition-colors select-none">
|
||||
#
|
||||
</span>
|
||||
</a>
|
||||
</h3>
|
||||
);
|
||||
},
|
||||
|
||||
+11
-6
@@ -1,11 +1,12 @@
|
||||
{
|
||||
"name": "web",
|
||||
"version": "0.1.0",
|
||||
"version": "0.1.11",
|
||||
"type": "module",
|
||||
"private": true,
|
||||
"license": "Apache-2.0",
|
||||
"scripts": {
|
||||
"dev": "next dev --turbopack",
|
||||
"predev": "command -v portless >/dev/null 2>&1 || (echo '\\nportless is required but not installed. Run: npm i -g portless\\nSee: https://github.com/vercel-labs/portless\\n' && exit 1)",
|
||||
"dev": "portless json-render next dev --turbopack",
|
||||
"build": "next build",
|
||||
"start": "next start",
|
||||
"lint": "eslint --max-warnings 0",
|
||||
@@ -17,6 +18,7 @@
|
||||
"@json-render/codegen": "workspace:*",
|
||||
"@json-render/core": "workspace:*",
|
||||
"@json-render/react": "workspace:*",
|
||||
"@json-render/yaml": "workspace:*",
|
||||
"@mdx-js/loader": "^3.1.1",
|
||||
"@mdx-js/mdx": "^3.1.1",
|
||||
"@mdx-js/react": "^3.1.1",
|
||||
@@ -28,12 +30,14 @@
|
||||
"@upstash/redis": "^1.36.1",
|
||||
"@vercel/analytics": "^1.6.1",
|
||||
"@vercel/speed-insights": "^1.3.1",
|
||||
"@visual-json/react": "0.1.1",
|
||||
"ai": "^6.0.33",
|
||||
"bash-tool": "1.3.14",
|
||||
"class-variance-authority": "^0.7.1",
|
||||
"clsx": "^2.1.1",
|
||||
"diff": "^8.0.3",
|
||||
"embla-carousel-react": "^8.6.0",
|
||||
"just-bash": "2.9.6",
|
||||
"geist": "1.7.0",
|
||||
"lucide-react": "^0.562.0",
|
||||
"next": "16.1.1",
|
||||
"next-themes": "^0.4.6",
|
||||
@@ -48,11 +52,12 @@
|
||||
"tailwind-merge": "^3.4.0",
|
||||
"unist-util-visit": "5.1.0",
|
||||
"vaul": "^1.1.2",
|
||||
"zod": "^4.0.0"
|
||||
"yaml": "^2.8.2",
|
||||
"zod": "^4.3.6"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@repo/eslint-config": "workspace:*",
|
||||
"@repo/typescript-config": "workspace:*",
|
||||
"@internal/eslint-config": "workspace:*",
|
||||
"@internal/typescript-config": "workspace:*",
|
||||
"@tailwindcss/postcss": "^4.1.18",
|
||||
"@types/mdx": "^2.0.13",
|
||||
"@types/node": "^22.15.3",
|
||||
|
||||
Binary file not shown.
@@ -1,5 +1,5 @@
|
||||
{
|
||||
"extends": "@repo/typescript-config/nextjs.json",
|
||||
"extends": "@internal/typescript-config/nextjs.json",
|
||||
"compilerOptions": {
|
||||
"plugins": [
|
||||
{
|
||||
|
||||
@@ -0,0 +1,15 @@
|
||||
# Vercel AI Gateway
|
||||
# Automatically authenticated when deployed on Vercel
|
||||
# For local development, get your key from https://vercel.com/ai-gateway
|
||||
AI_GATEWAY_API_KEY=
|
||||
|
||||
# AI Model Configuration
|
||||
# Default: anthropic/claude-haiku-4.5
|
||||
AI_GATEWAY_MODEL=anthropic/claude-haiku-4.5
|
||||
|
||||
# Rate Limiting (Upstash Redis)
|
||||
# Optional - rate limiting is disabled when these are not set
|
||||
KV_REST_API_URL=
|
||||
KV_REST_API_TOKEN=
|
||||
RATE_LIMIT_PER_MINUTE=10
|
||||
RATE_LIMIT_PER_DAY=100
|
||||
@@ -0,0 +1,100 @@
|
||||
# example-chat
|
||||
|
||||
## 0.1.11
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [519a538]
|
||||
- @json-render/core@0.16.0
|
||||
- @json-render/react@0.16.0
|
||||
- @json-render/shadcn@0.16.0
|
||||
|
||||
## 0.1.10
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [bf3a7ec]
|
||||
- @json-render/core@0.15.0
|
||||
- @json-render/react@0.15.0
|
||||
- @json-render/shadcn@0.15.0
|
||||
|
||||
## 0.1.9
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [43b7515]
|
||||
- @json-render/core@0.14.1
|
||||
- @json-render/react@0.14.1
|
||||
- @json-render/shadcn@0.14.1
|
||||
|
||||
## 0.1.8
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [a8afd8b]
|
||||
- @json-render/core@0.14.0
|
||||
- @json-render/react@0.14.0
|
||||
- @json-render/shadcn@0.14.0
|
||||
|
||||
## 0.1.7
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [5b32de8]
|
||||
- @json-render/core@0.13.0
|
||||
- @json-render/react@0.13.0
|
||||
- @json-render/shadcn@0.13.0
|
||||
|
||||
## 0.1.6
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [54a1ecf]
|
||||
- @json-render/core@0.12.1
|
||||
- @json-render/react@0.12.1
|
||||
- @json-render/shadcn@0.12.1
|
||||
|
||||
## 0.1.5
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [63c339b]
|
||||
- @json-render/core@0.12.0
|
||||
- @json-render/react@0.12.0
|
||||
- @json-render/shadcn@0.12.0
|
||||
|
||||
## 0.1.4
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [3f1e71e]
|
||||
- @json-render/core@0.11.0
|
||||
- @json-render/react@0.11.0
|
||||
- @json-render/shadcn@0.11.0
|
||||
|
||||
## 0.1.3
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [9cef4e9]
|
||||
- @json-render/core@0.10.0
|
||||
- @json-render/react@0.10.0
|
||||
- @json-render/shadcn@0.10.0
|
||||
|
||||
## 0.1.2
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [b103676]
|
||||
- @json-render/react@0.9.1
|
||||
- @json-render/shadcn@0.9.1
|
||||
- @json-render/core@0.9.1
|
||||
|
||||
## 0.1.1
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [1d755c1]
|
||||
- @json-render/core@0.9.0
|
||||
- @json-render/react@0.9.0
|
||||
- @json-render/shadcn@0.9.0
|
||||
@@ -1,4 +1,5 @@
|
||||
import { agent } from "@/lib/agent";
|
||||
import { minuteRateLimit, dailyRateLimit } from "@/lib/rate-limit";
|
||||
import {
|
||||
convertToModelMessages,
|
||||
createUIMessageStream,
|
||||
@@ -6,10 +7,35 @@ import {
|
||||
type UIMessage,
|
||||
} from "ai";
|
||||
import { pipeJsonRender } from "@json-render/core";
|
||||
import { headers } from "next/headers";
|
||||
|
||||
export const maxDuration = 60;
|
||||
|
||||
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 body = await req.json();
|
||||
const uiMessages: UIMessage[] = body.messages;
|
||||
|
||||
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 16 KiB |
@@ -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 [
|
||||
|
||||
@@ -130,7 +130,7 @@ When the user asks for a quiz, test, or Q&A, build an interactive experience:
|
||||
4. You can also add a final score section that becomes visible when all questions are submitted.
|
||||
|
||||
${explorerCatalog.prompt({
|
||||
mode: "chat",
|
||||
mode: "inline",
|
||||
customRules: [
|
||||
"NEVER use viewport height classes (min-h-screen, h-screen) — the UI renders inside a fixed-size container.",
|
||||
"Prefer Grid with columns='2' or columns='3' for side-by-side layouts.",
|
||||
|
||||
@@ -0,0 +1,57 @@
|
||||
import { Ratelimit } from "@upstash/ratelimit";
|
||||
import { Redis } from "@upstash/redis";
|
||||
|
||||
// Lazy initialization to avoid errors when Redis env vars are not configured
|
||||
let _minuteRateLimit: Ratelimit | null = null;
|
||||
let _dailyRateLimit: Ratelimit | null = null;
|
||||
|
||||
function getRedis(): Redis | null {
|
||||
const url = process.env.KV_REST_API_URL;
|
||||
const token = process.env.KV_REST_API_TOKEN;
|
||||
|
||||
if (!url || !token) {
|
||||
return null;
|
||||
}
|
||||
|
||||
return new Redis({ url, token });
|
||||
}
|
||||
|
||||
// No-op rate limiter for when Redis is not configured
|
||||
const noopRateLimiter = {
|
||||
limit: async () => ({ success: true, limit: 0, remaining: 0, reset: 0 }),
|
||||
};
|
||||
|
||||
const MINUTE_LIMIT = Number(process.env.RATE_LIMIT_PER_MINUTE) || 10;
|
||||
const DAILY_LIMIT = Number(process.env.RATE_LIMIT_PER_DAY) || 100;
|
||||
|
||||
// Requests per minute (sliding window)
|
||||
export const minuteRateLimit = {
|
||||
limit: async (identifier: string) => {
|
||||
if (!_minuteRateLimit) {
|
||||
const redis = getRedis();
|
||||
if (!redis) return noopRateLimiter.limit();
|
||||
_minuteRateLimit = new Ratelimit({
|
||||
redis,
|
||||
limiter: Ratelimit.slidingWindow(MINUTE_LIMIT, "1 m"),
|
||||
prefix: "ratelimit:chat:minute",
|
||||
});
|
||||
}
|
||||
return _minuteRateLimit.limit(identifier);
|
||||
},
|
||||
};
|
||||
|
||||
// Requests per day (fixed window)
|
||||
export const dailyRateLimit = {
|
||||
limit: async (identifier: string) => {
|
||||
if (!_dailyRateLimit) {
|
||||
const redis = getRedis();
|
||||
if (!redis) return noopRateLimiter.limit();
|
||||
_dailyRateLimit = new Ratelimit({
|
||||
redis,
|
||||
limiter: Ratelimit.fixedWindow(DAILY_LIMIT, "1 d"),
|
||||
prefix: "ratelimit:chat:daily",
|
||||
});
|
||||
}
|
||||
return _dailyRateLimit.limit(identifier);
|
||||
},
|
||||
};
|
||||
Vendored
+1
-1
@@ -1,6 +1,6 @@
|
||||
/// <reference types="next" />
|
||||
/// <reference types="next/image-types/global" />
|
||||
import "./.next/types/routes.d.ts";
|
||||
import "./.next/dev/types/routes.d.ts";
|
||||
|
||||
// NOTE: This file should not be edited
|
||||
// see https://nextjs.org/docs/app/api-reference/config/typescript for more information.
|
||||
|
||||
@@ -1,10 +1,11 @@
|
||||
{
|
||||
"name": "example-chat",
|
||||
"version": "0.1.0",
|
||||
"version": "0.1.11",
|
||||
"type": "module",
|
||||
"private": true,
|
||||
"scripts": {
|
||||
"dev": "next dev --turbopack",
|
||||
"predev": "command -v portless >/dev/null 2>&1 || (echo '\\nportless is required but not installed. Run: npm i -g portless\\nSee: https://github.com/vercel-labs/portless\\n' && exit 1)",
|
||||
"dev": "portless chat-demo.json-render next dev --turbopack",
|
||||
"build": "next build",
|
||||
"start": "next start",
|
||||
"lint": "eslint --max-warnings 0",
|
||||
@@ -33,10 +34,12 @@
|
||||
"streamdown": "^2.2.0",
|
||||
"tailwind-merge": "^3.4.0",
|
||||
"three": "^0.182.0",
|
||||
"zod": "4.3.5"
|
||||
"@upstash/ratelimit": "^2.0.8",
|
||||
"@upstash/redis": "^1.37.0",
|
||||
"zod": "4.3.6"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@repo/eslint-config": "workspace:*",
|
||||
"@internal/eslint-config": "workspace:*",
|
||||
"@tailwindcss/postcss": "^4.1.18",
|
||||
"@types/node": "^22.10.0",
|
||||
"@types/react": "19.2.3",
|
||||
|
||||
@@ -4,3 +4,10 @@ DATABASE_URL=postgresql://postgres:postgres@localhost:5432/json_render_dashboard
|
||||
# AI (optional - for UI generation)
|
||||
AI_GATEWAY_API_KEY=
|
||||
AI_GATEWAY_MODEL=anthropic/claude-haiku-4.5
|
||||
|
||||
# Rate Limiting (Upstash Redis)
|
||||
# Optional - rate limiting is disabled when these are not set
|
||||
KV_REST_API_URL=
|
||||
KV_REST_API_TOKEN=
|
||||
RATE_LIMIT_PER_MINUTE=10
|
||||
RATE_LIMIT_PER_DAY=100
|
||||
|
||||
@@ -0,0 +1,100 @@
|
||||
# example-dashboard
|
||||
|
||||
## 0.1.11
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [519a538]
|
||||
- @json-render/core@0.16.0
|
||||
- @json-render/codegen@0.16.0
|
||||
- @json-render/react@0.16.0
|
||||
|
||||
## 0.1.10
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [bf3a7ec]
|
||||
- @json-render/core@0.15.0
|
||||
- @json-render/codegen@0.15.0
|
||||
- @json-render/react@0.15.0
|
||||
|
||||
## 0.1.9
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [43b7515]
|
||||
- @json-render/core@0.14.1
|
||||
- @json-render/codegen@0.14.1
|
||||
- @json-render/react@0.14.1
|
||||
|
||||
## 0.1.8
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [a8afd8b]
|
||||
- @json-render/core@0.14.0
|
||||
- @json-render/codegen@0.14.0
|
||||
- @json-render/react@0.14.0
|
||||
|
||||
## 0.1.7
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [5b32de8]
|
||||
- @json-render/core@0.13.0
|
||||
- @json-render/codegen@0.13.0
|
||||
- @json-render/react@0.13.0
|
||||
|
||||
## 0.1.6
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [54a1ecf]
|
||||
- @json-render/core@0.12.1
|
||||
- @json-render/codegen@0.12.1
|
||||
- @json-render/react@0.12.1
|
||||
|
||||
## 0.1.5
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [63c339b]
|
||||
- @json-render/core@0.12.0
|
||||
- @json-render/codegen@0.12.0
|
||||
- @json-render/react@0.12.0
|
||||
|
||||
## 0.1.4
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [3f1e71e]
|
||||
- @json-render/core@0.11.0
|
||||
- @json-render/codegen@0.11.0
|
||||
- @json-render/react@0.11.0
|
||||
|
||||
## 0.1.3
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [9cef4e9]
|
||||
- @json-render/core@0.10.0
|
||||
- @json-render/react@0.10.0
|
||||
- @json-render/codegen@0.10.0
|
||||
|
||||
## 0.1.2
|
||||
|
||||
### Patch Changes
|
||||
|
||||
- Updated dependencies [b103676]
|
||||
- @json-render/react@0.9.1
|
||||
- @json-render/core@0.9.1
|
||||
- @json-render/codegen@0.9.1
|
||||
|
||||
## 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,6 +1,8 @@
|
||||
import { streamText } from "ai";
|
||||
import { buildUserPrompt } from "@json-render/core";
|
||||
import { dashboardCatalog } from "@/lib/render/catalog";
|
||||
import { minuteRateLimit, dailyRateLimit } from "@/lib/rate-limit";
|
||||
import { headers } from "next/headers";
|
||||
|
||||
export const maxDuration = 30;
|
||||
|
||||
@@ -9,6 +11,30 @@ const SYSTEM_PROMPT = dashboardCatalog.prompt();
|
||||
const DEFAULT_MODEL = "anthropic/claude-haiku-4.5";
|
||||
|
||||
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 { prompt, context } = await req.json();
|
||||
|
||||
const userPrompt = buildUserPrompt({
|
||||
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 19 KiB |
@@ -196,24 +196,28 @@ export function Widget({
|
||||
onDeleted?.();
|
||||
}, [widgetId, onDeleted]);
|
||||
|
||||
const handleStateChange = useCallback((path: string, value: unknown) => {
|
||||
setState((prev) => {
|
||||
const next = { ...prev };
|
||||
// Convert path like "customerForm/name" to nested object
|
||||
const parts = path.split("/");
|
||||
let current: Record<string, unknown> = next;
|
||||
for (let i = 0; i < parts.length - 1; i++) {
|
||||
const part = parts[i]!;
|
||||
if (!(part in current) || typeof current[part] !== "object") {
|
||||
current[part] = {};
|
||||
const handleStateChange = useCallback(
|
||||
(changes: Array<{ path: string; value: unknown }>) => {
|
||||
setState((prev) => {
|
||||
const next = { ...prev };
|
||||
for (const { path, value } of changes) {
|
||||
const parts = path.split("/");
|
||||
let current: Record<string, unknown> = next;
|
||||
for (let i = 0; i < parts.length - 1; i++) {
|
||||
const part = parts[i]!;
|
||||
if (!(part in current) || typeof current[part] !== "object") {
|
||||
current[part] = {};
|
||||
}
|
||||
current = current[part] as Record<string, unknown>;
|
||||
}
|
||||
const lastPart = parts[parts.length - 1]!;
|
||||
current[lastPart] = value;
|
||||
}
|
||||
current = current[part] as Record<string, unknown>;
|
||||
}
|
||||
const lastPart = parts[parts.length - 1]!;
|
||||
current[lastPart] = value;
|
||||
return next;
|
||||
});
|
||||
}, []);
|
||||
return next;
|
||||
});
|
||||
},
|
||||
[],
|
||||
);
|
||||
|
||||
// Use spec from stream, or initial spec for saved widgets
|
||||
const currentSpec = spec || initialSpec;
|
||||
|
||||
@@ -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 [
|
||||
|
||||
@@ -0,0 +1,57 @@
|
||||
import { Ratelimit } from "@upstash/ratelimit";
|
||||
import { Redis } from "@upstash/redis";
|
||||
|
||||
// Lazy initialization to avoid errors when Redis env vars are not configured
|
||||
let _minuteRateLimit: Ratelimit | null = null;
|
||||
let _dailyRateLimit: Ratelimit | null = null;
|
||||
|
||||
function getRedis(): Redis | null {
|
||||
const url = process.env.KV_REST_API_URL;
|
||||
const token = process.env.KV_REST_API_TOKEN;
|
||||
|
||||
if (!url || !token) {
|
||||
return null;
|
||||
}
|
||||
|
||||
return new Redis({ url, token });
|
||||
}
|
||||
|
||||
// No-op rate limiter for when Redis is not configured
|
||||
const noopRateLimiter = {
|
||||
limit: async () => ({ success: true, limit: 0, remaining: 0, reset: 0 }),
|
||||
};
|
||||
|
||||
const MINUTE_LIMIT = Number(process.env.RATE_LIMIT_PER_MINUTE) || 10;
|
||||
const DAILY_LIMIT = Number(process.env.RATE_LIMIT_PER_DAY) || 100;
|
||||
|
||||
// Requests per minute (sliding window)
|
||||
export const minuteRateLimit = {
|
||||
limit: async (identifier: string) => {
|
||||
if (!_minuteRateLimit) {
|
||||
const redis = getRedis();
|
||||
if (!redis) return noopRateLimiter.limit();
|
||||
_minuteRateLimit = new Ratelimit({
|
||||
redis,
|
||||
limiter: Ratelimit.slidingWindow(MINUTE_LIMIT, "1 m"),
|
||||
prefix: "ratelimit:dashboard:minute",
|
||||
});
|
||||
}
|
||||
return _minuteRateLimit.limit(identifier);
|
||||
},
|
||||
};
|
||||
|
||||
// Requests per day (fixed window)
|
||||
export const dailyRateLimit = {
|
||||
limit: async (identifier: string) => {
|
||||
if (!_dailyRateLimit) {
|
||||
const redis = getRedis();
|
||||
if (!redis) return noopRateLimiter.limit();
|
||||
_dailyRateLimit = new Ratelimit({
|
||||
redis,
|
||||
limiter: Ratelimit.fixedWindow(DAILY_LIMIT, "1 d"),
|
||||
prefix: "ratelimit:dashboard:daily",
|
||||
});
|
||||
}
|
||||
return _dailyRateLimit.limit(identifier);
|
||||
},
|
||||
};
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user