@ukic/canary-docs 3.0.0-canary.22 → 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.
Files changed (2) hide show
  1. package/docs.json +122 -33
  2. package/package.json +2 -2
package/docs.json CHANGED
@@ -22,12 +22,28 @@
22
22
  },
23
23
  {
24
24
  "name": "slot",
25
- "text": "image - Content will be placed to the left of all other content."
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": "\"extra-large\" | \"large\" | \"medium\" | \"small\"",
334
+ "type": "\"large\" | \"medium\" | \"small\"",
284
335
  "complexType": {
285
- "original": "IcCardSizes",
286
- "resolved": "\"extra-large\" | \"large\" | \"medium\" | \"small\"",
336
+ "original": "IcSizes",
337
+ "resolved": "\"large\" | \"medium\" | \"small\"",
287
338
  "references": {
288
- "IcCardSizes": {
339
+ "IcSizes": {
289
340
  "location": "import",
290
- "path": "./ic-card-horizontal.types",
291
- "id": "src/components/ic-card-horizontal/ic-card-horizontal.types.ts::IcCardSizes"
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": "@ukic/web-components",
360
- "id": "../web-components/dist/types/interface.d.ts::IcThemeMode"
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",
@@ -6248,15 +6337,20 @@
6248
6337
  }
6249
6338
  ],
6250
6339
  "typeLibrary": {
6251
- "src/components/ic-card-horizontal/ic-card-horizontal.types.ts::IcCardSizes": {
6252
- "declaration": "export type IcCardSizes = \"small\" | \"medium\" | \"large\" | \"extra-large\";",
6340
+ "src/utils/types.ts::IcCardDensity": {
6341
+ "declaration": "export type IcCardDensity = \"default\" | \"spacious\";",
6253
6342
  "docstring": "",
6254
- "path": "src/components/ic-card-horizontal/ic-card-horizontal.types.ts"
6343
+ "path": "src/utils/types.ts"
6255
6344
  },
6256
- "../web-components/dist/types/interface.d.ts::IcThemeMode": {
6257
- "declaration": "any",
6345
+ "src/utils/types.ts::IcSizes": {
6346
+ "declaration": "export type IcSizes = \"medium\" | \"large\" | \"small\";",
6258
6347
  "docstring": "",
6259
- "path": "../web-components/dist/types/interface.d.ts"
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"
6260
6354
  },
6261
6355
  "src/components/ic-data-table/ic-data-table.types.tsx::IcDataTableColumnObject": {
6262
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}",
@@ -6288,11 +6382,6 @@
6288
6382
  "docstring": "",
6289
6383
  "path": "src/components/ic-data-table/ic-data-table.types.tsx"
6290
6384
  },
6291
- "src/utils/types.ts::IcThemeMode": {
6292
- "declaration": "export type IcThemeMode = \"dark\" | \"light\" | \"inherit\";",
6293
- "docstring": "",
6294
- "path": "src/utils/types.ts"
6295
- },
6296
6385
  "src/components/ic-data-table/ic-data-table.types.tsx::IcDataTableTruncationTypes": {
6297
6386
  "declaration": "export type IcDataTableTruncationTypes = \"tooltip\" | \"show-hide\" | undefined;",
6298
6387
  "docstring": "",
@@ -6308,6 +6397,11 @@
6308
6397
  "docstring": "",
6309
6398
  "path": "../web-components/dist/types/components/ic-pagination/ic-pagination.types.d.ts"
6310
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
+ },
6311
6405
  "../web-components/dist/types/components/ic-pagination/ic-pagination.types.d.ts::IcPaginationTypes": {
6312
6406
  "declaration": "export type IcPaginationTypes = \"simple\" | \"complex\";",
6313
6407
  "docstring": "",
@@ -6343,11 +6437,6 @@
6343
6437
  "docstring": "",
6344
6438
  "path": "src/utils/types.ts"
6345
6439
  },
6346
- "src/utils/types.ts::IcSizes": {
6347
- "declaration": "export type IcSizes = \"medium\" | \"large\" | \"small\";",
6348
- "docstring": "",
6349
- "path": "src/utils/types.ts"
6350
- },
6351
6440
  "src/utils/types.ts::IcAriaLive": {
6352
6441
  "declaration": "export type IcAriaLive = \"polite\" | \"assertive\" | \"off\";",
6353
6442
  "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.22",
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": "7218b39b3c6116e600c3e6ba9e785d0b2f3a390a"
22
+ "gitHead": "493547c4e200a7a41416a6dea9f60ff1ef72073f"
23
23
  }