lightpick

Lightpick

Javascript date range picker - lightweight, no jQuery

Demo & Docs

---

Dependencies

• moment.js

Installation

---

npm install lightpick

or you can download and include Moment.js and Lightpick files manually.

Usage

---

Lightpick can be bound to an input field:

<input type="text" id="datepicker"/>

Include Lightpick script to the end of your document:

<link rel="stylesheet" type="text/css" href="css/lightpick.css">  
...  
<script src="https://cdnjs.cloudflare.com/ajax/libs/moment.js/2.22.2/moment.min.js"></script>
<script src="lightpick.js"></script>  
<script>  
var picker = new Lightpick({ field: document.getElementById('datepicker') });  
</script>

Configuration

---

field

• Type: Element
• Default: null

Bind the datepicker to a form field

secondField

• Type: Element
• Default: null

If exists then end of date range will set here.

firstDay

• Type: Number
• Default: 1

ISO day of the week (1: Monday, ..., 7: Sunday).

parentEl

• Type: String | Element
• Default: body

Selector of the parent element that the date range picker will be added to, if not provided this will be 'body'.

lang

• Type: String
• Default: auto

Language code for names of days, months by Date.prototype.toLocaleString(). 'auto' will try detect user browser language.

format

• Type: String
• Default: DD/MM/YYYY

The default output format.

separator

• Type: String
• Default: -

Separator between dates when one field.

numberOfMonths

• Type: Number
• Default: 1

Number of visible months.

numberOfColumns

• Type: Number
• Default: 2

Number of columns months.

singleDate

• Type: Boolean
• Default: true

Choose a single date instead of a date range.

autoclose

• Type: Boolean
• Default: true

Close calendar when picked date/range.

hideOnBodyClick

• Type: Boolean
• Default: true

Close calendar when clicked outside the elements specified in field or parentEl. Recommended use when autoclose is set to false.

repick

• Type: Boolean
• Default: false

Repick start/end instead of new range. This option working only when exists secondField.

minDate

• Type: moment|String|Number|Date
• Default: null

The minimum/earliest date that can be selected. Any format: moment() or '2018-06-01' or 1527811200000, new Date()

maxDate

• Type: moment|String|Number|Date
• Default: null

The maximum/latest date that can be selected. Any format: moment() or '2018-06-01' or 1527811200000, new Date()

disableDates

• Type: Array
• Default: null

Array of disabled dates. Array can contains ranges, allowed the same format as in options minDate, maxDate. Eg.: \[moment().startOf('month'), \['2018-06-23', '2018-06-30'\]\]

selectForward

• Type: Boolean
• Default: false

Select second date after the first selected date.

selectBackward

• Type: Boolean
• Default: false

Select second date before the first selected date.

minDays

• Type: Number
• Default: null

The minimum days of the selected range.

maxDays

• Type: Number
• Default: null

The maximum days of the selected range.

hoveringTooltip

• Type: Boolean
• Default: true

Show tooltip.

footer

• Type: Boolean|String
• Default: false

Footer calendar, if set to true will use default footer (Reset/Apply buttons) or custom string (html).

disabledDatesInRange

• Type: Boolean
• Default: true

If set to false then will reset selected range when disabled dates exists in selected range.

tooltipNights

• Type: Boolean
• Default: false

Calc date range in nights. (For hotels when last date doesn't include to range)

orientation

• Type: String
• Default: auto

A space-separated string consisting of one or two of “left” or “right”, “top” or “bottom”, and “auto” (may be omitted); for example, “top left”, “bottom” (horizontal orientation will default to “auto”), “right” (vertical orientation will default to “auto”), “auto top”.

disableWeekends

• Type: Boolean
• Default: false

Disable Saturday and Sunday.

inline

• Type: Boolean
• Default: false

Show calendar inline. If true and parentEl is not provided then will use parentNode of field.

weekdayStyle

• Type: String
• Default: short

Determines the weekday display style. Possible values are: long (e.g., Thursday), short (e.g., Thu), narrow (e.g., T). Two weekdays may have the same narrow style for some locales (e.g. Tuesday's narrow style is also T).

dropdowns

• Type: Object|Boolean
• Default:

{ 
    years: { 
        min: 1900, 
        max: null, 
    }, 
    months: true, 
}

Dropdown selections for years, months. Can be false for disable both dropdowns.
years (Object|Boolean) - Object must contains min and max range of years or can be false for disable dropdown of years.
months (Boolean) - true/false for enable/disable dropdown of months.

locale

• Type: Object
• Default:

{ 
    buttons: { 
        prev: '←', 
        next: '→', 
        close: '×', 
        reset: 'Reset', 
        apply: 'Apply'
    }, 
    tooltip: { 
        one: 'day',  
        other: 'days'
    },
    tooltipOnDisabled: null,
    pluralize: function(i, locale){
        if (typeof i === "string") i = parseInt(i, 10);
        
        if (i === 1 && 'one' in locale) return locale.one;
        if ('other' in locale) return locale.other;
        
        return '';
    }
}

buttons - Text for buttons
tooltip - Text for tooltip (one, few, many, other)
tooltipOnDisabled (String) - Show tooltip text on disabled dates. (Eg. «Already booked»)
pluralize (function) - Function for calc plural text. More examples for another locales on betsol/numerous

onSelect

• Type: Function
• Default: null

Callback function for when a date is selected.

onSelectStart

• Type: Function
• Default: null

Callback function for when a start date is selected (only when singleDate=false).

onSelectEnd

• Type: Function
• Default: null

Callback function for when a end date is selected (only when singleDate=false).

onOpen

• Type: Function
• Default: null

Callback function for when the picker becomes visible.

onClose

• Type: Function
• Default: null

Callback function for when the picker is hidden.

onError

• Type: Function
• Default: null

Working when disabledDatesInRange: false Callback function for when user has select date range with disabled dates.

onMonthsChange

• Type: Function
• Default: null

Callback function for when the months select is changed.

onYearsChange

• Type: Function
• Default: null

Callback function for when the years select is changed.

Methods

---

picker.setDate(date)

Set date when singleDate is true. date can be moment, string, number, date.
Eg. picker.setDate(new Date());

picker.setDateRange(start, end)

Set date range. start, end can be moment, string, number, date. Eg. picker.setDateRange(new Date(), moment().add(7, 'day'));

picker.setDisableDates(array)

array of disabled dates. Array can contains ranges, allowed moment, string, number, date. Eg. picker.setDisableDates([ moment().startOf('month'), ['2018-06-23', '2018-06-30'] ]);

picker.getDate()

Return current date as moment object.

picker.getStartDate()

Return current start of date range as moment object.

picker.getEndDate()

Return current start of date range as moment object.

picker.toString('YYYY-MM-DD')

Returns the date in a string format.

picker.reloadOptions({})

Update picker options.

picker.show()

Make the picker visible.

picker.hide()

Hide the picker.

picker.destroy()

Hide the picker and remove all event listeners.