daterangepicker-4.x 4.1.3 → 4.1.5

package/README.md

@@ -287,7 +287,7 @@ drp.setEndDate('2025-03-28T18:30:00');
 <a name="DateRangePicker+setPeriod"></a>
 
 ### dateRangePicker.setPeriod(startDate, endDate)
-Shortcut for [setStartDate](#setStartDate) and [setEndDate](#setEndDate)
+Shortcut for [#DateRangePicker+setStartDatesetStartDate](#DateRangePicker+setStartDatesetStartDate) and [#DateRangePicker+setEndDatesetEndDate](#DateRangePicker+setEndDatesetEndDate)
 
 **Kind**: instance method of [<code>DateRangePicker</code>](#DateRangePicker)  
 **Throws**:
@@ -310,7 +310,7 @@ drp.setPeriod(DateTime.now().startOf('week'), DateTime.now().startOf('week').plu
 
 ### dateRangePicker.updateView()
 Updates the picker when calendar is initiated or any date has been selected. 
-Could be useful after running [setStartDate](#setStartDate) or [setEndDate](#setEndDate)
+Could be useful after running [#DateRangePicker+setStartDatesetStartDate](#DateRangePicker+setStartDatesetStartDate) or [#DateRangePicker+setEndDatesetEndDate](#DateRangePicker+setEndDatesetEndDate)
 
 **Kind**: instance method of [<code>DateRangePicker</code>](#DateRangePicker)  
 <a name="DateRangePicker+outsideClick"></a>
@@ -488,15 +488,15 @@ Options for DateRangePicker
 | autoUpdateInput | <code>boolean</code> | <code>true</code> | Indicates whether the date range picker should automatically update the value of the `<input>`  element it's attached to at initialization and when the selected dates change.<br/>Value is reverted when use clicks on `Cancel`. |
 | onOutsideClick | <code>string</code> | <code>&quot;none&quot;</code> | Defines what picker shall do when user clicks outside the calendar.  `'apply'` or `'cancel'`. Event [onOutsideClick.daterangepicker](#event_outsideClick.daterangepicker) is always emitted. |
 | linkedCalendars | <code>boolean</code> | <code>true</code> | When enabled, the two calendars displayed will always be for two sequential months (i.e. January and February),  and both will be advanced when clicking the left or right arrows above the calendars.<br/> When disabled, the two calendars can be individually advanced and display any month/year |
-| isInvalidDate | <code>function</code> | <code>false</code> | A function that is passed each date in the two calendars before they are displayed,<br/>  and may return `true` or `false` to indicate whether that date should be available for selection or not.<br/> Signature: `isInvalidDate(date)` Function has no effect on date values set by `startDate`, `endDate`, `ranges`, [#setStartDate](#setStartDate), [setEndDate](#setEndDate). |
-| isInvalidTime | <code>function</code> | <code>false</code> | A function that is passed each hour/minute/second/am-pm in the two calendars before they are displayed,<br/>  and may return `true` or `false` to indicate whether that date should be available for selection or not.<br/> Signature: `isInvalidDate(time, side, unit)`<br/> `side` is 'start' or 'end' or `null` for `singleDatePicker = true`<br/> `unit` is `'hour'`, `'minute'`, `'second'` or `'ampm'`<br/> Function has no effect on time values set by `startDate`, `endDate`, `ranges`, [setStartDate](#setStartDate), [setEndDate](#setEndDate).<br/> Ensure that your function returns `false` for at least one item. Otherwise the calender is not rendered.<br/> |
+| isInvalidDate | <code>function</code> | <code>false</code> | A function that is passed each date in the two calendars before they are displayed,<br/>  and may return `true` or `false` to indicate whether that date should be available for selection or not.<br/> Signature: `isInvalidDate(date)` Function has no effect on date values set by `startDate`, `endDate`, `ranges`, [#DateRangePicker+setStartDatesetStartDate](#DateRangePicker+setStartDatesetStartDate), [#DateRangePicker+setEndDatesetEndDate](#DateRangePicker+setEndDatesetEndDate). |
+| isInvalidTime | <code>function</code> | <code>false</code> | A function that is passed each hour/minute/second/am-pm in the two calendars before they are displayed,<br/>  and may return `true` or `false` to indicate whether that date should be available for selection or not.<br/> Signature: `isInvalidDate(time, side, unit)`<br/> `side` is 'start' or 'end' or `null` for `singleDatePicker = true`<br/> `unit` is `'hour'`, `'minute'`, `'second'` or `'ampm'`<br/> Function has no effect on time values set by `startDate`, `endDate`, `ranges`, [#DateRangePicker+setStartDatesetStartDate](#DateRangePicker+setStartDatesetStartDate), [#DateRangePicker+setEndDatesetEndDate](#DateRangePicker+setEndDatesetEndDate).<br/> Ensure that your function returns `false` for at least one item. Otherwise the calender is not rendered.<br/> |
 | isCustomDate | <code>function</code> | <code>false</code> | A function that is passed each date in the two calendars before they are displayed,  and may return a string or array of CSS class names to apply to that date's calendar cell.<br/> Signature: `isCustomDate(date)` |
 | applyButtonClasses | <code>string</code> | <code>&quot;btn-primary&quot;</code> | CSS class names that will be added only to the apply button |
 | cancelButtonClasses | <code>string</code> | <code>&quot;btn-default&quot;</code> | CSS class names that will be added only to the cancel button |
 | buttonClasses | <code>string</code> | <code>&quot;btn&quot;</code> | btn-sm - CSS class names that will be added to both the apply and cancel buttons. |
 | opens | <code>string</code> | <code>&quot;right&quot;</code> | Whether the picker appears aligned to the left, to the right, or centered under the HTML element it's attached to.<br/> `'left' \| 'right' \| 'center'` |
 | drops | <code>string</code> | <code>&quot;down&quot;</code> | Whether the picker appears below or above the HTML element it's attached to.<br/> `'down' \| 'up' \| 'auto'` |
-| ranges | <code>Options.Ranges</code> | <code>{}</code> | Set predefined date ranges the user can select from. Each key is the label for the range,  and its value an array with two dates representing the bounds of the range. |
+| ranges | <code>object</code> | <code>{}</code> | Set predefined date [Ranges](#Ranges) the user can select from. Each key is the label for the range,  and its value an array with two dates representing the bounds of the range. |
 | showCustomRangeLabel | <code>boolean</code> | <code>true</code> | Displays "Custom Range" at the end of the list of predefined [Ranges](#Ranges),  when the ranges option is used.<br> This option will be highlighted whenever the current date range selection does not match one of the predefined ranges.<br/> Clicking it will display the calendars to select a new range. |
 | alwaysShowCalendars | <code>boolean</code> | <code>false</code> | Normally, if you use the ranges option to specify pre-defined date ranges,  calendars for choosing a custom date range are not shown until the user clicks "Custom Range".<br/> When this option is set to true, the calendars for choosing a custom date range are always shown instead. |
 | locale | <code>object</code> | <code>{}</code> | Allows you to provide localized strings for buttons and labels, customize the date format,  and change the first day of week for the calendars. |
@@ -504,8 +504,8 @@ Options for DateRangePicker
 | locale.format | <code>object</code> \| <code>string</code> |  | Default: `DateTime.DATE_SHORT`<br/>Date formats. Either given as string,  see [Format Tokens](https://moment.github.io/luxon/#/formatting?id=table-of-tokens) or an object according  to [Intl.DateTimeFormat](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat)<br/> I recommend to use the luxon [Presets](https://moment.github.io/luxon/#/formatting?id=presets). |
 | locale.separator= | <code>string</code> |  | Defaut: `' - '` - Separator for start and end time |
 | locale.weekLabel | <code>string</code> | <code>&quot;W&quot;</code> | Label for week numbers |
-| locale.daysOfWeek | <code>Array(string)</code> |  | Default: `Info.weekdays('short')`<br/>Array with weekday names, from Monday to Sunday |
-| locale.monthNames | <code>Array(string)</code> |  | Default: `Info.months('long')`<br/>Array with month names |
+| locale.daysOfWeek | <code>Array</code> |  | Default: `Info.weekdays('short')`<br/>Array with weekday names, from Monday to Sunday |
+| locale.monthNames | <code>Array</code> |  | Default: `Info.months('long')`<br/>Array with month names |
 | locale.firstDay | <code>number</code> |  | Default: `Info.getStartOfWeek()`<br/>First day of the week, 1 for Monday through 7 for Sunday |
 | locale.applyLabel | <code>string</code> | <code>&quot;Apply&quot;</code> | Label of `Apply` Button |
 | locale.cancelLabel | <code>string</code> | <code>&quot;Cancel&quot;</code> | Label of `Cancel` Button |

package/daterangepicker.js

@@ -93,13 +93,13 @@
         * @property {function} isInvalidDate=false - A function that is passed each date in the two calendars before they are displayed,<br/> 
         * and may return `true` or `false` to indicate whether that date should be available for selection or not.<br/>
         * Signature: `isInvalidDate(date)`
-        * Function has no effect on date values set by `startDate`, `endDate`, `ranges`, {@link #setStartDate}, {@link #setEndDate|setEndDate}.
+        * Function has no effect on date values set by `startDate`, `endDate`, `ranges`, {@link #DateRangePicker+setStartDatesetStartDate}, {@link #DateRangePicker+setEndDatesetEndDate}.
         * @property {function} isInvalidTime=false - A function that is passed each hour/minute/second/am-pm in the two calendars before they are displayed,<br/> 
         * and may return `true` or `false` to indicate whether that date should be available for selection or not.<br/>
         * Signature: `isInvalidDate(time, side, unit)`<br/>
         * `side` is 'start' or 'end' or `null` for `singleDatePicker = true`<br/>
         * `unit` is `'hour'`, `'minute'`, `'second'` or `'ampm'`<br/>
-        * Function has no effect on time values set by `startDate`, `endDate`, `ranges`, {@link #setStartDate|setStartDate}, {@link #setEndDate|setEndDate}.<br/>
+        * Function has no effect on time values set by `startDate`, `endDate`, `ranges`, {@link #DateRangePicker+setStartDatesetStartDate}, {@link #DateRangePicker+setEndDatesetEndDate}.<br/>
         * Ensure that your function returns `false` for at least one item. Otherwise the calender is not rendered.<br/>
         * @property {function} isCustomDate=false - A function that is passed each date in the two calendars before they are displayed, 
         * and may return a string or array of CSS class names to apply to that date's calendar cell.<br/>
@@ -113,7 +113,7 @@
         * @property {string} drops=down - Whether the picker appears below or above the HTML element it's attached to.<br/>
         * `'down' \| 'up' \| 'auto'`
         
-        * @property {Options.Ranges} ranges={} - Set predefined date ranges the user can select from. Each key is the label for the range, 
+        * @property {object} ranges={} - Set predefined date {@link #Ranges|Ranges} the user can select from. Each key is the label for the range, 
         * and its value an array with two dates representing the bounds of the range.
         * @property {boolean} showCustomRangeLabel=true - Displays "Custom Range" at the end of the list of predefined {@link #Ranges|Ranges}, 
         * when the ranges option is used.<br>
@@ -131,8 +131,8 @@
         * I recommend to use the luxon [Presets](https://moment.github.io/luxon/#/formatting?id=presets).
         * @property {string} locale.separator= - Defaut: `' - '` - Separator for start and end time
         * @property {string} locale.weekLabel=W - Label for week numbers
-        * @property {Array(string)} locale.daysOfWeek - Default: `Info.weekdays('short')`<br/>Array with weekday names, from Monday to Sunday
-        * @property {Array(string)} locale.monthNames - Default: `Info.months('long')`<br/>Array with month names
+        * @property {Array} locale.daysOfWeek - Default: `Info.weekdays('short')`<br/>Array with weekday names, from Monday to Sunday
+        * @property {Array} locale.monthNames - Default: `Info.months('long')`<br/>Array with month names
         * @property {number} locale.firstDay - Default: `Info.getStartOfWeek()`<br/>First day of the week, 1 for Monday through 7 for Sunday
         * @property {string} locale.applyLabel=Apply - Label of `Apply` Button
         * @property {string} locale.cancelLabel=Cancel - Label of `Cancel` Button
@@ -789,7 +789,7 @@
         },
 
         /**
-        * Shortcut for {@link #setStartDate|setStartDate} and {@link #setEndDate|setEndDate}
+        * Shortcut for {@link #DateRangePicker+setStartDatesetStartDate} and {@link #DateRangePicker+setEndDatesetEndDate}
         * @param {external:DateTime|external:Date|string} startDate - startDate to be set
         * @param {external:DateTime|external:Date|string} endDate - endDate to be set
         * @throws `RangeError` for invalid date values.
@@ -983,7 +983,7 @@
 
         /**
         * Updates the picker when calendar is initiated or any date has been selected. 
-        * Could be useful after running {@link #setStartDate|setStartDate} or {@link #setEndDate|setEndDate}
+        * Could be useful after running {@link #DateRangePicker+setStartDatesetStartDate} or {@link #DateRangePicker+setEndDatesetEndDate}
         */
         updateView: function () {
             if (this.timePicker) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "daterangepicker-4.x",
-  "version": "4.1.3",
+  "version": "4.1.5",
   "description": "Date range picker component for Bootstrap",
   "main": "daterangepicker.js",
   "style": "daterangepicker.css",