daterangepicker-4.x 4.1.3 → 4.1.4
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/README.md +3 -3
- package/daterangepicker.js +3 -3
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -496,7 +496,7 @@ Options for DateRangePicker
|
|
|
496
496
|
| buttonClasses | <code>string</code> | <code>"btn"</code> | btn-sm - CSS class names that will be added to both the apply and cancel buttons. |
|
|
497
497
|
| opens | <code>string</code> | <code>"right"</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'` |
|
|
498
498
|
| drops | <code>string</code> | <code>"down"</code> | Whether the picker appears below or above the HTML element it's attached to.<br/> `'down' \| 'up' \| 'auto'` |
|
|
499
|
-
| ranges | <code>
|
|
499
|
+
| 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. |
|
|
500
500
|
| 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. |
|
|
501
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. |
|
|
502
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. |
|
|
@@ -504,8 +504,8 @@ Options for DateRangePicker
|
|
|
504
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). |
|
|
505
505
|
| locale.separator= | <code>string</code> | | Defaut: `' - '` - Separator for start and end time |
|
|
506
506
|
| locale.weekLabel | <code>string</code> | <code>"W"</code> | Label for week numbers |
|
|
507
|
-
| locale.daysOfWeek | <code>Array
|
|
508
|
-
| locale.monthNames | <code>Array
|
|
507
|
+
| locale.daysOfWeek | <code>Array</code> | | Default: `Info.weekdays('short')`<br/>Array with weekday names, from Monday to Sunday |
|
|
508
|
+
| locale.monthNames | <code>Array</code> | | Default: `Info.months('long')`<br/>Array with month names |
|
|
509
509
|
| locale.firstDay | <code>number</code> | | Default: `Info.getStartOfWeek()`<br/>First day of the week, 1 for Monday through 7 for Sunday |
|
|
510
510
|
| locale.applyLabel | <code>string</code> | <code>"Apply"</code> | Label of `Apply` Button |
|
|
511
511
|
| locale.cancelLabel | <code>string</code> | <code>"Cancel"</code> | Label of `Cancel` Button |
|
package/daterangepicker.js
CHANGED
|
@@ -113,7 +113,7 @@
|
|
|
113
113
|
* @property {string} drops=down - Whether the picker appears below or above the HTML element it's attached to.<br/>
|
|
114
114
|
* `'down' \| 'up' \| 'auto'`
|
|
115
115
|
|
|
116
|
-
* @property {
|
|
116
|
+
* @property {object} ranges={} - Set predefined date {@link #Ranges|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
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>
|
|
@@ -131,8 +131,8 @@
|
|
|
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
|
|
135
|
-
* @property {Array
|
|
134
|
+
* @property {Array} locale.daysOfWeek - Default: `Info.weekdays('short')`<br/>Array with weekday names, from Monday to Sunday
|
|
135
|
+
* @property {Array} locale.monthNames - Default: `Info.months('long')`<br/>Array with month names
|
|
136
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
|