FormHandle

A subclass of React.Component.

Represent the ref of the Form component.

NameTypeDefaultDescription

errors

KeyValue<string>

fields

string[]

formErrors

undefined | KeyValue<string>

modified

KeyValue<boolean>

props

Readonly<FormProps>

The props of the FormHandle component.

touched

KeyValue<boolean>

validatorsByField

KeyValue<undefined[]>

values

KeyValue<any>

visited

KeyValue<boolean>

Methods

onChange

Method for emiting changes to a specific field outside the form component.

Use onChange only if you cannot achieve the desired behavior through the Field component by FormRenderProps.

Parameters

name

string

options

{ value: any; }

onReset

Method for resetting the form state outside the form component.

Use onReset only if you cannot achieve the desired behavior through the Field component or by FormRenderProps.