Skip to main content

API Helpers Overview

Helpers re-exported from @svar-ui/svelte-calendar alongside the Calendar component: companion Svelte components (CalendarPanel, ContextMenu, Editor), factory functions for default toolbar, menu, and editor items, registry functions for custom editor fields and custom views, iCal import/export utilities, the REST data provider, and the built-in ViewModel subclasses.

Helpers

AgendaViewModelBuilt-in ViewModel subclass that renders a chronological list grouped by day for one calendar month
CalendarPanelSidebar component with calendar-group filter checkboxes and a mini date picker
ContextMenuCompanion component that adds a right-click menu to wrapped Calendar content
DayViewModelViewModel subclass that powers the built-in day view
EditorSelection-driven event editor wired to the Calendar API
getEditorItemsReturns the default editor field definitions
getMenuOptionsReturns the default context-menu items used by ContextMenu
getToolbarItemsReturns the default toolbar items array
MonthViewModelPre-registered view model class for the built-in month view
parseICalParses an iCalendar text payload into an array of CalendarEvent objects
registerCalendarViewRegisters a ViewModel class under a string id so it can be used in the views prop
registerEditorItemRegisters a Svelte component as a named editor field type
ResourcesViewModelBuilt-in ViewModel subclass that lays out resources as columns and time as rows for a single day
RestDataProviderREST provider class that wires Calendar mutations to a backend events collection
serializeICalSerializes an array of CalendarEvents into an iCalendar (.ics) string
TimelineViewModelBuilt-in ViewModel subclass that lays out resource rows on the y-axis with time on the x-axis for a single day
WeekViewModelViewModel class powering the built-in week view; subclass to build workweek or multi-week variants
YearViewModelBuilt-in ViewModel for the year overview view