@wernfried/daterangepicker 4.17.5 → 4.19.0

package/API_Doc.md

@@ -8,19 +8,17 @@
 ## Events
 
 <dl>
-<dt><a href="#event_violated.daterangepicker">"violated.daterangepicker" (this, picker, result, newDate)</a> ⇒ <code>boolean</code></dt>
+<dt><a href="#event_violate.daterangepicker">"violate.daterangepicker" (picker, result, newDate)</a> ⇒ <code>boolean</code></dt>
 <dd><p>Emitted when the date is changed through <code>&lt;input&gt;</code> element or via <a href="#DateRangePicker+setStartDate">setStartDate</a> or 
 <a href="#DateRangePicker+setRange">setRange</a> and date is not valid due to 
 <code>minDate</code>, <code>maxDate</code>, <code>minSpan</code>, <code>maxSpan</code>, <code>invalidDate</code> and <code>invalidTime</code> constraints.<br>
 Event is only triggered when date string is valid and date value is changing<br></p>
 </dd>
 <dt><a href="#event_beforeRenderCalendar.daterangepicker">"beforeRenderCalendar.daterangepicker" (this)</a></dt>
-<dd><p>Emitted before the calendar is rendered. 
-Useful to remove any manually added elements.</p>
+<dd><p>Emitted before the calendar time picker is rendered.</p>
 </dd>
-<dt><a href="#event_beforeRenderTimePicker.daterangepicker">"beforeRenderTimePicker.daterangepicker" (this)</a></dt>
-<dd><p>Emitted before the TimePicker is rendered.
-Useful to remove any manually added elements.</p>
+<dt><a href="#event_beforeRenderCalendar.daterangepicker">"beforeRenderCalendar.daterangepicker" (this)</a></dt>
+<dd><p>Emitted before the calendar is rendered. Useful to remove any manually added elements.</p>
 </dd>
 <dt><a href="#event_show.daterangepicker">"show.daterangepicker" (this)</a></dt>
 <dd><p>Emitted when the picker is shown</p>
@@ -36,16 +34,13 @@ Useful to remove any manually added elements.</p>
 Only useful when <a href="#Ranges">Ranges</a> are used.</p>
 </dd>
 <dt><a href="#event_hideCalendar.daterangepicker">"hideCalendar.daterangepicker" (this)</a></dt>
-<dd><p>Emitted when the calendar(s) are hidden.
-Only useful when <a href="#Ranges">Ranges</a> are used.</p>
+<dd><p>Emitted when the calendar(s) are hidden. Only used when <a href="#Ranges">Ranges</a> are used.</p>
 </dd>
 <dt><a href="#event_outsideClick.daterangepicker">"outsideClick.daterangepicker" (this)</a></dt>
-<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>
+<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>
 </dd>
 <dt><a href="#event_dateChange.daterangepicker">"dateChange.daterangepicker" (this, side)</a></dt>
-<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>
+<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>
 </dd>
 <dt><a href="#event_timeChange.daterangepicker">"timeChange.daterangepicker" (this, side)</a></dt>
 <dd><p>Emitted when the time changed. Does not trigger when date is changed</p>
@@ -56,9 +51,16 @@ use <a href="#event_timeChange.daterangepicker">&quot;timeChange.daterangepicker
 <dt><a href="#event_cancel.daterangepicker">"cancel.daterangepicker" (this)</a></dt>
 <dd><p>Emitted when the <code>Cancel</code> button is clicked</p>
 </dd>
-<dt><a href="#event_inputChanged.daterangepicker">"inputChanged.daterangepicker" (this)</a></dt>
+<dt><a href="#event_inputChange.daterangepicker">"inputChange.daterangepicker" (this)</a></dt>
 <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>
 </dd>
+<dt><a href="#event_monthViewChange.daterangepicker">"monthViewChange.daterangepicker" (this, left, right)</a></dt>
+<dd><p>Emitted after month view changed, for example by click on &#39;prev&#39; or &#39;next&#39;</p>
+</dd>
+<dt><a href="#event_beforeRenderTimePicker.daterangepicker">"beforeRenderTimePicker.daterangepicker" (this)</a></dt>
+<dd><p>Emitted before the TimePicker is rendered.
+Useful to remove any manually added elements.</p>
+</dd>
 </dl>
 
 ## Typedefs
@@ -90,13 +92,14 @@ Ranges are not validated against <code>minDate</code>, <code>maxDate</code>, <co
     * _instance_
         * [.startDate](#DateRangePicker+startDate) : [<code>DateTime</code>](https://moment.github.io/luxon/api-docs/index.html#datetime)
         * [.endDate](#DateRangePicker+endDate) : [<code>DateTime</code>](https://moment.github.io/luxon/api-docs/index.html#datetime)
+        * [.events](#DateRangePicker+events)
         * [.setStartDate(startDate, updateView)](#DateRangePicker+setStartDate) ⇒ [<code>InputViolation</code>](#InputViolation)
         * [.setEndDate(endDate, updateView)](#DateRangePicker+setEndDate) ⇒ [<code>InputViolation</code>](#InputViolation)
         * [.setRange(startDate, endDate, updateView)](#DateRangePicker+setRange) ⇒ [<code>InputViolation</code>](#InputViolation)
         * [.parseDate(value)](#DateRangePicker+parseDate) ⇒ [<code>DateTime</code>](https://moment.github.io/luxon/api-docs/index.html#datetime)
         * [.formatDate(date, format)](#DateRangePicker+formatDate) ⇒ <code>string</code>
         * [.validateInput(range, dipatch)](#DateRangePicker+validateInput) ⇒ [<code>InputViolation</code>](#InputViolation) \| <code>null</code>
-        * [.updateView()](#DateRangePicker+updateView)
+        * [.updateView(monthChange)](#DateRangePicker+updateView)
         * [.show()](#DateRangePicker+show)
         * [.hide()](#DateRangePicker+hide)
         * [.toggle()](#DateRangePicker+toggle)
@@ -129,6 +132,12 @@ startDate
 ### dateRangePicker.endDate : [<code>DateTime</code>](https://moment.github.io/luxon/api-docs/index.html#datetime)
 endDate
 
+**Kind**: instance property of [<code>DateRangePicker</code>](#DateRangePicker)  
+<a name="DateRangePicker+events"></a>
+
+### dateRangePicker.events
+Getter for all DateRangePickerEvents
+
 **Kind**: instance property of [<code>DateRangePicker</code>](#DateRangePicker)  
 <a name="DateRangePicker+setStartDate"></a>
 
@@ -260,12 +269,17 @@ result => {
 ```
 <a name="DateRangePicker+updateView"></a>
 
-### dateRangePicker.updateView()
+### dateRangePicker.updateView(monthChange)
 Updates the picker when calendar is initiated or any date has been selected. 
 Could be useful after running [setStartDate](#DateRangePicker+setStartDate) or [setRange](#DateRangePicker+setEndDate)
 
 **Kind**: instance method of [<code>DateRangePicker</code>](#DateRangePicker)  
 **Emits**: <code>event:&quot;beforeRenderTimePicker.daterangepicker&quot;</code>  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| monthChange | <code>boolean</code> | If `true` then monthView changed |
+
 <a name="DateRangePicker+show"></a>
 
 ### dateRangePicker.show()
@@ -332,9 +346,9 @@ Initiate a new DateRangePicker
 | options | [<code>Options</code>](#Options) | Object to configure the DateRangePicker |
 | callback | [<code>callback</code>](#callback) | Callback function executed when date is changed.<br> Callback function is executed if selected date values has changed, before picker is hidden and before the attached `<input>` element is updated.  As alternative listen to the ["apply.daterangepicker"](#event_apply.daterangepicker) event |
 
-<a name="event_violated.daterangepicker"></a>
+<a name="event_violate.daterangepicker"></a>
 
-## "violated.daterangepicker" (this, picker, result, newDate) ⇒ <code>boolean</code>
+## "violate.daterangepicker" (picker, result, newDate) ⇒ <code>boolean</code>
 Emitted when the date is changed through `<input>` element or via [setStartDate](#DateRangePicker+setStartDate) or 
 [setRange](#DateRangePicker+setRange) and date is not valid due to 
 `minDate`, `maxDate`, `minSpan`, `maxSpan`, `invalidDate` and `invalidTime` constraints.<br>
@@ -345,7 +359,6 @@ Event is only triggered when date string is valid and date value is changing<br>
 
 | Param | Type | Description |
 | --- | --- | --- |
-| this | <code>Object</code> | The event object |
 | picker | [<code>DateRangePicker</code>](#DateRangePicker) | The daterangepicker object |
 | result | [<code>InputViolation</code>](#InputViolation) | The violation object, see example of `validateInput()` |
 | newDate | <code>Object</code> | Object of {startDate, endDate} |
@@ -361,7 +374,7 @@ $('#picker').daterangepicker({
   locale: {
      format: DateTime.DATETIME_SHORT
   }
-}).on('violated.daterangepicker', (ev, picker, result, newDate) => {
+}).on('violate.daterangepicker', (ev, picker, result, newDate) => {
   newDate.startDate = DateTime.now().minus({ days: 3 }).startOf('day');
   return true;
 });
@@ -376,8 +389,7 @@ const drp = $('#picker').data('daterangepicker').setStartDate(DateTime.now().min
 <a name="event_beforeRenderCalendar.daterangepicker"></a>
 
 ## "beforeRenderCalendar.daterangepicker" (this)
-Emitted before the calendar is rendered. 
-Useful to remove any manually added elements.
+Emitted before the calendar time picker is rendered.
 
 **Kind**: event emitted  
 
@@ -385,11 +397,10 @@ Useful to remove any manually added elements.
 | --- | --- | --- |
 | this | [<code>DateRangePicker</code>](#DateRangePicker) | The daterangepicker object |
 
-<a name="event_beforeRenderTimePicker.daterangepicker"></a>
+<a name="event_beforeRenderCalendar.daterangepicker"></a>
 
-## "beforeRenderTimePicker.daterangepicker" (this)
-Emitted before the TimePicker is rendered.
-Useful to remove any manually added elements.
+## "beforeRenderCalendar.daterangepicker" (this)
+Emitted before the calendar is rendered. Useful to remove any manually added elements.
 
 **Kind**: event emitted  
 
@@ -446,8 +457,7 @@ Only useful when [Ranges](#Ranges) are used.
 <a name="event_hideCalendar.daterangepicker"></a>
 
 ## "hideCalendar.daterangepicker" (this)
-Emitted when the calendar(s) are hidden.
-Only useful when [Ranges](#Ranges) are used.
+Emitted when the calendar(s) are hidden. Only used when [Ranges](#Ranges) are used.
 
 **Kind**: event emitted  
 
@@ -458,8 +468,7 @@ Only useful when [Ranges](#Ranges) are used.
 <a name="event_outsideClick.daterangepicker"></a>
 
 ## "outsideClick.daterangepicker" (this)
-Emitted when user clicks outside the picker. 
-Use option `onOutsideClick` to define the default action, then you may not need to handle this event.
+Emitted when user clicks outside the picker. Use option `onOutsideClick` to define the default action, then you may not need to handle this event.
 
 **Kind**: event emitted  
 
@@ -470,8 +479,7 @@ Use option `onOutsideClick` to define the default action, then you may not need
 <a name="event_dateChange.daterangepicker"></a>
 
 ## "dateChange.daterangepicker" (this, side)
-Emitted when the date changed. Does not trigger when time is changed, 
-use ["timeChange.daterangepicker"](#event_timeChange.daterangepicker) to handle it
+Emitted when the date changed. Does not trigger when time is changed, use ["timeChange.daterangepicker"](#event_timeChange.daterangepicker) to handle it
 
 **Kind**: event emitted  
 
@@ -514,9 +522,9 @@ Emitted when the `Cancel` button is clicked
 | --- | --- | --- |
 | this | [<code>DateRangePicker</code>](#DateRangePicker) | The daterangepicker object |
 
-<a name="event_inputChanged.daterangepicker"></a>
+<a name="event_inputChange.daterangepicker"></a>
 
-## "inputChanged.daterangepicker" (this)
+## "inputChange.daterangepicker" (this)
 Emitted when the date is changed through `<input>` element. Event is only triggered when date string is valid and date value has changed
 
 **Kind**: event emitted  
@@ -525,6 +533,31 @@ Emitted when the date is changed through `<input>` element. Event is only trigge
 | --- | --- | --- |
 | this | [<code>DateRangePicker</code>](#DateRangePicker) | The daterangepicker object |
 
+<a name="event_monthViewChange.daterangepicker"></a>
+
+## "monthViewChange.daterangepicker" (this, left, right)
+Emitted after month view changed, for example by click on 'prev' or 'next'
+
+**Kind**: event emitted  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| this | [<code>DateRangePicker</code>](#DateRangePicker) | The daterangepicker object |
+| left | [<code>DateTime</code>](https://moment.github.io/luxon/api-docs/index.html#datetime) | For day of left-hand calendar |
+| right | [<code>DateTime</code>](https://moment.github.io/luxon/api-docs/index.html#datetime) \| <code>null</code> | For day of right-hand calendar |
+
+<a name="event_beforeRenderTimePicker.daterangepicker"></a>
+
+## "beforeRenderTimePicker.daterangepicker" (this)
+Emitted before the TimePicker is rendered.
+Useful to remove any manually added elements.
+
+**Kind**: event emitted  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| this | [<code>DateRangePicker</code>](#DateRangePicker) | The daterangepicker object |
+
 <a name="Options"></a>
 
 ## Options

package/README.md

@@ -20,8 +20,8 @@ Above samples are based on the [original repository](https://github.com/dangross
 ```html
 <script type="text/javascript" src="https://cdn.jsdelivr.net/jquery/latest/jquery.min.js"></script>
 <script type="text/javascript" src="https://cdn.jsdelivr.net/npm/luxon@3.5.0/build/global/luxon.min.js"></script>
-<script type="text/javascript" src="https://cdn.jsdelivr.net/npm/@wernfried/daterangepicker@4.17.5/dist/global/daterangepicker.min.js"></script>
-<link type="text/css" href="https://cdn.jsdelivr.net/npm/@wernfried/daterangepicker@4.17.5/css/daterangepicker.min.css" rel="stylesheet" />
+<script type="text/javascript" src="https://cdn.jsdelivr.net/npm/@wernfried/daterangepicker@4.19.0/dist/global/daterangepicker.min.js"></script>
+<link type="text/css" href="https://cdn.jsdelivr.net/npm/@wernfried/daterangepicker@4.19.0/css/daterangepicker.min.css" rel="stylesheet" />
 
 <input type="text" id="picker" />
 
@@ -43,11 +43,11 @@ Above samples are based on the [original repository](https://github.com/dangross
    "imports": {
       "jquery": "https://cdn.jsdelivr.net/npm/jquery@4.0.0/+esm",
       "luxon": "https://cdn.jsdelivr.net/npm/luxon@3.7.2/+esm",
-      "daterangepicker": "https://cdn.jsdelivr.net/npm/@wernfried/daterangepicker@4.17.5/+esm"
+      "daterangepicker": "https://cdn.jsdelivr.net/npm/@wernfried/daterangepicker@4.19.0/+esm"
    }
 }
 </script>
-<link type="text/css" href="https://cdn.jsdelivr.net/npm/@wernfried/daterangepicker@4.17.5/css/daterangepicker.min.css" rel="stylesheet" />
+<link type="text/css" href="https://cdn.jsdelivr.net/npm/@wernfried/daterangepicker@4.19.0/css/daterangepicker.min.css" rel="stylesheet" />
 
 <input type="text" id="picker" />
 
@@ -68,7 +68,7 @@ Above samples are based on the [original repository](https://github.com/dangross
 ```html
 <script ...></script>
 <link type="text/css" href="https://cdn.jsdelivr.net/npm/bulma@1.0.4/css/bulma.min.css" rel="stylesheet" />
-<link type="text/css" href="https://cdn.jsdelivr.net/npm/@wernfried/daterangepicker@4.17.5/css/daterangepicker.bulma.min.css" rel="stylesheet" />
+<link type="text/css" href="https://cdn.jsdelivr.net/npm/@wernfried/daterangepicker@4.19.0/css/daterangepicker.bulma.min.css" rel="stylesheet" />
 
 <input type="text" id="picker" />
 
@@ -222,41 +222,7 @@ You can style this daterangepicker with [Bulma CSS Framework](https://bulma.io/)
 
 ## Methods
 
-Available methods are listed below in [API documentation](#DateRangePicker). You will mainly use 
-   * [.daterangepicker(options, callback)](#DateRangePicker.daterangepicker)
-   * [.setStartDate(startDate)](#DateRangePicker+setStartDate)
-   * [.setRange(startDate, endDate)](#DateRangePicker+setRange)
-   * `$(...).data('daterangepicker')` to get the daterangepicker object
-
-all other methods are used rarely.
-
-### Differences between `moment` and `luxon` library
-This table lists a few important differences between datarangepicker using moment and luxon. Check them carefully when you migrate from older daterangepicker.
-
-| Parameter               | moment                                              | luxon             |
-| ----------------------- | --------------------------------------------------- | ----------------- |
-| `locale.daysOfWeek`     | [ "Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat" ] | [ "Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "Sun" ] | 
-| `locale.firstDay`       | 0-6 (Sunday to Saturday)                            | 1 for Monday through 7 for Sunday | 
-| to ISO-8601 String      | `toISOString()`                                     | `toISO()`         | 
-| to [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) Object | `toDate()` | `toJSDate()`         | 
-| from ISO-8601 String    | `moment(...)`                                       | `DateIme.fromISO(...)`         | 
-| from [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) Object | `moment(...)` | `DateIme.fromJSDate(...)`         | 
-| current day             | `moment()`                                          | `DateTime.now()`  |
-| format to string        | `format(...)`                                       | `toFormat(...)`   |
-| format tokens           | `'YYYY-MM-DD'`                                      | `'yyyy-MM-dd'`    |
-
-
-## License
-
-The MIT License (MIT)
-
-Copyright (c) 2012-2019 Dan Grossman<br/>
-Copyright (c) 2025 Wernfried Domscheit
-
-Licensed under the [MIT license](LICENSE).
-
-## API Documentation
-[API Documentation](API_Doc.md)
+Available methods are listed in detail at [API Documentation](API_Doc.md). You will mainly use 
 ## Options
 Options for DateRangePicker