API reference
Generated from each primitive's $props() declaration.
Calendar.Root
| Prop | Type | Default | Description |
|---|---|---|---|
| ref bind: | HTMLElement | null | null | |
| value bind: | — | — | |
| placeholder bind: | — | — | |
| class as className | string | — | |
| weekdayFormat | string | "short" | |
| buttonVariant | string | "ghost" | |
| captionLayout | string | "label" | |
| locale | string | "en-US" | |
| months as monthsProp | — | — | |
| years | — | — | |
| monthFormat as monthFormatProp | — | — | |
| yearFormat | string | "numeric" | |
| day | Snippet | — | |
| disableDaysOutsideMonth | boolean | false | |
| ...restProps | Record<string, unknown> | — | Remaining attributes, spread onto the underlying element. |
Calendar.Caption
Date picker and calendar display.
| Prop | Type | Default | Description |
|---|---|---|---|
| captionLayout | — | — | |
| months | — | — | |
| monthFormat | — | — | |
| years | — | — | |
| yearFormat | — | — | |
| month | — | — | |
| locale | — | — | |
| placeholder bind: | — | — | |
| monthIndex | number | 0 |
Calendar.Cell
Date picker and calendar display.
| Prop | Type | Default | Description |
|---|---|---|---|
| ref bind: | HTMLElement | null | null | |
| class as className | string | — | |
| ...restProps | Record<string, unknown> | — | Remaining attributes, spread onto the underlying element. |
Calendar.Day
Date picker and calendar display with dark mode support.
| Prop | Type | Default | Description |
|---|---|---|---|
| ref bind: | HTMLElement | null | null | |
| class as className | string | — | |
| ...restProps | Record<string, unknown> | — | Remaining attributes, spread onto the underlying element. |
Calendar.Grid
Date picker and calendar display.
| Prop | Type | Default | Description |
|---|---|---|---|
| ref bind: | HTMLElement | null | null | |
| class as className | string | — | |
| ...restProps | Record<string, unknown> | — | Remaining attributes, spread onto the underlying element. |
Calendar.GridBody
Date picker and calendar display.
| Prop | Type | Default | Description |
|---|---|---|---|
| ref bind: | HTMLElement | null | null | |
| class as className | string | — | |
| ...restProps | Record<string, unknown> | — | Remaining attributes, spread onto the underlying element. |
Calendar.GridHead
Date picker and calendar display.
| Prop | Type | Default | Description |
|---|---|---|---|
| ref bind: | HTMLElement | null | null | |
| class as className | string | — | |
| ...restProps | Record<string, unknown> | — | Remaining attributes, spread onto the underlying element. |
Calendar.GridRow
Date picker and calendar display.
| Prop | Type | Default | Description |
|---|---|---|---|
| ref bind: | HTMLElement | null | null | |
| class as className | string | — | |
| ...restProps | Record<string, unknown> | — | Remaining attributes, spread onto the underlying element. |
Calendar.HeadCell
Date picker and calendar display.
| Prop | Type | Default | Description |
|---|---|---|---|
| ref bind: | HTMLElement | null | null | |
| class as className | string | — | |
| ...restProps | Record<string, unknown> | — | Remaining attributes, spread onto the underlying element. |
Calendar.Header
Date picker and calendar display.
| Prop | Type | Default | Description |
|---|---|---|---|
| ref bind: | HTMLElement | null | null | |
| class as className | string | — | |
| ...restProps | Record<string, unknown> | — | Remaining attributes, spread onto the underlying element. |
Calendar.Heading
Date picker and calendar display.
| Prop | Type | Default | Description |
|---|---|---|---|
| ref bind: | HTMLElement | null | null | |
| class as className | string | — | |
| ...restProps | Record<string, unknown> | — | Remaining attributes, spread onto the underlying element. |
Calendar.Month
Date picker and calendar display.
| Prop | Type | Default | Description |
|---|---|---|---|
| ref bind: | HTMLElement | null | null | |
| class as className | string | — | |
| children | Snippet | — | |
| ...restProps | Record<string, unknown> | — | Remaining attributes, spread onto the underlying element. |
Calendar.Months
Date picker and calendar display.
| Prop | Type | Default | Description |
|---|---|---|---|
| ref bind: | HTMLElement | null | null | |
| class as className | string | — | |
| children | Snippet | — | |
| ...restProps | Record<string, unknown> | — | Remaining attributes, spread onto the underlying element. |
Calendar.MonthSelect
Date picker and calendar display.
| Prop | Type | Default | Description |
|---|---|---|---|
| ref bind: | HTMLElement | null | null | |
| class as className | string | — | |
| value | — | — | |
| onchange | — | — | |
| ...restProps | Record<string, unknown> | — | Remaining attributes, spread onto the underlying element. |
Calendar.Nav
Date picker and calendar display.
| Prop | Type | Default | Description |
|---|---|---|---|
| ref bind: | HTMLElement | null | null | |
| class as className | string | — | |
| children | Snippet | — | |
| ...restProps | Record<string, unknown> | — | Remaining attributes, spread onto the underlying element. |
Calendar.NextButton
Date picker and calendar display.
| Prop | Type | Default | Description |
|---|---|---|---|
| ref bind: | HTMLElement | null | null | |
| class as className | string | — | |
| children | — | — | |
| variant | string | "ghost" | |
| ...restProps | Record<string, unknown> | — | Remaining attributes, spread onto the underlying element. |
Calendar.PrevButton
Date picker and calendar display.
| Prop | Type | Default | Description |
|---|---|---|---|
| ref bind: | HTMLElement | null | null | |
| class as className | string | — | |
| children | — | — | |
| variant | string | "ghost" | |
| ...restProps | Record<string, unknown> | — | Remaining attributes, spread onto the underlying element. |
Calendar.YearSelect
Date picker and calendar display.
| Prop | Type | Default | Description |
|---|---|---|---|
| ref bind: | HTMLElement | null | null | |
| class as className | string | — | |
| value | — | — | |
| ...restProps | Record<string, unknown> | — | Remaining attributes, spread onto the underlying element. |