Configuration
Option | Type | Default | Description |
---|---|---|---|
el | String | null | The ID of the instance's linked element. |
context | ELEMENT_NODE, DOCUMENT_FRAGMENT_NODE | document.body | The ID of the instance's linked element. |
dateFormat | String | DD-MMM-YYYY | Sets the format of the returned date. |
bodyType | String | modal | Sets the calendar mode. |
autoClose | Boolean | false | Closes the calendar when a date is selected. |
closeOndblclick | Boolean | true | Closes the calendar on double click. |
closeOnBlur | Boolean | false | Closes the calendar when it loses focus. |
showCalendarDisplay | Boolean | true | Shows or hides the calendar display. |
customWeekDays | Array | EN Weekdays | Sets custom calendar weekdays. |
customMonths | Array | EN Month names | Sets custom calendar months name. |
customOkBTN | String | OK | Sets custom OK button label. |
customClearBTN | String | Clear | Sets custom Clear button label. |
customCancelBTN | String | CANCEL | Sets custom CANCEL button label. |
firstWeekday | Number | 0 | Sets first weekday of the calendar. |
selectedDate | Date | null | Sets the default picked date. |
minDate | Date | null | Sets the min selectable date. |
maxDate | Date | null | Sets the max selectable date. |
jumpToMinMax | Boolean | true | Jumps to min | max dates using year arrows |
jumpOverDisabled | Boolean | true | Jumps over the disabled months and years. |
disableWeekends | Boolean | false | Disables weekends. |
disableWeekDays | Array | [] | Disables specific days of the week. |
disableDates | Array | [] | Disables specific dates. |
disableMonths | Array | [] | Disables specific months. |
disableYears | Array | [] | Disables specific years. |
allowedMonths | Array | [] | Allows specific months only. |
allowedYears | Array | [] | Allows specific years only. |
markDates | Array | [] | Mark specific dates. |
theme | Object | Default theme | Customize calendar color theme. |
#
elThis option specifies the id of the <input>
element that the instance needs to be linked to. The id needs to be specified as a css selector.
note
Starting with version v0.4.0 this option is not required
#
context#
dateFormatThis option is used to specify the format of the returned date. By default is set to DD-MMM-YYYY
. More details about the valid formats can be found here
#
bodyTypeThis option sets the calendar UI type, currently, it supports only 2 types: modal
and inline
#
autoCloseThis option closes the calendar automatically when an active date is selected.
#
closeOndblclickThis option closes the calendar automatically by double-clicking on an active date. By default this option is set to true
.
#
closeOnBlurThis option closes the calendar automatically when it loses focus. By default this option is set to false
.
#
showCalendarDisplayUse this option to show or hide the calendar display in the modal
mode.
note
This option works only on desktop!
#
customWeekDaysAdd an array of custom weekdays, they will be used to display weekdays when a date is picked, also these custom weekdays are used by calendar table.
important
The array should start with Sunday
#
customMonthsSimilar to customWeekDays
this option will be used to display the month of the picked day, also they are used in the calendar table.
#
customOkBTNUse this option to set a custom label of the OK button
#
customClearBTNUse this option to set a custom label of the Clear button
#
customCancelBTNUse this option to set a custom label of the CANCEL button
#
firstWeekdayIf you are living in Europe, you probably need the calendar to start on Monday. This option allows you to set the first weekday of the calendar table. Accepts numbers from 0 to 6, where 0 represents Sunday.
#
selectedDateUse this option to set a picked date when the calendar is rendered for the first time. By default, the option is set to null.
#
minDateUse this option to set the smallest selectable date. By default, the option is set to null.
#
maxDateUse this option to set the biggest selectable date. By default, the option is set to null.
#
jumpToMinMaxJumps to min | max dates if the prev | next year is out of min | max dates
#
jumpOverDisabledJumps over the disabled months and years.
When this option is enabled, the calendar jumps to the ( next | prev ) active month and year if the (next | prev) month or year is disabled.
#
disableWeekendsBy enabling this option, you are disabling Saturday and Sunday so they cannot be selected.
#
disableWeekDaysSimilar to disableWeekends
, this option disables custom weekdays.
You need to add an array of indexes that represents the weekdays you want to disable. Accepts numbers from 0 to 6, where 0 represents Sunday.
#
disableDatesIf you want to disable a specific date, this option allows you to disable any date you want. Accepts an array of dates objects.
#
disableMonthsIf you want to disable a specific month, this option allows you to disable any month you want. Accepts an array of numbers.
#
disableYearsIf you want to disable a specific years, this option allows you to disable the specified years. Accepts an array of numbers.
#
allowedMonthsIf you want to allow the user to select specific months only, this option allows you to do so. Accepts an array of numbers.
important
This option overrides the rules of disableMonths
option.
#
allowedYearsIf you want to allow the user to select specific years only, this option allows you to do so. Accepts an array of numbers.
important
This option overrides the rules of disableYears
option.
#
markDatesThis option allows you to mark custom dates. Accepts an array of dates objects.
#
themeThe theme
option allows you to set the color theme of the datepicker.
It accepts an object representing the calendar parts and their types.
It also contains some general options, that are used across the entire calendar component.
If a custom color is added to a specific option representing a calendar part, the general option is overridden for that calendar part.
For example, if you want to set the background color of the calendar to red, you can do it like this:
For more information about the theme object, please refer to the theme documentation.