UNPKG

@uplink-protocol/calendar-controller

Version:

Flexible calendar API supporting both calendar and date-picker integrations for any JavaScript framework or library

github.com/jmkcoder/uplink-protocol-calendar

jmkcoder/uplink-protocol-calendar

147 lines (74 loc) • 3.03 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
[**@uplink-protocol/form-controller v0.2.1**](../README.md) *** [@uplink-protocol/form-controller](../globals.md) / IInitializationService # Interface: IInitializationService Defined in: [interfaces/initialization.service.interfaces.ts:14](https://github.com/jmkcoder/uplink-protocol-calendar/blob/311e0b81efba7399cf1c367c0a2007aa66f3b830/src/interfaces/initialization.service.interfaces.ts#L14) Interface for component initialization service Responsible for setting up and initializing calendar components ## Methods ### applyConfiguration() > **applyConfiguration**(`options`, `locale`, `calendarService`, `dateFormattingService`, `localizationService`): `object` Defined in: [interfaces/initialization.service.interfaces.ts:34](https://github.com/jmkcoder/uplink-protocol-calendar/blob/311e0b81efba7399cf1c367c0a2007aa66f3b830/src/interfaces/initialization.service.interfaces.ts#L34) Apply calendar configuration options #### Parameters ##### options `undefined` | [`CalendarOptions`](CalendarOptions.md) ##### locale `string` ##### calendarService [`ICalendarService`](ICalendarService.md) ##### dateFormattingService [`IDateFormattingService`](IDateFormattingService.md) ##### localizationService [`ILocalizationService`](ILocalizationService.md) #### Returns `object` ##### dateFormat > **dateFormat**: `null` \| `string` ##### disabledDates > **disabledDates**: `Date`[] ##### firstDayOfWeek > **firstDayOfWeek**: `number` ##### hideOtherMonthDays > **hideOtherMonthDays**: `boolean` ##### locale > **locale**: `string` ##### localizationService > **localizationService**: [`ILocalizationService`](ILocalizationService.md) ##### maxDate > **maxDate**: `null` \| `Date` ##### minDate > **minDate**: `null` \| `Date` ##### selectedDate > **selectedDate**: `null` \| `Date` *** ### initializeBindings() > **initializeBindings**(`currentDate`, `selectedDate`, `selectedDateRange`, `firstDayOfWeek`, `isRangeSelection`, `calendarDaysGenerator`, `getMonthNameFn`, `getWeekdayNamesFn`, `generateCalendarMonthsFn`, `generateCalendarYearsFn`): `Record`\<`string`, `Binding`\<`any`\>\> Defined in: [interfaces/initialization.service.interfaces.ts:18](https://github.com/jmkcoder/uplink-protocol-calendar/blob/311e0b81efba7399cf1c367c0a2007aa66f3b830/src/interfaces/initialization.service.interfaces.ts#L18) Initialize view state bindings and initial values #### Parameters ##### currentDate `Date` ##### selectedDate `null` | `Date` ##### selectedDateRange ###### endDate `null` \| `Date` ###### startDate `null` \| `Date` ##### firstDayOfWeek `number` ##### isRangeSelection `boolean` ##### calendarDaysGenerator () => [`CalendarDate`](CalendarDate.md)[] ##### getMonthNameFn (`month`) => `string` ##### getWeekdayNamesFn (`firstDayOfWeek`) => `string`[] ##### generateCalendarMonthsFn () => [`CalendarMonth`](CalendarMonth.md)[] ##### generateCalendarYearsFn () => [`CalendarYear`](CalendarYear.md)[] #### Returns `Record`\<`string`, `Binding`\<`any`\>\>