New to Kendo UI for VueStart a free 30-day trial

Represents the props of the Kendo UI for Vue SchedulerForm component.

Definition

Package:@progress/kendo-vue-scheduler

Properties

Specifies the dataItem to be visualized inside the form.

errors?

{ [name: string]: string }

Validation errors that override field and form validators.

Provides validation errors directly as an object, unlike the validator prop which expects a callback. When both validator and errors exist for a field, the errors prop takes precedence.

Set this to true to allow the form submit without modified fields.

initialValues?

{ [name: string]: any }

The initial field values of the Form.

When you initialize the Form fields, set initial values to them. Otherwise, some components might throw errors related to switching from uncontrolled to controlled mode.

onCancel?

(event: SchedulerFormStateChangeEvent​<null>) => void

Called when the cancel button is clicked.

Parameters:eventSchedulerFormStateChangeEvent​<null>

onChange?

(fieldName: string, value: any, valueGetter: (name: string) => any) => void

Fires each time any field value changes.

The third parameter valueGetter allows accessing other field values, useful for cross-field validation or clearing related errors.

Parameters:fieldNamestringvalueanyvalueGetter(name: string) => any

onClose?

(event: SchedulerFormStateChangeEvent​<null>) => void

Called when the close button is clicked.

Parameters:eventSchedulerFormStateChangeEvent​<null>

onSubmit?

(values: { [name: string]: any }, event: any) => void

The submission handler for the Form. Called when at least one field has been modified, the user pressed the Submit button, and the form validation was successful.

Parameters:values{ [name: string]: any }event?any

onSubmitclick?

(event: FormSubmitClickEvent) => void

Called every time the user presses the Submit button. Useful in advanced scenarios when you need to handle every submit event, even when the form is invalid or not modified state.

Parameters:eventFormSubmitClickEvent

The Form content that will be rendered.

Parameters:propsFormRenderPropsReturns:

any

validator?

FormValidatorType

The validation function for the Form level. Should return key-value pair where the key is the field path and the value is the error message. Nested fields are supported, e.g.: 'users[0].name'. You can use the same field path to access the value from the values object using the getter function from the kendo-vue-common package. Currently, validator supports only synchronous functions.