Skip to content

Calendar Options

Complete reference for the options object passed to .calendar.init().

Top-level init keys

KeyTypeDefaultDescription
selectorstring#haven-appDOM element to render into
formatstringlistCalendar format (see below)
dataarraynullPre-fetched event data
routingobjectsee RoutingURL routing configuration
optionsobject{}Feature options (below)

Formats

FormatDescription
listStandard event list
dailyDay-grouped view (forces cols: 1)
upcomingLimited upcoming events
ongoingOngoing events only
detailSingle event detail
itineraryCurated event list
contactcardContact card layout
featuredFeatured events

Layout

OptionTypeDefaultDescription
idstringhaven-listID of the generated list wrapper
sortstringnameSort field (date recommended for calendars)
colsnumber1Grid columns
maxWidthnumber/string1280Max container width (px)
responsiveobjectnullBreakpoint → { cols } map
cssstring''Additional CSS class
titleTagstringh3Heading tag for item titles
omitDetailsarray[]Detail fields to hide

Upcoming

Used when format: 'upcoming'.

OptionTypeDefaultDescription
upcoming.limitnumber5Maximum events to display

Ongoing

Used with format: 'daily' or other formats that split long-running events.

OptionTypeDefaultDescription
ongoing.lengthnumber14Day threshold for "ongoing" classification
ongoing.selectorstringnullContainer for ongoing event list
ongoing.containerstringnullSidebar wrapper (shown/hidden automatically)
ongoing.hideOnDetailbooleanfalseHide sidebar when viewing event detail
ongoing.excludebooleanfalseExclude ongoing events from main list
ongoing.applyFilterbooleantrueApply active filters to ongoing list

Images

Same structure as Directory Options:

javascript
images: {
  thumbnail: { ar: '3:2', w: 600, h: 400, fit: 'crop' },
  logo:      { ar: '3:2', w: 600, h: 400, fit: 'max' },
  featured:  { ar: '3:2', w: 1280, h: 400, fit: 'max' },
  banner:    { ar: '21:6', w: 1280, fit: 'crop' },
  gallery:   { ar: '16:9', w: 1280, fit: 'crop' },
}

Map

Same options as Directory. Enable with includeMap: true. See Maps and Lightbox.

Same options as Directory. Enable with includeLightbox: true.

OptionTypeDefaultDescription
lightbox.expandDirectionstringbottomtop, bottom, left, right

Filter

OptionTypeDescription
filter.selectorstringExternal filter container
filter.fields.dateobjectDate picker field (type: 'datepicker')
filter.fields.keywordobjectKeyword search field
filter.fields.typesobjectType dropdown field

See Filters and Search for field configuration.

Favorites

OptionTypeDescription
favesobjectFavorites configuration

Haven Destinations integration documentation