@wernfried/daterangepicker 4.17.4 → 4.18.0

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.
package/API_Doc.md CHANGED
@@ -8,19 +8,17 @@
8
8
  ## Events
9
9
 
10
10
  <dl>
11
- <dt><a href="#event_violated.daterangepicker">"violated.daterangepicker" (this, picker, result, newDate)</a> ⇒ <code>boolean</code></dt>
11
+ <dt><a href="#event_violated.daterangepicker">"violated.daterangepicker" (picker, result, newDate)</a> ⇒ <code>boolean</code></dt>
12
12
  <dd><p>Emitted when the date is changed through <code>&lt;input&gt;</code> element or via <a href="#DateRangePicker+setStartDate">setStartDate</a> or
13
13
  <a href="#DateRangePicker+setRange">setRange</a> and date is not valid due to
14
14
  <code>minDate</code>, <code>maxDate</code>, <code>minSpan</code>, <code>maxSpan</code>, <code>invalidDate</code> and <code>invalidTime</code> constraints.<br>
15
15
  Event is only triggered when date string is valid and date value is changing<br></p>
16
16
  </dd>
17
17
  <dt><a href="#event_beforeRenderCalendar.daterangepicker">"beforeRenderCalendar.daterangepicker" (this)</a></dt>
18
- <dd><p>Emitted before the calendar is rendered.
19
- Useful to remove any manually added elements.</p>
18
+ <dd><p>Emitted before the calendar time picker is rendered.</p>
20
19
  </dd>
21
- <dt><a href="#event_beforeRenderTimePicker.daterangepicker">"beforeRenderTimePicker.daterangepicker" (this)</a></dt>
22
- <dd><p>Emitted before the TimePicker is rendered.
23
- Useful to remove any manually added elements.</p>
20
+ <dt><a href="#event_beforeRenderCalendar.daterangepicker">"beforeRenderCalendar.daterangepicker" (this)</a></dt>
21
+ <dd><p>Emitted before the calendar is rendered. Useful to remove any manually added elements.</p>
24
22
  </dd>
25
23
  <dt><a href="#event_show.daterangepicker">"show.daterangepicker" (this)</a></dt>
26
24
  <dd><p>Emitted when the picker is shown</p>
@@ -36,16 +34,13 @@ Useful to remove any manually added elements.</p>
36
34
  Only useful when <a href="#Ranges">Ranges</a> are used.</p>
37
35
  </dd>
38
36
  <dt><a href="#event_hideCalendar.daterangepicker">"hideCalendar.daterangepicker" (this)</a></dt>
39
- <dd><p>Emitted when the calendar(s) are hidden.
40
- Only useful when <a href="#Ranges">Ranges</a> are used.</p>
37
+ <dd><p>Emitted when the calendar(s) are hidden. Only used when <a href="#Ranges">Ranges</a> are used.</p>
41
38
  </dd>
42
39
  <dt><a href="#event_outsideClick.daterangepicker">"outsideClick.daterangepicker" (this)</a></dt>
43
- <dd><p>Emitted when user clicks outside the picker.
44
- Use option <code>onOutsideClick</code> to define the default action, then you may not need to handle this event.</p>
40
+ <dd><p>Emitted when user clicks outside the picker. Use option <code>onOutsideClick</code> to define the default action, then you may not need to handle this event.</p>
45
41
  </dd>
46
42
  <dt><a href="#event_dateChange.daterangepicker">"dateChange.daterangepicker" (this, side)</a></dt>
47
- <dd><p>Emitted when the date changed. Does not trigger when time is changed,
48
- use <a href="#event_timeChange.daterangepicker">&quot;timeChange.daterangepicker&quot;</a> to handle it</p>
43
+ <dd><p>Emitted when the date changed. Does not trigger when time is changed, use <a href="#event_timeChange.daterangepicker">&quot;timeChange.daterangepicker&quot;</a> to handle it</p>
49
44
  </dd>
50
45
  <dt><a href="#event_timeChange.daterangepicker">"timeChange.daterangepicker" (this, side)</a></dt>
51
46
  <dd><p>Emitted when the time changed. Does not trigger when date is changed</p>
@@ -59,6 +54,13 @@ use <a href="#event_timeChange.daterangepicker">&quot;timeChange.daterangepicker
59
54
  <dt><a href="#event_inputChanged.daterangepicker">"inputChanged.daterangepicker" (this)</a></dt>
60
55
  <dd><p>Emitted when the date is changed through <code>&lt;input&gt;</code> element. Event is only triggered when date string is valid and date value has changed</p>
61
56
  </dd>
57
+ <dt><a href="#event_monthViewChanged.daterangepicker">"monthViewChanged.daterangepicker" (this)</a></dt>
58
+ <dd><p>Emitted after month view changed, for example by click on &#39;prev&#39; or &#39;next&#39;</p>
59
+ </dd>
60
+ <dt><a href="#event_beforeRenderTimePicker.daterangepicker">"beforeRenderTimePicker.daterangepicker" (this)</a></dt>
61
+ <dd><p>Emitted before the TimePicker is rendered.
62
+ Useful to remove any manually added elements.</p>
63
+ </dd>
62
64
  </dl>
63
65
 
64
66
  ## Typedefs
@@ -96,7 +98,7 @@ Ranges are not validated against <code>minDate</code>, <code>maxDate</code>, <co
96
98
  * [.parseDate(value)](#DateRangePicker+parseDate) ⇒ [<code>DateTime</code>](https://moment.github.io/luxon/api-docs/index.html#datetime)
97
99
  * [.formatDate(date, format)](#DateRangePicker+formatDate) ⇒ <code>string</code>
98
100
  * [.validateInput(range, dipatch)](#DateRangePicker+validateInput) ⇒ [<code>InputViolation</code>](#InputViolation) \| <code>null</code>
99
- * [.updateView()](#DateRangePicker+updateView)
101
+ * [.updateView(monthChanged)](#DateRangePicker+updateView)
100
102
  * [.show()](#DateRangePicker+show)
101
103
  * [.hide()](#DateRangePicker+hide)
102
104
  * [.toggle()](#DateRangePicker+toggle)
@@ -260,12 +262,17 @@ result => {
260
262
  ```
261
263
  <a name="DateRangePicker+updateView"></a>
262
264
 
263
- ### dateRangePicker.updateView()
265
+ ### dateRangePicker.updateView(monthChanged)
264
266
  Updates the picker when calendar is initiated or any date has been selected.
265
267
  Could be useful after running [setStartDate](#DateRangePicker+setStartDate) or [setRange](#DateRangePicker+setEndDate)
266
268
 
267
269
  **Kind**: instance method of [<code>DateRangePicker</code>](#DateRangePicker)
268
270
  **Emits**: <code>event:&quot;beforeRenderTimePicker.daterangepicker&quot;</code>
271
+
272
+ | Param | Type | Description |
273
+ | --- | --- | --- |
274
+ | monthChanged | <code>boolean</code> | If `true` then monthView changed |
275
+
269
276
  <a name="DateRangePicker+show"></a>
270
277
 
271
278
  ### dateRangePicker.show()
@@ -334,7 +341,7 @@ Initiate a new DateRangePicker
334
341
 
335
342
  <a name="event_violated.daterangepicker"></a>
336
343
 
337
- ## "violated.daterangepicker" (this, picker, result, newDate) ⇒ <code>boolean</code>
344
+ ## "violated.daterangepicker" (picker, result, newDate) ⇒ <code>boolean</code>
338
345
  Emitted when the date is changed through `<input>` element or via [setStartDate](#DateRangePicker+setStartDate) or
339
346
  [setRange](#DateRangePicker+setRange) and date is not valid due to
340
347
  `minDate`, `maxDate`, `minSpan`, `maxSpan`, `invalidDate` and `invalidTime` constraints.<br>
@@ -345,7 +352,6 @@ Event is only triggered when date string is valid and date value is changing<br>
345
352
 
346
353
  | Param | Type | Description |
347
354
  | --- | --- | --- |
348
- | this | <code>Object</code> | The event object |
349
355
  | picker | [<code>DateRangePicker</code>](#DateRangePicker) | The daterangepicker object |
350
356
  | result | [<code>InputViolation</code>](#InputViolation) | The violation object, see example of `validateInput()` |
351
357
  | newDate | <code>Object</code> | Object of {startDate, endDate} |
@@ -376,8 +382,7 @@ const drp = $('#picker').data('daterangepicker').setStartDate(DateTime.now().min
376
382
  <a name="event_beforeRenderCalendar.daterangepicker"></a>
377
383
 
378
384
  ## "beforeRenderCalendar.daterangepicker" (this)
379
- Emitted before the calendar is rendered.
380
- Useful to remove any manually added elements.
385
+ Emitted before the calendar time picker is rendered.
381
386
 
382
387
  **Kind**: event emitted
383
388
 
@@ -385,11 +390,10 @@ Useful to remove any manually added elements.
385
390
  | --- | --- | --- |
386
391
  | this | [<code>DateRangePicker</code>](#DateRangePicker) | The daterangepicker object |
387
392
 
388
- <a name="event_beforeRenderTimePicker.daterangepicker"></a>
393
+ <a name="event_beforeRenderCalendar.daterangepicker"></a>
389
394
 
390
- ## "beforeRenderTimePicker.daterangepicker" (this)
391
- Emitted before the TimePicker is rendered.
392
- Useful to remove any manually added elements.
395
+ ## "beforeRenderCalendar.daterangepicker" (this)
396
+ Emitted before the calendar is rendered. Useful to remove any manually added elements.
393
397
 
394
398
  **Kind**: event emitted
395
399
 
@@ -446,8 +450,7 @@ Only useful when [Ranges](#Ranges) are used.
446
450
  <a name="event_hideCalendar.daterangepicker"></a>
447
451
 
448
452
  ## "hideCalendar.daterangepicker" (this)
449
- Emitted when the calendar(s) are hidden.
450
- Only useful when [Ranges](#Ranges) are used.
453
+ Emitted when the calendar(s) are hidden. Only used when [Ranges](#Ranges) are used.
451
454
 
452
455
  **Kind**: event emitted
453
456
 
@@ -458,8 +461,7 @@ Only useful when [Ranges](#Ranges) are used.
458
461
  <a name="event_outsideClick.daterangepicker"></a>
459
462
 
460
463
  ## "outsideClick.daterangepicker" (this)
461
- Emitted when user clicks outside the picker.
462
- Use option `onOutsideClick` to define the default action, then you may not need to handle this event.
464
+ Emitted when user clicks outside the picker. Use option `onOutsideClick` to define the default action, then you may not need to handle this event.
463
465
 
464
466
  **Kind**: event emitted
465
467
 
@@ -470,8 +472,7 @@ Use option `onOutsideClick` to define the default action, then you may not need
470
472
  <a name="event_dateChange.daterangepicker"></a>
471
473
 
472
474
  ## "dateChange.daterangepicker" (this, side)
473
- Emitted when the date changed. Does not trigger when time is changed,
474
- use ["timeChange.daterangepicker"](#event_timeChange.daterangepicker) to handle it
475
+ Emitted when the date changed. Does not trigger when time is changed, use ["timeChange.daterangepicker"](#event_timeChange.daterangepicker) to handle it
475
476
 
476
477
  **Kind**: event emitted
477
478
 
@@ -525,6 +526,29 @@ Emitted when the date is changed through `<input>` element. Event is only trigge
525
526
  | --- | --- | --- |
526
527
  | this | [<code>DateRangePicker</code>](#DateRangePicker) | The daterangepicker object |
527
528
 
529
+ <a name="event_monthViewChanged.daterangepicker"></a>
530
+
531
+ ## "monthViewChanged.daterangepicker" (this)
532
+ Emitted after month view changed, for example by click on 'prev' or 'next'
533
+
534
+ **Kind**: event emitted
535
+
536
+ | Param | Type | Description |
537
+ | --- | --- | --- |
538
+ | this | [<code>DateRangePicker</code>](#DateRangePicker) | The daterangepicker object |
539
+
540
+ <a name="event_beforeRenderTimePicker.daterangepicker"></a>
541
+
542
+ ## "beforeRenderTimePicker.daterangepicker" (this)
543
+ Emitted before the TimePicker is rendered.
544
+ Useful to remove any manually added elements.
545
+
546
+ **Kind**: event emitted
547
+
548
+ | Param | Type | Description |
549
+ | --- | --- | --- |
550
+ | this | [<code>DateRangePicker</code>](#DateRangePicker) | The daterangepicker object |
551
+
528
552
  <a name="Options"></a>
529
553
 
530
554
  ## Options
package/README.md CHANGED
@@ -20,8 +20,8 @@ Above samples are based on the [original repository](https://github.com/dangross
20
20
  ```html
21
21
  <script type="text/javascript" src="https://cdn.jsdelivr.net/jquery/latest/jquery.min.js"></script>
22
22
  <script type="text/javascript" src="https://cdn.jsdelivr.net/npm/luxon@3.5.0/build/global/luxon.min.js"></script>
23
- <script type="text/javascript" src="https://cdn.jsdelivr.net/npm/@wernfried/daterangepicker@4.17.4/dist/global/daterangepicker.min.js"></script>
24
- <link type="text/css" href="https://cdn.jsdelivr.net/npm/@wernfried/daterangepicker@4.17.4/css/daterangepicker.min.css" rel="stylesheet" />
23
+ <script type="text/javascript" src="https://cdn.jsdelivr.net/npm/@wernfried/daterangepicker@4.18.0/dist/global/daterangepicker.min.js"></script>
24
+ <link type="text/css" href="https://cdn.jsdelivr.net/npm/@wernfried/daterangepicker@4.18.0/css/daterangepicker.min.css" rel="stylesheet" />
25
25
 
26
26
  <input type="text" id="picker" />
27
27
 
@@ -43,11 +43,11 @@ Above samples are based on the [original repository](https://github.com/dangross
43
43
  "imports": {
44
44
  "jquery": "https://cdn.jsdelivr.net/npm/jquery@4.0.0/+esm",
45
45
  "luxon": "https://cdn.jsdelivr.net/npm/luxon@3.7.2/+esm",
46
- "daterangepicker": "https://cdn.jsdelivr.net/npm/@wernfried/daterangepicker@4.17.4/+esm"
46
+ "daterangepicker": "https://cdn.jsdelivr.net/npm/@wernfried/daterangepicker@4.18.0/+esm"
47
47
  }
48
48
  }
49
49
  </script>
50
- <link type="text/css" href="https://cdn.jsdelivr.net/npm/@wernfried/daterangepicker@4.17.4/css/daterangepicker.min.css" rel="stylesheet" />
50
+ <link type="text/css" href="https://cdn.jsdelivr.net/npm/@wernfried/daterangepicker@4.18.0/css/daterangepicker.min.css" rel="stylesheet" />
51
51
 
52
52
  <input type="text" id="picker" />
53
53
 
@@ -68,7 +68,7 @@ Above samples are based on the [original repository](https://github.com/dangross
68
68
  ```html
69
69
  <script ...></script>
70
70
  <link type="text/css" href="https://cdn.jsdelivr.net/npm/bulma@1.0.4/css/bulma.min.css" rel="stylesheet" />
71
- <link type="text/css" href="https://cdn.jsdelivr.net/npm/@wernfried/daterangepicker@4.17.4/css/daterangepicker.bulma.min.css" rel="stylesheet" />
71
+ <link type="text/css" href="https://cdn.jsdelivr.net/npm/@wernfried/daterangepicker@4.18.0/css/daterangepicker.bulma.min.css" rel="stylesheet" />
72
72
 
73
73
  <input type="text" id="picker" />
74
74