angular-mydatepicker

Angular datepicker and date range picker

Description

Highly configurable Angular datepicker and date range picker. No dependencies to other libraries.

This project was generated with Angular CLI version 7.3.8. The library is tested with Angular version 7.2.0.

The datepicker source code is in the projects/angular-mydatepicker/src/lib folder.

Online demo is here

Installation

To install this component to an external project, follow the procedure:

1. npm install angular-mydatepicker --save

2. Add AngularMyDatePickerModule import to your @NgModule as follows

   import { BrowserModule } from '@angular/platform-browser';
   import { NgModule } from '@angular/core';
   import { FormsModule, ReactiveFormsModule } from '@angular/forms';
   import { AngularMyDatePickerModule } from 'angular-mydatepicker';
   
   @NgModule({
     declarations: [
       AppComponent
     ],
     imports: [
       BrowserModule, ReactiveFormsModule, FormsModule, AngularMyDatePickerModule.forRoot()
     ],
     providers: [],
     bootstrap: [AppComponent]
   })
   export class AppModule { }

Usage

Use one of the following two options.

1. ngModel binding

In this option the ngModel binding is used.

To use ngModel define the application class as follows:

import {IAngularMyDpOptions, IMyDateModel} from 'angular-mydatepicker';
// other imports are here...

export class MyTestApp {
  private myOptions: IAngularMyDpOptions = {
    dateRange: false,      // If false = date picker, if true = date range picker
    dateFormat: 'dd.mm.yyyy'
    // other options are here...
  };

  private model: IMyDateModel = null;

  constructor() { }

  // optional date changed callback
  onDateChanged(event: IMyDateModel): void {
    // date selected
  }
}

If you are using bootstrap 4 add the following snippet inside your template:

• example adds bootstrap input group buttons

<div class="input-group">
  <input class="form-control" placeholder="Select a date" angular-mydatepicker name="mydate"
         [(ngModel)]="model" [options]="myOptions" #dp="angular-mydatepicker" (dateChanged)="onDateChanged($event)"/>
  <div class="input-group-append">
    <button type="button" class="btn btn-secondary" (click)="dp.clearDate()">
      <i class="fa fa-close"></i>
    </button>
  </div>
  <div class="input-group-append">
    <button type="button" class="btn btn-secondary" (click)="dp.toggleCalendar()">
      <i class="fa fa-calendar-o"></i>
    </button>
  </div>
</div>

There are two ways to set an initial date to the model.

• Initialize with the IMyDate object:

// Initialized to specific date (05.05.2019)
model: IMyDateModel = {isRange: false, singleDate: {date: { year: 2019, month: 5, day: 5 }}};

• Initialize with the javascript date object:

// Initialized to today
model: IMyDateModel = {isRange: false, singleDate: {jsDate: new Date()}};

2. Reactive forms

In this option the value accessor of reactive forms is used. Here is an example application. It shows how to use the formControlName.

To use reactive forms define the application class as follows:

import {IAngularMyDpOptions, IMyDateModel} from 'angular-mydatepicker';
// other imports are here...

export class MyTestApp implements OnInit {

  myOptions: IAngularMyDpOptions = {
    dateRange: false,      // If false = date picker, if true = date range picker
    dateFormat: 'dd.mm.yyyy'
    // other options...
  };

  private myForm: FormGroup;

  constructor(private formBuilder: FormBuilder) { }

  ngOnInit() {
    // Initialize to today date
    let model: IMyDateModel = {isRange: false, singleDate: {jsDate: new Date()}, dateRange: null};
    this.myForm = this.formBuilder.group({
      myDate: [model, Validators.required]
      // other controls are here...
    });
  }

  setDate(): void {
    // Set today date using the patchValue function
    let model: IMyDateModel = {isRange: false, singleDate: {jsDate: new Date()}, dateRange: null};
    this.myForm.patchValue({myDate: model);
  }

  clearDate(): void {
    // Clear the date using the patchValue function
    this.myForm.patchValue({myDate: null});
  }
}

Add the following snippet inside your template:

• Input box styling is bootstrap 4.0.0

<form [formGroup]="myForm" (ngSubmit)="onSubmit()" novalidate>
    <div class="input-group">
        <input class="form-control" placeholder="Select a date" angular-mydatepicker name="myDate" 
          formControlName="myDate"[options]="myOptions" #dp="angular-mydatepicker"/>
        <div class="input-group-append">
          <button type="button" class="btn btn-secondary" (click)="dp.clearDate()">
            <i class="fa fa-close"></i>
          </button>
        </div>
        <div class="input-group-append">
          <button type="button" class="btn btn-secondary" (click)="dp.toggleCalendar()">
            <i class="fa fa-calendar-o"></i>
          </button>
        </div>
    </div>

    <div class="btnGroup">
        <button class="button" type="submit" [disabled]="myForm.controls.myDate.errors">Submit</button>
        <p class="error" *ngIf="myForm.controls.myDate.errors">Date is required!</p>
    </div>
</form>

Attributes

options attribute

Value of the options attribute is a type of IAngularMyDpOptions. It can contain the following properties.

locale attribute

An ISO 639-1 language code can be provided as shorthand for the following options (dayLabels, monthLabels, dateFormat, todayBtnTxt, firstDayOfWeek and sunHighlight). Currently supported languages: en, fr, fr-ch, ja, fi, es, hu, sv, nl, ru, uk, no, tr, pt-br, de, de-ch, it, it-ch, pl, my, sk, sl, zh-cn, he, ro, ca, id, en-au, am-et, cs, el, kk, th, ko-kr, da, lt, vi, bn, bg, hr, ar, is, tw, lv and et.

The locale options can be overridden by options attribute.

• new locale data can be added to this file. If you want to add a new locale create a pull request.

defaultMonth attribute

Visible month/year when calendar is opened:

• If date is already selected => calendar opens to the month and year of the selected date
  • In date range mode => calendar opens to the month and year of the selected begin date
• If the defaultMonth is set => calendar opens to the month and year specified in the the __defaultMonth attribute
• If none of above => calendar opens to the month and year of current date

Value of the defaultMonth attribute can be:

• IMyDefaultMonth object. The value of defMonth property can be a string which contain year number and month number separated by delimiter. The delimiter can be any special character. For example: 08-2016 or 08/2016.
• a string which contain year number and month number separated by delimiter. The delimiter can be any special character. For example: 08-2016 or 08/2016.

Functions

You can can call functions of the directive. Define local variable to input field like below:

<input angular-mydatepicker name="mydate" [(ngModel)]="model" [options]="myOptions" #dp="angular-mydatepicker"/>

The #dp="angular-mydatepicker" defines the local variable named dp. You can use it to call functions of the directive for example (click)="dp.openCalendar()".

openCalendar function

Opens the calendar. For example:

<button type="button" (click)="dp.openCalendar()">Open</button>

closeCalendar function

Closes the calendar. For example:

<button type="button" (click)="dp.closeCalendar()">Close</button>

toggleCalendar function

Closes the calendar if it is open and opens the calendar if it is closed. For example:

<button type="button" (click)="dp.toggleCalendar()">Toggle</button>

clearDate function

Clears the date from the input box and model. For example:

<button type="button" (click)="dp.clearDate()">Clear</button>

isDateValid function

Returns true if the date in the input box is valid. Otherwise it returns false. This function also calls the inputFieldChanged callback.

<input angular-mydatepicker [(ngModel)]="model" [options]="myDatePickerOptions" #dp="angular-mydatepicker"/>

@ViewChild('dp') mdpd: AngularMyDatePickerDirective;

checkDateValidity(): void {
    let valid: boolean = this.mdpd.isDateValid();
    console.log('Valid date in the input box: ', valid);
}

Callbacks

dateChanged callback

• called when a single date or date range is selected, cleared or input field typing is valid

• event parameter:

  • event.isRange: true if a date range is selected, false if a single date is selected
  • event.singleDate: event data if isRange is false, if isRange is true this property is null
    • date: IMyDate object for example: { day: 22, month: 11, year: 2019 }
    • jsDate: Javascript Date object
    • formatted: Date string in the same format as the dateFormat option is. For example '2016-11-22'
    • epoc: Epoc time stamp. For example: 1479765600
  • event.dateRange: event data if isRange is true, if isRange is false this property is null
    • beginDate: IMyDate object for example: { day: 22, month: 11, year: 2019 }
    • beginJsDate: Javascript Date object
    • beginEpoc: Epoc time stamp for example: 1479765600
    • endDate: IMyDate object for example: { day: 22, month: 11, year: 2019 }
    • endJsDate: Javascript Date object
    • endEpoc: Epoc time stamp. For example: 1479765600
    • formatted: Date range string. The date is in the same format as the dateFormat option is. For example '2019-11-22 - 2019-11-24'

• Type of event parameter is IMyDateModel

• Example of the dateChanged callback:

<input angular-mydatepicker [(ngModel)]="model" [options]="myDatePickerOptions" #dp="angular-mydatepicker" (dateChanged)="onDateChanged($event)"/>

onDateChanged(event: IMyDateModel) {
  console.log('onDateChanged(): ', event);
}

inputFieldChanged callback

• called when the value change in the input field, date or date range is selected or date is cleared.

• event parameter:

  • event.value: Value of the input field. For example: '2018-11-22'
  • event.dateFormat: Date format. For example 'yyyy-mm-dd'
  • event.valid: Boolean value indicating is the value of input field valid or not. For example: true

• Type of event parameter is IMyInputFieldChanged

• Example of the input field changed callback:

<input angular-mydatepicker [(ngModel)]="model" [options]="myDatePickerOptions" #dp="angular-mydatepicker" (inputFieldChanged)="onInputFieldChanged($event)"/>

onInputFieldChanged(event: IMyInputFieldChanged) {
  console.log('onInputFieldChanged(): Value: ', event);
}

calendarViewChanged callback

• called when the calendar view change

• event parameter:

  • event.year: Year number in calendar. For example: 2016
  • event.month: Month number in calendar. For example: 11
  • event.first: First day of selected month and year. Type of IMyWeekday. For example: {number: 1, weekday: "tu"}
  • event.last: Last day of selected month and year. Type of IMyWeekday. For example: {number: 30, weekday: "we"}

• event parameter type is IMyCalendarViewChanged

• values of the weekday property are same as values of the firstDayOfWeek option

• Example of the calendar view changed callback:

<input angular-mydatepicker [(ngModel)]="model" [options]="myDatePickerOptions" #dp="angular-mydatepicker" (calendarViewChanged)="onCalendarViewChanged($event)"/>

onCalendarViewChanged(event: IMyCalendarViewChanged) {
  console.log('onCalendarViewChanged(): Year: ', event);
}

calendarToggle callback

• called when the calendar is opened or closed

  • event: number from 1 to 4 indicating the reason of the event
    • 1 = calendar opened
    • 2 = calendar closed by date select
    • 3 = calendar closed by calendar button
    • 4 = calendar closed by outside click (document click)
    • 5 = calendar closed by ESC key

• Example of the calendar toggle callback:

 <input angular-mydatepicker [(ngModel)]="model" [options]="myDatePickerOptions" #dp="angular-mydatepicker" (calendarToggle)="onCalendarToggle($event)"/>

onCalendarToggle(event: number): void {
    console.log('onCalendarClosed(): Reason: ', event);
}

rangeDateSelection callback

• called in date range mode when a date is selected

  • event parameter:
    • event.isBegin: Is begin date. true if begin date, false if end date
    • event.date: Selected date (IMyDate)
    • event.dateFormat: Date format given in options. For example 'yyyy-mm-dd'
    • event.formatted: Selected date (format based on dateFormat option). For example '2019-05-10'
    • event.epoc: Epoc time stamp. For example: 1557435600

• Example of the range date selection callback:

 <input angular-mydatepicker [(ngModel)]="model" [options]="myDatePickerOptions" #dp="angular-mydatepicker" (rangeDateSelection)="onDateRangeSelection($event)"/>

onDateRangeSelection(event: IMyRangeDateSelection): void {
  console.log('onDateRangeSelection(): event: ', event);
}

Development of this component

• At first fork and clone this repo:

  1. git clone https://github.com/kekeh/angular-mydatepicker.git
  2. cd angular-mydatepicker

• Install tools (version >= 7.3.8):

  1. npm install --g @angular/cli

• Install dependencies:

  1. npm install

• Run sample application:

  1. ng serve
  2. Navigate to http://localhost:4200

• Build datepicker library:

  1. npm run build-lib (dist/angular-mydatepicker folder will be created under the root folder)

• Build a local npm installation package:

  1. npm run build-lib
  2. cd dist/angular-mydatepicker
  3. npm pack
  • local installation package is created to the dist/angular-mydatepicker folder. For example: angular-mydatepicker-0.0.1.tgz

• Install local npm package to your project:

  1. npm install path_to_dist/angular-mydatepicker-0.0.1.tgz

Demo

Online demo is here

Compatibility

• Firefox (version 66.0.3)
• Chrome (version 72.0.3626.96)
• Edge - not tested yet
• IE11 - not tested yet
• Safari - not tested yet

License

• License: MIT

Author

• Author: kekeh

Keywords

• datepicker
• date range picker
• Angular