FormApi

Provides reactive form state, field access, validation, submit, reset, and error controls.

Signature

interface FormApi

state: ReadonlyCell<FormState<TValues>>

function field<Name>(name: Name): FieldApi<TValues, Name>

function getValues(): TValues

function reset(values?: TValues): void

function setErrors(errors: FormErrors<TValues>): void

function setServerErrors(errors: ServerActionErrors<TValues>): void

function setValue<Name>(name: Name, value: TValues[Name]): Promise<void>

function submit<TResult>(handler: (values: TSubmitValues): TResult | Promise<TResult>): Promise<FormSubmitResult<TValues, TResult>>

function validate(): Promise<FormValidationResult<TValues, TSubmitValues>>