Package API

FrameKit publishes a small set of explicit package entrypoints. Import only from these paths; the package does not expose its src/ tree as a consumer API.

Choose an entrypoint

• Core API — shared template definitions, fields, validation, data helpers, and Markdown.
• Client API — the client component used by the private render page.
• Editor API — interactive editor and navigation components.
• QR code API — SVG QR codes with a layout-friendly div wrapper for templates.
• Next.js API — the supported Next.js configuration wrapper.
• Studio API — the client-side Studio surface and its messages and types.
• Studio root API — server-side document and page factories for Studio routes.
• Development API — advanced server-side discovery, code generation, and watching utilities.
• Server API — Node.js handlers and server-side rendering contracts.
• Stylesheet — the published CSS entrypoint.

Package constraints

The package is ESM-only. Its peer dependency ranges are Next.js >=16 <17, React >=19 <20, and React DOM >=19 <20. The package requires Node.js >=22.13.0; the package manager requirement is pnpm >=11.14.0.

For project setup, see integrating an existing Next.js project. For the template contract, see the template reference.