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

Definition

The TypeScript interface definition as found in the origam source. Click the copy icon to copy the snippet.

typescript

Inheritance

Extends

Parent interfaces this one inherits from. Their properties are available on every consumer of this interface.

API

Properties

Every property declared by this interface, with its type, optionality and default.

view
TCalendarView
Active view mode. Two-way binding via v-model:view.
currentDate
Date | string
Anchor date. Two-way binding via v-model:currentDate.
events
Array<IEvent>
Event list. Recurring events are expanded internally.
firstDayOfWeek
0 | 1 | 2 | 3 | 4 | 5 | 6
1
First weekday rendered as the leftmost column. 1 (Monday) for EU/ISO, 0 (Sunday) for US.
timeFormat
TCalendarTimeFormat
'24h'
Clock format for time labels.
locale
string
BCP 47 locale tag — drives weekday and month names.
selectable
boolean
true
Enable drag-select on the grid.
eventColorKey
'category' | 'color' | string
'category'
Which property of IEvent to read for colouring.
categoryColors
Record<string, TIntent | string>
Map category string → intent / CSS colour.
weekendHighlight
boolean
true
Tint Saturday + Sunday in month/week views.
showWeekNumbers
boolean
false
Render a leading ISO week-number column.
dayStartHour
number
0
First hour rendered in week/day views.
dayEndHour
number
24
Last hour rendered in week/day views.
slotDuration
number
30
Minutes per row in the timeline. 30 for half-hour granularity, 15 for fine-grained drag-create, 60 for compact.
minDate
Date | string
Lower navigation bound. The toolbar disables < past this.
maxDate
Date | string
Upper navigation bound. The toolbar disables > past this.
disabledDates
Array<Date | string> | ((d: Date) => boolean)
Cells to grey out. Accepts an array (Dates or ISO strings) or a predicate.

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Calendar with events and week view

html