UNPKG

@uplink-protocol/calendar-controller

Version:

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

github.com/jmkcoder/uplink-protocol-calendar

jmkcoder/uplink-protocol-calendar

143 lines (72 loc) • 4.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
[**@uplink-protocol/form-controller v0.3.1**](../README.md) *** [@uplink-protocol/form-controller](../globals.md) / TimeControllerBindings # Interface: TimeControllerBindings Defined in: [Time/types/time-controller.types.ts:19](https://github.com/jmkcoder/uplink-protocol-calendar/blob/4cde26f472352440ee258db7670fce2e95651862/src/Time/types/time-controller.types.ts#L19) Time Controller Bindings - Reactive state properties These bindings automatically update the UI when time state changes ## Properties ### currentTime > **currentTime**: `Binding`\<`Date`\> Defined in: [Time/types/time-controller.types.ts:30](https://github.com/jmkcoder/uplink-protocol-calendar/blob/4cde26f472352440ee258db7670fce2e95651862/src/Time/types/time-controller.types.ts#L30) Current time being displayed *** ### focusedSegment > **focusedSegment**: `Binding`\<`"hours"` \| `"minutes"` \| `"seconds"` \| `"milliseconds"` \| `"period"` \| `null`\> Defined in: [Time/types/time-controller.types.ts:27](https://github.com/jmkcoder/uplink-protocol-calendar/blob/4cde26f472352440ee258db7670fce2e95651862/src/Time/types/time-controller.types.ts#L27) Currently focused time segment (for accessibility) *** ### formattedTime > **formattedTime**: `Binding`\<`string`\> Defined in: [Time/types/time-controller.types.ts:33](https://github.com/jmkcoder/uplink-protocol-calendar/blob/4cde26f472352440ee258db7670fce2e95651862/src/Time/types/time-controller.types.ts#L33) Formatted time string for display *** ### isRangeSelection > **isRangeSelection**: `Binding`\<`boolean`\> Defined in: [Time/types/time-controller.types.ts:57](https://github.com/jmkcoder/uplink-protocol-calendar/blob/4cde26f472352440ee258db7670fce2e95651862/src/Time/types/time-controller.types.ts#L57) Whether range selection mode is enabled *** ### locale > **locale**: `Binding`\<`string`\> Defined in: [Time/types/time-controller.types.ts:54](https://github.com/jmkcoder/uplink-protocol-calendar/blob/4cde26f472352440ee258db7670fce2e95651862/src/Time/types/time-controller.types.ts#L54) Current locale for internationalization *** ### minuteStep > **minuteStep**: `Binding`\<`number`\> Defined in: [Time/types/time-controller.types.ts:60](https://github.com/jmkcoder/uplink-protocol-calendar/blob/4cde26f472352440ee258db7670fce2e95651862/src/Time/types/time-controller.types.ts#L60) Minute step interval *** ### secondStep > **secondStep**: `Binding`\<`number`\> Defined in: [Time/types/time-controller.types.ts:63](https://github.com/jmkcoder/uplink-protocol-calendar/blob/4cde26f472352440ee258db7670fce2e95651862/src/Time/types/time-controller.types.ts#L63) Second step interval *** ### selectedTime > **selectedTime**: `Binding`\<`Date` \| `null`\> Defined in: [Time/types/time-controller.types.ts:21](https://github.com/jmkcoder/uplink-protocol-calendar/blob/4cde26f472352440ee258db7670fce2e95651862/src/Time/types/time-controller.types.ts#L21) Currently selected time (null if no time selected) *** ### selectedTimeRange > **selectedTimeRange**: `Binding`\<[`TimeRange`](TimeRange.md)\> Defined in: [Time/types/time-controller.types.ts:24](https://github.com/jmkcoder/uplink-protocol-calendar/blob/4cde26f472352440ee258db7670fce2e95651862/src/Time/types/time-controller.types.ts#L24) Selected time range (for range selection mode) *** ### showMilliseconds > **showMilliseconds**: `Binding`\<`boolean`\> Defined in: [Time/types/time-controller.types.ts:51](https://github.com/jmkcoder/uplink-protocol-calendar/blob/4cde26f472352440ee258db7670fce2e95651862/src/Time/types/time-controller.types.ts#L51) Whether to show milliseconds in time picker *** ### showSeconds > **showSeconds**: `Binding`\<`boolean`\> Defined in: [Time/types/time-controller.types.ts:48](https://github.com/jmkcoder/uplink-protocol-calendar/blob/4cde26f472352440ee258db7670fce2e95651862/src/Time/types/time-controller.types.ts#L48) Whether to show seconds in time picker *** ### timeSegments > **timeSegments**: `Binding`\<\{ `hours`: [`TimeSegment`](TimeSegment.md)[]; `milliseconds?`: [`TimeSegment`](TimeSegment.md)[]; `minutes`: [`TimeSegment`](TimeSegment.md)[]; `period?`: [`TimePeriod`](TimePeriod.md); `seconds`: [`TimeSegment`](TimeSegment.md)[]; \}\> Defined in: [Time/types/time-controller.types.ts:36](https://github.com/jmkcoder/uplink-protocol-calendar/blob/4cde26f472352440ee258db7670fce2e95651862/src/Time/types/time-controller.types.ts#L36) Time segments for UI rendering *** ### use12HourFormat > **use12HourFormat**: `Binding`\<`boolean`\> Defined in: [Time/types/time-controller.types.ts:45](https://github.com/jmkcoder/uplink-protocol-calendar/blob/4cde26f472352440ee258db7670fce2e95651862/src/Time/types/time-controller.types.ts#L45) Whether using 12-hour format