IResolvedCalendarOptions

interface
Data Display

Resolved, fully-defaulted option object produced by the useCalendar composable after normalising ICalendarComponentProps. Every field is non-optional at this layer — the composable guarantees a concrete value for each, so downstream rendering logic never has to guard against undefined.

TypeScript

Definition

The TypeScript interface definition as found in the origam source. Click the copy icon to copy the snippet.

typescript

API

Properties

Every property declared by this interface, with its type, optionality and default.

view
required
TCalendarView
Active view mode — month, week, day, or agenda.
currentDate
required
Date
Anchor date driving the currently rendered period.
events
required
Array<IEvent>
Expanded event list; recurring events have been unwrapped into concrete occurrences.
firstDayOfWeek
required
number
Weekday index (0=Sunday, 1=Monday) for the leftmost column header.
timeFormat
required
TCalendarTimeFormat
Clock display format — "12h" or "24h".
locale
required
string
BCP 47 locale tag used for weekday and month name rendering.
selectable
required
boolean
Whether drag-select on the grid is enabled.
eventColorKey
required
string
Property name read from IEvent for colour resolution ("category" or "color").
categoryColors
required
Record<string, TIntent | string>
Map from category string to intent token or raw CSS colour.
weekendHighlight
required
boolean
Whether Saturday and Sunday receive a tinted background in month/week views.
showWeekNumbers
required
boolean
Whether an ISO week-number column is prepended in week/month views.
dayStartHour
required
number
First hour rendered in the timeline for week and day views.
dayEndHour
required
number
Last hour rendered in the timeline for week and day views.
slotDuration
required
number
Minutes per timeline row — 15, 30, or 60.
minDate
required
Date | null
Lower navigation bound; null means no lower limit.
maxDate
required
Date | null
Upper navigation bound; null means no upper limit.
disabledDatesPredicate
required
(date: Date) => boolean
Compiled predicate derived from the disabledDates prop — always a function at this layer.

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Consuming resolved options in a custom calendar composable

typescript