Skip to main content

recurring

Enables recurring event support. When true, the store expands events with an rrule field into individual occurrences and supports editing a single occurrence or this-and-following. When false, events with rrule are stored as plain one-off records.

PRO

The functionality is available in PRO Edition only

Usage

recurring?: boolean;

Default: false.

When enabled, additional fields on CalendarEvent are interpreted by the store:

FieldTypeDescription
rrulestringiCalendar RRULE string defining the pattern
masterEventIdEventIDLinks an exception event to its master
originalDateDateOriginal occurrence date for an exception
exdatesDate[]Dates excluded from the recurrence
durationnumberSingle-instance duration in ms (computed by store)

Example

<script setup lang="ts">
import { Calendar } from "@svar-ui/vue-calendar";

const events = [
{
id: 1,
start: new Date(2025, 9, 6, 9, 0),
end: new Date(2025, 9, 6, 9, 30),
text: "Daily standup",
rrule: "FREQ=DAILY;COUNT=10",
},
];
</script>

<template>
<Calendar :events="events" :date="new Date(2025, 9, 6)" :recurring="true" />
</template>
  • events — fields on CalendarEvent that recurrence interprets.
  • update-eventmode: "single" | "following" for editing occurrences.
  • getEvents — read expanded instances within a range.
  • Recurring events — patterns, RRULE subset, and editing semantics.