Skip to main content

Installation

Package Manager

Install @uniform-ts/core along with its peer dependencies:

npm install @uniform-ts/core react react-hook-form zod
Zod V4 import path

UniForm requires the Zod V4 API. How you import it depends on which version of the zod package you have installed:

  • zod@3.25 or later — Zod V4 ships inside the existing zod package. Import from the sub-path:
    import { z } from 'zod/v4'
  • zod@4.x — Import directly from the package root:
    import { z } from 'zod'

Imports

Everything you need is exported from @uniform-ts/core:

import { createForm, AutoForm, createAutoForm } from '@uniform-ts/core'
import type { FieldProps, AutoFormHandle } from '@uniform-ts/core'

TypeScript Configuration

UniForm requires TypeScript with strict mode and moduleResolution: bundler (or node16 / nodenext). In tsconfig.json:

{
"compilerOptions": {
"strict": true,
"moduleResolution": "bundler",
"jsx": "react-jsx"
}
}

Peer Dependencies

PackageVersion
react^19.0.0
react-hook-form^7.0.0
zod^3.25.0 (Zod V4)

AI Agent Skill

If you build forms with an AI coding assistant (Copilot, Claude, etc.), install the UniForm skill so it follows the idiomatic, schema-first patterns:

npx skills add https://github.com/UniFormTS/UniForm --skill uniform-best-practices

The skill is also discoverable on skills.sh.