Components / Scheduler / API / SchedulerFormProps / 

SchedulerFormProps

Represents the props of the KendoReact SchedulerForm component.

NameTypeDefaultDescription

dataItem

any

Specifies the dataItem to be visualized inside the form.

dialog?

React.ComponentType<DialogProps>

Overrides the component used for visualizing the dialog. The KendoReact Dialog component is used, by default.

For more information, please refer to the Scheduler Form Customization article.

editor?

React.ComponentType<SchedulerFormEditorProps>

Overrides the component used for visualizing the editor. The SchedulerFormEditor component is used, by default.

For more information, please refer to the Scheduler Form Customization article.

ignoreModified?

boolean

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

initialValues?

{[name: string]: any}

The initial field values of the Form.

When you initialize the Form felds, set initial values to them. Otherwise, some

components might throw errors related to switching from uncontrolled to controlled mode.

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-react-common package. Currently, validator supports only synchronous functions.

Methods

onCancel

Called when the cancel button is clicked.

Parameters

event

SchedulerFormStateChangeEvent<null>

onClose

Called when the close button is clicked.

Parameters

event

SchedulerFormStateChangeEvent<null>

onSubmit

Called when the submit button is clicked.

Parameters

event

SchedulerFormStateChangeEvent<any>

onSubmitClick

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

event

FormSubmitClickEvent

render

The Form content that will be rendered. The default rendering includes a dialog and editor.

For more information about customizing some parts of the default rendering please refer to the SchedulerForm Customization article.

Parameters

props

FormRenderProps
Returns

any

In this article

Not finding the help you need?

Contact Support