ICalendarProps

interface
Data & Items

Props for calendar grid components — controls the visible month/year, selected dates, allowed-dates predicate, min/max bounds, weekday layout and adjacent-month visibility.

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.

allowedDates
Array<unknown> | ((date: unknown) => boolean)
An array of allowed date values, or a function returning true for dates that should be selectable.
disabled
boolean
Disables all date interactions.
displayValue
unknown
The date value used for display purposes (e.g. hover highlight).
date
ReadonlyArray<unknown> | Array<unknown>
Currently selected date(s).
month
number
The month currently displayed (0-indexed).
max
unknown
The maximum selectable date.
min
unknown
The minimum selectable date.
showAdjacentMonths
boolean
Show days from the previous and next months in the current grid.
year
number
The year currently displayed.
weekdays
Array<number>
Array of weekday indices to display (0 = Sunday … 6 = Saturday).
weeksInMonth
TCalendarStrategy
Strategy for computing the number of week rows in the month view.
firstDayOfWeek
number
Index of the first day of the week (0 = Sunday, 1 = Monday…).

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Basic date picker with min/max

vue