@mackehansson/schemaform
API Reference

API Reference

Source-derived API reference for the main package and advanced subpath entrypoints.

The main entrypoint is the recommended import path:

import {
  SchemaForm,
  FormBuilder,
  useFormRenderer,
  useFormBuilder,
  type FormDefinition,
} from "@mackehansson/schemaform";

The API reference is split by responsibility so advanced users can find the layer they need:

  • schemaform includes the full installed surface.
  • schemaform/core is the headless engine: Form Definition types, resolution, Rules Engine, validation, renderability, migration, and builder mutations.
  • schemaform/react is the React hook layer: useFormRenderer for Form Renderers and useFormBuilder for admin surfaces.
  • schemaform/shadcn is the first-party Renderer and Form Builder UI, plus its Registry and widget helpers.

Type tables are generated at build time with fumadocs-typescript from real TypeScript source. The prose explains when to use each export; the tables stay tied to the exported source types.

Reference Sections

Start with the main package. Use Core when you need the domain model or pure functions. Use React when you are building a Renderer or Form Builder around hooks. Use ShadCN when you want the drop-in components or want to extend the first-party Registry.

Entry pointUse for
schemaformDefault installed API for React apps
schemaform/coreFramework-agnostic model, resolver, validator, rules, migrations, and mutations
schemaform/reactControlled React hooks over Core
schemaform/shadcnFirst-party ShadCN/RHF Renderer, Form Builder, Registry, and widgets

On this page