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.
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.
- viewrequisTCalendarView
- Active view mode — month, week, day, or agenda.
- currentDaterequisDate
- Anchor date driving the currently rendered period.
- eventsrequisArray<IEvent>
- Expanded event list; recurring events have been unwrapped into concrete occurrences.
- firstDayOfWeekrequisnumber
- Weekday index (0=Sunday, 1=Monday) for the leftmost column header.
- timeFormatrequisTCalendarTimeFormat
- Clock display format — "12h" or "24h".
- localerequisstring
- BCP 47 locale tag used for weekday and month name rendering.
- selectablerequisboolean
- Whether drag-select on the grid is enabled.
- eventColorKeyrequisstring
- Property name read from IEvent for colour resolution ("category" or "color").
- categoryColorsrequisRecord<string, TIntent | string>
- Map from category string to intent token or raw CSS colour.
- weekendHighlightrequisboolean
- Whether Saturday and Sunday receive a tinted background in month/week views.
- showWeekNumbersrequisboolean
- Whether an ISO week-number column is prepended in week/month views.
- dayStartHourrequisnumber
- First hour rendered in the timeline for week and day views.
- dayEndHourrequisnumber
- Last hour rendered in the timeline for week and day views.
- slotDurationrequisnumber
- Minutes per timeline row — 15, 30, or 60.
- minDaterequisDate | null
- Lower navigation bound; null means no lower limit.
- maxDaterequisDate | null
- Upper navigation bound; null means no upper limit.
- disabledDatesPredicaterequis(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