1.2.0 • Published 1 year ago
@arwinvdv/range-plugin v1.2.0
@arwinvdv/range-plugin
This package does not need to be installed if you are using @arwinvdv/bundle.
Adds the ability to select a range of dates.
Documentation
https://easepick.com/packages/range-plugin
Options
| Name | Type | Default | Description |
|---|---|---|---|
| elementEnd | HTMLElement string | null | Bind the datepicker to a element for end date. |
| startDate | Date string number | null | Preselect start date. Date Object or Unix Timestamp (with milliseconds) or String (must be equal to option format). |
| endDate | Date string number | null | Preselect end date. Date Object or Unix Timestamp (with milliseconds) or String (must be equal to option format). |
| repick | boolean | false | If date range is already selected, then user can change only one of start date or end date (depends on clicked field) instead of new date range. |
| strict | boolean | true | Disabling the option allows you to select an incomplete range. |
| delimiter | string | ' - ' | Delimiter between dates. |
| tooltip | boolean | true | Showing tooltip with how much days will be selected. |
| tooltipNumber | function | Handling the tooltip number. | |
| locale | object | { one: 'day', other: 'days' } | Text for the tooltip. Keys depends on option lang (see Intl.PluralRules). |
Methods
| Name | Description |
|---|---|
| setDateRange(start, end) | Set date range. Should be Date Object or Unix Timestamp (with milliseconds) or String (must be equal to option format). |
| setStartDate(date) | Set start of date range. Should be Date Object or Unix Timestamp (with milliseconds) or String (must be equal to option format). |
| setEndDate(date) | Set end of date range. Should be Date Object or Unix Timestamp (with milliseconds) or String (must be equal to option format). |
| getStartDate() | Return current start of date range as DateTime Object. |
| getEndDate() | Return current end of date range as DateTime Object. |
1.2.0
1 year ago