https://github.com/siteslave/mydatepicker-th
Datepicker for with thai locale, fork from https://github.com/kekeh/mydatepicker
https://github.com/siteslave/mydatepicker-th
angular angular4 datepicker thai
Last synced: 2 days ago
JSON representation
Datepicker for with thai locale, fork from https://github.com/kekeh/mydatepicker
- Host: GitHub
- URL: https://github.com/siteslave/mydatepicker-th
- Owner: siteslave
- License: mit
- Created: 2017-04-25T09:05:35.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2017-05-07T12:32:04.000Z (almost 9 years ago)
- Last Synced: 2025-10-19T10:23:07.794Z (6 months ago)
- Topics: angular, angular4, datepicker, thai
- Language: TypeScript
- Homepage:
- Size: 760 KB
- Stars: 5
- Watchers: 1
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# mydatepicker
**Angular date picker**
## Description
Fork from [https://github.com/kekeh/mydatepicker](https://github.com/kekeh/mydatepicker)
Online demo is [here](http://kekeh.github.io/mydatepicker)
## Installation
To install this component to an external project, follow the procedure:
1. __npm install mydatepicker-th --save__
2. Add __MyDatePickerTHModule__ import to your __@NgModule__ like example below
```ts
import { NgModule } from '@angular/core';
import { BrowserModule } from '@angular/platform-browser';
import { MyTestApp } from './my-test-app';
import { MyDatePickerTHModule } from 'mydatepicker-th';
@NgModule({
imports: [ BrowserModule, MyDatePickerTHModule ],
declarations: [ MyTestApp ],
bootstrap: [ MyTestApp ]
})
export class MyTestAppModule {}
```
3. If you are using __systemjs__ package loader add the following mydatepicker properties to the __System.config__:
```js
(function (global) {
System.config({
paths: {
'npm:': 'node_modules/'
},
map: {
// Other components are here...
'mydatepicker-th': 'npm:mydatepicker/bundles/mydatepicker.umd.min.js'
},
packages: {
}
});
})(this);
```
## Usage
วิธีใช้งาน
### 1. ngModel binding
แก้ไขไฟล์ app.module.ts:
```ts
import { MyDatePickerTHModule } from 'mydatepicker-th';
@NgModule({
imports: [
CommonModule,
FormsModule,
MyDatePickerTHModule
]
});
```
```ts
import {IMyOptions} from 'mydatepicker-th';
// other imports here...
export class MyTestApp {
private myDatePickerOptions: IMyOptions = {
// other options...
dateFormat: 'dd mmm yyyy',
};
// Initialized to specific date (09.10.2018).
private model: Object = { date: { year: 2018, month: 10, day: 9 } };
constructor() { }
}
```
การใช้งานใน Template:
```html
```
### 2. Reactive forms
```ts
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.
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: ''});
}
}
```
แก้ไข Template:
```html
```
### 3. การใช้งาน Event
```js
import {IMyOptions, IMyDateModel} from 'mydatepicker-th';
// other imports here...
export class MyTestApp {
private myDatePickerOptions: IMyOptions = {
// other options...
dateFormat: 'dd.mm.yyyy',
};
constructor() { }
onDateChanged(event: IMyDateModel) {
// event properties are: event.date, event.jsdate, event.formatted and event.epoc
console.log(event);
}
}
```
Template:
```html
```
## Attributes
### options attribute
Value of the __options__ attribute is a type of [IMyOptions](https://github.com/kekeh/mydatepicker/blob/master/src/my-date-picker/interfaces/my-options.interface.ts). It can contain the following properties.
| Option | Default | Type | Description |
| :------------ | :------------ | :----- | :--------- |
| __dayLabels__ | {su: 'Sun', mo: 'Mon', tu: 'Tue', we: 'Wed', th: 'Thu', fr: 'Fri', sa: 'Sat'} | [IMyDayLabels](https://github.com/kekeh/mydatepicker/blob/master/src/my-date-picker/interfaces/my-day-labels.interface.ts) | 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' } | [IMyMonthLabels](https://github.com/kekeh/mydatepicker/blob/master/src/my-date-picker/interfaces/my-month-labels.interface.ts) | Month labels visible on the selector. |
| __dateFormat__ | yyyy-mm-dd | string | 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 | boolean | Show 'Today' button on calendar. |
| __todayBtnTxt__ | Today | string | Today button text. Can be used if __showTodayBtn = true__. |
| __firstDayOfWeek__ | mo | string | First day of week on calendar. One of the following: mo, tu, we, th, fr, sa, su |
| __sunHighlight__ | true | boolean | Sunday red colored on calendar. |
| __markCurrentDay__ | true | boolean | Is current day (today) marked on calendar. |
| __monthSelector__ | true | boolean | If month label is selected opens a selector of months. |
| __yearSelector__ | true | boolean | If year label is selected opens a selector of years. |
| __minYear__ | 1000 | number | Minimum allowed year in calendar. Cannot be less than 1000. |
| __maxYear__ | 9999 | number | Maximum allowed year in calendar. Cannot be more than 9999. |
| __disableUntil__ | no default value | [IMyDate](https://github.com/kekeh/mydatepicker/blob/master/src/my-date-picker/interfaces/my-date.interface.ts) | Disable dates backward starting from the given date. For example: {year: 2016, month: 6, day: 26} |
| __disableSince__ | no default value | [IMyDate](https://github.com/kekeh/mydatepicker/blob/master/src/my-date-picker/interfaces/my-date.interface.ts) | Disable dates forward starting from the given date. For example: {year: 2016, month: 7, day: 22} |
| __disableDays__ | no default value | Array<[IMyDate](https://github.com/kekeh/mydatepicker/blob/master/src/my-date-picker/interfaces/my-date.interface.ts)> | 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 | Array<[IMyDate](https://github.com/kekeh/mydatepicker/blob/master/src/my-date-picker/interfaces/my-date.interface.ts)> | 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}] |
| __disableDateRanges__ | no default value | Array<[IMyDateRange](https://github.com/kekeh/mydatepicker/blob/master/src/my-date-picker/interfaces/my-date-range.interface.ts)> | Disable date ranges. For example: [{begin: {year: 2016, month: 11, day: 14}, end: {year: 2016, month: 11, day: 20}}] |
| __disableWeekends__ | false | boolean | Disable weekends (Saturday and Sunday). |
| __markDates__ | no default value | Array<[IMyMarkedDates](https://github.com/kekeh/mydatepicker/blob/master/src/my-date-picker/interfaces/my-marked-dates.interface.ts)> | Mark dates for different colors. For example: [{dates: [{year: 2016, month: 11, day: 14}, {year: 2016, month: 12, day: 16}], color: '#004198'}, {dates: [{year: 2017, month: 10, day: 1}, {year: 2017, month: 11, day: 4}], color: 'green'}] |
| __markWeekends__ | false | [IMyMarkedDate](https://github.com/kekeh/mydatepicker/blob/master/src/my-date-picker/interfaces/my-marked-date.interface.ts) | Mark weekends (Saturday and Sunday). For example: {marked: true, color: 'red'}. Value of color can be any CSS color code. |
| __disableHeaderButtons__ | true | boolean | Prevent to change the calendar view with header buttons if previous or next month are fully disabled by disableUntil or disableSince. |
| __showWeekNumbers__ | false | boolean | Are week numbers visible or not on calendar. Can be used if __firstDayOfWeek = mo__. |
| __inline__ | false | boolean | Show mydatepicker in inline mode. |
| __showClearDateBtn__ | true | boolean | Is clear date button shown or not. Can be used if __inline = false__. |
| __showDecreaseDateBtn__ | false | boolean | Is decrease date button shown or not. Can be used if __inline = false__. |
| __showIncreaseDateBtn__ | false | boolean | Is increase date button shown or not. Can be used if __inline = false__. |
| __height__ | 34px | string | mydatepicker height in without selector. Can be used if __inline = false__. |
| __width__ | 100% | string | mydatepicker width. Can be used if __inline = false__. |
| __selectionTxtFontSize__ | 14px | string | Selection area font size. Can be used if __inline = false__. |
| __alignSelectorRight__ | false | boolean | Align selector right. Can be used if __inline = false__. |
| __openSelectorTopOfInput__ | false | boolean | 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 | boolean | If user typed date is not same format as __dateFormat__, show red background in the selection area. Can be used if __inline = false__. |
| __componentDisabled__ | false | boolean | Is selection area input field and buttons disabled or not (input disabled flag). You can also disable component by __disabled__ attribute. Can be used if __inline = false__. |
| __editableDateField__ | true | boolean | Is selection area input field editable or not (input readonly flag). Can be used if __inline = false__. |
| __showSelectorArrow__ | true | boolean | Is selector (calendar) arrow shown or not. Can be used if __inline = false__. |
| __showInputField__ | true | boolean | Is selection area input field shown or not. If not, just show the icon. Can be used if __inline = false__. |
| __openSelectorOnInputClick__ | false | boolean | Open selector when the input field is clicked. Can be used if __inline = false and editableDateField = false__. |
| __ariaLabelInputField__ | Date input field | string | Aria label text of input field. |
| __ariaLabelClearDate__ | Clear Date | string | Aria label text of clear date button. |
| __ariaLabelDecreaseDate__ | Decrease Date | string | Aria label text of decrease date button. |
| __ariaLabelIncreaseDate__ | Increase Date | string | Aria label text of increase date button. |
| __ariaLabelOpenCalendar__ | Open Calendar | string | Aria label text of open calendar button. |
| __ariaLabelPrevMonth__ | Previous Month | string | Aria label text of previous month button. |
| __ariaLabelNextMonth__ | Next Month | string | Aria label text of next month button. |
| __ariaLabelPrevYear__ | Previous Year | string | Aria label text of previous year button. |
| __ariaLabelNextYear__ | Next Year | string | Aria label text of next year button. |
* Example of the options data (not all properties listed):
```ts
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',
disableUntil: {year: 2016, month: 8, day: 10}
};
```
### 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__, __cs__, __el__ and __kk__.
The __locale__ options can be override by __options__ attribute.
* new locale data can be added to [this](https://github.com/kekeh/mydatepicker/blob/master/src/my-date-picker/services/my-date-picker.locale.service.ts)
file. If you want to add a new locale create a pull request.
* locales can be tested [here](http://kekeh.github.io/mydatepicker/#inlinemode)
### 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](https://github.com/kekeh/mydatepicker/blob/master/src/my-date-picker/interfaces/my-date.interface.ts) 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](https://github.com/kekeh/mydatepicker/wiki/Initialize-with-selDate-attribute) 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](https://github.com/kekeh/mydatepicker/wiki/Initialize-with-defaultMonth-attribute) is an example on how to use this attribute.
### placeholder attribute
Placeholder text in the input field. [Here](https://github.com/kekeh/mydatepicker/wiki/Set-placeholder) is an example on how to use this attribute.
### disabled attribute
Boolean value indicating is the component disabled or not. [Here](https://github.com/kekeh/mydatepicker/wiki/Disable-component-with-disabled-attribute) is an example on how to use this attribute.
### selector attribute
Selector can be opened or closed using this attribute. [Here](https://github.com/kekeh/mydatepicker/wiki/Open-selector-with-selector-attribute) is an example on how to use this attribute.
Another way is to call a function of mydatepicker. [Here](https://github.com/kekeh/mydatepicker/wiki/Calling-date-picker-function) 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](https://github.com/kekeh/mydatepicker/blob/master/src/my-date-picker/interfaces/my-date-model.interface.ts)
* Example of the dateChanged callback:
```js
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](https://github.com/kekeh/mydatepicker/blob/master/src/my-date-picker/interfaces/my-input-field-changed.interface.ts)
* Example of the input field changed callback:
```js
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](https://github.com/kekeh/mydatepicker/blob/master/src/my-date-picker/interfaces/my-weekday.interface.ts). For example: {number: 1, weekday: "tu"}
* event.last: Last day of selected month and year. Type of [IMyWeekday](https://github.com/kekeh/mydatepicker/blob/master/src/my-date-picker/interfaces/my-weekday.interface.ts). For example: {number: 30, weekday: "we"}
* event parameter type is [IMyCalendarViewChanged](https://github.com/kekeh/mydatepicker/blob/master/src/my-date-picker/interfaces/my-calendar-view-changed.interface.ts)
* values of the weekday property are same as values of the __firstDayOfWeek__ option
* Example of the calendar view changed callback:
```js
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)
* 5 = calendar closed by ESC key
* Example of the calendar toggle callback:
```js
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](https://github.com/kekeh/mydatepicker/blob/master/src/my-date-picker/interfaces/my-input-focus-blur.interface.ts)
* Example of the input focus blur callback:
```js
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](https://github.com/kekeh/mydatepicker/tree/master/sampleapp) of the component contain an example:
* [override.css](https://github.com/kekeh/mydatepicker/blob/master/sampleapp/override.css) contain the changed styles.
* [index.html](https://github.com/kekeh/mydatepicker/blob/master/sampleapp/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: __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](http://kekeh.github.io/mydatepicker)
## Compatibility (tested with)
* Firefox (latest)
* Chrome (latest)
* Chromium (latest)
* Edge
* IE11
* Safari
## License
* License: MIT
## Author
* Author: kekeh
* Modified by: Satit
## Keywords
* Date picker
* Angular2
* Angular4