Mixins / foldkit-mixins-ui

CalendarOptions

interface · packages/mixins-ui/src/calendar.ts:259

interface CalendarOptions<Message> {
  readonly render?: ((resolved: ResolvedCalendar<Message>) => Html) | undefined
  readonly weekNumbers?: boolean | undefined
  readonly caption?: 'grid' | 'label' | undefined
  readonly dropdowns?: Dropdowns<Message> | undefined
  readonly paging?: 'both' | 'previous' | 'next' | 'none' | undefined
  readonly preview?: Preview<Message> | undefined
}

What a Calendar draws beyond upstream's grid. Every option is off by default.

In the guides

Members

CalendarOptions.render

property · packages/mixins-ui/src/calendar.ts:261

readonly render?: ((resolved: ResolvedCalendar<Message>) => Html) | undefined

Draws the resolved bundles; default draw.

CalendarOptions.weekNumbers

property · packages/mixins-ui/src/calendar.ts:263

readonly weekNumbers?: boolean | undefined

A column of ISO 8601 week numbers before the days.

CalendarOptions.caption

property · packages/mixins-ui/src/calendar.ts:269

readonly caption?: 'grid' | 'label' | undefined

The days' heading: grid (default) is a button opening a grid of months, then of years; label the month and year as text. dropdowns replaces either.

property · packages/mixins-ui/src/calendar.ts:270

readonly dropdowns?: Dropdowns<Message> | undefined

CalendarOptions.paging

property · packages/mixins-ui/src/calendar.ts:275

readonly paging?: 'both' | 'previous' | 'next' | 'none' | undefined

Which paging buttons are drawn; default both. Two months side by side draw previous on the first and next on the second.

CalendarOptions.preview

property · packages/mixins-ui/src/calendar.ts:276

readonly preview?: Preview<Message> | undefined