@ukic/canary-docs 3.0.0-canary.21 → 3.0.0-canary.23
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 +241 -30
- package/package.json +2 -2
package/docs.json
CHANGED
|
@@ -22,12 +22,28 @@
|
|
|
22
22
|
},
|
|
23
23
|
{
|
|
24
24
|
"name": "slot",
|
|
25
|
-
"text": "
|
|
25
|
+
"text": "subheading - Content will be placed below the card heading. Only for `density=\"spacious\"`."
|
|
26
|
+
},
|
|
27
|
+
{
|
|
28
|
+
"name": "slot",
|
|
29
|
+
"text": "adornment - Content will be placed below the card subheading. Only for `density=\"spacious\"`."
|
|
30
|
+
},
|
|
31
|
+
{
|
|
32
|
+
"name": "slot",
|
|
33
|
+
"text": "image-left - Content will be placed to the left of all other content."
|
|
34
|
+
},
|
|
35
|
+
{
|
|
36
|
+
"name": "slot",
|
|
37
|
+
"text": "image-right - Content will be placed to the right of all other content."
|
|
26
38
|
},
|
|
27
39
|
{
|
|
28
40
|
"name": "slot",
|
|
29
41
|
"text": "icon - Content will be placed to the left of the horizontal card heading."
|
|
30
42
|
},
|
|
43
|
+
{
|
|
44
|
+
"name": "slot",
|
|
45
|
+
"text": "interaction-button - Content will be placed in the top right corner of the heading section."
|
|
46
|
+
},
|
|
31
47
|
{
|
|
32
48
|
"name": "slot",
|
|
33
49
|
"text": "badge - Badge component overlaying the top right of the horizontal card."
|
|
@@ -59,6 +75,41 @@
|
|
|
59
75
|
"getter": false,
|
|
60
76
|
"setter": false
|
|
61
77
|
},
|
|
78
|
+
{
|
|
79
|
+
"name": "density",
|
|
80
|
+
"type": "\"default\" | \"spacious\"",
|
|
81
|
+
"complexType": {
|
|
82
|
+
"original": "IcCardDensity",
|
|
83
|
+
"resolved": "\"default\" | \"spacious\"",
|
|
84
|
+
"references": {
|
|
85
|
+
"IcCardDensity": {
|
|
86
|
+
"location": "import",
|
|
87
|
+
"path": "../../utils/types",
|
|
88
|
+
"id": "src/utils/types.ts::IcCardDensity"
|
|
89
|
+
}
|
|
90
|
+
}
|
|
91
|
+
},
|
|
92
|
+
"mutable": false,
|
|
93
|
+
"attr": "density",
|
|
94
|
+
"reflectToAttr": false,
|
|
95
|
+
"docs": "The padding of the horizontal card.",
|
|
96
|
+
"docsTags": [],
|
|
97
|
+
"default": "\"default\"",
|
|
98
|
+
"values": [
|
|
99
|
+
{
|
|
100
|
+
"value": "default",
|
|
101
|
+
"type": "string"
|
|
102
|
+
},
|
|
103
|
+
{
|
|
104
|
+
"value": "spacious",
|
|
105
|
+
"type": "string"
|
|
106
|
+
}
|
|
107
|
+
],
|
|
108
|
+
"optional": false,
|
|
109
|
+
"required": false,
|
|
110
|
+
"getter": false,
|
|
111
|
+
"setter": false
|
|
112
|
+
},
|
|
62
113
|
{
|
|
63
114
|
"name": "disabled",
|
|
64
115
|
"type": "boolean",
|
|
@@ -280,15 +331,15 @@
|
|
|
280
331
|
},
|
|
281
332
|
{
|
|
282
333
|
"name": "size",
|
|
283
|
-
"type": "\"
|
|
334
|
+
"type": "\"large\" | \"medium\" | \"small\"",
|
|
284
335
|
"complexType": {
|
|
285
|
-
"original": "
|
|
286
|
-
"resolved": "\"
|
|
336
|
+
"original": "IcSizes",
|
|
337
|
+
"resolved": "\"large\" | \"medium\" | \"small\"",
|
|
287
338
|
"references": {
|
|
288
|
-
"
|
|
339
|
+
"IcSizes": {
|
|
289
340
|
"location": "import",
|
|
290
|
-
"path": "
|
|
291
|
-
"id": "src/
|
|
341
|
+
"path": "../../utils/types",
|
|
342
|
+
"id": "src/utils/types.ts::IcSizes"
|
|
292
343
|
}
|
|
293
344
|
}
|
|
294
345
|
},
|
|
@@ -299,10 +350,6 @@
|
|
|
299
350
|
"docsTags": [],
|
|
300
351
|
"default": "\"medium\"",
|
|
301
352
|
"values": [
|
|
302
|
-
{
|
|
303
|
-
"value": "extra-large",
|
|
304
|
-
"type": "string"
|
|
305
|
-
},
|
|
306
353
|
{
|
|
307
354
|
"value": "large",
|
|
308
355
|
"type": "string"
|
|
@@ -321,6 +368,32 @@
|
|
|
321
368
|
"getter": false,
|
|
322
369
|
"setter": false
|
|
323
370
|
},
|
|
371
|
+
{
|
|
372
|
+
"name": "subheading",
|
|
373
|
+
"type": "string | undefined",
|
|
374
|
+
"complexType": {
|
|
375
|
+
"original": "string",
|
|
376
|
+
"resolved": "string | undefined",
|
|
377
|
+
"references": {}
|
|
378
|
+
},
|
|
379
|
+
"mutable": false,
|
|
380
|
+
"attr": "subheading",
|
|
381
|
+
"reflectToAttr": false,
|
|
382
|
+
"docs": "The subheading for the card.",
|
|
383
|
+
"docsTags": [],
|
|
384
|
+
"values": [
|
|
385
|
+
{
|
|
386
|
+
"type": "string"
|
|
387
|
+
},
|
|
388
|
+
{
|
|
389
|
+
"type": "undefined"
|
|
390
|
+
}
|
|
391
|
+
],
|
|
392
|
+
"optional": true,
|
|
393
|
+
"required": false,
|
|
394
|
+
"getter": false,
|
|
395
|
+
"setter": false
|
|
396
|
+
},
|
|
324
397
|
{
|
|
325
398
|
"name": "target",
|
|
326
399
|
"type": "string | undefined",
|
|
@@ -356,8 +429,8 @@
|
|
|
356
429
|
"references": {
|
|
357
430
|
"IcThemeMode": {
|
|
358
431
|
"location": "import",
|
|
359
|
-
"path": "
|
|
360
|
-
"id": "
|
|
432
|
+
"path": "../../utils/types",
|
|
433
|
+
"id": "src/utils/types.ts::IcThemeMode"
|
|
361
434
|
}
|
|
362
435
|
}
|
|
363
436
|
},
|
|
@@ -436,6 +509,10 @@
|
|
|
436
509
|
}
|
|
437
510
|
],
|
|
438
511
|
"slots": [
|
|
512
|
+
{
|
|
513
|
+
"name": "adornment",
|
|
514
|
+
"docs": "Content will be placed below the card subheading. Only for `density=\"spacious\"`."
|
|
515
|
+
},
|
|
439
516
|
{
|
|
440
517
|
"name": "badge",
|
|
441
518
|
"docs": "Badge component overlaying the top right of the horizontal card."
|
|
@@ -449,12 +526,24 @@
|
|
|
449
526
|
"docs": "Content will be placed to the left of the horizontal card heading."
|
|
450
527
|
},
|
|
451
528
|
{
|
|
452
|
-
"name": "image",
|
|
529
|
+
"name": "image-left",
|
|
453
530
|
"docs": "Content will be placed to the left of all other content."
|
|
454
531
|
},
|
|
532
|
+
{
|
|
533
|
+
"name": "image-right",
|
|
534
|
+
"docs": "Content will be placed to the right of all other content."
|
|
535
|
+
},
|
|
536
|
+
{
|
|
537
|
+
"name": "interaction-button",
|
|
538
|
+
"docs": "Content will be placed in the top right corner of the heading section."
|
|
539
|
+
},
|
|
455
540
|
{
|
|
456
541
|
"name": "message",
|
|
457
542
|
"docs": "Content will be placed in the main body of the horizontal card."
|
|
543
|
+
},
|
|
544
|
+
{
|
|
545
|
+
"name": "subheading",
|
|
546
|
+
"docs": "Content will be placed below the card heading. Only for `density=\"spacious\"`."
|
|
458
547
|
}
|
|
459
548
|
],
|
|
460
549
|
"parts": [],
|
|
@@ -1454,11 +1543,11 @@
|
|
|
1454
1543
|
},
|
|
1455
1544
|
{
|
|
1456
1545
|
"event": "icSelectedRowChange",
|
|
1457
|
-
"detail": "{ row: IcDataTableDataType | null; selectedRows: IcDataTableDataType[]; }",
|
|
1546
|
+
"detail": "{ row: IcDataTableDataType | null; selectedRows: IcDataTableDataType[]; icRowId: string | null; selectedIcRowIds: string[]; }",
|
|
1458
1547
|
"bubbles": true,
|
|
1459
1548
|
"complexType": {
|
|
1460
|
-
"original": "{\n row: IcDataTableDataType | null;\n selectedRows: IcDataTableDataType[];\n }",
|
|
1461
|
-
"resolved": "{ row: IcDataTableDataType | null; selectedRows: IcDataTableDataType[]; }",
|
|
1549
|
+
"original": "{\n row: IcDataTableDataType | null;\n selectedRows: IcDataTableDataType[];\n icRowId: string | null;\n selectedIcRowIds: string[];\n }",
|
|
1550
|
+
"resolved": "{ row: IcDataTableDataType | null; selectedRows: IcDataTableDataType[]; icRowId: string | null; selectedIcRowIds: string[]; }",
|
|
1462
1551
|
"references": {
|
|
1463
1552
|
"IcDataTableDataType": {
|
|
1464
1553
|
"location": "import",
|
|
@@ -2469,6 +2558,45 @@
|
|
|
2469
2558
|
"getter": false,
|
|
2470
2559
|
"setter": false
|
|
2471
2560
|
},
|
|
2561
|
+
{
|
|
2562
|
+
"name": "validationAriaLive",
|
|
2563
|
+
"type": "\"assertive\" | \"off\" | \"polite\"",
|
|
2564
|
+
"complexType": {
|
|
2565
|
+
"original": "IcAriaLive",
|
|
2566
|
+
"resolved": "\"assertive\" | \"off\" | \"polite\"",
|
|
2567
|
+
"references": {
|
|
2568
|
+
"IcAriaLive": {
|
|
2569
|
+
"location": "import",
|
|
2570
|
+
"path": "../../utils/types",
|
|
2571
|
+
"id": "src/utils/types.ts::IcAriaLive"
|
|
2572
|
+
}
|
|
2573
|
+
}
|
|
2574
|
+
},
|
|
2575
|
+
"mutable": false,
|
|
2576
|
+
"attr": "validation-aria-live",
|
|
2577
|
+
"reflectToAttr": false,
|
|
2578
|
+
"docs": "The value of the `aria-live` attribute on the validation message.",
|
|
2579
|
+
"docsTags": [],
|
|
2580
|
+
"default": "\"polite\"",
|
|
2581
|
+
"values": [
|
|
2582
|
+
{
|
|
2583
|
+
"value": "assertive",
|
|
2584
|
+
"type": "string"
|
|
2585
|
+
},
|
|
2586
|
+
{
|
|
2587
|
+
"value": "off",
|
|
2588
|
+
"type": "string"
|
|
2589
|
+
},
|
|
2590
|
+
{
|
|
2591
|
+
"value": "polite",
|
|
2592
|
+
"type": "string"
|
|
2593
|
+
}
|
|
2594
|
+
],
|
|
2595
|
+
"optional": false,
|
|
2596
|
+
"required": false,
|
|
2597
|
+
"getter": false,
|
|
2598
|
+
"setter": false
|
|
2599
|
+
},
|
|
2472
2600
|
{
|
|
2473
2601
|
"name": "validationStatus",
|
|
2474
2602
|
"type": "\"\" | \"error\" | \"success\" | \"warning\"",
|
|
@@ -3531,6 +3659,45 @@
|
|
|
3531
3659
|
"getter": false,
|
|
3532
3660
|
"setter": false
|
|
3533
3661
|
},
|
|
3662
|
+
{
|
|
3663
|
+
"name": "validationAriaLive",
|
|
3664
|
+
"type": "\"assertive\" | \"off\" | \"polite\"",
|
|
3665
|
+
"complexType": {
|
|
3666
|
+
"original": "IcAriaLive",
|
|
3667
|
+
"resolved": "\"assertive\" | \"off\" | \"polite\"",
|
|
3668
|
+
"references": {
|
|
3669
|
+
"IcAriaLive": {
|
|
3670
|
+
"location": "import",
|
|
3671
|
+
"path": "../../utils/types",
|
|
3672
|
+
"id": "src/utils/types.ts::IcAriaLive"
|
|
3673
|
+
}
|
|
3674
|
+
}
|
|
3675
|
+
},
|
|
3676
|
+
"mutable": false,
|
|
3677
|
+
"attr": "validation-aria-live",
|
|
3678
|
+
"reflectToAttr": false,
|
|
3679
|
+
"docs": "The value of the `aria-live` attribute on the validation message.",
|
|
3680
|
+
"docsTags": [],
|
|
3681
|
+
"default": "\"polite\"",
|
|
3682
|
+
"values": [
|
|
3683
|
+
{
|
|
3684
|
+
"value": "assertive",
|
|
3685
|
+
"type": "string"
|
|
3686
|
+
},
|
|
3687
|
+
{
|
|
3688
|
+
"value": "off",
|
|
3689
|
+
"type": "string"
|
|
3690
|
+
},
|
|
3691
|
+
{
|
|
3692
|
+
"value": "polite",
|
|
3693
|
+
"type": "string"
|
|
3694
|
+
}
|
|
3695
|
+
],
|
|
3696
|
+
"optional": false,
|
|
3697
|
+
"required": false,
|
|
3698
|
+
"getter": false,
|
|
3699
|
+
"setter": false
|
|
3700
|
+
},
|
|
3534
3701
|
{
|
|
3535
3702
|
"name": "validationStatus",
|
|
3536
3703
|
"type": "\"\" | \"error\" | \"success\" | \"warning\" | undefined",
|
|
@@ -5166,6 +5333,45 @@
|
|
|
5166
5333
|
"getter": false,
|
|
5167
5334
|
"setter": false
|
|
5168
5335
|
},
|
|
5336
|
+
{
|
|
5337
|
+
"name": "validationAriaLive",
|
|
5338
|
+
"type": "\"assertive\" | \"off\" | \"polite\"",
|
|
5339
|
+
"complexType": {
|
|
5340
|
+
"original": "IcAriaLive",
|
|
5341
|
+
"resolved": "\"assertive\" | \"off\" | \"polite\"",
|
|
5342
|
+
"references": {
|
|
5343
|
+
"IcAriaLive": {
|
|
5344
|
+
"location": "import",
|
|
5345
|
+
"path": "../../utils/types",
|
|
5346
|
+
"id": "src/utils/types.ts::IcAriaLive"
|
|
5347
|
+
}
|
|
5348
|
+
}
|
|
5349
|
+
},
|
|
5350
|
+
"mutable": false,
|
|
5351
|
+
"attr": "validation-aria-live",
|
|
5352
|
+
"reflectToAttr": false,
|
|
5353
|
+
"docs": "The value of the `aria-live` attribute on the validation message.",
|
|
5354
|
+
"docsTags": [],
|
|
5355
|
+
"default": "\"polite\"",
|
|
5356
|
+
"values": [
|
|
5357
|
+
{
|
|
5358
|
+
"value": "assertive",
|
|
5359
|
+
"type": "string"
|
|
5360
|
+
},
|
|
5361
|
+
{
|
|
5362
|
+
"value": "off",
|
|
5363
|
+
"type": "string"
|
|
5364
|
+
},
|
|
5365
|
+
{
|
|
5366
|
+
"value": "polite",
|
|
5367
|
+
"type": "string"
|
|
5368
|
+
}
|
|
5369
|
+
],
|
|
5370
|
+
"optional": false,
|
|
5371
|
+
"required": false,
|
|
5372
|
+
"getter": false,
|
|
5373
|
+
"setter": false
|
|
5374
|
+
},
|
|
5169
5375
|
{
|
|
5170
5376
|
"name": "validationStatus",
|
|
5171
5377
|
"type": "\"\" | \"error\" | \"success\" | \"warning\"",
|
|
@@ -6131,15 +6337,20 @@
|
|
|
6131
6337
|
}
|
|
6132
6338
|
],
|
|
6133
6339
|
"typeLibrary": {
|
|
6134
|
-
"src/
|
|
6135
|
-
"declaration": "export type
|
|
6340
|
+
"src/utils/types.ts::IcCardDensity": {
|
|
6341
|
+
"declaration": "export type IcCardDensity = \"default\" | \"spacious\";",
|
|
6136
6342
|
"docstring": "",
|
|
6137
|
-
"path": "src/
|
|
6343
|
+
"path": "src/utils/types.ts"
|
|
6138
6344
|
},
|
|
6139
|
-
"
|
|
6140
|
-
"declaration": "
|
|
6345
|
+
"src/utils/types.ts::IcSizes": {
|
|
6346
|
+
"declaration": "export type IcSizes = \"medium\" | \"large\" | \"small\";",
|
|
6141
6347
|
"docstring": "",
|
|
6142
|
-
"path": "
|
|
6348
|
+
"path": "src/utils/types.ts"
|
|
6349
|
+
},
|
|
6350
|
+
"src/utils/types.ts::IcThemeMode": {
|
|
6351
|
+
"declaration": "export type IcThemeMode = \"dark\" | \"light\" | \"inherit\";",
|
|
6352
|
+
"docstring": "",
|
|
6353
|
+
"path": "src/utils/types.ts"
|
|
6143
6354
|
},
|
|
6144
6355
|
"src/components/ic-data-table/ic-data-table.types.tsx::IcDataTableColumnObject": {
|
|
6145
6356
|
"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}",
|
|
@@ -6171,11 +6382,6 @@
|
|
|
6171
6382
|
"docstring": "",
|
|
6172
6383
|
"path": "src/components/ic-data-table/ic-data-table.types.tsx"
|
|
6173
6384
|
},
|
|
6174
|
-
"src/utils/types.ts::IcThemeMode": {
|
|
6175
|
-
"declaration": "export type IcThemeMode = \"dark\" | \"light\" | \"inherit\";",
|
|
6176
|
-
"docstring": "",
|
|
6177
|
-
"path": "src/utils/types.ts"
|
|
6178
|
-
},
|
|
6179
6385
|
"src/components/ic-data-table/ic-data-table.types.tsx::IcDataTableTruncationTypes": {
|
|
6180
6386
|
"declaration": "export type IcDataTableTruncationTypes = \"tooltip\" | \"show-hide\" | undefined;",
|
|
6181
6387
|
"docstring": "",
|
|
@@ -6191,6 +6397,11 @@
|
|
|
6191
6397
|
"docstring": "",
|
|
6192
6398
|
"path": "../web-components/dist/types/components/ic-pagination/ic-pagination.types.d.ts"
|
|
6193
6399
|
},
|
|
6400
|
+
"../web-components/dist/types/interface.d.ts::IcThemeMode": {
|
|
6401
|
+
"declaration": "any",
|
|
6402
|
+
"docstring": "",
|
|
6403
|
+
"path": "../web-components/dist/types/interface.d.ts"
|
|
6404
|
+
},
|
|
6194
6405
|
"../web-components/dist/types/components/ic-pagination/ic-pagination.types.d.ts::IcPaginationTypes": {
|
|
6195
6406
|
"declaration": "export type IcPaginationTypes = \"simple\" | \"complex\";",
|
|
6196
6407
|
"docstring": "",
|
|
@@ -6226,8 +6437,8 @@
|
|
|
6226
6437
|
"docstring": "",
|
|
6227
6438
|
"path": "src/utils/types.ts"
|
|
6228
6439
|
},
|
|
6229
|
-
"src/utils/types.ts::
|
|
6230
|
-
"declaration": "export type
|
|
6440
|
+
"src/utils/types.ts::IcAriaLive": {
|
|
6441
|
+
"declaration": "export type IcAriaLive = \"polite\" | \"assertive\" | \"off\";",
|
|
6231
6442
|
"docstring": "",
|
|
6232
6443
|
"path": "src/utils/types.ts"
|
|
6233
6444
|
},
|
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.23",
|
|
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": "493547c4e200a7a41416a6dea9f60ff1ef72073f"
|
|
23
23
|
}
|