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.
API
Properties
Every property declared by this interface, with its type, optionality and default.
- allowedDatesArray<unknown> | ((date: unknown) => boolean)
- An array of allowed date values, or a function returning true for dates that should be selectable.
- disabledboolean
- Disables all date interactions.
- displayValueunknown
- The date value used for display purposes (e.g. hover highlight).
- dateReadonlyArray<unknown> | Array<unknown>
- Currently selected date(s).
- monthnumber
- The month currently displayed (0-indexed).
- maxunknown
- The maximum selectable date.
- minunknown
- The minimum selectable date.
- showAdjacentMonthsboolean
- Show days from the previous and next months in the current grid.
- yearnumber
- The year currently displayed.
- weekdaysArray<number>
- Array of weekday indices to display (0 = Sunday … 6 = Saturday).
- weeksInMonthTCalendarStrategy
- Strategy for computing the number of week rows in the month view.
- firstDayOfWeeknumber
- 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