/date-time-picker

AngularJS Date Time Picker (Responsive Design)

Primary LanguageTypeScriptMIT LicenseMIT

Angular Date Time Picker

Angular date time picker - Angular reusable UI component This package supports Angular 4

Updates

  • Binding to [(ngModel)] instead [dateTimePicker]
  • Separate picker styles into picker.min.css. In this case, people could easily overwrite the picker's theme (like picker's color, background color, or fonts ect) in their own project's css files.
  • Delete [theme] option.
  • Change emit event names, onChange($event), onError($event).
  • Fixed cancel button clear input issue, closes #81.
  • Fixed minMoment and maxMoment not update issue, closes #82.
  • Fixed Starting of week issue, closes #84.

Important

Other Similar Projects

Description

Simple Angular date time picker. Online demo is here. This picker is responsive design, so feel free to try it in your desktops, tablets and mobile devices. This picker uses MomentJS

Installation

To install this component, follow the procedure:

  1. Install with npm:npm install ng-pick-datetime --save
  2. Add <link rel="stylesheet" type="text/css" href="/node_modules/ng-pick-datetime/styles/picker.min.css" /> in your index.html
  3. Add DateTimePickerModule 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 { DateTimePickerModule } from 'ng-pick-datetime';

@NgModule({
    imports:      [ BrowserModule, DateTimePickerModule ],
    declarations: [ MyTestApp ],
    bootstrap:    [ MyTestApp ]
})
export class MyTestAppModule {}
  4. This picker use MomentJS. Remember to load MomentJS when you load your project from webpack or systemjs.**
  5. If you are using systemjs package loader add the following ng-pick-datetime properties to the System.config: 
    (function (global) {
    System.config({
        paths: {
            'npm:': 'node_modules/'
        },
        map: {
            // Other components are here...

            'ng-pick-datetime': 'npm:ng-pick-datetime',
            'moment': 'npm:moment',
        },
        packages: {
            // Other components are here...

			// the picker
            'ng-pick-datetime': {
                main: 'picker.bundle.js',
                defaultExtension: 'js'
            },
            // momentJS
            'moment': {
                main: 'moment.js',
                defaultExtension: 'js'
            },
        }
    });
})(this);

Usage

Use the following snippet inside your template. For example:

<input [value]="momentValue | date: 'short'" [(ngModel)]="momentValue" dateTimePicker />

Or:

<input [value]="momentValue | date: 'short'" [(ngModel)]="momentValue" dateTimePicker (onChange)="setMoment($event)" />
public setMoment(moment: any): any {
    this.momentValue = moment;
    // Do whatever you want to the return object 'moment'
}
  • Create a normal HTML Input and put it anywhere you want (like inside a form you already created).
  • You may set the HTML Input to readonly, so you can only change the date value from the pop-up date-time picker.
  • Use dateTimePicker directive from our DateTimePickerModule dateTimePicker and bind your variable to picker via [(ngModel)]='momentValue'. This is the two way binding feature from AngularJS. Firstly, the local variable 'momentValue' would be bind to our 'dateTimePicker' directive Input and shows in the popup picker dialog. Once you select your new moment value and confirm it, the local variable 'momentValue' would be updated. Or if you want to deal with the return new moment value from our directive before update the local variable, your can separate it like this [ngModel]="momentValue" (onChange)="setMoment($event)"
  • Use [value]="momentValue" from bind the moment value to the input value.
  • Inside [value]="momentValue | date: 'short' ", we use the date pipe from Angular built-in Pipes to transform the Javascript Date Object to more friendly formats. We only use this built-in date pipe when we set the 'dateTimePicker' return object as Javascript Date Object.
  • Optional attributes:
    • [autoClose]=" false " --- The picker would not close or return the value by selecting a day in the calendar. If setting [autoClose] = "true", the picker would close and return the moment value by clicking a day in the calendar or confirming the time value in time slider (The default value is 'false').
    • [hourTime]=" '24' " --- Set the hour time format (12-hour format or 24-hour format). Default is '24'(24-hour format). The other choice could be '12'(12-hour format).
    • [locale]=" 'en' " --- This date-time-picker has robust support for internationalization. (Default value is 'en'. If you want to change to French for example, just set [locale]=" 'fr' ". You can get more inform about the i18n from MomentJS-i18n).
    • [mode]=" 'popup' " --- Set the date-time picker mode. Default is 'popup'. The options choice could be 'popup', 'dropdown', 'inline'. If you set it as 'inline', the date-time-picker would always show on your web page as a html element (In inline mode, you could set width = '250px' to make the the picker smaller or bigger. picker width are set between 250px and 300px ).
    • [minMoment]= "'2017-09-21 19:30:00''" / [maxMoment] -- Set minimum date / time and maximum date / time that is selectable. The format is YYYY-MM-DD HH:mm:ss(or YYYY-MM-DD for only setting date value).
      For example, if the ideal min date and time is September 21st, 2017 19:30, the format string is '2017-09-21 19:30:00'(The default value is 'null'). If you want to know whether a user selected a invalid date or time, you could use (dateTimePickerError)="DoWhateverFn($event)" to catch an error message.
    • [onlyCurrentMonth]=" true " --- Set to only show current month days in date picker. (The default value is false).
    • [pickerType]=" 'both' " --- You can set the default dialogType to 'date' or 'time' or 'both'. When you leave it as default ([pickerType]=" 'both' "), the date-time-picker dialog would display the date calendar and time slider (you could toggle between them). If you set it as 'date' or 'time', the date-time-picker dialog would only display date calendar or time slider.
    • [position]=" 'bottom' " --- Set the picker position in dropdown mode. This position means the picker would appear on the bottom ('top', 'left' or 'right') of your input box. Default is 'bottom'. The option choice could be 'top', 'bottom', 'left', 'right'. (The default value is 'bottom').
    • [positionOffset]=" '0%' " --- Set the picker position offset in dropdown mode.
      When you set your position to 'top' or 'bottom', the [positionOffset] is the percentage of your input box width and it would modify the distance between the picker and the input box horizontally.
      When you set your position to 'right' or 'left', the [positionOffset] is the percentage of your input box height and it would modify the distance between the picker and the input box vertically.
      The value could be minus like '-10%'.(The default value is '0%').
    • [returnObject]=" 'js' " --- You can set the return object type when you pick a moment from date-time-picker. (Default value is 'js', this means the default return object type is javascript Date object. The other options are: string, moment, json, array, iso and object).
    • [showSeconds]=" true " --- Set to show seconds slider in time picker. (The default value is false).
    • [viewFormat]=" 'll' " --- If you set your returnObject as 'string', you need to set the viewFormat. (Default value is 'll'. You can get more inform about the format from MomentJS).
    • Important: Do Not forget the single quote inside the double quote when you set the optional attributes string value.
  • Emit Events
    • (onChange) --- emit a value whenever a date or time is selected.
    • (onError) --- emit a message whenever a invalid date or time is selected.

Theme

The picker now separate its styles into ./node_modules/ng-pick-datetime/styles/picker.min.css. You could inspect the picker's classes from your browser's dev tool and overwrite them in your project's css files.

Demo

Online demo is here

License

  • License: MIT

Author

  • Author: Daniel Pan