Dependencies
Documentation
use new KarstelCalendar(options)
to create a new calendar, where options can contain the following properties:
property | description | default |
---|---|---|
trigger | This property is mandatory. It defines the triggering element. Clicking this element triggers the widget. Widget appears next to the trigger element | |
daySelectCallback | provide a callback function to handle the user selection. A moment date object with the selected date is passed to the callback and can be handled there | function noop() {} |
id | specify an ID for the calender widget | 'karstelCalendar' |
header | specify the header text of the widget | 'Select date' |
locale | specify the locale. The locale stems from moment.js, so the corresponding language files have to be present too! | 'en' |
orientation | specify on which side of the trigger, the calendar is opened. Possible values: 'e' (east), 'w' (west), 'n' (north), 's' (south) | 'e' |
startYear | year where the calendar starts | current year |
endYear | year where the calendar ends | current year + 4 |
hideAfterSelect | determines whether the calendar should be closed after the user has selected a date | true |
Usage example
var options = {
trigger: $('#myButtonId'),
daySelectCallback: function onDaySelect(d) {
console.log(d.format('dddd, LL'));
},
id: 'myCalenderId',
header: 'Check-in date',
locale: 'en',
orientation: 'e'
};
var startCal = new KarstelCalendar(options);
options can also be changed via setters after the object is instantiated:
startCal.header = 'The new header text';
// or with chainable setters
startCal.locale('de').header('Datum');
to get an option property use
startCal.header();
// 'Select date'
to show or close the calendar explicitly
startCal.showCalendar();
// or respectively
startCal.hideCalendar();