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
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.
- eventsrequis() => Array<IEvent>
- Getter returning the current event array. Recurring events are expanded internally by the composable.
- viewrequis() => TCalendarView
- Getter returning the active view mode (month / week / day / agenda).
- currentDaterequis() => Date
- Getter returning the anchor date for the currently rendered range.
- firstDayOfWeekrequis() => number
- Getter returning the first weekday column index (0 = Sunday, 1 = Monday).
- slotDurationrequis() => number
- Getter returning the minutes per time slot row in week/day views (15, 30, or 60).
- dayStartHourrequis() => number
- Getter returning the first rendered hour in week/day views (0–23).
- dayEndHourrequis() => 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.
Écosystème
Utilisé par
Composants et composables qui étendent ou consomment cette interface.
Usage
Exemples
Extraits de code prêts à coller utilisant cette interface.
Passing options to useCalendar