ICalendarComponentProps
interface
Component Props
Props for <OrigamCalendar> — a full-featured calendar with month/week/day/agenda views, event management, drag-select, recurring event expansion, locale support, and the full origam cross-cutting surface.
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.
Héritage
Hérite de
Interfaces parentes dont celle-ci hérite. Leurs propriétés sont disponibles pour tout consommateur de cette interface.
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.
- viewTCalendarView
- Active view mode. Two-way binding via v-model:view.
- currentDateDate | string
- Anchor date. Two-way binding via v-model:currentDate.
- eventsArray<IEvent>
- Event list. Recurring events are expanded internally.
- firstDayOfWeek0 | 1 | 2 | 3 | 4 | 5 | 61
- First weekday rendered as the leftmost column. 1 (Monday) for EU/ISO, 0 (Sunday) for US.
- timeFormatTCalendarTimeFormat'24h'
- Clock format for time labels.
- localestring
- BCP 47 locale tag — drives weekday and month names.
- selectablebooleantrue
- Enable drag-select on the grid.
- eventColorKey'category' | 'color' | string'category'
- Which property of IEvent to read for colouring.
- categoryColorsRecord<string, TIntent | string>
- Map category string → intent / CSS colour.
- weekendHighlightbooleantrue
- Tint Saturday + Sunday in month/week views.
- showWeekNumbersbooleanfalse
- Render a leading ISO week-number column.
- dayStartHournumber0
- First hour rendered in week/day views.
- dayEndHournumber24
- Last hour rendered in week/day views.
- slotDurationnumber30
- Minutes per row in the timeline. 30 for half-hour granularity, 15 for fine-grained drag-create, 60 for compact.
- minDateDate | string
- Lower navigation bound. The toolbar disables < past this.
- maxDateDate | string
- Upper navigation bound. The toolbar disables > past this.
- disabledDatesArray<Date | string> | ((d: Date) => boolean)
- Cells to grey out. Accepts an array (Dates or ISO strings) or a predicate.
Écosystème
Utilisé par
Composants et composables qui étendent ou consomment cette interface.
Usage
Exemples
Extraits de code prêts à coller utilisant cette interface.
Calendar with events and week view