Get started

interface

FieldForm

interface FieldForm { ... }

The manifest-driven form controller exposed to field plugins.

Source packages/plugin/src/index.ts:15

contentLocalestring
The contentLocale value.
resourceFieldFormResource
The resource value.
get(path: string) => unknown
The get value.
issuesFor(path: string) => readonly ValidationIssue[]
The issuesFor value.
register(path: string) => () => void
The register value.
set(path: string, value: unknown) => void
The set value.
snapshot() => Record<string, unknown>
The snapshot value.

Call register when the component mounts and invoke the returned cleanup when it unmounts. Paths are schema paths, including runtime indexes for repeated fields.

snapshot returns the current unsaved document when the host supports draft-aware plugin behavior; resource and contentLocale identify its authoring scope.

Methods