mydatepicker

Angular 2 date picker - Angular2 reusable UI component

Description

Highly configurable Angular2 date picker. Online demo is here

Installation

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. 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);

Usage

Use one of the following three options.

1. Callbacks

In this option the mydatepicker sends data back to host application using callbacks. Here is an example application. It shows how to use callbacks.

To use callbacks define the application class as follows:

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

export class MyTestApp {

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

    constructor() { }

    // dateChanged callback function called when the user select the date. This is mandatory callback
    // in this option. There are also optional inputFieldChanged and calendarViewChanged callbacks.
    onDateChanged(event: IMyDateModel) {
        // event properties are: event.date, event.jsdate, event.formatted and event.epoc
    }
}

Add the following snippet inside your template:

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

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 'mydatepicker';
// other imports here...

export class MyTestApp implements OnInit {

    private myDatePickerOptions: 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. It is also possible to set initial date using the selDate attribute.

            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:

<form [formGroup]="myForm" novalidate>
    <my-date-picker name="mydate" [options]="myDatePickerOptions"
                    formControlName="myDate"></my-date-picker>
  <!-- other controls are here... -->
</form>

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

export class MyTestApp {

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

    // Initialized to specific date (09.10.2018). It is also possible to set initial
    // date value using the selDate attribute.
    private model: Object = { date: { year: 2018, month: 10, day: 9 } };

    constructor() { }
}

Add the following snippet inside your template:

<form #myForm="ngForm" novalidate>
    <my-date-picker name="mydate" [options]="myDatePickerOptions"
                    [(ngModel)]="model" required></my-date-picker>
</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).
inline	false	Show mydatepicker in inline mode.
showClearDateBtn	true	Is clear date button shown or not. Can be used if inline = false.
height	34px	mydatepicker height in without selector. Can be used if inline = false.
width	100%	mydatepicker width. Can be used if inline = false.
selectionTxtFontSize	18px	Selection area font size. Can be used if inline = false.
alignSelectorRight	false	Align selector right. Can be used if inline = false.
openSelectorTopOfInput	false	Open selector top of input field. The selector arrow cannot be shown if this option is true. Can be used if inline = false.
indicateInvalidDate	true	If user typed date is not same format as dateFormat, show red background in the selection area. Can be used if inline = false.
showDateFormatPlaceholder	false	Show value of dateFormat as placeholder in the selection area if a date is not selected. Can be used if inline = false.
customPlaceholderTxt	empty string	Show custom string in the selection area if a date is not selected. Can be used if showDateFormatPlaceholder = false and inline = false.
componentDisabled	false	Is selection area input field and buttons disabled or not (input disabled flag). Can be used if inline = false.
editableDateField	true	Is selection area input field editable or not (input readonly flag). Can be used if inline = false.
inputValueRequired	false	Is selection area input field value required or not (input required flag). Can be used if inline = false.
showSelectorArrow	true	Is selector (calendar) arrow shown or not. Can be used if inline = false.
showInputField	true	Is selection area input field shown or not. If not, just show the icon. Can be used if inline = false.
openSelectorOnInputClick	false	Open selector when the input field is clicked. Can be used if inline = false and editableDateField = false.

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

  myDatePickerOptions: IMyOptions = {
      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'
  };

locale attribute

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, uk, no, tr, pt-br, de, it, it-ch, pl, my, sk, sl and zh-cn. 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

selDate attribute

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}

defaultMonth attribute

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.

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);
}

Change styles of the component

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.

Development of this component

• 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://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

Demo

Online demo is here

Compatibility (tested with)

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

License

• License: MIT

Author

• Author: kekeh