Hero Hook Form API / AdvancedFieldBuilder

Class: AdvancedFieldBuilder<T>

Defined in: builders/AdvancedFormBuilder.ts:557

Builder pattern for advanced field creation

Type Parameters

T

T extends FieldValues

Constructors

Constructor

new AdvancedFieldBuilder<T>(): AdvancedFieldBuilder<T>

Returns

AdvancedFieldBuilder<T>

Methods

field()

field(params): this

Defined in: builders/AdvancedFormBuilder.ts:563

Add any field type using the unified API

Parameters

params

FieldCreationParams<T>

Returns

this

conditionalField()

conditionalField(name, condition, field): this

Defined in: builders/AdvancedFormBuilder.ts:572

Add a conditional field that shows/hides based on form data

Parameters

name

Path<T>

condition

(formData) => boolean

field

ZodFormFieldConfig<T>

Returns

this

fieldArray()

fieldArray(name, label, fields, options?): this

Defined in: builders/AdvancedFormBuilder.ts:592

Add a field array for dynamic repeating field groups

Parameters

name

ArrayPath<T>

label

string

fields

ZodFormFieldConfig<T>[]

options?

min?

number

max?

number

addButtonText?

string

removeButtonText?

string

Returns

this

dynamicSection()

dynamicSection(name, condition, fields, options?): this

Defined in: builders/AdvancedFormBuilder.ts:622

Add a dynamic section that shows/hides based on form data

Parameters

name

Path<T>

condition

(formData) => boolean

fields

ZodFormFieldConfig<T>[]

options?

title?

string

description?

string

Returns

this

build()

build(): ZodFormFieldConfig<T>[]

Defined in: builders/AdvancedFormBuilder.ts:648

Build the final field configuration array

Returns

ZodFormFieldConfig<T>[]