JSVision

Appearance

@jsvision/ui / CalendarOptions

Interface: CalendarOptions ​

Defined in: ui/src/date/calendar.ts:63

Options for a Calendar.

Properties ​

density? ​

optional density?: CalendarDensity

Defined in: ui/src/date/calendar.ts:83

Layout density (default 'comfortable'): 'compact' is tightest (~20×8), 'comfortable' is the roomy default (4-wide cells + a Today footer, ~28×10), 'spacious' adds breathing room (5-wide cells + blank week spacers, ~35×15).

firstDayOfWeek? ​

optional firstDayOfWeek?: 0 | 1

Defined in: ui/src/date/calendar.ts:75

0 = Sunday (default) | 1 = Monday (ISO).

isDisabled? ​

optional isDisabled?: (date) => boolean

Defined in: ui/src/date/calendar.ts:73

Predicate that dims a day: it stays navigable but cannot be committed.

Parameters ​

date ​

CalendarDate

Returns ​

boolean

max? ​

optional max?: CalendarDate

Defined in: ui/src/date/calendar.ts:71

Inclusive navigation upper bound.

min? ​

optional min?: CalendarDate

Defined in: ui/src/date/calendar.ts:69

Inclusive navigation lower bound (the cursor never leaves [min,max]).

onChange? ​

optional onChange?: (date) => void

Defined in: ui/src/date/calendar.ts:85

Fired when value changes.

Parameters ​

date ​

CalendarDate

Returns ​

void

showWeekNumbers? ​

optional showWeekNumbers?: boolean

Defined in: ui/src/date/calendar.ts:77

Opt-in leading ISO week-number column (default false; adds 3 columns).

today? ​

optional today?: CalendarDate

Defined in: ui/src/date/calendar.ts:67

The day to highlight as "today" (default: the system clock at construction; pass it for tests).

value ​

value: Signal<CalendarDate | null>

Defined in: ui/src/date/calendar.ts:65

Two-way selected day (null = no selection).