Skip to content

Commit c5533de

Browse files
authoredJan 8, 2018
adding day-calendar api to documentation (#331)
* adding day-calendar api to documentation * fixing build
1 parent c39080e commit c5533de

7 files changed

+18
-9
lines changed
 

‎README.md

+8
Original file line numberDiff line numberDiff line change
@@ -221,6 +221,14 @@ Here are the available configurations:
221221

222222
You can use the `<dp-month-calendar>` component to display the calendar widget without an associated input box.
223223

224+
Here is the list of APIs:
225+
226+
| Name | Signature | Description |
227+
|----------------------|:-----------------------------------------------------------------------------------:|----------------------------------|
228+
| moveCalendarsBy | `(current: Moment, amount: number, granularity: moment.unitOfTime.Base) => void` | Moves calendar by given amount |
229+
| moveCalendarTo | `(to: Moment \| String) => void` | Moves calendar to specific date |
230+
| toggleCalendarMode | `(mode: day \| month) => void` | Changes clander mode day/month |
231+
224232
i.e.
225233
```html
226234
<dp-month-calendar [(ngModel)]="selectedDate" [config]="config"></dp-month-calendar>

‎src/app/date-picker/date-picker.component.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -394,7 +394,7 @@ export class DatePickerComponent implements OnChanges,
394394
this.areCalendarsShown = false;
395395

396396
if (this.dayCalendarRef) {
397-
this.dayCalendarRef.api.toggleCalendar(ECalendarMode.Day);
397+
this.dayCalendarRef.api.toggleCalendarMode(ECalendarMode.Day);
398398
}
399399

400400
this.close.emit();

‎src/app/day-calendar/day-calendar.component.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
[theme]="theme"
99
(onLeftNav)="onLeftNav()"
1010
(onRightNav)="onRightNav()"
11-
(onLabelClick)="toggleCalendar(CalendarMode.Month)"
11+
(onLabelClick)="toggleCalendarMode(CalendarMode.Month)"
1212
(onGoToCurrent)="goToCurrent()">
1313
</dp-calendar-nav>
1414

@@ -43,5 +43,5 @@
4343
[displayDate]="_currentDateView"
4444
[theme]="theme"
4545
(onSelect)="monthSelected($event)"
46-
(onNavHeaderBtnClick)="toggleCalendar(CalendarMode.Day)">
46+
(onNavHeaderBtnClick)="toggleCalendarMode(CalendarMode.Day)">
4747
</dp-month-calendar>

‎src/app/day-calendar/day-calendar.component.ts

+3-3
Original file line numberDiff line numberDiff line change
@@ -87,8 +87,8 @@ export class DayCalendarComponent implements OnInit, OnChanges, ControlValueAcce
8787

8888
api = {
8989
moveCalendarsBy: this.moveCalendarsBy.bind(this),
90-
toggleCalendar: this.toggleCalendar.bind(this),
91-
moveCalendarTo: this.moveCalendarTo.bind(this)
90+
moveCalendarTo: this.moveCalendarTo.bind(this),
91+
toggleCalendarMode: this.toggleCalendarMode.bind(this)
9292
};
9393

9494
set selected(selected: Moment[]) {
@@ -258,7 +258,7 @@ export class DayCalendarComponent implements OnInit, OnChanges, ControlValueAcce
258258
return weekday.format(this.componentConfig.weekDayFormat);
259259
}
260260

261-
toggleCalendar(mode: ECalendarMode) {
261+
toggleCalendarMode(mode: ECalendarMode) {
262262
if (this.currentCalendarMode !== mode) {
263263
this.currentCalendarMode = mode;
264264
this.onNavHeaderBtnClick.emit(mode);

‎src/app/index.ts

+1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
export {SingleCalendarValue} from './common/types/single-calendar-value';
12
export {IDate} from './common/models/date.model';
23
export {ECalendarMode} from './common/types/calendar-mode-enum';
34
export {IDay} from './day-calendar/day.model';

‎src/app/month-calendar/month-calendar.component.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
(onLeftSecondaryNav)="onLeftSecondaryNav()"
1313
(onRightNav)="onRightNav()"
1414
(onRightSecondaryNav)="onRightSecondaryNav()"
15-
(onLabelClick)="toggleCalendar()"
15+
(onLabelClick)="toggleCalendarMode()"
1616
(onGoToCurrent)="goToCurrent()">
1717
</dp-calendar-nav>
1818

‎src/app/month-calendar/month-calendar.component.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ export class MonthCalendarComponent implements OnInit, OnChanges, ControlValueAc
7979
showSecondaryRightNav: boolean;
8080

8181
api = {
82-
toggleCalendar: this.toggleCalendar.bind(this),
82+
toggleCalendar: this.toggleCalendarMode.bind(this),
8383
moveCalendarTo: this.moveCalendarTo.bind(this)
8484
};
8585

@@ -242,7 +242,7 @@ export class MonthCalendarComponent implements OnInit, OnChanges, ControlValueAc
242242
this.currentDateView = this.currentDateView.clone().add(navigateBy, 'year');
243243
}
244244

245-
toggleCalendar() {
245+
toggleCalendarMode() {
246246
this.onNavHeaderBtnClick.emit();
247247
}
248248

0 commit comments

Comments
 (0)
Please sign in to comment.