@ukic/docs 3.0.0-alpha.7 → 3.0.0-alpha.8

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 +123 -111
  2. package/package.json +2 -2
package/docs.json CHANGED
@@ -9,7 +9,7 @@
9
9
  "filePath": "src/components/ic-accordion/ic-accordion.tsx",
10
10
  "encapsulation": "shadow",
11
11
  "tag": "ic-accordion",
12
- "readme": "# ic-accordion\r\n\r\n\r\n\r",
12
+ "readme": "# ic-accordion\n\n\n",
13
13
  "docs": "",
14
14
  "docsTags": [
15
15
  {
@@ -238,7 +238,7 @@
238
238
  "filePath": "src/components/ic-accordion-group/ic-accordion-group.tsx",
239
239
  "encapsulation": "shadow",
240
240
  "tag": "ic-accordion-group",
241
- "readme": "# ic-accordion-title\r\n\r\n\r\n\r",
241
+ "readme": "# ic-accordion-title\n\n\n",
242
242
  "docs": "",
243
243
  "docsTags": [
244
244
  {
@@ -431,7 +431,7 @@
431
431
  },
432
432
  "signature": "setFocus() => Promise<void>",
433
433
  "parameters": [],
434
- "docs": "Sets the focus on first focusable element in the accordion group. If the \"See/Hide all\" button is present, it will be focused.\r\nOtherwise, the first accordion will be focused.",
434
+ "docs": "Sets the focus on first focusable element in the accordion group. If the \"See/Hide all\" button is present, it will be focused.\nOtherwise, the first accordion will be focused.",
435
435
  "docsTags": []
436
436
  }
437
437
  ],
@@ -477,7 +477,7 @@
477
477
  "filePath": "src/components/ic-alert/ic-alert.tsx",
478
478
  "encapsulation": "shadow",
479
479
  "tag": "ic-alert",
480
- "readme": "# ic-alert\r\n\r\n\r\n\r",
480
+ "readme": "# ic-alert\n\n\n",
481
481
  "docs": "",
482
482
  "docsTags": [
483
483
  {
@@ -775,7 +775,7 @@
775
775
  "filePath": "src/components/ic-back-to-top/ic-back-to-top.tsx",
776
776
  "encapsulation": "shadow",
777
777
  "tag": "ic-back-to-top",
778
- "readme": "# ic-back-to-top\r\n\r\n\r\n\r",
778
+ "readme": "# ic-back-to-top\n\n\n",
779
779
  "docs": "",
780
780
  "docsTags": [],
781
781
  "usage": {},
@@ -908,7 +908,7 @@
908
908
  "filePath": "src/components/ic-badge/ic-badge.tsx",
909
909
  "encapsulation": "shadow",
910
910
  "tag": "ic-badge",
911
- "readme": "# ic-badge\r\n\r\n\r\n\r",
911
+ "readme": "# ic-badge\n\n\n",
912
912
  "docs": "",
913
913
  "docsTags": [
914
914
  {
@@ -956,7 +956,7 @@
956
956
  "mutable": false,
957
957
  "attr": "custom-color",
958
958
  "reflectToAttr": false,
959
- "docs": "The custom badge colour. This will only style the badge component if variant=\"custom\".\r\nCan be a hex value e.g. \"#ff0000\", RGB e.g. \"rgb(255, 0, 0)\", or RGBA e.g. \"rgba(255, 0, 0, 1)\".",
959
+ "docs": "The custom badge colour. This will only style the badge component if variant=\"custom\".\nCan be a hex value e.g. \"#ff0000\", RGB e.g. \"rgb(255, 0, 0)\", or RGBA e.g. \"rgba(255, 0, 0, 1)\".",
960
960
  "docsTags": [],
961
961
  "default": "null",
962
962
  "values": [
@@ -1005,7 +1005,7 @@
1005
1005
  "mutable": false,
1006
1006
  "attr": "max-number",
1007
1007
  "reflectToAttr": false,
1008
- "docs": "The maximum number shown on the badge appended with a +.\r\nThis will only be displayed if type=\"text\" and label is not empty.",
1008
+ "docs": "The maximum number shown on the badge appended with a +.\nThis will only be displayed if type=\"text\" and label is not empty.",
1009
1009
  "docsTags": [],
1010
1010
  "values": [
1011
1011
  {
@@ -1264,7 +1264,7 @@
1264
1264
  "filePath": "src/components/ic-breadcrumb/ic-breadcrumb.tsx",
1265
1265
  "encapsulation": "shadow",
1266
1266
  "tag": "ic-breadcrumb",
1267
- "readme": "# ic-breadcrumb\r\n\r\n\r\n\r",
1267
+ "readme": "# ic-breadcrumb\n\n\n",
1268
1268
  "docs": "",
1269
1269
  "docsTags": [
1270
1270
  {
@@ -1392,7 +1392,7 @@
1392
1392
  "filePath": "src/components/ic-breadcrumb-group/ic-breadcrumb-group.tsx",
1393
1393
  "encapsulation": "shadow",
1394
1394
  "tag": "ic-breadcrumb-group",
1395
- "readme": "# ic-breadcrumb-group\r\n\r\n\r\n\r",
1395
+ "readme": "# ic-breadcrumb-group\n\n\n",
1396
1396
  "docs": "",
1397
1397
  "docsTags": [],
1398
1398
  "usage": {},
@@ -1524,7 +1524,7 @@
1524
1524
  "filePath": "src/components/ic-button/ic-button.tsx",
1525
1525
  "encapsulation": "shadow",
1526
1526
  "tag": "ic-button",
1527
- "readme": "# ic-button\r\n\r",
1527
+ "readme": "# ic-button\n",
1528
1528
  "docs": "",
1529
1529
  "docsTags": [
1530
1530
  {
@@ -2554,7 +2554,7 @@
2554
2554
  "filePath": "src/components/ic-card-vertical/ic-card-vertical.tsx",
2555
2555
  "encapsulation": "shadow",
2556
2556
  "tag": "ic-card-vertical",
2557
- "readme": "# ic-card-vertical\r\n\r\n\r\n\r",
2557
+ "readme": "# ic-card-vertical\n\n\n",
2558
2558
  "docs": "",
2559
2559
  "docsTags": [
2560
2560
  {
@@ -3042,7 +3042,7 @@
3042
3042
  "filePath": "src/components/ic-checkbox/ic-checkbox.tsx",
3043
3043
  "encapsulation": "shadow",
3044
3044
  "tag": "ic-checkbox",
3045
- "readme": "# ic-checkbox\r\n\r\n\r\n\r",
3045
+ "readme": "# ic-checkbox\n\n\n",
3046
3046
  "docs": "",
3047
3047
  "docsTags": [
3048
3048
  {
@@ -3463,7 +3463,7 @@
3463
3463
  "filePath": "src/components/ic-checkbox-group/ic-checkbox-group.tsx",
3464
3464
  "encapsulation": "shadow",
3465
3465
  "tag": "ic-checkbox-group",
3466
- "readme": "# ic-checkbox-group\r\n\r\n\r\n\r",
3466
+ "readme": "# ic-checkbox-group\n\n\n",
3467
3467
  "docs": "",
3468
3468
  "docsTags": [],
3469
3469
  "usage": {},
@@ -3795,7 +3795,7 @@
3795
3795
  "filePath": "src/components/ic-chip/ic-chip.tsx",
3796
3796
  "encapsulation": "shadow",
3797
3797
  "tag": "ic-chip",
3798
- "readme": "# ic-chip\r\n\r\n\r\n\r",
3798
+ "readme": "# ic-chip\n\n\n",
3799
3799
  "docs": "",
3800
3800
  "docsTags": [
3801
3801
  {
@@ -3826,7 +3826,7 @@
3826
3826
  "mutable": false,
3827
3827
  "attr": "custom-color",
3828
3828
  "reflectToAttr": false,
3829
- "docs": "The custom chip colour. This will override the theme colour.\r\nCan be a hex value e.g. \"#ff0000\", RGB e.g. \"rgb(255, 0, 0)\", or RGBA e.g. \"rgba(255, 0, 0, 1)\".",
3829
+ "docs": "The custom chip colour. This will override the theme colour.\nCan be a hex value e.g. \"#ff0000\", RGB e.g. \"rgb(255, 0, 0)\", or RGBA e.g. \"rgba(255, 0, 0, 1)\".",
3830
3830
  "docsTags": [],
3831
3831
  "default": "null",
3832
3832
  "values": [
@@ -3978,7 +3978,7 @@
3978
3978
  "mutable": false,
3979
3979
  "attr": "theme",
3980
3980
  "reflectToAttr": false,
3981
- "docs": "Sets the chip to the dark or light theme colors. \"inherit\" will set the color based on the system settings or ic-theme component.\r\nSetting the \"customColor\" prop will override this.",
3981
+ "docs": "Sets the chip to the dark or light theme colors. \"inherit\" will set the color based on the system settings or ic-theme component.\nSetting the \"customColor\" prop will override this.",
3982
3982
  "docsTags": [],
3983
3983
  "default": "\"inherit\"",
3984
3984
  "values": [
@@ -4132,7 +4132,7 @@
4132
4132
  "filePath": "src/components/ic-classification-banner/ic-classification-banner.tsx",
4133
4133
  "encapsulation": "shadow",
4134
4134
  "tag": "ic-classification-banner",
4135
- "readme": "# ic-classification-banner\r\n\r\n\r\n\r",
4135
+ "readme": "# ic-classification-banner\n\n\n",
4136
4136
  "docs": "",
4137
4137
  "docsTags": [],
4138
4138
  "usage": {},
@@ -4297,7 +4297,7 @@
4297
4297
  "filePath": "src/components/ic-data-list/ic-data-list.tsx",
4298
4298
  "encapsulation": "shadow",
4299
4299
  "tag": "ic-data-list",
4300
- "readme": "# ic-data-list\r\n\r\n\r\n\r",
4300
+ "readme": "# ic-data-list\n\n\n",
4301
4301
  "docs": "",
4302
4302
  "docsTags": [
4303
4303
  {
@@ -4424,7 +4424,7 @@
4424
4424
  "filePath": "src/components/ic-data-row/ic-data-row.tsx",
4425
4425
  "encapsulation": "shadow",
4426
4426
  "tag": "ic-data-row",
4427
- "readme": "# ic-data-row\r\n\r\n\r\n\r",
4427
+ "readme": "# ic-data-row\n\n\n",
4428
4428
  "docs": "",
4429
4429
  "docsTags": [
4430
4430
  {
@@ -4588,7 +4588,7 @@
4588
4588
  "filePath": "src/components/ic-dialog/ic-dialog.tsx",
4589
4589
  "encapsulation": "shadow",
4590
4590
  "tag": "ic-dialog",
4591
- "readme": "# ic-dialog\r\n\r\n\r\n\r",
4591
+ "readme": "# ic-dialog\n\n\n",
4592
4592
  "docs": "",
4593
4593
  "docsTags": [
4594
4594
  {
@@ -4687,7 +4687,7 @@
4687
4687
  "mutable": false,
4688
4688
  "attr": "disable-height-constraint",
4689
4689
  "reflectToAttr": false,
4690
- "docs": "If set to `true`, the content area max height and overflow properties are removed allowing the dialog to stretch below the fold.\r\nThis prop also prevents popover elements from being cut off within the content area.",
4690
+ "docs": "If set to `true`, the content area max height and overflow properties are removed allowing the dialog to stretch below the fold.\nThis prop also prevents popover elements from being cut off within the content area.",
4691
4691
  "docsTags": [],
4692
4692
  "default": "false",
4693
4693
  "values": [
@@ -5066,7 +5066,7 @@
5066
5066
  "filePath": "src/components/ic-divider/ic-divider.tsx",
5067
5067
  "encapsulation": "scoped",
5068
5068
  "tag": "ic-divider",
5069
- "readme": "# ic-divider\r\n\r\n\r\n\r",
5069
+ "readme": "# ic-divider\n\n\n",
5070
5070
  "docs": "",
5071
5071
  "docsTags": [],
5072
5072
  "usage": {},
@@ -5381,7 +5381,7 @@
5381
5381
  "filePath": "src/components/ic-empty-state/ic-empty-state.tsx",
5382
5382
  "encapsulation": "shadow",
5383
5383
  "tag": "ic-empty-state",
5384
- "readme": "# ic-empty-state\r\n\r\n\r\n\r",
5384
+ "readme": "# ic-empty-state\n\n\n",
5385
5385
  "docs": "",
5386
5386
  "docsTags": [
5387
5387
  {
@@ -5607,7 +5607,7 @@
5607
5607
  "filePath": "src/components/ic-footer/ic-footer.tsx",
5608
5608
  "encapsulation": "shadow",
5609
5609
  "tag": "ic-footer",
5610
- "readme": "# ic-footer\r\n\r\n\r\n\r",
5610
+ "readme": "# ic-footer\n\n\n",
5611
5611
  "docs": "",
5612
5612
  "docsTags": [
5613
5613
  {
@@ -5844,7 +5844,7 @@
5844
5844
  "filePath": "src/components/ic-footer-link/ic-footer-link.tsx",
5845
5845
  "encapsulation": "shadow",
5846
5846
  "tag": "ic-footer-link",
5847
- "readme": "# ic-footer-link\r\n\r\n\r\n\r",
5847
+ "readme": "# ic-footer-link\n\n\n",
5848
5848
  "docs": "",
5849
5849
  "docsTags": [],
5850
5850
  "usage": {},
@@ -6051,7 +6051,7 @@
6051
6051
  "filePath": "src/components/ic-footer-link-group/ic-footer-link-group.tsx",
6052
6052
  "encapsulation": "shadow",
6053
6053
  "tag": "ic-footer-link-group",
6054
- "readme": "# ic-footer-link-group\r\n\r\n\r\n\r",
6054
+ "readme": "# ic-footer-link-group\n\n\n",
6055
6055
  "docs": "",
6056
6056
  "docsTags": [],
6057
6057
  "usage": {},
@@ -6113,7 +6113,7 @@
6113
6113
  "filePath": "src/components/ic-hero/ic-hero.tsx",
6114
6114
  "encapsulation": "shadow",
6115
6115
  "tag": "ic-hero",
6116
- "readme": "# ic-hero\r\n\r\n\r\n\r",
6116
+ "readme": "# ic-hero\n\n\n",
6117
6117
  "docs": "",
6118
6118
  "docsTags": [
6119
6119
  {
@@ -6418,7 +6418,7 @@
6418
6418
  "filePath": "src/components/ic-horizontal-scroll/ic-horizontal-scroll.tsx",
6419
6419
  "encapsulation": "shadow",
6420
6420
  "tag": "ic-horizontal-scroll",
6421
- "readme": "# ic-horizontal-scroll\r\n\r\n\r\n\r",
6421
+ "readme": "# ic-horizontal-scroll\n\n\n",
6422
6422
  "docs": "",
6423
6423
  "docsTags": [],
6424
6424
  "usage": {},
@@ -6504,7 +6504,7 @@
6504
6504
  "filePath": "src/components/ic-input-component-container/ic-input-component-container.tsx",
6505
6505
  "encapsulation": "none",
6506
6506
  "tag": "ic-input-component-container",
6507
- "readme": "# ic-input-container\r\n\r\n\r\n\r",
6507
+ "readme": "# ic-input-container\n\n\n",
6508
6508
  "docs": "",
6509
6509
  "docsTags": [
6510
6510
  {
@@ -6801,7 +6801,7 @@
6801
6801
  "filePath": "src/components/ic-input-container/ic-input-container.tsx",
6802
6802
  "encapsulation": "none",
6803
6803
  "tag": "ic-input-container",
6804
- "readme": "# ic-input-container\r\n\r\n\r\n\r",
6804
+ "readme": "# ic-input-container\n\n\n",
6805
6805
  "docs": "",
6806
6806
  "docsTags": [],
6807
6807
  "usage": {},
@@ -6879,7 +6879,7 @@
6879
6879
  "filePath": "src/components/ic-input-label/ic-input-label.tsx",
6880
6880
  "encapsulation": "none",
6881
6881
  "tag": "ic-input-label",
6882
- "readme": "# ic-input-label\r\n\r\n\r\n\r",
6882
+ "readme": "# ic-input-label\n\n\n",
6883
6883
  "docs": "",
6884
6884
  "docsTags": [],
6885
6885
  "usage": {},
@@ -7108,7 +7108,7 @@
7108
7108
  "filePath": "src/components/ic-input-validation/ic-input-validation.tsx",
7109
7109
  "encapsulation": "none",
7110
7110
  "tag": "ic-input-validation",
7111
- "readme": "# ic-input-validation\r\n\r\n\r\n\r",
7111
+ "readme": "# ic-input-validation\n\n\n",
7112
7112
  "docs": "",
7113
7113
  "docsTags": [
7114
7114
  {
@@ -7298,7 +7298,7 @@
7298
7298
  "filePath": "src/components/ic-link/ic-link.tsx",
7299
7299
  "encapsulation": "shadow",
7300
7300
  "tag": "ic-link",
7301
- "readme": "# ic-link\r\n\r\n\r\n\r",
7301
+ "readme": "# ic-link\n\n\n",
7302
7302
  "docs": "",
7303
7303
  "docsTags": [
7304
7304
  {
@@ -7595,7 +7595,7 @@
7595
7595
  "filePath": "src/components/ic-loading-indicator/ic-loading-indicator.tsx",
7596
7596
  "encapsulation": "shadow",
7597
7597
  "tag": "ic-loading-indicator",
7598
- "readme": "# ic-loading\r\n\r\n\r\n\r",
7598
+ "readme": "# ic-loading\n\n\n",
7599
7599
  "docs": "",
7600
7600
  "docsTags": [],
7601
7601
  "usage": {},
@@ -7655,7 +7655,7 @@
7655
7655
  "mutable": false,
7656
7656
  "attr": "label",
7657
7657
  "reflectToAttr": false,
7658
- "docs": "The label to be displayed beneath the loading indicator.\r\nDisplay a changing label by supplying an array of messages.",
7658
+ "docs": "The label to be displayed beneath the loading indicator.\nDisplay a changing label by supplying an array of messages.",
7659
7659
  "docsTags": [],
7660
7660
  "values": [
7661
7661
  {
@@ -7701,7 +7701,7 @@
7701
7701
  "mutable": false,
7702
7702
  "attr": "max",
7703
7703
  "reflectToAttr": false,
7704
- "docs": "The maximum value that the progress value can take.\r\nUsed to calculate the proportional width of the progress bar.",
7704
+ "docs": "The maximum value that the progress value can take.\nUsed to calculate the proportional width of the progress bar.",
7705
7705
  "docsTags": [],
7706
7706
  "default": "100",
7707
7707
  "values": [
@@ -7723,7 +7723,7 @@
7723
7723
  "mutable": false,
7724
7724
  "attr": "min",
7725
7725
  "reflectToAttr": false,
7726
- "docs": "The minimum value that the progress value can take.\r\nUsed to calculate the proportional width of the progress bar.",
7726
+ "docs": "The minimum value that the progress value can take.\nUsed to calculate the proportional width of the progress bar.",
7727
7727
  "docsTags": [],
7728
7728
  "default": "0",
7729
7729
  "values": [
@@ -7767,7 +7767,7 @@
7767
7767
  "mutable": false,
7768
7768
  "attr": "progress",
7769
7769
  "reflectToAttr": false,
7770
- "docs": "The current amount of progress made.\r\nIf not provided, component acts as an indeterminate loading indicator.",
7770
+ "docs": "The current amount of progress made.\nIf not provided, component acts as an indeterminate loading indicator.",
7771
7771
  "docsTags": [],
7772
7772
  "values": [
7773
7773
  {
@@ -7937,7 +7937,7 @@
7937
7937
  "filePath": "src/components/ic-menu/ic-menu.tsx",
7938
7938
  "encapsulation": "scoped",
7939
7939
  "tag": "ic-menu",
7940
- "readme": "# ic-menu\r\n\r\n\r\n\r",
7940
+ "readme": "# ic-menu\n\n\n",
7941
7941
  "docs": "",
7942
7942
  "docsTags": [],
7943
7943
  "usage": {},
@@ -8333,7 +8333,7 @@
8333
8333
  "docs": "The keyboard event which is available when handleKeyboardOpen is invoked."
8334
8334
  }
8335
8335
  ],
8336
- "docs": "Used alongside activationType\r\nIf menu is opened via keyboard navigation (i.e. Enter, ArrowUp or ArrowDown), emit optionSelect custom event.",
8336
+ "docs": "Used alongside activationType\nIf menu is opened via keyboard navigation (i.e. Enter, ArrowUp or ArrowDown), emit optionSelect custom event.",
8337
8337
  "docsTags": [
8338
8338
  {
8339
8339
  "name": "param",
@@ -8405,7 +8405,7 @@
8405
8405
  "filePath": "src/components/ic-menu-group/ic-menu-group.tsx",
8406
8406
  "encapsulation": "shadow",
8407
8407
  "tag": "ic-menu-group",
8408
- "readme": "# ic-menu-group\r\n\r\n\r\n\r",
8408
+ "readme": "# ic-menu-group\n\n\n",
8409
8409
  "docs": "",
8410
8410
  "docsTags": [],
8411
8411
  "usage": {},
@@ -8452,7 +8452,7 @@
8452
8452
  "filePath": "src/components/ic-menu-item/ic-menu-item.tsx",
8453
8453
  "encapsulation": "shadow",
8454
8454
  "tag": "ic-menu-item",
8455
- "readme": "# ic-menu-item\r\n\r\n\r\n\r",
8455
+ "readme": "# ic-menu-item\n\n\n",
8456
8456
  "docs": "",
8457
8457
  "docsTags": [
8458
8458
  {
@@ -8777,7 +8777,7 @@
8777
8777
  "detail": "{ checked: boolean; }",
8778
8778
  "bubbles": true,
8779
8779
  "complexType": {
8780
- "original": "{\r\n checked: boolean;\r\n }",
8780
+ "original": "{\n checked: boolean;\n }",
8781
8781
  "resolved": "{ checked: boolean; }",
8782
8782
  "references": {}
8783
8783
  },
@@ -8833,7 +8833,7 @@
8833
8833
  "filePath": "src/components/ic-navigation-button/ic-navigation-button.tsx",
8834
8834
  "encapsulation": "shadow",
8835
8835
  "tag": "ic-navigation-button",
8836
- "readme": "# ic-navigation-button\r\n\r\n\r\n\r",
8836
+ "readme": "# ic-navigation-button\n\n\n",
8837
8837
  "docs": "",
8838
8838
  "docsTags": [
8839
8839
  {
@@ -9154,7 +9154,7 @@
9154
9154
  "filePath": "src/components/ic-navigation-group/ic-navigation-group.tsx",
9155
9155
  "encapsulation": "shadow",
9156
9156
  "tag": "ic-navigation-group",
9157
- "readme": "# ic-navigation-group\r\n\r\n\r\n\r",
9157
+ "readme": "# ic-navigation-group\n\n\n",
9158
9158
  "docs": "",
9159
9159
  "docsTags": [],
9160
9160
  "usage": {},
@@ -9306,7 +9306,7 @@
9306
9306
  "filePath": "src/components/ic-navigation-item/ic-navigation-item.tsx",
9307
9307
  "encapsulation": "shadow",
9308
9308
  "tag": "ic-navigation-item",
9309
- "readme": "# ic-navigation-item\r\n\r\n\r\n\r",
9309
+ "readme": "# ic-navigation-item\n\n\n",
9310
9310
  "docs": "",
9311
9311
  "docsTags": [
9312
9312
  {
@@ -9648,7 +9648,7 @@
9648
9648
  "filePath": "src/components/ic-navigation-menu/ic-navigation-menu.tsx",
9649
9649
  "encapsulation": "shadow",
9650
9650
  "tag": "ic-navigation-menu",
9651
- "readme": "# ic-navigation-menu\r\n\r\n\r\n\r",
9651
+ "readme": "# ic-navigation-menu\n\n\n",
9652
9652
  "docs": "",
9653
9653
  "docsTags": [
9654
9654
  {
@@ -9808,7 +9808,7 @@
9808
9808
  "filePath": "src/components/ic-page-header/ic-page-header.tsx",
9809
9809
  "encapsulation": "shadow",
9810
9810
  "tag": "ic-page-header",
9811
- "readme": "# ic-page-header\r\n\r\n\r\n\r",
9811
+ "readme": "# ic-page-header\n\n\n",
9812
9812
  "docs": "",
9813
9813
  "docsTags": [
9814
9814
  {
@@ -10160,7 +10160,7 @@
10160
10160
  "filePath": "src/components/ic-pagination/ic-pagination.tsx",
10161
10161
  "encapsulation": "shadow",
10162
10162
  "tag": "ic-pagination",
10163
- "readme": "# ic-pagination\r\n\r\n\r\n\r",
10163
+ "readme": "# ic-pagination\n\n\n",
10164
10164
  "docs": "",
10165
10165
  "docsTags": [],
10166
10166
  "usage": {},
@@ -10557,7 +10557,7 @@
10557
10557
  "filePath": "src/components/ic-pagination-item/ic-pagination-item.tsx",
10558
10558
  "encapsulation": "shadow",
10559
10559
  "tag": "ic-pagination-item",
10560
- "readme": "# ic-pagination-item\r\n\r\n\r\n\r",
10560
+ "readme": "# ic-pagination-item\n\n\n",
10561
10561
  "docs": "",
10562
10562
  "docsTags": [],
10563
10563
  "usage": {},
@@ -10770,7 +10770,7 @@
10770
10770
  "filePath": "src/components/ic-popover-menu/ic-popover-menu.tsx",
10771
10771
  "encapsulation": "shadow",
10772
10772
  "tag": "ic-popover-menu",
10773
- "readme": "# ic-popover-menu\r\n\r\nThis is a wrapper component to be placed around one or more ic-menu-item components.\r\n\r",
10773
+ "readme": "# ic-popover-menu\n\nThis is a wrapper component to be placed around one or more ic-menu-item components.\n",
10774
10774
  "docs": "This is a wrapper component to be placed around one or more ic-menu-item components.",
10775
10775
  "docsTags": [],
10776
10776
  "usage": {},
@@ -10971,7 +10971,7 @@
10971
10971
  "filePath": "src/components/ic-radio-group/ic-radio-group.tsx",
10972
10972
  "encapsulation": "shadow",
10973
10973
  "tag": "ic-radio-group",
10974
- "readme": "# ic-radio-group\r\n\r\n\r\n\r",
10974
+ "readme": "# ic-radio-group\n\n\n",
10975
10975
  "docs": "",
10976
10976
  "docsTags": [],
10977
10977
  "usage": {},
@@ -11331,7 +11331,7 @@
11331
11331
  "filePath": "src/components/ic-radio-option/ic-radio-option.tsx",
11332
11332
  "encapsulation": "none",
11333
11333
  "tag": "ic-radio-option",
11334
- "readme": "# ic-radio-option\r\n\r\n\r\n\r",
11334
+ "readme": "# ic-radio-option\n\n\n",
11335
11335
  "docs": "",
11336
11336
  "docsTags": [
11337
11337
  {
@@ -11672,7 +11672,7 @@
11672
11672
  "filePath": "src/components/ic-search-bar/ic-search-bar.tsx",
11673
11673
  "encapsulation": "shadow",
11674
11674
  "tag": "ic-search-bar",
11675
- "readme": "# ic-search-bar\r\n\r\n\r\n\r",
11675
+ "readme": "# ic-search-bar\n\n\n",
11676
11676
  "docs": "",
11677
11677
  "docsTags": [],
11678
11678
  "usage": {},
@@ -11710,7 +11710,7 @@
11710
11710
  "mutable": false,
11711
11711
  "attr": "autocapitalize",
11712
11712
  "reflectToAttr": false,
11713
- "docs": "The automatic capitalisation of the text value as it is entered/edited by the user.\r\nAvailable options: \"off\", \"none\", \"on\", \"sentences\", \"words\", \"characters\".",
11713
+ "docs": "The automatic capitalisation of the text value as it is entered/edited by the user.\nAvailable options: \"off\", \"none\", \"on\", \"sentences\", \"words\", \"characters\".",
11714
11714
  "docsTags": [],
11715
11715
  "default": "\"off\"",
11716
11716
  "values": [
@@ -12072,7 +12072,7 @@
12072
12072
  "mutable": false,
12073
12073
  "attr": "disable-auto-filtering",
12074
12074
  "reflectToAttr": false,
12075
- "docs": "Specify whether to disable the built in filtering. For example, if options will already be filtered from external source.\r\nIf `true`, all options provided will be displayed.",
12075
+ "docs": "Specify whether to disable the built in filtering. For example, if options will already be filtered from external source.\nIf `true`, all options provided will be displayed.",
12076
12076
  "docsTags": [],
12077
12077
  "default": "false",
12078
12078
  "values": [
@@ -12160,7 +12160,7 @@
12160
12160
  "mutable": false,
12161
12161
  "attr": "full-width",
12162
12162
  "reflectToAttr": false,
12163
- "docs": "Specify whether the search bar fills the full width of the container.\r\nIf `true`, this overrides the --input-width CSS variable.",
12163
+ "docs": "Specify whether the search bar fills the full width of the container.\nIf `true`, this overrides the --input-width CSS variable.",
12164
12164
  "docsTags": [],
12165
12165
  "default": "false",
12166
12166
  "values": [
@@ -12910,7 +12910,7 @@
12910
12910
  "filePath": "src/components/ic-section-container/ic-section-container.tsx",
12911
12911
  "encapsulation": "shadow",
12912
12912
  "tag": "ic-section-container",
12913
- "readme": "# ic-section-container\r\n\r\n\r\n\r",
12913
+ "readme": "# ic-section-container\n\n\n",
12914
12914
  "docs": "",
12915
12915
  "docsTags": [],
12916
12916
  "usage": {},
@@ -13011,7 +13011,7 @@
13011
13011
  "filePath": "src/components/ic-select/ic-select.tsx",
13012
13012
  "encapsulation": "shadow",
13013
13013
  "tag": "ic-select",
13014
- "readme": "# ic-select\r\n\r\n\r\n\r",
13014
+ "readme": "# ic-select\n\n\n",
13015
13015
  "docs": "",
13016
13016
  "docsTags": [
13017
13017
  {
@@ -13731,7 +13731,7 @@
13731
13731
  "mutable": true,
13732
13732
  "attr": "value",
13733
13733
  "reflectToAttr": false,
13734
- "docs": "The value of the select, reflected by the value of the currently selected option.\r\nFor the searchable variant, the value is also reflected by the user input.\r\nFor the multi-select variant, the value must be an array of option values.",
13734
+ "docs": "The value of the select, reflected by the value of the currently selected option.\nFor the searchable variant, the value is also reflected by the user input.\nFor the multi-select variant, the value must be an array of option values.",
13735
13735
  "docsTags": [],
13736
13736
  "values": [
13737
13737
  {
@@ -13917,7 +13917,7 @@
13917
13917
  },
13918
13918
  "cancelable": true,
13919
13919
  "composed": true,
13920
- "docs": "Emitted when an option is selected.\r\nSelecting an option will also trigger an `icChange/onIcChange` due to the value being updated.",
13920
+ "docs": "Emitted when an option is selected.\nSelecting an option will also trigger an `icChange/onIcChange` due to the value being updated.",
13921
13921
  "docsTags": []
13922
13922
  },
13923
13923
  {
@@ -14013,7 +14013,7 @@
14013
14013
  "filePath": "src/components/ic-side-navigation/ic-side-navigation.tsx",
14014
14014
  "encapsulation": "shadow",
14015
14015
  "tag": "ic-side-navigation",
14016
- "readme": "# ic-side-navigation\r\n\r\n\r\n\r",
14016
+ "readme": "# ic-side-navigation\n\n\n",
14017
14017
  "docs": "",
14018
14018
  "docsTags": [
14019
14019
  {
@@ -14341,8 +14341,8 @@
14341
14341
  "filePath": "src/components/ic-skeleton/ic-skeleton.tsx",
14342
14342
  "encapsulation": "shadow",
14343
14343
  "tag": "ic-skeleton",
14344
- "readme": "# ic-skeleton\r\n\r\nWhen using the skeleton component, an aria-live level should be applied to the parent element of the skeleton and the element that it is\r\nrepresenting so that any changes, such as the real element replacing the skeleton placeholder, are announced to assistive technology like screen readers. The recommendation is to use aria-live=\"polite\" over aria-live=\"recommended\" unless changes are critically important. \r\n\r",
14345
- "docs": "When using the skeleton component, an aria-live level should be applied to the parent element of the skeleton and the element that it is\r\nrepresenting so that any changes, such as the real element replacing the skeleton placeholder, are announced to assistive technology like screen readers. The recommendation is to use aria-live=\"polite\" over aria-live=\"recommended\" unless changes are critically important.",
14344
+ "readme": "# ic-skeleton\n\nWhen using the skeleton component, an aria-live level should be applied to the parent element of the skeleton and the element that it is\nrepresenting so that any changes, such as the real element replacing the skeleton placeholder, are announced to assistive technology like screen readers. The recommendation is to use aria-live=\"polite\" over aria-live=\"recommended\" unless changes are critically important. \n",
14345
+ "docs": "When using the skeleton component, an aria-live level should be applied to the parent element of the skeleton and the element that it is\nrepresenting so that any changes, such as the real element replacing the skeleton placeholder, are announced to assistive technology like screen readers. The recommendation is to use aria-live=\"polite\" over aria-live=\"recommended\" unless changes are critically important.",
14346
14346
  "docsTags": [],
14347
14347
  "usage": {},
14348
14348
  "props": [
@@ -14435,7 +14435,7 @@
14435
14435
  "filePath": "src/components/ic-status-tag/ic-status-tag.tsx",
14436
14436
  "encapsulation": "shadow",
14437
14437
  "tag": "ic-status-tag",
14438
- "readme": "# ic-status-tag\r\n\r\n\r\n\r",
14438
+ "readme": "# ic-status-tag\n\n\n",
14439
14439
  "docs": "",
14440
14440
  "docsTags": [],
14441
14441
  "usage": {},
@@ -14451,7 +14451,7 @@
14451
14451
  "mutable": false,
14452
14452
  "attr": "announced",
14453
14453
  "reflectToAttr": false,
14454
- "docs": "If `true`, role='status' is added to the component and it will act as an 'aria-live' region.\r\nScreen readers will announce changes to the `label`, but not the initial value.",
14454
+ "docs": "If `true`, role='status' is added to the component and it will act as an 'aria-live' region.\nScreen readers will announce changes to the `label`, but not the initial value.",
14455
14455
  "docsTags": [],
14456
14456
  "default": "false",
14457
14457
  "values": [
@@ -14668,7 +14668,7 @@
14668
14668
  "filePath": "src/components/ic-step/ic-step.tsx",
14669
14669
  "encapsulation": "shadow",
14670
14670
  "tag": "ic-step",
14671
- "readme": "# ic-step\r\n\r\n\r\n\r",
14671
+ "readme": "# ic-step\n\n\n",
14672
14672
  "docs": "",
14673
14673
  "docsTags": [],
14674
14674
  "usage": {},
@@ -14814,7 +14814,7 @@
14814
14814
  "filePath": "src/components/ic-stepper/ic-stepper.tsx",
14815
14815
  "encapsulation": "shadow",
14816
14816
  "tag": "ic-stepper",
14817
- "readme": "# ic-stepper\r\n\r\nThis is a wrapper component to be placed around one or more ic-step components\r\n\r",
14817
+ "readme": "# ic-stepper\n\nThis is a wrapper component to be placed around one or more ic-step components\n",
14818
14818
  "docs": "This is a wrapper component to be placed around one or more ic-step components",
14819
14819
  "docsTags": [],
14820
14820
  "usage": {},
@@ -14981,7 +14981,7 @@
14981
14981
  "filePath": "src/components/ic-switch/ic-switch.tsx",
14982
14982
  "encapsulation": "shadow",
14983
14983
  "tag": "ic-switch",
14984
- "readme": "# ic-switch\r\n\r\n\r\n\r",
14984
+ "readme": "# ic-switch\n\n\n",
14985
14985
  "docs": "",
14986
14986
  "docsTags": [
14987
14987
  {
@@ -15225,7 +15225,7 @@
15225
15225
  "mutable": false,
15226
15226
  "attr": "value",
15227
15227
  "reflectToAttr": false,
15228
- "docs": "The value of the toggle does not mean if it's checked or not, use the `checked`\r\nproperty for that.\r\n\r\nThe value of a toggle is analogous to the value of a `<input type=\"checkbox\">`,\r\nit's only used when the toggle participates in a native `<form>`.",
15228
+ "docs": "The value of the toggle does not mean if it's checked or not, use the `checked`\nproperty for that.\n\nThe value of a toggle is analogous to the value of a `<input type=\"checkbox\">`,\nit's only used when the toggle participates in a native `<form>`.",
15229
15229
  "docsTags": [],
15230
15230
  "default": "\"on\"",
15231
15231
  "values": [
@@ -15339,7 +15339,7 @@
15339
15339
  "filePath": "src/components/ic-tab/ic-tab.tsx",
15340
15340
  "encapsulation": "shadow",
15341
15341
  "tag": "ic-tab",
15342
- "readme": "# ic-tab\r\n\r\n\r\n\r",
15342
+ "readme": "# ic-tab\n\n\n",
15343
15343
  "docs": "",
15344
15344
  "docsTags": [
15345
15345
  {
@@ -15428,7 +15428,7 @@
15428
15428
  "filePath": "src/components/ic-tab-context/ic-tab-context.tsx",
15429
15429
  "encapsulation": "none",
15430
15430
  "tag": "ic-tab-context",
15431
- "readme": "# ic-tab-context\r\n\r\n\r\n\r",
15431
+ "readme": "# ic-tab-context\n\n\n",
15432
15432
  "docs": "",
15433
15433
  "docsTags": [],
15434
15434
  "usage": {},
@@ -15625,7 +15625,7 @@
15625
15625
  "filePath": "src/components/ic-tab-group/ic-tab-group.tsx",
15626
15626
  "encapsulation": "shadow",
15627
15627
  "tag": "ic-tab-group",
15628
- "readme": "# ic-tab-group\r\n\r\n\r\n\r",
15628
+ "readme": "# ic-tab-group\n\n\n",
15629
15629
  "docs": "",
15630
15630
  "docsTags": [],
15631
15631
  "usage": {},
@@ -15707,7 +15707,7 @@
15707
15707
  "filePath": "src/components/ic-tab-panel/ic-tab-panel.tsx",
15708
15708
  "encapsulation": "shadow",
15709
15709
  "tag": "ic-tab-panel",
15710
- "readme": "# ic-tab-panel\r\n\r\n\r\n\r",
15710
+ "readme": "# ic-tab-panel\n\n\n",
15711
15711
  "docs": "",
15712
15712
  "docsTags": [],
15713
15713
  "usage": {},
@@ -15726,7 +15726,7 @@
15726
15726
  "filePath": "src/components/ic-text-field/ic-text-field.tsx",
15727
15727
  "encapsulation": "shadow",
15728
15728
  "tag": "ic-text-field",
15729
- "readme": "# ic-textfield\r\n\r\n\r\n\r",
15729
+ "readme": "# ic-textfield\n\n\n",
15730
15730
  "docs": "",
15731
15731
  "docsTags": [
15732
15732
  {
@@ -15747,7 +15747,7 @@
15747
15747
  "mutable": false,
15748
15748
  "attr": "autocapitalize",
15749
15749
  "reflectToAttr": false,
15750
- "docs": "The automatic capitalisation of the text value as it is entered/edited by the user.\r\nAvailable options: \"off\", \"none\", \"on\", \"sentences\", \"words\", \"characters\".",
15750
+ "docs": "The automatic capitalisation of the text value as it is entered/edited by the user.\nAvailable options: \"off\", \"none\", \"on\", \"sentences\", \"words\", \"characters\".",
15751
15751
  "docsTags": [],
15752
15752
  "default": "\"off\"",
15753
15753
  "values": [
@@ -16109,7 +16109,7 @@
16109
16109
  "mutable": false,
16110
16110
  "attr": "full-width",
16111
16111
  "reflectToAttr": false,
16112
- "docs": "Specify whether the text field fills the full width of the container.\r\nIf `true`, this overrides the --input-width CSS variable.",
16112
+ "docs": "Specify whether the text field fills the full width of the container.\nIf `true`, this overrides the --input-width CSS variable.",
16113
16113
  "docsTags": [],
16114
16114
  "default": "false",
16115
16115
  "values": [
@@ -16225,7 +16225,7 @@
16225
16225
  "mutable": false,
16226
16226
  "attr": "inputmode",
16227
16227
  "reflectToAttr": false,
16228
- "docs": "A hint to the browser for which keyboard to display.\r\nPossible values: `\"none\"`, `\"text\"`, `\"tel\"`, `\"url\"`,\r\n`\"email\"`, `\"numeric\"`, `\"decimal\"`, and `\"search\"`.",
16228
+ "docs": "A hint to the browser for which keyboard to display.\nPossible values: `\"none\"`, `\"text\"`, `\"tel\"`, `\"url\"`,\n`\"email\"`, `\"numeric\"`, `\"decimal\"`, and `\"search\"`.",
16229
16229
  "docsTags": [],
16230
16230
  "default": "\"text\"",
16231
16231
  "values": [
@@ -16938,7 +16938,7 @@
16938
16938
  "filePath": "src/components/ic-theme/ic-theme.tsx",
16939
16939
  "encapsulation": "none",
16940
16940
  "tag": "ic-theme",
16941
- "readme": "# ic-theme\r\n\r\n\r\n\r",
16941
+ "readme": "# ic-theme\n\n\n",
16942
16942
  "docs": "",
16943
16943
  "docsTags": [],
16944
16944
  "usage": {},
@@ -17023,7 +17023,7 @@
17023
17023
  "filePath": "src/components/ic-toast/ic-toast.tsx",
17024
17024
  "encapsulation": "shadow",
17025
17025
  "tag": "ic-toast",
17026
- "readme": "# ic-toast\r\n\r\n\r\n\r",
17026
+ "readme": "# ic-toast\n\n\n",
17027
17027
  "docs": "",
17028
17028
  "docsTags": [
17029
17029
  {
@@ -17048,7 +17048,7 @@
17048
17048
  "mutable": true,
17049
17049
  "attr": "auto-dismiss-timeout",
17050
17050
  "reflectToAttr": false,
17051
- "docs": "If toast dismissMode is set to `automatic`, use this prop to define the time before the toast dismisses (in MILLISECONDS)\r\n(NOTE: Has a minimum value of `5000ms`)",
17051
+ "docs": "If toast dismissMode is set to `automatic`, use this prop to define the time before the toast dismisses (in MILLISECONDS)\n(NOTE: Has a minimum value of `5000ms`)",
17052
17052
  "docsTags": [],
17053
17053
  "default": "5000",
17054
17054
  "values": [
@@ -17308,7 +17308,7 @@
17308
17308
  "filePath": "src/components/ic-toast-region/ic-toast-region.tsx",
17309
17309
  "encapsulation": "none",
17310
17310
  "tag": "ic-toast-region",
17311
- "readme": "# ic-toast-region\r\n\r\n\r\n\r",
17311
+ "readme": "# ic-toast-region\n\n\n",
17312
17312
  "docs": "",
17313
17313
  "docsTags": [],
17314
17314
  "usage": {},
@@ -17359,7 +17359,7 @@
17359
17359
  "filePath": "src/components/ic-toggle-button/ic-toggle-button.tsx",
17360
17360
  "encapsulation": "shadow",
17361
17361
  "tag": "ic-toggle-button",
17362
- "readme": "# ic-toggle-button\r\n\r\n\r\n\r",
17362
+ "readme": "# ic-toggle-button\n\n\n",
17363
17363
  "docs": "",
17364
17364
  "docsTags": [
17365
17365
  {
@@ -17424,7 +17424,7 @@
17424
17424
  "resolved": "boolean",
17425
17425
  "references": {}
17426
17426
  },
17427
- "mutable": false,
17427
+ "mutable": true,
17428
17428
  "attr": "disabled",
17429
17429
  "reflectToAttr": false,
17430
17430
  "docs": "If `true`, the toggle button will be in disabled state.",
@@ -17446,7 +17446,7 @@
17446
17446
  "resolved": "boolean",
17447
17447
  "references": {}
17448
17448
  },
17449
- "mutable": false,
17449
+ "mutable": true,
17450
17450
  "attr": "full-width",
17451
17451
  "reflectToAttr": false,
17452
17452
  "docs": "If `true`, the toggle button will fill the width of the container.",
@@ -17464,15 +17464,22 @@
17464
17464
  "name": "iconPlacement",
17465
17465
  "type": "\"left\" | \"right\" | \"top\"",
17466
17466
  "complexType": {
17467
- "original": "\"left\" | \"right\" | \"top\"",
17467
+ "original": "IcIconPlacementOptions",
17468
17468
  "resolved": "\"left\" | \"right\" | \"top\"",
17469
- "references": {}
17469
+ "references": {
17470
+ "IcIconPlacementOptions": {
17471
+ "location": "import",
17472
+ "path": "../../utils/types",
17473
+ "id": "src/utils/types.ts::IcIconPlacementOptions"
17474
+ }
17475
+ }
17470
17476
  },
17471
17477
  "mutable": false,
17472
17478
  "attr": "icon-placement",
17473
17479
  "reflectToAttr": false,
17474
17480
  "docs": "The placement of the icon in relation to the toggle button label.",
17475
17481
  "docsTags": [],
17482
+ "default": "\"left\"",
17476
17483
  "values": [
17477
17484
  {
17478
17485
  "value": "left",
@@ -17519,7 +17526,7 @@
17519
17526
  "resolved": "boolean",
17520
17527
  "references": {}
17521
17528
  },
17522
- "mutable": false,
17529
+ "mutable": true,
17523
17530
  "attr": "loading",
17524
17531
  "reflectToAttr": false,
17525
17532
  "docs": "If `true`, the toggle button will be in loading state.",
@@ -17541,7 +17548,7 @@
17541
17548
  "resolved": "boolean",
17542
17549
  "references": {}
17543
17550
  },
17544
- "mutable": false,
17551
+ "mutable": true,
17545
17552
  "attr": "monochrome",
17546
17553
  "reflectToAttr": false,
17547
17554
  "docs": "If `true`, the toggle button will display as black in the light theme, and white in dark theme.",
@@ -17569,7 +17576,7 @@
17569
17576
  }
17570
17577
  }
17571
17578
  },
17572
- "mutable": false,
17579
+ "mutable": true,
17573
17580
  "attr": "size",
17574
17581
  "reflectToAttr": false,
17575
17582
  "docs": "The size of the toggle button to be displayed.",
@@ -17606,7 +17613,7 @@
17606
17613
  }
17607
17614
  }
17608
17615
  },
17609
- "mutable": false,
17616
+ "mutable": true,
17610
17617
  "attr": "theme",
17611
17618
  "reflectToAttr": false,
17612
17619
  "docs": "Sets the theme color to the dark or light theme color. \"inherit\" will set the color based on the system settings or ic-theme component.",
@@ -17637,7 +17644,7 @@
17637
17644
  "resolved": "\"default\" | \"icon\"",
17638
17645
  "references": {}
17639
17646
  },
17640
- "mutable": false,
17647
+ "mutable": true,
17641
17648
  "attr": "variant",
17642
17649
  "reflectToAttr": true,
17643
17650
  "docs": "The variant of the toggle button.",
@@ -17664,7 +17671,7 @@
17664
17671
  "detail": "{ checked: boolean; }",
17665
17672
  "bubbles": true,
17666
17673
  "complexType": {
17667
- "original": "{\r\n checked: boolean;\r\n }",
17674
+ "original": "{\n checked: boolean;\n }",
17668
17675
  "resolved": "{ checked: boolean; }",
17669
17676
  "references": {}
17670
17677
  },
@@ -17717,7 +17724,7 @@
17717
17724
  "filePath": "src/components/ic-toggle-button-group/ic-toggle-button-group.tsx",
17718
17725
  "encapsulation": "shadow",
17719
17726
  "tag": "ic-toggle-button-group",
17720
- "readme": "# ic-toggle-button-group\r\n\r\n\r\n\r",
17727
+ "readme": "# ic-toggle-button-group\n\n\n",
17721
17728
  "docs": "",
17722
17729
  "docsTags": [],
17723
17730
  "usage": {},
@@ -18071,7 +18078,7 @@
18071
18078
  "filePath": "src/components/ic-tooltip/ic-tooltip.tsx",
18072
18079
  "encapsulation": "shadow",
18073
18080
  "tag": "ic-tooltip",
18074
- "readme": "# ic-tooltip\r\n\r\n\r\n\r",
18081
+ "readme": "# ic-tooltip\n\n\n",
18075
18082
  "docs": "",
18076
18083
  "docsTags": [],
18077
18084
  "usage": {},
@@ -18369,7 +18376,7 @@
18369
18376
  "filePath": "src/components/ic-top-navigation/ic-top-navigation.tsx",
18370
18377
  "encapsulation": "shadow",
18371
18378
  "tag": "ic-top-navigation",
18372
- "readme": "# ic-top-navigation\r\n\r\n\r\n\r",
18379
+ "readme": "# ic-top-navigation\n\n\n",
18373
18380
  "docs": "",
18374
18381
  "docsTags": [
18375
18382
  {
@@ -18478,7 +18485,7 @@
18478
18485
  "mutable": false,
18479
18486
  "attr": "custom-mobile-breakpoint",
18480
18487
  "reflectToAttr": false,
18481
- "docs": "Can set a custom breakpoint for the top navigation to switch to mobile mode.\r\nMust be one of our specified breakpoints in px: `0`, `576`, `768`, `992`, `1200`.",
18488
+ "docs": "Can set a custom breakpoint for the top navigation to switch to mobile mode.\nMust be one of our specified breakpoints in px: `0`, `576`, `768`, `992`, `1200`.",
18482
18489
  "docsTags": [],
18483
18490
  "default": "DEVICE_SIZES.L",
18484
18491
  "values": [
@@ -18765,7 +18772,7 @@
18765
18772
  "filePath": "src/components/ic-typography/ic-typography.tsx",
18766
18773
  "encapsulation": "shadow",
18767
18774
  "tag": "ic-typography",
18768
- "readme": "# ic-typography\r\n\r\n\r\n\r",
18775
+ "readme": "# ic-typography\n\n\n",
18769
18776
  "docs": "",
18770
18777
  "docsTags": [],
18771
18778
  "usage": {},
@@ -18803,7 +18810,7 @@
18803
18810
  "mutable": false,
18804
18811
  "attr": "bold",
18805
18812
  "reflectToAttr": false,
18806
- "docs": "If `true`, the typography will have a bold font weight.\r\nNote: This will have no impact on variants that already use an equivalent or higher font weight (h1, h2, and subtitle-large).",
18813
+ "docs": "If `true`, the typography will have a bold font weight.\nNote: This will have no impact on variants that already use an equivalent or higher font weight (h1, h2, and subtitle-large).",
18807
18814
  "docsTags": [],
18808
18815
  "default": "false",
18809
18816
  "values": [
@@ -19209,7 +19216,7 @@
19209
19216
  "path": "src/utils/types.ts"
19210
19217
  },
19211
19218
  "src/utils/types.ts::IcStatusVariants": {
19212
- "declaration": "export type IcStatusVariants =\r\n | \"neutral\"\r\n | \"info\"\r\n | \"warning\"\r\n | \"error\"\r\n | \"success\";",
19219
+ "declaration": "export type IcStatusVariants =\n | \"neutral\"\n | \"info\"\n | \"warning\"\n | \"error\"\n | \"success\";",
19213
19220
  "docstring": "",
19214
19221
  "path": "src/utils/types.ts"
19215
19222
  },
@@ -19244,7 +19251,7 @@
19244
19251
  "path": "src/components/ic-button/ic-button.types.ts"
19245
19252
  },
19246
19253
  "src/components/ic-button/ic-button.types.ts::IcButtonVariants": {
19247
- "declaration": "export type IcButtonVariants =\r\n | \"primary\"\r\n | \"secondary\"\r\n | \"tertiary\"\r\n | \"destructive\"\r\n | \"icon\"\r\n | \"icon-primary\"\r\n | \"icon-secondary\"\r\n | \"icon-tertiary\"\r\n | \"icon-destructive\";",
19254
+ "declaration": "export type IcButtonVariants =\n | \"primary\"\n | \"secondary\"\n | \"tertiary\"\n | \"destructive\"\n | \"icon\"\n | \"icon-primary\"\n | \"icon-secondary\"\n | \"icon-tertiary\"\n | \"icon-destructive\";",
19248
19255
  "docstring": "",
19249
19256
  "path": "src/components/ic-button/ic-button.types.ts"
19250
19257
  },
@@ -19304,7 +19311,7 @@
19304
19311
  "path": "src/components/ic-text-field/ic-text-field.types.ts"
19305
19312
  },
19306
19313
  "src/utils/types.ts::IcAutocompleteTypes": {
19307
- "declaration": "export type IcAutocompleteTypes =\r\n | \"on\"\r\n | \"off\"\r\n | \"name\"\r\n | \"honorific-prefix\"\r\n | \"given-name\"\r\n | \"additional-name\"\r\n | \"family-name\"\r\n | \"honorific-suffix\"\r\n | \"nickname\"\r\n | \"email\"\r\n | \"username\"\r\n | \"new-password\"\r\n | \"current-password\"\r\n | \"one-time-code\"\r\n | \"organization-title\"\r\n | \"organization\"\r\n | \"street-address\"\r\n | \"address-line1\"\r\n | \"address-line2\"\r\n | \"address-line3\"\r\n | \"address-level4\"\r\n | \"address-level3\"\r\n | \"address-level2\"\r\n | \"address-level1\"\r\n | \"country\"\r\n | \"country-name\"\r\n | \"postal-code\"\r\n | \"cc-name\"\r\n | \"cc-given-name\"\r\n | \"cc-additional-name\"\r\n | \"cc-family-name\"\r\n | \"cc-family-name\"\r\n | \"cc-number\"\r\n | \"cc-exp\"\r\n | \"cc-exp-month\"\r\n | \"cc-exp-year\"\r\n | \"cc-csc\"\r\n | \"cc-type\"\r\n | \"transaction-currency\"\r\n | \"transaction-amount\"\r\n | \"language\"\r\n | \"bday\"\r\n | \"bday-day\"\r\n | \"bday-month\"\r\n | \"bday-year\"\r\n | \"sex\"\r\n | \"tel\"\r\n | \"tel-country-code\"\r\n | \"tel-national\"\r\n | \"tel-area-code\"\r\n | \"tel-local\"\r\n | \"tel-extension\"\r\n | \"impp\"\r\n | \"url\"\r\n | \"photo\";",
19314
+ "declaration": "export type IcAutocompleteTypes =\n | \"on\"\n | \"off\"\n | \"name\"\n | \"honorific-prefix\"\n | \"given-name\"\n | \"additional-name\"\n | \"family-name\"\n | \"honorific-suffix\"\n | \"nickname\"\n | \"email\"\n | \"username\"\n | \"new-password\"\n | \"current-password\"\n | \"one-time-code\"\n | \"organization-title\"\n | \"organization\"\n | \"street-address\"\n | \"address-line1\"\n | \"address-line2\"\n | \"address-line3\"\n | \"address-level4\"\n | \"address-level3\"\n | \"address-level2\"\n | \"address-level1\"\n | \"country\"\n | \"country-name\"\n | \"postal-code\"\n | \"cc-name\"\n | \"cc-given-name\"\n | \"cc-additional-name\"\n | \"cc-family-name\"\n | \"cc-family-name\"\n | \"cc-number\"\n | \"cc-exp\"\n | \"cc-exp-month\"\n | \"cc-exp-year\"\n | \"cc-csc\"\n | \"cc-type\"\n | \"transaction-currency\"\n | \"transaction-amount\"\n | \"language\"\n | \"bday\"\n | \"bday-day\"\n | \"bday-month\"\n | \"bday-year\"\n | \"sex\"\n | \"tel\"\n | \"tel-country-code\"\n | \"tel-national\"\n | \"tel-area-code\"\n | \"tel-local\"\n | \"tel-extension\"\n | \"impp\"\n | \"url\"\n | \"photo\";",
19308
19315
  "docstring": "",
19309
19316
  "path": "src/utils/types.ts"
19310
19317
  },
@@ -19329,7 +19336,7 @@
19329
19336
  "path": "src/components/ic-text-field/ic-text-field.types.ts"
19330
19337
  },
19331
19338
  "src/utils/types.ts::IcValueEventDetail": {
19332
- "declaration": "export interface IcValueEventDetail {\r\n value: string | string[];\r\n keyPressed?: string;\r\n}",
19339
+ "declaration": "export interface IcValueEventDetail {\n value: string | string[];\n keyPressed?: string;\n}",
19333
19340
  "docstring": "",
19334
19341
  "path": "src/utils/types.ts"
19335
19342
  },
@@ -19339,7 +19346,7 @@
19339
19346
  "path": "src/components/ic-divider/ic-divider.types.tsx"
19340
19347
  },
19341
19348
  "src/components/ic-divider/ic-divider.types.tsx::IcDividerLabelPlacement": {
19342
- "declaration": "export type IcDividerLabelPlacement =\r\n | \"left\"\r\n | \"center\"\r\n | \"right\"\r\n | \"top\"\r\n | \"bottom\";",
19349
+ "declaration": "export type IcDividerLabelPlacement =\n | \"left\"\n | \"center\"\n | \"right\"\n | \"top\"\n | \"bottom\";",
19343
19350
  "docstring": "",
19344
19351
  "path": "src/components/ic-divider/ic-divider.types.tsx"
19345
19352
  },
@@ -19359,7 +19366,7 @@
19359
19366
  "path": "src/components/ic-divider/ic-divider.types.tsx"
19360
19367
  },
19361
19368
  "src/utils/types.ts::IcTypographyVariants": {
19362
- "declaration": "export type IcTypographyVariants =\r\n | \"h1\"\r\n | \"h2\"\r\n | \"h3\"\r\n | \"h4\"\r\n | \"subtitle-large\"\r\n | \"subtitle-small\"\r\n | \"body\"\r\n | \"label\"\r\n | \"label-uppercase\"\r\n | \"caption\"\r\n | \"caption-uppercase\"\r\n | \"code-large\"\r\n | \"code-small\"\r\n | \"code-extra-small\"\r\n | \"badge\"\r\n | \"badge-small\";",
19369
+ "declaration": "export type IcTypographyVariants =\n | \"h1\"\n | \"h2\"\n | \"h3\"\n | \"h4\"\n | \"subtitle-large\"\n | \"subtitle-small\"\n | \"body\"\n | \"label\"\n | \"label-uppercase\"\n | \"caption\"\n | \"caption-uppercase\"\n | \"code-large\"\n | \"code-small\"\n | \"code-extra-small\"\n | \"badge\"\n | \"badge-small\";",
19363
19370
  "docstring": "",
19364
19371
  "path": "src/utils/types.ts"
19365
19372
  },
@@ -19399,7 +19406,7 @@
19399
19406
  "path": "src/components/ic-search-bar/ic-search-bar.types.ts"
19400
19407
  },
19401
19408
  "src/utils/types.ts::IcMenuOption": {
19402
- "declaration": "export interface IcMenuOption {\r\n description?: string;\r\n disabled?: boolean;\r\n recommended?: boolean;\r\n children?: IcMenuOption[];\r\n loading?: boolean;\r\n timedOut?: boolean;\r\n [key: string]: any;\r\n element?: {\r\n component: any;\r\n ariaLabel: string;\r\n };\r\n icon?: any;\r\n}",
19409
+ "declaration": "export interface IcMenuOption {\n description?: string;\n disabled?: boolean;\n recommended?: boolean;\n children?: IcMenuOption[];\n loading?: boolean;\n timedOut?: boolean;\n [key: string]: any;\n element?: {\n component: any;\n ariaLabel: string;\n };\n icon?: any;\n}",
19403
19410
  "docstring": "",
19404
19411
  "path": "src/utils/types.ts"
19405
19412
  },
@@ -19424,7 +19431,7 @@
19424
19431
  "path": "src/components/ic-menu-item/ic-menu-item.types.ts"
19425
19432
  },
19426
19433
  "src/components/ic-side-navigation/ic-side-navigation.types.ts::IcExpandedDetail": {
19427
- "declaration": "export interface IcExpandedDetail {\r\n sideNavExpanded: boolean;\r\n sideNavMobile: boolean;\r\n}",
19434
+ "declaration": "export interface IcExpandedDetail {\n sideNavExpanded: boolean;\n sideNavMobile: boolean;\n}",
19428
19435
  "docstring": "",
19429
19436
  "path": "src/components/ic-side-navigation/ic-side-navigation.types.ts"
19430
19437
  },
@@ -19454,7 +19461,7 @@
19454
19461
  "path": "src/components/ic-radio-group/ic-radio-group.types.ts"
19455
19462
  },
19456
19463
  "src/utils/types.ts::IcBlurEventDetail": {
19457
- "declaration": "export interface IcBlurEventDetail {\r\n relatedTarget: IcRelatedTarget;\r\n}",
19464
+ "declaration": "export interface IcBlurEventDetail {\n relatedTarget: IcRelatedTarget;\n}",
19458
19465
  "docstring": "",
19459
19466
  "path": "src/utils/types.ts"
19460
19467
  },
@@ -19509,7 +19516,12 @@
19509
19516
  "path": "src/components/ic-tab/ic-tab.types.ts"
19510
19517
  },
19511
19518
  "src/utils/types.ts::IcBrand": {
19512
- "declaration": "{\r\n mode: IcBrandForeground;\r\n color: IcColorRGB;\r\n}",
19519
+ "declaration": "{\n mode: IcBrandForeground;\n color: IcColorRGB;\n}",
19520
+ "docstring": "",
19521
+ "path": "src/utils/types.ts"
19522
+ },
19523
+ "src/utils/types.ts::IcIconPlacementOptions": {
19524
+ "declaration": "export type IcIconPlacementOptions = \"left\" | \"right\" | \"top\";",
19513
19525
  "docstring": "",
19514
19526
  "path": "src/utils/types.ts"
19515
19527
  },
@@ -19524,7 +19536,7 @@
19524
19536
  "path": "src/utils/types.ts"
19525
19537
  },
19526
19538
  "src/components/ic-toggle-button-group/ic-toggle-button-group.types.ts::IcChangeEventDetail": {
19527
- "declaration": "export interface IcChangeEventDetail {\r\n checked: boolean[] | boolean;\r\n toggledOptions?: {\r\n toggleButton: HTMLIcToggleButtonElement;\r\n }[];\r\n selectedOption: HTMLIcToggleButtonElement;\r\n}",
19539
+ "declaration": "export interface IcChangeEventDetail {\n checked: boolean[] | boolean;\n toggledOptions?: {\n toggleButton: HTMLIcToggleButtonElement;\n }[];\n selectedOption: HTMLIcToggleButtonElement;\n}",
19528
19540
  "docstring": "",
19529
19541
  "path": "src/components/ic-toggle-button-group/ic-toggle-button-group.types.ts"
19530
19542
  }
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "author": "mi6",
3
3
  "name": "@ukic/docs",
4
- "version": "3.0.0-alpha.7",
4
+ "version": "3.0.0-alpha.8",
5
5
  "description": "API documentation for @ukic components",
6
6
  "main": "docs.json",
7
7
  "types": "docs.d.ts",
@@ -18,5 +18,5 @@
18
18
  "email": "icds@gchq.gov.uk"
19
19
  },
20
20
  "license": "MIT",
21
- "gitHead": "0a552da91d9f65e72b19d4518fb54efcf018d7bf"
21
+ "gitHead": "aadff337c20cb1dee5e221f7e88179dc8242789e"
22
22
  }