daterangepicker-4.x 4.1.1 → 4.1.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +57 -39
  2. package/daterangepicker.js +56 -53
  3. package/package.json +1 -1
package/README.md CHANGED
@@ -162,21 +162,23 @@ Licensed under the [MIT license](LICENSE).
162
162
  </dd>
163
163
  <dt><a href="#event_outsideClick.daterangepicker">"outsideClick.daterangepicker" (this)</a></dt>
164
164
  <dd><p>Emitted when user clicks outside the picker.
165
- Picker values is not updated, you may trigger <a href="%22apply.daterangepicker%22">&quot;apply.daterangepicker&quot;</a> or <a href="%22cancel.daterangepicker%22">&quot;cancel.daterangepicker&quot;</a> in your EventHandler.</p>
165
+ Picker values is not updated, you may trigger <a href="#event_apply.daterangepicker">&quot;apply.daterangepicker&quot;</a>
166
+ or <a href="#event_cancel.daterangepicker">&quot;cancel.daterangepicker&quot;</a> in your EventHandler.</p>
166
167
  </dd>
167
168
  <dt><a href="#event_showCalendar.daterangepicker">"showCalendar.daterangepicker" (this)</a></dt>
168
169
  <dd><p>Emitted when the calendar(s) are shown.
169
- Only useful when <a href="ranges">ranges</a> are used.</p>
170
+ Only useful when <a href="#Ranges">Ranges</a> are used.</p>
170
171
  </dd>
171
172
  <dt><a href="#event_hideCalendar.daterangepicker">"hideCalendar.daterangepicker" (this)</a></dt>
172
173
  <dd><p>Emitted when the calendar(s) are hidden.
173
- Only useful when <a href="ranges">ranges</a> are used.</p>
174
+ Only useful when <a href="#Ranges">Ranges</a> are used.</p>
174
175
  </dd>
175
176
  <dt><a href="#event_dateChange.daterangepicker">"dateChange.daterangepicker" (this, side)</a></dt>
176
- <dd><p>Emitted when the date changed. Does not trigger when time is changed, use <a href="%22timeChange.daterangepicker%22">&quot;timeChange.daterangepicker&quot;</a> to handle it</p>
177
+ <dd><p>Emitted when the date changed. Does not trigger when time is changed,
178
+ use <a href="#event_timeChange.daterangepicker">&quot;timeChange.daterangepicker&quot;</a> to handle it</p>
177
179
  </dd>
178
180
  <dt><a href="#event_apply.daterangepicker">"apply.daterangepicker" (this)</a></dt>
179
- <dd><p>Emitted when the <code>Apply</code> button is clicked, or when a predefined <a href="ranges">ranges</a> is clicked</p>
181
+ <dd><p>Emitted when the <code>Apply</code> button is clicked, or when a predefined <a href="#Ranges">Ranges</a> is clicked</p>
180
182
  </dd>
181
183
  <dt><a href="#event_cancel.daterangepicker">"cancel.daterangepicker" (this)</a></dt>
182
184
  <dd><p>Emitted when the <code>Cancel</code> button is clicked</p>
@@ -214,6 +216,7 @@ Only useful when <a href="ranges">ranges</a> are used.</p>
214
216
  * [.setEndDate(endDate)](#DateRangePicker+setEndDate)
215
217
  * [.setPeriod(startDate, endDate)](#DateRangePicker+setPeriod)
216
218
  * [.updateView()](#DateRangePicker+updateView)
219
+ * [.outsideClick(e)](#DateRangePicker+outsideClick)
217
220
  * _static_
218
221
  * [.daterangepicker(options, callback)](#DateRangePicker.daterangepicker) ⇒
219
222
 
@@ -232,11 +235,11 @@ Only useful when <a href="ranges">ranges</a> are used.</p>
232
235
  ### dateRangePicker.setStartDate(startDate)
233
236
  Sets the date range picker's currently selected start date to the provided date.<br/>
234
237
  `startDate` must be a `luxon.DateTime` or `Date` or `string` according to [ISO-8601](ISO-8601) or
235
- a string matching [locale.format](locale.format).
238
+ a string matching `locale.format`.
236
239
  The value of the attached `<input>` element is also updated.
237
- Date value is rounded to match option [timePickerStepSize](timePickerStepSize)<br/>
238
- Functions [isInvalidDate](isInvalidDate) and [isInvalidTime](isInvalidTime) are not evaluated, you may set date/time which is not selectable in calendar.<br/>
239
- If the `startDate` does not fall into [minDate](minDate) and [maxDate](maxDate) then [startDate](startDate) is shifted and a warning is written to console.
240
+ Date value is rounded to match option `timePickerStepSize`<br/>
241
+ Functions `isInvalidDate` and `isInvalidTime` are not evaluated, you may set date/time which is not selectable in calendar.<br/>
242
+ If the `startDate` does not fall into `minDate` and `maxDate` then `startDate` is shifted and a warning is written to console.
240
243
 
241
244
  **Kind**: instance method of [<code>DateRangePicker</code>](#DateRangePicker)
242
245
  **Throws**:
@@ -258,13 +261,13 @@ drp.setStartDate(DateTime.now().startOf('hour'));
258
261
 
259
262
  ### dateRangePicker.setEndDate(endDate)
260
263
  Sets the date range picker's currently selected end date to the provided date.<br/>
261
- `endDate` be a `luxon.DateTime` or `Date` or `string` according to [ISO-8601](ISO-8601) or
262
- a string matching [locale.format](locale.format).
264
+ `endDate` must be a `luxon.DateTime` or `Date` or `string` according to [ISO-8601](ISO-8601) or
265
+ a string matching`locale.format`.
263
266
  The value of the attached `<input>` element is also updated.
264
- Date value is rounded to match option [timePickerStepSize](timePickerStepSize)<br/>
265
- Functions [isInvalidDate](isInvalidDate) and [isInvalidTime](isInvalidTime) are not evaluated, you may set date/time which is not selectable in calendar.<br/>
266
- If the [endDate](endDate) does not fall into [minDate](minDate) and [maxDate](maxDate) or into [minSpan](minSpan) and [maxSpan](maxSpan)
267
- then [endDate](endDate) is shifted and a warning is written to console.
267
+ Date value is rounded to match option `timePickerStepSize`<br/>
268
+ Functions `isInvalidDate` and `isInvalidTime` are not evaluated, you may set date/time which is not selectable in calendar.<br/>
269
+ If the `endDate` does not fall into `minDate` and `maxDate` or into `minSpan` and `maxSpan`
270
+ then `endDate` is shifted and a warning is written to console.
268
271
 
269
272
  **Kind**: instance method of [<code>DateRangePicker</code>](#DateRangePicker)
270
273
  **Throws**:
@@ -284,7 +287,7 @@ drp.setEndDate('2025-03-28T18:30:00');
284
287
  <a name="DateRangePicker+setPeriod"></a>
285
288
 
286
289
  ### dateRangePicker.setPeriod(startDate, endDate)
287
- Shortcut for [setStartDate](setStartDate) and [setEndDate](setEndDate)
290
+ Shortcut for [setStartDate](#setStartDate) and [setEndDate](#setEndDate)
288
291
 
289
292
  **Kind**: instance method of [<code>DateRangePicker</code>](#DateRangePicker)
290
293
  **Throws**:
@@ -306,9 +309,22 @@ drp.setPeriod(DateTime.now().startOf('week'), DateTime.now().startOf('week').plu
306
309
  <a name="DateRangePicker+updateView"></a>
307
310
 
308
311
  ### dateRangePicker.updateView()
309
- Updates the picker when calendar is initiated or any date has been selected. Could be useful after running [setStartDate](setStartDate) or [setEndDate](setEndDate)
312
+ Updates the picker when calendar is initiated or any date has been selected.
313
+ Could be useful after running [setStartDate](#setStartDate) or [setEndDate](#setEndDate)
310
314
 
311
315
  **Kind**: instance method of [<code>DateRangePicker</code>](#DateRangePicker)
316
+ <a name="DateRangePicker+outsideClick"></a>
317
+
318
+ ### dateRangePicker.outsideClick(e)
319
+ Closes the picker when user clicks outside
320
+
321
+ **Kind**: instance method of [<code>DateRangePicker</code>](#DateRangePicker)
322
+ **Emits**: <code>event:&quot;outsideClick.daterangepicker&quot;</code>
323
+
324
+ | Param | Type | Description |
325
+ | --- | --- | --- |
326
+ | e | [<code>jQuery</code>](https://learn.jquery.com/using-jquery-core/jquery-object/) | The Event target |
327
+
312
328
  <a name="DateRangePicker.daterangepicker"></a>
313
329
 
314
330
  ### DateRangePicker.daterangepicker(options, callback) ⇒
@@ -320,7 +336,7 @@ Initiate a new DateRangePicker
320
336
  | Param | Type | Description |
321
337
  | --- | --- | --- |
322
338
  | options | [<code>Options</code>](#Options) | Object to configure the DateRangePicker |
323
- | callback | [<code>callback</code>](#callback) | Callback function executed when date is changed. As alternative listen to the ["apply.daterangepicker"]("apply.daterangepicker") event |
339
+ | callback | [<code>callback</code>](#callback) | Callback function executed when date is changed. As alternative listen to the ["apply.daterangepicker"](#event_apply.daterangepicker) event |
324
340
 
325
341
  <a name="event_show.daterangepicker"></a>
326
342
 
@@ -360,7 +376,8 @@ Emitted when the picker is hidden
360
376
 
361
377
  ## "outsideClick.daterangepicker" (this)
362
378
  Emitted when user clicks outside the picker.
363
- Picker values is not updated, you may trigger ["apply.daterangepicker"]("apply.daterangepicker") or ["cancel.daterangepicker"]("cancel.daterangepicker") in your EventHandler.
379
+ Picker values is not updated, you may trigger ["apply.daterangepicker"](#event_apply.daterangepicker)
380
+ or ["cancel.daterangepicker"](#event_cancel.daterangepicker) in your EventHandler.
364
381
 
365
382
  **Kind**: event emitted
366
383
 
@@ -372,7 +389,7 @@ Picker values is not updated, you may trigger ["apply.daterangepicker"]("apply.d
372
389
 
373
390
  ## "showCalendar.daterangepicker" (this)
374
391
  Emitted when the calendar(s) are shown.
375
- Only useful when [ranges](ranges) are used.
392
+ Only useful when [Ranges](#Ranges) are used.
376
393
 
377
394
  **Kind**: event emitted
378
395
 
@@ -384,7 +401,7 @@ Only useful when [ranges](ranges) are used.
384
401
 
385
402
  ## "hideCalendar.daterangepicker" (this)
386
403
  Emitted when the calendar(s) are hidden.
387
- Only useful when [ranges](ranges) are used.
404
+ Only useful when [Ranges](#Ranges) are used.
388
405
 
389
406
  **Kind**: event emitted
390
407
 
@@ -395,7 +412,8 @@ Only useful when [ranges](ranges) are used.
395
412
  <a name="event_dateChange.daterangepicker"></a>
396
413
 
397
414
  ## "dateChange.daterangepicker" (this, side)
398
- Emitted when the date changed. Does not trigger when time is changed, use ["timeChange.daterangepicker"]("timeChange.daterangepicker") to handle it
415
+ Emitted when the date changed. Does not trigger when time is changed,
416
+ use ["timeChange.daterangepicker"](#event_timeChange.daterangepicker) to handle it
399
417
 
400
418
  **Kind**: event emitted
401
419
 
@@ -407,7 +425,7 @@ Emitted when the date changed. Does not trigger when time is changed, use ["time
407
425
  <a name="event_apply.daterangepicker"></a>
408
426
 
409
427
  ## "apply.daterangepicker" (this)
410
- Emitted when the `Apply` button is clicked, or when a predefined [ranges](ranges) is clicked
428
+ Emitted when the `Apply` button is clicked, or when a predefined [Ranges](#Ranges) is clicked
411
429
 
412
430
  **Kind**: event emitted
413
431
 
@@ -449,29 +467,29 @@ Options for DateRangePicker
449
467
  | Name | Type | Default | Description |
450
468
  | --- | --- | --- | --- |
451
469
  | parentEl | <code>string</code> | <code>&quot;body&quot;</code> | [jQuery](jQuery) selector of the parent element that the date range picker will be added to |
452
- | startDate | [<code>DateTime</code>](https://moment.github.io/luxon/api-docs/index.html#datetime) \| [<code>Date</code>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) \| <code>string</code> | <code>DateTime.now().startOf(&#x27;day&#x27;)</code> | The beginning date of the initially selected date range.<br/> Must be a `luxon.DateTime` or `Date` or `string` according to [ISO-8601](ISO-8601) or a string matching [Options.locale.format](Options.locale.format).<br/> Date value is rounded to match option [timePickerStepSize](timePickerStepSize)<br/> Option [Options.isInvalidDate](Options.isInvalidDate) and [Options.isInvalidTime](Options.isInvalidTime) are not evaluated, you may set date/time which is not selectable in calendar.<br/> If the date does not fall into [and {@link maxDate](Options.minDate`) then date is shifted and a warning is written to console. |
453
- | endDate | [<code>DateTime</code>](https://moment.github.io/luxon/api-docs/index.html#datetime) \| [<code>Date</code>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) \| <code>string</code> | <code>DateTime.now().endOf(&#x27;day&#x27;)</code> | The end date of the initially selected date range.<br/> Must be a `luxon.DateTime` or `Date` or `string` according to [ISO-8601](ISO-8601) or a string matching [Options.locale.format](Options.locale.format).<br/> Date value is rounded to match option [Options.timePickerStepSize](Options.timePickerStepSize)<br/> Option [Options.isInvalidDate](Options.isInvalidDate), [Options.isInvalidTime](Options.isInvalidTime) and [Options.minSpan](Options.minSpan), [Options.maxSpan](Options.maxSpan) are not evaluated, you may set date/time which is not selectable in calendar.<br/> If the date does not fall into [Options.minDate](Options.minDate) and [Options.maxDate](Options.maxDate) then date is shifted and a warning is written to console.<br/> |
454
- | minDate | [<code>DateTime</code>](https://moment.github.io/luxon/api-docs/index.html#datetime) \| [<code>Date</code>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) \| <code>string</code> \| <code>null</code> | | The earliest date a user may select or `null` for no limit.<br/> Must be a `luxon.DateTime` or `Date` or `string` according to [ISO-8601](ISO-8601) or a string matching [locale.format](locale.format). |
455
- | maxDate | [<code>DateTime</code>](https://moment.github.io/luxon/api-docs/index.html#datetime) \| [<code>Date</code>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) \| <code>string</code> \| <code>null</code> | | The latest date a user may select or `null` for no limit.<br/> Must be a `luxon.DateTime` or `Date` or `string` according to [ISO-8601](ISO-8601) or a string matching [locale.format](locale.format). |
470
+ | startDate | [<code>DateTime</code>](https://moment.github.io/luxon/api-docs/index.html#datetime) \| [<code>Date</code>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) \| <code>string</code> | | Default: `DateTime.now().startOf('day')`<br/>The beginning date of the initially selected date range.<br/> Must be a `luxon.DateTime` or `Date` or `string` according to [ISO-8601](ISO-8601) or a string matching `locale.format`.<br/> Date value is rounded to match option `timePickerStepSize`<br/> Option `isInvalidDate` and `isInvalidTime` are not evaluated, you may set date/time which is not selectable in calendar.<br/> If the date does not fall into `minDate` and `maxDate` then date is shifted and a warning is written to console. |
471
+ | endDate | [<code>DateTime</code>](https://moment.github.io/luxon/api-docs/index.html#datetime) \| [<code>Date</code>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) \| <code>string</code> | | Defautl: `DateTime.now().endOf('day')`<br/>The end date of the initially selected date range.<br/> Must be a `luxon.DateTime` or `Date` or `string` according to [ISO-8601](ISO-8601) or a string matching `locale.format`.<br/> Date value is rounded to match option `timePickerStepSize`<br/> Option `isInvalidDate`, `isInvalidTime` and `minSpan`, `maxSpan` are not evaluated, you may set date/time which is not selectable in calendar.<br/> If the date does not fall into `minDate` and `maxDate` then date is shifted and a warning is written to console.<br/> |
472
+ | minDate | [<code>DateTime</code>](https://moment.github.io/luxon/api-docs/index.html#datetime) \| [<code>Date</code>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) \| <code>string</code> \| <code>null</code> | | The earliest date a user may select or `null` for no limit.<br/> Must be a `luxon.DateTime` or `Date` or `string` according to [ISO-8601](ISO-8601) or a string matching `locale.format`. |
473
+ | maxDate | [<code>DateTime</code>](https://moment.github.io/luxon/api-docs/index.html#datetime) \| [<code>Date</code>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) \| <code>string</code> \| <code>null</code> | | The latest date a user may select or `null` for no limit.<br/> Must be a `luxon.DateTime` or `Date` or `string` according to [ISO-8601](ISO-8601) or a string matching `locale.format`. |
456
474
  | minSpan | [<code>Duration</code>](https://moment.github.io/luxon/api-docs/index.html#duration) \| <code>string</code> \| <code>number</code> \| <code>null</code> | | The maximum span between the selected start and end dates.<br/> Must be a `luxon.Duration` or number of seconds or a string according to [ISO-8601](ISO-8601) duration.<br/> Ignored when `singleDatePicker: true` |
457
475
  | maxSpan | [<code>Duration</code>](https://moment.github.io/luxon/api-docs/index.html#duration) \| <code>string</code> \| <code>number</code> \| <code>null</code> | | The minimum span between the selected start and end dates.<br/> Must be a `luxon.Duration` or number of seconds or a string according to [ISO-8601](ISO-8601) duration.<br/> Ignored when `singleDatePicker: true` |
458
476
  | autoApply | <code>boolean</code> | <code>false</code> | Hide the `Apply` and `Cancel` buttons, and automatically apply a new date range as soon as two dates are clicked.<br/> Only useful when `timePicker: false` |
459
477
  | singleDatePicker | <code>boolean</code> | <code>false</code> | Show only a single calendar to choose one date, instead of a range picker with two calendars.<br/> The start and end dates provided to your callback will be the same single date chosen. |
460
478
  | showDropdowns | <code>boolean</code> | <code>false</code> | Show year and month select boxes above calendars to jump to a specific month and year |
461
- | minYear | <code>number</code> | <code>DateTime.now().minus({year:100}).year</code> | The minimum year shown in the dropdowns when `showDropdowns: true` |
462
- | maxYear | <code>number</code> | <code>DateTime.now().plus({year:100}).year</code> | The maximum year shown in the dropdowns when `showDropdowns: true` |
479
+ | minYear | <code>number</code> | | Default: `DateTime.now().minus({year:100}).year`<br/>The minimum year shown in the dropdowns when `showDropdowns: true` |
480
+ | maxYear | <code>number</code> | | Default: `DateTime.now().plus({year:100}).year`<br/>The maximum year shown in the dropdowns when `showDropdowns: true` |
463
481
  | showWeekNumbers | <code>boolean</code> | <code>false</code> | Show **localized** week numbers at the start of each week on the calendars |
464
482
  | showISOWeekNumbers | <code>boolean</code> | <code>false</code> | Show **ISO** week numbers at the start of each week on the calendars |
465
483
  | timePicker | <code>boolean</code> | <code>false</code> | Adds select boxes to choose times in addition to dates |
466
484
  | timePicker24Hour | <code>boolean</code> | <code>false</code> | Use 24-hour instead of 12-hour times, removing the AM/PM selection |
467
- | timePickerStepSize | [<code>Duration</code>](https://moment.github.io/luxon/api-docs/index.html#duration) \| <code>string</code> | <code>Duration.fromObject({minutes:1})</code> | Set the time picker step size.<br/> Must be a `luxon.Duration` or number of seconds or a string according to [ISO-8601](ISO-8601) duration.<br/> Valid values are 1,2,3,4,5,6,10,12,15,20,30 for `Duration.fromObject({seconds: ...})` and `Duration.fromObject({minutes: ...})` and 1,2,3,4,6,(8,12) for `Duration.fromObject({hours: ...})`.<br/> Duration must be greater than [minSpan](minSpan) and smaller than [maxSpan](maxSpan).<br/> For example `timePickerStepSize: 600` will disable time picker seconds and time picker minutes are set to step size of 10 Minutes.<br/> Overwrites #timePickerIncrement and #timePickerSeconds |
468
- | timePickerSeconds | <code>boolean</code> | <code>boolean</code> | **Deprecated**, use [timePickerStepSize](timePickerStepSize)<br/>Show seconds in the timePicker |
469
- | timePickerIncrement | <code>boolean</code> | <code>1</code> | **Deprecated**, use [timePickerStepSize](timePickerStepSize)<br/>Increment of the minutes selection list for times |
485
+ | timePickerStepSize | [<code>Duration</code>](https://moment.github.io/luxon/api-docs/index.html#duration) \| <code>string</code> | | Default: `Duration.fromObject({minutes:1})`<br/>Set the time picker step size.<br/> Must be a `luxon.Duration` or number of seconds or a string according to [ISO-8601](ISO-8601) duration.<br/> Valid values are 1,2,3,4,5,6,10,12,15,20,30 for `Duration.fromObject({seconds: ...})` and `Duration.fromObject({minutes: ...})` and 1,2,3,4,6,(8,12) for `Duration.fromObject({hours: ...})`.<br/> Duration must be greater than `minSpan` and smaller than `maxSpan`.<br/> For example `timePickerStepSize: 600` will disable time picker seconds and time picker minutes are set to step size of 10 Minutes.<br/> Overwrites #timePickerIncrement and #timePickerSeconds |
486
+ | timePickerSeconds | <code>boolean</code> | <code>boolean</code> | **Deprecated**, use `timePickerStepSize`<br/>Show seconds in the timePicker |
487
+ | timePickerIncrement | <code>boolean</code> | <code>1</code> | **Deprecated**, use `timePickerStepSize`<br/>Increment of the minutes selection list for times |
470
488
  | 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`. |
471
- | 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']('onOutsideClick.daterangepicker') is always emitted. |
489
+ | 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. |
472
490
  | 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 |
473
- | 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](startDate), [endDate](endDate), [ranges](ranges), [setStartDate](setStartDate), [setEndDate](setEndDate). |
474
- | 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](startDate), [endDate](endDate), [ranges](ranges), [setStartDate](setStartDate), [setEndDate](setEndDate).<br/> Ensure that your function returns `false` for at least one item. Otherwise the calender is not rendered.<br/> |
491
+ | 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). |
492
+ | 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/> |
475
493
  | 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)` |
476
494
  | applyButtonClasses | <code>string</code> | <code>&quot;btn-primary&quot;</code> | CSS class names that will be added only to the apply button |
477
495
  | cancelButtonClasses | <code>string</code> | <code>&quot;btn-default&quot;</code> | CSS class names that will be added only to the cancel button |
@@ -483,12 +501,12 @@ Options for DateRangePicker
483
501
  | 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. |
484
502
  | 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. |
485
503
  | locale.direction | <code>string</code> | <code>&quot;ltr&quot;</code> | Direction of reading, `'ltr'` or `'rtl'` |
486
- | locale.format | <code>object</code> \| <code>string</code> | <code>DateTime.DATE_SHORT</code> | 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). |
504
+ | 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). |
487
505
  | locale.separator= | <code>string</code> | | Defaut: `' - '` - Separator for start and end time |
488
506
  | locale.weekLabel | <code>string</code> | <code>&quot;W&quot;</code> | Label for week numbers |
489
- | locale.daysOfWeek | <code>Array(string)</code> | <code>Info.weekdays(&#x27;short&#x27;)</code> | Array with weekday names, from Monday to Sunday |
490
- | locale.monthNames | <code>Array(string)</code> | <code>Info.months(&#x27;long&#x27;)</code> | Array with month names |
491
- | locale.firstDay | <code>number</code> | <code>Info.getStartOfWeek()</code> | First day of the week, 1 for Monday through 7 for Sunday |
507
+ | locale.daysOfWeek | <code>Array(string)</code> | | Default: `Info.weekdays('short')`<br/>Array with weekday names, from Monday to Sunday |
508
+ | locale.monthNames | <code>Array(string)</code> | | Default: `Info.months('long')`<br/>Array with month names |
509
+ | locale.firstDay | <code>number</code> | | Default: `Info.getStartOfWeek()`<br/>First day of the week, 1 for Monday through 7 for Sunday |
492
510
  | locale.applyLabel | <code>string</code> | <code>&quot;Apply&quot;</code> | Label of `Apply` Button |
493
511
  | locale.cancelLabel | <code>string</code> | <code>&quot;Cancel&quot;</code> | Label of `Cancel` Button |
494
512
  | locale.customRangeLabel | <code>string</code> | <code>&quot;Custom&quot;</code> | Range - Title for custom ranges |
package/daterangepicker.js CHANGED
@@ -39,21 +39,21 @@
39
39
  * @typedef Options
40
40
  * @property {string} parentEl=body - {@link jQuery} selector of the parent element that the date range picker will be added to
41
41
 
42
- * @property {external:DateTime|external:Date|string} startDate=DateTime.now().startOf('day') - The beginning date of the initially selected date range.<br/>
43
- * Must be a `luxon.DateTime` or `Date` or `string` according to {@link ISO-8601} or a string matching {@link Options.locale.format}.<br/>
44
- * Date value is rounded to match option {@link timePickerStepSize}<br/>
45
- * Option {@link Options.isInvalidDate} and {@link Options.isInvalidTime} are not evaluated, you may set date/time which is not selectable in calendar.<br/>
46
- * If the date does not fall into {@link Options.minDate` and {@link maxDate} then date is shifted and a warning is written to console.
47
- * @property {external:DateTime|external:Date|string} endDate=DateTime.now().endOf('day') - The end date of the initially selected date range.<br/>
48
- * Must be a `luxon.DateTime` or `Date` or `string` according to {@link ISO-8601} or a string matching {@link Options.locale.format}.<br/>
49
- * Date value is rounded to match option {@link Options.timePickerStepSize}<br/>
50
- * Option {@link Options.isInvalidDate}, {@link Options.isInvalidTime} and {@link Options.minSpan}, {@link Options.maxSpan} are not evaluated, you may set date/time which is not selectable in calendar.<br/>
51
- * If the date does not fall into {@link Options.minDate} and {@link Options.maxDate} then date is shifted and a warning is written to console.<br/>
42
+ * @property {external:DateTime|external:Date|string} startDate - Default: `DateTime.now().startOf('day')`<br/>The beginning date of the initially selected date range.<br/>
43
+ * Must be a `luxon.DateTime` or `Date` or `string` according to {@link ISO-8601} or a string matching `locale.format`.<br/>
44
+ * Date value is rounded to match option `timePickerStepSize`<br/>
45
+ * Option `isInvalidDate` and `isInvalidTime` are not evaluated, you may set date/time which is not selectable in calendar.<br/>
46
+ * If the date does not fall into `minDate` and `maxDate` then date is shifted and a warning is written to console.
47
+ * @property {external:DateTime|external:Date|string} endDate - Defautl: `DateTime.now().endOf('day')`<br/>The end date of the initially selected date range.<br/>
48
+ * Must be a `luxon.DateTime` or `Date` or `string` according to {@link ISO-8601} or a string matching `locale.format`.<br/>
49
+ * Date value is rounded to match option `timePickerStepSize`<br/>
50
+ * Option `isInvalidDate`, `isInvalidTime` and `minSpan`, `maxSpan` are not evaluated, you may set date/time which is not selectable in calendar.<br/>
51
+ * If the date does not fall into `minDate` and `maxDate` then date is shifted and a warning is written to console.<br/>
52
52
 
53
53
  * @property {external:DateTime|external:Date|string|null} minDate - The earliest date a user may select or `null` for no limit.<br/>
54
- * Must be a `luxon.DateTime` or `Date` or `string` according to {@link ISO-8601} or a string matching {@link locale.format}.
54
+ * Must be a `luxon.DateTime` or `Date` or `string` according to {@link ISO-8601} or a string matching `locale.format`.
55
55
  * @property {external:DateTime|external:Date|string|null} maxDate - The latest date a user may select or `null` for no limit.<br/>
56
- * Must be a `luxon.DateTime` or `Date` or `string` according to {@link ISO-8601} or a string matching {@link locale.format}.
56
+ * Must be a `luxon.DateTime` or `Date` or `string` according to {@link ISO-8601} or a string matching `locale.format`.
57
57
  * @property {external:Duration|string|number|null} minSpan - The maximum span between the selected start and end dates.<br/>
58
58
  * Must be a `luxon.Duration` or number of seconds or a string according to {@link ISO-8601} duration.<br/>
59
59
  * Ignored when `singleDatePicker: true`
@@ -66,40 +66,40 @@
66
66
  * @property {boolean} singleDatePicker=false - Show only a single calendar to choose one date, instead of a range picker with two calendars.<br/>
67
67
  * The start and end dates provided to your callback will be the same single date chosen.
68
68
  * @property {boolean} showDropdowns=false - Show year and month select boxes above calendars to jump to a specific month and year
69
- * @property {number} minYear=DateTime.now().minus({year:100}).year - The minimum year shown in the dropdowns when `showDropdowns: true`
70
- * @property {number} maxYear=DateTime.now().plus({year:100}).year - The maximum year shown in the dropdowns when `showDropdowns: true`
69
+ * @property {number} minYear - Default: `DateTime.now().minus({year:100}).year`<br/>The minimum year shown in the dropdowns when `showDropdowns: true`
70
+ * @property {number} maxYear - Default: `DateTime.now().plus({year:100}).year`<br/>The maximum year shown in the dropdowns when `showDropdowns: true`
71
71
  * @property {boolean} showWeekNumbers=false - Show **localized** week numbers at the start of each week on the calendars
72
72
  * @property {boolean} showISOWeekNumbers=false - Show **ISO** week numbers at the start of each week on the calendars
73
73
 
74
74
  * @property {boolean} timePicker=false - Adds select boxes to choose times in addition to dates
75
75
  * @property {boolean} timePicker24Hour=false - Use 24-hour instead of 12-hour times, removing the AM/PM selection
76
- * @property {external:Duration|string} timePickerStepSize=Duration.fromObject({minutes:1}) - Set the time picker step size.<br/>
76
+ * @property {external:Duration|string} timePickerStepSize - Default: `Duration.fromObject({minutes:1})`<br/>Set the time picker step size.<br/>
77
77
  * Must be a `luxon.Duration` or number of seconds or a string according to {@link ISO-8601} duration.<br/>
78
78
  * Valid values are 1,2,3,4,5,6,10,12,15,20,30 for `Duration.fromObject({seconds: ...})` and `Duration.fromObject({minutes: ...})`
79
79
  * and 1,2,3,4,6,(8,12) for `Duration.fromObject({hours: ...})`.<br/>
80
- * Duration must be greater than {@link minSpan} and smaller than {@link maxSpan}.<br/>
80
+ * Duration must be greater than `minSpan` and smaller than `maxSpan`.<br/>
81
81
  * For example `timePickerStepSize: 600` will disable time picker seconds and time picker minutes are set to step size of 10 Minutes.<br/>
82
82
  * Overwrites #timePickerIncrement and #timePickerSeconds
83
- * @property {boolean} timePickerSeconds=boolean - **Deprecated**, use {@link timePickerStepSize}<br/>Show seconds in the timePicker
84
- * @property {boolean} timePickerIncrement=1 - **Deprecated**, use {@link timePickerStepSize}<br/>Increment of the minutes selection list for times
83
+ * @property {boolean} timePickerSeconds=boolean - **Deprecated**, use `timePickerStepSize`<br/>Show seconds in the timePicker
84
+ * @property {boolean} timePickerIncrement=1 - **Deprecated**, use `timePickerStepSize`<br/>Increment of the minutes selection list for times
85
85
 
86
86
  * @property {boolean} autoUpdateInput=true - Indicates whether the date range picker should automatically update the value of the `<input>`
87
87
  * element it's attached to at initialization and when the selected dates change.<br/>Value is reverted when use clicks on `Cancel`.
88
88
  * @property {string} onOutsideClick=none - Defines what picker shall do when user clicks outside the calendar.
89
- * `'apply'` or `'cancel'`. Event {@link 'onOutsideClick.daterangepicker'} is always emitted.
89
+ * `'apply'` or `'cancel'`. Event {@link #event_outsideClick.daterangepicker|onOutsideClick.daterangepicker} is always emitted.
90
90
  * @property {boolean} linkedCalendars=true - When enabled, the two calendars displayed will always be for two sequential months (i.e. January and February),
91
91
  * and both will be advanced when clicking the left or right arrows above the calendars.<br/>
92
92
  * When disabled, the two calendars can be individually advanced and display any month/year
93
93
  * @property {function} isInvalidDate=false - A function that is passed each date in the two calendars before they are displayed,<br/>
94
94
  * and may return `true` or `false` to indicate whether that date should be available for selection or not.<br/>
95
95
  * Signature: `isInvalidDate(date)`
96
- * Function has no effect on date values set by {@link startDate}, {@link endDate}, {@link ranges}, {@link setStartDate}, {@link setEndDate}.
96
+ * Function has no effect on date values set by `startDate`, `endDate`, `ranges`, {@link #setStartDate}, {@link #setEndDate|setEndDate}.
97
97
  * @property {function} isInvalidTime=false - A function that is passed each hour/minute/second/am-pm in the two calendars before they are displayed,<br/>
98
98
  * and may return `true` or `false` to indicate whether that date should be available for selection or not.<br/>
99
99
  * Signature: `isInvalidDate(time, side, unit)`<br/>
100
100
  * `side` is 'start' or 'end' or `null` for `singleDatePicker = true`<br/>
101
101
  * `unit` is `'hour'`, `'minute'`, `'second'` or `'ampm'`<br/>
102
- * Function has no effect on time values set by {@link startDate}, {@link endDate}, {@link ranges}, {@link setStartDate}, {@link setEndDate}.<br/>
102
+ * Function has no effect on time values set by `startDate`, `endDate`, `ranges`, {@link #setStartDate|setStartDate}, {@link #setEndDate|setEndDate}.<br/>
103
103
  * Ensure that your function returns `false` for at least one item. Otherwise the calender is not rendered.<br/>
104
104
  * @property {function} isCustomDate=false - A function that is passed each date in the two calendars before they are displayed,
105
105
  * and may return a string or array of CSS class names to apply to that date's calendar cell.<br/>
@@ -115,7 +115,7 @@
115
115
 
116
116
  * @property {Options.Ranges} ranges={} - Set predefined date ranges the user can select from. Each key is the label for the range,
117
117
  * and its value an array with two dates representing the bounds of the range.
118
- * @property {boolean} showCustomRangeLabel=true - Displays "Custom Range" at the end of the list of predefined {@link Ranges},
118
+ * @property {boolean} showCustomRangeLabel=true - Displays "Custom Range" at the end of the list of predefined {@link #Ranges|Ranges},
119
119
  * when the ranges option is used.<br>
120
120
  * This option will be highlighted whenever the current date range selection does not match one of the predefined ranges.<br/>
121
121
  * Clicking it will display the calendars to select a new range.
@@ -125,15 +125,15 @@
125
125
  * @property {object} locale={} - Allows you to provide localized strings for buttons and labels, customize the date format,
126
126
  * and change the first day of week for the calendars.
127
127
  * @property {string} locale.direction=ltr - Direction of reading, `'ltr'` or `'rtl'`
128
- * @property {object|string} locale.format=DateTime.DATE_SHORT - Date formats. Either given as string,
128
+ * @property {object|string} locale.format - Default: `DateTime.DATE_SHORT`<br/>Date formats. Either given as string,
129
129
  * see [Format Tokens](https://moment.github.io/luxon/#/formatting?id=table-of-tokens) or an object according
130
130
  * to [Intl.DateTimeFormat](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat)<br/>
131
131
  * I recommend to use the luxon [Presets](https://moment.github.io/luxon/#/formatting?id=presets).
132
132
  * @property {string} locale.separator= - Defaut: `' - '` - Separator for start and end time
133
133
  * @property {string} locale.weekLabel=W - Label for week numbers
134
- * @property {Array(string)} locale.daysOfWeek=Info.weekdays('short') - Array with weekday names, from Monday to Sunday
135
- * @property {Array(string)} locale.monthNames=Info.months('long') - Array with month names
136
- * @property {number} locale.firstDay=Info.getStartOfWeek() - First day of the week, 1 for Monday through 7 for Sunday
134
+ * @property {Array(string)} locale.daysOfWeek - Default: `Info.weekdays('short')`<br/>Array with weekday names, from Monday to Sunday
135
+ * @property {Array(string)} locale.monthNames - Default: `Info.months('long')`<br/>Array with month names
136
+ * @property {number} locale.firstDay - Default: `Info.getStartOfWeek()`<br/>First day of the week, 1 for Monday through 7 for Sunday
137
137
  * @property {string} locale.applyLabel=Apply - Label of `Apply` Button
138
138
  * @property {string} locale.cancelLabel=Cancel - Label of `Cancel` Button
139
139
  * @property {string} locale.customRangeLabel=Custom Range - Title for custom ranges
@@ -679,11 +679,11 @@
679
679
  /**
680
680
  * Sets the date range picker's currently selected start date to the provided date.<br/>
681
681
  * `startDate` must be a `luxon.DateTime` or `Date` or `string` according to {@link ISO-8601} or
682
- * a string matching {@link locale.format}.
682
+ * a string matching `locale.format`.
683
683
  * The value of the attached `<input>` element is also updated.
684
- * Date value is rounded to match option {@link timePickerStepSize}<br/>
685
- * Functions {@link isInvalidDate} and {@link isInvalidTime} are not evaluated, you may set date/time which is not selectable in calendar.<br/>
686
- * If the `startDate` does not fall into {@link minDate} and {@link maxDate} then {@link startDate} is shifted and a warning is written to console.
684
+ * Date value is rounded to match option `timePickerStepSize`<br/>
685
+ * Functions `isInvalidDate` and `isInvalidTime` are not evaluated, you may set date/time which is not selectable in calendar.<br/>
686
+ * If the `startDate` does not fall into `minDate` and `maxDate` then `startDate` is shifted and a warning is written to console.
687
687
  * @param {external:DateTime|external:Date|string} startDate - startDate to be set
688
688
  * @throws `RangeError` for invalid date values.
689
689
  * @example const DateTime = luxon.DateTime;
@@ -726,13 +726,13 @@
726
726
 
727
727
  /**
728
728
  * Sets the date range picker's currently selected end date to the provided date.<br/>
729
- * `endDate` be a `luxon.DateTime` or `Date` or `string` according to {@link ISO-8601} or
730
- * a string matching {@link locale.format}.
729
+ * `endDate` must be a `luxon.DateTime` or `Date` or `string` according to {@link ISO-8601} or
730
+ * a string matching`locale.format`.
731
731
  * The value of the attached `<input>` element is also updated.
732
- * Date value is rounded to match option {@link timePickerStepSize}<br/>
733
- * Functions {@link isInvalidDate} and {@link isInvalidTime} are not evaluated, you may set date/time which is not selectable in calendar.<br/>
734
- * If the {@link endDate} does not fall into {@link minDate} and {@link maxDate} or into {@link minSpan} and {@link maxSpan}
735
- * then {@link endDate} is shifted and a warning is written to console.
732
+ * Date value is rounded to match option `timePickerStepSize`<br/>
733
+ * Functions `isInvalidDate` and `isInvalidTime` are not evaluated, you may set date/time which is not selectable in calendar.<br/>
734
+ * If the `endDate` does not fall into `minDate` and `maxDate` or into `minSpan` and `maxSpan`
735
+ * then `endDate` is shifted and a warning is written to console.
736
736
  * @param {external:DateTime|external:Date|string} endDate - endDate to be set
737
737
  * @throws `RangeError` for invalid date values.
738
738
  * @example const drp = $('#picker').data('daterangepicker');
@@ -789,7 +789,7 @@
789
789
  },
790
790
 
791
791
  /**
792
- * Shortcut for {@link setStartDate} and {@link setEndDate}
792
+ * Shortcut for {@link #setStartDate|setStartDate} and {@link #setEndDate|setEndDate}
793
793
  * @param {external:DateTime|external:Date|string} startDate - startDate to be set
794
794
  * @param {external:DateTime|external:Date|string} endDate - endDate to be set
795
795
  * @throws `RangeError` for invalid date values.
@@ -810,19 +810,19 @@
810
810
  /**
811
811
  * @typedef constraintOptions
812
812
  * @type {Object}
813
- * @property {boolean} stepSize=true If `true`, then `startDate` and `endDate` are rounded to match {@link timePickerStepSize} (no warning)
814
- * @property {boolean} minMax=true If `true` then and if the `startDate` and `endDate` do not fall into {@link minDate} and {@link maxDate}
813
+ * @property {boolean} stepSize=true If `true`, then `startDate` and `endDate` are rounded to match `timePickerStepSize` (no warning)
814
+ * @property {boolean} minMax=true If `true` then and if the `startDate` and `endDate` do not fall into `minDate` and `maxDate`
815
815
  * then dates are shifted and a warning is written to console.
816
- * @property {boolean} span=true If `true` then and if the `startDate` and `endDate` do not fall into {@link minSpan} and {@link maxSpan}
816
+ * @property {boolean} span=true If `true` then and if the `startDate` and `endDate` do not fall into `minDate` and `maxSpan`
817
817
  * then `endDate` is shifted and a warning is written to console.
818
- * @property {boolean} invalidDate=false If `true` then and if {@link invalidDate} return `true`, then an error is logged to console
819
- * @property {boolean} invalidTime=false If `true` then and if {@link invalidTime} return `true`, then an error is logged to console
818
+ * @property {boolean} invalidDate=false If `true` then and if `invalidDate` return `true`, then an error is logged to console
819
+ * @property {boolean} invalidTime=false If `true` then and if `invalidTime` return `true`, then an error is logged to console
820
820
  * @private
821
821
  */
822
822
 
823
823
  /**
824
- * Modifies and checks `startDate` and `endDate` against {@link timePickerStepSize}, {@link minDate}, {@link maxDate},
825
- * {@link minSpan}, {@link maxSpan}, {@link invalidDate} and {@link invalidTime}
824
+ * Modifies and checks `startDate` and `endDate` against `timePickerStepSize`, `minDate`, `maxDate`,
825
+ * `minSpan`, `maxSpan`, `invalidDate` and `invalidTime`
826
826
  * @param {constraintOptions} options - Defines which constraint shall apply
827
827
  * @param {Array} [range] - Used to check prefefined range instead of `startDate` and `endDate` => `[name, startDate, endDate]`
828
828
  * @throws `RangeError` for invalid date values
@@ -982,7 +982,8 @@
982
982
 
983
983
 
984
984
  /**
985
- * Updates the picker when calendar is initiated or any date has been selected. Could be useful after running {@link setStartDate} or {@link setEndDate}
985
+ * Updates the picker when calendar is initiated or any date has been selected.
986
+ * Could be useful after running {@link #setStartDate|setStartDate} or {@link #setEndDate|setEndDate}
986
987
  */
987
988
  updateView: function () {
988
989
  if (this.timePicker) {
@@ -1744,7 +1745,6 @@
1744
1745
  * Closes the picker when user clicks outside
1745
1746
  * @param {external:jQuery} e - The Event target
1746
1747
  * @emits "outsideClick.daterangepicker"
1747
- * @private
1748
1748
  */
1749
1749
  outsideClick: function (e) {
1750
1750
  var target = $(e.target);
@@ -1766,7 +1766,8 @@
1766
1766
 
1767
1767
  /**
1768
1768
  * Emitted when user clicks outside the picker.
1769
- * Picker values is not updated, you may trigger {@link "apply.daterangepicker"} or {@link "cancel.daterangepicker"} in your EventHandler.
1769
+ * Picker values is not updated, you may trigger {@link #event_apply.daterangepicker|"apply.daterangepicker"}
1770
+ * or {@link #event_cancel.daterangepicker|"cancel.daterangepicker"} in your EventHandler.
1770
1771
  * @event
1771
1772
  * @name "outsideClick.daterangepicker"
1772
1773
  * @param {DateRangePicker} this - The daterangepicker object
@@ -1784,7 +1785,7 @@
1784
1785
  this.move();
1785
1786
  /**
1786
1787
  * Emitted when the calendar(s) are shown.
1787
- * Only useful when {@link ranges} are used.
1788
+ * Only useful when {@link #Ranges|Ranges} are used.
1788
1789
  * @event
1789
1790
  * @name "showCalendar.daterangepicker"
1790
1791
  * @param {DateRangePicker} this - The daterangepicker object
@@ -1801,7 +1802,7 @@
1801
1802
  this.container.removeClass('show-calendar');
1802
1803
  /**
1803
1804
  * Emitted when the calendar(s) are hidden.
1804
- * Only useful when {@link ranges} are used.
1805
+ * Only useful when {@link #Ranges|Ranges} are used.
1805
1806
  * @event
1806
1807
  * @name "hideCalendar.daterangepicker"
1807
1808
  * @param {DateRangePicker} this - The daterangepicker object
@@ -2069,7 +2070,8 @@
2069
2070
  this.updateElement();
2070
2071
 
2071
2072
  /**
2072
- * Emitted when the date changed. Does not trigger when time is changed, use {@link "timeChange.daterangepicker"} to handle it
2073
+ * Emitted when the date changed. Does not trigger when time is changed,
2074
+ * use {@link #event_timeChange.daterangepicker|"timeChange.daterangepicker"} to handle it
2073
2075
  * @event
2074
2076
  * @name "dateChange.daterangepicker"
2075
2077
  * @param {DateRangePicker} this - The daterangepicker object
@@ -2122,7 +2124,7 @@
2122
2124
  clickApply: function (e) {
2123
2125
  this.hide();
2124
2126
  /**
2125
- * Emitted when the `Apply` button is clicked, or when a predefined {@link ranges} is clicked
2127
+ * Emitted when the `Apply` button is clicked, or when a predefined {@link #Ranges|Ranges} is clicked
2126
2128
  * @event
2127
2129
  * @name "apply.daterangepicker"
2128
2130
  * @param {DateRangePicker} this - The daterangepicker object
@@ -2353,13 +2355,14 @@
2353
2355
  * @param {external:DateTime} endDate - Selected endDate
2354
2356
  * @param {string} range
2355
2357
  */
2356
-
2358
+
2357
2359
  /**
2358
2360
  * Initiate a new DateRangePicker
2359
2361
  * @name DateRangePicker.daterangepicker
2360
2362
  * @function
2361
2363
  * @param {Options} options - Object to configure the DateRangePicker
2362
- * @param {callback} callback - Callback function executed when date is changed. As alternative listen to the {@link "apply.daterangepicker"} event
2364
+ * @param {callback} callback - Callback function executed when date is changed.
2365
+ * As alternative listen to the {@link #event_apply.daterangepicker|"apply.daterangepicker"} event
2363
2366
  * @returns DateRangePicker
2364
2367
  */
2365
2368
  $.fn.daterangepicker = function (options, callback) {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "daterangepicker-4.x",
3
- "version": "4.1.1",
3
+ "version": "4.1.3",
4
4
  "description": "Date range picker component for Bootstrap",
5
5
  "main": "daterangepicker.js",
6
6
  "style": "daterangepicker.css",