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

143 lines (72 loc) • 4.66 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
[**@uplink-protocol/form-controller v0.2.1**](../README.md) *** [@uplink-protocol/form-controller](../globals.md) / CalendarControllerBindings # Interface: CalendarControllerBindings Defined in: [types/calendar-controller.types.ts:20](https://github.com/jmkcoder/uplink-protocol-calendar/blob/311e0b81efba7399cf1c367c0a2007aa66f3b830/src/types/calendar-controller.types.ts#L20) Calendar Controller Bindings - Reactive state properties These bindings automatically update the UI when calendar state changes ## Properties ### calendarDays > **calendarDays**: `Binding`\<[`CalendarDate`](CalendarDate.md)[]\> Defined in: [types/calendar-controller.types.ts:43](https://github.com/jmkcoder/uplink-protocol-calendar/blob/311e0b81efba7399cf1c367c0a2007aa66f3b830/src/types/calendar-controller.types.ts#L43) Array of calendar days for the current month view *** ### calendarMonths > **calendarMonths**: `Binding`\<[`CalendarMonth`](CalendarMonth.md)[]\> Defined in: [types/calendar-controller.types.ts:46](https://github.com/jmkcoder/uplink-protocol-calendar/blob/311e0b81efba7399cf1c367c0a2007aa66f3b830/src/types/calendar-controller.types.ts#L46) Array of calendar months for the year view *** ### calendarYears > **calendarYears**: `Binding`\<[`CalendarYear`](CalendarYear.md)[]\> Defined in: [types/calendar-controller.types.ts:49](https://github.com/jmkcoder/uplink-protocol-calendar/blob/311e0b81efba7399cf1c367c0a2007aa66f3b830/src/types/calendar-controller.types.ts#L49) Array of calendar years for the decade view *** ### currentDate > **currentDate**: `Binding`\<`Date`\> Defined in: [types/calendar-controller.types.ts:31](https://github.com/jmkcoder/uplink-protocol-calendar/blob/311e0b81efba7399cf1c367c0a2007aa66f3b830/src/types/calendar-controller.types.ts#L31) Current date being displayed (navigation state) *** ### currentMonth > **currentMonth**: `Binding`\<`number`\> Defined in: [types/calendar-controller.types.ts:34](https://github.com/jmkcoder/uplink-protocol-calendar/blob/311e0b81efba7399cf1c367c0a2007aa66f3b830/src/types/calendar-controller.types.ts#L34) Current month number (0-based) *** ### currentYear > **currentYear**: `Binding`\<`number`\> Defined in: [types/calendar-controller.types.ts:37](https://github.com/jmkcoder/uplink-protocol-calendar/blob/311e0b81efba7399cf1c367c0a2007aa66f3b830/src/types/calendar-controller.types.ts#L37) Current year number *** ### currentYearRangeBase > **currentYearRangeBase**: `Binding`\<`number` \| [`YearRange`](YearRange.md)\> Defined in: [types/calendar-controller.types.ts:58](https://github.com/jmkcoder/uplink-protocol-calendar/blob/311e0b81efba7399cf1c367c0a2007aa66f3b830/src/types/calendar-controller.types.ts#L58) Current year range base for decade view *** ### focusedDate > **focusedDate**: `Binding`\<`null` \| `Date`\> Defined in: [types/calendar-controller.types.ts:28](https://github.com/jmkcoder/uplink-protocol-calendar/blob/311e0b81efba7399cf1c367c0a2007aa66f3b830/src/types/calendar-controller.types.ts#L28) Currently focused date (for accessibility) *** ### isRangeSelection > **isRangeSelection**: `Binding`\<`boolean`\> Defined in: [types/calendar-controller.types.ts:55](https://github.com/jmkcoder/uplink-protocol-calendar/blob/311e0b81efba7399cf1c367c0a2007aa66f3b830/src/types/calendar-controller.types.ts#L55) Whether range selection mode is enabled *** ### monthName > **monthName**: `Binding`\<`string`\> Defined in: [types/calendar-controller.types.ts:40](https://github.com/jmkcoder/uplink-protocol-calendar/blob/311e0b81efba7399cf1c367c0a2007aa66f3b830/src/types/calendar-controller.types.ts#L40) Current month name in the selected locale *** ### selectedDate > **selectedDate**: `Binding`\<`null` \| `Date`\> Defined in: [types/calendar-controller.types.ts:22](https://github.com/jmkcoder/uplink-protocol-calendar/blob/311e0b81efba7399cf1c367c0a2007aa66f3b830/src/types/calendar-controller.types.ts#L22) Currently selected date (null if no date selected) *** ### selectedDateRange > **selectedDateRange**: `Binding`\<[`DateRange`](DateRange.md)\> Defined in: [types/calendar-controller.types.ts:25](https://github.com/jmkcoder/uplink-protocol-calendar/blob/311e0b81efba7399cf1c367c0a2007aa66f3b830/src/types/calendar-controller.types.ts#L25) Selected date range (for range selection mode) *** ### weekdays > **weekdays**: `Binding`\<`string`[]\> Defined in: [types/calendar-controller.types.ts:52](https://github.com/jmkcoder/uplink-protocol-calendar/blob/311e0b81efba7399cf1c367c0a2007aa66f3b830/src/types/calendar-controller.types.ts#L52) Array of weekday names in the selected locale