@ukic/canary-docs 3.0.0-canary.15 → 3.0.0-canary.17

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 +139 -65
  2. package/package.json +2 -2
package/docs.json CHANGED
@@ -9,7 +9,7 @@
9
9
  "filePath": "src/components/ic-card-horizontal/ic-card-horizontal.tsx",
10
10
  "encapsulation": "shadow",
11
11
  "tag": "ic-card-horizontal",
12
- "readme": "# ic-horizontal-card\n\n\n",
12
+ "readme": "# ic-horizontal-card\r\n\r\n\r\n\r",
13
13
  "docs": "",
14
14
  "docsTags": [
15
15
  {
@@ -472,7 +472,7 @@
472
472
  "filePath": "src/components/ic-data-table/ic-data-table.tsx",
473
473
  "encapsulation": "shadow",
474
474
  "tag": "ic-data-table",
475
- "readme": "# ic-data-table\n\n\n",
475
+ "readme": "# ic-data-table\r\n\r\n\r\n\r",
476
476
  "docs": "",
477
477
  "docsTags": [
478
478
  {
@@ -809,7 +809,7 @@
809
809
  "name": "loadingOptions",
810
810
  "type": "undefined | { description?: string | undefined; label?: string | undefined; labelDuration?: number | undefined; max?: number | undefined; min?: number | undefined; progress?: number | undefined; monochrome?: boolean | undefined; overlay?: boolean | undefined; }",
811
811
  "complexType": {
812
- "original": "{\n description?: string;\n label?: string;\n labelDuration?: number;\n max?: number;\n min?: number;\n progress?: number;\n monochrome?: boolean;\n overlay?: boolean;\n }",
812
+ "original": "{\r\n description?: string;\r\n label?: string;\r\n labelDuration?: number;\r\n max?: number;\r\n min?: number;\r\n progress?: number;\r\n monochrome?: boolean;\r\n overlay?: boolean;\r\n }",
813
813
  "resolved": "undefined | { description?: string | undefined; label?: string | undefined; labelDuration?: number | undefined; max?: number | undefined; min?: number | undefined; progress?: number | undefined; monochrome?: boolean | undefined; overlay?: boolean | undefined; }",
814
814
  "references": {}
815
815
  },
@@ -948,7 +948,7 @@
948
948
  "reflectToAttr": false,
949
949
  "docs": "Sets the props for the built-in pagination bar. If the `pagination-bar` slot is used then this prop is ignored.",
950
950
  "docsTags": [],
951
- "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 setToFirstPageOnPaginationChange: false,\n showGoToPageControl: true,\n showItemsPerPageControl: true,\n type: \"simple\",\n }",
951
+ "default": "{\r\n alignment: \"right\",\r\n hideAllFromItemsPerPage: false,\r\n hideRangeLabel: false,\r\n itemLabel: \"Item\",\r\n itemsPerPageOptions: [\r\n { label: \"10\", value: \"10\" },\r\n { label: \"25\", value: \"25\" },\r\n { label: \"50\", value: \"50\" },\r\n ],\r\n monochrome: false,\r\n pageLabel: \"Page\",\r\n rangeLabelType: \"page\",\r\n selectedItemsPerPage: 10,\r\n selectItemsPerPageOnEnter: true,\r\n setToFirstPageOnPaginationChange: false,\r\n showGoToPageControl: true,\r\n showItemsPerPageControl: true,\r\n type: \"simple\",\r\n }",
952
952
  "values": [
953
953
  {
954
954
  "type": "IcPaginationBarOptions"
@@ -1014,7 +1014,7 @@
1014
1014
  "name": "sortOptions",
1015
1015
  "type": "{ sortOrders: IcDataTableSortOrderOptions[]; defaultColumn?: string | undefined; }",
1016
1016
  "complexType": {
1017
- "original": "{\n sortOrders: IcDataTableSortOrderOptions[];\n defaultColumn?: string;\n }",
1017
+ "original": "{\r\n sortOrders: IcDataTableSortOrderOptions[];\r\n defaultColumn?: string;\r\n }",
1018
1018
  "resolved": "{ sortOrders: IcDataTableSortOrderOptions[]; defaultColumn?: string | undefined; }",
1019
1019
  "references": {
1020
1020
  "IcDataTableSortOrderOptions": {
@@ -1028,7 +1028,7 @@
1028
1028
  "reflectToAttr": false,
1029
1029
  "docs": "Sets the order columns will be sorted in and allows for 'default' sorts to be added.",
1030
1030
  "docsTags": [],
1031
- "default": "{\n sortOrders: [\"unsorted\", \"ascending\", \"descending\"],\n defaultColumn: \"\",\n }",
1031
+ "default": "{\r\n sortOrders: [\"unsorted\", \"ascending\", \"descending\"],\r\n defaultColumn: \"\",\r\n }",
1032
1032
  "values": [
1033
1033
  {
1034
1034
  "type": "{ sortOrders: IcDataTableSortOrderOptions[]; defaultColumn?: string"
@@ -1256,7 +1256,7 @@
1256
1256
  "name": "updatingOptions",
1257
1257
  "type": "undefined | { description?: string | undefined; max?: number | undefined; min?: number | undefined; progress?: number | undefined; monochrome?: boolean | undefined; }",
1258
1258
  "complexType": {
1259
- "original": "{\n description?: string;\n max?: number;\n min?: number;\n progress?: number;\n monochrome?: boolean;\n }",
1259
+ "original": "{\r\n description?: string;\r\n max?: number;\r\n min?: number;\r\n progress?: number;\r\n monochrome?: boolean;\r\n }",
1260
1260
  "resolved": "undefined | { description?: string | undefined; max?: number | undefined; min?: number | undefined; progress?: number | undefined; monochrome?: boolean | undefined; }",
1261
1261
  "references": {}
1262
1262
  },
@@ -1296,7 +1296,7 @@
1296
1296
  "name": "variableRowHeight",
1297
1297
  "type": "((params: { [key: string]: any; index: number; }) => IcDataTableRowHeights | null) | undefined",
1298
1298
  "complexType": {
1299
- "original": "(params: {\n [key: string]: any;\n index: number;\n }) => IcDataTableRowHeights | null",
1299
+ "original": "(params: {\r\n [key: string]: any;\r\n index: number;\r\n }) => IcDataTableRowHeights | null",
1300
1300
  "resolved": "((params: { [key: string]: any; index: number; }) => IcDataTableRowHeights | null) | undefined",
1301
1301
  "references": {
1302
1302
  "IcDataTableRowHeights": {
@@ -1308,7 +1308,7 @@
1308
1308
  },
1309
1309
  "mutable": true,
1310
1310
  "reflectToAttr": false,
1311
- "docs": "Allows for custom setting of row heights on individual rows based on an individual value from the `data` prop and the row index.\nIf the function returns `null`, that row's height will be set to the `globalRowHeight` property.",
1311
+ "docs": "Allows for custom setting of row heights on individual rows based on an individual value from the `data` prop and the row index.\r\nIf the function returns `null`, that row's height will be set to the `globalRowHeight` property.",
1312
1312
  "docsTags": [],
1313
1313
  "values": [
1314
1314
  {
@@ -1390,6 +1390,34 @@
1390
1390
  }
1391
1391
  ],
1392
1392
  "events": [
1393
+ {
1394
+ "event": "icColumnsLoaded",
1395
+ "detail": "void",
1396
+ "bubbles": true,
1397
+ "complexType": {
1398
+ "original": "void",
1399
+ "resolved": "void",
1400
+ "references": {}
1401
+ },
1402
+ "cancelable": true,
1403
+ "composed": true,
1404
+ "docs": "Emitted when the columns have finished loading after being updated or initially rendered.",
1405
+ "docsTags": []
1406
+ },
1407
+ {
1408
+ "event": "icDataLoaded",
1409
+ "detail": "void",
1410
+ "bubbles": true,
1411
+ "complexType": {
1412
+ "original": "void",
1413
+ "resolved": "void",
1414
+ "references": {}
1415
+ },
1416
+ "cancelable": true,
1417
+ "composed": true,
1418
+ "docs": "Emitted when the data has finished loading after being updated or initially rendered.",
1419
+ "docsTags": []
1420
+ },
1393
1421
  {
1394
1422
  "event": "icRowHeightChange",
1395
1423
  "detail": "void",
@@ -1429,7 +1457,7 @@
1429
1457
  "detail": "{ row: IcDataTableDataType | null; selectedRows: IcDataTableDataType[]; }",
1430
1458
  "bubbles": true,
1431
1459
  "complexType": {
1432
- "original": "{\n row: IcDataTableDataType | null;\n selectedRows: IcDataTableDataType[];\n }",
1460
+ "original": "{\r\n row: IcDataTableDataType | null;\r\n selectedRows: IcDataTableDataType[];\r\n }",
1433
1461
  "resolved": "{ row: IcDataTableDataType | null; selectedRows: IcDataTableDataType[]; }",
1434
1462
  "references": {
1435
1463
  "IcDataTableDataType": {
@@ -1598,7 +1626,7 @@
1598
1626
  "filePath": "src/components/ic-data-table-title-bar/ic-data-table-title-bar.tsx",
1599
1627
  "encapsulation": "shadow",
1600
1628
  "tag": "ic-data-table-title-bar",
1601
- "readme": "# ic-data-table-title-bar\n\n\n",
1629
+ "readme": "# ic-data-table-title-bar\r\n\r\n\r\n\r",
1602
1630
  "docs": "",
1603
1631
  "docsTags": [
1604
1632
  {
@@ -1818,9 +1846,14 @@
1818
1846
  "filePath": "src/components/ic-date-input/ic-date-input.tsx",
1819
1847
  "encapsulation": "shadow",
1820
1848
  "tag": "ic-date-input",
1821
- "readme": "# ic-date-input\n\n\n",
1849
+ "readme": "# ic-date-input\r\n\r\n\r\n\r",
1822
1850
  "docs": "",
1823
- "docsTags": [],
1851
+ "docsTags": [
1852
+ {
1853
+ "name": "slot",
1854
+ "text": "helper-text - Content is set as the helper text for the date input."
1855
+ }
1856
+ ],
1824
1857
  "usage": {},
1825
1858
  "props": [
1826
1859
  {
@@ -2232,7 +2265,7 @@
2232
2265
  "mutable": false,
2233
2266
  "attr": "max",
2234
2267
  "reflectToAttr": false,
2235
- "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`.",
2268
+ "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.\r\nThe value of this prop is ignored if `disableFuture` is set to `true`.",
2236
2269
  "docsTags": [],
2237
2270
  "default": "\"\"",
2238
2271
  "values": [
@@ -2264,7 +2297,7 @@
2264
2297
  "mutable": false,
2265
2298
  "attr": "min",
2266
2299
  "reflectToAttr": false,
2267
- "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`.",
2300
+ "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.\r\nThe value of this prop is ignored if `disablePast` is set to `true`.",
2268
2301
  "docsTags": [],
2269
2302
  "default": "\"\"",
2270
2303
  "values": [
@@ -2602,7 +2635,7 @@
2602
2635
  "detail": "{ value: Date | null; dateObject: { day: string | null; month: string | null; year: string | null; }; utcValue: Date | null; }",
2603
2636
  "bubbles": true,
2604
2637
  "complexType": {
2605
- "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 }",
2638
+ "original": "{\r\n value: Date | null;\r\n dateObject: {\r\n day: string | null;\r\n month: string | null;\r\n year: string | null;\r\n };\r\n utcValue: Date | null;\r\n }",
2606
2639
  "resolved": "{ value: Date | null; dateObject: { day: string | null; month: string | null; year: string | null; }; utcValue: Date | null; }",
2607
2640
  "references": {
2608
2641
  "Date": {
@@ -2638,7 +2671,12 @@
2638
2671
  ],
2639
2672
  "listeners": [],
2640
2673
  "styles": [],
2641
- "slots": [],
2674
+ "slots": [
2675
+ {
2676
+ "name": "helper-text",
2677
+ "docs": "Content is set as the helper text for the date input."
2678
+ }
2679
+ ],
2642
2680
  "parts": [],
2643
2681
  "dependents": [
2644
2682
  "ic-date-picker"
@@ -2684,9 +2722,14 @@
2684
2722
  "filePath": "src/components/ic-date-picker/ic-date-picker.tsx",
2685
2723
  "encapsulation": "shadow",
2686
2724
  "tag": "ic-date-picker",
2687
- "readme": "# ic-date-picker\n\n\n",
2725
+ "readme": "# ic-date-picker\r\n\r\n\r\n\r",
2688
2726
  "docs": "",
2689
- "docsTags": [],
2727
+ "docsTags": [
2728
+ {
2729
+ "name": "slot",
2730
+ "text": "helper-text - Content is set as the helper text for the date picker."
2731
+ }
2732
+ ],
2690
2733
  "usage": {},
2691
2734
  "props": [
2692
2735
  {
@@ -3115,7 +3158,7 @@
3115
3158
  "mutable": false,
3116
3159
  "attr": "max",
3117
3160
  "reflectToAttr": false,
3118
- "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`.",
3161
+ "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.\r\nThe value of this prop is ignored if `disableFuture` is set to `true`.",
3119
3162
  "docsTags": [],
3120
3163
  "default": "\"\"",
3121
3164
  "values": [
@@ -3147,7 +3190,7 @@
3147
3190
  "mutable": false,
3148
3191
  "attr": "min",
3149
3192
  "reflectToAttr": false,
3150
- "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`.",
3193
+ "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.\r\nThe value of this prop is ignored if `disablePast` is set to `true`.",
3151
3194
  "docsTags": [],
3152
3195
  "default": "\"\"",
3153
3196
  "values": [
@@ -3205,7 +3248,7 @@
3205
3248
  "mutable": false,
3206
3249
  "attr": "open-at-date",
3207
3250
  "reflectToAttr": false,
3208
- "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.",
3251
+ "docs": "The date visible when the calendar opens. Used if no date is currently selected.\r\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.",
3209
3252
  "docsTags": [],
3210
3253
  "default": "\"\"",
3211
3254
  "values": [
@@ -3388,7 +3431,7 @@
3388
3431
  "mutable": false,
3389
3432
  "attr": "start-of-week",
3390
3433
  "reflectToAttr": false,
3391
- "docs": "The first day of the week. `0` for Sunday, `1` for Monday, etc.\nDefault is Monday.",
3434
+ "docs": "The first day of the week. `0` for Sunday, `1` for Monday, etc.\r\nDefault is Monday.",
3392
3435
  "docsTags": [],
3393
3436
  "default": "IcWeekDays.Monday",
3394
3437
  "values": [
@@ -3619,7 +3662,12 @@
3619
3662
  "docs": "Width of the input field"
3620
3663
  }
3621
3664
  ],
3622
- "slots": [],
3665
+ "slots": [
3666
+ {
3667
+ "name": "helper-text",
3668
+ "docs": "Content is set as the helper text for the date picker."
3669
+ }
3670
+ ],
3623
3671
  "parts": [],
3624
3672
  "dependents": [],
3625
3673
  "dependencies": [
@@ -3663,7 +3711,7 @@
3663
3711
  "filePath": "src/components/ic-pagination-bar/ic-pagination-bar.tsx",
3664
3712
  "encapsulation": "shadow",
3665
3713
  "tag": "ic-pagination-bar",
3666
- "readme": "# ic-pagination-bar\n\n\n",
3714
+ "readme": "# ic-pagination-bar\r\n\r\n\r\n\r",
3667
3715
  "docs": "",
3668
3716
  "docsTags": [],
3669
3717
  "usage": {},
@@ -3822,7 +3870,7 @@
3822
3870
  "name": "itemsPerPageOptions",
3823
3871
  "type": "undefined | { label: string; value: string; }[]",
3824
3872
  "complexType": {
3825
- "original": "{\n label: string;\n value: string;\n }[]",
3873
+ "original": "{\r\n label: string;\r\n value: string;\r\n }[]",
3826
3874
  "resolved": "undefined | { label: string; value: string; }[]",
3827
3875
  "references": {}
3828
3876
  },
@@ -3935,6 +3983,30 @@
3935
3983
  "getter": false,
3936
3984
  "setter": false
3937
3985
  },
3986
+ {
3987
+ "name": "selectItemsPerPageOnEnter",
3988
+ "type": "boolean",
3989
+ "complexType": {
3990
+ "original": "boolean",
3991
+ "resolved": "boolean",
3992
+ "references": {}
3993
+ },
3994
+ "mutable": false,
3995
+ "attr": "select-items-per-page-on-enter",
3996
+ "reflectToAttr": false,
3997
+ "docs": "If `false`, the value in the items per page control will be set immediately on ArrowUp and ArrowDown instead of when Enter is pressed.",
3998
+ "docsTags": [],
3999
+ "default": "true",
4000
+ "values": [
4001
+ {
4002
+ "type": "boolean"
4003
+ }
4004
+ ],
4005
+ "optional": false,
4006
+ "required": false,
4007
+ "getter": false,
4008
+ "setter": false
4009
+ },
3938
4010
  {
3939
4011
  "name": "selectedItemsPerPage",
3940
4012
  "type": "number | undefined",
@@ -4179,7 +4251,7 @@
4179
4251
  },
4180
4252
  "cancelable": true,
4181
4253
  "composed": true,
4182
- "docs": "Emitted when a page is navigated to via the 'go to' input.\nThe `detail` property contains `value` (i.e. the page number) and a `fromItemsPerPage` flag to indicate if the event was triggered by the `icItemsPerPageChange` event also occurring.",
4254
+ "docs": "Emitted when a page is navigated to via the 'go to' input.\r\nThe `detail` property contains `value` (i.e. the page number) and a `fromItemsPerPage` flag to indicate if the event was triggered by the `icItemsPerPageChange` event also occurring.",
4183
4255
  "docsTags": []
4184
4256
  }
4185
4257
  ],
@@ -4267,7 +4339,7 @@
4267
4339
  "filePath": "src/components/ic-tree-item/ic-tree-item.tsx",
4268
4340
  "encapsulation": "shadow",
4269
4341
  "tag": "ic-tree-item",
4270
- "readme": "# ic-tree-item\n\n\n",
4342
+ "readme": "# ic-tree-item\r\n\r\n\r\n\r",
4271
4343
  "docs": "",
4272
4344
  "docsTags": [
4273
4345
  {
@@ -4591,6 +4663,32 @@
4591
4663
  "getter": false,
4592
4664
  "setter": false
4593
4665
  },
4666
+ {
4667
+ "name": "treeItemId",
4668
+ "type": "string | undefined",
4669
+ "complexType": {
4670
+ "original": "string",
4671
+ "resolved": "string | undefined",
4672
+ "references": {}
4673
+ },
4674
+ "mutable": false,
4675
+ "attr": "tree-item-id",
4676
+ "reflectToAttr": false,
4677
+ "docs": "Sets the tree item id. Must be unique.",
4678
+ "docsTags": [],
4679
+ "values": [
4680
+ {
4681
+ "type": "string"
4682
+ },
4683
+ {
4684
+ "type": "undefined"
4685
+ }
4686
+ ],
4687
+ "optional": true,
4688
+ "required": false,
4689
+ "getter": false,
4690
+ "setter": false
4691
+ },
4594
4692
  {
4595
4693
  "name": "truncateTreeItem",
4596
4694
  "type": "boolean | undefined",
@@ -4645,11 +4743,11 @@
4645
4743
  "events": [
4646
4744
  {
4647
4745
  "event": "icTreeItemExpanded",
4648
- "detail": "{ isExpanded: boolean; }",
4746
+ "detail": "{ isExpanded: boolean; id: string; }",
4649
4747
  "bubbles": true,
4650
4748
  "complexType": {
4651
- "original": "{ isExpanded: boolean }",
4652
- "resolved": "{ isExpanded: boolean; }",
4749
+ "original": "{\r\n isExpanded: boolean;\r\n id: string;\r\n }",
4750
+ "resolved": "{ isExpanded: boolean; id: string; }",
4653
4751
  "references": {}
4654
4752
  },
4655
4753
  "cancelable": true,
@@ -4714,7 +4812,7 @@
4714
4812
  "filePath": "src/components/ic-tree-view/ic-tree-view.tsx",
4715
4813
  "encapsulation": "shadow",
4716
4814
  "tag": "ic-tree-view",
4717
- "readme": "# ic-tree-view\n\n\n",
4815
+ "readme": "# ic-tree-view\r\n\r\n\r\n\r",
4718
4816
  "docs": "",
4719
4817
  "docsTags": [
4720
4818
  {
@@ -4728,30 +4826,6 @@
4728
4826
  ],
4729
4827
  "usage": {},
4730
4828
  "props": [
4731
- {
4732
- "name": "focusInset",
4733
- "type": "boolean",
4734
- "complexType": {
4735
- "original": "boolean",
4736
- "resolved": "boolean",
4737
- "references": {}
4738
- },
4739
- "mutable": false,
4740
- "attr": "focus-inset",
4741
- "reflectToAttr": false,
4742
- "docs": "If `true`, tree items will have inset focus.",
4743
- "docsTags": [],
4744
- "default": "false",
4745
- "values": [
4746
- {
4747
- "type": "boolean"
4748
- }
4749
- ],
4750
- "optional": false,
4751
- "required": false,
4752
- "getter": false,
4753
- "setter": false
4754
- },
4755
4829
  {
4756
4830
  "name": "heading",
4757
4831
  "type": "string",
@@ -4900,7 +4974,7 @@
4900
4974
  "mutable": true,
4901
4975
  "attr": "truncate-heading",
4902
4976
  "reflectToAttr": false,
4903
- "docs": "If `true`, the tree view heading will be truncated instead of text wrapping.\nWhen used on small devices, this prop will be overridden and headings will be set to text-wrap.",
4977
+ "docs": "If `true`, the tree view heading will be truncated instead of text wrapping.\r\nWhen used on small devices, this prop will be overridden and headings will be set to text-wrap.",
4904
4978
  "docsTags": [],
4905
4979
  "default": "false",
4906
4980
  "values": [
@@ -4924,7 +4998,7 @@
4924
4998
  "mutable": true,
4925
4999
  "attr": "truncate-tree-items",
4926
5000
  "reflectToAttr": false,
4927
- "docs": "If `true`, tree items will be truncated, unless they are individually overridden.\nWhen used on small devices, this prop will be overridden and tree-items will be set to text-wrap.",
5001
+ "docs": "If `true`, tree items will be truncated, unless they are individually overridden.\r\nWhen used on small devices, this prop will be overridden and tree-items will be set to text-wrap.",
4928
5002
  "docsTags": [],
4929
5003
  "default": "false",
4930
5004
  "values": [
@@ -4993,7 +5067,7 @@
4993
5067
  "path": "../web-components/dist/types/interface.d.ts"
4994
5068
  },
4995
5069
  "src/components/ic-data-table/ic-data-table.types.tsx::IcDataTableColumnObject": {
4996
- "declaration": "{\n key: string;\n title: string;\n dataType: IcDataTableColumnDataTypes;\n columnAlignment?: {\n horizontal?: string;\n vertical?: string;\n };\n rowOptions?: {\n textWrap: boolean;\n };\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}",
5070
+ "declaration": "{\r\n key: string;\r\n title: string;\r\n dataType: IcDataTableColumnDataTypes;\r\n columnAlignment?: {\r\n horizontal?: string;\r\n vertical?: string;\r\n };\r\n rowOptions?: {\r\n textWrap: boolean;\r\n };\r\n columnWidth?: string | IcDataTableColumnWidthTypes;\r\n textWrap?: boolean;\r\n cellAlignment?: string;\r\n emphasis?: string;\r\n colspan?: number;\r\n icon?: {\r\n icon: string;\r\n onAllCells?: boolean;\r\n hideOnHeader?: boolean;\r\n };\r\n excludeColumnFromSort?: boolean;\r\n disableAutoSort?: boolean;\r\n}",
4997
5071
  "docstring": "",
4998
5072
  "path": "src/components/ic-data-table/ic-data-table.types.tsx"
4999
5073
  },
@@ -5013,12 +5087,12 @@
5013
5087
  "path": "src/components/ic-data-table/ic-data-table.types.tsx"
5014
5088
  },
5015
5089
  "src/utils/types.ts::IcPaginationBarOptions": {
5016
- "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 setToFirstPageOnPaginationChange?: boolean;\n showGoToPageControl?: boolean;\n showItemsPerPageControl?: boolean;\n theme?: IcThemeMode;\n type?: IcPaginationTypes;\n}",
5090
+ "declaration": "export interface IcPaginationBarOptions {\r\n alignment?: IcPaginationAlignmentOptions;\r\n hideAllFromItemsPerPage?: boolean;\r\n hideRangeLabel?: boolean;\r\n itemLabel?: string;\r\n itemsPerPageOptions?: { label: string; value: string }[];\r\n monochrome?: boolean;\r\n pageLabel?: string;\r\n rangeLabelType?: IcPaginationLabelTypes;\r\n selectedItemsPerPage?: number;\r\n selectItemsPerPageOnEnter?: boolean;\r\n setToFirstPageOnPaginationChange?: boolean;\r\n showGoToPageControl?: boolean;\r\n showItemsPerPageControl?: boolean;\r\n theme?: IcThemeMode;\r\n type?: IcPaginationTypes;\r\n}",
5017
5091
  "docstring": "",
5018
5092
  "path": "src/utils/types.ts"
5019
5093
  },
5020
5094
  "src/components/ic-data-table/ic-data-table.types.tsx::IcDataTableSortOrderOptions": {
5021
- "declaration": "export type IcDataTableSortOrderOptions =\n | \"unsorted\"\n | \"ascending\"\n | \"descending\";",
5095
+ "declaration": "export type IcDataTableSortOrderOptions =\r\n | \"unsorted\"\r\n | \"ascending\"\r\n | \"descending\";",
5022
5096
  "docstring": "",
5023
5097
  "path": "src/components/ic-data-table/ic-data-table.types.tsx"
5024
5098
  },
@@ -5033,7 +5107,7 @@
5033
5107
  "path": "src/components/ic-data-table/ic-data-table.types.tsx"
5034
5108
  },
5035
5109
  "src/components/ic-data-table/ic-data-table.types.tsx::IcSortEventDetail": {
5036
- "declaration": "export interface IcSortEventDetail {\n columnName: string;\n sorted: IcDataTableSortOrderOptions;\n}",
5110
+ "declaration": "export interface IcSortEventDetail {\r\n columnName: string;\r\n sorted: IcDataTableSortOrderOptions;\r\n}",
5037
5111
  "docstring": "",
5038
5112
  "path": "src/components/ic-data-table/ic-data-table.types.tsx"
5039
5113
  },
@@ -5058,7 +5132,7 @@
5058
5132
  "path": "src/components/ic-pagination-bar/ic-pagination-bar.types.ts"
5059
5133
  },
5060
5134
  "src/components/ic-data-table/ic-data-table.types.tsx::IcDensityUpdateEventDetail": {
5061
- "declaration": "export interface IcDensityUpdateEventDetail {\n value: IcDataTableDensityOptions;\n}",
5135
+ "declaration": "export interface IcDensityUpdateEventDetail {\r\n value: IcDataTableDensityOptions;\r\n}",
5062
5136
  "docstring": "",
5063
5137
  "path": "src/components/ic-data-table/ic-data-table.types.tsx"
5064
5138
  },
@@ -5068,7 +5142,7 @@
5068
5142
  "path": "src/utils/types.ts"
5069
5143
  },
5070
5144
  "src/utils/types.ts::IcWeekDays": {
5071
- "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}",
5145
+ "declaration": "export enum IcWeekDays {\r\n Sunday = 0,\r\n Monday = 1,\r\n Tuesday = 2,\r\n Wednesday = 3,\r\n Thursday = 4,\r\n Friday = 5,\r\n Saturday = 6,\r\n}",
5072
5146
  "docstring": "",
5073
5147
  "path": "src/utils/types.ts"
5074
5148
  },
@@ -5083,7 +5157,7 @@
5083
5157
  "path": "src/utils/types.ts"
5084
5158
  },
5085
5159
  "src/components/ic-tree-view/ic-tree-view.types.tsx::IcTreeItemOptions": {
5086
- "declaration": "{\n label: string;\n icon?: string;\n children?: IcTreeItemOptions[];\n disabled?: boolean;\n expanded?: boolean;\n href?: string;\n selected?: boolean;\n theme?: IcThemeMode;\n truncateTreeItem?: boolean;\n}",
5160
+ "declaration": "{\r\n label: string;\r\n icon?: string;\r\n children?: IcTreeItemOptions[];\r\n disabled?: boolean;\r\n expanded?: boolean;\r\n href?: string;\r\n selected?: boolean;\r\n treeItemId?: string;\r\n theme?: IcThemeMode;\r\n truncateTreeItem?: boolean;\r\n}",
5087
5161
  "docstring": "",
5088
5162
  "path": "src/components/ic-tree-view/ic-tree-view.types.tsx"
5089
5163
  }
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.15",
4
+ "version": "3.0.0-canary.17",
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": "c5aacb4fbd31c869f377411da6561eb6a2645966"
22
+ "gitHead": "b2e5e8e0ebf877277c71d9b8c72edde315c70fe5"
23
23
  }