ICalendarSlots

interface
Calendar

Slot signatures exposed by OrigamCalendar. The default toolbar can be replaced wholesale via #header, individual events via #event, day cells via #day, day column headers via #dayHeader, and empty-agenda state via #empty.

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.

header
(bindings: ICalendarHeaderSlotBindings) => any
Full toolbar replacement. Receives view, title, canPrev, canNext, navigate and setView.
event
(bindings: ICalendarEventSlotBindings) => any
Custom event chip renderer. Receives the IEvent object plus isPast and isToday context flags.
day
(bindings: ICalendarDaySlotBindings) => any
Custom day cell renderer (month view). Receives date, events array, isToday, isPast, isOutside, isWeekend, isDisabled.
dayHeader
(bindings: { date: Date }) => any
Custom day column header (week / day views). Receives the column Date.
empty
(bindings: { view: TCalendarView }) => any
Rendered in agenda view when no events are present for the current period.

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Using the #day slot to add custom content in month cells

vue