Skip to content

docs(next): wire routes through getPageData and a client renderer #388

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Closed
xiehuanyi wants to merge 2 commits into from
Closed

docs(next): wire routes through getPageData and a client renderer #388

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4b16828
docs(next): wire routes through getPageData and a client renderer
xiehuanyi Oct 6, 2026
2df2cfc
docs(next): keep provider handlers inside a client boundary
xiehuanyi Oct 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 33 additions & 3 deletions packages/next/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,10 @@ npm install @json-render/core @json-render/react @json-render/next
### 1. Define your application spec

```typescript
// lib/spec.ts
import type { NextAppSpec } from "@json-render/next";

const spec: NextAppSpec = {
export const spec: NextAppSpec = {
metadata: {
title: { default: "My App", template: "%s | My App" },
},
Expand Down Expand Up @@ -49,19 +50,48 @@ const spec: NextAppSpec = {
```typescript
// lib/app.ts
import { createNextApp } from "@json-render/next/server";
import { spec } from "./spec";

export const { Page, generateMetadata, generateStaticParams } = createNextApp({ spec });
export const { getPageData, generateMetadata, generateStaticParams } = createNextApp({ spec });
```

### 3. Wire up Next.js routes

```tsx
// app/[[...slug]]/page.tsx
export { Page as default, generateMetadata, generateStaticParams } from "@/lib/app";
import { notFound } from "next/navigation";
import { getPageData } from "@/lib/app";
import { SiteRenderer } from "./renderer";

export { generateMetadata, generateStaticParams } from "@/lib/app";

export default async function Page({
params,
}: {
params: Promise<{ slug?: string[] }>;
}) {
const data = await getPageData({ params });
if (!data) notFound();
return <SiteRenderer {...data} />;
}
```

```tsx
// app/[[...slug]]/renderer.tsx
"use client";

import { PageRenderer } from "@json-render/next";
import type { PageRendererProps } from "@json-render/next";

export function SiteRenderer(props: PageRendererProps) {
return <PageRenderer {...props} />;
}
```

```tsx
// app/[[...slug]]/layout.tsx
"use client";

import { NextAppProvider } from "@json-render/next";
import { registry, handlers } from "@/lib/registry";

Expand Down