/angular-2-daterangepicker

Primary LanguageJavaScriptMIT LicenseMIT

angular-2-daterangepicker

Warning

⚠️ If you are on angular v6 or later. Please consider using angular-datetimerangepicker package

About this package

Daterangepicker for Angular vX.X. Although the name of package is angular 2 it is compatible with angular v4 and v5

It is a fully responsive daterangepicker with or without bootstrap.css. See responsive section below for more details.

This module is strictly intended to work on browsers only and not in node/browserless environments

This is a work in progress and you are always welcome to help me going forward with this project.

Announcements

  • Date: 12 Aug 2018
    • Added option alwaysOpen to keep the flyout open always 1.1.47
  • Date: 19 May 2018
    • Added option timepicker to enable/disable timepicker in version 1.1.38
    • Added option disableBeforeStart to enable/disable dates in right calendar that are before selected from date in version 1.1.39
  • Date: 5 May 2018
    • Added option disabled to enable/disable input box in version 1.1.35
  • Date: 29 Apr 2018
    • Added option position to open flyout on left right or center in version 1.1.30
  • Date: 28 Apr 2018
    • Fixing a small CSS issue in version 1.1.28
  • Date: 31 Mar 2018
    • New option for singleCalendar added in version 1.1.27
  • Date: 25 Mar 2018
    • Made some changes in CSS and responsiveness in version v1.1.26
  • Date: 23 Mar 2018
    • New option for DisplayFormat added in version v1.1.25
  • Date: 20 Jan 2018
    • Module less than version v1.0.10 is no longer supported

Getting Started

Install

$ npm install angular-2-daterangepicker

or

$ bower install angular-2-daterangepicker

Demo

see Demo or Plunker to how to consume this module or You can play around with the code on stackblitz here

Usage

How to make it work for you

Import DaterangepickerModule into your module as following

import { NgModule } from '@angular/core';
import { AppComponent } from './app.component';
import { BrowserModule } from '@angular/platform-browser';
import { DaterangepickerModule } from 'angular-2-daterangepicker';
@NgModule({
	imports: [BrowserModule, DaterangepickerModule],
	declarations: [ AppComponent ],
	bootstrap: [AppComponent]
})
export class AppModule {
	
}

Options

Currently, very minimum number of options are available but I will keep on developing and adding more and more options

Option Name Type Purpose Default Value Possible Values
format string format that this daterangepicker will use to communicate with your code "YYYY-MM-DD" As per momentjs standard formats
displayFormat string format that will be displayed to end user Same as format As per momentjs standard formats
startDate string Default start date when this components is rendered for first time. Format of this date should be in line with format option's value above Current Systetm Date date string in line with format option's value above
endDate string Default end date when this components is rendered for first time. Format of this date should be in line with format option's value above Current Systetm Date date string in line with format option's value above
minDate string Default minimum date not including this date. End user will not be able select all dates before this date. Format of this date should be in line with format option's value above null date string in line with format option's value above
maxDate string Default maximum date not including this date. End user will not be able select all dates after this date. Format of this date should be in line with format option's value above null date string in line with format option's value above
inactiveBeforeStart boolean Blurs all dates before selected start date. So end user can not select toDate to be before fromDate. false true,false
autoApply boolean Removes apply and cancel buttons and applies as soon as user selects end date false true,false
showRanges boolean Predefined ranges to show to end user. So end user has ready options instead of navingating through calendars. false true,false
preDefinedRanges Array of object shown as below. Custom ranges if you want to define your own ranges. This is useful only if showRanges option is set to true. see below for more details see below for more details
noDefaultRangeSelected boolean This option set the startDate and endDate options to blank on first render.This date range picker sets startDate and endDate to be current system date by dafault if no value is passed to startDate and endDate. false true,false
singleCalendar boolean Use only one calendar. So you do not need another datepicker for single month. false true,false
position string position of the flyout which will open. By default it opens on left edge of input box 'left' 'left','right','center'
disabled boolean Whether to disable the main input control false true,false
timePicker object Whether to show timepicker null Object explained as below
disableBeforeStart boolean Whether to disable dates that ar before selected start date in right calendar. This option applies to right calendar only false true,false
alwaysOpen boolean Whether to keep the calendars always open. This option removes the main input box where range is shown false true,false

Custom Range

For custom range, Pass options as below. For this you need to pass momentjs objects.

        preDefinedRanges: [{
            name: 'Day After tomorrow',
                value: {
                    start: moment().add(2, 'days'),
                    end: moment().add(2, 'days'),
                }
		    },{
            name: 'This week',
            value: {
                start: moment(),
                end: moment().add(7, 'days'),
            }
        }]

All dates are supposed to be string and in format as you are passing. You can also

import { Options } from 'angular-2-daterangepicker';

class for passing options to the component.

Time Picker

Timepicker options expects an object containing following keys as timepicker options

Option Name Type Purpose Default Value Possible Values
minuteInterval (integer)number The interval by which minutes will increase/decrease when user changes minutes in timepicker 1 anything between 1 to 59. If you supply value greater or equal 60 then that value mod 60 is taken as actual value

Events

Subscribe to rangeSelected event as

<date-range-picker [class]="'col-md-12 form-control'" [options]="daterangepickerOptions" (rangeSelected)="rangeSelected($event)"></date-range-picker>

the event listener will receive a javascript object conaining

{
	start: 'moment object representing start date selected by user'
	end: 'moment object representing end date selected by user'
}

and if you have set singleCalendar to true then the event listener will receive following

{
	start: 'moment object representing date selected by user'
}

How pass options to the component

The input box automatically takes class of the date-range-picker tag

import { Component } from '@angular/core';

@Component({
	selector: "my-datepicker-demo",
	template: `
		<date-range-picker class="col-md-4" [options]="daterangepickerOptions" class="col-md-4">
		</date-range-picker>
	`
})
export class AppComponent{
	daterangepickerOptions = {
		startDate: '09/01/2017',
		endDate: '09/02/2017',
		format: 'DD/MM/YYYY'
	}
}

Dependencies

moment.js version greater than 2.17.1
moment-range.js version 2.2.0
also you should have installed @types/node or see here for more information. I suggest installing all the dependencies before this module

Responsive CSS

If you are using bootstrap.css then just include the following styling in your code if you do not want to include whole bootstrap.css then include this css in your code.

<style>
        .daterangepicker-wrapper{
            position: relative;
            border: none;
        }

        .daterangepicker {
            font-family: "Helvetica Neue", Helvetica, Arial, sans-serif !important;
            font-size: 14px;
            position: absolute;
            top: 44px;
            background: #fff;
        }

        .daterangepicker.always-open{
            top: 0;
            box-shadow: none;
        }

        .daterangepicker.open-right{
            right: 0;
        }

        .daterangepicker.open-left{
            left: 0;
        }

        .daterangepicker.open-center{
            right: -50%;
        }

        .daterangepicker.tooltip-chevron:before{
            content: '';
            height: 0px;
            width: 0px;
            border: 10px solid transparent;
            position: absolute;
            border-bottom-color: #aaa; 
            top: -20px;
        }

         .daterangepicker.tooltip-chevron:after{
            content: '';
            height: 0px;
            width: 0px;
            border: 9px solid transparent;
            position: absolute;
            border-bottom-color: #fff;
            top: -18px;
        }
        
        .daterangepicker.open-left.tooltip-chevron:before{
            left: 10px;
        }

        .daterangepicker.open-left.tooltip-chevron:after{
            left: 11px;
        }

        .daterangepicker.open-right.tooltip-chevron:before{
            right: 10px;
        }

        .daterangepicker.open-right.tooltip-chevron:after{
            right: 11px;
        }

         .daterangepicker.open-center.tooltip-chevron:before{
            left: 50%
        }

        .daterangepicker.open-center.tooltip-chevron:after{
            left: 50%;
        }

        @media (min-width: 550px) {
            .daterangepicker {
                width: 550px;
            }
        }

        @media (max-width: 550px) {
            .daterangepicker {
                width: 270px;
            }
            .text-center .pull-right {
                float: none !important;
            }
            .col-md-6 {
                width: 100% !important;
            }
            .col-md-10 {
                width: 100% !important;
            }
            .ranges > div {
                display: none;
            }
        }

        .singledatepicker {
            width: 225px;
        }

        .daterangepicker {
            z-index: 3000;
            border-radius: 4px;
            box-shadow: 0px 2px 2px 2px #ddd;
            border: 1px solid #aaa;
            padding: 10px;
        }

        .daterangepicker div[class*="col-md-"],
        .daterangepicker span[class*="col-md-"] {
            padding: 0 15px 0 5px;
        }

        .hidden {
            display: none !important;
            visibility: false !important;
        }

        .daterangepicker .calendar {
            margin: 4px;
            float: left;
            border-radius: 4px !important;
            padding: 0 5px 0 5px;
        }

        .applyBtn {
            margin: 4px;
        }

        .daterangepicker .flush {
            padding: 0 !important;
            margin: 0 !important;
        }

        .daterangepicker .flussh {
            padding: 0 !important;
        }

        .daterangepicker .flush-bottom {
            padding-bottom: 0 !important;
        }

        .daterangepicker .flush-left {
            padding-left: 0 !important;
        }

        .daterangepicker .flush-right {
            padding-right: 0 !important;
        }

        .daterangepicker .nudge-half--left {
            padding-left: 4px !important;
        }

        .daterangepicker .nudge-half--right {
            padding-right: 4px !important;
        }

        .daterangepicker .nudge-top {
            top: 5px;
        }

        .daterangepicker .push-bottom {
            margin-bottom: 10px;
        }

        .daterangepicker th {
            margin: 1px !important;
            padding: 1px !important;
            text-align: center;
            border-radius: 4px !important;
        }

        .daterangepicker td {
            font-size: 14px;
            height: 20px;
            width: 20px;
            text-align: center;
            margin: 1px !important;
            padding: 3px !important;
            border-radius: 4px !important;
            white-space: nowrap;
            text-align: center;
        }

        .daterangepicker .btn.btn-flat {
            border: none;
            background: transparent;
            margin: 3px !important;
            padding: 1px !important;
        }

        .daterangepicker .off {
            color: #666;
        }

        .daterangepicker table {
            border-spacing: 0;
            border-collapse: collapse;
        }

        .daterangepicker td,
        .daterangepicker th {
            padding: 0;
        }

        .daterangepicker .clickable {
            cursor: pointer;
        }

        .daterangepicker .clickable-link {
            color: #337ab7;
        }

        .daterangepicker .clickable.disabled {
            pointer-events: none;
            color: #AAA;
            opacity: 0.5;
            cursor: not-allowed;
        }

        .ranges{
            padding: 5px 0;
        }

        .ranges .clickable {
            margin-top: 8px !important;
        }

        .daterangepicker label {
            display: inline-block;
            max-width: 100%;
            margin-bottom: 5px;
            font-weight: bold;
        }

        .daterangepicker .form-control{
            margin: 5px;
        }

        .daterangepicker .btn-link {
            padding: 1px 6px 1px 6px !important;
        }

        .daterangepicker .bootstrap-flush{
            margin: 0 !important;
            padding: 0 !important;
        }

        .daterangepicker .time-picker span{
            padding-left: 4px;
            padding-right: 4px;
        }

        .daterangepicker .time-picker .time-breadcrumb{
            position: relative;
            top: 22px;
            font-weight: bolder;
            font-size: 0.8em;
        }

        .daterangepicker .col-md-1,
        .daterangepicker .col-md-2,
        .daterangepicker .col-md-3,
        .daterangepicker .col-md-4,
        .daterangepicker .col-md-5,
        .daterangepicker .col-md-6,
        .daterangepicker .col-md-7,
        .daterangepicker .col-md-8,
        .daterangepicker .col-md-9,
        .daterangepicker .col-md-10,
        .daterangepicker .col-md-11,
        .daterangepicker .col-md-12 {
            position: relative;
            float: left;
        }

        .daterangepicker .col-md-12 {
            width: 100%;
        }

        .daterangepicker .col-md-11 {
            width: 91.66666667%;
        }

        .daterangepicker .col-md-10 {
            width: 83.33333333%;
        }

        .daterangepicker .col-md-9 {
            width: 75%;
        }

        .daterangepicker .col-md-8 {
            width: 66.66666667%;
        }

        .daterangepicker .col-md-7 {
            width: 58.33333333%;
        }

        .daterangepicker .col-md-6 {
            width: 50%;
        }

        .daterangepicker .col-md-5 {
            width: 41.66666667%;
        }

        .daterangepicker .col-md-4 {
            width: 33.33333333%;
        }

        .daterangepicker .col-md-3 {
            width: 25%;
        }

        .daterangepicker .col-md-2 {
            width: 16.66666667%;
        }

        .daterangepicker .col-md-1 {
            width: 8.33333333%;
        }

        .daterangepicker .col-md-offset-4 {
            margin-left: 33.333333333%;
        }
    </style>

Issues/Problems

Please let me know if you are facing any issues here

Want to contribute. You are welcome!!! :)

  1. Fork this repo
  2. npm install
  3. Copy all files from this gist to your local folder. And do not add them to git index otherwise they will appear in your pull requests.
  4. run "npm install -g typescript typescript-formatter lite-server concurrently rimraf"
  5. run "npm start"
  6. open browser at http://localhost:3000/
  7. You are all set.
  8. Add features. Fix issues. Open Pull requests.
  9. Remember not to include files from gist in your pull requests