Interface: FormField

Defined in: packages/core/dist/types.d.ts:101

Intermediate representation of a single form field produced by walkSchema. Each processor fills in component, props, constraints, and optional children. This structure is consumed by codegen (static TSX generation) and by the runtime FieldRenderer to produce a live React component tree.

Properties

arrayItem?

optional arrayItem?: FormField

Defined in: packages/core/dist/types.d.ts:135

Template for array items

---

children?

optional children?: FormField[]

Defined in: packages/core/dist/types.d.ts:133

Children for nested objects

---

component

component: string

Defined in: packages/core/dist/types.d.ts:105

Component name from ComponentMap, e.g. "Input", "Select", "Textarea"

---

constraints

constraints: FormFieldConstraints

Defined in: packages/core/dist/types.d.ts:137

Validation constraints extracted from Zod v4 constraint bag (_zod.bag)

---

defaultValue?

optional defaultValue?: unknown

Defined in: packages/core/dist/types.d.ts:117

Default value from z.default() or metadata

---

deprecated

deprecated: boolean

Defined in: packages/core/dist/types.d.ts:129

Whether the field is marked as deprecated in the schema registry

---

description?

optional description?: string

Defined in: packages/core/dist/types.d.ts:111

Help text from .describe() or .meta()

---

disabled

disabled: boolean

Defined in: packages/core/dist/types.d.ts:125

Non-interactive state (greyed out)

---

hasCustomRender?

optional hasCustomRender?: boolean

Defined in: packages/core/dist/types.d.ts:141

Whether a custom render function is registered for this field (runtime only)

---

helpText?

optional helpText?: string

Defined in: packages/core/dist/types.d.ts:127

Help text rendered below the input, distinct from description (below label)

---

hidden

hidden: boolean

Defined in: packages/core/dist/types.d.ts:121

Hidden but present in form state

---

key

key: string

Defined in: packages/core/dist/types.d.ts:103

Field path, e.g. "name", "address.street", "items.0.name"

---

label

label: string

Defined in: packages/core/dist/types.d.ts:109

Display label

---

options?

optional options?: FormFieldOption[]

Defined in: packages/core/dist/types.d.ts:131

Options for enum/union select fields

---

order?

optional order?: number

Defined in: packages/core/dist/types.d.ts:123

Display order override from form registry

---

placeholder?

optional placeholder?: string

Defined in: packages/core/dist/types.d.ts:113

Placeholder from examples[0] or metadata

---

props

props: Record<string, unknown>

Defined in: packages/core/dist/types.d.ts:107

Pass-through props for the component

---

readOnly

readOnly: boolean

Defined in: packages/core/dist/types.d.ts:119

Read-only from z.readonly() or metadata

---

render?

optional render?: (field, props) => unknown

Defined in: packages/core/dist/types.d.ts:143

Custom render function from FormMeta (runtime only, not serialisable)

Parameters

field

FormField

props

Record<string, unknown>

Returns

unknown

---

required

required: boolean

Defined in: packages/core/dist/types.d.ts:115

Whether the field is required

---

validation?

optional validation?: ValidationStrategy

Defined in: packages/core/dist/types.d.ts:147

Validation strategy set by optimizers (undefined = use zodResolver)

---

zodSchema?

optional zodSchema?: $ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>

Defined in: packages/core/dist/types.d.ts:145

Atomic Zod schema for this field, set by L1 optimizer

---

zodType

zodType: string

Defined in: packages/core/dist/types.d.ts:139

Original Zod def.type for reference