SchedulerFormEditorProps
Represents the props of the KendoReact SchedulerFormEditor component.
Definition
Package:@progress/kendo-react-scheduler
Properties
allDayEditor?
ComponentType<TargetlessChangeEvent<CheckboxProps intersected with FieldProps, boolean>>
Overrides the component used for visualizing the allDay field editor.
The KendoReact Checkbox component is used, by default.
For more information, please refer to the Scheduler Form Editor Customization article.
allDayLabel?
ComponentType<LabelProps intersected with FieldProps>
Overrides the component used for visualizing the allDay field label.
The KendoReact Label component is used, by default.
For more information, please refer to the Scheduler Form Editor Customization article.
allowSubmit
boolean
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.
descriptionEditor?
ComponentType<TargetlessChangeEvent<TextAreaProps intersected with FieldProps, string>>
Overrides the component used for visualizing the description field editor.
The KendoReact TextArea component is used, by default.
For more information, please refer to the Scheduler Form Editor Customization article.
descriptionError?
ComponentType<ErrorProps intersected with FieldProps>
Overrides the component used for visualizing the description field error.
The KendoReact Error component is used, by default.
For more information, please refer to the Scheduler Form Editor Customization article.
descriptionLabel?
ComponentType<LabelProps intersected with FieldProps>
Overrides the component used for visualizing the description field label.
The KendoReact Label component is used, by default.
For more information, please refer to the Scheduler Form Editor Customization article.
endEditor?
ComponentType<TargetlessChangeEvent<Omit<DatePickerProps | DateTimePickerProps, "onChange" | "calendar"> intersected with { as?: ComponentType<DatePickerProps | DateTimePickerProps> | undefined; onChange?: (args: { value: null | Date }) => void; onOpen?: (args: DatePickerOpenEvent | DateTimePickerOpenEvent) => void; onClose?: (args: DatePickerCloseEvent | DateTimePickerCloseEvent) => void } intersected with FieldProps, Date>>
Overrides the component used for visualizing the end field editor.
The KendoReact DatePicker or KendoReact DateTimePicker component is used by default depending on the allDay field value.
For more information, please refer to the Scheduler Form Editor Customization article.
endError?
ComponentType<ErrorProps intersected with FieldProps>
Overrides the component used for visualizing the end field error.
The KendoReact Error component is used, by default.
For more information, please refer to the Scheduler Form Editor Customization article.
endLabel?
ComponentType<LabelProps intersected with FieldProps>
Overrides the component used for visualizing the end field label.
The KendoReact Label component is used, by default.
For more information, please refer to the Scheduler Form Editor Customization article.
endTimezoneCheckedEditor?
ComponentType<TargetlessChangeEvent<CheckboxProps, boolean>>
Overrides the component used for visualizing the end timezone checked editor.
The KendoReact Checkbox component is used, by default.
For more information, please refer to the Scheduler Form Editor Customization article.
endTimezoneCheckedLabel?
ComponentType<LabelProps>
Overrides the component used for visualizing the start timezone checked label.
The KendoReact Label component is used, by default.
For more information, please refer to the Scheduler Form Editor Customization article.
endTimezoneEditor?
ComponentType<TargetlessChangeEvent<ComboBoxProps, string>>
Overrides the component used for visualizing the end timezone field editor.
An extended KendoReact ComboBox component is used, by default.
For more information, please refer to the Scheduler Form Editor Customization article.
endTimezoneError?
ComponentType<ErrorProps>
Overrides the component used for visualizing the end timezone field error.
The KendoReact Error component is used, by default.
For more information, please refer to the Scheduler Form Editor Customization article.
endTimezoneLabel?
ComponentType<LabelProps>
Overrides the component used for visualizing the end timezone field label.
The KendoReact Label component is used, by default.
For more information, please refer to the Scheduler Form Editor Customization article.
errors
KeyValue<string>
Contains current validation errors organized by field path.
id?
string
Specifies the id attribute of the root element.
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
onChangeonly if you cannot achieve the desired behavior through the Field component.
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.
recurrenceEditor?
ComponentType<TargetlessChangeEvent<FieldProps, string>>
Overrides the component used for visualizing the recurrenceRule field editor.
A custom made RecurrenceEditor component is used, by default.
We're planing on releasing the
RecurrenceEditoras a standalone component in the future.
For more information, please refer to the Scheduler Form Editor Customization article.
resourceEditor?
ComponentType<TargetlessChangeEvent<(MultiSelectProps | DropDownListProps) & FieldProps, any>>
Overrides the component used for visualizing each resource field editor.
An extended KendoReact MultiSelect or DropDownList component is used by default, depending on the multiple field of each individual resource.
For more information, please refer to the Scheduler Form Editor Customization article.
resourceLabel?
ComponentType<LabelProps intersected with FieldProps>
Overrides the component used for visualizing the start timezone checked field label.
The KendoReact Label component is used, by default.
For more information, please refer to the Scheduler Form Editor Customization article.
resourcesError?
ComponentType<ErrorProps intersected with FieldProps>
Overrides the component used for visualizing each resources field error.
The KendoReact Error component is used, by default.
For more information, please refer to the Scheduler Form Editor Customization article.
startEditor?
ComponentType<TargetlessChangeEvent<Omit<DatePickerProps | DateTimePickerProps, "onChange" | "calendar"> intersected with { as?: ComponentType<DatePickerProps | DateTimePickerProps> | undefined; onChange?: (args: { value: null | Date }) => void; onOpen?: (args: DatePickerOpenEvent | DateTimePickerOpenEvent) => void; onClose?: (args: DatePickerCloseEvent | DateTimePickerCloseEvent) => void } intersected with FieldProps, Date>>
Overrides the component used for visualizing the start field editor.
The KendoReact DatePicker or KendoReact DateTimePicker component is used by default depending on the allDay field value.
For more information, please refer to the Scheduler Form Editor Customization article.
startError?
ComponentType<ErrorProps intersected with FieldProps>
Overrides the component used for visualizing the start field error.
The KendoReact Error component is used, by default.
For more information, please refer to the Scheduler Form Editor Customization article.
startLabel?
ComponentType<LabelProps intersected with FieldProps>
Overrides the component used for visualizing the start field label.
The KendoReact Label component is used, by default.
For more information, please refer to the Scheduler Form Editor Customization article.
startTimezoneCheckedEditor?
ComponentType<TargetlessChangeEvent<CheckboxProps, boolean>>
Overrides the component used for visualizing the start timezone checked editor.
The KendoReact Checkbox component is used, by default.
For more information, please refer to the Scheduler Form Editor Customization article.
startTimezoneCheckedLabel?
ComponentType<LabelProps>
Overrides the component used for visualizing the start timezone checked label.
The KendoReact Label component is used, by default.
For more information, please refer to the Scheduler Form Editor Customization article.
startTimezoneEditor?
ComponentType<TargetlessChangeEvent<ComboBoxProps intersected with FieldProps, string>>
Overrides the component used for visualizing the start timezone field editor.
An extended KendoReact ComboBox component is used, by default.
For more information, please refer to the Scheduler Form Editor Customization article.
startTimezoneError?
ComponentType<ErrorProps intersected with FieldProps>
Overrides the component used for visualizing the start timezone field error.
The KendoReact Error component is used, by default.
For more information, please refer to the Scheduler Form Editor Customization article.
startTimezoneLabel?
ComponentType<LabelProps intersected with FieldProps>
Overrides the component used for visualizing the start timezone field label.
The KendoReact Label component is used, by default.
For more information, please refer to the Scheduler Form Editor Customization article.
submitted
boolean
Shows whether the form has been successfully submitted. Use this to detect if the user is leaving before saving changes.
tabIndex?
number
Specifies the tabIndex attribute of the root element.
titleEditor?
ComponentType<TargetlessChangeEvent<InputProps intersected with FieldProps, string>>
Overrides the component used for visualizing the title field editor.
The KendoReact Input component is used, by default.
For more information, please refer to the Scheduler Form Editor Customization article.
titleError?
ComponentType<LabelProps intersected with FieldProps>
Overrides the component used for visualizing the title field error.
The KendoReact Error component is used, by default.
For more information, please refer to the Scheduler Form Editor Customization article.
titleLabel?
ComponentType<LabelProps intersected with FieldProps>
Overrides the component used for visualizing the title field label.
The KendoReact Label component is used, by default.
For more information, please refer to the Scheduler Form Editor Customization article.
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.
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.