📅 ion2-calendar

[![NPM version][npm-image]][npm-url]
[![Downloads][downloads-image]][downloads-url]
[![MIT License][license-image]][license-url]

!date

> English is not my native language; please excuse typing errors.
> 中文文档

- Support date range.
- Support multi date.
- Support HTML components.
- Disable weekdays or weekends.
- Setting days event.
- Setting localization.
- Material design.

Support

- ionic-angular ^3.0.0 2.x
- @ionic/angular 4.0.0

Demo

live demo click me.

Usage

$3

$ npm install ion2-calendar moment --save

$3

``typescript
import { NgModule } from '@angular/core';
import { IonicApp, IonicModule } from '@ionic/angular';
import { MyApp } from './app.component';
...
import { CalendarModule } from 'ion2-calendar';

@NgModule({
declarations: [
MyApp,
...
],
imports: [
IonicModule.forRoot(),
CalendarModule
],
bootstrap: [MyApp],
...
})
export class AppModule {}
`

$3

`typescript
import { NgModule } from '@angular/core';
import { IonicApp, IonicModule } from 'ionic-angular';
import { MyApp } from './app.component';
...
import { CalendarModule } from "ion2-calendar";

@NgModule({
declarations: [
MyApp,
...
],
imports: [
IonicModule.forRoot(MyApp),
// See CalendarComponentOptions for options
CalendarModule.forRoot({
doneLabel: 'Save',
closeIcon: true
})
],
bootstrap: [IonicApp],
entryComponents: [
MyApp,
...
]
})
export class AppModule {}
`

Components Mode

$3

`html
(change)="onChange($event)"
[type]="type"
[format]="'YYYY-MM-DD'">

`

`typescript
import { Component } from '@angular/core';

@Component({
selector: 'page-home',
templateUrl: 'home.html'
})
export class HomePage {
date: string;
type: 'string'; // 'string' | 'js-date' | 'moment' | 'time' | 'object'
constructor() { }

onChange($event) {
console.log($event);
}
...
}
`

$3

`html
[options]="optionsRange"
[type]="type"
[format]="'YYYY-MM-DD'">

`

`typescript
import { Component } from '@angular/core';
import { CalendarComponentOptions } from 'ion2-calendar';

@Component({
selector: 'page-home',
templateUrl: 'home.html'
})
export class HomePage {
dateRange: { from: string; to: string; };
type: 'string'; // 'string' | 'js-date' | 'moment' | 'time' | 'object'
optionsRange: CalendarComponentOptions = {
pickMode: 'range'
};

constructor() { }
...
}
`

$3

`html
[options]="optionsMulti"
[type]="type"
[format]="'YYYY-MM-DD'">

`

`typescript
import { Component } from '@angular/core';
import { CalendarComponentOptions } from 'ion2-calendar';

@Component({
selector: 'page-home',
templateUrl: 'home.html'
})
export class HomePage {
dateMulti: string[];
type: 'string'; // 'string' | 'js-date' | 'moment' | 'time' | 'object'
optionsMulti: CalendarComponentOptions = {
pickMode: 'multi'
};

constructor() { }
...
}
`

$3

| Name | Type | Default | Description |
| -------- | ------------------------ | ------------ | ------------ |
| options | CalendarComponentOptions | null | options |
| format | string | 'YYYY-MM-DD' | value format |
| type | string | 'string' | value type |
| readonly | boolean | false | readonly |

$3

| Name | Type | Description |
| ----------- | ------------ | -------------------------- |
| change | EventEmitter | event for model change |
| monthChange | EventEmitter | event for month change |
| select | EventEmitter | event for click day-button |
| selectStart | EventEmitter | event for click day-button |
| selectEnd | EventEmitter | event for click day-button |

$3

| Name | Type | Default | Description |
| ----------------- | ----------------------- | -------------------------------------------------------------------------------------- | ------------------------------------------------- |
| from | Date | new Date() | start date |
| to | Date | 0 (Infinite) | end date |
| color | string | 'primary' | 'primary', 'secondary', 'danger', 'light', 'dark' |
| pickMode | string | single | 'multi', 'range', 'single' |
| showToggleButtons | boolean | true | show toggle buttons |
| showMonthPicker | boolean | true | show month picker |
| monthPickerFormat | Array | ['JAN', 'FEB', 'MAR', 'APR', 'MAY', 'JUN', 'JUL', 'AUG', 'SEP', 'OCT', 'NOV', 'DEC'] | month picker format |
| defaultTitle | string | '' | default title in days |
| defaultSubtitle | string | '' | default subtitle in days |
| disableWeeks | Array | [] | week to be disabled (0-6) |
| monthFormat | string | 'MMM YYYY' | month title format |
| weekdays | Array | ['S', 'M', 'T', 'W', 'T', 'F', 'S'] | weeks text |
| weekStart | number | 0 (0 or 1) | set week start day |
| daysConfig | Array<_DaysConfig_> | [] | days configuration |

Modal Mode

$3

Import ion2-calendar in component controller.

`typescript
import { Component } from '@angular/core';
import { ModalController } from '@ionic/angular';
import {
CalendarModal,
CalendarModalOptions,
DayConfig,
CalendarResult
} from 'ion2-calendar';

@Component({
selector: 'page-home',
templateUrl: 'home.html'
})
export class HomePage {
constructor(public modalCtrl: ModalController) {}

openCalendar() {
const options: CalendarModalOptions = {
title: 'BASIC'
};

const myCalendar = await this.modalCtrl.create({
component: CalendarModal,
componentProps: { options }
});

myCalendar.present();

const event: any = await myCalendar.onDidDismiss();
const date: CalendarResult = event.data;
console.log(date);
}
}
`

$3

Set pickMode to 'range'.

`typescript
openCalendar() {
const options: CalendarModalOptions = {
pickMode: 'range',
title: 'RANGE'
};

const myCalendar = await this.modalCtrl.create({
component: CalendarModal,
componentProps: { options }
});

myCalendar.present();

const event: any = await myCalendar.onDidDismiss();
const date = event.data;
const from: CalendarResult = date.from;
const to: CalendarResult = date.to;

console.log(date, from, to);
}
`

$3

Set pickMode to 'multi'.

`typescript
openCalendar() {
const options = {
pickMode: 'multi',
title: 'MULTI'
};

const myCalendar = await this.modalCtrl.create({
component: CalendarModal,
componentProps: { options }
});

myCalendar.present();

const event: any = await myCalendar.onDidDismiss();
const date: CalendarResult = event.data;
console.log(date);
}
`

$3

Use index eg: [0, 6] denote Sunday and Saturday.

`typescript
openCalendar() {
const options: CalendarModalOptions = {
disableWeeks: [0, 6]
};

const myCalendar = await this.modalCtrl.create({
component: CalendarModal,
componentProps: { options }
});

myCalendar.present();

const event: any = await myCalendar.onDidDismiss();
const date: CalendarResult = event.data;
console.log(date);
}
`

$3

your root module

`typescript
import { NgModule, LOCALE_ID } from '@angular/core';
...

@NgModule({
...
providers: [{ provide: LOCALE_ID, useValue: "zh-CN" }]
})

...
`

`typescript
openCalendar() {
const options: CalendarModalOptions = {
monthFormat: 'YYYY 年 MM 月 ',
weekdays: ['天', '一', '二', '三', '四', '五', '六'],
weekStart: 1,
defaultDate: new Date()
};

const myCalendar = await this.modalCtrl.create({
component: CalendarModal,
componentProps: { options }
});

myCalendar.present();

const event: any = await myCalendar.onDidDismiss();
const date: CalendarResult = event.data;
console.log(date);
}
`

$3

Configure one day.

`typescript
openCalendar() {
let _daysConfig: DayConfig[] = [];
for (let i = 0; i < 31; i++) {
_daysConfig.push({
date: new Date(2017, 0, i + 1),
subTitle: $${i + 1}
})
}

const options: CalendarModalOptions = {
from: new Date(2017, 0, 1),
to: new Date(2017, 11.1),
daysConfig: _daysConfig
};

const myCalendar = await this.modalCtrl.create({
component: CalendarModal,
componentProps: { options }
});

myCalendar.present();

const event: any = await myCalendar.onDidDismiss();
const date: CalendarResult = event.data;
console.log(date);
}
`

API

$3

| Name | Type | Default | Description |
| ------------------------- | ------------------------ | ------------------------------------- | ---------------------------------------------------------- |
| from | Date | new Date() | start date |
| to | Date | 0 (Infinite) | end date |
| title | string | 'CALENDAR' | title |
| color | string | 'primary' | 'primary', 'secondary', 'danger', 'light', 'dark' |
| defaultScrollTo | Date | none | let the view scroll to the default date |
| defaultDate | Date | none | default date data, apply to single |
| defaultDates | Array | none | default dates data, apply to multi |
| defaultDateRange | { from: Date, to: Date } | none | default date-range data, apply to range |
| defaultTitle | string | '' | default title in days |
| defaultSubtitle | string | '' | default subtitle in days |
| cssClass | string | '' | Additional classes for custom styles, separated by spaces. |
| canBackwardsSelected | boolean | false | can backwards selected |
| pickMode | string | single | 'multi', 'range', 'single' |
| disableWeeks | Array | [] | week to be disabled (0-6) |
| closeLabel | string | CANCEL | cancel button label |
| doneLabel | string | DONE | done button label |
| clearLabel | string | null | clear button label |
| closeIcon | boolean | false | show cancel button icon |
| doneIcon | boolean | false | show done button icon |
| monthFormat | string | 'MMM YYYY' | month title format |
| weekdays | Array | ['S', 'M', 'T', 'W', 'T', 'F', 'S'] | weeks text |
| weekStart | number | 0 (0 or 1) | set week start day |
| daysConfig | Array<_DaysConfig_> | [] | days configuration |
| step | number | 12 | month load stepping interval to when scroll |
| defaultEndDateToStartDate | boolean | false | makes the end date optional, will default it to the start |

$3

| pickMode | Type |
| -------- | -------------------------------------------------------- |
| single | { date: _CalendarResult_ } |
| range | { from: _CalendarResult_, to: _CalendarResult_ } |
| multi | Array<_CalendarResult_> |

$3

| Value | Description |
| ---------- | ------------------------------------ |
| 'cancel' | dismissed by click the cancel button |
| 'done' | dismissed by click the done button |
| 'backdrop' | dismissed by click the backdrop |

#### DaysConfig

| Name | Type | Default | Description |
| -------- | ------- | -------- | ------------------------------------- |
| cssClass | string | '' | separated by spaces |
| date | Date | required | configured days |
| marked | boolean | false | highlight color |
| disable | boolean | false | disable |
| title | string | none | displayed title eg: 'today' |
| subTitle | string | none | subTitle subTitle eg: 'New Year\'s'` |

$3

| Name | Type |
| ------- | ------ |
| time | number |
| unix | number |
| dateObj | Date |
| string | string |
| years | number |
| months | number |
| date | number |

Thanks for reading

[npm-url]: https://www.npmjs.com/package/ion2-calendar
[npm-image]: https://img.shields.io/npm/v/ion2-calendar.svg
[downloads-image]: https://img.shields.io/npm/dm/ion2-calendar.svg
[downloads-url]: http://badge.fury.io/js/ion2-calendar
[license-image]: http://img.shields.io/badge/license-MIT-blue.svg?style=flat
[license-url]: LICENSE