pgForm/Installation
Getting started~2 min

Installation

One package, one peer dependency, no plugins. pgForm ships as ESM only — bring it into any bundler that understands modern JavaScript and you're done.

Install

Pick your package manager:

bun
bun add @westopp/pgform
pnpm
pnpm add @westopp/pgform
npm
npm install @westopp/pgform
yarn
yarn add @westopp/pgform

Peer dependencies

pgForm expects React 19 already in your project. It's a peer dependency, not bundled, so you control the version and avoid duplicate copies in your tree.

TypeScript

TypeScript isn't required, but you'll lose most of the benefit without it. Field types, values, and the form API are inferred from your pgf.formData(...) config — JavaScript consumers still get the runtime behaviour, just not the editor tooling.

What's next

That's the install. Head to Getting started for the 10-minute tour: declare your fields, mount the hook, render with BYOC components.