@ukic/canary-docs 3.0.0-canary.23 → 3.0.0-canary.25
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/docs.json +724 -49
- package/package.json +2 -2
package/docs.json
CHANGED
|
@@ -5,6 +5,612 @@
|
|
|
5
5
|
"typescriptVersion": "5.5.4"
|
|
6
6
|
},
|
|
7
7
|
"components": [
|
|
8
|
+
{
|
|
9
|
+
"filePath": "src/components/ic-calendar/ic-calendar.tsx",
|
|
10
|
+
"encapsulation": "shadow",
|
|
11
|
+
"tag": "ic-calendar",
|
|
12
|
+
"readme": "# ic-calendar\n\n\n",
|
|
13
|
+
"docs": "",
|
|
14
|
+
"docsTags": [],
|
|
15
|
+
"usage": {},
|
|
16
|
+
"props": [
|
|
17
|
+
{
|
|
18
|
+
"name": "dateFormat",
|
|
19
|
+
"type": "\"DD/MM/YYYY\" | \"MM/DD/YYYY\" | \"YYYY/MM/DD\"",
|
|
20
|
+
"complexType": {
|
|
21
|
+
"original": "IcDateFormat",
|
|
22
|
+
"resolved": "\"DD/MM/YYYY\" | \"MM/DD/YYYY\" | \"YYYY/MM/DD\"",
|
|
23
|
+
"references": {
|
|
24
|
+
"IcDateFormat": {
|
|
25
|
+
"location": "import",
|
|
26
|
+
"path": "../../utils/types",
|
|
27
|
+
"id": "src/utils/types.ts::IcDateFormat"
|
|
28
|
+
}
|
|
29
|
+
}
|
|
30
|
+
},
|
|
31
|
+
"mutable": false,
|
|
32
|
+
"attr": "date-format",
|
|
33
|
+
"reflectToAttr": false,
|
|
34
|
+
"docs": "The format in which the date will be displayed.",
|
|
35
|
+
"docsTags": [],
|
|
36
|
+
"default": "\"DD/MM/YYYY\"",
|
|
37
|
+
"values": [
|
|
38
|
+
{
|
|
39
|
+
"value": "DD/MM/YYYY",
|
|
40
|
+
"type": "string"
|
|
41
|
+
},
|
|
42
|
+
{
|
|
43
|
+
"value": "MM/DD/YYYY",
|
|
44
|
+
"type": "string"
|
|
45
|
+
},
|
|
46
|
+
{
|
|
47
|
+
"value": "YYYY/MM/DD",
|
|
48
|
+
"type": "string"
|
|
49
|
+
}
|
|
50
|
+
],
|
|
51
|
+
"optional": false,
|
|
52
|
+
"required": false,
|
|
53
|
+
"getter": false,
|
|
54
|
+
"setter": false
|
|
55
|
+
},
|
|
56
|
+
{
|
|
57
|
+
"name": "disableDays",
|
|
58
|
+
"type": "IcWeekDays[] | undefined",
|
|
59
|
+
"complexType": {
|
|
60
|
+
"original": "IcWeekDays[]",
|
|
61
|
+
"resolved": "IcWeekDays[] | undefined",
|
|
62
|
+
"references": {
|
|
63
|
+
"IcWeekDays": {
|
|
64
|
+
"location": "import",
|
|
65
|
+
"path": "../../utils/types",
|
|
66
|
+
"id": "src/utils/types.ts::IcWeekDays"
|
|
67
|
+
}
|
|
68
|
+
}
|
|
69
|
+
},
|
|
70
|
+
"mutable": false,
|
|
71
|
+
"reflectToAttr": false,
|
|
72
|
+
"docs": "The days of the week to disable.",
|
|
73
|
+
"docsTags": [],
|
|
74
|
+
"default": "[]",
|
|
75
|
+
"values": [
|
|
76
|
+
{
|
|
77
|
+
"type": "IcWeekDays[]"
|
|
78
|
+
},
|
|
79
|
+
{
|
|
80
|
+
"type": "undefined"
|
|
81
|
+
}
|
|
82
|
+
],
|
|
83
|
+
"optional": true,
|
|
84
|
+
"required": false,
|
|
85
|
+
"getter": false,
|
|
86
|
+
"setter": false
|
|
87
|
+
},
|
|
88
|
+
{
|
|
89
|
+
"name": "disableFuture",
|
|
90
|
+
"type": "boolean | undefined",
|
|
91
|
+
"complexType": {
|
|
92
|
+
"original": "boolean",
|
|
93
|
+
"resolved": "boolean | undefined",
|
|
94
|
+
"references": {}
|
|
95
|
+
},
|
|
96
|
+
"mutable": false,
|
|
97
|
+
"attr": "disable-future",
|
|
98
|
+
"reflectToAttr": false,
|
|
99
|
+
"docs": "If `true`, dates in the future are not allowed.",
|
|
100
|
+
"docsTags": [],
|
|
101
|
+
"default": "false",
|
|
102
|
+
"values": [
|
|
103
|
+
{
|
|
104
|
+
"type": "boolean"
|
|
105
|
+
},
|
|
106
|
+
{
|
|
107
|
+
"type": "undefined"
|
|
108
|
+
}
|
|
109
|
+
],
|
|
110
|
+
"optional": true,
|
|
111
|
+
"required": false,
|
|
112
|
+
"getter": false,
|
|
113
|
+
"setter": false
|
|
114
|
+
},
|
|
115
|
+
{
|
|
116
|
+
"name": "disablePast",
|
|
117
|
+
"type": "boolean | undefined",
|
|
118
|
+
"complexType": {
|
|
119
|
+
"original": "boolean",
|
|
120
|
+
"resolved": "boolean | undefined",
|
|
121
|
+
"references": {}
|
|
122
|
+
},
|
|
123
|
+
"mutable": false,
|
|
124
|
+
"attr": "disable-past",
|
|
125
|
+
"reflectToAttr": false,
|
|
126
|
+
"docs": "If `true`, dates in the past are not allowed.",
|
|
127
|
+
"docsTags": [],
|
|
128
|
+
"default": "false",
|
|
129
|
+
"values": [
|
|
130
|
+
{
|
|
131
|
+
"type": "boolean"
|
|
132
|
+
},
|
|
133
|
+
{
|
|
134
|
+
"type": "undefined"
|
|
135
|
+
}
|
|
136
|
+
],
|
|
137
|
+
"optional": true,
|
|
138
|
+
"required": false,
|
|
139
|
+
"getter": false,
|
|
140
|
+
"setter": false
|
|
141
|
+
},
|
|
142
|
+
{
|
|
143
|
+
"name": "disabled",
|
|
144
|
+
"type": "boolean",
|
|
145
|
+
"complexType": {
|
|
146
|
+
"original": "boolean",
|
|
147
|
+
"resolved": "boolean",
|
|
148
|
+
"references": {}
|
|
149
|
+
},
|
|
150
|
+
"mutable": false,
|
|
151
|
+
"attr": "disabled",
|
|
152
|
+
"reflectToAttr": true,
|
|
153
|
+
"docs": "If `true`, the disabled state will be set.",
|
|
154
|
+
"docsTags": [],
|
|
155
|
+
"default": "false",
|
|
156
|
+
"values": [
|
|
157
|
+
{
|
|
158
|
+
"type": "boolean"
|
|
159
|
+
}
|
|
160
|
+
],
|
|
161
|
+
"optional": false,
|
|
162
|
+
"required": false,
|
|
163
|
+
"getter": false,
|
|
164
|
+
"setter": false
|
|
165
|
+
},
|
|
166
|
+
{
|
|
167
|
+
"name": "max",
|
|
168
|
+
"type": "Date | string",
|
|
169
|
+
"complexType": {
|
|
170
|
+
"original": "string | Date",
|
|
171
|
+
"resolved": "Date | string",
|
|
172
|
+
"references": {
|
|
173
|
+
"Date": {
|
|
174
|
+
"location": "global",
|
|
175
|
+
"id": "global::Date"
|
|
176
|
+
}
|
|
177
|
+
}
|
|
178
|
+
},
|
|
179
|
+
"mutable": false,
|
|
180
|
+
"attr": "max",
|
|
181
|
+
"reflectToAttr": false,
|
|
182
|
+
"docs": "The latest date that will be allowed. The value can be in any format supported as `dateFormat`, in ISO 8601 date string format (`yyyy-mm-dd`) or as a JavaScript `Date` object.\nThe value of this prop is ignored if `disableFuture` is set to `true`.",
|
|
183
|
+
"docsTags": [],
|
|
184
|
+
"default": "\"\"",
|
|
185
|
+
"values": [
|
|
186
|
+
{
|
|
187
|
+
"type": "Date"
|
|
188
|
+
},
|
|
189
|
+
{
|
|
190
|
+
"type": "string"
|
|
191
|
+
}
|
|
192
|
+
],
|
|
193
|
+
"optional": false,
|
|
194
|
+
"required": false,
|
|
195
|
+
"getter": false,
|
|
196
|
+
"setter": false
|
|
197
|
+
},
|
|
198
|
+
{
|
|
199
|
+
"name": "min",
|
|
200
|
+
"type": "Date | string",
|
|
201
|
+
"complexType": {
|
|
202
|
+
"original": "string | Date",
|
|
203
|
+
"resolved": "Date | string",
|
|
204
|
+
"references": {
|
|
205
|
+
"Date": {
|
|
206
|
+
"location": "global",
|
|
207
|
+
"id": "global::Date"
|
|
208
|
+
}
|
|
209
|
+
}
|
|
210
|
+
},
|
|
211
|
+
"mutable": false,
|
|
212
|
+
"attr": "min",
|
|
213
|
+
"reflectToAttr": false,
|
|
214
|
+
"docs": "The earliest date that will be allowed. The value can be in any format supported as `dateFormat`, in ISO 8601 date string format (`yyyy-mm-dd`) or as a JavaScript `Date` object.\nThe value of this prop is ignored if `disablePast` is set to `true`.",
|
|
215
|
+
"docsTags": [],
|
|
216
|
+
"default": "\"\"",
|
|
217
|
+
"values": [
|
|
218
|
+
{
|
|
219
|
+
"type": "Date"
|
|
220
|
+
},
|
|
221
|
+
{
|
|
222
|
+
"type": "string"
|
|
223
|
+
}
|
|
224
|
+
],
|
|
225
|
+
"optional": false,
|
|
226
|
+
"required": false,
|
|
227
|
+
"getter": false,
|
|
228
|
+
"setter": false
|
|
229
|
+
},
|
|
230
|
+
{
|
|
231
|
+
"name": "openAtDate",
|
|
232
|
+
"type": "Date | string",
|
|
233
|
+
"complexType": {
|
|
234
|
+
"original": "string | Date",
|
|
235
|
+
"resolved": "Date | string",
|
|
236
|
+
"references": {
|
|
237
|
+
"Date": {
|
|
238
|
+
"location": "global",
|
|
239
|
+
"id": "global::Date"
|
|
240
|
+
}
|
|
241
|
+
}
|
|
242
|
+
},
|
|
243
|
+
"mutable": false,
|
|
244
|
+
"attr": "open-at-date",
|
|
245
|
+
"reflectToAttr": false,
|
|
246
|
+
"docs": "The date visible when the calendar opens. Used if no date is currently selected.\nThe value can be in any format supported as `dateFormat`, in ISO 8601 date string format (`yyyy-mm-dd`) or as a JavaScript `Date` object.",
|
|
247
|
+
"docsTags": [],
|
|
248
|
+
"default": "\"\"",
|
|
249
|
+
"values": [
|
|
250
|
+
{
|
|
251
|
+
"type": "Date"
|
|
252
|
+
},
|
|
253
|
+
{
|
|
254
|
+
"type": "string"
|
|
255
|
+
}
|
|
256
|
+
],
|
|
257
|
+
"optional": false,
|
|
258
|
+
"required": false,
|
|
259
|
+
"getter": false,
|
|
260
|
+
"setter": false
|
|
261
|
+
},
|
|
262
|
+
{
|
|
263
|
+
"name": "showClearButton",
|
|
264
|
+
"type": "boolean | undefined",
|
|
265
|
+
"complexType": {
|
|
266
|
+
"original": "boolean",
|
|
267
|
+
"resolved": "boolean | undefined",
|
|
268
|
+
"references": {}
|
|
269
|
+
},
|
|
270
|
+
"mutable": false,
|
|
271
|
+
"attr": "show-clear-button",
|
|
272
|
+
"reflectToAttr": false,
|
|
273
|
+
"docs": "If `true`, the `Clear` button on the calendar will be visible.",
|
|
274
|
+
"docsTags": [],
|
|
275
|
+
"default": "true",
|
|
276
|
+
"values": [
|
|
277
|
+
{
|
|
278
|
+
"type": "boolean"
|
|
279
|
+
},
|
|
280
|
+
{
|
|
281
|
+
"type": "undefined"
|
|
282
|
+
}
|
|
283
|
+
],
|
|
284
|
+
"optional": true,
|
|
285
|
+
"required": false,
|
|
286
|
+
"getter": false,
|
|
287
|
+
"setter": false
|
|
288
|
+
},
|
|
289
|
+
{
|
|
290
|
+
"name": "showDaysOutsideMonth",
|
|
291
|
+
"type": "boolean | undefined",
|
|
292
|
+
"complexType": {
|
|
293
|
+
"original": "boolean",
|
|
294
|
+
"resolved": "boolean | undefined",
|
|
295
|
+
"references": {}
|
|
296
|
+
},
|
|
297
|
+
"mutable": false,
|
|
298
|
+
"attr": "show-days-outside-month",
|
|
299
|
+
"reflectToAttr": false,
|
|
300
|
+
"docs": "If `true`, days outside the current month will be visible in the calendar.",
|
|
301
|
+
"docsTags": [],
|
|
302
|
+
"default": "true",
|
|
303
|
+
"values": [
|
|
304
|
+
{
|
|
305
|
+
"type": "boolean"
|
|
306
|
+
},
|
|
307
|
+
{
|
|
308
|
+
"type": "undefined"
|
|
309
|
+
}
|
|
310
|
+
],
|
|
311
|
+
"optional": true,
|
|
312
|
+
"required": false,
|
|
313
|
+
"getter": false,
|
|
314
|
+
"setter": false
|
|
315
|
+
},
|
|
316
|
+
{
|
|
317
|
+
"name": "showTodayButton",
|
|
318
|
+
"type": "boolean | undefined",
|
|
319
|
+
"complexType": {
|
|
320
|
+
"original": "boolean",
|
|
321
|
+
"resolved": "boolean | undefined",
|
|
322
|
+
"references": {}
|
|
323
|
+
},
|
|
324
|
+
"mutable": false,
|
|
325
|
+
"attr": "show-today-button",
|
|
326
|
+
"reflectToAttr": false,
|
|
327
|
+
"docs": "If `true`, the `Go to today` button on the calendar will be visible.",
|
|
328
|
+
"docsTags": [],
|
|
329
|
+
"default": "true",
|
|
330
|
+
"values": [
|
|
331
|
+
{
|
|
332
|
+
"type": "boolean"
|
|
333
|
+
},
|
|
334
|
+
{
|
|
335
|
+
"type": "undefined"
|
|
336
|
+
}
|
|
337
|
+
],
|
|
338
|
+
"optional": true,
|
|
339
|
+
"required": false,
|
|
340
|
+
"getter": false,
|
|
341
|
+
"setter": false
|
|
342
|
+
},
|
|
343
|
+
{
|
|
344
|
+
"name": "size",
|
|
345
|
+
"type": "\"large\" | \"medium\" | \"small\"",
|
|
346
|
+
"complexType": {
|
|
347
|
+
"original": "IcSizes",
|
|
348
|
+
"resolved": "\"large\" | \"medium\" | \"small\"",
|
|
349
|
+
"references": {
|
|
350
|
+
"IcSizes": {
|
|
351
|
+
"location": "import",
|
|
352
|
+
"path": "../../utils/types",
|
|
353
|
+
"id": "src/utils/types.ts::IcSizes"
|
|
354
|
+
}
|
|
355
|
+
}
|
|
356
|
+
},
|
|
357
|
+
"mutable": false,
|
|
358
|
+
"attr": "size",
|
|
359
|
+
"reflectToAttr": false,
|
|
360
|
+
"docs": "The size of the calendar to be displayed.",
|
|
361
|
+
"docsTags": [],
|
|
362
|
+
"default": "\"medium\"",
|
|
363
|
+
"values": [
|
|
364
|
+
{
|
|
365
|
+
"value": "large",
|
|
366
|
+
"type": "string"
|
|
367
|
+
},
|
|
368
|
+
{
|
|
369
|
+
"value": "medium",
|
|
370
|
+
"type": "string"
|
|
371
|
+
},
|
|
372
|
+
{
|
|
373
|
+
"value": "small",
|
|
374
|
+
"type": "string"
|
|
375
|
+
}
|
|
376
|
+
],
|
|
377
|
+
"optional": false,
|
|
378
|
+
"required": false,
|
|
379
|
+
"getter": false,
|
|
380
|
+
"setter": false
|
|
381
|
+
},
|
|
382
|
+
{
|
|
383
|
+
"name": "startOfWeek",
|
|
384
|
+
"type": "IcWeekDays.Friday | IcWeekDays.Monday | IcWeekDays.Saturday | IcWeekDays.Sunday | IcWeekDays.Thursday | IcWeekDays.Tuesday | IcWeekDays.Wednesday",
|
|
385
|
+
"complexType": {
|
|
386
|
+
"original": "IcWeekDays",
|
|
387
|
+
"resolved": "IcWeekDays.Friday | IcWeekDays.Monday | IcWeekDays.Saturday | IcWeekDays.Sunday | IcWeekDays.Thursday | IcWeekDays.Tuesday | IcWeekDays.Wednesday",
|
|
388
|
+
"references": {
|
|
389
|
+
"IcWeekDays": {
|
|
390
|
+
"location": "import",
|
|
391
|
+
"path": "../../utils/types",
|
|
392
|
+
"id": "src/utils/types.ts::IcWeekDays"
|
|
393
|
+
}
|
|
394
|
+
}
|
|
395
|
+
},
|
|
396
|
+
"mutable": false,
|
|
397
|
+
"attr": "start-of-week",
|
|
398
|
+
"reflectToAttr": false,
|
|
399
|
+
"docs": "The first day of the week. `0` for Sunday, `1` for Monday, etc.\nDefault is Monday.",
|
|
400
|
+
"docsTags": [],
|
|
401
|
+
"default": "IcWeekDays.Monday",
|
|
402
|
+
"values": [
|
|
403
|
+
{
|
|
404
|
+
"type": "IcWeekDays.Friday"
|
|
405
|
+
},
|
|
406
|
+
{
|
|
407
|
+
"type": "IcWeekDays.Monday"
|
|
408
|
+
},
|
|
409
|
+
{
|
|
410
|
+
"type": "IcWeekDays.Saturday"
|
|
411
|
+
},
|
|
412
|
+
{
|
|
413
|
+
"type": "IcWeekDays.Sunday"
|
|
414
|
+
},
|
|
415
|
+
{
|
|
416
|
+
"type": "IcWeekDays.Thursday"
|
|
417
|
+
},
|
|
418
|
+
{
|
|
419
|
+
"type": "IcWeekDays.Tuesday"
|
|
420
|
+
},
|
|
421
|
+
{
|
|
422
|
+
"type": "IcWeekDays.Wednesday"
|
|
423
|
+
}
|
|
424
|
+
],
|
|
425
|
+
"optional": false,
|
|
426
|
+
"required": false,
|
|
427
|
+
"getter": false,
|
|
428
|
+
"setter": false
|
|
429
|
+
},
|
|
430
|
+
{
|
|
431
|
+
"name": "theme",
|
|
432
|
+
"type": "\"dark\" | \"inherit\" | \"light\" | undefined",
|
|
433
|
+
"complexType": {
|
|
434
|
+
"original": "IcThemeMode",
|
|
435
|
+
"resolved": "\"dark\" | \"inherit\" | \"light\" | undefined",
|
|
436
|
+
"references": {
|
|
437
|
+
"IcThemeMode": {
|
|
438
|
+
"location": "import",
|
|
439
|
+
"path": "../../utils/types",
|
|
440
|
+
"id": "src/utils/types.ts::IcThemeMode"
|
|
441
|
+
}
|
|
442
|
+
}
|
|
443
|
+
},
|
|
444
|
+
"mutable": false,
|
|
445
|
+
"attr": "theme",
|
|
446
|
+
"reflectToAttr": false,
|
|
447
|
+
"docs": "Sets the calendar to the dark or light theme colors. \"inherit\" will set the color based on the system settings or ic-theme component.",
|
|
448
|
+
"docsTags": [],
|
|
449
|
+
"default": "\"inherit\"",
|
|
450
|
+
"values": [
|
|
451
|
+
{
|
|
452
|
+
"value": "dark",
|
|
453
|
+
"type": "string"
|
|
454
|
+
},
|
|
455
|
+
{
|
|
456
|
+
"value": "inherit",
|
|
457
|
+
"type": "string"
|
|
458
|
+
},
|
|
459
|
+
{
|
|
460
|
+
"value": "light",
|
|
461
|
+
"type": "string"
|
|
462
|
+
},
|
|
463
|
+
{
|
|
464
|
+
"type": "undefined"
|
|
465
|
+
}
|
|
466
|
+
],
|
|
467
|
+
"optional": true,
|
|
468
|
+
"required": false,
|
|
469
|
+
"getter": false,
|
|
470
|
+
"setter": false
|
|
471
|
+
},
|
|
472
|
+
{
|
|
473
|
+
"name": "value",
|
|
474
|
+
"type": "Date | null | string | undefined",
|
|
475
|
+
"complexType": {
|
|
476
|
+
"original": "IcDateValueFormat",
|
|
477
|
+
"resolved": "Date | null | string | undefined",
|
|
478
|
+
"references": {
|
|
479
|
+
"IcDateValueFormat": {
|
|
480
|
+
"location": "import",
|
|
481
|
+
"path": "../../utils/types",
|
|
482
|
+
"id": "src/utils/types.ts::IcDateValueFormat"
|
|
483
|
+
}
|
|
484
|
+
}
|
|
485
|
+
},
|
|
486
|
+
"mutable": true,
|
|
487
|
+
"attr": "value",
|
|
488
|
+
"reflectToAttr": true,
|
|
489
|
+
"docs": "The value of the calendar and the date visible when the calendar opens.\nThe value can be in any format supported as `dateFormat`, in ISO 8601 date string format (`yyyy-mm-dd`) or as a JavaScript `Date` object.",
|
|
490
|
+
"docsTags": [],
|
|
491
|
+
"default": "\"\"",
|
|
492
|
+
"values": [
|
|
493
|
+
{
|
|
494
|
+
"type": "Date"
|
|
495
|
+
},
|
|
496
|
+
{
|
|
497
|
+
"type": "null"
|
|
498
|
+
},
|
|
499
|
+
{
|
|
500
|
+
"type": "string"
|
|
501
|
+
},
|
|
502
|
+
{
|
|
503
|
+
"type": "undefined"
|
|
504
|
+
}
|
|
505
|
+
],
|
|
506
|
+
"optional": true,
|
|
507
|
+
"required": false,
|
|
508
|
+
"getter": false,
|
|
509
|
+
"setter": false
|
|
510
|
+
}
|
|
511
|
+
],
|
|
512
|
+
"methods": [],
|
|
513
|
+
"events": [
|
|
514
|
+
{
|
|
515
|
+
"event": "icCalendarClearButtonClick",
|
|
516
|
+
"detail": "void",
|
|
517
|
+
"bubbles": true,
|
|
518
|
+
"complexType": {
|
|
519
|
+
"original": "void",
|
|
520
|
+
"resolved": "void",
|
|
521
|
+
"references": {}
|
|
522
|
+
},
|
|
523
|
+
"cancelable": true,
|
|
524
|
+
"composed": true,
|
|
525
|
+
"docs": "Emitted when the clear button has been clicked.",
|
|
526
|
+
"docsTags": []
|
|
527
|
+
},
|
|
528
|
+
{
|
|
529
|
+
"event": "icCalendarMonthSelect",
|
|
530
|
+
"detail": "void",
|
|
531
|
+
"bubbles": true,
|
|
532
|
+
"complexType": {
|
|
533
|
+
"original": "void",
|
|
534
|
+
"resolved": "void",
|
|
535
|
+
"references": {}
|
|
536
|
+
},
|
|
537
|
+
"cancelable": true,
|
|
538
|
+
"composed": true,
|
|
539
|
+
"docs": "Emitted when a month is selected.",
|
|
540
|
+
"docsTags": []
|
|
541
|
+
},
|
|
542
|
+
{
|
|
543
|
+
"event": "icCalendarYearSelect",
|
|
544
|
+
"detail": "void",
|
|
545
|
+
"bubbles": true,
|
|
546
|
+
"complexType": {
|
|
547
|
+
"original": "void",
|
|
548
|
+
"resolved": "void",
|
|
549
|
+
"references": {}
|
|
550
|
+
},
|
|
551
|
+
"cancelable": true,
|
|
552
|
+
"composed": true,
|
|
553
|
+
"docs": "Emitted when a year is selected.",
|
|
554
|
+
"docsTags": []
|
|
555
|
+
},
|
|
556
|
+
{
|
|
557
|
+
"event": "icChange",
|
|
558
|
+
"detail": "{ value: Date | null; dateObject: { day: string | null; month: string | null; year: string | null; }; utcValue: Date | null; }",
|
|
559
|
+
"bubbles": true,
|
|
560
|
+
"complexType": {
|
|
561
|
+
"original": "{\n value: Date | null;\n dateObject: {\n day: string | null;\n month: string | null;\n year: string | null;\n };\n utcValue: Date | null;\n }",
|
|
562
|
+
"resolved": "{ value: Date | null; dateObject: { day: string | null; month: string | null; year: string | null; }; utcValue: Date | null; }",
|
|
563
|
+
"references": {
|
|
564
|
+
"Date": {
|
|
565
|
+
"location": "global",
|
|
566
|
+
"id": "global::Date"
|
|
567
|
+
}
|
|
568
|
+
}
|
|
569
|
+
},
|
|
570
|
+
"cancelable": true,
|
|
571
|
+
"composed": true,
|
|
572
|
+
"docs": "Emitted when the value has changed.",
|
|
573
|
+
"docsTags": []
|
|
574
|
+
}
|
|
575
|
+
],
|
|
576
|
+
"listeners": [],
|
|
577
|
+
"styles": [
|
|
578
|
+
{
|
|
579
|
+
"name": "--ic-z-index-calendar",
|
|
580
|
+
"annotation": "prop",
|
|
581
|
+
"docs": "z-index of calendar."
|
|
582
|
+
}
|
|
583
|
+
],
|
|
584
|
+
"slots": [],
|
|
585
|
+
"parts": [],
|
|
586
|
+
"dependents": [
|
|
587
|
+
"ic-date-picker"
|
|
588
|
+
],
|
|
589
|
+
"dependencies": [
|
|
590
|
+
"ic-button",
|
|
591
|
+
"ic-typography"
|
|
592
|
+
],
|
|
593
|
+
"dependencyGraph": {
|
|
594
|
+
"ic-calendar": [
|
|
595
|
+
"ic-button",
|
|
596
|
+
"ic-typography"
|
|
597
|
+
],
|
|
598
|
+
"ic-button": [
|
|
599
|
+
"ic-typography",
|
|
600
|
+
"ic-loading-indicator",
|
|
601
|
+
"ic-tooltip"
|
|
602
|
+
],
|
|
603
|
+
"ic-loading-indicator": [
|
|
604
|
+
"ic-typography"
|
|
605
|
+
],
|
|
606
|
+
"ic-tooltip": [
|
|
607
|
+
"ic-typography"
|
|
608
|
+
],
|
|
609
|
+
"ic-date-picker": [
|
|
610
|
+
"ic-calendar"
|
|
611
|
+
]
|
|
612
|
+
}
|
|
613
|
+
},
|
|
8
614
|
{
|
|
9
615
|
"filePath": "src/components/ic-card-horizontal/ic-card-horizontal.tsx",
|
|
10
616
|
"encapsulation": "shadow",
|
|
@@ -1037,7 +1643,7 @@
|
|
|
1037
1643
|
"reflectToAttr": false,
|
|
1038
1644
|
"docs": "Sets the props for the built-in pagination bar. If the `pagination-bar` slot is used then this prop is ignored.",
|
|
1039
1645
|
"docsTags": [],
|
|
1040
|
-
"default": "{\n alignment: \"right\",\n hideAllFromItemsPerPage: false,\n hideRangeLabel: false,\n itemLabel: \"Item\",\n itemsPerPageOptions: [\n { label: \"10\", value: \"10\" },\n { label: \"25\", value: \"25\" },\n { label: \"50\", value: \"50\" },\n ],\n monochrome: false,\n pageLabel: \"Page\",\n rangeLabelType: \"page\",\n selectedItemsPerPage: 10,\n selectItemsPerPageOnEnter: true,\n setToFirstPageOnPaginationChange: false,\n showGoToPageControl: true,\n showItemsPerPageControl: true,\n type: \"simple\",\n }",
|
|
1646
|
+
"default": "{\n alignment: \"right\",\n hideAllFromItemsPerPage: false,\n hideCurrentPage: false,\n hideFirstAndLastPageButton: false,\n hideRangeLabel: false,\n itemLabel: \"Item\",\n itemsPerPageOptions: [\n { label: \"10\", value: \"10\" },\n { label: \"25\", value: \"25\" },\n { label: \"50\", value: \"50\" },\n ],\n monochrome: false,\n pageLabel: \"Page\",\n rangeLabelType: \"page\",\n selectedItemsPerPage: 10,\n selectItemsPerPageOnEnter: true,\n setToFirstPageOnPaginationChange: false,\n showGoToPageControl: true,\n showItemsPerPageControl: true,\n type: \"simple\",\n }",
|
|
1041
1647
|
"values": [
|
|
1042
1648
|
{
|
|
1043
1649
|
"type": "IcPaginationBarOptions"
|
|
@@ -2670,12 +3276,13 @@
|
|
|
2670
3276
|
"name": "value",
|
|
2671
3277
|
"type": "Date | null | string | undefined",
|
|
2672
3278
|
"complexType": {
|
|
2673
|
-
"original": "
|
|
3279
|
+
"original": "IcDateValueFormat",
|
|
2674
3280
|
"resolved": "Date | null | string | undefined",
|
|
2675
3281
|
"references": {
|
|
2676
|
-
"
|
|
2677
|
-
"location": "
|
|
2678
|
-
"
|
|
3282
|
+
"IcDateValueFormat": {
|
|
3283
|
+
"location": "import",
|
|
3284
|
+
"path": "../../utils/types",
|
|
3285
|
+
"id": "src/utils/types.ts::IcDateValueFormat"
|
|
2679
3286
|
}
|
|
2680
3287
|
}
|
|
2681
3288
|
},
|
|
@@ -3774,12 +4381,13 @@
|
|
|
3774
4381
|
"name": "value",
|
|
3775
4382
|
"type": "Date | null | string | undefined",
|
|
3776
4383
|
"complexType": {
|
|
3777
|
-
"original": "
|
|
4384
|
+
"original": "IcDateValueFormat",
|
|
3778
4385
|
"resolved": "Date | null | string | undefined",
|
|
3779
4386
|
"references": {
|
|
3780
|
-
"
|
|
3781
|
-
"location": "
|
|
3782
|
-
"
|
|
4387
|
+
"IcDateValueFormat": {
|
|
4388
|
+
"location": "import",
|
|
4389
|
+
"path": "../../utils/types",
|
|
4390
|
+
"id": "src/utils/types.ts::IcDateValueFormat"
|
|
3783
4391
|
}
|
|
3784
4392
|
}
|
|
3785
4393
|
},
|
|
@@ -3813,11 +4421,11 @@
|
|
|
3813
4421
|
"events": [
|
|
3814
4422
|
{
|
|
3815
4423
|
"event": "icChange",
|
|
3816
|
-
"detail": "{ value: Date; }",
|
|
4424
|
+
"detail": "{ value: Date | null; dateObject?: { day: string | null; month: string | null; year: string | null; } | undefined; utcValue: Date | null; }",
|
|
3817
4425
|
"bubbles": true,
|
|
3818
4426
|
"complexType": {
|
|
3819
|
-
"original": "{
|
|
3820
|
-
"resolved": "{ value: Date; }",
|
|
4427
|
+
"original": "{\n value: Date | null;\n dateObject?: {\n day: string | null;\n month: string | null;\n year: string | null;\n };\n utcValue: Date | null;\n }",
|
|
4428
|
+
"resolved": "{ value: Date | null; dateObject?: { day: string | null; month: string | null; year: string | null; } | undefined; utcValue: Date | null; }",
|
|
3821
4429
|
"references": {
|
|
3822
4430
|
"Date": {
|
|
3823
4431
|
"location": "global",
|
|
@@ -3842,6 +4450,16 @@
|
|
|
3842
4450
|
"target": "document",
|
|
3843
4451
|
"capture": false,
|
|
3844
4452
|
"passive": false
|
|
4453
|
+
},
|
|
4454
|
+
{
|
|
4455
|
+
"event": "icCalendarDaySelect",
|
|
4456
|
+
"capture": false,
|
|
4457
|
+
"passive": false
|
|
4458
|
+
},
|
|
4459
|
+
{
|
|
4460
|
+
"event": "icChange",
|
|
4461
|
+
"capture": false,
|
|
4462
|
+
"passive": false
|
|
3845
4463
|
}
|
|
3846
4464
|
],
|
|
3847
4465
|
"styles": [
|
|
@@ -3853,7 +4471,7 @@
|
|
|
3853
4471
|
{
|
|
3854
4472
|
"name": "--input-width",
|
|
3855
4473
|
"annotation": "prop",
|
|
3856
|
-
"docs": "Width of the input field"
|
|
4474
|
+
"docs": "Width of the date input field"
|
|
3857
4475
|
}
|
|
3858
4476
|
],
|
|
3859
4477
|
"slots": [
|
|
@@ -3865,14 +4483,22 @@
|
|
|
3865
4483
|
"parts": [],
|
|
3866
4484
|
"dependents": [],
|
|
3867
4485
|
"dependencies": [
|
|
3868
|
-
"ic-button",
|
|
3869
4486
|
"ic-date-input",
|
|
3870
|
-
"ic-
|
|
4487
|
+
"ic-calendar"
|
|
3871
4488
|
],
|
|
3872
4489
|
"dependencyGraph": {
|
|
3873
4490
|
"ic-date-picker": [
|
|
3874
|
-
"ic-button",
|
|
3875
4491
|
"ic-date-input",
|
|
4492
|
+
"ic-calendar"
|
|
4493
|
+
],
|
|
4494
|
+
"ic-date-input": [
|
|
4495
|
+
"ic-input-container",
|
|
4496
|
+
"ic-input-label",
|
|
4497
|
+
"ic-input-component-container",
|
|
4498
|
+
"ic-button",
|
|
4499
|
+
"ic-input-validation"
|
|
4500
|
+
],
|
|
4501
|
+
"ic-input-label": [
|
|
3876
4502
|
"ic-typography"
|
|
3877
4503
|
],
|
|
3878
4504
|
"ic-button": [
|
|
@@ -3886,17 +4512,11 @@
|
|
|
3886
4512
|
"ic-tooltip": [
|
|
3887
4513
|
"ic-typography"
|
|
3888
4514
|
],
|
|
3889
|
-
"ic-
|
|
3890
|
-
"ic-input-container",
|
|
3891
|
-
"ic-input-label",
|
|
3892
|
-
"ic-input-component-container",
|
|
3893
|
-
"ic-button",
|
|
3894
|
-
"ic-input-validation"
|
|
3895
|
-
],
|
|
3896
|
-
"ic-input-label": [
|
|
4515
|
+
"ic-input-validation": [
|
|
3897
4516
|
"ic-typography"
|
|
3898
4517
|
],
|
|
3899
|
-
"ic-
|
|
4518
|
+
"ic-calendar": [
|
|
4519
|
+
"ic-button",
|
|
3900
4520
|
"ic-typography"
|
|
3901
4521
|
]
|
|
3902
4522
|
}
|
|
@@ -4006,6 +4626,60 @@
|
|
|
4006
4626
|
"getter": false,
|
|
4007
4627
|
"setter": false
|
|
4008
4628
|
},
|
|
4629
|
+
{
|
|
4630
|
+
"name": "hideCurrentPage",
|
|
4631
|
+
"type": "boolean | undefined",
|
|
4632
|
+
"complexType": {
|
|
4633
|
+
"original": "boolean",
|
|
4634
|
+
"resolved": "boolean | undefined",
|
|
4635
|
+
"references": {}
|
|
4636
|
+
},
|
|
4637
|
+
"mutable": false,
|
|
4638
|
+
"attr": "hide-current-page",
|
|
4639
|
+
"reflectToAttr": false,
|
|
4640
|
+
"docs": "If `true`, the current page of the simple pagination will not be displayed.",
|
|
4641
|
+
"docsTags": [],
|
|
4642
|
+
"default": "false",
|
|
4643
|
+
"values": [
|
|
4644
|
+
{
|
|
4645
|
+
"type": "boolean"
|
|
4646
|
+
},
|
|
4647
|
+
{
|
|
4648
|
+
"type": "undefined"
|
|
4649
|
+
}
|
|
4650
|
+
],
|
|
4651
|
+
"optional": true,
|
|
4652
|
+
"required": false,
|
|
4653
|
+
"getter": false,
|
|
4654
|
+
"setter": false
|
|
4655
|
+
},
|
|
4656
|
+
{
|
|
4657
|
+
"name": "hideFirstAndLastPageButton",
|
|
4658
|
+
"type": "boolean | undefined",
|
|
4659
|
+
"complexType": {
|
|
4660
|
+
"original": "boolean",
|
|
4661
|
+
"resolved": "boolean | undefined",
|
|
4662
|
+
"references": {}
|
|
4663
|
+
},
|
|
4664
|
+
"mutable": false,
|
|
4665
|
+
"attr": "hide-first-and-last-page-button",
|
|
4666
|
+
"reflectToAttr": false,
|
|
4667
|
+
"docs": "If `true`, the first and last page buttons will not be displayed.",
|
|
4668
|
+
"docsTags": [],
|
|
4669
|
+
"default": "false",
|
|
4670
|
+
"values": [
|
|
4671
|
+
{
|
|
4672
|
+
"type": "boolean"
|
|
4673
|
+
},
|
|
4674
|
+
{
|
|
4675
|
+
"type": "undefined"
|
|
4676
|
+
}
|
|
4677
|
+
],
|
|
4678
|
+
"optional": true,
|
|
4679
|
+
"required": false,
|
|
4680
|
+
"getter": false,
|
|
4681
|
+
"setter": false
|
|
4682
|
+
},
|
|
4009
4683
|
{
|
|
4010
4684
|
"name": "hideRangeLabel",
|
|
4011
4685
|
"type": "boolean | undefined",
|
|
@@ -4317,8 +4991,8 @@
|
|
|
4317
4991
|
"references": {
|
|
4318
4992
|
"IcThemeMode": {
|
|
4319
4993
|
"location": "import",
|
|
4320
|
-
"path": "
|
|
4321
|
-
"id": "
|
|
4994
|
+
"path": "../../utils/types",
|
|
4995
|
+
"id": "src/utils/types.ts::IcThemeMode"
|
|
4322
4996
|
}
|
|
4323
4997
|
}
|
|
4324
4998
|
},
|
|
@@ -5445,12 +6119,13 @@
|
|
|
5445
6119
|
"name": "value",
|
|
5446
6120
|
"type": "Date | null | string | undefined",
|
|
5447
6121
|
"complexType": {
|
|
5448
|
-
"original": "
|
|
6122
|
+
"original": "IcDateValueFormat",
|
|
5449
6123
|
"resolved": "Date | null | string | undefined",
|
|
5450
6124
|
"references": {
|
|
5451
|
-
"
|
|
5452
|
-
"location": "
|
|
5453
|
-
"
|
|
6125
|
+
"IcDateValueFormat": {
|
|
6126
|
+
"location": "import",
|
|
6127
|
+
"path": "../../utils/types",
|
|
6128
|
+
"id": "src/utils/types.ts::IcDateValueFormat"
|
|
5454
6129
|
}
|
|
5455
6130
|
}
|
|
5456
6131
|
},
|
|
@@ -6337,8 +7012,13 @@
|
|
|
6337
7012
|
}
|
|
6338
7013
|
],
|
|
6339
7014
|
"typeLibrary": {
|
|
6340
|
-
"src/utils/types.ts::
|
|
6341
|
-
"declaration": "export type
|
|
7015
|
+
"src/utils/types.ts::IcDateFormat": {
|
|
7016
|
+
"declaration": "export type IcDateFormat = \"DD/MM/YYYY\" | \"MM/DD/YYYY\" | \"YYYY/MM/DD\";",
|
|
7017
|
+
"docstring": "",
|
|
7018
|
+
"path": "src/utils/types.ts"
|
|
7019
|
+
},
|
|
7020
|
+
"src/utils/types.ts::IcWeekDays": {
|
|
7021
|
+
"declaration": "export enum IcWeekDays {\n Sunday = 0,\n Monday = 1,\n Tuesday = 2,\n Wednesday = 3,\n Thursday = 4,\n Friday = 5,\n Saturday = 6,\n}",
|
|
6342
7022
|
"docstring": "",
|
|
6343
7023
|
"path": "src/utils/types.ts"
|
|
6344
7024
|
},
|
|
@@ -6352,6 +7032,16 @@
|
|
|
6352
7032
|
"docstring": "",
|
|
6353
7033
|
"path": "src/utils/types.ts"
|
|
6354
7034
|
},
|
|
7035
|
+
"src/utils/types.ts::IcDateValueFormat": {
|
|
7036
|
+
"declaration": "export type IcDateValueFormat = string | Date | null | undefined;",
|
|
7037
|
+
"docstring": "",
|
|
7038
|
+
"path": "src/utils/types.ts"
|
|
7039
|
+
},
|
|
7040
|
+
"src/utils/types.ts::IcCardDensity": {
|
|
7041
|
+
"declaration": "export type IcCardDensity = \"default\" | \"spacious\";",
|
|
7042
|
+
"docstring": "",
|
|
7043
|
+
"path": "src/utils/types.ts"
|
|
7044
|
+
},
|
|
6355
7045
|
"src/components/ic-data-table/ic-data-table.types.tsx::IcDataTableColumnObject": {
|
|
6356
7046
|
"declaration": "{\n key: string;\n title: string;\n dataType: IcDataTableColumnDataTypes;\n columnAlignment?: IcDataTableAlignmentOptions;\n columnWidth?: string | IcDataTableColumnWidthTypes;\n textWrap?: boolean;\n cellAlignment?: string;\n emphasis?: string;\n colspan?: number;\n icon?: {\n icon: string;\n onAllCells?: boolean;\n hideOnHeader?: boolean;\n };\n excludeColumnFromSort?: boolean;\n hidden?: boolean;\n disableAutoSort?: boolean;\n}",
|
|
6357
7047
|
"docstring": "",
|
|
@@ -6373,7 +7063,7 @@
|
|
|
6373
7063
|
"path": "src/components/ic-data-table/ic-data-table.types.tsx"
|
|
6374
7064
|
},
|
|
6375
7065
|
"src/utils/types.ts::IcPaginationBarOptions": {
|
|
6376
|
-
"declaration": "export interface IcPaginationBarOptions {\n alignment?: IcPaginationAlignmentOptions;\n hideAllFromItemsPerPage?: boolean;\n hideRangeLabel?: boolean;\n itemLabel?: string;\n itemsPerPageOptions?: { label: string; value: string }[];\n monochrome?: boolean;\n pageLabel?: string;\n rangeLabelType?: IcPaginationLabelTypes;\n selectedItemsPerPage?: number;\n selectItemsPerPageOnEnter?: boolean;\n setToFirstPageOnPaginationChange?: boolean;\n showGoToPageControl?: boolean;\n showItemsPerPageControl?: boolean;\n theme?: IcThemeMode;\n type?: IcPaginationTypes;\n}",
|
|
7066
|
+
"declaration": "export interface IcPaginationBarOptions {\n alignment?: IcPaginationAlignmentOptions;\n hideAllFromItemsPerPage?: boolean;\n hideCurrentPage?: boolean;\n hideFirstAndLastPageButton?: boolean;\n hideRangeLabel?: boolean;\n itemLabel?: string;\n itemsPerPageOptions?: { label: string; value: string }[];\n monochrome?: boolean;\n pageLabel?: string;\n rangeLabelType?: IcPaginationLabelTypes;\n selectedItemsPerPage?: number;\n selectItemsPerPageOnEnter?: boolean;\n setToFirstPageOnPaginationChange?: boolean;\n showGoToPageControl?: boolean;\n showItemsPerPageControl?: boolean;\n theme?: IcThemeMode;\n type?: IcPaginationTypes;\n}",
|
|
6377
7067
|
"docstring": "",
|
|
6378
7068
|
"path": "src/utils/types.ts"
|
|
6379
7069
|
},
|
|
@@ -6397,11 +7087,6 @@
|
|
|
6397
7087
|
"docstring": "",
|
|
6398
7088
|
"path": "../web-components/dist/types/components/ic-pagination/ic-pagination.types.d.ts"
|
|
6399
7089
|
},
|
|
6400
|
-
"../web-components/dist/types/interface.d.ts::IcThemeMode": {
|
|
6401
|
-
"declaration": "any",
|
|
6402
|
-
"docstring": "",
|
|
6403
|
-
"path": "../web-components/dist/types/interface.d.ts"
|
|
6404
|
-
},
|
|
6405
7090
|
"../web-components/dist/types/components/ic-pagination/ic-pagination.types.d.ts::IcPaginationTypes": {
|
|
6406
7091
|
"declaration": "export type IcPaginationTypes = \"simple\" | \"complex\";",
|
|
6407
7092
|
"docstring": "",
|
|
@@ -6427,16 +7112,6 @@
|
|
|
6427
7112
|
"docstring": "",
|
|
6428
7113
|
"path": "src/components/ic-data-table/ic-data-table.types.tsx"
|
|
6429
7114
|
},
|
|
6430
|
-
"src/utils/types.ts::IcDateFormat": {
|
|
6431
|
-
"declaration": "export type IcDateFormat = \"DD/MM/YYYY\" | \"MM/DD/YYYY\" | \"YYYY/MM/DD\";",
|
|
6432
|
-
"docstring": "",
|
|
6433
|
-
"path": "src/utils/types.ts"
|
|
6434
|
-
},
|
|
6435
|
-
"src/utils/types.ts::IcWeekDays": {
|
|
6436
|
-
"declaration": "export enum IcWeekDays {\n Sunday = 0,\n Monday = 1,\n Tuesday = 2,\n Wednesday = 3,\n Thursday = 4,\n Friday = 5,\n Saturday = 6,\n}",
|
|
6437
|
-
"docstring": "",
|
|
6438
|
-
"path": "src/utils/types.ts"
|
|
6439
|
-
},
|
|
6440
7115
|
"src/utils/types.ts::IcAriaLive": {
|
|
6441
7116
|
"declaration": "export type IcAriaLive = \"polite\" | \"assertive\" | \"off\";",
|
|
6442
7117
|
"docstring": "",
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"author": "mi6",
|
|
3
3
|
"name": "@ukic/canary-docs",
|
|
4
|
-
"version": "3.0.0-canary.
|
|
4
|
+
"version": "3.0.0-canary.25",
|
|
5
5
|
"description": "API documentation for @ukic canary components",
|
|
6
6
|
"main": "docs.json",
|
|
7
7
|
"types": "./docs.d.ts",
|
|
@@ -19,5 +19,5 @@
|
|
|
19
19
|
},
|
|
20
20
|
"license": "MIT",
|
|
21
21
|
"packageManager": "^npm@10.9.2",
|
|
22
|
-
"gitHead": "
|
|
22
|
+
"gitHead": "e79d55a34a906d095f8674636410d47bdb6d3e03"
|
|
23
23
|
}
|