Skip to content

Latest commit

 

History

History
260 lines (200 loc) · 8.17 KB

README.md

File metadata and controls

260 lines (200 loc) · 8.17 KB
Raw

ng2-daterangepicker

This is an Angular 2, 4, 5+ port of the popular Date Range Picker for Bootstrap http://www.daterangepicker.com/

Tested and working in Angular 5. In case of problems please submit an issue

Demos and Sample Usage

For Demos and sample usage of this package see the following code on Plunker

https://embed.plnkr.co/94HAl4q2ITLnahjhYOY0/

Installation

npm install ng2-daterangepicker --save

peerDependencies

Please note and install the following peerDependencies if necessary for your setup

"peerDependencies": {
"@types/jquery": "^3.2.12",
"jquery": "^3.2.1",
"moment": "^2.19.1"
}

Usage

Add Bootstrap to your project's index.html or include in your workflow

<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css" integrity="sha384-BVYiiSIFeK1dGmJRAkycuHAHRg32OmUcww7on3RYdg4Va+PmSTsz/K68vbdEjh4u" crossorigin="anonymous">

NB: You might want to override icon classes with your own custom icons if you are using Bootstrap 4 without glyphs and without fontawesome. Button icon classes used are below

fa fa-calendar glyphicon glyphicon-calendar
fa fa-chevron-left glyphicon glyphicon-chevron-left
fa fa-chevron-right glyphicon glyphicon-chevron-right

SystemJS Mapping

If you are using a SystemJS setup then map ng2-daterangepicker and it's dependencies in your system.config.js file

paths: {
    // paths serve as alias
    'npm:': 'node_modules/'
},
map: {
    // angular bundles

    // add ng2-daterangepicker bundles
    'ng2-daterangepicker': 'npm:ng2-daterangepicker',
    'jquery': 'npm:jquery/dist/jquery.js',
    'moment': 'npm:moment',
    'bootstrap-daterangepicker': 'npm:bootstrap-daterangepicker/daterangepicker.js'
},
packages: {
    // other packages already defined

    // ng2-daterangepicker packages
    moment: {
        main: 'moment',
        defaultExtension: 'js'
    },
    'ng2-daterangepicker': {
        main: 'index',
        defaultExtension: 'js'
     }
}

import Daterangepicker Module

import the Daterangepicker module in your application module

import { Daterangepicker } from 'ng2-daterangepicker';

@NgModule({
    imports: [Daterangepicker]
})

Use the daterangepicker directive in your component by passing in options {} and consuming the selected event. Directive can be added to inputs, buttons or any other html element

@Component({
    selector: 'my-app',
    template: `<input type="text" name="daterangeInput" daterangepicker [options]="options" (selected)="selectedDate($event, daterange)" />`,
})
export class AppComponent {

    public daterange: any = {};

    // see original project for full list of options
    // can also be setup using the config service to apply to multiple pickers
    public options: any = {
        locale: { format: 'YYYY-MM-DD' },
        alwaysShowCalendars: false,
    };

    public selectedDate(value: any, datepicker?: any) {
        // this is the date the iser selected
        console.log(value);

        // any object can be passed to the selected event and it will be passed back here
        datepicker.start = value.start;
        datepicker.end = value.end;

        // or manupulat your own internal property
        this.daterange.start = value.start;
        this.daterange.end = value.end;
        this.daterange.label = value.label;
    }
}

You can pass global settings that can be overloaded by the options object in the daterangepicker instances. Use the DaterangepickerConfig service to do so. The service provider is set in the daterangepicker module.

import { DaterangepickerConfig } from 'ng2-daterangepicker';

@Component({
    selector:'my-app',
    template:'<h3>Component Template</h3>'
})
export class AppComponent {

    constructor(private daterangepickerOptions: DaterangepickerConfig) {
        this.daterangepickerOptions.settings = {
            locale: { format: 'YYYY-MM-DD' },
            alwaysShowCalendars: false
        };
    }
}

Customizing the CSS

Skip Adding CSS in Head - You can bundle the css that styles the calendar in your app by copying or importing the contents of node_modules/ng2-daterangepicker/daterangepicker.component.css and customizing as you like. When you do so set the skipCSS property of the config service to true in order for the module to skip adding the css styles in the head.

NB: Skipping should be done early in your component where the service is used first and before your component has rendered.

NB: Note that the picker dropdown might be added in the body element outside of your component so the css must not be encapsulated by the component. The styles should be added to your global styles.

import { DaterangepickerConfig } from 'ng2-daterangepicker';

@Component({
    selector:'my-app',
    template:'<h3>Component Template</h3>'
})
export class AppComponent {

    constructor(private daterangepickerOptions: DaterangepickerConfig) {
        this.daterangepickerOptions.skipCSS = true;
    }
}

Daterangepicker methods

You can programmatically update the startDate and endDate in the picker using the setStartDate and setEndDate methods. You can access the Date Range Picker object and its functions and properties through the datePicker property of the directive using @ViewChild.

import { Component, AfterViewInit, ViewChild  } from '@angular/core';
import { DaterangePickerComponent } from 'ng2-daterangepicker';

@Component({
    selector:'my-app',
    template:'<h3>Component Template</h3>'
})
export class AppComponent {

    @ViewChild(DaterangePickerComponent)
    private picker: DaterangePickerComponent;

    public updateDateRange() {
        this.picker.datePicker.setStartDate('2017-03-27');
        this.picker.datePicker.setEndDate('2017-04-08');
    }
}

Using Daterangepicker Events

You can bind to the events fired by the daterangepicker. All events will emit an object containing the event fired and the datepicker object.

{
    event: {},
    picker: {}
}

Available events

Below is the list of events that you can bind into.

Visit the original site for detailed options and documentation http://www.daterangepicker.com/#options

cancelDaterangepicker
applyDaterangepicker
hideCalendarDaterangepicker
showCalendarDaterangepicker
hideDaterangepicker
showDaterangepicker

Below is a sample usage. You can have multiple methods and implement only the events you want.

Create methods that will be called by the events in your component and bind to fired events in the component's template.

@Component({
    selector: 'my-app',
    template: `<input type="text" name="daterangeInput" daterangepicker [options]="options" (selected)="selectedDate($event)"
    (cancelDaterangepicker)="calendarCanceled($event)"
    (applyDaterangepicker)="calendarApplied($event)"
    />`,
})
export class AppComponent {

    public daterange: any = {};

    private selectedDate(value: any) {
        daterange.start = value.start;
        daterange.end = value.end;
    }

    // expected output is an object containing the event and the picker.
    // your method can be named whaterver you want.
    // you can add multiple params to the method and pass them in the template
    public calendarCanceled(e:any) {
        console.log(e);
        // e.event
        // e.picker
    }

    public calendarApplied(e:any) {
        console.log(e);
        // e.event
        // e.picker
    }
}

Below is the link to the original project, there's more info regarding the daterangepicker there. http://www.daterangepicker.com/

Note:

  • This component is in active development so keep checking for new releases and update to the latest version.
  • This Component depends on jQuery, Moment.js and Bootstrap to work correctly.
  • I have recently added support for SystemJS builds in a minor version with a lot of build changes but I do not expect anything to break, if you encounter errors please post an issue or do a pull request to patch it.
  • Contribution is highly encouraged.
  • This package is an Angular (2+) port. see original project http://www.daterangepicker.com