calendarkit-pro 1.2.1 → 1.3.0

package/README.md

@@ -84,7 +84,9 @@ function MyCalendar() {
 | `onEventCreate` | `(event: Partial<CalendarEvent>) => void` | Event creation callback |
 | `onEventUpdate` | `(event: CalendarEvent) => void` | Event update callback |
 | `onEventDelete` | `(eventId: string) => void` | Event deletion callback |
-| `onEventResize` | `(event, start, end) => void` | Event resize callback |
+| `onEventDrop` | `(event, start, end) => void` | Called when an event is dropped (with the event before the move and its new dates), alongside `onEventUpdate` |
+| `onEventResize` | `(event, start, end) => void` | Called when an event is resized, alongside `onEventUpdate` (both fire, so update your state in only one of them) |
+| `onOccurrenceDelete` | `(occurrence, updatedSeries) => void` | Delete a single occurrence of a recurring event: persist `updatedSeries` (it has the date in `recurrence.exdates`). Without it, deleting an occurrence deletes the series |
 | `calendars` | `Calendar[]` | Multiple calendar support |
 | `resources` | `Resource[]` | Resources for resource view |
 | `eventTypes` | `EventType[]` | Pre-defined event types |
@@ -125,7 +127,8 @@ interface CalendarEvent {
     interval?: number;
     count?: number;
     until?: Date;
-    byweekday?: number[];
+    byweekday?: number[]; // 0 = Monday … 6 = Sunday
+    exdates?: Date[];     // occurrence starts excluded from the series
   };
 }
 ```
@@ -192,6 +195,25 @@ const recurringEvent: CalendarEvent = {
 };
 ```
 
+Occurrences keep their wall-clock time across daylight-saving changes, in the `timezone` prop's zone (or the browser's).
+
+Moving, resizing or editing one occurrence updates the whole series by the same amount (`onEventUpdate` receives the recurring event). To delete a single occurrence, handle `onOccurrenceDelete`:
+
+```tsx
+<Scheduler
+  events={events}
+  onOccurrenceDelete={(occurrence, updatedSeries) => {
+    setEvents(events.map(e => (e.id === updatedSeries.id ? updatedSeries : e)));
+  }}
+/>
+```
+
+### Invalid data
+
+Dates may be `Date` objects, ISO strings or timestamps. Events with an invalid date or an end before their start are skipped, with a warning in development. Event ids must be unique (duplicates are rendered but warned about, and break drag & drop).
+
+Treat events as immutable: to change an event, pass a new object (`events.map(e => e.id === id ? { ...e, title } : e)`). Computations are cached per event object, so mutating an event in place may not be reflected.
+
 ## Timezone Support
 
 ```tsx

package/dist/index.d.mts

@@ -111,7 +111,13 @@ interface CalendarEvent {
         count?: number;
         until?: Date;
         byweekday?: number[];
+        /** Occurrence start dates excluded from the series. */
+        exdates?: Date[];
     };
+    /** Set on expanded occurrences: id of the recurring (master) event. */
+    originalEventId?: string;
+    /** Set on expanded occurrences: start of this occurrence. */
+    occurrenceStart?: Date;
     [key: string]: any;
 }
 interface EventType {
@@ -154,6 +160,12 @@ interface CalendarProps {
     onEventCreate?: (event: Partial<CalendarEvent>) => void;
     onEventUpdate?: (event: CalendarEvent) => void;
     onEventDelete?: (eventId: string) => void;
+    /**
+     * Called when a single occurrence of a recurring event is deleted. `updatedSeries` is the master
+     * event with that occurrence added to `recurrence.exdates`: persist it to delete only this
+     * occurrence. Without this prop, deleting an occurrence deletes the whole series (`onEventDelete`).
+     */
+    onOccurrenceDelete?: (occurrence: CalendarEvent, updatedSeries: CalendarEvent) => void;
     theme?: CalendarTheme;
     locale?: Locale;
     timezone?: string;

package/dist/index.d.ts

@@ -111,7 +111,13 @@ interface CalendarEvent {
         count?: number;
         until?: Date;
         byweekday?: number[];
+        /** Occurrence start dates excluded from the series. */
+        exdates?: Date[];
     };
+    /** Set on expanded occurrences: id of the recurring (master) event. */
+    originalEventId?: string;
+    /** Set on expanded occurrences: start of this occurrence. */
+    occurrenceStart?: Date;
     [key: string]: any;
 }
 interface EventType {
@@ -154,6 +160,12 @@ interface CalendarProps {
     onEventCreate?: (event: Partial<CalendarEvent>) => void;
     onEventUpdate?: (event: CalendarEvent) => void;
     onEventDelete?: (eventId: string) => void;
+    /**
+     * Called when a single occurrence of a recurring event is deleted. `updatedSeries` is the master
+     * event with that occurrence added to `recurrence.exdates`: persist it to delete only this
+     * occurrence. Without this prop, deleting an occurrence deletes the whole series (`onEventDelete`).
+     */
+    onOccurrenceDelete?: (occurrence: CalendarEvent, updatedSeries: CalendarEvent) => void;
     theme?: CalendarTheme;
     locale?: Locale;
     timezone?: string;