Recurrence Editor
The Recurrence Editor allows the creation and customization of repeating event patterns and follows the iCalendar specifications. By selecting options such as frequency, interval, days, and end conditions, the repeating behavior of an event can be defined over time. This provides a clear and intuitive way to manage recurring schedules with flexibility and full control.
Generate the recurrence rule
The recurrence rule is generated based on the settings chosen in the Recurrence Editor. When any field in the editor is changed, the onChange event is triggered, and the updated rule can be accessed through the value property.
Set recurrence rule
By providing a recurrence rule string, the recurrence editor can load its initial settings automatically. The recurrence editor then updates its value and triggers the onChange property to match the rule.
Editor customization
The Recurrence Editor can be configured to display only the required options, such as specific repeat types or end conditions. By customizing these fields, the editor becomes simpler to navigate and supports a more efficient setup of recurring events.
Configuring the repeat type option
By customizing the frequencies array, the repeat type dropdown can be limited to the default options. By default, it includes DAILY, WEEKLY, MONTHLY, and YEARLY.
Configuring the end type option
By customizing the endType array, the dropdown can be limited to specific options. By default, the end type dropdown includes Never, Count, and Until.
Recurrence date generation
Recurrence date generation turns a recurrence rule into a list of actual dates. The getRecurrenceSummary method reads the rule and locale, then creates the summary of the rule based on the selected pattern and localeObject properties as optional. The getRecurrenceDates method reads the rule and start date, then creates all matching occurrences based on the selected pattern and optional settings.
| Prop | Type | Description |
|---|---|---|
startDate | Date | Renders the recurrence editor with the start date. |
rule | String | Defines the recurrence rule that determines the frequency, pattern, and end conditions used to generate the recurring dates. |
excludeDate | String | Specifies a collection of ISO‑formatted dates that should be excluded from the recurrence. Providing this value is optional. |
maximumCount | Number | Specifies how many recurrence dates should be generated. Providing this value is optional. |
viewDate | Date | Specifies the starting date of the current view range. Providing this value is optional. |
The getRecurrenceSummary method returns a summary of rule based on the properties provided. The getRecurrenceDates method returns a list of dates based on the properties provided.