Calendar

Calendars present single-date or range selection in a compact month view.

Single Date

Use single mode when the interface needs one chosen day with minimal extra UI.

Disabled Days

Disabled ranges are useful for unavailable dates.

Date Ranges

Range mode works well for reporting, booking, and filtering flows where a start and end date belong together.

Dropdown Captions

Dropdown month and year captions help when users need to move quickly across larger time spans.

Two-Month Display

months="2" shows two months side by side — useful for ranges and booking-style UIs.

Week Numbers

withWeekNumbers adds an ISO 8601 week column.

View Stepper

Click the month/year title to step between day, month, and year views.

Days of Week

disabledDaysOfWeek takes space-separated weekday names (sun, mon, …).

API

Slots

Name	Description
previous-icon	—
next-icon	—
footer	—
day-YYYY-MM-DD	Custom content for a specific day cell

Props

Name	Description
bordered	When false, omits the outer frame — use inside popovers (e.g. pk-date-picker). Type boolean Default true
disabled	Type boolean Default false
disabledDatesRaw	Type string
disabledDaysOfWeek	Type string
disableFuture	Type boolean Default false
disablePast	Type boolean Default false
firstDayOfWeek	Type PkCalendarFirstDayOfWeek Default auto
focusedDate	Type string
locale	Type string
max	Type string
maxRange	Type number Default 0
min	Type string
minRange	Type number Default 0
mode	Type PkCalendarMode Default single
months	Type 1 | 2 Default 1
pageBy	Type PkCalendarPageBy Default months
readonly	Type boolean Default false
readOnly	Alias for readonly.
size	Type PkCalendarSize Default default
today	Type string
value	Type string
view	Type PkCalendarView Default days
weekdayFormat	Type 'narrow' | 'short' | 'long' Default narrow
withOutsideDays	Type boolean Default true
withWeekNumbers	Type boolean Default false

Events

Name	Description
onChange	User commits a new value
onInput	Value changes during interaction
onPkFocusDay	Focused day changed; detail.date
onPkViewChange	View changed; detail.view, detail.date