New to KendoReactStart a free 30-day trial

Contains props that are passed to the form's render function.

Definition

Package:@progress/kendo-react-form

Properties

Shows whether the form can be submitted. When true and form is valid, you can submit. When true and form is invalid, you can show all validation errors.

Use this to control the disabled state of Submit buttons.

errors

KeyValue​<string>

Contains current validation errors organized by field path.

modified

boolean

Shows whether any field value has changed from its initial value. Becomes true when any field value changes for the first time.

onChange

(name: string, options: { value: any }) => void

A callback for emitting changes to a specific field without using the Field component (see example).

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

Parameters:namestringoptions{ value: any }

onFormReset

() => void

Resets the form to its initial state.

onSubmit

(event: SyntheticEvent​<any, Event>) => void

Submits the form when called. Use this with the onClick property of Submit buttons.

Parameters:eventSyntheticEvent​<any, Event>

submitted

boolean

Shows whether the form has been successfully submitted. Use this to detect if the user is leaving before saving changes.

touched

boolean

Shows whether the user has interacted with any field. Becomes true when any field loses focus or the user tries to submit.

valid

boolean

Shows whether the form passes all validation rules. Becomes false if any field fails validation.

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.

Parameters:namestringReturns:

any

visited

boolean

Shows whether the user has focused on any field. Becomes true when any field receives focus or the user tries to submit.