Angular 2 date picker - Angular2 reusable UI component

Simple Angular2 date picker. Online demo is here

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

1. npm install 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';
   
   // If you are using webpack package loader import the MyDatePickerModule from here:
   import { MyDatePickerModule } from 'mydatepicker';
   
   // If you are using systemjs package loader import the MyDatePickerModule from here:
   import { MyDatePickerModule } from 'mydatepicker/dist/my-date-picker.module';
   
   @NgModule({
       imports:      [ BrowserModule, MyDatePickerModule ],
       declarations: [ MyTestApp ],
       bootstrap:    [ MyTestApp ]
   })
   export class MyTestAppModule {}

3. Use the following snippet inside your template:

   <my-date-picker [options]="myDatePickerOptions"
                   (dateChanged)="onDateChanged($event)"></my-date-picker>

   • Mandatory attributes:

     • [options]="myDatePickerOptions"
     • (dateChanged)="onDateChanged($event)"

   • Optional attributes:

     • [selDate]="selectedDate" || [defaultMonth]="defaultMonth"
     • [locale]="locale"
     • (inputFieldChanged)="onInputFieldChanged($event)"
     • (calendarViewChanged)="onCalendarViewChanged($event)"

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

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

Value of the options attribute is a javascript object. It can contain the following properties.

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

  myDatePickerOptions = {
      todayBtnTxt: 'Today',
      dateFormat: 'yyyy-mm-dd',
      firstDayOfWeek: 'mo',
      sunHighlight: true,
      height: '34px',
      width: '260px',
      inline: false,
      disableUntil: {year: 2016, month: 8, day: 10},
      selectionTxtFontSize: '16px'
  };

An ISO 639-1 language code can be provided as shorthand for several of the options listed above. Currently supported languages: en, fr, ja, fi, es, hu, sv, nl, ru, no, tr, pt-br, de, it, pl and my. If the locale attribute is used it overrides dayLabels, monthLabels, dateFormat, todayBtnTxt, firstDayOfWeek and sunHighlight properties from the options.

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

Provide the initially chosen date that will display both in the text input field and provide the default for the popped-up selector.

Type of the selDate attribute can be a string or an IMyDate object.

• the string must be in the same format as the dateFormat option is. For example '2016-06-26'
• the object must be in the IMyDate format. For example: {year: 2016, month: 6, day: 26}

If selDate is not specified, when the datepicker is opened, it will ordinarily default to selecting the current date. If you would prefer a different year and month to be the default for a freshly chosen date picking operation, specify a [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.

• 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

• Example of the dateChanged callback:

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

• 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

• Example of the input field changed callback:

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

• 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. Object which contain day number and weekday string. For example: {number: 1, weekday: "tu"}
  • event.last: Last day of selected month and year. Object which contain day number and weekday string. For example: {number: 30, weekday: "we"}

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

• Example of the calendar view changed callback:

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

The styles of the component can be changed by overriding the styles.

Create a separate stylesheet file which contain the changed styles. Then import the stylesheet file in the place which is after the place where the component is loaded.

The sampleapp of the component contain an example:

• override.css contain the changed styles.
• index.html contain import of the override.css file.

• At first fork and clone this repo.

• Install all dependencies:

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

• Build dist and npmdist folders 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:https://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: mydatepicker-1.1.1.tgz

• Install local npm package to your project:

  1. npm install path_to_npmdist/mydatepicker-1.1.1.tgz

Online demo is here

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

• License: MIT

• Author: kekeh