Methods

Extensions are fixed at construction. Register modules you will enable later through set() or update(). Those methods still change the existing feature options; they cannot add or remove modules. Reusing the same options or extensions array is supported; each calendar has independent state. Enabling a feature without its extension throws a descriptive error at init(), set() or update(); inactive settings and callbacks do not require a module.

init()

The init() method is the main instance method that starts the calendar initialization process.

const calendar = new Calendar(element, params);
calendar.init();

update()

The update() method allows you to apply new settings to the calendar and perform a reset. This method accepts an object with optional arguments to control the reset, by default resetting the user-selected date, month, and year after the update.

All arguments default to true:

{
  year: boolean;
  month: boolean;
  dates: boolean | 'only-first';
  holidays: boolean;
  time: boolean;
}

• true - will reset to the parameters specified in the settings;
• false - will not perform a reset, leaving the parameters selected by the user;
• 'only-first' - resets all selected dates, leaving only the earliest one. If the date selection type is specified as 'multiple-ranged', a 'mousemove' and 'keydown' handler is added for hovering.

Example usage:

calendar.locale = 'de-AT';
calendar.firstWeekday = 0;
 
calendar.update({
  dates: true,
});

set()

If you need to specify new parameters or handlers for a calendar that is not yet initialized or already initialized, you can use the .set() method. This method accepts an object with new parameters and an object with optional arguments to control the reset, by default resetting the user-selected date, month, and year after the update.

Example usage:

calendar.set({
  locale: 'de-AT',
  firstWeekday: 0,
}, {
  dates: true,
});

This method can be an alternative to specifying parameters when creating a calendar instance. If you call this method before initialization, do not specify the object for controlling the reset.

const calendar = new Calendar(element);
calendar.set({ locale: 'de-AT', firstWeekday: 0 });
calendar.init();

destroy()

If you need to completely delete the calendar instance, you can use the destroy() method.

calendar.destroy();

show()

The show() method allows you to display the calendar if it was hidden.

calendar.show();

hide()

The hide() method allows you to hide the calendar if it was shown.

calendar.hide();