Skip to content

Latest commit

 

History

History
112 lines (91 loc) · 4.03 KB

README.md

File metadata and controls

112 lines (91 loc) · 4.03 KB
Raw

Baremetrics Date Range Picker

Baremetrics provides one-click analytics & insights for Stripe. Get started today!

The Baremetrics date range picker is a simplified solution for selecting both date ranges and single dates all from a single calender view. There aren't a billion options but the code is pretty basic and modular so feel free to edit however to meet your own needs.

Design by Chris Meeks Code by Tyler van der Hoeven

View a demo View in a live production app

Installing

Using the date picker is pretty simple, you've just got to make a couple choices and include a couple settings. Create a div with a daterange class and then either the daterange--double or daterange--single classname for targeting the specific calendar you'd like to generate.

<div class="daterange daterange--double"></div>
<div class="daterange daterange--single"></div>

Next you've just gotta create a new Calendar instance.

new Calendar({
  element: $('.daterange--single'),
  current_date: 'June 15, 2015',
  format: {input: 'M/D/YYYY'},
  required: false
});

new Calendar({
  element: $('.daterange--double'),
  earliest_date: 'January 1, 2000',
  latest_date: new Date(),
  start_date: 'May 1, 2015',
  end_date: 'May 31, 2015',
  callback: function() {
    var start = moment(this.start_date).format('ll'),
        end = moment(this.end_date).format('ll');

    console.debug('Start Date: '+ start +'\nEnd Date: '+ end);
  }
});

Base Calendar Params

  • element *required [jQuery DOM object]
    • jQuery DOM object of the calendar div you're working on
  • earliest_date [date]
    • The earliest date to show in the calendar
  • latest_date [date]
    • The latest date to show in the calendar
  • callback [function]
    • A function for whenever a new date is saved
    • Inside you have access to object variables like this.earliest_date and this.latest_date for doing things with your calendar's dates
  • format [object]
    • Object containing formatting strings for.. you guessed it.. formating your dates
      format: {
    input: 'MMMM D, YYYY', // Format for the input fields
    jump_month: 'MMMM', // Format for the month switcher
    jump_year: 'YYYY' // Format for the year switcher
  }
  • days_array [array]
    • Array of the 7 strings you'd like to represent your days in the calendar
      days_array: ['Su','Mo','Tu','We','Th','Fr','Sa']

Single Calendar Params

  • current_date [date]
    • The date to start the calendar on
  • required [boolean]
    • Toggle if this field must have always have a valid selected date
  • placeholder [string]
    • Set placeholder text

Double Calendar Params

  • start_date [date]
    • The date to start the selection on for the calendar
  • end_date [date]
    • The date to end the selection on for the calendar
  • format [object key:value]
    • The double calendar adds the preset key to the format object for formatting the preset dates in the preset dropdown
  • same_day_range [boolean]
    • Allow a range selection of a single day

Developing

I've included my signature gulpfile too so be sure and take a look at that as well.

$ cd <project directory>
$ npm install
$ gulp

I also use pow and the powder gem to run my local dev environments but however you plan on wrangling that the gulpfile turns on a livereload server so as long as you have the files serving somehow any changes you make will show up instantly.

Dependencies