Skip to main content

Methods Overview

The Calendar component exposes its instance API through bind:this or the init callback. The API covers state snapshots, action dispatch, event-bus subscription, and provider chaining.

<script>
import { Calendar } from "@svar-ui/svelte-calendar";
let api = $state();
</script>

<Calendar bind:this={api} events={[]} date={new Date()} />

Methods

detachRemoves a previously registered handler or interceptor by its tag
execDispatches a store action through interceptors, handlers, and the prop router
getEventReturns a single event by id
getEventsReturns the events stored in the calendar, optionally filtered by date range
getReactiveStateReturns reactive stores for each state field
getStateReturns a non-reactive snapshot of the calendar store state
getStoresReturns the raw store instances powering the calendar
interceptRegisters a handler that runs before built-in handlers and can cancel the action
onRegisters a handler that runs after an action is dispatched
setNextAppends a downstream handler at the end of the event bus chain