axiros-datetime-picker

Angular Date Time Picker
========================


Angular date time picker - Angular reusable UI component with support for Angular 12+

Description
-------
This is the modified version of date time picker package Angular Date Time Picker.
In a nutshell this library is date time picker, that can work in single / range modes. There are two modes for picker UI - dialog and popup menu,
so feel free to try it in your desktops, tablets and mobile devices.

The difference from original library - I have updated dependencies to Angular 11, did some refactoring and added native parsing of en-GB date format.

Online docs for original library is here.
Demo page is here.

How to Use
-------

1. Install with npm:npm install axiros-datetime-picker --save
2. Add styles.
If you are using Angular CLI, you can add this to your styles.css:
``css
@import "~axiros-datetime-picker/assets/style/picker.min.css";
`
If you are not using the Angular CLI, you can include the picker.min.css via a `` element in your index.html.
3. Add __OwlDateTimeModule__ and __OwlNativeDateTimeModule__ to your __@NgModule__ like example below
`typescript
import { NgModule } from '@angular/core';
import { BrowserModule } from '@angular/platform-browser';
import { MyTestApp } from './my-test-app';

import { OwlDateTimeModule, OwlNativeDateTimeModule } from 'axiros-datetime-picker';

@NgModule({
imports: [
BrowserModule,
OwlDateTimeModule,
OwlNativeDateTimeModule,
],
declarations: [ MyTestApp ],
bootstrap: [ MyTestApp ]
})
export class MyTestAppModule {}
`

Also it is important to define date format that will be displayed in Input form.
In the module add provider:

`
providers: [
{ provide: OWL_DATE_TIME_FORMATS, useValue: MY_NATIVE_FORMATS },
],
`

you can define any format for date, in my example i use:

`
export const MY_NATIVE_FORMATS = {
fullPickerInput: { year: 'numeric', month: '2-digit', day: '2-digit', hour: '2-digit', minute: '2-digit', hour12: false },
datePickerInput: { year: 'numeric', month: 'numeric', day: 'numeric' },
timePickerInput: { hour: 'numeric', minute: 'numeric' },
monthYearLabel: { year: 'numeric', month: 'short' },
dateA11yLabel: { year: 'numeric', month: 'long', day: 'numeric' },
monthYearA11yLabel: { year: 'numeric', month: 'long' },
};
`

4. Connecting a picker to an input and a trigger.
`html
[owlDateTime]="dt1"
[owlDateTimeTrigger]="dt1"
placeholder="Date Time">

`
`html
[owlDateTime]="dt2"
placeholder="Date Time">
[owlDateTimeTrigger]="dt2">



`
The examples above are quite basic. The picker has much more features,
and you could learn more about those from demo page.

In addition, this is ngx-formly implementation

`
import {Component, ElementRef, ViewChild} from '@angular/core';
import {FieldType} from '@ngx-formly/material';
import {DateTimeAdapter} from 'axiros-datetime-picker';

@Component({
selector: 'app-datetime-picker',
styleUrls: ['./formly-datetime-picker.component.scss'],
template:

Animation
-------
This picker uses angular animations to improve the user experience,
therefore you need to install @angular/animations and import BrowserAnimationsModule to your application.
`
npm install @angular/animations --save
`
`typescript
import {BrowserModule} from '@angular/platform-browser';
import {BrowserAnimationsModule} from '@angular/platform-browser/animations';

@NgModule({
imports: [
BrowserModule,
BrowserAnimationsModule,
//...
],
//...
})
export class YourAppModule { }
`
If you prefer to disable animation effect, use NoopAnimationsModule instead.

Choose a date implementation
-------
The date-time picker was built to be date implementation agnostic.
Developers need to make sure to provide the appropriate pieces for the picker to work with their chosen implementation.
There are two pre-made modules, users need to import one of them or build your own one (learn more about this from here).

- OwlNativeDateTimeModule - support for native JavaScript Date object
- OwlMomentDateTimeModule - support for MomentJs

Properties for owl-date-time
-------
|Name|Type|Required|Default|Description|
|:--- |:--- |:--- |:--- |:--- |
|pickerType|both, calendar, timer|Optional|both| Set the type of the dateTime picker. both: show both calendar and timer, calendar: only show calendar, timer: only show timer. |
|pickerMode|popup, dialog|Optional|popup| The style the picker would open as. |
|startView|month, year, multi-year|Optional|month| The view that the calendar should start in. |
|startAt| T/null |Optional|null| The moment to open the picker to initially. |
|firstDayOfWeek|number|Optional|0| Set the first day of week. Valid value is from 0 to 6. 0: Sunday ~ 6: Saturday|
|showSecondsTimer|boolean|Optional|false| When specify it to true, it would show a timer to configure the second's value |
|hideOtherMonths|boolean|Optional|false| Whether to hide dates in other months at the start or end of the current month |
|hour12Timer|boolean|Optional|false| When specify it to true, the timer would be in hour12 format mode|
|stepHour|number|Optional|1| Hours to change per step.|
|stepMinute|number|Optional|1| Minutes to change per step.|
|stepSecond|number|Optional|1| Seconds to change per step.|
|scrollStrategy|ScrollStrategy|Optional|BlockScrollStrategy| Define the scroll strategy when the picker is open. Learn more this from https://material.angular.io/cdk/overlay/overview#scroll-strategies.|
|disabled|boolean|Optional|false|When specify to true, it would disable the picker.|
|backdropClass|string/string[]|Optional|null|Custom class for the picker backdrop.|
|panelClass|string/string[]|Optional|null|Custom class for the picker overlay panel.|

Events for owl-date-time
-------
|Events|Parameter|Description|
|:--- |:--- |:--- |
|afterPickerOpen|null|Callback to invoke when the picker is opened|
|afterPickerClosed|null|Callback to invoke when the picker is closed.|
|yearSelected|T|Callback to invoke when the year is selected.This doesn't imply a change on the selected date.|
|monthSelected|T|Callback to invoke when the month is selected.This doesn't imply a change on the selected date.|

Properties for input[owlDateTime]
-------
|Name|Type|Required|Default|Description|
|:--- |:--- |:--- |:--- |:--- |
|owlDateTime|OwlDateTimeComponent|Require|null| The date time picker that this input is associated with.|
|owlDateTimeFilter|( date: T)=>boolean |Optional|null|A function to filter date time.|
|disabled|boolean|Optional|false|When specify to true, it would disable the picker's input.|
|min||Optional|null| The minimum valid date time.|
|max||Optional|null| The maximum valid date time.|
|selectMode|single, range, rangeFrom, rangeTo|Optional|single| Specify the picker's select mode. single: a single value allowed, range: allow users to select a range of date-time, rangeFrom: the input would only show the 'from' value and the picker could only selects 'from' value, rangeTo: the input would only show the 'to' value and the picker could only selects 'to' value.|
|rangeSeparator|string|Optional|~| The character to separate the 'from' and 'to' in input value in range selectMode.|

Events for input[owlDateTime]
-------
|Events|Parameter|Description|
|:--- |:--- |:--- |
|dateTimeChange|source: OwlDateTimeInput, value: input value, input: the input element|Callback to invoke when change event is fired on this |
|dateTimeInput|source: OwlDateTimeInput, value: input value, input: the input element|Callback to invoke when an input event is fired on this .|

Properties for [owlDateTimeTrigger]
-------
|Name|Type|Required|Default|Description|
|:--- |:--- |:--- |:--- |:--- |
|owlDateTimeTrigger|OwlDateTimeComponent|Require|null| The date time picker that this trigger is associated with.|
|disabled|boolean|Optional|false|When specify to true, it would disable the trigger.|


Properties for [owlDateTimeTrigger]
-------
|Name|Type|Required|Default|Description|
|:--- |:--- |:--- |:--- |:--- |
|owlDateTimeTrigger|OwlDateTimeComponent|Require|null| The date time picker that this trigger is associated with.|
|disabled|boolean|Optional|false|When specify to true, it would disable the trigger.|


Properties for owl-date-time-inline
-------
|Name|Type|Required|Default|Description|
|:--- |:--- |:--- |:--- |:--- |
|pickerType|both, calendar, timer|Optional|both| Set the type of the dateTime picker. both: show both calendar and timer, calendar: only show calendar, timer: only show timer. |
|startView|month, year, multi-year|Optional|month| The view that the calendar should start in. |
|startAt| T/null |Optional|null| The moment to open the picker to initially. |
|firstDayOfWeek|number|Optional|0| Set the first day of week. Valid value is from 0 to 6. 0: Sunday ~ 6: Saturday|
|showSecondsTimer|boolean|Optional|false| When specify it to true, it would show a timer to configure the second's value |
|hideOtherMonths|boolean|Optional|false| Whether to hide dates in other months at the start or end of the current month |
|hour12Timer|boolean|Optional|false| When specify it to true, the timer would be in hour12 format mode|
|stepHour|number|Optional|1| Hours to change per step.|
|stepMinute|number|Optional|1| Minutes to change per step.|
|stepSecond|number|Optional|1| Seconds to change per step.|
|disabled|boolean|Optional|false|When specify to true, it would disable the picker.|
|owlDateTimeFilter|( date: T)=>boolean |Optional|null|A function to filter date time.|
|min||Optional|null| The minimum valid date time.|
|max||Optional|null| The maximum valid date time.|
|selectMode|single, range, rangeFrom, rangeTo|Optional|single| Specify the picker's select mode. single: a single value allowed, range: allow users to select a range of date-time, rangeFrom: the input would only show the 'from' value and the picker could only selects 'from' value, rangeTo: the input would only show the 'to' value and the picker could only selects 'to' value.|

Localization and DateTime Format
-------
Localization for different languages and formats is defined by OWL_DATE_TIME_LOCALE and OWL_DATE_TIME_FORMATS`. You could learn more about this from here.

Dependencies
-------
none

License
-------
* License: MIT

Author
-------
Original library author - Daniel YK Pan