Date Range Picker

For Bootstrap

A JavaScript widget for choosing date ranges.
Designed to work with the Bootstrap CSS framework.

Date Range Picker is a JavaScript UI component originally created for Improvely to allow users to choose the date range of various reports. It can be attached to any element of a page, whether a text input or not, and provides a dropdown with two calendars to select the dates or a predefined range.



Click here to see the Date Range Picker on a real website

Usage

Date Range Picker relies on Bootstrap, jQuery and Moment.js. Include the required scripts and stylesheet in your page:

Then attach the picker to the element you want to trigger it:


You can customize Date Range Picker with options, and get notified when the user chooses new dates by providing a callback function.

Examples

Minimal Example

The Date Range Picker is attached to a text input. It will use the current value of the input to initialize, and update the input if new dates are chosen.



Date and Time Picker

The Date Range Picker can also be used to select times. Hour, minute and (optional) second dropdowns are added below the calendars. An option exists to set the increment count of the minutes dropdown to e.g. offer only 15-minute or 30-minute increments.



Limit Selectable Dates

You can limit the selectable date range to between some minimum and maximum date, and also limit the maximum distance between the chosen start and end date. This example limits the selectable dates to the month of June 2015, and allows at most one week to be selected.



Single Date Picker

The Date Range Picker can be turned into a single date picker widget with only one calendar. In this example, dropdowns to select a month and year have also been enabled at the top of the calendar to quickly jump to different months.



All Options

This example shows usage of all the available options.

01/01/2015 - 01/31/2015


Options

  • startDate (Date object, moment object or string) The start of the initially selected date range
  • endDate: (Date object, moment object or string) The end of the initially selected date range
  • minDate: (Date object, moment object or string) The earliest date a user may select
  • maxDate: (Date object, moment object or string) The latest date a user may select
  • dateLimit: (object) The maximum span between the selected start and end dates. Can have any property you can add to a moment object (i.e. days, months)
  • timeZone: (string or number) The timezone that will be used to display the startDate and endDate in the calendar. This may be a string such as "08:00" or an offset in minutes from Greenwich Mean Time. Uses Moment.js #utcOffset, see the docs here for more information. If the timeZone option is not set, the calendar will use the time zone set on the startDate that has been passed in through the options, if it has one. Defaults to the local time zone
  • showDropdowns: (boolean) Show year and month select boxes above calendars to jump to a specific month and year
  • showWeekNumbers: (boolean) Show week numbers at the start of each week on the calendars
  • timePicker: (boolean) Allow selection of dates with times, not just dates
  • timePickerIncrement: (number) Increment of the minutes selection list for times (i.e. 30 to allow only selection of times ending in 0 or 30)
  • timePicker12Hour: (boolean) Use 12-hour instead of 24-hour times, adding an AM/PM select box
  • timePickerSeconds: (boolean) Show seconds in the timePicker
  • ranges: (object) Set predefined date 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
  • opens: (string: 'left'/'right'/'center') Whether the picker appears aligned to the left, to the right, or centered under the HTML element it's attached to
  • buttonClasses: (array) CSS class names that will be added to all buttons in the picker
  • applyClass: (string) CSS class string that will be added to the apply button
  • cancelClass: (string) CSS class string that will be added to the cancel button
  • format: (string) Date/time format string used by moment when parsing or displaying the selected dates
  • separator: (string) Separator string to display between the start and end date when populating a text input the picker is attached to
  • locale: (object) Allows you to provide localized strings for buttons and labels, and the first day of week for the calendars
  • singleDatePicker: (boolean) Show only a single calendar to choose one date, instead of a range picker with two calendars; the start and end dates provided to your callback will be the same single date chosen
  • parentEl: (string) jQuery selector of the parent element that the date range picker will be added to, if not provided this will be 'body'

Methods

Several functions are provided for updating the picker's option and state after initialization. You can access the Date Range Picker object and its functions and properties through data properties of the element you attached it to.


  • setOptions(object, function): This function has the same signature and purpose as the date range picker's constructor: it sets the picker's options to their defaults, overrides them with any values in an options object you provide, and sets the callback for selection changes to whatever function you provide
  • setStartDate(Date/moment/string): Sets the date range picker's currently selected start date to the provided date
  • setEndDate(Date/moment/string): Sets the date range picker's currently selected end date to the provided date

Example usage:

Events

Several events are triggered on the element you attach the picker to, which you can listen for.

  • show.daterangepicker: Triggered when the picker is shown
  • hide.daterangepicker: Triggered when the picker is hidden
  • showCalendar.daterangepicker: Triggered when the calendar is shown
  • hideCalendar.daterangepicker: Triggered when the calendar is hidden
  • apply.daterangepicker: Triggered when the apply button is clicked
  • cancel.daterangepicker: Triggered when the cancel button is clicked

Some applications need a "clear" instead of a "cancel" functionality, which can be achieved by changing the button label and watching for the cancel event:


While passing in a callback to the constructor is the easiest way to listen for changes in the selected date range, you can also do something every time the apply button is clicked even if the selection hasn't changed:

License

The MIT License (MIT)

Copyright (c) 2012-2015 Dan Grossman

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Comments