ICalendarHeaderSlotBindings
interface
Calendar
Slot bindings injected into the #header slot of OrigamCalendar for a full toolbar replacement. Exposes view state, navigation guards and imperative callbacks so the custom header drives the calendar without extra wiring.
TypeScript
Definition
The TypeScript interface definition as found in the origam source. Click the copy icon to copy the snippet.
API
Properties
Every property declared by this interface, with its type, optionality and default.
- viewrequiredTCalendarView
- The currently active view mode.
- titlerequiredstring
- Human-readable label for the visible period (e.g. "June 2026" or "Jun 15 – 21, 2026").
- canPrevrequiredboolean
- False when the previous navigation step would exceed minDate.
- canNextrequiredboolean
- False when the next navigation step would exceed maxDate.
- setViewrequired(next: TCalendarView) => void
- Imperatively switch the calendar to a different view mode.
- navigaterequired(direction: TCalendarNavigate) => void
- Imperatively move the calendar forward or backward by one period.
Ecosystem
Used by
Components and composables that extend or consume this interface.
Usage
Examples
Ready-to-paste code snippets using this interface.
Custom toolbar via the #header slot