About
An API endpoint or tool input as a readable typed tree, with path parameters, required fields, allowed values and defaults.
Built with React and Tailwind. Copy the prompt and paste it into Claude Code, Cursor or Lovable: your agent adds Schema Display to your project and fits it to your theme.
Code
How Schema Display is used: the demo's code. The component's own source comes with a free account.
Usage.tsx
"use client"
import * as React from "react"
import { SchemaDisplay, SchemaDisplayProps } from "@/components/ui/schema-display"
const reducedMotion = () =>
typeof window !== "undefined" && window.matchMedia("(prefers-reduced-motion: reduce)").matches
/** How long a choice holds a tour before it carries on. */
const RESUME_MS = 1800
/**
* Steps through `values` on a timer, so a 21st preview (and its cover video) shows every option
* without a click. Picking a value holds it, and the tour carries on from there after
* `RESUME_MS`, so a click never leaves the preview still. Reduced motion never starts it.
*/
function useCycle<T>(values: readonly T[], ms: number) {
const [index, setIndex] = React.useState(0)
const [heldAt, setHeldAt] = React.useState(0)
React.useEffect(() => {
if (reducedMotion()) return
let id = 0
const start = () => {
id = window.setInterval(() => setIndex((n) => (n + 1) % values.length), ms)
}
const wait = window.setTimeout(start, heldAt ? RESUME_MS : 0)
return () => {
window.clearTimeout(wait)
window.clearInterval(id)
}
}, [heldAt, values.length, ms])
const pick = React.useCallback(
(value: T) => {
setHeldAt(Date.now())
setIndex(Math.max(0, values.indexOf(value)))
},
[values],
)
return [values[index] as T, pick] as const
}
/** Three calls an agent makes against a billing API, read before it makes each one. */
const ENDPOINTS: SchemaDisplayProps[] = [
{
method: "POST",
path: "/v1/invoices",
description: "Create a draft invoice. It is not sent until you finalize it.",
requestBody: {
type: "object",
required: ["customer", "currency"],
properties: {
customer: { type: "string", description: "Starts with cus_." },
currency: { type: "string", enum: ["eur", "gbp", "usd"] },
due_days: { type: "integer", default: 30 },
},
},
responseBody: {
type: "object",
properties: {
id: { type: "string", description: "Starts with inv_." },
status: { type: "string", enum: ["draft", "open", "paid", "void"] },
},
},
},
{
method: "GET",
path: "/v1/invoices/{invoice_id}",
description: "Read one invoice with its lines and payment status.",
parameters: [
{ name: "invoice_id", in: "path", required: true, schema: { type: "string" } },
{
name: "expand",
in: "query",
schema: { type: "string", enum: ["lines", "customer"] },
},
],
responseBody: {
type: "object",
properties: {
id: { type: "string" },
total: { type: "integer", description: "In cents, so 12.50 euros is 1250." },
paid_at: { type: "string", format: "date-time", nullable: true },
status: { type: "string", enum: ["draft", "open", "paid", "void"] },
},
},
},
{
method: "DELETE",
path: "/v1/invoices/{invoice_id}",
description: "Delete a draft. Finalized invoices can only be voided.",
parameters: [
{ name: "invoice_id", in: "path", required: true, schema: { type: "string" } },
{
name: "Idempotency-Key",
in: "header",
schema: { type: "string", description: "A retry with the same key does nothing twice." },
},
],
responseBody: {
type: "object",
properties: {
id: { type: "string", description: "The draft that was deleted." },
deleted: { type: "boolean", description: "Always true. A failed delete returns an error." },
},
},
},
]
const FIT_CSS = "html,body{overflow:hidden}[data-fit-small] [data-fit-hide]{display:none!important}"
/**
* 21st shows a demo in a small frame: about 674 by 421 on a component page, 358 by 224 on a
* phone and 245 by 139 on a profile card. A demo taller than its frame gets scrollbars, which
* render white on dark pages. FitFrame fills the frame exactly instead.
*
* - "scale": the content shrinks until it fits, centered. For visuals such as orbs.
* - "crop": the content stays at full size from the top and fades out at the bottom. For text
* that streams in, where a changing scale would make the page breathe.
*
* `minWidth` lays out a wide demo (a table, a two column panel) at that width and scales it down
* to the frame, instead of letting it collapse to a narrow layout. The frame centers it, so it
* shrinks evenly on both sides.
*
* Anything marked `data-fit-hide` (state buttons, the chatcn.dev line) drops out in frames
* shorter than `hideBelow`, so a profile card shows the visual alone.
*/
function FitFrame({
children,
mode = "scale",
hideBelow = 360,
minWidth,
}: {
children: React.ReactNode
mode?: "scale" | "crop"
hideBelow?: number
minWidth?: string
}) {
const content = React.useRef<HTMLDivElement>(null)
const [cropped, setCropped] = React.useState(false)
React.useLayoutEffect(() => {
const el = content.current
if (!el) return
const measure = () => {
const vw = window.innerWidth
const vh = window.innerHeight
el.toggleAttribute("data-fit-small", vh < hideBelow)
// Layout sizes ignore the transform, so measuring never feeds back.
const w = Math.max(el.offsetWidth, el.scrollWidth)
const h = Math.max(el.offsetHeight, el.scrollHeight)
const scale = mode === "scale" ? Math.min(1, vw / w, vh / h) : 1
el.style.transform = scale < 1 ? `scale(${scale})` : ""
setCropped(mode === "crop" && h > vh + 1)
}
measure()
const observer = new ResizeObserver(measure)
observer.observe(el)
// Content that changes inside a fixed width box (a headline that cycles words) never resizes
// the box itself, so changes below it measure again on the next frame.
let frame = 0
const mutations = new MutationObserver(() => {
cancelAnimationFrame(frame)
frame = requestAnimationFrame(measure)
})
mutations.observe(el, { subtree: true, childList: true, characterData: true })
window.addEventListener("resize", measure)
return () => {
observer.disconnect()
mutations.disconnect()
cancelAnimationFrame(frame)
window.removeEventListener("resize", measure)
}
}, [mode, hideBelow])
const fade = "linear-gradient(to bottom, #000 calc(100% - 40px), transparent)"
return (
<div
className="flex w-full justify-center overflow-hidden"
style={{
height: "100dvh",
alignItems: mode === "crop" ? "flex-start" : "center",
maskImage: cropped ? fade : undefined,
WebkitMaskImage: cropped ? fade : undefined,
}}
>
<style>{FIT_CSS}</style>
<div
ref={content}
className="w-full shrink-0"
style={{ transformOrigin: mode === "crop" ? "top center" : "center", minWidth }}
>
{children}
</div>
</div>
)
}
/** The line under each 21st demo that points back to the kit. */
function MoreOn({ slug, children }: { slug: string; children: React.ReactNode }) {
return (
<p data-fit-hide className="text-[0.75rem]/[1rem] text-(color:--chatcn-fg-faint) text-center text-balance">
{children}{" "}
<a
href={`https://chatcn.dev/docs/components/${slug}`}
target="_blank"
rel="noopener"
className="text-(color:--chatcn-fg-subtle) hover:text-(color:--chatcn-fg) underline underline-offset-2"
>
chatcn.dev
</a>
</p>
)
}
/**
* An agent reading a billing API before it calls it: the method and path with its parameters
* marked, then each field with its type, whether it is required, the values it allows and its
* default. The tour steps through three endpoints. Every endpoint shares one grid cell, so the
* frame keeps the size of the tallest and never rescales.
*/
export default function SchemaDisplayPreview() {
const [shown] = useCycle(ENDPOINTS, 2600)
return (
<FitFrame minWidth="32rem">
<div className="flex w-full flex-col items-center justify-center gap-4 p-5">
<div className="grid w-full max-w-lg items-start">
{ENDPOINTS.map((endpoint) => (
<div
key={`${endpoint.method} ${endpoint.path}`}
aria-hidden={endpoint !== shown}
inert={endpoint !== shown}
className="col-start-1 row-start-1 transition-opacity duration-300"
style={{ opacity: endpoint === shown ? 1 : 0 }}
>
<SchemaDisplay {...endpoint} />
</div>
))}
</div>
<MoreOn slug="schema-display">API endpoints and tool inputs as a readable, typed tree. On</MoreOn>
</div>
</FitFrame>
)
}
















