IDay
interface
Date & Time
Data shape for a single day cell in the Calendar grid. Carries display strings, boolean flags for all calendar states (selected, disabled, adjacent, etc.) and the raw adapter date value.
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.
- daterequiredunknown
- Raw adapter date value for this cell.
- isoDaterequiredstring
- ISO-8601 date string (YYYY-MM-DD) for this cell.
- formattedrequiredstring
- Adapter-formatted display string for the day number.
- yearrequirednumber
- Four-digit year of this cell.
- monthrequirednumber
- Zero-based month index of this cell.
- isDisabledrequiredboolean
- True when the day is outside the allowed date range.
- isWeekStartrequiredboolean
- True when the day is the first day of a week row.
- isWeekEndrequiredboolean
- True when the day is the last day of a week row.
- isTodayrequiredboolean
- True when the day corresponds to today's date.
- isAdjacentrequiredboolean
- True when the day belongs to the previous or next month (overflow cell).
- isHiddenrequiredboolean
- True when the cell should be visually hidden.
- isStartrequiredboolean
- True when the day is the start of a selected range.
- isSelectedrequiredboolean
- True when the day is the selected date or within a selected range.
- isEndrequiredboolean
- True when the day is the end of a selected range.
- isSamerequiredboolean
- True when start and end of the range land on the same day.
- localizedrequiredstring
- Locale-aware display string for the day number (e.g. "١" in Arabic).
Ecosystem
Used by
Components and composables that extend or consume this interface.
Usage
Examples
Ready-to-paste code snippets using this interface.
Consuming IDay in a calendar slot