fullcalendar
- Version 7.0.2
- Published
- 2.17 MB
- 3 dependencies
- MIT license
Install
npm i fullcalendaryarn add fullcalendarpnpm add fullcalendarOverview
FullCalendar Vanilla JS package for rendering a calendar
Index
Variables
Functions
Classes
Interfaces
CalendarApi
- addEvent()
- addEventSource()
- changeView()
- formatDate()
- formatIso()
- formatRange()
- getAvailableLocaleCodes()
- getDate()
- getEventById()
- getEvents()
- getEventSourceById()
- getEventSources()
- getOption()
- gotoDate()
- incrementDate()
- next()
- nextYear()
- off()
- on()
- prev()
- prevYear()
- refetchEvents()
- removeAllEvents()
- removeAllEventSources()
- scrollToTime()
- select()
- setOption()
- today()
- trigger()
- unselect()
- view
- zoomTo()
PluginInput
- calendarInteractions
- cmdFormatter
- componentInteractions
- contextInit
- datePointTransforms
- dateSelectionTransformers
- dateSpanTransforms
- deps
- elementDraggingImpl
- eventDefMemberAdders
- eventDefMutationAppliers
- eventDragMutationMassagers
- eventDropTransformers
- eventRefiners
- eventSourceDefs
- eventSourceRefiners
- externalDefTransforms
- initialView
- isDraggableTransformers
- isLoadingFuncs
- isPropsValid
- listenerRefiners
- name
- optionChangeHandlers
- optionDefaults
- optionRefiners
- premiumReleaseDate
- propSetHandlers
- recurringTypes
- reducers
- scrollerSyncerClass
- viewContainerAppends
- viewPropsTransformers
- views
Type Aliases
- AllowFunc
- BusinessHoursInput
- ButtonDisplay
- CalendarOptions
- ClassNameGenerator
- ClassNameInput
- ConstraintInput
- ContentGenerator
- CssDimValue
- CustomRenderingHandler
- DatesSetInfo
- DateTimeFormatPartWithWeek
- DidMountHandler
- EventDragStartInfo
- EventDragStopInfo
- EventInput
- EventInputTransformer
- EventLeaveInfo
- EventReceiveInfo
- EventResizeStartInfo
- EventResizeStopInfo
- EventSourceFunc
- EventSourceFuncInfo
- EventSourceInput
- FormatterInput
- LocaleSingularArg
- MoreLinkAction
- MoreLinkHandler
- MoreLinkSimpleAction
- MountInfo
- OverlapFunc
- SingleMonthHeaderInfo
- TableBodyInfo
- TableDisplayInfo
- TableHeaderInfo
- ToolbarElementInput
- ViewComponentType
- ViewContentInfo
- ViewOptions
- WillUnmountHandler
Variables
variable globalLocales
const globalLocales: LocaleInput[];variable globalPlugins
const globalPlugins: PluginInput[];variable version
const version: string;Functions
function formatDate
formatDate: (dateInput: DateInput, options?: FormatDateOptions) => string;function formatRange
formatRange: ( startInput: DateInput, endInput: DateInput, options: FormatRangeOptions) => string;function joinClassNames
joinClassNames: (...args: ClassValue[]) => string;function sliceEvents
sliceEvents: (props: ViewContentInfo, allDay?: boolean) => EventRenderRange[];Classes
class Calendar
class Calendar extends CalendarApiImpl {}constructor
constructor(el: HTMLElement, optionOverrides?: any);property el
el: HTMLElement;method batchRendering
batchRendering: (func: any) => void;method destroy
destroy: () => void;method pauseRendering
pauseRendering: () => void;method render
render: () => void;method resetOptions
resetOptions: (optionOverrides: any, changedOptionNames?: string[]) => void;method resumeRendering
resumeRendering: () => void;class CalendarController
class CalendarController {}constructor
constructor(handleDateChange?: () => void);property view
readonly view: ViewApi;method changeView
changeView: (viewType: string) => void;method getButtonState
getButtonState: () => ButtonStateMap;method getDate
getDate: () => Date | undefined;method gotoDate
gotoDate: (zonedDateInput: DateInput) => void;method incrementDate
incrementDate: (duration: DurationInput) => void;method next
next: () => void;method nextYear
nextYear: () => void;method prev
prev: () => void;method prevYear
prevYear: () => void;method today
today: () => void;class CustomRenderingStore
class CustomRenderingStore<RenderProps> extends Store< Map<string, CustomRendering<RenderProps>>> {}method handle
handle: (customRendering: CustomRendering<RenderProps>) => void;class JsonRequestError
class JsonRequestError extends Error {}constructor
constructor(message: string, response: Response);property response
response: Response;Interfaces
interface AllDayHeaderInfo
interface AllDayHeaderInfo {}interface ButtonGroupInfo
interface ButtonGroupInfo {}property hasSelection
hasSelection: boolean;interface ButtonInfo
interface ButtonInfo {}property buttonGroup
buttonGroup: ButtonGroupInfo | null;property isDisabled
isDisabled: boolean;property isIconOnly
isIconOnly: boolean;property isPrimary
isPrimary: boolean;property isSelected
isSelected: boolean;property name
name: string;property text
text: string;interface ButtonInput
interface ButtonInput {}property class
class?: ClassNameGenerator<ButtonInfo>;property className
className?: ClassNameGenerator<ButtonInfo>;property click
click?: (ev: MouseEvent) => void;property didMount
didMount?: DidMountHandler<ButtonInfo>;property display
display?: ButtonDisplay;property hint
hint?: | string | ((viewOrCurrentUnitText: string, viewOrCurrentUnit: string) => string);property iconClass
iconClass?: string | undefined;property iconContent
iconContent?: ContentGenerator<{}>;property isPrimary
isPrimary?: boolean;property text
text?: string;property willUnmount
willUnmount?: WillUnmountHandler<ButtonInfo>;interface ButtonState
interface ButtonState {}interface ButtonStateMap
interface ButtonStateMap {}interface CalendarApi
interface CalendarApi {}property view
view: ViewApi;method addEvent
addEvent: ( eventInput: EventInput, sourceInput?: EventSourceApi | string | boolean) => EventApi | null;method addEventSource
addEventSource: (sourceInput: EventSourceInput) => EventSourceApi;method changeView
changeView: (viewType: string, dateOrRange?: DateRangeInput | DateInput) => void;method formatDate
formatDate: (d: DateInput, formatter: FormatterInput) => string;method formatIso
formatIso: (d: DateInput, omitTime?: boolean) => string;method formatRange
formatRange: (d0: DateInput, d1: DateInput, settings: any) => string;method getAvailableLocaleCodes
getAvailableLocaleCodes: () => string[];method getDate
getDate: () => Date;method getEventById
getEventById: (id: string) => EventApi | null;method getEvents
getEvents: () => EventApi[];method getEventSourceById
getEventSourceById: (id: string) => EventSourceApi | null;method getEventSources
getEventSources: () => EventSourceApi[];method getOption
getOption: <OptionName extends string | number | symbol>( name: OptionName) => CalendarOptions[OptionName];method gotoDate
gotoDate: (zonedDateInput: DateInput) => void;method incrementDate
incrementDate: (deltaInput: DurationInput) => void;method next
next: () => void;method nextYear
nextYear: () => void;method off
off: <ListenerName extends never>( handlerName: ListenerName, handler: Required<CalendarListeners>[ListenerName]) => void;method on
on: <ListenerName extends never>( handlerName: ListenerName, handler: Required<CalendarListeners>[ListenerName]) => void;method prev
prev: () => void;method prevYear
prevYear: () => void;method refetchEvents
refetchEvents: () => void;method removeAllEvents
removeAllEvents: () => void;method removeAllEventSources
removeAllEventSources: () => void;method scrollToTime
scrollToTime: (timeInput: DurationInput) => void;method select
select: (dateOrObj: DateInput | any, endDate?: DateInput) => void;method setOption
setOption: <OptionName extends string | number | symbol>( name: OptionName, val: CalendarOptions[OptionName]) => void;method today
today: () => void;method trigger
trigger: <ListenerName extends never>( handlerName: ListenerName, ...args: Parameters<Required<CalendarListeners>[ListenerName]>) => void;method unselect
unselect: () => void;method zoomTo
zoomTo: (dateMarker: Date, viewType?: string) => void;interface CalendarDisplayInfo
interface CalendarDisplayInfo {}property borderlessBottom
borderlessBottom: boolean;property borderlessTop
borderlessTop: boolean;property borderlessX
borderlessX: boolean;interface CalendarListeners
interface CalendarListeners extends RawOptionsFromRefiners<CalendarListenerRefiners> {}interface DateClickInfo
interface DateClickInfo extends DatePointApi {}interface DatePointApi
interface DatePointApi {}interface DateSelectInfo
interface DateSelectInfo extends DateSpanApi {}interface DateSelectionApi
interface DateSelectionApi extends DateSpanApi {}interface DateSpanApi
interface DateSpanApi extends RangeApi {}property allDay
allDay: boolean;interface DateSpanInput
interface DateSpanInput extends OpenDateSpanInput {}interface DateUnselectInfo
interface DateUnselectInfo {}interface DayCellInfo
interface DayCellInfo extends DateMeta {}property date
date: DateMarker;property dayNumberText
dayNumberText: string;property hasNavLink
hasNavLink: boolean;property inPopover
inPopover: boolean;property isMajor
isMajor: boolean;property isNarrow
isNarrow: boolean;property monthText
monthText: string;property options
options: { businessHours: boolean;};property text
text: string;property textParts
textParts: DateTimeFormatPartWithWeek$1[];property view
view: ViewApi;property weekdayText
weekdayText: string;index signature
[extraProp: string]: any;interface DayHeaderDividerInfo
interface DayHeaderDividerInfo {}property isSticky
isSticky: boolean;property multiMonthColumns
multiMonthColumns: number;property options
options: { allDaySlot: boolean;};interface DayHeaderInfo
interface DayHeaderInfo extends DateMeta {}property date
date: Date;property dayNumberText
dayNumberText: string;property hasNavLink
hasNavLink: boolean;property inPopover
inPopover: boolean;property isMajor
isMajor: boolean;property isNarrow
isNarrow: boolean;property level
level: number;property text
text: string;property textParts
textParts: DateTimeFormatPartWithWeek$1[];property view
view: ViewApi;property weekdayText
weekdayText: string;index signature
[otherProp: string]: any;interface DayLaneInfo
interface DayLaneInfo extends DateMeta {}interface DropInfo
interface DropInfo extends DatePointApi {}interface EventAddInfo
interface EventAddInfo {}property event
event: EventImpl;property relatedEvents
relatedEvents: EventImpl[];property revert
revert: () => void;interface EventApi
interface EventApi {}property allDay
allDay: boolean;property allow
allow: any;property className
className: string;property color
color: string;property constraint
constraint: any;property contrastColor
contrastColor: string;property display
display: string;property durationEditable
durationEditable: boolean;property end
end: Date | null;property endStr
endStr: string;property extendedProps
extendedProps: Dictionary;property groupId
groupId: string;property id
id: string;property overlap
overlap: boolean;property source
source: EventSourceApi | null;property start
start: Date | null;property startEditable
startEditable: boolean;property startStr
startStr: string;property title
title: string;property url
url: string;method formatRange
formatRange: (formatInput: FormatterInput) => any;method moveDates
moveDates: (deltaInput: DurationInput) => void;method moveEnd
moveEnd: (deltaInput: DurationInput) => void;method moveStart
moveStart: (deltaInput: DurationInput) => void;method remove
remove: () => void;method setAllDay
setAllDay: (allDay: boolean, options?: { maintainDuration?: boolean }) => void;method setDates
setDates: ( startInput: DateInput, endInput: DateInput | null, options?: { allDay?: boolean; granularity?: string }) => void;method setEnd
setEnd: (endInput: DateInput | null, options?: { granularity?: string }) => void;method setExtendedProp
setExtendedProp: (name: string, val: any) => void;method setProp
setProp: (name: string, val: any) => void;method setStart
setStart: ( startInput: DateInput, options?: { granularity?: string; maintainDuration?: boolean }) => void;method toJSON
toJSON: () => Dictionary;method toPlainObject
toPlainObject: (settings?: { collapseExtendedProps?: boolean }) => Dictionary;interface EventChangeInfo
interface EventChangeInfo {}property event
event: EventImpl;property oldEvent
oldEvent: EventImpl;property relatedEvents
relatedEvents: EventImpl[];property revert
revert: () => void;interface EventClickInfo
interface EventClickInfo {}interface EventDisplayInfo
interface EventDisplayInfo {}property color
color: string;property contrastColor
contrastColor: string;property event
event: EventImpl;property isDraggable
isDraggable: boolean;property isDragging
isDragging: boolean;property isEnd
isEnd: boolean;property isEndResizable
isEndResizable: boolean;property isFirst
isFirst: boolean;property isFuture
isFuture: boolean;property isInteractive
isInteractive: boolean;property isLast
isLast: boolean;property isMirror
isMirror: boolean;property isNarrow
isNarrow: boolean;property isPast
isPast: boolean;property isResizing
isResizing: boolean;property isSelected
isSelected: boolean;property isShort
isShort: boolean;property isStart
isStart: boolean;property isStartResizable
isStartResizable: boolean;property isToday
isToday: boolean;property level
level: number;property options
options: { eventOverlap: boolean;};property timeClass
timeClass: string;property timeText
timeText: string;property titleClass
titleClass: string;property view
view: ViewApi;interface EventDropInfo
interface EventDropInfo extends EventChangeInfo {}interface EventHoveringInfo
interface EventHoveringInfo {}interface EventRemoveInfo
interface EventRemoveInfo {}property event
event: EventImpl;property relatedEvents
relatedEvents: EventImpl[];property revert
revert: () => void;interface EventRenderRange
interface EventRenderRange extends EventTuple {}interface EventResizeDoneInfo
interface EventResizeDoneInfo extends EventChangeInfo {}property el
el: HTMLElement;property endDelta
endDelta: Duration;property jsEvent
jsEvent: MouseEvent;property startDelta
startDelta: Duration;property view
view: ViewApi;interface EventSegment
interface EventSegment {}interface EventSourceApi
interface EventSourceApi {}interface FormatDateOptions
interface FormatDateOptions extends NativeDateFormatterOptions {}property locale
locale?: string;interface FormatRangeOptions
interface FormatRangeOptions extends FormatDateOptions {}property isEndExclusive
isEndExclusive?: boolean;interface InlineWeekNumberInfo
interface InlineWeekNumberInfo {}interface ListDayHeaderInfo
interface ListDayHeaderInfo extends DateMeta {}property view
view: ViewApi;interface ListDayHeaderInnerInfo
interface ListDayHeaderInnerInfo extends DateMeta {}property dayNumberText
dayNumberText: string;property hasNavLink
hasNavLink: boolean;property level
level: number;property text
text: string;property textParts
textParts: DateTimeFormatPartWithWeek$1[];property view
view: ViewApi;property weekdayText
weekdayText: string;interface ListDayInfo
interface ListDayInfo extends DateMeta {}interface LocaleInput
interface LocaleInput extends CalendarOptions {}property code
code: string;interface MoreLinkInfo
interface MoreLinkInfo$1 {}interface NavButtonState
interface NavButtonState extends ButtonState {}property isDisabled
isDisabled: boolean;interface NoEventsInfo
interface NoEventsInfo {}interface NowIndicatorHeaderInfo
interface NowIndicatorHeaderInfo {}interface NowIndicatorLineInfo
interface NowIndicatorLineInfo {}interface PluginInput
interface PluginInput {}property calendarInteractions
calendarInteractions?: CalendarInteractionClass[];property cmdFormatter
cmdFormatter?: CmdDateFormatterFunc;property componentInteractions
componentInteractions?: InteractionClass[];property contextInit
contextInit?: (context: CalendarContext) => void;property datePointTransforms
datePointTransforms?: DatePointTransform[];property dateSelectionTransformers
dateSelectionTransformers?: dateSelectionJoinTransformer[];property dateSpanTransforms
dateSpanTransforms?: DateSpanTransform[];property deps
deps?: PluginInput[];property elementDraggingImpl
elementDraggingImpl?: ElementDraggingClass;property eventDefMemberAdders
eventDefMemberAdders?: EventDefMemberAdder[];property eventDefMutationAppliers
eventDefMutationAppliers?: eventDefMutationApplier[];property eventDragMutationMassagers
eventDragMutationMassagers?: eventDragMutationMassager[];property eventDropTransformers
eventDropTransformers?: EventDropTransformers[];property eventRefiners
eventRefiners?: GenericRefiners;property eventSourceDefs
eventSourceDefs?: EventSourceDef<any>[];property eventSourceRefiners
eventSourceRefiners?: GenericRefiners;property externalDefTransforms
externalDefTransforms?: ExternalDefTransform[];property initialView
initialView?: string;property isDraggableTransformers
isDraggableTransformers?: eventIsDraggableTransformer[];property isLoadingFuncs
isLoadingFuncs?: ((state: Dictionary) => boolean)[];property isPropsValid
isPropsValid?: isPropsValidTester;property listenerRefiners
listenerRefiners?: GenericListenerRefiners;property name
name: string;property optionChangeHandlers
optionChangeHandlers?: OptionChangeHandlerMap;property optionDefaults
optionDefaults?: CalendarOptions;property optionRefiners
optionRefiners?: GenericRefiners;property premiumReleaseDate
premiumReleaseDate?: string;property propSetHandlers
propSetHandlers?: { [propName: string]: (val: any, context: CalendarData) => void;};property recurringTypes
recurringTypes?: RecurringType<any>[];property reducers
reducers?: ReducerFunc[];property scrollerSyncerClass
scrollerSyncerClass?: ScrollerSyncerClass;property viewContainerAppends
viewContainerAppends?: ViewContainerAppend[];property viewPropsTransformers
viewPropsTransformers?: ViewPropsTransformerClass[];property views
views?: ViewConfigInputHash;interface SingleMonthInfo
interface SingleMonthInfo {}property isFirst
isFirst: boolean;property isLast
isLast: boolean;property multiMonthColumns
multiMonthColumns: number;interface SlotHeaderInfo
interface SlotHeaderInfo extends SlotLaneInfo {}interface SlotLaneInfo
interface SlotLaneInfo extends DateMeta {}interface ToolbarInfo
interface ToolbarInfo {}property borderlessBottom
borderlessBottom: boolean;property borderlessTop
borderlessTop: boolean;property borderlessX
borderlessX: boolean;interface ToolbarInput
interface ToolbarInput {}interface ToolbarSectionInfo
interface ToolbarSectionInfo {}property name
name: string;interface ViewApi
interface ViewApi {}property activeEnd
activeEnd: Date;property activeStart
activeStart: Date;property calendar
calendar: CalendarApi;property currentEnd
currentEnd: Date;property currentStart
currentStart: Date;property title
title: string;property type
type: string;method getOption
getOption: (name: string) => any;interface ViewDisplayInfo
interface ViewDisplayInfo {}property borderlessBottom
borderlessBottom: boolean;property borderlessTop
borderlessTop: boolean;property borderlessX
borderlessX: boolean;property isHeightAuto
isHeightAuto: boolean;property options
options: { headerToolbar: ToolbarInput | false | undefined; footerToolbar: ToolbarInput | false | undefined;};property view
view: ViewApi;interface WeekNumberHeaderInfo
interface WeekNumberHeaderInfo {}Type Aliases
type AllowFunc
type AllowFunc = (span: DateSpanApi, movingEvent: EventImpl | null) => boolean;type BusinessHoursInput
type BusinessHoursInput = boolean | EventInput | EventInput[];type ButtonDisplay
type ButtonDisplay = 'auto' | 'icon' | 'text' | 'icon-text' | 'text-icon';type CalendarOptions
type CalendarOptions = BaseOptions & CalendarListeners & CalendarOnlyOptions;type ClassNameGenerator
type ClassNameGenerator<RenderProps> = | ClassNameInput | ((renderProps: RenderProps) => ClassNameInput);type ClassNameInput
type ClassNameInput = string | undefined | null | false | 0;type ConstraintInput
type ConstraintInput = 'businessHours' | string | EventInput | EventInput[];type ContentGenerator
type ContentGenerator<RenderProps> = | CustomContent | ((renderProps: RenderProps) => CustomContent | true | void | undefined);type CssDimValue
type CssDimValue = string | number;type CustomRenderingHandler
type CustomRenderingHandler<RenderProps> = ( customRender: CustomRendering<RenderProps>) => void;type DatesSetInfo
type DatesSetInfo = RangeApiWithTimeZone & { view: ViewApi;};type DateTimeFormatPartWithWeek
type DateTimeFormatPartWithWeek = Omit<Intl.DateTimeFormatPart, 'type'> & { type: Intl.DateTimeFormatPart['type'] | 'week';};type DidMountHandler
type DidMountHandler<DisplayInfo> = (mountData: MountInfo<DisplayInfo>) => void;type EventDragStartInfo
type EventDragStartInfo = EventDragInfo;type EventDragStopInfo
type EventDragStopInfo = EventDragInfo;type EventInput
type EventInput = EventUiInput & RawOptionsFromRefiners<Required<EventRefiners>> & { // Required hack [extendedProp: string]: any; };type EventInputTransformer
type EventInputTransformer = (input: EventInput) => EventInput;type EventLeaveInfo
type EventLeaveInfo = EventReceiveLeaveData;type EventReceiveInfo
type EventReceiveInfo = EventReceiveLeaveData;type EventResizeStartInfo
type EventResizeStartInfo = EventResizeStartStopData;type EventResizeStopInfo
type EventResizeStopInfo = EventResizeStartStopData;type EventSourceFunc
type EventSourceFunc = | (( info: EventSourceFuncInfo, successCallback: (eventInputs: EventInput[]) => void, failureCallback: (error: Error) => void ) => void) | ((info: EventSourceFuncInfo) => Promise<EventInput[]>);type EventSourceFuncInfo
type EventSourceFuncInfo = { start: Date; end: Date; startStr: string; endStr: string; timeZone: string;};type EventSourceInput
type EventSourceInput = | EventSourceInputObject // object in extended form | EventInput[] | EventSourceFunc // just a function | string;type FormatterInput
type FormatterInput = NativeDateFormatterOptions | string | FuncDateFormatterFunc;type LocaleSingularArg
type LocaleSingularArg = LocaleCodeArg | LocaleInput;type MoreLinkAction
type MoreLinkAction = MoreLinkSimpleAction | MoreLinkHandler;type MoreLinkHandler
type MoreLinkHandler = (info: MoreLinkInfo) => MoreLinkSimpleAction | void;type MoreLinkSimpleAction
type MoreLinkSimpleAction = | 'popover' | 'week' | 'day' | 'timeGridWeek' | 'timeGridDay' | string;type MountInfo
type MountInfo<DisplayInfo> = DisplayInfo & { el: HTMLElement;};type OverlapFunc
type OverlapFunc = (stillEvent: EventImpl, movingEvent: EventImpl | null) => boolean;type SingleMonthHeaderInfo
type SingleMonthHeaderInfo = { isSticky: boolean; isNarrow: boolean; hasNavLink: boolean; multiMonthColumns: number;};type TableBodyInfo
type TableBodyInfo = TableDisplayInfo;type TableDisplayInfo
type TableDisplayInfo = { borderlessX: boolean; borderlessTop: boolean; borderlessBottom: boolean; multiMonthColumns: number;};type TableHeaderInfo
type TableHeaderInfo = TableDisplayInfo & { isSticky: boolean;};type ToolbarElementInput
type ToolbarElementInput = ContentGenerator<{}>;type ViewComponentType
type ViewComponentType = ComponentType<ViewProps>;type ViewContentInfo
type ViewContentInfo = ViewProps & ViewDisplayInfo & { nextDayThreshold: Duration; };type ViewOptions
type ViewOptions = BaseOptions & CalendarListeners & ViewOnlyOptions;type WillUnmountHandler
type WillUnmountHandler<DisplayInfo> = (mountData: MountInfo<DisplayInfo>) => void;Package Files (5)
Dependencies (3)
Dev Dependencies (0)
No dev dependencies.
Peer Dependencies (1)
Badge
To add a badge like this oneto your package's README, use the codes available below.
You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/fullcalendar.
- Markdown[](https://www.jsdocs.io/package/fullcalendar)
- HTML<a href="https://www.jsdocs.io/package/fullcalendar"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>
- Updated .
Package analyzed in 5430 ms. - Missing or incorrect documentation? Open an issue for this package.
