node_modules/@fullcalendar/common/main | PrimeFaces JavaScript API Docs

Index

References

renderMicroColGroup

Namespaces

createElement

Interfaces

Type Aliases

Variables

Functions

References

renderMicroColGroup

Renames and re-exports __type

Type Aliases

Action

Action: { type: "NOTHING" } | { optionName: string; rawOptionValue: any; type: "SET_OPTION" } | { type: "PREV" } | { type: "NEXT" } | { dateMarker: DateMarker; type: "CHANGE_DATE" } | { dateMarker?: DateMarker; type: "CHANGE_VIEW_TYPE"; viewType: string } | { selection: DateSpan; type: "SELECT_DATES" } | { type: "UNSELECT_DATES" } | { eventInstanceId: string; type: "SELECT_EVENT" } | { type: "UNSELECT_EVENT" } | { state: EventInteractionState; type: "SET_EVENT_DRAG" } | { type: "UNSET_EVENT_DRAG" } | { state: EventInteractionState; type: "SET_EVENT_RESIZE" } | { type: "UNSET_EVENT_RESIZE" } | { sources: EventSource<any>[]; type: "ADD_EVENT_SOURCES" } | { sourceId: string; type: "REMOVE_EVENT_SOURCE" } | { type: "REMOVE_ALL_EVENT_SOURCES" } | { isRefetch?: boolean; sourceIds?: string[]; type: "FETCH_EVENT_SOURCES" } | { fetchId: string; fetchRange: DateRange | null; rawEvents: EventInput[]; sourceId: string; type: "RECEIVE_EVENTS" } | { error: EventSourceError; fetchId: string; fetchRange: DateRange | null; sourceId: string; type: "RECEIVE_EVENT_ERROR" } | { eventStore: EventStore; type: "ADD_EVENTS" } | { eventStore: EventStore; type: "RESET_EVENTS" } | { eventStore: EventStore; type: "MERGE_EVENTS" } | { eventStore: EventStore; type: "REMOVE_EVENTS" } | { type: "REMOVE_ALL_EVENTS" }

AllDayMountArg

AllDayMountArg: MountArg<AllDayContentArg>

AllowFunc

AllowFunc: ((span: DateSpanApi, movingEvent: EventApi | null) => boolean)

Type declaration

- (span: DateSpanApi, movingEvent: EventApi | null): boolean
- Parameters
  - span: DateSpanApi
  - movingEvent: EventApi | null
  Returns boolean

BaseOptionsRefined

BaseOptionsRefined: DefaultedRefinedOptions<RefinedOptionsFromRefiners<Required<BaseOptionRefiners>>, keyof typeof BASE_OPTION_DEFAULTS>

BusinessHoursInput

BusinessHoursInput: boolean | EventInput | EventInput[]

CalendarListeners

CalendarListeners: Required<CalendarListenersLoose>

CalendarOptions

CalendarOptions: BaseOptions & CalendarListenersLoose & RawOptionsFromRefiners<Required<CalendarOptionRefiners>>

CalendarOptionsRefined

CalendarOptionsRefined: BaseOptionsRefined & CalendarListenersLoose & RefinedOptionsFromRefiners<Required<CalendarOptionRefiners>>

ChunkConfigContent

ChunkConfigContent: ((contentProps: ChunkContentCallbackArgs) => VNode)

Type declaration

- (contentProps: ChunkContentCallbackArgs): VNode
- Parameters
  - contentProps: ChunkContentCallbackArgs
  Returns VNode

ChunkConfigRowContent

ChunkConfigRowContent: VNode | ChunkConfigContent

ClassNamesGenerator

ClassNamesGenerator<HookProps>: ClassNamesInput | ((hookProps: HookProps) => ClassNamesInput)

Type Parameters

HookProps

ComponentChild

ComponentChildren

ComponentChildren: ComponentChild[] | ComponentChild

ComponentType

ComponentType: ComponentClass | FunctionComponent

Type Parameters

P = {}

Constraint

Constraint: "businessHours" | string | EventStore | false

ConstraintInput

ConstraintInput: "businessHours" | string | EventInput | EventInput[]

CssDimValue

CssDimValue: string | number

CustomContentGenerator

CustomContentGenerator<HookProps>: CustomContent | ((hookProps: HookProps) => CustomContent)

Type Parameters

HookProps

DateInput

DateInput: Date | string | number | number[]

DateMarker

DateMarker: Date

DatePointTransform

DatePointTransform: ((dateSpan: DateSpan, context: CalendarContext) => any)

Type declaration

- (dateSpan: DateSpan, context: CalendarContext): any
- Parameters
  - dateSpan: DateSpan
  - context: CalendarContext
  Returns any

DateSpanTransform

DateSpanTransform: ((dateSpan: DateSpan, context: CalendarContext) => any)

Type declaration

- (dateSpan: DateSpan, context: CalendarContext): any
- Parameters
  - dateSpan: DateSpan
  - context: CalendarContext
  Returns any

DatesSetArg

DatesSetArg: RangeApiWithTimeZone & { view: ViewApi }

DayCellMountArg

DayCellMountArg: MountArg<DayCellContentArg>

DayHeaderMountArg

DayHeaderMountArg: MountArg<DayHeaderContentArg>

Dictionary

Dictionary: Record<string, any>

DidMountHandler

DidMountHandler<TheMountArg>: ((mountArg: TheMountArg) => void)

Type Parameters

TheMountArg extends { el: HTMLElement }

Type declaration

- (mountArg: TheMountArg): void
- Parameters
  - mountArg: TheMountArg
  Returns void

DragMetaInput

DragMetaInput: RawOptionsFromRefiners<typeof DRAG_META_REFINERS> & {}

DurationInput

DurationInput: DurationObjectInput | string | number

EventDefHash

EventDefHash: {}

Type declaration

[defId: string]: EventDef

EventDropTransformers

EventDropTransformers: ((mutation: EventMutation, context: CalendarContext) => Dictionary)

Type declaration

- (mutation: EventMutation, context: CalendarContext): Dictionary
- Parameters
  - mutation: EventMutation
  - context: CalendarContext
  Returns Dictionary

EventInput

EventInput: EventUiInput & RawOptionsFromRefiners<Required<EventRefiners>> & {}

EventInputTransformer

EventInputTransformer: ((input: EventInput) => EventInput)

Type declaration

- (input: EventInput): EventInput
- Parameters
  - input: EventInput
  Returns EventInput

EventInstanceHash

EventInstanceHash: {}

Type declaration

[instanceId: string]: EventInstance

EventMountArg

EventMountArg: MountArg<EventContentArg>

EventRefined

EventRefined: EventUiRefined & RefinedOptionsFromRefiners<Required<EventRefiners>>

EventSourceFunc

EventSourceFunc: ((arg: { end: Date; endStr: string; start: Date; startStr: string; timeZone: string }, successCallback: ((events: EventInput[]) => void), failureCallback: ((error: EventSourceError) => void)) => void | PromiseLike<EventInput[]>)

Type declaration

- (arg: { end: Date; endStr: string; start: Date; startStr: string; timeZone: string }, successCallback: ((events: EventInput[]) => void), failureCallback: ((error: EventSourceError) => void)): void | PromiseLike<EventInput[]>
- Parameters
 - arg: { end: Date; endStr: string; start: Date; startStr: string; timeZone: string }
 - end: Date
 - endStr: string
 - start: Date
 - startStr: string
 - timeZone: string
 - successCallback: ((events: EventInput[]) => void)
 - - (events: EventInput[]): void
 - Parameters
 events: EventInput[]
 Returns void
 - failureCallback: ((error: EventSourceError) => void)
 - - (error: EventSourceError): void
 - Parameters
 error: EventSourceError
 Returns void
 Returns void | PromiseLike<EventInput[]>

EventSourceHash

EventSourceHash: {}

Type declaration

[sourceId: string]: EventSource<any>

EventSourceInput

EventSourceInput: EventSourceInputObject | EventInput[] | EventSourceFunc | string

EventSourceRefined

EventSourceRefined: EventUiRefined & RefinedOptionsFromRefiners<Required<EventSourceRefiners>>

EventUiHash

EventUiHash: {}

Type declaration

[defId: string]: EventUi

FormatterInput

FormatterInput: NativeFormatterOptions | string | FuncFormatterFunc

Identity

Identity<T>: ((raw: T) => T)

Type Parameters

T = any

Type declaration

- (raw: T): T
- Parameters
  - raw: T
  Returns T

InteractionSettingsStore

InteractionSettingsStore: {}

Type declaration

[componenUid: string]: InteractionSettings

LocaleSingularArg

LocaleSingularArg: LocaleCodeArg | LocaleInput

MemoiseArrayFunc

MemoiseArrayFunc<Args, Res>: ((argSets: Args[]) => Res[])

Type Parameters

Args extends any[]
Res

Type declaration

- (argSets: Args[]): Res[]
- Parameters
  - argSets: Args[]
  Returns Res[]

MemoizeHashFunc

MemoizeHashFunc<Args, Res>: ((argHash: {}) => {})

Type Parameters

Args extends any[]
Res

Type declaration

- (argHash: {}): {}
- Parameters
  - argHash: {}
    - [key: string]: Args
  Returns {}
  - [key: string]: Res

MoreLinkAction

MoreLinkAction: MoreLinkSimpleAction | MoreLinkHandler

MoreLinkHandler

MoreLinkHandler: ((arg: MoreLinkArg) => MoreLinkSimpleAction | void)

Type declaration

- (arg: MoreLinkArg): MoreLinkSimpleAction | void
- Parameters
  - arg: MoreLinkArg
  Returns MoreLinkSimpleAction | void

MoreLinkMountArg

MoreLinkMountArg: MountArg<MoreLinkContentArg>

MoreLinkSimpleAction

MountArg

MountArg<ContentArg>: ContentArg & { el: HTMLElement }

Type Parameters

ContentArg

NowIndicatorMountArg

NowIndicatorMountArg: MountArg<NowIndicatorContentArg>

OverflowValue

OverflowValue: "auto" | "hidden" | "scroll" | "visible"

OverlapFunc

OverlapFunc: ((stillEvent: EventApi, movingEvent: EventApi | null) => boolean)

Type declaration

- (stillEvent: EventApi, movingEvent: EventApi | null): boolean
- Parameters
  - stillEvent: EventApi
  - movingEvent: EventApi | null
  Returns boolean

RawOptionsFromRefiners

RawOptionsFromRefiners<Refiners>: { [ Prop in keyof Refiners]?: Refiners[Prop] extends ((input: infer RawType) => infer RefinedType) ? any extends RawType ? RefinedType : RawType : never }

Type Parameters

Refiners extends GenericRefiners

Ref

Ref<T>: RefObject<T> | RefCallback<T> | null

Type Parameters

RefObject

RefObject<T>: { current: T | null }

Type Parameters

Type declaration

current: T | null

RefinedOptionsFromRefiners

RefinedOptionsFromRefiners<Refiners>: { [ Prop in keyof Refiners]?: Refiners[Prop] extends ((input: any) => infer RefinedType) ? RefinedType : never }

Type Parameters

Refiners extends GenericRefiners

RenderHookPropsChildren

RenderHookPropsChildren: ((rootElRef: Ref<any>, classNames: string[], innerElRef: Ref<any>, innerContent: ComponentChildren) => ComponentChildren)

Type declaration

- (rootElRef: Ref<any>, classNames: string[], innerElRef: Ref<any>, innerContent: ComponentChildren): ComponentChildren
- Parameters
 - rootElRef: Ref<any>
 - classNames: string[]
 - innerElRef: Ref<any>
 - innerContent: ComponentChildren
 Returns ComponentChildren

ScrollGridImpl

ScrollGridImpl: {}

Type declaration

VNode

VNode: preact.VNode<any>

VUIEvent

VUIEvent: UIEvent

ViewComponentType

ViewComponentType: ComponentType<ViewProps>

ViewContainerAppend

ViewContainerAppend: ((context: CalendarContext) => ComponentChildren)

Type declaration

- (context: CalendarContext): ComponentChildren
- Parameters
  - context: CalendarContext
  Returns ComponentChildren

ViewMountArg

ViewMountArg: MountArg<ViewContentArg>

ViewOptionsRefined

ViewOptionsRefined: BaseOptionsRefined & CalendarListenersLoose & RefinedOptionsFromRefiners<Required<ViewOptionRefiners>>

WeekNumberCalculation

WeekNumberCalculation: "local" | "ISO" | ((m: Date) => number)

WeekNumberMountArg

WeekNumberMountArg: MountArg<WeekNumberContentArg>

WillUnmountHandler

WillUnmountHandler<TheMountArg>: ((mountArg: TheMountArg) => void)

Type Parameters

TheMountArg extends { el: HTMLElement }

Type declaration

- (mountArg: TheMountArg): void
- Parameters
  - mountArg: TheMountArg
  Returns void

dateSelectionJoinTransformer

dateSelectionJoinTransformer: ((hit0: Hit, hit1: Hit) => any)

Type declaration

- (hit0: Hit, hit1: Hit): any
- Parameters
  - hit0: Hit
  - hit1: Hit
  Returns any

eventDragMutationMassager

eventDragMutationMassager: ((mutation: EventMutation, hit0: Hit, hit1: Hit) => void)

Type declaration

- (mutation: EventMutation, hit0: Hit, hit1: Hit): void
- Parameters
  - mutation: EventMutation
  - hit0: Hit
  - hit1: Hit
  Returns void

Variables

Const BASE_OPTION_DEFAULTS

BASE_OPTION_DEFAULTS: { allDayMaintainDuration: boolean; aspectRatio: number; dayHeaders: boolean; dayPopoverFormat: { day: string; month: string; year: string }; defaultAllDayEventDuration: { day: number }; defaultRangeSeparator: string; defaultTimedEventDuration: string; dragRevertDuration: number; dragScroll: boolean; dropAccept: string; editable: boolean; endParam: string; eventDisplay: string; eventDragMinDistance: number; eventMinHeight: number; eventMinWidth: number; eventOrder: string; eventShortHeight: number; expandRows: boolean; forceEventDuration: boolean; handleWindowResize: boolean; headerToolbar: { center: string; end: string; start: string }; initialView: string; lazyFetching: boolean; locale: string; locales: any[]; longPressDelay: number; navLinks: boolean; nextDayThreshold: string; nowIndicator: boolean; scrollTime: string; scrollTimeReset: boolean; selectable: boolean; showNonCurrentDates: boolean; slotMaxTime: string; slotMinTime: string; startParam: string; themeSystem: string; timeZone: string; timeZoneParam: string; titleRangeSeparator: string; unselectAuto: boolean; weekNumberCalculation: WeekNumberCalculation; weekNumbers: boolean; weekends: boolean; windowResizeDelay: number }

Type declaration

allDayMaintainDuration: boolean
aspectRatio: number
dayHeaders: boolean
dayPopoverFormat: { day: string; month: string; year: string }
- day: string
- month: string
- year: string
defaultAllDayEventDuration: { day: number }
- day: number
defaultRangeSeparator: string
defaultTimedEventDuration: string
dragRevertDuration: number
dragScroll: boolean
dropAccept: string
editable: boolean
endParam: string
eventDisplay: string
eventDragMinDistance: number
eventMinHeight: number
eventMinWidth: number
eventOrder: string
eventShortHeight: number
expandRows: boolean
forceEventDuration: boolean
handleWindowResize: boolean
headerToolbar: { center: string; end: string; start: string }
- center: string
- end: string
- start: string
initialView: string
lazyFetching: boolean
locale: string
locales: any[]
longPressDelay: number
navLinks: boolean
nextDayThreshold: string
nowIndicator: boolean
scrollTime: string
scrollTimeReset: boolean
selectable: boolean
showNonCurrentDates: boolean
slotMaxTime: string
slotMinTime: string
startParam: string
themeSystem: string
timeZone: string
timeZoneParam: string
titleRangeSeparator: string
unselectAuto: boolean
weekNumberCalculation: WeekNumberCalculation
weekNumbers: boolean
weekends: boolean
windowResizeDelay: number

Const BASE_OPTION_REFINERS

BASE_OPTION_REFINERS: { allDayClassNames: Identity<ClassNamesGenerator<AllDayContentArg>>; allDayContent: Identity<CustomContentGenerator<AllDayContentArg>>; allDayDidMount: Identity<DidMountHandler<AllDayMountArg>>; allDayMaintainDuration: BooleanConstructor; allDayText: StringConstructor; allDayWillUnmount: Identity<WillUnmountHandler<AllDayMountArg>>; aspectRatio: NumberConstructor; bootstrapFontAwesome: Identity<false | ButtonIconsInput>; businessHours: Identity<BusinessHoursInput>; buttonIcons: Identity<false | ButtonIconsInput>; closeHint: StringConstructor; contentHeight: Identity<CssDimValue>; customButtons: Identity<{}>; dateAlignment: StringConstructor; dateIncrement: typeof createDuration; dayCellClassNames: Identity<ClassNamesGenerator<DayCellContentArg>>; dayCellContent: Identity<CustomContentGenerator<DayCellContentArg>>; dayCellDidMount: Identity<DidMountHandler<DayCellMountArg>>; dayCellWillUnmount: Identity<WillUnmountHandler<DayCellMountArg>>; dayCount: NumberConstructor; dayHeaderClassNames: Identity<ClassNamesGenerator<DayHeaderContentArg>>; dayHeaderContent: Identity<CustomContentGenerator<DayHeaderContentArg>>; dayHeaderDidMount: Identity<DidMountHandler<DayHeaderMountArg>>; dayHeaderFormat: typeof createFormatter; dayHeaderWillUnmount: Identity<WillUnmountHandler<DayHeaderMountArg>>; dayHeaders: BooleanConstructor; dayMaxEventRows: Identity<number | boolean>; dayMaxEvents: Identity<number | boolean>; dayMinWidth: NumberConstructor; dayPopoverFormat: typeof createFormatter; defaultAllDay: BooleanConstructor; defaultAllDayEventDuration: typeof createDuration; defaultRangeSeparator: StringConstructor; defaultTimedEventDuration: typeof createDuration; direction: Identity<"ltr" | "rtl">; displayEventEnd: BooleanConstructor; displayEventTime: BooleanConstructor; dragRevertDuration: NumberConstructor; dragScroll: BooleanConstructor; dropAccept: Identity<string | ((this: CalendarApi, draggable: any) => boolean)>; droppable: BooleanConstructor; duration: typeof createDuration; editable: BooleanConstructor; endParam: StringConstructor; eventAllow: Identity<AllowFunc>; eventBackgroundColor: StringConstructor; eventBorderColor: StringConstructor; eventClassNames: Identity<ClassNamesGenerator<EventContentArg>>; eventColor: StringConstructor; eventConstraint: Identity<ConstraintInput>; eventContent: Identity<CustomContentGenerator<EventContentArg>>; eventDataTransform: Identity<EventInputTransformer>; eventDidMount: Identity<DidMountHandler<EventMountArg>>; eventDisplay: StringConstructor; eventDragMinDistance: NumberConstructor; eventDurationEditable: BooleanConstructor; eventHint: StringConstructor; eventInteractive: BooleanConstructor; eventLongPressDelay: NumberConstructor; eventMaxStack: NumberConstructor; eventMinHeight: NumberConstructor; eventMinWidth: NumberConstructor; eventOrder: typeof parseFieldSpecs; eventOrderStrict: BooleanConstructor; eventOverlap: Identity<boolean | OverlapFunc>; eventResizableFromStart: BooleanConstructor; eventShortHeight: NumberConstructor; eventSourceFailure: Identity<((this: CalendarApi, error: any) => void)>; eventSourceSuccess: Identity<((this: CalendarApi, eventsInput: EventInput[], xhr?: XMLHttpRequest) => EventInput[] | void)>; eventStartEditable: BooleanConstructor; eventTextColor: StringConstructor; eventTimeFormat: typeof createFormatter; eventWillUnmount: Identity<WillUnmountHandler<EventMountArg>>; expandRows: BooleanConstructor; firstDay: NumberConstructor; fixedWeekCount: BooleanConstructor; footerToolbar: Identity<false | ToolbarInput>; forceEventDuration: BooleanConstructor; handleWindowResize: BooleanConstructor; headerToolbar: Identity<false | ToolbarInput>; height: Identity<CssDimValue>; hiddenDays: Identity<number[]>; initialDate: Identity<DateInput>; initialView: StringConstructor; lazyFetching: BooleanConstructor; locale: Identity<LocaleSingularArg>; locales: Identity<LocaleInput[]>; longPressDelay: NumberConstructor; monthMode: BooleanConstructor; moreLinkClassNames: Identity<ClassNamesGenerator<MoreLinkContentArg>>; moreLinkClick: Identity<MoreLinkAction>; moreLinkContent: Identity<CustomContentGenerator<MoreLinkContentArg>>; moreLinkDidMount: Identity<DidMountHandler<MoreLinkMountArg>>; moreLinkHint: Identity<string | ((this: CalendarApi, num: number) => string)>; moreLinkText: Identity<string | ((this: CalendarApi, num: number) => string)>; moreLinkWillUnmount: Identity<WillUnmountHandler<MoreLinkMountArg>>; navLinkDayClick: Identity<string | ((this: CalendarApi, date: Date, jsEvent: VUIEvent) => void)>; navLinkHint: Identity<string | ((...args: any[]) => string)>; navLinkWeekClick: Identity<string | ((this: CalendarApi, weekStart: Date, jsEvent: VUIEvent) => void)>; navLinks: BooleanConstructor; nextDayThreshold: typeof createDuration; noEventsText: StringConstructor; now: Identity<DateInput | ((this: CalendarApi) => DateInput)>; nowIndicator: BooleanConstructor; nowIndicatorClassNames: Identity<ClassNamesGenerator<NowIndicatorContentArg>>; nowIndicatorContent: Identity<CustomContentGenerator<NowIndicatorContentArg>>; nowIndicatorDidMount: Identity<DidMountHandler<NowIndicatorMountArg>>; nowIndicatorWillUnmount: Identity<WillUnmountHandler<NowIndicatorMountArg>>; plugins: Identity<PluginDef[]>; progressiveEventRendering: BooleanConstructor; rerenderDelay: NumberConstructor; scrollTime: typeof createDuration; scrollTimeReset: BooleanConstructor; selectAllow: Identity<AllowFunc>; selectConstraint: Identity<ConstraintInput>; selectLongPressDelay: NumberConstructor; selectMinDistance: NumberConstructor; selectMirror: BooleanConstructor; selectOverlap: Identity<boolean | OverlapFunc>; selectable: BooleanConstructor; showNonCurrentDates: BooleanConstructor; slotDuration: typeof createDuration; slotEventOverlap: BooleanConstructor; slotLabelClassNames: Identity<ClassNamesGenerator<SlotLabelContentArg>>; slotLabelContent: Identity<CustomContentGenerator<SlotLabelContentArg>>; slotLabelDidMount: Identity<DidMountHandler<SlotLabelMountArg>>; slotLabelFormat: Identity<FormatterInput | FormatterInput[]>; slotLabelInterval: typeof createDuration; slotLabelWillUnmount: Identity<WillUnmountHandler<SlotLabelMountArg>>; slotLaneClassNames: Identity<ClassNamesGenerator<SlotLaneContentArg>>; slotLaneContent: Identity<CustomContentGenerator<SlotLaneContentArg>>; slotLaneDidMount: Identity<DidMountHandler<SlotLaneMountArg>>; slotLaneWillUnmount: Identity<WillUnmountHandler<SlotLaneMountArg>>; slotMaxTime: typeof createDuration; slotMinTime: typeof createDuration; slotMinWidth: NumberConstructor; snapDuration: typeof createDuration; startParam: StringConstructor; stickyFooterScrollbar: Identity<boolean | "auto">; stickyHeaderDates: Identity<boolean | "auto">; themeSystem: Identity<string>; timeHint: StringConstructor; timeZone: StringConstructor; timeZoneParam: StringConstructor; titleFormat: Identity<FormatterInput>; titleRangeSeparator: StringConstructor; unselectAuto: BooleanConstructor; unselectCancel: StringConstructor; validRange: Identity<DateRangeInput | ((this: CalendarApi, nowDate: Date) => DateRangeInput)>; viewClassNames: Identity<ClassNamesGenerator<ViewContentArg>>; viewDidMount: Identity<DidMountHandler<ViewMountArg>>; viewHeight: Identity<CssDimValue>; viewHint: Identity<string | ((...args: any[]) => string)>; viewWillUnmount: Identity<WillUnmountHandler<ViewMountArg>>; visibleRange: Identity<DateRangeInput | ((this: CalendarApi, currentDate: Date) => DateRangeInput)>; weekNumberCalculation: Identity<WeekNumberCalculation>; weekNumberClassNames: Identity<ClassNamesGenerator<WeekNumberContentArg>>; weekNumberContent: Identity<CustomContentGenerator<WeekNumberContentArg>>; weekNumberDidMount: Identity<DidMountHandler<WeekNumberMountArg>>; weekNumberFormat: typeof createFormatter; weekNumberWillUnmount: Identity<WillUnmountHandler<WeekNumberMountArg>>; weekNumbers: BooleanConstructor; weekText: StringConstructor; weekTextLong: StringConstructor; weekends: BooleanConstructor; windowResizeDelay: NumberConstructor }

Type declaration

allDayClassNames: Identity<ClassNamesGenerator<AllDayContentArg>>
allDayContent: Identity<CustomContentGenerator<AllDayContentArg>>
allDayDidMount: Identity<DidMountHandler<AllDayMountArg>>
allDayMaintainDuration: BooleanConstructor
allDayText: StringConstructor
allDayWillUnmount: Identity<WillUnmountHandler<AllDayMountArg>>
aspectRatio: NumberConstructor
bootstrapFontAwesome: Identity<false | ButtonIconsInput>
businessHours: Identity<BusinessHoursInput>
buttonIcons: Identity<false | ButtonIconsInput>
closeHint: StringConstructor
contentHeight: Identity<CssDimValue>
customButtons: Identity<{}>
dateAlignment: StringConstructor
dateIncrement: typeof createDuration
dayCellClassNames: Identity<ClassNamesGenerator<DayCellContentArg>>
dayCellContent: Identity<CustomContentGenerator<DayCellContentArg>>
dayCellDidMount: Identity<DidMountHandler<DayCellMountArg>>
dayCellWillUnmount: Identity<WillUnmountHandler<DayCellMountArg>>
dayCount: NumberConstructor
dayHeaderClassNames: Identity<ClassNamesGenerator<DayHeaderContentArg>>
dayHeaderContent: Identity<CustomContentGenerator<DayHeaderContentArg>>
dayHeaderDidMount: Identity<DidMountHandler<DayHeaderMountArg>>
dayHeaderFormat: typeof createFormatter
dayHeaderWillUnmount: Identity<WillUnmountHandler<DayHeaderMountArg>>
dayHeaders: BooleanConstructor
dayMaxEventRows: Identity<number | boolean>
dayMaxEvents: Identity<number | boolean>
dayMinWidth: NumberConstructor
dayPopoverFormat: typeof createFormatter
defaultAllDay: BooleanConstructor
defaultAllDayEventDuration: typeof createDuration
defaultRangeSeparator: StringConstructor
defaultTimedEventDuration: typeof createDuration
direction: Identity<"ltr" | "rtl">
displayEventEnd: BooleanConstructor
displayEventTime: BooleanConstructor
dragRevertDuration: NumberConstructor
dragScroll: BooleanConstructor
dropAccept: Identity<string | ((this: CalendarApi, draggable: any) => boolean)>
droppable: BooleanConstructor
duration: typeof createDuration
editable: BooleanConstructor
endParam: StringConstructor
eventAllow: Identity<AllowFunc>
eventBackgroundColor: StringConstructor
eventBorderColor: StringConstructor
eventClassNames: Identity<ClassNamesGenerator<EventContentArg>>
eventColor: StringConstructor
eventConstraint: Identity<ConstraintInput>
eventContent: Identity<CustomContentGenerator<EventContentArg>>
eventDataTransform: Identity<EventInputTransformer>
eventDidMount: Identity<DidMountHandler<EventMountArg>>
eventDisplay: StringConstructor
eventDragMinDistance: NumberConstructor
eventDurationEditable: BooleanConstructor
eventHint: StringConstructor
eventInteractive: BooleanConstructor
eventLongPressDelay: NumberConstructor
eventMaxStack: NumberConstructor
eventMinHeight: NumberConstructor
eventMinWidth: NumberConstructor
eventOrder: typeof parseFieldSpecs
eventOrderStrict: BooleanConstructor
eventOverlap: Identity<boolean | OverlapFunc>
eventResizableFromStart: BooleanConstructor
eventShortHeight: NumberConstructor
eventSourceFailure: Identity<((this: CalendarApi, error: any) => void)>
eventSourceSuccess: Identity<((this: CalendarApi, eventsInput: EventInput[], xhr?: XMLHttpRequest) => EventInput[] | void)>
eventStartEditable: BooleanConstructor
eventTextColor: StringConstructor
eventTimeFormat: typeof createFormatter
eventWillUnmount: Identity<WillUnmountHandler<EventMountArg>>
expandRows: BooleanConstructor
firstDay: NumberConstructor
fixedWeekCount: BooleanConstructor
footerToolbar: Identity<false | ToolbarInput>
forceEventDuration: BooleanConstructor
handleWindowResize: BooleanConstructor
headerToolbar: Identity<false | ToolbarInput>
height: Identity<CssDimValue>
hiddenDays: Identity<number[]>
initialDate: Identity<DateInput>
initialView: StringConstructor
lazyFetching: BooleanConstructor
locale: Identity<LocaleSingularArg>
locales: Identity<LocaleInput[]>
longPressDelay: NumberConstructor
monthMode: BooleanConstructor
moreLinkClassNames: Identity<ClassNamesGenerator<MoreLinkContentArg>>
moreLinkClick: Identity<MoreLinkAction>
moreLinkContent: Identity<CustomContentGenerator<MoreLinkContentArg>>
moreLinkDidMount: Identity<DidMountHandler<MoreLinkMountArg>>
moreLinkHint: Identity<string | ((this: CalendarApi, num: number) => string)>
moreLinkText: Identity<string | ((this: CalendarApi, num: number) => string)>
moreLinkWillUnmount: Identity<WillUnmountHandler<MoreLinkMountArg>>
navLinkDayClick: Identity<string | ((this: CalendarApi, date: Date, jsEvent: VUIEvent) => void)>
navLinkHint: Identity<string | ((...args: any[]) => string)>
navLinkWeekClick: Identity<string | ((this: CalendarApi, weekStart: Date, jsEvent: VUIEvent) => void)>
navLinks: BooleanConstructor
nextDayThreshold: typeof createDuration
noEventsText: StringConstructor
now: Identity<DateInput | ((this: CalendarApi) => DateInput)>
nowIndicator: BooleanConstructor
nowIndicatorClassNames: Identity<ClassNamesGenerator<NowIndicatorContentArg>>
nowIndicatorContent: Identity<CustomContentGenerator<NowIndicatorContentArg>>
nowIndicatorDidMount: Identity<DidMountHandler<NowIndicatorMountArg>>
nowIndicatorWillUnmount: Identity<WillUnmountHandler<NowIndicatorMountArg>>
plugins: Identity<PluginDef[]>
progressiveEventRendering: BooleanConstructor
rerenderDelay: NumberConstructor
scrollTime: typeof createDuration
scrollTimeReset: BooleanConstructor
selectAllow: Identity<AllowFunc>
selectConstraint: Identity<ConstraintInput>
selectLongPressDelay: NumberConstructor
selectMinDistance: NumberConstructor
selectMirror: BooleanConstructor
selectOverlap: Identity<boolean | OverlapFunc>
selectable: BooleanConstructor
showNonCurrentDates: BooleanConstructor
slotDuration: typeof createDuration
slotEventOverlap: BooleanConstructor
slotLabelClassNames: Identity<ClassNamesGenerator<SlotLabelContentArg>>
slotLabelContent: Identity<CustomContentGenerator<SlotLabelContentArg>>
slotLabelDidMount: Identity<DidMountHandler<SlotLabelMountArg>>
slotLabelFormat: Identity<FormatterInput | FormatterInput[]>
slotLabelInterval: typeof createDuration
slotLabelWillUnmount: Identity<WillUnmountHandler<SlotLabelMountArg>>
slotLaneClassNames: Identity<ClassNamesGenerator<SlotLaneContentArg>>
slotLaneContent: Identity<CustomContentGenerator<SlotLaneContentArg>>
slotLaneDidMount: Identity<DidMountHandler<SlotLaneMountArg>>
slotLaneWillUnmount: Identity<WillUnmountHandler<SlotLaneMountArg>>
slotMaxTime: typeof createDuration
slotMinTime: typeof createDuration
slotMinWidth: NumberConstructor
snapDuration: typeof createDuration
startParam: StringConstructor
stickyFooterScrollbar: Identity<boolean | "auto">
stickyHeaderDates: Identity<boolean | "auto">
themeSystem: Identity<string>
timeHint: StringConstructor
timeZone: StringConstructor
timeZoneParam: StringConstructor
titleFormat: Identity<FormatterInput>
titleRangeSeparator: StringConstructor
unselectAuto: BooleanConstructor
unselectCancel: StringConstructor
validRange: Identity<DateRangeInput | ((this: CalendarApi, nowDate: Date) => DateRangeInput)>
viewClassNames: Identity<ClassNamesGenerator<ViewContentArg>>
viewDidMount: Identity<DidMountHandler<ViewMountArg>>
viewHeight: Identity<CssDimValue>
viewHint: Identity<string | ((...args: any[]) => string)>
viewWillUnmount: Identity<WillUnmountHandler<ViewMountArg>>
visibleRange: Identity<DateRangeInput | ((this: CalendarApi, currentDate: Date) => DateRangeInput)>
weekNumberCalculation: Identity<WeekNumberCalculation>
weekNumberClassNames: Identity<ClassNamesGenerator<WeekNumberContentArg>>
weekNumberContent: Identity<CustomContentGenerator<WeekNumberContentArg>>
weekNumberDidMount: Identity<DidMountHandler<WeekNumberMountArg>>
weekNumberFormat: typeof createFormatter
weekNumberWillUnmount: Identity<WillUnmountHandler<WeekNumberMountArg>>
weekNumbers: BooleanConstructor
weekText: StringConstructor
weekTextLong: StringConstructor
weekends: BooleanConstructor
windowResizeDelay: NumberConstructor

Const CustomContentRenderContext

CustomContentRenderContext: Context<number>

Const Fragment

Fragment: FunctionComponent<{}>

Const ViewContextType

ViewContextType: Context<any>

Const config

config: any

Const globalLocales

globalLocales: LocaleInput[]

Const globalPlugins

globalPlugins: PluginDef[]

Const interactionSettingsStore

interactionSettingsStore: InteractionSettingsStore

Const version

version: string

Functions

BgEvent

BgEvent(props: BgEventProps): Element

Parameters
- props: BgEventProps
Returns Element

ContentHook

ContentHook<HookProps>(props: ContentHookProps<HookProps>): Element

Type Parameters
- HookProps
Parameters
- props: ContentHookProps<HookProps>
Returns Element

NowIndicatorRoot

NowIndicatorRoot(props: NowIndicatorRootProps): Element

Parameters
- props: NowIndicatorRootProps
Returns Element

WeekNumberRoot

WeekNumberRoot(props: WeekNumberRootProps): Element

Parameters
- props: WeekNumberRootProps
Returns Element

addDays

addDays(m: Date, n: number): Date

Parameters
- m: Date
- n: number
Returns Date

addDurations

addDurations(d0: Duration, d1: Duration): { days: number; milliseconds: number; months: number; years: number }

Parameters
- d0: Duration
- d1: Duration
Returns { days: number; milliseconds: number; months: number; years: number }
- days: number
- milliseconds: number
- months: number
- years: number

addMs

addMs(m: Date, n: number): Date

Parameters
- m: Date
- n: number
Returns Date

addWeeks

addWeeks(m: Date, n: number): Date

Parameters
- m: Date
- n: number
Returns Date

allowContextMenu

allowContextMenu(el: HTMLElement): void

Parameters
- el: HTMLElement
Returns void

allowSelection

allowSelection(el: HTMLElement): void

Parameters
- el: HTMLElement
Returns void

applyMutationToEventStore

applyMutationToEventStore(eventStore: EventStore, eventConfigBase: EventUiHash, mutation: EventMutation, context: CalendarContext): EventStore

Parameters
- eventStore: EventStore
- eventConfigBase: EventUiHash
- mutation: EventMutation
- context: CalendarContext
Returns EventStore

applyStyle

applyStyle(el: HTMLElement, props: Dictionary): void

Parameters
- el: HTMLElement
- props: Dictionary
Returns void

applyStyleProp

applyStyleProp(el: HTMLElement, name: string, val: any): void

Parameters
- el: HTMLElement
- name: string
- val: any
Returns void

asCleanDays

asCleanDays(dur: Duration): number

Parameters
- dur: Duration
Returns number

asRoughMinutes

asRoughMinutes(dur: Duration): number

Parameters
- dur: Duration
Returns number

asRoughMs

asRoughMs(dur: Duration): number

Parameters
- dur: Duration
Returns number

asRoughSeconds

asRoughSeconds(dur: Duration): number

Parameters
- dur: Duration
Returns number

binarySearch

binarySearch<Item>(a: Item[], searchVal: number, getItemVal: ((item: Item) => number)): [number, number]

Type Parameters
- Item
Parameters
- a: Item[]
- searchVal: number
- getItemVal: ((item: Item) => number)
  - - (item: Item): number
    - Parameters
      - item: Item
      Returns number
Returns [number, number]

buildClassNameNormalizer

buildClassNameNormalizer<HookProps>(): ((generator: ClassNamesGenerator<HookProps>, hookProps: HookProps) => string[])

Type Parameters
- HookProps
Returns ((generator: ClassNamesGenerator<HookProps>, hookProps: HookProps) => string[])
- - (generator: ClassNamesGenerator<HookProps>, hookProps: HookProps): string[]
 - Parameters
 - generator: ClassNamesGenerator<HookProps>
 - hookProps: HookProps
 Returns string[]

buildEntryKey

buildEntryKey(entry: SegEntry): string

Parameters
- entry: SegEntry
Returns string

buildEventApis

buildEventApis(eventStore: EventStore, context: CalendarContext, excludeInstance?: EventInstance): EventApi[]

Parameters
- eventStore: EventStore
- context: CalendarContext
- Optional excludeInstance: EventInstance
Returns EventApi[]

buildEventRangeKey

buildEventRangeKey(eventRange: EventRenderRange): string

Parameters
- eventRange: EventRenderRange
Returns string

buildHashFromArray

buildHashFromArray<Item, ItemRes>(a: Item[], func: ((item: Item, index: number) => [string, ItemRes])): {}

Type Parameters
- Item
- ItemRes
Parameters
- a: Item[]
- func: ((item: Item, index: number) => [string, ItemRes])
  - - (item: Item, index: number): [string, ItemRes]
    - Parameters
      - item: Item
      - index: number
      Returns [string, ItemRes]
Returns {}
- [key: string]: ItemRes

buildIsoString

buildIsoString(marker: Date, timeZoneOffset?: number, stripZeroTime?: boolean): string

Parameters
- marker: Date
- Optional timeZoneOffset: number
- Optional stripZeroTime: boolean
Returns string

buildNavLinkAttrs

buildNavLinkAttrs(context: ViewContext, dateMarker: Date, viewType?: string, isTabbable?: boolean): { aria-label?: undefined; data-navlink: string; tabIndex: number; title: any; onClick: any; onKeyDown: any } | { aria-label?: undefined; data-navlink: string; title: any; onClick: any } | { aria-label: string }

Parameters
- context: ViewContext
- dateMarker: Date
- Optional viewType: string
- Optional isTabbable: boolean
Returns { aria-label?: undefined; data-navlink: string; tabIndex: number; title: any; onClick: any; onKeyDown: any } | { aria-label?: undefined; data-navlink: string; title: any; onClick: any } | { aria-label: string }

buildSegCompareObj

buildSegCompareObj(seg: Seg): { _seg: Seg; allDay: number; defId: string; duration: number; end: number; extendedProps: Dictionary; groupId: string; hasEnd: boolean; id: string; interactive?: boolean; publicId: string; recurringDef: { duration: Duration; typeData: any; typeId: number }; sourceId: string; start: number; title: string; ui: EventUi; url: string }

Parameters
- seg: Seg
Returns { _seg: Seg; allDay: number; defId: string; duration: number; end: number; extendedProps: Dictionary; groupId: string; hasEnd: boolean; id: string; interactive?: boolean; publicId: string; recurringDef: { duration: Duration; typeData: any; typeId: number }; sourceId: string; start: number; title: string; ui: EventUi; url: string }
- _seg: Seg
- allDay: number
- defId: string
- duration: number
- end: number
- extendedProps: Dictionary
- groupId: string
- hasEnd: boolean
- id: string
- Optional interactive?: boolean
- publicId: string
- recurringDef: { duration: Duration; typeData: any; typeId: number }
  - duration: Duration
  - typeData: any
  - typeId: number
- sourceId: string
- start: number
- title: string
- ui: EventUi
- url: string

buildSegTimeText

buildSegTimeText(seg: Seg, timeFormat: DateFormatter, context: ViewContext, defaultDisplayEventTime?: boolean, defaultDisplayEventEnd?: boolean, startOverride?: Date, endOverride?: Date): string

Parameters
- seg: Seg
- timeFormat: DateFormatter
- context: ViewContext
- Optional defaultDisplayEventTime: boolean
- Optional defaultDisplayEventEnd: boolean
- Optional startOverride: Date
- Optional endOverride: Date
Returns string

collectFromHash

collectFromHash<Item>(hash: {}, startIndex?: number, endIndex?: number, step?: number): Item[]

Type Parameters
- Item
Parameters
- hash: {}
  - [key: string]: Item
- Optional startIndex: number
- Optional endIndex: number
- Optional step: number
Returns Item[]

combineEventUis

combineEventUis(uis: EventUi[]): EventUi

Parameters
- uis: EventUi[]
Returns EventUi

compareByFieldSpec

compareByFieldSpec<Subject>(obj0: Subject, obj1: Subject, fieldSpec: OrderSpec<Subject>): number

Type Parameters
- Subject
Parameters
- obj0: Subject
- obj1: Subject
- fieldSpec: OrderSpec<Subject>
Returns number

compareByFieldSpecs

compareByFieldSpecs<Subject>(obj0: Subject, obj1: Subject, fieldSpecs: OrderSpec<Subject>[]): number

Type Parameters
- Subject
Parameters
- obj0: Subject
- obj1: Subject
- fieldSpecs: OrderSpec<Subject>[]
Returns number

compareNumbers

compareNumbers(a: any, b: any): number

Parameters
- a: any
- b: any
Returns number

compareObjs

compareObjs(oldProps: any, newProps: any, equalityFuncs?: EqualityFuncs<any>): boolean

Parameters
- oldProps: any
- newProps: any
- Optional equalityFuncs: EqualityFuncs<any>
Returns boolean

computeEarliestSegStart

computeEarliestSegStart(segs: Seg[]): DateMarker

Parameters
- segs: Seg[]
Returns DateMarker

computeEdges

computeEdges(el: HTMLElement, getPadding?: boolean): EdgeInfo

Parameters
- el: HTMLElement
- Optional getPadding: boolean
Returns EdgeInfo

computeFallbackHeaderFormat

computeFallbackHeaderFormat(datesRepDistinctDays: boolean, dayCnt: number): DateFormatter

Parameters
- datesRepDistinctDays: boolean
- dayCnt: number
Returns DateFormatter

computeHeightAndMargins

computeHeightAndMargins(el: HTMLElement): number

Parameters
- el: HTMLElement
Returns number

computeInnerRect

computeInnerRect(el: any, goWithinPadding?: boolean, doFromWindowViewport?: boolean): { bottom: number; left: any; right: number; top: any }

Parameters
- el: any
- Optional goWithinPadding: boolean
- Optional doFromWindowViewport: boolean
Returns { bottom: number; left: any; right: number; top: any }
- bottom: number
- left: any
- right: number
- top: any

computeRect

computeRect(el: any): Rect

Parameters
- el: any
Returns Rect

computeSegDraggable

computeSegDraggable(seg: Seg, context: ViewContext): boolean

Parameters
- seg: Seg
- context: ViewContext
Returns boolean

computeSegEndResizable

computeSegEndResizable(seg: Seg, context: ViewContext): boolean

Parameters
- seg: Seg
- context: ViewContext
Returns boolean

computeSegStartResizable

computeSegStartResizable(seg: Seg, context: ViewContext): boolean

Parameters
- seg: Seg
- context: ViewContext
Returns boolean

computeShrinkWidth

computeShrinkWidth(chunkEls: HTMLElement[]): number

Parameters
- chunkEls: HTMLElement[]
Returns number

computeSmallestCellWidth

computeSmallestCellWidth(cellEl: HTMLElement): number

Parameters
- cellEl: HTMLElement
Returns number

computeVisibleDayRange

computeVisibleDayRange(timedRange: OpenDateRange, nextDayThreshold?: Duration): OpenDateRange

Parameters
- timedRange: OpenDateRange
- Optional nextDayThreshold: Duration
Returns OpenDateRange

constrainPoint

constrainPoint(point: Point, rect: Rect): Point

Parameters
- point: Point
- rect: Rect
Returns Point

createAriaClickAttrs

createAriaClickAttrs(handler: ((ev: UIEvent) => void)): { tabIndex: number; onClick: any; onKeyDown: any }

Parameters
- handler: ((ev: UIEvent) => void)
  - - (ev: UIEvent): void
    - Parameters
      - ev: UIEvent
      Returns void
Returns { tabIndex: number; onClick: any; onKeyDown: any }
- tabIndex: number
- onClick:function
  - onClick(ev: UIEvent): void
  - Parameters
    - ev: UIEvent
    Returns void
- onKeyDown:function
  - onKeyDown(ev: KeyboardEvent): void
  - Parameters
    - ev: KeyboardEvent
    Returns void

createContext

createContext<T>(defaultValue: T): Context<T>

Type Parameters
- T
Parameters
- defaultValue: T
Returns Context<T>

createDuration

createDuration(input: DurationInput, unit?: string): Duration | null

Parameters
- input: DurationInput
- Optional unit: string
Returns Duration | null

createElement

createElement(type: "input", props: null | DOMAttributes<HTMLInputElement> & ClassAttributes<HTMLInputElement>, ...children: ComponentChildren[]): VNode<any>
createElement<P, T>(type: keyof IntrinsicElements, props: null | ClassAttributes<T> & P, ...children: ComponentChildren[]): VNode<any>
createElement<P, T>(type: keyof IntrinsicElements, props: null | ClassAttributes<T> & P, ...children: ComponentChildren[]): VNode<any>
createElement<T>(type: string, props: null | ClassAttributes<T> & HTMLAttributes<EventTarget> & SVGAttributes<SVGElement>, ...children: ComponentChildren[]): VNode<any>
createElement(type: ComponentType, props: null | Attributes & P, ...children: ComponentChildren[]): VNode<any>

Parameters
- type: "input"
- props: null | DOMAttributes<HTMLInputElement> & ClassAttributes<HTMLInputElement>
- Rest ...children: ComponentChildren[]
Returns VNode<any>
Type Parameters
- P extends HTMLAttributes<T, P>
- T extends HTMLElement
Parameters
- type: keyof IntrinsicElements
- props: null | ClassAttributes<T> & P
- Rest ...children: ComponentChildren[]
Returns VNode<any>
Type Parameters
- P extends SVGAttributes<T, P>
- T extends HTMLElement
Parameters
- type: keyof IntrinsicElements
- props: null | ClassAttributes<T> & P
- Rest ...children: ComponentChildren[]
Returns VNode<any>
Type Parameters
- T extends HTMLElement
Parameters
- type: string
- props: null | ClassAttributes<T> & HTMLAttributes<EventTarget> & SVGAttributes<SVGElement>
- Rest ...children: ComponentChildren[]
Returns VNode<any>
Type Parameters
- P
Parameters
- type: ComponentType
- props: null | Attributes & P
- Rest ...children: ComponentChildren[]
Returns VNode<any>

createEmptyEventStore

createEmptyEventStore(): EventStore

Returns EventStore

createEventInstance

createEventInstance(defId: string, range: DateRange, forcedStartTzo?: number, forcedEndTzo?: number): EventInstance

Parameters
- defId: string
- range: DateRange
- Optional forcedStartTzo: number
- Optional forcedEndTzo: number
Returns EventInstance

createEventUi

createEventUi(refined: RefinedOptionsFromRefiners<Required<EventUiRefiners>>, context: CalendarContext): EventUi

Parameters
- refined: RefinedOptionsFromRefiners<Required<EventUiRefiners>>
- context: CalendarContext
Returns EventUi

createFormatter

createFormatter(input: FormatterInput): DateFormatter

Parameters
- input: FormatterInput
Returns DateFormatter

createPlugin

createPlugin(input: PluginDefInput): PluginDef

Parameters
- input: PluginDefInput
Returns PluginDef

createPortal

createPortal(vnode: VNode<{}>, container: Element): preact.VNode<any>

Parameters
- vnode: VNode<{}>
- container: Element
Returns preact.VNode<any>

createRef

createRef<T>(): RefObject<T>

Type Parameters
- T = any
Returns RefObject<T>

diffDates

diffDates(date0: Date, date1: Date, dateEnv: DateEnv, largeUnit?: string): Duration

Parameters
- date0: Date
- date1: Date
- dateEnv: DateEnv
- Optional largeUnit: string
Returns Duration

diffDayAndTime

diffDayAndTime(m0: Date, m1: Date): Duration

Parameters
- m0: Date
- m1: Date
Returns Duration

diffDays

diffDays(m0: any, m1: any): number

Parameters
- m0: any
- m1: any
Returns number

diffPoints

diffPoints(point1: Point, point2: Point): Point

Parameters
- point1: Point
- point2: Point
Returns Point

diffWeeks

diffWeeks(m0: any, m1: any): number

Parameters
- m0: any
- m1: any
Returns number

diffWholeDays

diffWholeDays(m0: Date, m1: Date): number

Parameters
- m0: Date
- m1: Date
Returns number

diffWholeWeeks

diffWholeWeeks(m0: Date, m1: Date): number

Parameters
- m0: Date
- m1: Date
Returns number

disableCursor

disableCursor(): void

Returns void

elementClosest

elementClosest(el: HTMLElement, selector: string): HTMLElement

Parameters
- el: HTMLElement
- selector: string
Returns HTMLElement

elementMatches

elementMatches(el: HTMLElement, selector: string): HTMLElement

Parameters
- el: HTMLElement
- selector: string
Returns HTMLElement

enableCursor

enableCursor(): void

Returns void

eventTupleToStore

eventTupleToStore(tuple: EventTuple, eventStore?: EventStore): EventStore

Parameters
- tuple: EventTuple
- Optional eventStore: EventStore
Returns EventStore

filterEventStoreDefs

filterEventStoreDefs(eventStore: EventStore, filterFunc: ((eventDef: EventDef) => boolean)): EventStore

Parameters
- eventStore: EventStore
- filterFunc: ((eventDef: EventDef) => boolean)
  - - (eventDef: EventDef): boolean
    - Parameters
      - eventDef: EventDef
      Returns boolean
Returns EventStore

filterHash

filterHash(hash: any, func: any): {}

Parameters
- hash: any
- func: any
Returns {}

findDirectChildren

findDirectChildren(parent: HTMLElement | HTMLElement[], selector?: string): HTMLElement[]

Parameters
- parent: HTMLElement | HTMLElement[]
- Optional selector: string
Returns HTMLElement[]

findElements

findElements(container: HTMLElement | HTMLElement[] | NodeListOf<HTMLElement>, selector: string): HTMLElement[]

Parameters
- container: HTMLElement | HTMLElement[] | NodeListOf<HTMLElement>
- selector: string
Returns HTMLElement[]

flexibleCompare

flexibleCompare(a: any, b: any): number

Parameters
- a: any
- b: any
Returns number

flushSync

flushSync(callback: (() => void)): void

Parameters
- callback: (() => void)
  - - (): void
    - Returns void
Returns void

formatDate

formatDate(dateInput: DateInput, options?: FormatDateOptions): string

Parameters
- dateInput: DateInput
- Optional options: FormatDateOptions
Returns string

formatDayString

formatDayString(marker: Date): string

Parameters
- marker: Date
Returns string

formatIsoTimeString

formatIsoTimeString(marker: Date): string

Parameters
- marker: Date
Returns string

formatRange

formatRange(startInput: DateInput, endInput: DateInput, options: FormatRangeOptions): string

Parameters
- startInput: DateInput
- endInput: DateInput
- options: FormatRangeOptions
Returns string

getAllowYScrolling

getAllowYScrolling(props: { liquid: boolean }, sectionConfig: SectionConfig): boolean

Parameters
- props: { liquid: boolean }
  - liquid: boolean
- sectionConfig: SectionConfig
Returns boolean

getCanVGrowWithinCell

getCanVGrowWithinCell(): boolean

Returns boolean

getClippingParents

getClippingParents(el: HTMLElement): HTMLElement[]

Parameters
- el: HTMLElement
Returns HTMLElement[]

getDateMeta

getDateMeta(date: Date, todayRange?: DateRange, nowDate?: Date, dateProfile?: DateProfile): DateMeta

Parameters
- date: Date
- Optional todayRange: DateRange
- Optional nowDate: Date
- Optional dateProfile: DateProfile
Returns DateMeta

getDayClassNames

getDayClassNames(meta: DateMeta, theme: Theme): string[]

Parameters
- meta: DateMeta
- theme: Theme
Returns string[]

getDefaultEventEnd

getDefaultEventEnd(allDay: boolean, marker: Date, context: CalendarContext): DateMarker

Parameters
- allDay: boolean
- marker: Date
- context: CalendarContext
Returns DateMarker

getElRoot

getElRoot(el: HTMLElement): ShadowRoot | Document

Parameters
- el: HTMLElement
Returns ShadowRoot | Document

getElSeg

getElSeg(el: HTMLElement): Seg | null

Parameters
- el: HTMLElement
Returns Seg | null

getEntrySpanEnd

getEntrySpanEnd(entry: SegEntry): number

Parameters
- entry: SegEntry
Returns number

getEventClassNames

getEventClassNames(props: EventContentArg): string[]

Parameters
- props: EventContentArg
Returns string[]

getEventTargetViaRoot

getEventTargetViaRoot(ev: Event): EventTarget

Parameters
- ev: Event
Returns EventTarget

getIsRtlScrollbarOnLeft

getIsRtlScrollbarOnLeft(): boolean

Returns boolean

getRectCenter

getRectCenter(rect: Rect): Point

Parameters
- rect: Rect
Returns Point

getRelevantEvents

getRelevantEvents(eventStore: EventStore, instanceId: string): EventStore

Parameters
- eventStore: EventStore
- instanceId: string
Returns EventStore

getScrollGridClassNames

getScrollGridClassNames(liquid: boolean, context: ViewContext): any[]

Parameters
- liquid: boolean
- context: ViewContext
Returns any[]

getScrollbarWidths

getScrollbarWidths(): ScrollbarWidths

Returns ScrollbarWidths

getSectionClassNames

getSectionClassNames(sectionConfig: SectionConfig, wholeTableVGrow: boolean): string[]

Parameters
- sectionConfig: SectionConfig
- wholeTableVGrow: boolean
Returns string[]

getSectionHasLiquidHeight

getSectionHasLiquidHeight(props: { liquid: boolean }, sectionConfig: SectionConfig): boolean

Parameters
- props: { liquid: boolean }
  - liquid: boolean
- sectionConfig: SectionConfig
Returns boolean

getSegAnchorAttrs

getSegAnchorAttrs(seg: Seg, context: ViewContext): { tabIndex: number; onKeyDown: any } | { href: string } | { href?: undefined }

Parameters
- seg: Seg
- context: ViewContext
Returns { tabIndex: number; onKeyDown: any } | { href: string } | { href?: undefined }

getSegMeta

getSegMeta(seg: Seg, todayRange: DateRange, nowDate?: Date): { isFuture: boolean; isPast: boolean; isToday: boolean }

Parameters
- seg: Seg
- todayRange: DateRange
- Optional nowDate: Date
Returns { isFuture: boolean; isPast: boolean; isToday: boolean }
- isFuture: boolean
- isPast: boolean
- isToday: boolean

getSlotClassNames

getSlotClassNames(meta: DateMeta, theme: Theme): string[]

Parameters
- meta: DateMeta
- theme: Theme
Returns string[]

getStickyFooterScrollbar

getStickyFooterScrollbar(options: BaseOptionsRefined): boolean

Parameters
- options: BaseOptionsRefined
Returns boolean

getStickyHeaderDates

getStickyHeaderDates(options: BaseOptionsRefined): boolean

Parameters
- options: BaseOptionsRefined
Returns boolean

getUnequalProps

getUnequalProps(obj0: any, obj1: any): string[]

Parameters
- obj0: any
- obj1: any
Returns string[]

getUniqueDomId

getUniqueDomId(): string

Returns string

greatestDurationDenominator

greatestDurationDenominator(dur: Duration): { unit: string; value: number }

Parameters
- dur: Duration
Returns { unit: string; value: number }
- unit: string
- value: number

groupIntersectingEntries

groupIntersectingEntries(entries: SegEntry[]): SegEntryGroup[]

Parameters
- entries: SegEntry[]
Returns SegEntryGroup[]

guid

guid(): string

Returns string

hasBgRendering

hasBgRendering(def: EventDef): boolean

Parameters
- def: EventDef
Returns boolean

hasShrinkWidth

hasShrinkWidth(cols: ColProps[]): boolean

Parameters
- cols: ColProps[]
Returns boolean

identity

identity<T>(raw: T): T

Type Parameters
- T
Parameters
- raw: T
Returns T

interactionSettingsToStore

interactionSettingsToStore(settings: InteractionSettings): {}

Parameters
- settings: InteractionSettings
Returns {}
- [x: string]: InteractionSettings

intersectRanges

intersectRanges(range0: OpenDateRange, range1: OpenDateRange): OpenDateRange

Parameters
- range0: OpenDateRange
- range1: OpenDateRange
Returns OpenDateRange

intersectRects

intersectRects(rect1: Rect, rect2: Rect): Rect | false

Parameters
- rect1: Rect
- rect2: Rect
Returns Rect | false

intersectSpans

intersectSpans(span0: SegSpan, span1: SegSpan): SegSpan | null

Parameters
- span0: SegSpan
- span1: SegSpan
Returns SegSpan | null

isArraysEqual

isArraysEqual(a0: any, a1: any, equalityFunc?: ((v0: any, v1: any) => boolean)): boolean

Parameters
- a0: any
- a1: any
- Optional equalityFunc: ((v0: any, v1: any) => boolean)
  - - (v0: any, v1: any): boolean
    - Parameters
      - v0: any
      - v1: any
      Returns boolean
Returns boolean

isColPropsEqual

isColPropsEqual(cols0: ColProps[], cols1: ColProps[]): boolean

Parameters
- cols0: ColProps[]
- cols1: ColProps[]
Returns boolean

isDateSelectionValid

isDateSelectionValid(dateSelection: DateSpan, dateProfile: DateProfile, context: CalendarContext): boolean

Parameters
- dateSelection: DateSpan
- dateProfile: DateProfile
- context: CalendarContext
Returns boolean

isDateSpansEqual

isDateSpansEqual(span0: DateSpan, span1: DateSpan): boolean

Parameters
- span0: DateSpan
- span1: DateSpan
Returns boolean

isInt

isInt(n: any): boolean

Parameters
- n: any
Returns boolean

isInteractionValid

isInteractionValid(interaction: EventInteractionState, dateProfile: DateProfile, context: CalendarContext): boolean

Parameters
- interaction: EventInteractionState
- dateProfile: DateProfile
- context: CalendarContext
Returns boolean

isMultiDayRange

isMultiDayRange(range: DateRange): boolean

Parameters
- range: DateRange
Returns boolean

isPropsEqual

isPropsEqual(obj0: any, obj1: any): boolean

Parameters
- obj0: any
- obj1: any
Returns boolean

isPropsValid

isPropsValid(state: SplittableProps, context: CalendarContext, dateSpanMeta?: {}, filterConfig?: any): boolean

Parameters
- state: SplittableProps
- context: CalendarContext
- Optional dateSpanMeta: {}
- Optional filterConfig: any
Returns boolean

isValidDate

isValidDate(m: Date): boolean

Parameters
- m: Date
Returns boolean

joinSpans

joinSpans(span0: SegSpan, span1: SegSpan): SegSpan

Parameters
- span0: SegSpan
- span1: SegSpan
Returns SegSpan

listenBySelector

listenBySelector(container: HTMLElement, eventType: string, selector: string, handler: ((ev: Event, matchedTarget: HTMLElement) => void)): (() => void)

Parameters
- container: HTMLElement
- eventType: string
- selector: string
- handler: ((ev: Event, matchedTarget: HTMLElement) => void)
  - - (ev: Event, matchedTarget: HTMLElement): void
    - Parameters
      - ev: Event
      - matchedTarget: HTMLElement
      Returns void
Returns (() => void)
- - (): void
  - Returns void

mapHash

mapHash<InputItem, OutputItem>(hash: {}, func: ((input: InputItem, key: string) => OutputItem)): {}

Type Parameters
- InputItem
- OutputItem
Parameters
- hash: {}
  - [key: string]: InputItem
- func: ((input: InputItem, key: string) => OutputItem)
  - - (input: InputItem, key: string): OutputItem
    - Parameters
      - input: InputItem
      - key: string
      Returns OutputItem
Returns {}
- [key: string]: OutputItem

memoize

memoize<Args, Res>(workerFunc: ((...args: Args) => Res), resEquality?: ((res0: Res, res1: Res) => boolean), teardownFunc?: ((res: Res) => void)): ((...args: Args) => Res)

Type Parameters
- Args extends any[]
- Res
Parameters
- workerFunc: ((...args: Args) => Res)
  - - (...args: Args): Res
    - Parameters
      - Rest ...args: Args
      Returns Res
- Optional resEquality: ((res0: Res, res1: Res) => boolean)
  - - (res0: Res, res1: Res): boolean
    - Parameters
      - res0: Res
      - res1: Res
      Returns boolean
- Optional teardownFunc: ((res: Res) => void)
  - - (res: Res): void
    - Parameters
      - res: Res
      Returns void
Returns ((...args: Args) => Res)
- - (...args: Args): Res
  - Parameters
    - Rest ...args: Args
    Returns Res

memoizeArraylike

memoizeArraylike<Args, Res>(workerFunc: ((...args: Args) => Res), resEquality?: ((res0: Res, res1: Res) => boolean), teardownFunc?: ((res: Res) => void)): MemoiseArrayFunc<Args, Res>

Type Parameters
- Args extends any[]
- Res
Parameters
- workerFunc: ((...args: Args) => Res)
 - - (...args: Args): Res
 - Parameters
 - Rest ...args: Args
 Returns Res
- Optional resEquality: ((res0: Res, res1: Res) => boolean)
 - - (res0: Res, res1: Res): boolean
 - Parameters
 - res0: Res
 - res1: Res
 Returns boolean
- Optional teardownFunc: ((res: Res) => void)
 - - (res: Res): void
 - Parameters
 - res: Res
 Returns void
Returns MemoiseArrayFunc<Args, Res>

memoizeHashlike

memoizeHashlike<Args, Res>(workerFunc: ((...args: Args) => Res), resEquality?: ((res0: Res, res1: Res) => boolean), teardownFunc?: ((res: Res) => void)): MemoizeHashFunc<Args, Res>

Type Parameters
- Args extends any[]
- Res
Parameters
- workerFunc: ((...args: Args) => Res)
 - - (...args: Args): Res
 - Parameters
 - Rest ...args: Args
 Returns Res
- Optional resEquality: ((res0: Res, res1: Res) => boolean)
 - - (res0: Res, res1: Res): boolean
 - Parameters
 - res0: Res
 - res1: Res
 Returns boolean
- Optional teardownFunc: ((res: Res) => void)
 - - (res: Res): void
 - Parameters
 - res: Res
 Returns void
Returns MemoizeHashFunc<Args, Res>

memoizeObjArg

memoizeObjArg<Arg, Res>(workerFunc: ((arg: Arg) => Res), resEquality?: ((res0: Res, res1: Res) => boolean), teardownFunc?: ((res: Res) => void)): ((arg: Arg) => Res)

Type Parameters
- Arg extends Dictionary
- Res
Parameters
- workerFunc: ((arg: Arg) => Res)
  - - (arg: Arg): Res
    - Parameters
      - arg: Arg
      Returns Res
- Optional resEquality: ((res0: Res, res1: Res) => boolean)
  - - (res0: Res, res1: Res): boolean
    - Parameters
      - res0: Res
      - res1: Res
      Returns boolean
- Optional teardownFunc: ((res: Res) => void)
  - - (res: Res): void
    - Parameters
      - res: Res
      Returns void
Returns ((arg: Arg) => Res)
- - (arg: Arg): Res
  - Parameters
    - arg: Arg
    Returns Res

mergeEventStores

mergeEventStores(store0: EventStore, store1: EventStore): EventStore

Parameters
- store0: EventStore
- store1: EventStore
Returns EventStore

multiplyDuration

multiplyDuration(d: Duration, n: number): { days: number; milliseconds: number; months: number; years: number }

Parameters
- d: Duration
- n: number
Returns { days: number; milliseconds: number; months: number; years: number }
- days: number
- milliseconds: number
- months: number
- years: number

padStart

padStart(val: any, len: any): string

Parameters
- val: any
- len: any
Returns string

parseBusinessHours

parseBusinessHours(input: BusinessHoursInput, context: CalendarContext): EventStore

Parameters
- input: BusinessHoursInput
- context: CalendarContext
Returns EventStore

parseClassNames

parseClassNames(raw: ClassNamesInput): string[]

Parameters
- raw: ClassNamesInput
Returns string[]

parseDragMeta

parseDragMeta(raw: DragMetaInput): DragMeta

Parameters
- raw: DragMetaInput
Returns DragMeta

parseEventDef

parseEventDef(refined: EventRefined, extra: Dictionary, sourceId: string, allDay: boolean, hasEnd: boolean, context: CalendarContext): EventDef

Parameters
- refined: EventRefined
- extra: Dictionary
- sourceId: string
- allDay: boolean
- hasEnd: boolean
- context: CalendarContext
Returns EventDef

parseFieldSpecs

parseFieldSpecs<Subject>(input: FieldSpecInput<Subject>): OrderSpec<Subject>[]

Type Parameters
- Subject
Parameters
- input: FieldSpecInput<Subject>
Returns OrderSpec<Subject>[]

parseMarker

parseMarker(str: any): { isTimeUnspecified: boolean; marker: Date; timeZoneOffset: any }

Parameters
- str: any
Returns { isTimeUnspecified: boolean; marker: Date; timeZoneOffset: any }
- isTimeUnspecified: boolean
- marker: Date
- timeZoneOffset: any

pointInsideRect

pointInsideRect(point: Point, rect: Rect): boolean

Parameters
- point: Point
- rect: Rect
Returns boolean

preventContextMenu

preventContextMenu(el: HTMLElement): void

Parameters
- el: HTMLElement
Returns void

preventDefault

preventDefault(ev: any): void

Parameters
- ev: any
Returns void

preventSelection

preventSelection(el: HTMLElement): void

Parameters
- el: HTMLElement
Returns void

rangeContainsMarker

rangeContainsMarker(range: OpenDateRange, date: number | Date): boolean

Parameters
- range: OpenDateRange
- date: number | Date
Returns boolean

rangeContainsRange

rangeContainsRange(outerRange: OpenDateRange, innerRange: OpenDateRange): boolean

Parameters
- outerRange: OpenDateRange
- innerRange: OpenDateRange
Returns boolean

rangesEqual

rangesEqual(range0: OpenDateRange, range1: OpenDateRange): boolean

Parameters
- range0: OpenDateRange
- range1: OpenDateRange
Returns boolean

rangesIntersect

rangesIntersect(range0: OpenDateRange, range1: OpenDateRange): boolean

Parameters
- range0: OpenDateRange
- range1: OpenDateRange
Returns boolean

refineEventDef

refineEventDef(raw: EventInput, context: CalendarContext, refiners?: { allDay: BooleanConstructor; allow: Identity<AllowFunc>; backgroundColor: StringConstructor; borderColor: StringConstructor; className: ((raw: ClassNamesInput) => string[]); classNames: ((raw: ClassNamesInput) => string[]); color: StringConstructor; constraint: Identity<any>; date: Identity<DateInput>; display: StringConstructor; durationEditable: BooleanConstructor; editable: BooleanConstructor; end: Identity<DateInput>; extendedProps: Identity<Dictionary>; groupId: StringConstructor; id: StringConstructor; interactive: BooleanConstructor; overlap: Identity<boolean>; start: Identity<DateInput>; startEditable: BooleanConstructor; textColor: StringConstructor; title: StringConstructor; url: StringConstructor }): { extra: Dictionary; refined: RefinedOptionsFromRefiners<{ allDay: BooleanConstructor; allow: Identity<AllowFunc>; backgroundColor: StringConstructor; borderColor: StringConstructor; className: typeof parseClassNames; classNames: typeof parseClassNames; color: StringConstructor; constraint: Identity<any>; date: Identity<DateInput>; display: StringConstructor; durationEditable: BooleanConstructor; editable: BooleanConstructor; end: Identity<DateInput>; extendedProps: Identity<Dictionary>; groupId: StringConstructor; id: StringConstructor; interactive: BooleanConstructor; overlap: Identity<boolean>; start: Identity<DateInput>; startEditable: BooleanConstructor; textColor: StringConstructor; title: StringConstructor; url: StringConstructor }> }

Parameters
- raw: EventInput
- context: CalendarContext
- Optional refiners: { allDay: BooleanConstructor; allow: Identity<AllowFunc>; backgroundColor: StringConstructor; borderColor: StringConstructor; className: ((raw: ClassNamesInput) => string[]); classNames: ((raw: ClassNamesInput) => string[]); color: StringConstructor; constraint: Identity<any>; date: Identity<DateInput>; display: StringConstructor; durationEditable: BooleanConstructor; editable: BooleanConstructor; end: Identity<DateInput>; extendedProps: Identity<Dictionary>; groupId: StringConstructor; id: StringConstructor; interactive: BooleanConstructor; overlap: Identity<boolean>; start: Identity<DateInput>; startEditable: BooleanConstructor; textColor: StringConstructor; title: StringConstructor; url: StringConstructor }
 - allDay: BooleanConstructor
 - allow: Identity<AllowFunc>
 - backgroundColor: StringConstructor
 - borderColor: StringConstructor
 - className: ((raw: ClassNamesInput) => string[])
 - - (raw: ClassNamesInput): string[]
 - Parameters
 raw: ClassNamesInput
 Returns string[]
 - classNames: ((raw: ClassNamesInput) => string[])
 - - (raw: ClassNamesInput): string[]
 - Parameters
 raw: ClassNamesInput
 Returns string[]
 - color: StringConstructor
 - constraint: Identity<any>
 - date: Identity<DateInput>
 - display: StringConstructor
 - durationEditable: BooleanConstructor
 - editable: BooleanConstructor
 - end: Identity<DateInput>
 - extendedProps: Identity<Dictionary>
 - groupId: StringConstructor
 - id: StringConstructor
 - interactive: BooleanConstructor
 - overlap: Identity<boolean>
 - start: Identity<DateInput>
 - startEditable: BooleanConstructor
 - textColor: StringConstructor
 - title: StringConstructor
 - url: StringConstructor
Returns { extra: Dictionary; refined: RefinedOptionsFromRefiners<{ allDay: BooleanConstructor; allow: Identity<AllowFunc>; backgroundColor: StringConstructor; borderColor: StringConstructor; className: typeof parseClassNames; classNames: typeof parseClassNames; color: StringConstructor; constraint: Identity<any>; date: Identity<DateInput>; display: StringConstructor; durationEditable: BooleanConstructor; editable: BooleanConstructor; end: Identity<DateInput>; extendedProps: Identity<Dictionary>; groupId: StringConstructor; id: StringConstructor; interactive: BooleanConstructor; overlap: Identity<boolean>; start: Identity<DateInput>; startEditable: BooleanConstructor; textColor: StringConstructor; title: StringConstructor; url: StringConstructor }> }
- extra: Dictionary
- refined: RefinedOptionsFromRefiners<{ allDay: BooleanConstructor; allow: Identity<AllowFunc>; backgroundColor: StringConstructor; borderColor: StringConstructor; className: typeof parseClassNames; classNames: typeof parseClassNames; color: StringConstructor; constraint: Identity<any>; date: Identity<DateInput>; display: StringConstructor; durationEditable: BooleanConstructor; editable: BooleanConstructor; end: Identity<DateInput>; extendedProps: Identity<Dictionary>; groupId: StringConstructor; id: StringConstructor; interactive: BooleanConstructor; overlap: Identity<boolean>; start: Identity<DateInput>; startEditable: BooleanConstructor; textColor: StringConstructor; title: StringConstructor; url: StringConstructor }>

refineProps

refineProps<Refiners, Raw>(input: Raw, refiners: Refiners): { extra: Dictionary; refined: RefinedOptionsFromRefiners<Refiners> }

Type Parameters
- Refiners extends GenericRefiners
- Raw extends RawOptionsFromRefiners<Refiners>
Parameters
- input: Raw
- refiners: Refiners
Returns { extra: Dictionary; refined: RefinedOptionsFromRefiners<Refiners> }
- extra: Dictionary
- refined: RefinedOptionsFromRefiners<Refiners>

removeElement

removeElement(el: HTMLElement): void

Parameters
- el: HTMLElement
Returns void

removeExact

removeExact(array: any, exactVal: any): number

Parameters
- array: any
- exactVal: any
Returns number

render

render(vnode: ComponentChild, parent: ContainerNode): void
render(vnode: ComponentChild, parent: ContainerNode, replaceNode?: Element | Text): void

deprecated
Will be removed in v11.

Replacement Preact 10+ implementation can be found here: https://gist.github.com/developit/f4c67a2ede71dc2fab7f357f39cff28c

Parameters
- vnode: ComponentChild
- parent: ContainerNode
Returns void
deprecated
Will be removed in v11.

Replacement Preact 10+ implementation can be found here: https://gist.github.com/developit/f4c67a2ede71dc2fab7f357f39cff28c

Parameters
- vnode: ComponentChild
- parent: ContainerNode
- Optional replaceNode: Element | Text
Returns void

renderChunkContent

renderChunkContent(sectionConfig: SectionConfig, chunkConfig: ChunkConfig, arg: ChunkContentCallbackArgs, isHeader: boolean): VNode

Parameters
- sectionConfig: SectionConfig
- chunkConfig: ChunkConfig
- arg: ChunkContentCallbackArgs
- isHeader: boolean
Returns VNode

renderFill

renderFill(fillType: string): Element

Parameters
- fillType: string
Returns Element

renderScrollShim

renderScrollShim(arg: ChunkContentCallbackArgs): Element

Parameters
- arg: ChunkContentCallbackArgs
Returns Element

requestJson

requestJson(method: string, url: string, params: Dictionary, successCallback: any, failureCallback: any): void

Parameters
- method: string
- url: string
- params: Dictionary
- successCallback: any
- failureCallback: any
Returns void

sanitizeShrinkWidth

sanitizeShrinkWidth(shrinkWidth?: number): number

Parameters
- Optional shrinkWidth: number
Returns number

setElSeg

setElSeg(el: HTMLElement, seg: Seg): void

Parameters
- el: HTMLElement
- seg: Seg
Returns void

setRef

setRef<RefType>(ref: void | Ref<RefType>, current: RefType): void

Type Parameters
- RefType
Parameters
- ref: void | Ref<RefType>
- current: RefType
Returns void

sliceEventStore

sliceEventStore(eventStore: EventStore, eventUiBases: EventUiHash, framingRange: DateRange, nextDayThreshold?: Duration): { bg: EventRenderRange[]; fg: EventRenderRange[] }

Parameters
- eventStore: EventStore
- eventUiBases: EventUiHash
- framingRange: DateRange
- Optional nextDayThreshold: Duration
Returns { bg: EventRenderRange[]; fg: EventRenderRange[] }
- bg: EventRenderRange[]
- fg: EventRenderRange[]

sliceEvents

sliceEvents(props: ViewProps & { dateProfile: DateProfile; nextDayThreshold: Duration }, allDay?: boolean): EventRenderRange[]

Parameters
- props: ViewProps & { dateProfile: DateProfile; nextDayThreshold: Duration }
- Optional allDay: boolean
Returns EventRenderRange[]

sortEventSegs

sortEventSegs(segs: any, eventOrderSpecs: OrderSpec<EventApi>[]): Seg[]

Parameters
- segs: any
- eventOrderSpecs: OrderSpec<EventApi>[]
Returns Seg[]

startOfDay

startOfDay(m: Date): DateMarker

Parameters
- m: Date
Returns DateMarker

translateRect

translateRect(rect: Rect, deltaX: number, deltaY: number): Rect

Parameters
- rect: Rect
- deltaX: number
- deltaY: number
Returns Rect

triggerDateSelect

triggerDateSelect(selection: DateSpan, pev: null | PointerDragEvent, context: CalendarContext & { viewApi?: ViewApi }): void

Parameters
- selection: DateSpan
- pev: null | PointerDragEvent
- context: CalendarContext & { viewApi?: ViewApi }
Returns void

unmountComponentAtNode

unmountComponentAtNode(node: HTMLElement): void

Parameters
- node: HTMLElement
Returns void

unpromisify

unpromisify(func: any, success: any, failure?: any): void

Parameters
- func: any
- success: any
- Optional failure: any
Returns void

whenTransitionDone

whenTransitionDone(el: HTMLElement, callback: ((ev: Event) => void)): void

Parameters
- el: HTMLElement
- callback: ((ev: Event) => void)
  - - (ev: Event): void
    - Parameters
      - ev: Event
      Returns void
Returns void

wholeDivideDurations

wholeDivideDurations(numerator: Duration, denominator: Duration): number

Parameters
- numerator: Duration
- denominator: Duration
Returns number

Index

References

Namespaces

Classes

Interfaces

Type Aliases

Variables

Functions

References

renderMicroColGroup

Type Aliases

Action

AllDayMountArg

AllowFunc

Type declaration

Parameters

span: DateSpanApi

movingEvent: EventApi | null

Returns boolean

BaseOptionsRefined

BusinessHoursInput

CalendarListeners

CalendarOptions

CalendarOptionsRefined

ChunkConfigContent

Type declaration

Parameters

contentProps: ChunkContentCallbackArgs

Returns VNode

ChunkConfigRowContent

ClassNamesGenerator

Type Parameters

HookProps

ComponentChild

ComponentChildren

ComponentType

Type Parameters

P = {}

Constraint

ConstraintInput

CssDimValue

CustomContentGenerator

Type Parameters

HookProps

DateInput

DateMarker

DatePointTransform

Type declaration

Parameters

dateSpan: DateSpan

context: CalendarContext

Returns any

DateSpanTransform

Type declaration

Parameters

dateSpan: DateSpan

context: CalendarContext

Returns any

DatesSetArg

DayCellMountArg

DayHeaderMountArg

Dictionary

DidMountHandler

Type Parameters

TheMountArg extends { el: HTMLElement }

Type declaration

Parameters

mountArg: TheMountArg

Returns void

DragMetaInput

DurationInput

EventDefHash

Type declaration

[defId: string]: EventDef

EventDropTransformers

Type declaration

Parameters

mutation: EventMutation

context: CalendarContext

Returns Dictionary