side_navigation

Basic Options

Explore this complete list of basic Calendar.js configuration options to easily set up, customize, and update your calendar settings on the fly.

Standard Options

calendarInstance.setOptions( {
    visibleDays: [ 0, 1, 2, 3, 4 ]
} );
Type:Name:Description:
booleanshowDayNumberOrdinalsStates if the day ordinal values should be shown (defaults to true).
booleandragAndDropForEventsEnabledStates if dragging and dropping events around the days of the month is enabled (defaults to true).
booleanexportEventsEnabledStates if exporting events is enabled (defaults to true).
booleanmanualEditingEnabledStates if adding, editing, dragging and removing events is enabled (defaults to true).
numberautoRefreshTimerDelayThe amount of time to wait before each full refresh (defaults to 30000 milliseconds, 0 disables it).
booleanfullScreenModeEnabledStates if double-click on the main title bar activates full-screen mode (defaults to true).
numbertooltipDelayThe amount of time to wait until a tooltip is shown (defaults to 1000 milliseconds).
Holiday[]holidaysThe holidays that should be shown for specific days/months (refer to "Holiday" documentation for properties).
stringorganizerNameThe default name of the organizer (defaults to an empty string).
stringorganizerEmailAddressThe default email address of the organizer (defaults to an empty string).
numberspacingStates the default spacing that should be used for additional margins (defaults to 10).
numbermaximumEventTitleLengthStates the maximum length allowed for an event title (defaults to 0 to allow any size).
numbermaximumEventDescriptionLengthStates the maximum length allowed for an event description (defaults to 0 to allow any size).
numbermaximumEventLocationLengthStates the maximum length allowed for an event location (defaults to 0 to allow any size).
numbermaximumEventGroupLengthStates the maximum length allowed for an event group (defaults to 0 to allow any size).
booleaneventNotificationsEnabledStates if notifications should be shown for events (defaults to false).
booleantooltipsEnabledStates if the tooltips are enabled throughout all the displays (defaults to true).
number[]visibleDaysStates the day numbers that should be visible (Outside listing all events. Defaults to [ 0, 1, 2, 3, 4, 5, 6 ], Mon=0, Sun=6).
stringurlWindowTargetStates the target that an event URL should be opened in (defaults to _blank for a new window).
stringdefaultEventBackgroundColorStates the default background color that should be used for events (defaults to "#484848").
stringdefaultEventTextColorStates the default text color that should be used for events (defaults to "#F5F5F5").
stringdefaultEventBorderColorStates the default border color that should be used for events (defaults to "#282828").
booleanopenInFullScreenModeStates if full-screen mode should be turned on when the calendar is rendered (defaults to false).
booleanhideEventsWithoutGroupAssignedStates if events without a group should be hidden (defaults to false).
booleanshowHolidaysStates if the holidays should be shown (defaults to true).
booleanuseTemplateWhenAddingNewEventStates if a blank template event should be added when adding a new event (causing the dialog to be in edit mode, defaults to true).
booleanuseEscapeKeyToExitFullScreenModeStates if the escape key should exit full-screen mode (if enabled, defaults to true).
booleanallowHtmlInDisplayStates if HTML can be used in the display (defaults to false).
number[]weekendDaysStates the day numbers that are considered weekend days (defaults to [ 0, 1, 2, 3, 4, 5, 6 ], Mon=0, Sun=6).
ObjectinitialDateTimeStates the date that the calendar should start from when first loaded (defaults to today).
SearchsearchOptionsStates all the configurable search options that should be used (refer to "Search Options" documentation for properties). This is an alternate way of getting the options into the instance.
Event[]dataStates the events that will be shown when the calendar first renders (defaults to null).
number[]workingDaysStates the day numbers that are considered working days (defaults to [ 0, 1, 2, 3, 4, 5, 6 ], Mon=0, Sun=6).
numberminimumYearThe minimum year that can be shown in the Calendar (defaults to 1900).
numbermaximumYearThe maximum year that can be shown in the Calendar (defaults to 2099).
numberdefaultEventDurationStates the default duration used when a new event is added (defaults to 30 minutes).
booleanconfigurationDialogEnabledStates if the configuration dialog is enabled (defaults to true).
booleanpopUpNotificationsEnabledStates if the popup notifications (when actions are performed) are enabled (defaults to true).
numberstartOfWeekDayStates what day the week starts on (defaults to 0, with options: Mon = 0, Sat = 5, Sun = 6).
booleanuseLocalStorageForEventsStates if the events added should be stored in local storage (remembered between browser usages, defaults to false).
booleanshortcutKeysEnabledStates if the shortcut keys are enabled (defaults to true).
ObjectworkingHoursStartStates what time the working hours start (for example, "09:00", or { 2: "09:00" } for specific days, and defaults to null).
ObjectworkingHoursEndStates what time the working hours end (for example, "17:00", or { 2: "17:00" } for specific days, and defaults to null).
booleanreverseOrderDaysOfWeekStates if the days of the week should be reversed (for Hebrew calendars, for example. Defaults to false).
booleanimportEventsEnabledStates if importing events is enabled (defaults to true).
booleanuseAmPmForTimeDisplaysStates if the AM/PM time format should be used for all time displays (defaults to false).
booleanisWidgetStates if the new calendar instance is only a widget (defaults to false).
stringviewToOpenOnFirstLoadStates which view should be opened when the Calendar is first initialized (defaults to null, accepts "full-day", "full-week", "full-year", "timeline", and "all-events").
booleaneventColorsEditingEnabledStates if changing the colors for events in the "Edit Event" dialog is enabled (defaults to true).
numbereventTooltipDelayThe amount of time to wait until an event tooltip is shown (defaults to 1000 milliseconds).
booleanjumpToDateEnabledStates if the "Jump To Date" dialog is enabled (defaults to true).

Side Menu Options

calendarInstance.setOptions( {
    views: {
        sideMenu: {
            showDays: true
        }
    }
} );
Type:Name:Description:
booleanshowDaysStates if the "Days" section on the Side Menu is visible (defaults to true).
booleanshowGroupsStates if the "Groups" section on the Side Menu is visible (defaults to true).
booleanshowEventTypesStates if the "Event Types" section on the Side Menu is visible (defaults to true).
booleanshowWorkingDaysStates if the "Working Days" section on the Side Menu is visible (defaults to true).
booleanshowWeekendDaysStates if the "Weekend Days" section on the Side Menu is visible (defaults to true).