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.
API
Properties
Every property declared by this interface, with its type, optionality and default.
- viewrequiredTCalendarView
- Active view mode — month, week, day, or agenda.
- currentDaterequiredDate
- Anchor date driving the currently rendered period.
- eventsrequiredArray<IEvent>
- Expanded event list; recurring events have been unwrapped into concrete occurrences.
- firstDayOfWeekrequirednumber
- Weekday index (0=Sunday, 1=Monday) for the leftmost column header.
- timeFormatrequiredTCalendarTimeFormat
- Clock display format — "12h" or "24h".
- localerequiredstring
- BCP 47 locale tag used for weekday and month name rendering.
- selectablerequiredboolean
- Whether drag-select on the grid is enabled.
- eventColorKeyrequiredstring
- Property name read from IEvent for colour resolution ("category" or "color").
- categoryColorsrequiredRecord<string, TIntent | string>
- Map from category string to intent token or raw CSS colour.
- weekendHighlightrequiredboolean
- Whether Saturday and Sunday receive a tinted background in month/week views.
- showWeekNumbersrequiredboolean
- Whether an ISO week-number column is prepended in week/month views.
- dayStartHourrequirednumber
- First hour rendered in the timeline for week and day views.
- dayEndHourrequirednumber
- Last hour rendered in the timeline for week and day views.
- slotDurationrequirednumber
- Minutes per timeline row — 15, 30, or 60.
- minDaterequiredDate | null
- Lower navigation bound; null means no lower limit.
- maxDaterequiredDate | null
- Upper navigation bound; null means no upper limit.
- disabledDatesPredicaterequired(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