ngx-mydatepicker

Angular date picker

Description

Angular attribute directive date picker. There is similar date picker here, but difference between these two is that with ngx-mydatepicker you can define the style of input box, calendar and clear buttons.

Online demo of bootstrap styled input box is here

Installation

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

1. npm install ngx-mydatepicker --save

2. Add MyDatePickerModule import to your @NgModule like example below

   import { NgModule } from '@angular/core';
   import { BrowserModule } from '@angular/platform-browser';
   import { MyTestApp } from './my-test-app';
   import { NgxMyDatePickerModule } from 'ngx-mydatepicker';
   
   @NgModule({
       imports:      [ BrowserModule, NgxMyDatePickerModule ],
       declarations: [ MyTestApp ],
       bootstrap:    [ MyTestApp ]
   })
   export class MyTestAppModule {}

3. If you are using systemjs package loader add the following ngx-mydatepicker properties to the System.config:

   (function (global) {
       System.config({
           paths: {
               'npm:': 'node_modules/'
           },
           map: {
               // Other components are here...
   
               'ngx-mydatepicker': 'npm:ngx-mydatepicker/bundles/ngx-mydatepicker.umd.js'
           },
           packages: {
           }
       });
   })(this);

Usage

Use one of the following two options.

1. ngModel binding

In this option the ngModel binding is used. Here is an example application. It shows how to use the ngModel.

To use ngModel define the application class as follows:

import {IMyOptions, IMyDateModel} from 'ngx-mydatepicker';
// other imports here...

export class MyTestApp {

    private myOptions: IMyOptions = {
        // other options...
        dateFormat: 'dd.mm.yyyy',
    };

    // Initialized to specific date (09.10.2018)
    private model: Object = { date: { year: 2018, month: 10, day: 9 } };

    constructor() { }

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

Add the following snippet inside your template:

<!-- input box styling is bootstrap 3.3.7 -->
<form>
    <div class="input-group">
        <input class="form-control" style="float:none" placeholder="Select a date" ngx-mydatepicker name="mydate"
               [(ngModel)]="model" [options]="myOptions" #dp="ngx-mydatepicker" (dateChanged)="onDateChanged($event)"/>

        <span class="input-group-btn">
            <button type="button" class="btn btn-default" (click)="dp.clearDate();$event.stopPropagation()">
                <i class="glyphicon glyphicon-remove"></i>
            </button>
            <button type="button" class="btn btn-default" (click)="dp.toggleCalendar();$event.stopPropagation()">
                <i class="glyphicon glyphicon-calendar"></i>
            </button>
        </span>
    </div>
</form>

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 {IMyOptions} from 'ngx-mydatepicker';
// other imports here...

export class MyTestApp implements OnInit {

    private myOptions: IMyOptions = {
        // other options...
        dateFormat: 'dd.mm.yyyy',
    };

    private myForm: FormGroup;

    constructor(private formBuilder: FormBuilder) { }

    ngOnInit() {
        this.myForm = this.formBuilder.group({
            // Empty string means no initial value. Can be also specific date for
            // example: {date: {year: 2018, month: 10, day: 9}} which sets this date to initial
            // value.

            myDate: ['', Validators.required]
            // other controls are here...
        });
    }

    setDate(): void {
        // Set today date using the setValue function
        let date = new Date();
        this.myForm.setValue({myDate: {
        date: {
            year: date.getFullYear(),
            month: date.getMonth() + 1,
            day: date.getDate()}
        }});
    }

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

Add the following snippet inside your template:

<!-- input box styling is bootstrap 3.3.7 -->
<form [formGroup]="myForm" (ngSubmit)="onSubmit()" novalidate>
    <div class="input-group">
        <input class="form-control" style="float:none" placeholder="Select a date" ngx-mydatepicker name="myDate"
               formControlName="myDate" [options]="myOptions" #dp="ngx-mydatepicker"/>

        <span class="input-group-btn">
            <button type="button" class="btn btn-default" (click)="dp.clearDate();$event.stopPropagation()">
                <i class="glyphicon glyphicon-remove"></i>
            </button>
            <button type="button" class="btn btn-default" (click)="dp.toggleCalendar();$event.stopPropagation()">
                <i class="glyphicon glyphicon-calendar"></i>
            </button>
        </span>
    </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 IMyOptions. It can contain the following properties.

Option	Default	Description
dayLabels	{su: 'Sun', mo: 'Mon', tu: 'Tue', we: 'Wed', th: 'Thu', fr: 'Fri', sa: 'Sat'}	Day labels visible on the selector.
monthLabels	{ 1: 'Jan', 2: 'Feb', 3: 'Mar', 4: 'Apr', 5: 'May', 6: 'Jun', 7: 'Jul', 8: 'Aug', 9: 'Sep', 10: 'Oct', 11: 'Nov', 12: 'Dec' }	Month labels visible on the selector.
dateFormat	yyyy-mm-dd	Date format on the selection area and the callback. For example: dd.mm.yyyy, yyyy-mm-dd, dd mmm yyyy (mmm = Month as a text)
showTodayBtn	true	Show 'Today' button on calendar.
todayBtnTxt	Today	Today button text. Can be used if showTodayBtn = true.
firstDayOfWeek	mo	First day of week on calendar. One of the following: mo, tu, we, th, fr, sa, su
sunHighlight	true	Sunday red colored on calendar.
markCurrentDay	true	Is current day (today) marked on calendar.
editableMonthAndYear	true	Is month and year labels editable or not.
minYear	1000	Minimum allowed year in calendar. Cannot be less than 1000.
maxYear	9999	Maximum allowed year in calendar. Cannot be more than 9999.
disableUntil	no default value	Disable dates backward starting from the given date. For example: {year: 2016, month: 6, day: 26}
disableSince	no default value	Disable dates forward starting from the given date. For example: {year: 2016, month: 7, day: 22}
disableDays	no default value	Disable single dates one by one. Array of disabled dates. For example: [{year: 2016, month: 11, day: 14}, {year: 2016, month: 1, day: 15]
enableDays	no default value	Enable given dates one by one if the date is disabled. For example if you disable the date range and want to enable some dates in range. Array of enabled days. For example: [{year: 2016, month: 11, day: 14}, {year: 2016, month: 1, day: 15}]
disableDateRange	no default value	Disable a date range from begin to end. For example: {begin: {year: 2016, month: 11, day: 14}, end: {year: 2016, month: 11, day: 20}
disableWeekends	false	Disable weekends (Saturday and Sunday).
disableHeaderButtons	true	Prevent to change the calendar view with header buttons if previous or next month are fully disabled by disableUntil or disableSince.
showWeekNumbers	false	Are week numbers visible or not on calendar. Can be used if firstDayOfWeek = mo.
alignSelectorRight	false	Align selector right.
openSelectorTopOfInput	false	Open selector top of input field. The selector arrow cannot be shown if this option is true.
ariaLabelPrevMonth	Previous Month	Aria label text of previous month button.
ariaLabelNextMonth	Next Month	Aria label text of next month button.
ariaLabelPrevYear	Previous Year	Aria label text of previous year button.
ariaLabelNextYear	Next Year	Aria label text of next year button.

• Example of the options data (not all properties listed):

  myOptions: IMyOptions = {
      todayBtnTxt: 'Today',
      dateFormat: 'yyyy-mm-dd',
      firstDayOfWeek: 'mo',
      sunHighlight: true,
      disableUntil: {year: 2016, month: 8, day: 10}
  };

defaultMonth attribute

If initial date is not specified, when the datepicker is opened, you would prefer a different year and month to be the default for a freshly chosen date picking operation, specify the defaultMonth attribute.

Value of the defaultMonth attribute is a string which contain year number and month number separated by delimiter. The delimiter can be any special character. For example the value of the defaultMonth attribute can be: 2016.08, 08-2016, 08/2016.

Functions

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

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

This #dp="ngx-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();$event.stopPropagation()">Open</button>

closeCalendar function

Closes the calendar. For example:

<button type="button" (click)="dp.closeCalendar();$event.stopPropagation()">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();$event.stopPropagation()">Toggle</button>

clearDate function

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

<button type="button" (click)="dp.clearDate();$event.stopPropagation()">Clear</button>

Callbacks

dateChanged callback

• called when the date is selected, removed or input field typing is valid

• event parameter:

  • event.date: Date object in the following format: { day: 22, month: 11, year: 2016 }
  • event.jsdate: Javascript Date object
  • event.formatted: Date string in the same format as dateFormat option is: '2016-11-22'
  • event.epoc: Epoc time stamp number: 1479765600

• event parameter type is IMyDateModel

• Example of the dateChanged callback:

onDateChanged(event: IMyDateModel) {
  console.log('onDateChanged(): ', event.date, ' - jsdate: ', new Date(event.jsdate).toLocaleDateString(), ' - formatted: ', event.formatted, ' - epoc timestamp: ', event.epoc);
}

inputFieldChanged callback

• called when the value change in the input field, date is selected or date is cleared (can be used in validation, returns true or false indicating is date valid or not in the input field)

• event parameter:

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

• event parameter type is IMyInputFieldChanged

• Example of the input field changed callback:

onInputFieldChanged(event: IMyInputFieldChanged) {
  console.log('onInputFieldChanged(): Value: ', event.value, ' - dateFormat: ', event.dateFormat, ' - valid: ', event.valid);
}

calendarViewChanged callback

• called when the calendar view change (year or month 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:

onCalendarViewChanged(event: IMyCalendarViewChanged) {
  console.log('onCalendarViewChanged(): Year: ', event.year, ' - month: ', event.month, ' - first: ', event.first, ' - last: ', event.last);
}

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)

• Example of the calendar toggle callback:

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

Development of this component

• At first fork and clone this repo.

• Install all dependencies:

  1. npm install
  2. npm install --global gulp-cli

• Build the npmdist folder and execute tslint:

  1. gulp all

• Execute unit tests and coverage (output is generated to the test-output folder):

  1. npm test

• Run sample application:

  1. npm start
  2. Open http://localhost:5000 to browser

• Build a local npm installation package:

  1. gulp all
  2. cd npmdist
  3. npm pack
  • local installation package is created to the npmdist folder. For example: ngx-mydatepicker-0.0.1.tgz

• Install local npm package to your project:

  1. npm install path_to_npmdist/ngx-mydatepicker-0.0.1.tgz

Demo

Online demo is here

Compatibility (tested with)

• Firefox (latest)
• Chrome (latest)
• Chromium (latest)
• Edge
• IE11
• Safari

License

• License: MIT

Author

• Author: kekeh