New to KendoReactStart a free 30-day trial

SchedulerFormProps
Premium

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

Allows the form to submit even when no fields have been modified.

jsx
<Form ignoreModified={true} render={props => <form>form content </form>} />

initialValues?

{[name: string]: any}

Sets the starting values for form fields.

Set initial values to prevent errors when switching from uncontrolled to controlled mode.

jsx
const initialValues = { user: { name: '', age: 0 } };
<Form initialValues={initialValues} render={props => <form>form content</form>} />

onCancel?

(event: SchedulerFormStateChangeEvent<null>) => void

Fires when you click the cancel button.

onClose?

(event: SchedulerFormStateChangeEvent<null>) => void

Fires when you click the close button.

onSubmit

(event: SchedulerFormStateChangeEvent<any>) => void

Fires when you click the submit button.

onSubmitClick?

(event: FormSubmitClickEvent) => void

Handles every submit button click, even when the form is invalid or unchanged.

Use this for advanced scenarios where you need to handle all submit events.

jsx
const handleSubmitClick = event => console.log(event);
<Form onSubmitClick={handleSubmitClick} render={props => <form> form content </form>} />

render?

(props: FormRenderProps) => any

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.

validator?

FormValidatorType

Validates the entire form and returns error messages.

Return a key-value pair where the key is the field path and the value is the error message. You can validate nested fields like 'users[0].name'. Only synchronous functions are supported.

jsx
const validator = values => ({ user: { name: values.user.name ? "" : "Name is required." } });
<Form validator={validator} render={props => <form> form content </form>} />
Not finding the help you need?
Contact Support