FormRenderProps
Represents the props that the Form passes to its renderForm function.
Definition
Package:@progress/kendo-vue-form
Properties
allowSubmit
boolean
Shows whether the Form is ready for submission.
- If
allowSubmitistrueand the Form is valid, the user can submit the Form. - If
allowSubmitistrueand the Form is not valid, a submit sets the
touched and visited state of all fields to true.
Use it to toggle the disabled state of the Submit button.
The key-value pairs of the current errors by field path. They combine the errors from the field-level and form-level validators.
modified
boolean
Shows whether the Form is modified.
When any field is modified, modified is true.
A field becomes modified the first time the Field component handles
the change event of its editor.
onChange?
(name: string, options: { value: any }) => void
A callback that changes the value of a specific field without the Field component (see example).
Use
onChangeonly when you cannot get the result you need through the Field component.
onFormreset?
() => void
A callback that resets the Form.
onSubmit?
(event: any) => void
A callback that submits the Form.
You can bind it to the click event of the Submit button.
submitted
boolean
Shows whether the Form is successfully submitted. Use it to detect when the user leaves the Form before saving the changes.
touched
boolean
Shows whether the Form is touched.
When any field is touched, touched is true.
A field becomes touched when the Field component handles the blur event
of its editor or when the user tries to submit the Form.
valid
boolean
Shows whether the Form is valid.
When any field is not valid, valid is false.
A callback that returns the value of a field without the Field component (see example). Use it to build or change the UI based on the field values.
any
visited
boolean
Shows whether the Form is visited.
When any field is visited, visited is true.
A field becomes visited when the Field component handles the focus event
of its editor or when the user tries to submit the Form.