Editor template in JavaScript Scheduler control
18 Nov 201811 minutes to read
Scheduler provides popups and dialogs to display notifications and includes an editor window with event fields for streamlined appointment creation and editing. The editor window and its fields can be easily customized, and validations can be applied to those fields.
Event editor
The editor window opens on the Scheduler when a cell or event is double-clicked. Double-clicking a cell opens the detailed editor window in “Add new” mode, while double-clicking an event opens it in “Edit” mode.
On mobile devices, the detailed editor window opens in edit mode by clicking the edit icon on the popup that appears when single-tapping an event. It can also be opened in add mode by single-tapping a cell, which displays a + indication. Clicking this indication again opens the editor window.
The editor window can be prevented from opening by rendering Scheduler in
readonlymode or by using code customization within thepopupOpenevent.
Change the editor window header title and footer button text
The header title and footer button text of the editor window can be changed by modifying the appropriate localized word collection used in the Scheduler.
Change the label text of default editor fields
To change the default labels such as Subject, Location, and other field names in the editor window, use the title property available within the field option of eventSettings.
Field validation
Required fields in the editor window can be validated on the client-side before submission by adding appropriate validation rules to each field using the validation property available within the field option of eventSettings. The appointment fields have been extended to accept both string and object type values. To perform validations, specify object values for the event fields.
Applicable validation rules can be referred from form validation documentation.
Add additional fields to the default editor
Additional fields can be added to the default event editor by using the popupOpen event which is triggered before the event editor opens on the Scheduler. The popupOpen is a client-side event that triggers before any of the generic popups opens on the Scheduler. The additional field (any of the form elements) should be added with the common class name e-field, so as to handle and process that additional data along with the default event object. In the following example, an additional field Event Type has been added to the default event editor and its value is processed accordingly.
Customize the default time duration in editor window
In the default event editor window, start and end time duration are processed based on the interval value set within the timeScale property. By default, the interval value is set to 30, and therefore the start/end time duration within the event editor will be in 30-minute intervals. This duration value can be changed by modifying the duration option within the popupOpen event as shown in the following code example.
How to prevent the display of editor and quick popups
The display of editor and quick popup windows can be prevented by passing the value true to the cancel option within the popupOpen event.
To prevent only specific popups on Scheduler, check the condition based on the popup type. The types of popups that can be checked within the popupOpen event are as follows.
| Type | Description |
|---|---|
| Editor | For Detailed editor window. |
| QuickInfo | For Quick popup which opens on cell click. |
| EditEventInfo | For Quick popup which opens on event click. |
| ViewEventInfo | For Quick popup which opens on responsive mode. |
| EventContainer | For more event indicator popup. |
| RecurrenceAlert | For edit recurrence event alert popup. |
| DeleteAlert | For delete confirmation popup. |
| ValidationAlert | For validation alert popup. |
| RecurrenceValidationAlert | For recurrence validation alert popup. |
Customize timezone collection in the editor window
By default, the timezone collections in the editor window are loaded with built-in timezone data. The timezone collections can be customized using the timezoneDataSource property with the collection of TimezoneFields data.
Close the editor window manually
The editor window can be closed using the closeEditor method.
Customize event editor using template
The event editor window can be customized using the editorTemplate option. The custom window design is built with the required fields using the script template and its type should be of text/x-template.
Each field defined within the template should contain the e-field class, to allow the processing of those field values internally. The ID of this customized script template section is assigned to the editorTemplate option, so that these customized fields will be replaced onto the default editor window.
Note: The e-field class is only applicable for DropDownList, DateTimePicker, MultiSelect, DatePicker, CheckBox and TextBox components. Since we have processed, as field values are processed internally for these components.
When using our Syncfusion® sub-components within the editor using template in the following example, the custom defined form elements needs to be configured as required Syncfusion® components such as DropDownList and DateTimePicker within the popupOpen event. This particular step can be skipped, if using standard form elements.
Customize header and footer using template
The editor window’s header and footer can be enhanced with custom designs using the editorHeaderTemplate and editorFooterTemplate options. To achieve this, create a script template that includes the necessary fields. Ensure that the template type is set to text/x-template.
In this example, the editor’s header is customized according to the appointment’s subject field using
editorHeaderTemplate. The editorFooterTemplate is used to handle the functionality of validating specific fields before proceeding with the save action or canceling if validation requirements are not met.
Add resource options within editor template
The resource field can be added within the editor template with a multiselect control to allow multiple resource selection.
Add recurrence options within editor template
The following code example shows how to add recurrence options within the editor template by importing RecurrenceEditor.
Apply validations on editor template fields
In the following code example, validation has been added to the EventType field by using the popupOpen event. This field is set as required, and the validation message is displayed using the FormValidator class.
How to save the customized event editor using template
If the e-field class is not added to each field defined within the template, so you should allow setting those field values should be set externally using the popupClose event.
Note: Data can be retrieved only on the save and delete options. Data cannot be retrieved on the close and cancel options in the editor window.
The following code example shows how to save the customized event editor using a template with the popupClose event.
To prevent only specific popup closures on Scheduler, check the condition based on the popup type. The types of popups that can be checked within the popupClose event are as follows.
| Type | Description |
|---|---|
| Editor | For Detailed editor window. |
| QuickInfo | For Quick popup which opens on cell click. |
| EditEventInfo | For Quick popup which opens on event click. |
| ViewEventInfo | For Quick popup which opens on responsive mode. |
| EventContainer | For more event indicator popup. |
| RecurrenceAlert | For edit recurrence event alert popup. |
| DeleteAlert | For delete confirmation popup. |
| ValidationAlert | For validation alert popup. |
| RecurrenceValidationAlert | For recurrence validation alert popup. |
Quick popups
Quick info popups are displayed when a cell or appointment is single-clicked on desktop mode. Single-clicking a cell allows providing a subject and saving it quickly. Single-clicking an event displays a popup with an overview of the event information, along with options to edit or delete the event.
By default, these popups are displayed over cells and appointments of Scheduler. To disable this action, set false to showQuickInfo property.
The quick popup that opens when single-clicking cells is not applicable on mobile devices.
Open quick popup on multiple cell selection
The quick popup can be displayed immediately after multiple cells are selected in Scheduler by setting the quickInfoOnSelectionEnd property to true. By default, it’s value is set to false.
How to change the watermark text of quick popup subject
By default, Add Title text is displayed on the subject field of the quick popup. To change the default watermark text, modify the value of the appropriate localized word collection used in the Scheduler.
L10n.load({
'en-US': {
'schedule': {
'addTitle' : 'New Title'
}
}
});Customize quick popups
The look and feel of the built-in quick popup window that opens when single-clicking cells or appointments can be customized using the quickInfoTemplates property of the Scheduler. There are three sub-options available to customize:
- header - Accepts the template design that customizes the header part of the quick popup.
- content - Accepts the template design that customizes the content part of the quick popup.
- footer - Accepts the template design that customizes the footer part of the quick popup.
The quick popup in adaptive mode can also be customized using
quickInfoTemplateswith thee-deviceclass.
Open the quick info popup manually
The quick info popup in Scheduler can be opened using the openQuickInfoPopup public method. To open the cell quick info popup, pass the cell data as an argument to the method. To open the event quick info popup, pass the event data object as an argument to the method.
Close the quick info popup manually
The quick info popup in Scheduler can be closed using the closeQuickInfoPopup public method. The following code example demonstrates how to close the quick info popup manually.
More events indicator and popup
When the number of appointments in a particular time range exceeds the default appointment height of a cell in month view and all timeline views, a + more text indicator is displayed at the bottom of those cells. This indicator denotes that the cell contains additional appointments, and clicking on it displays a popup with all the appointments present on that day.
To disable the popup displaying all hidden appointments, when clicking on the text indicator, use code customization within the
popupOpenevent.
The same indicator is displayed on the all-day row in calendar views such as day, week and work week views, when the number of appointments present in a cell exceeds three. Clicking on the text indicator here does not open a popup, but allows the expand/collapse option for viewing the remaining appointments present in the all-day row.
The following code example shows how to disable the display of such popups when clicking on the more text indicator.
Customize the popup that opens on more indicator
The following code example shows how to customize the default more indicator popup by displaying the number of events rendered that day in the header.
Prevent the display of popup when clicking on the more text indicator
The display of the popup window can be prevented by passing the value true to the cancel option within the MoreEventsClick event.
Navigate to Day view when clicking on more text indicator
The following code example shows how to customize the moreEventsClick event to navigate to the Day view when clicking on the more text indicator.
Refer to our JavaScript Scheduler feature tour page for its groundbreaking feature representations. You can also explore our JavaScript Scheduler example to learn how to present and manipulate data.