ICalendarDaySlotBindings

interface
Slots

Bindings handed to the #day slot of <OrigamCalendar> — one object per cell in month view, providing the date and its contextual flags (today, past, outside month, weekend, disabled).

TypeScript

Definition

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

typescript

API

Properties

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

date
required
Date
The Date object this cell represents.
events
required
Array<IEvent>
Events that fall on this date.
isToday
required
boolean
True when the cell represents today.
isPast
required
boolean
True when the date is in the past relative to today.
isOutside
required
boolean
True when the cell is outside the currently displayed month (leading/trailing filler days).
isWeekend
required
boolean
True when the day is Saturday or Sunday.
isDisabled
required
boolean
True when the date matches a disabledDates rule.

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Custom day cell in month view

html