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

167 lines (85 loc) • 3.78 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
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
[**@uplink-protocol/form-controller v0.2.1**](../README.md) *** [@uplink-protocol/form-controller](../globals.md) / ICalendarGeneratorService # Interface: ICalendarGeneratorService Defined in: [interfaces/calendar-generator.service.interfaces.ts:8](https://github.com/jmkcoder/uplink-protocol-calendar/blob/311e0b81efba7399cf1c367c0a2007aa66f3b830/src/interfaces/calendar-generator.service.interfaces.ts#L8) Calendar generator service interface Responsible for generating calendar days based on given options ## Methods ### generateCalendarDays() > **generateCalendarDays**(`year`, `month`, `options`): [`CalendarDate`](CalendarDate.md)[] Defined in: [interfaces/calendar-generator.service.interfaces.ts:12](https://github.com/jmkcoder/uplink-protocol-calendar/blob/311e0b81efba7399cf1c367c0a2007aa66f3b830/src/interfaces/calendar-generator.service.interfaces.ts#L12) Generate calendar days for a specified month/year #### Parameters ##### year `number` ##### month `number` ##### options [`CalendarGenerationOptions`](CalendarGenerationOptions.md) #### Returns [`CalendarDate`](CalendarDate.md)[] *** ### generateCalendarMonths() > **generateCalendarMonths**(`year`, `options`): [`CalendarMonth`](CalendarMonth.md)[] Defined in: [interfaces/calendar-generator.service.interfaces.ts:21](https://github.com/jmkcoder/uplink-protocol-calendar/blob/311e0b81efba7399cf1c367c0a2007aa66f3b830/src/interfaces/calendar-generator.service.interfaces.ts#L21) Generate calendar months for a specified year #### Parameters ##### year `number` ##### options [`MonthViewGenerationOptions`](MonthViewGenerationOptions.md) #### Returns [`CalendarMonth`](CalendarMonth.md)[] *** ### generateCalendarYears() > **generateCalendarYears**(`baseYear`, `rangeSize`, `options`): [`CalendarYear`](CalendarYear.md)[] Defined in: [interfaces/calendar-generator.service.interfaces.ts:29](https://github.com/jmkcoder/uplink-protocol-calendar/blob/311e0b81efba7399cf1c367c0a2007aa66f3b830/src/interfaces/calendar-generator.service.interfaces.ts#L29) Generate calendar years for a specified year range #### Parameters ##### baseYear `number` ##### rangeSize `number` ##### options [`YearViewGenerationOptions`](YearViewGenerationOptions.md) #### Returns [`CalendarYear`](CalendarYear.md)[] *** ### generateMonthView() > **generateMonthView**(`year`, `month`, `options`): `object` Defined in: [interfaces/calendar-generator.service.interfaces.ts:48](https://github.com/jmkcoder/uplink-protocol-calendar/blob/311e0b81efba7399cf1c367c0a2007aa66f3b830/src/interfaces/calendar-generator.service.interfaces.ts#L48) Generate a complete month view with proper structure for rendering Includes weeks and weekdays data #### Parameters ##### year `number` ##### month `number` ##### options [`CalendarGenerationOptions`](CalendarGenerationOptions.md) #### Returns `object` ##### month > **month**: `number` ##### weekdays > **weekdays**: `string`[] ##### weeks > **weeks**: `object`[] ##### year > **year**: `number` *** ### getCalendarDaysGenerator() > **getCalendarDaysGenerator**(`getCurrentDate`, `getCalendarOptions`): () => [`CalendarDate`](CalendarDate.md)[] Defined in: [interfaces/calendar-generator.service.interfaces.ts:39](https://github.com/jmkcoder/uplink-protocol-calendar/blob/311e0b81efba7399cf1c367c0a2007aa66f3b830/src/interfaces/calendar-generator.service.interfaces.ts#L39) Get calendar days generation function Returns a function that can be called to generate calendar days #### Parameters ##### getCurrentDate () => `Date` ##### getCalendarOptions () => [`CalendarGenerationOptions`](CalendarGenerationOptions.md) #### Returns > (): [`CalendarDate`](CalendarDate.md)[] ##### Returns [`CalendarDate`](CalendarDate.md)[]