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

Définition

La définition TypeScript de l'interface telle que trouvée dans le code source d'origam. Cliquez sur l'icône de copie pour copier l'extrait.

typescript

API

Propriétés

Chaque propriété déclarée par cette interface, avec son type, son caractère optionnel et sa valeur par défaut.

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

Écosystème

Utilisé par

Composants et composables qui étendent ou consomment cette interface.

Usage

Exemples

Extraits de code prêts à coller utilisant cette interface.

Consuming resolved options in a custom calendar composable

typescript