ng2datepickernevent v1.0.0

ng2datepickernevent

Angular 2 date picker - Angular2 reusable UI component

Description

Highly configurable Angular2 date picker. Online demo is here

If you want to set own styles to the input box, the calendar and the clear buttons you can try this attribute directive datepicker.

Installation

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

1. npm install ng2datepickernevent --save

2. Add ng2datepickerneventModule 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 { ng2datepickerneventModule } from 'ng2datepickernevent';
   
   @NgModule({
       imports:      [ BrowserModule, ng2datepickerneventModule ],
       declarations: [ MyTestApp ],
       bootstrap:    [ MyTestApp ]
   })
   export class MyTestAppModule {}

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

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

Usage

Use one of the following three 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} from 'ng2datepickernevent';
// other imports here...

export class MyTestApp {

    private ng2datepickerneventOptions: 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() { }
}

Add the following snippet inside your template:

<form #myForm="ngForm" novalidate>
    <my-date-picker name="mydate" [options]="ng2datepickerneventOptions"
                    [(ngModel)]="model" required></my-date-picker>
</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 'ng2datepickernevent';
// other imports here...

export class MyTestApp implements OnInit {

    private ng2datepickerneventOptions: 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:

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

3. Callbacks

In this option the ng2datepickernevent 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 'ng2datepickernevent';
// other imports here...

export class MyTestApp {

    private ng2datepickerneventOptions: 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]="ng2datepickerneventOptions"
                (dateChanged)="onDateChanged($event)"></my-date-picker>

Attributes

options attribute

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

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

  ng2datepickerneventOptions: 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 the following options (dayLabels, monthLabels, dateFormat, todayBtnTxt, firstDayOfWeek and sunHighlight). 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, zh-cn, he, ro, ca, id, en-au, am-et and cs.

The locale options can be override by options attribute.

• 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}

Here is an example on how to use this attribute.

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.

Here is an example on how to use this attribute.

placeholder attribute

Placeholder text in the input field. Here is an example on how to use this attribute.

selector attribute

Selector can be opened or closed using this attribute. Here is an example on how to use this attribute. Another way is to call a function of ng2datepickernevent. Here is an example.

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

inputFocusBlur callback

• called when the input box get or lost focus

• event parameter:

  • event.reason: Reason of the event:
    • 1 = focus to input box
    • 2 = focus out of input box
  • event.value: Value of input box
  • event parameter type is IMyInputFocusBlur

• Example of the input focus blur callback:

    onInputFocusBlur(event: IMyInputFocusBlur): void {
        console.log('onInputFocusBlur(): Reason: ', event. reason, ' - Value: ', event.value);
    }

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 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: ng2datepickernevent-1.1.1.tgz

• Install local npm package to your project:

  1. npm install path_to_npmdist/ng2datepickernevent-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