Documentation / @zerotal/flow-ui / index / CalendarProps

Interface: CalendarProps

Defined in: flow-ui/src/components/Calendar.tsx:42

Indexable

[key: string]: unknown

Properties

bind?

optional bind?: unknown

Defined in: flow-ui/src/components/Calendar.tsx:50

Bound

Expose

YYYY-MM-DD, for a picker.

With this set the calendar runs on the client: months page instantly and a chosen day syncs once. Prefer it to onSelect for anything that is picking rather than browsing.

name?

optional name?: string

Defined in: flow-ui/src/components/Calendar.tsx:51

month?

optional month?: string

Defined in: flow-ui/src/components/Calendar.tsx:53

Month to show, YYYY-MM. Defaults to the month of value, else today.

value?

optional value?: string

Defined in: flow-ui/src/components/Calendar.tsx:55

Selected day, YYYY-MM-DD.

onSelect?

optional onSelect?: unknown

Defined in: flow-ui/src/components/Calendar.tsx:57

Server action receiving the clicked YYYY-MM-DD. Only for a server-driven grid.

events?

optional events?: CalendarEvent[]

Defined in: flow-ui/src/components/Calendar.tsx:59

Records to lay out across the month.

min?

optional min?: string

Defined in: flow-ui/src/components/Calendar.tsx:61

Days before this are not selectable. YYYY-MM-DD.

max?

optional max?: string

Defined in: flow-ui/src/components/Calendar.tsx:62

sundayFirst?

optional sundayFirst?: boolean

Defined in: flow-ui/src/components/Calendar.tsx:64

Start weeks on Sunday instead of Monday.

monthHref?

optional monthHref?: (month) => string

Defined in: flow-ui/src/components/Calendar.tsx:66

Build the href for the previous/next month links. Omit for a static grid.

Parameters

month

string

Returns

string

class?

optional class?: string

Defined in: flow-ui/src/components/Calendar.tsx:67