IUseCalendarOptions
interface
Composable Options
Options consumed by the useCalendar composable. All fields are thunks (getter functions) so the composable stays reactive without owning the prop reference directly.
TypeScript
Definition
The TypeScript interface definition as found in the origam source. Click the copy icon to copy the snippet.
API
Properties
Every property declared by this interface, with its type, optionality and default.
- eventsrequired() => Array<IEvent>
- Getter returning the current event array. Recurring events are expanded internally by the composable.
- viewrequired() => TCalendarView
- Getter returning the active view mode (month / week / day / agenda).
- currentDaterequired() => Date
- Getter returning the anchor date for the currently rendered range.
- firstDayOfWeekrequired() => number
- Getter returning the first weekday column index (0 = Sunday, 1 = Monday).
- slotDurationrequired() => number
- Getter returning the minutes per time slot row in week/day views (15, 30, or 60).
- dayStartHourrequired() => number
- Getter returning the first rendered hour in week/day views (0–23).
- dayEndHourrequired() => number
- Getter returning the last rendered hour in week/day views (1–24).
- minDate() => Date | null
- Optional getter returning the lower navigation bound. Prev navigation is disabled before this date.
- maxDate() => Date | null
- Optional getter returning the upper navigation bound. Next navigation is disabled after this date.
- locale() => string
- Optional getter returning the BCP 47 locale tag for weekday/month name formatting.
Ecosystem
Used by
Components and composables that extend or consume this interface.
Usage
Examples
Ready-to-paste code snippets using this interface.
Passing options to useCalendar