@easepick/range-plugin
TypeScript icon, indicating that this package has built-in type declarations

1.2.1 • Public • Published

@easepick/range-plugin

npm version

This package does not need to be installed if you are using @easepick/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.

Readme

Keywords

none

Package Sidebar

Install

npm i @easepick/range-plugin

Homepage

easepick.com

Weekly Downloads

13,466

Version

1.2.1

License

GPL-2.0-or-later

Unpacked Size

35.8 kB

Total Files

8

Last publish

Collaborators

  • waki