EventModel
Represents the complete data structure of a single event in the scheduler. Contains all event details including timing, location, and recurrence information, with support for custom properties. Provides a unified interface for event manipulation across all scheduler views and operations.
Props
The following table outlines the props for the EventModel:
| Name | Type | Default | Description |
|---|---|---|---|
| description | string | - | Additional notes, agenda items, or context for the event provided to attendees. Visible in event detail views, popups, or custom event templates. |
| endTime | Date | - | The exact date and time when the event concludes, determining its duration in the scheduler. Must be a valid JavaScript Date object later than the start time. |
| id | string | number | - | A unique identifier for the event used in update and delete operations. Can be a string or number depending on your data source configuration. |
| isAllDay | boolean | - | When true, the event spans the entire day and appears in the all-day row above timed events. Ideal for holidays, birthdays, deadlines, or events without specific times. |
| isBlock | boolean | - | When true, marks the event as a time block preventing scheduling of other events in the same slot. Commonly used for meetings, lunch breaks, maintenance windows, or reserved availability. |
| isReadonly | boolean | - | When true, prevents the event from being edited or deleted by end users. Useful for protecting critical events or events managed by administrators only. |
| location | string | - | The physical location or venue where the event occurs (in-person or virtual meeting link). Displayed alongside event details for attendee reference and planning. |
| recurrenceException | string | - | Recurrence exception rule string in RFC 5545 format (e.g., 'EXDATE=2024-01-01,2024-02-01'). Specifies dates or rules for skipping or excluding specific occurrences from a recurring series. |
| recurrenceID | string | number | - | The parent recurring event identifier linking this exception occurrence back to the original series. Used internally to manage and track modified instances within recurring event series. |
| recurrenceRule | string | - | Recurrence rule string in RFC 5545 format (e.g., 'FREQ=DAILY;INTERVAL=1;UNTIL=2025-12-31'). Defines event repetition patterns for daily, weekly, monthly, or yearly recurrence. |
| startTime | Date | - | The exact date and time when the event begins, determining its position in the scheduler. Must be a valid JavaScript Date object for proper scheduling. |
| subject | string | - | The event title or heading displayed in all scheduler views and event cards. Provides a concise summary of the event's purpose or topic. |
| [key: string] | unknown | - | Supports custom properties beyond standard event fields for flexible event data modeling. Allows extending event objects with domain-specific attributes and metadata. |