FormRenderProps
Represents the props that are passed to the render option component of the Form.
| Name | Type | Default | Description |
|---|---|---|---|
allowSubmit |
|
Indicates if the Form is ready to be submitted.
Useful for toggling the disabled state of the Submit button. | |
errors |
|
The key-value pair containing the current errors by field path, combined from both field and form level validators. | |
modified |
|
Indicates if the Form is modified.
If any field is modified, | |
submitted |
|
Indicates if the Form is successfuly submitted. Useful for detecting if user is leaving the form before saving changes. | |
touched |
|
Indicates if the Form is touched.
If any field is touched, | |
valid |
|
Indicates if the Form is valid.
If any field is invalid, | |
visited |
|
Indicates if the Form is visited.
If any field is visited, |
Methods
onChange | |||||||||
|---|---|---|---|---|---|---|---|---|---|
|
A callback for emiting changes to a specific field without using the Field component (see example).
| |||||||||
|
onFormReset |
|---|
|
A callback for resetting the Form. |
onSubmit | ||||||
|---|---|---|---|---|---|---|
|
A callback for submitting the Form.
Can be passed to the | ||||||
|
valueGetter | ||||||
|---|---|---|---|---|---|---|
|
A callback for getting the value of a field without using the Field component (see example). Useful for creating and modifying the UI based on the field values. | ||||||
| ||||||
|
