@ukic/docs 3.0.0-alpha.14 → 3.0.0-alpha.15

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 +207 -102
  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\n\n\n",
12
+ "readme": "# ic-accordion\r\n\r\n\r\n\r",
13
13
  "docs": "",
14
14
  "docsTags": [
15
15
  {
@@ -268,7 +268,7 @@
268
268
  "filePath": "src/components/ic-accordion-group/ic-accordion-group.tsx",
269
269
  "encapsulation": "shadow",
270
270
  "tag": "ic-accordion-group",
271
- "readme": "# ic-accordion-title\n\n\n",
271
+ "readme": "# ic-accordion-title\r\n\r\n\r\n\r",
272
272
  "docs": "",
273
273
  "docsTags": [
274
274
  {
@@ -538,7 +538,7 @@
538
538
  "filePath": "src/components/ic-alert/ic-alert.tsx",
539
539
  "encapsulation": "shadow",
540
540
  "tag": "ic-alert",
541
- "readme": "# ic-alert\n\n\n",
541
+ "readme": "# ic-alert\r\n\r\n\r\n\r",
542
542
  "docs": "",
543
543
  "docsTags": [
544
544
  {
@@ -877,7 +877,7 @@
877
877
  "filePath": "src/components/ic-back-to-top/ic-back-to-top.tsx",
878
878
  "encapsulation": "shadow",
879
879
  "tag": "ic-back-to-top",
880
- "readme": "# ic-back-to-top\n\n\n",
880
+ "readme": "# ic-back-to-top\r\n\r\n\r\n\r",
881
881
  "docs": "",
882
882
  "docsTags": [],
883
883
  "usage": {},
@@ -1080,7 +1080,7 @@
1080
1080
  "filePath": "src/components/ic-badge/ic-badge.tsx",
1081
1081
  "encapsulation": "shadow",
1082
1082
  "tag": "ic-badge",
1083
- "readme": "# ic-badge\n\n\n",
1083
+ "readme": "# ic-badge\r\n\r\n\r\n\r",
1084
1084
  "docs": "",
1085
1085
  "docsTags": [
1086
1086
  {
@@ -1498,7 +1498,7 @@
1498
1498
  "filePath": "src/components/ic-breadcrumb/ic-breadcrumb.tsx",
1499
1499
  "encapsulation": "shadow",
1500
1500
  "tag": "ic-breadcrumb",
1501
- "readme": "# ic-breadcrumb\n\n\n",
1501
+ "readme": "# ic-breadcrumb\r\n\r\n\r\n\r",
1502
1502
  "docs": "",
1503
1503
  "docsTags": [
1504
1504
  {
@@ -1638,7 +1638,7 @@
1638
1638
  "filePath": "src/components/ic-breadcrumb-group/ic-breadcrumb-group.tsx",
1639
1639
  "encapsulation": "shadow",
1640
1640
  "tag": "ic-breadcrumb-group",
1641
- "readme": "# ic-breadcrumb-group\n\n\n",
1641
+ "readme": "# ic-breadcrumb-group\r\n\r\n\r\n\r",
1642
1642
  "docs": "",
1643
1643
  "docsTags": [],
1644
1644
  "usage": {},
@@ -1790,7 +1790,7 @@
1790
1790
  "filePath": "src/components/ic-button/ic-button.tsx",
1791
1791
  "encapsulation": "shadow",
1792
1792
  "tag": "ic-button",
1793
- "readme": "# ic-button\n",
1793
+ "readme": "# ic-button\r\n\r",
1794
1794
  "docs": "",
1795
1795
  "docsTags": [
1796
1796
  {
@@ -2972,7 +2972,7 @@
2972
2972
  "filePath": "src/components/ic-card-vertical/ic-card-vertical.tsx",
2973
2973
  "encapsulation": "shadow",
2974
2974
  "tag": "ic-card-vertical",
2975
- "readme": "# ic-card-vertical\n\n\n",
2975
+ "readme": "# ic-card-vertical\r\n\r\n\r\n\r",
2976
2976
  "docs": "",
2977
2977
  "docsTags": [
2978
2978
  {
@@ -3525,7 +3525,7 @@
3525
3525
  "filePath": "src/components/ic-checkbox/ic-checkbox.tsx",
3526
3526
  "encapsulation": "shadow",
3527
3527
  "tag": "ic-checkbox",
3528
- "readme": "# ic-checkbox\n\n\n",
3528
+ "readme": "# ic-checkbox\r\n\r\n\r\n\r",
3529
3529
  "docs": "",
3530
3530
  "docsTags": [
3531
3531
  {
@@ -4010,7 +4010,7 @@
4010
4010
  "filePath": "src/components/ic-checkbox-group/ic-checkbox-group.tsx",
4011
4011
  "encapsulation": "shadow",
4012
4012
  "tag": "ic-checkbox-group",
4013
- "readme": "# ic-checkbox-group\n\n\n",
4013
+ "readme": "# ic-checkbox-group\r\n\r\n\r\n\r",
4014
4014
  "docs": "",
4015
4015
  "docsTags": [],
4016
4016
  "usage": {},
@@ -4309,7 +4309,7 @@
4309
4309
  "mutable": false,
4310
4310
  "attr": "validation-text",
4311
4311
  "reflectToAttr": false,
4312
- "docs": "The validation text - e.g. 'error' | 'warning' | 'success'.",
4312
+ "docs": "The text to display as the validation message.",
4313
4313
  "docsTags": [],
4314
4314
  "default": "\"\"",
4315
4315
  "values": [
@@ -4386,7 +4386,7 @@
4386
4386
  "filePath": "src/components/ic-chip/ic-chip.tsx",
4387
4387
  "encapsulation": "shadow",
4388
4388
  "tag": "ic-chip",
4389
- "readme": "# ic-chip\n\n\n",
4389
+ "readme": "# ic-chip\r\n\r\n\r\n\r",
4390
4390
  "docs": "",
4391
4391
  "docsTags": [
4392
4392
  {
@@ -4764,7 +4764,7 @@
4764
4764
  "filePath": "src/components/ic-classification-banner/ic-classification-banner.tsx",
4765
4765
  "encapsulation": "shadow",
4766
4766
  "tag": "ic-classification-banner",
4767
- "readme": "# ic-classification-banner\n\n\n",
4767
+ "readme": "# ic-classification-banner\r\n\r\n\r\n\r",
4768
4768
  "docs": "",
4769
4769
  "docsTags": [],
4770
4770
  "usage": {},
@@ -4954,7 +4954,7 @@
4954
4954
  "filePath": "src/components/ic-data-list/ic-data-list.tsx",
4955
4955
  "encapsulation": "shadow",
4956
4956
  "tag": "ic-data-list",
4957
- "readme": "# ic-data-list\n\n\n",
4957
+ "readme": "# ic-data-list\r\n\r\n\r\n\r",
4958
4958
  "docs": "",
4959
4959
  "docsTags": [
4960
4960
  {
@@ -5096,7 +5096,7 @@
5096
5096
  "filePath": "src/components/ic-data-row/ic-data-row.tsx",
5097
5097
  "encapsulation": "shadow",
5098
5098
  "tag": "ic-data-row",
5099
- "readme": "# ic-data-row\n\n\n",
5099
+ "readme": "# ic-data-row\r\n\r\n\r\n\r",
5100
5100
  "docs": "",
5101
5101
  "docsTags": [
5102
5102
  {
@@ -5280,7 +5280,7 @@
5280
5280
  "filePath": "src/components/ic-dialog/ic-dialog.tsx",
5281
5281
  "encapsulation": "shadow",
5282
5282
  "tag": "ic-dialog",
5283
- "readme": "# ic-dialog\n\n\n",
5283
+ "readme": "# ic-dialog\r\n\r\n\r\n\r",
5284
5284
  "docs": "",
5285
5285
  "docsTags": [
5286
5286
  {
@@ -5302,33 +5302,6 @@
5302
5302
  ],
5303
5303
  "usage": {},
5304
5304
  "props": [
5305
- {
5306
- "name": "buttons",
5307
- "type": "boolean | undefined",
5308
- "complexType": {
5309
- "original": "boolean",
5310
- "resolved": "boolean | undefined",
5311
- "references": {}
5312
- },
5313
- "mutable": false,
5314
- "attr": "buttons",
5315
- "reflectToAttr": false,
5316
- "docs": "If set to `false`, default buttons will not be shown, but slotted dialog controls will still be displayed.",
5317
- "docsTags": [],
5318
- "default": "true",
5319
- "values": [
5320
- {
5321
- "type": "boolean"
5322
- },
5323
- {
5324
- "type": "undefined"
5325
- }
5326
- ],
5327
- "optional": true,
5328
- "required": false,
5329
- "getter": false,
5330
- "setter": false
5331
- },
5332
5305
  {
5333
5306
  "name": "closeOnBackdropClick",
5334
5307
  "type": "boolean | undefined",
@@ -5517,6 +5490,30 @@
5517
5490
  "getter": false,
5518
5491
  "setter": false
5519
5492
  },
5493
+ {
5494
+ "name": "hideDefaultControls",
5495
+ "type": "boolean",
5496
+ "complexType": {
5497
+ "original": "boolean",
5498
+ "resolved": "boolean",
5499
+ "references": {}
5500
+ },
5501
+ "mutable": false,
5502
+ "attr": "hide-default-controls",
5503
+ "reflectToAttr": false,
5504
+ "docs": "If set to `true`, default button controls will not be shown, but slotted dialog controls will still be displayed.",
5505
+ "docsTags": [],
5506
+ "default": "false",
5507
+ "values": [
5508
+ {
5509
+ "type": "boolean"
5510
+ }
5511
+ ],
5512
+ "optional": false,
5513
+ "required": false,
5514
+ "getter": false,
5515
+ "setter": false
5516
+ },
5520
5517
  {
5521
5518
  "name": "label",
5522
5519
  "type": "string | undefined",
@@ -5819,7 +5816,7 @@
5819
5816
  "filePath": "src/components/ic-divider/ic-divider.tsx",
5820
5817
  "encapsulation": "scoped",
5821
5818
  "tag": "ic-divider",
5822
- "readme": "# ic-divider\n\n\n",
5819
+ "readme": "# ic-divider\r\n\r\n\r\n\r",
5823
5820
  "docs": "",
5824
5821
  "docsTags": [],
5825
5822
  "usage": {},
@@ -6169,7 +6166,7 @@
6169
6166
  "filePath": "src/components/ic-empty-state/ic-empty-state.tsx",
6170
6167
  "encapsulation": "shadow",
6171
6168
  "tag": "ic-empty-state",
6172
- "readme": "# ic-empty-state\n\n\n",
6169
+ "readme": "# ic-empty-state\r\n\r\n\r\n\r",
6173
6170
  "docs": "",
6174
6171
  "docsTags": [
6175
6172
  {
@@ -6467,7 +6464,7 @@
6467
6464
  "filePath": "src/components/ic-footer/ic-footer.tsx",
6468
6465
  "encapsulation": "shadow",
6469
6466
  "tag": "ic-footer",
6470
- "readme": "# ic-footer\n\n\n",
6467
+ "readme": "# ic-footer\r\n\r\n\r\n\r",
6471
6468
  "docs": "",
6472
6469
  "docsTags": [
6473
6470
  {
@@ -6734,7 +6731,7 @@
6734
6731
  "filePath": "src/components/ic-footer-link/ic-footer-link.tsx",
6735
6732
  "encapsulation": "shadow",
6736
6733
  "tag": "ic-footer-link",
6737
- "readme": "# ic-footer-link\n\n\n",
6734
+ "readme": "# ic-footer-link\r\n\r\n\r\n\r",
6738
6735
  "docs": "",
6739
6736
  "docsTags": [],
6740
6737
  "usage": {},
@@ -6970,7 +6967,7 @@
6970
6967
  "filePath": "src/components/ic-footer-link-group/ic-footer-link-group.tsx",
6971
6968
  "encapsulation": "shadow",
6972
6969
  "tag": "ic-footer-link-group",
6973
- "readme": "# ic-footer-link-group\n\n\n",
6970
+ "readme": "# ic-footer-link-group\r\n\r\n\r\n\r",
6974
6971
  "docs": "",
6975
6972
  "docsTags": [],
6976
6973
  "usage": {},
@@ -7034,7 +7031,7 @@
7034
7031
  "filePath": "src/components/ic-hero/ic-hero.tsx",
7035
7032
  "encapsulation": "shadow",
7036
7033
  "tag": "ic-hero",
7037
- "readme": "# ic-hero\n\n\n",
7034
+ "readme": "# ic-hero\r\n\r\n\r\n\r",
7038
7035
  "docs": "",
7039
7036
  "docsTags": [
7040
7037
  {
@@ -7384,7 +7381,7 @@
7384
7381
  "filePath": "src/components/ic-horizontal-scroll/ic-horizontal-scroll.tsx",
7385
7382
  "encapsulation": "shadow",
7386
7383
  "tag": "ic-horizontal-scroll",
7387
- "readme": "# ic-horizontal-scroll\n\n\n",
7384
+ "readme": "# ic-horizontal-scroll\r\n\r\n\r\n\r",
7388
7385
  "docs": "",
7389
7386
  "docsTags": [],
7390
7387
  "usage": {},
@@ -7476,7 +7473,7 @@
7476
7473
  "filePath": "src/components/ic-input-component-container/ic-input-component-container.tsx",
7477
7474
  "encapsulation": "none",
7478
7475
  "tag": "ic-input-component-container",
7479
- "readme": "# ic-input-container\n\n\n",
7476
+ "readme": "# ic-input-container\r\n\r\n\r\n\r",
7480
7477
  "docs": "",
7481
7478
  "docsTags": [
7482
7479
  {
@@ -7808,7 +7805,7 @@
7808
7805
  "filePath": "src/components/ic-input-container/ic-input-container.tsx",
7809
7806
  "encapsulation": "none",
7810
7807
  "tag": "ic-input-container",
7811
- "readme": "# ic-input-container\n\n\n",
7808
+ "readme": "# ic-input-container\r\n\r\n\r\n\r",
7812
7809
  "docs": "",
7813
7810
  "docsTags": [],
7814
7811
  "usage": {},
@@ -7896,7 +7893,7 @@
7896
7893
  "filePath": "src/components/ic-input-label/ic-input-label.tsx",
7897
7894
  "encapsulation": "none",
7898
7895
  "tag": "ic-input-label",
7899
- "readme": "# ic-input-label\n\n\n",
7896
+ "readme": "# ic-input-label\r\n\r\n\r\n\r",
7900
7897
  "docs": "",
7901
7898
  "docsTags": [],
7902
7899
  "usage": {},
@@ -8147,7 +8144,7 @@
8147
8144
  "filePath": "src/components/ic-input-validation/ic-input-validation.tsx",
8148
8145
  "encapsulation": "none",
8149
8146
  "tag": "ic-input-validation",
8150
- "readme": "# ic-input-validation\n\n\n",
8147
+ "readme": "# ic-input-validation\r\n\r\n\r\n\r",
8151
8148
  "docs": "",
8152
8149
  "docsTags": [
8153
8150
  {
@@ -8359,7 +8356,7 @@
8359
8356
  "filePath": "src/components/ic-link/ic-link.tsx",
8360
8357
  "encapsulation": "shadow",
8361
8358
  "tag": "ic-link",
8362
- "readme": "# ic-link\n\n\n",
8359
+ "readme": "# ic-link\r\n\r\n\r\n\r",
8363
8360
  "docs": "",
8364
8361
  "docsTags": [
8365
8362
  {
@@ -8699,7 +8696,7 @@
8699
8696
  "filePath": "src/components/ic-loading-indicator/ic-loading-indicator.tsx",
8700
8697
  "encapsulation": "shadow",
8701
8698
  "tag": "ic-loading-indicator",
8702
- "readme": "# ic-loading\n\n\n",
8699
+ "readme": "# ic-loading\r\n\r\n\r\n\r",
8703
8700
  "docs": "",
8704
8701
  "docsTags": [],
8705
8702
  "usage": {},
@@ -9096,7 +9093,7 @@
9096
9093
  "filePath": "src/components/ic-menu/ic-menu.tsx",
9097
9094
  "encapsulation": "scoped",
9098
9095
  "tag": "ic-menu",
9099
- "readme": "# ic-menu\n\n\n",
9096
+ "readme": "# ic-menu\r\n\r\n\r\n\r",
9100
9097
  "docs": "",
9101
9098
  "docsTags": [],
9102
9099
  "usage": {},
@@ -9614,7 +9611,7 @@
9614
9611
  "filePath": "src/components/ic-menu-group/ic-menu-group.tsx",
9615
9612
  "encapsulation": "shadow",
9616
9613
  "tag": "ic-menu-group",
9617
- "readme": "# ic-menu-group\n\n\n",
9614
+ "readme": "# ic-menu-group\r\n\r\n\r\n\r",
9618
9615
  "docs": "",
9619
9616
  "docsTags": [],
9620
9617
  "usage": {},
@@ -9666,7 +9663,7 @@
9666
9663
  "filePath": "src/components/ic-menu-item/ic-menu-item.tsx",
9667
9664
  "encapsulation": "shadow",
9668
9665
  "tag": "ic-menu-item",
9669
- "readme": "# ic-menu-item\n\n\n",
9666
+ "readme": "# ic-menu-item\r\n\r\n\r\n\r",
9670
9667
  "docs": "",
9671
9668
  "docsTags": [
9672
9669
  {
@@ -10105,7 +10102,7 @@
10105
10102
  "filePath": "src/components/ic-navigation-button/ic-navigation-button.tsx",
10106
10103
  "encapsulation": "shadow",
10107
10104
  "tag": "ic-navigation-button",
10108
- "readme": "# ic-navigation-button\n\n\n",
10105
+ "readme": "# ic-navigation-button\r\n\r\n\r\n\r",
10109
10106
  "docs": "",
10110
10107
  "docsTags": [
10111
10108
  {
@@ -10464,7 +10461,7 @@
10464
10461
  "filePath": "src/components/ic-navigation-group/ic-navigation-group.tsx",
10465
10462
  "encapsulation": "shadow",
10466
10463
  "tag": "ic-navigation-group",
10467
- "readme": "# ic-navigation-group\n\n\n",
10464
+ "readme": "# ic-navigation-group\r\n\r\n\r\n\r",
10468
10465
  "docs": "",
10469
10466
  "docsTags": [],
10470
10467
  "usage": {},
@@ -10480,7 +10477,7 @@
10480
10477
  "mutable": false,
10481
10478
  "attr": "expandable",
10482
10479
  "reflectToAttr": false,
10483
- "docs": "If `true`, the group will be expandable in the side menu.",
10480
+ "docs": "If `true`, the group will be expandable when in an ic-side-navigation component, or, when in an ic-top-navigation component, in the side menu displayed at small screen sizes.",
10484
10481
  "docsTags": [],
10485
10482
  "default": "false",
10486
10483
  "values": [
@@ -10634,7 +10631,7 @@
10634
10631
  "filePath": "src/components/ic-navigation-item/ic-navigation-item.tsx",
10635
10632
  "encapsulation": "shadow",
10636
10633
  "tag": "ic-navigation-item",
10637
- "readme": "# ic-navigation-item\n\n\n",
10634
+ "readme": "# ic-navigation-item\r\n\r\n\r\n\r",
10638
10635
  "docs": "",
10639
10636
  "docsTags": [
10640
10637
  {
@@ -11021,7 +11018,7 @@
11021
11018
  "filePath": "src/components/ic-navigation-menu/ic-navigation-menu.tsx",
11022
11019
  "encapsulation": "shadow",
11023
11020
  "tag": "ic-navigation-menu",
11024
- "readme": "# ic-navigation-menu\n\n\n",
11021
+ "readme": "# ic-navigation-menu\r\n\r\n\r\n\r",
11025
11022
  "docs": "",
11026
11023
  "docsTags": [
11027
11024
  {
@@ -11197,7 +11194,7 @@
11197
11194
  "filePath": "src/components/ic-page-header/ic-page-header.tsx",
11198
11195
  "encapsulation": "shadow",
11199
11196
  "tag": "ic-page-header",
11200
- "readme": "# ic-page-header\n\n\n",
11197
+ "readme": "# ic-page-header\r\n\r\n\r\n\r",
11201
11198
  "docs": "",
11202
11199
  "docsTags": [
11203
11200
  {
@@ -11595,7 +11592,7 @@
11595
11592
  "filePath": "src/components/ic-pagination/ic-pagination.tsx",
11596
11593
  "encapsulation": "shadow",
11597
11594
  "tag": "ic-pagination",
11598
- "readme": "# ic-pagination\n\n\n",
11595
+ "readme": "# ic-pagination\r\n\r\n\r\n\r",
11599
11596
  "docs": "",
11600
11597
  "docsTags": [],
11601
11598
  "usage": {},
@@ -12050,7 +12047,7 @@
12050
12047
  "filePath": "src/components/ic-pagination-item/ic-pagination-item.tsx",
12051
12048
  "encapsulation": "shadow",
12052
12049
  "tag": "ic-pagination-item",
12053
- "readme": "# ic-pagination-item\n\n\n",
12050
+ "readme": "# ic-pagination-item\r\n\r\n\r\n\r",
12054
12051
  "docs": "",
12055
12052
  "docsTags": [],
12056
12053
  "usage": {},
@@ -12292,7 +12289,7 @@
12292
12289
  "filePath": "src/components/ic-popover-menu/ic-popover-menu.tsx",
12293
12290
  "encapsulation": "shadow",
12294
12291
  "tag": "ic-popover-menu",
12295
- "readme": "# ic-popover-menu\n\nThis is a wrapper component to be placed around one or more ic-menu-item components.\n",
12292
+ "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",
12296
12293
  "docs": "This is a wrapper component to be placed around one or more ic-menu-item components.",
12297
12294
  "docsTags": [],
12298
12295
  "usage": {},
@@ -12514,7 +12511,7 @@
12514
12511
  "filePath": "src/components/ic-radio-group/ic-radio-group.tsx",
12515
12512
  "encapsulation": "shadow",
12516
12513
  "tag": "ic-radio-group",
12517
- "readme": "# ic-radio-group\n\n\n",
12514
+ "readme": "# ic-radio-group\r\n\r\n\r\n\r",
12518
12515
  "docs": "",
12519
12516
  "docsTags": [],
12520
12517
  "usage": {},
@@ -12846,7 +12843,7 @@
12846
12843
  "mutable": false,
12847
12844
  "attr": "validation-text",
12848
12845
  "reflectToAttr": false,
12849
- "docs": "The validation text - e.g. 'error' | 'warning' | 'success'.",
12846
+ "docs": "The text to display as the validation message.",
12850
12847
  "docsTags": [],
12851
12848
  "default": "\"\"",
12852
12849
  "values": [
@@ -12923,7 +12920,7 @@
12923
12920
  "filePath": "src/components/ic-radio-option/ic-radio-option.tsx",
12924
12921
  "encapsulation": "none",
12925
12922
  "tag": "ic-radio-option",
12926
- "readme": "# ic-radio-option\n\n\n",
12923
+ "readme": "# ic-radio-option\r\n\r\n\r\n\r",
12927
12924
  "docs": "",
12928
12925
  "docsTags": [
12929
12926
  {
@@ -13316,7 +13313,7 @@
13316
13313
  "filePath": "src/components/ic-search-bar/ic-search-bar.tsx",
13317
13314
  "encapsulation": "shadow",
13318
13315
  "tag": "ic-search-bar",
13319
- "readme": "# ic-search-bar\n\n\n",
13316
+ "readme": "# ic-search-bar\r\n\r\n\r\n\r",
13320
13317
  "docs": "",
13321
13318
  "docsTags": [],
13322
13319
  "usage": {},
@@ -14494,7 +14491,7 @@
14494
14491
  "filePath": "src/components/ic-section-container/ic-section-container.tsx",
14495
14492
  "encapsulation": "shadow",
14496
14493
  "tag": "ic-section-container",
14497
- "readme": "# ic-section-container\n\n\n",
14494
+ "readme": "# ic-section-container\r\n\r\n\r\n\r",
14498
14495
  "docs": "",
14499
14496
  "docsTags": [],
14500
14497
  "usage": {},
@@ -14605,7 +14602,7 @@
14605
14602
  "filePath": "src/components/ic-select/ic-select.tsx",
14606
14603
  "encapsulation": "shadow",
14607
14604
  "tag": "ic-select",
14608
- "readme": "# ic-select\n\n\n",
14605
+ "readme": "# ic-select\r\n\r\n\r\n\r",
14609
14606
  "docs": "",
14610
14607
  "docsTags": [
14611
14608
  {
@@ -15467,7 +15464,7 @@
15467
15464
  "mutable": true,
15468
15465
  "attr": "value",
15469
15466
  "reflectToAttr": false,
15470
- "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.",
15467
+ "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.",
15471
15468
  "docsTags": [],
15472
15469
  "values": [
15473
15470
  {
@@ -15661,7 +15658,7 @@
15661
15658
  },
15662
15659
  "cancelable": true,
15663
15660
  "composed": true,
15664
- "docs": "Emitted when an option is selected.\nSelecting an option will also trigger an `icChange/onIcChange` due to the value being updated.",
15661
+ "docs": "Emitted when an option is selected.\r\nSelecting an option will also trigger an `icChange/onIcChange` due to the value being updated.",
15665
15662
  "docsTags": []
15666
15663
  },
15667
15664
  {
@@ -15758,7 +15755,7 @@
15758
15755
  "filePath": "src/components/ic-side-navigation/ic-side-navigation.tsx",
15759
15756
  "encapsulation": "shadow",
15760
15757
  "tag": "ic-side-navigation",
15761
- "readme": "# ic-side-navigation\n\n\n",
15758
+ "readme": "# ic-side-navigation\r\n\r\n\r\n\r",
15762
15759
  "docs": "",
15763
15760
  "docsTags": [
15764
15761
  {
@@ -16137,8 +16134,8 @@
16137
16134
  "filePath": "src/components/ic-skeleton/ic-skeleton.tsx",
16138
16135
  "encapsulation": "shadow",
16139
16136
  "tag": "ic-skeleton",
16140
- "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",
16141
- "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.",
16137
+ "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",
16138
+ "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.",
16142
16139
  "docsTags": [],
16143
16140
  "usage": {},
16144
16141
  "props": [
@@ -16241,7 +16238,7 @@
16241
16238
  "filePath": "src/components/ic-skip-link/ic-skip-link.tsx",
16242
16239
  "encapsulation": "shadow",
16243
16240
  "tag": "ic-skip-link",
16244
- "readme": "# ic-skip-link\n\n\n",
16241
+ "readme": "# ic-skip-link\r\n\r\n\r\n\r",
16245
16242
  "docs": "",
16246
16243
  "docsTags": [],
16247
16244
  "usage": {},
@@ -16455,7 +16452,7 @@
16455
16452
  "filePath": "src/components/ic-status-tag/ic-status-tag.tsx",
16456
16453
  "encapsulation": "shadow",
16457
16454
  "tag": "ic-status-tag",
16458
- "readme": "# ic-status-tag\n\n\n",
16455
+ "readme": "# ic-status-tag\r\n\r\n\r\n\r",
16459
16456
  "docs": "",
16460
16457
  "docsTags": [],
16461
16458
  "usage": {},
@@ -16720,7 +16717,7 @@
16720
16717
  "filePath": "src/components/ic-step/ic-step.tsx",
16721
16718
  "encapsulation": "shadow",
16722
16719
  "tag": "ic-step",
16723
- "readme": "# ic-step\n\n\n",
16720
+ "readme": "# ic-step\r\n\r\n\r\n\r",
16724
16721
  "docs": "",
16725
16722
  "docsTags": [],
16726
16723
  "usage": {},
@@ -16886,7 +16883,7 @@
16886
16883
  "filePath": "src/components/ic-stepper/ic-stepper.tsx",
16887
16884
  "encapsulation": "shadow",
16888
16885
  "tag": "ic-stepper",
16889
- "readme": "# ic-stepper\n\nThis is a wrapper component to be placed around one or more ic-step components\n",
16886
+ "readme": "# ic-stepper\r\n\r\nThis is a wrapper component to be placed around one or more ic-step components\r\n\r",
16890
16887
  "docs": "This is a wrapper component to be placed around one or more ic-step components",
16891
16888
  "docsTags": [],
16892
16889
  "usage": {},
@@ -17078,7 +17075,7 @@
17078
17075
  "filePath": "src/components/ic-switch/ic-switch.tsx",
17079
17076
  "encapsulation": "shadow",
17080
17077
  "tag": "ic-switch",
17081
- "readme": "# ic-switch\n\n\n",
17078
+ "readme": "# ic-switch\r\n\r\n\r\n\r",
17082
17079
  "docs": "",
17083
17080
  "docsTags": [
17084
17081
  {
@@ -17457,7 +17454,7 @@
17457
17454
  "filePath": "src/components/ic-tab/ic-tab.tsx",
17458
17455
  "encapsulation": "shadow",
17459
17456
  "tag": "ic-tab",
17460
- "readme": "# ic-tab\n\n\n",
17457
+ "readme": "# ic-tab\r\n\r\n\r\n\r",
17461
17458
  "docs": "",
17462
17459
  "docsTags": [
17463
17460
  {
@@ -17551,7 +17548,7 @@
17551
17548
  "filePath": "src/components/ic-tab-context/ic-tab-context.tsx",
17552
17549
  "encapsulation": "none",
17553
17550
  "tag": "ic-tab-context",
17554
- "readme": "# ic-tab-context\n\n\n",
17551
+ "readme": "# ic-tab-context\r\n\r\n\r\n\r",
17555
17552
  "docs": "",
17556
17553
  "docsTags": [],
17557
17554
  "usage": {},
@@ -17773,7 +17770,7 @@
17773
17770
  "filePath": "src/components/ic-tab-group/ic-tab-group.tsx",
17774
17771
  "encapsulation": "shadow",
17775
17772
  "tag": "ic-tab-group",
17776
- "readme": "# ic-tab-group\n\n\n",
17773
+ "readme": "# ic-tab-group\r\n\r\n\r\n\r",
17777
17774
  "docs": "",
17778
17775
  "docsTags": [],
17779
17776
  "usage": {},
@@ -17863,7 +17860,7 @@
17863
17860
  "filePath": "src/components/ic-tab-panel/ic-tab-panel.tsx",
17864
17861
  "encapsulation": "shadow",
17865
17862
  "tag": "ic-tab-panel",
17866
- "readme": "# ic-tab-panel\n\n\n",
17863
+ "readme": "# ic-tab-panel\r\n\r\n\r\n\r",
17867
17864
  "docs": "",
17868
17865
  "docsTags": [],
17869
17866
  "usage": {},
@@ -17882,7 +17879,7 @@
17882
17879
  "filePath": "src/components/ic-text-field/ic-text-field.tsx",
17883
17880
  "encapsulation": "shadow",
17884
17881
  "tag": "ic-text-field",
17885
- "readme": "# ic-textfield\n\n\n",
17882
+ "readme": "# ic-textfield\r\n\r\n\r\n\r",
17886
17883
  "docs": "",
17887
17884
  "docsTags": [
17888
17885
  {
@@ -18347,6 +18344,60 @@
18347
18344
  "getter": false,
18348
18345
  "setter": false
18349
18346
  },
18347
+ {
18348
+ "name": "maxCharactersMessage",
18349
+ "type": "string | undefined",
18350
+ "complexType": {
18351
+ "original": "string",
18352
+ "resolved": "string | undefined",
18353
+ "references": {}
18354
+ },
18355
+ "mutable": false,
18356
+ "attr": "max-characters-message",
18357
+ "reflectToAttr": false,
18358
+ "docs": "The text to display as the warning message when the maximum number of characters (the `maxCharacters` prop value) is reached.",
18359
+ "docsTags": [],
18360
+ "default": "`Maximum input is ${this.maxCharacters} characters`",
18361
+ "values": [
18362
+ {
18363
+ "type": "string"
18364
+ },
18365
+ {
18366
+ "type": "undefined"
18367
+ }
18368
+ ],
18369
+ "optional": true,
18370
+ "required": false,
18371
+ "getter": false,
18372
+ "setter": false
18373
+ },
18374
+ {
18375
+ "name": "maxMessage",
18376
+ "type": "string | undefined",
18377
+ "complexType": {
18378
+ "original": "string",
18379
+ "resolved": "string | undefined",
18380
+ "references": {}
18381
+ },
18382
+ "mutable": false,
18383
+ "attr": "max-message",
18384
+ "reflectToAttr": false,
18385
+ "docs": "The text to display as the error message when the maximum value (the `max` prop value) has been exceeded.",
18386
+ "docsTags": [],
18387
+ "default": "`Maximum value of ${this.max} exceeded`",
18388
+ "values": [
18389
+ {
18390
+ "type": "string"
18391
+ },
18392
+ {
18393
+ "type": "undefined"
18394
+ }
18395
+ ],
18396
+ "optional": true,
18397
+ "required": false,
18398
+ "getter": false,
18399
+ "setter": false
18400
+ },
18350
18401
  {
18351
18402
  "name": "min",
18352
18403
  "type": "number | string | undefined",
@@ -18403,6 +18454,60 @@
18403
18454
  "getter": false,
18404
18455
  "setter": false
18405
18456
  },
18457
+ {
18458
+ "name": "minCharactersMessage",
18459
+ "type": "string | undefined",
18460
+ "complexType": {
18461
+ "original": "string",
18462
+ "resolved": "string | undefined",
18463
+ "references": {}
18464
+ },
18465
+ "mutable": false,
18466
+ "attr": "min-characters-message",
18467
+ "reflectToAttr": false,
18468
+ "docs": "The text to display as the error message when the minimum number of characters (the `minCharacters` prop value) has not been met.",
18469
+ "docsTags": [],
18470
+ "default": "`Minimum input is ${this.minCharacters} characters`",
18471
+ "values": [
18472
+ {
18473
+ "type": "string"
18474
+ },
18475
+ {
18476
+ "type": "undefined"
18477
+ }
18478
+ ],
18479
+ "optional": true,
18480
+ "required": false,
18481
+ "getter": false,
18482
+ "setter": false
18483
+ },
18484
+ {
18485
+ "name": "minMessage",
18486
+ "type": "string | undefined",
18487
+ "complexType": {
18488
+ "original": "string",
18489
+ "resolved": "string | undefined",
18490
+ "references": {}
18491
+ },
18492
+ "mutable": false,
18493
+ "attr": "min-message",
18494
+ "reflectToAttr": false,
18495
+ "docs": "The text to display as the error message when the minimum value (the `min` prop value) has not been met.",
18496
+ "docsTags": [],
18497
+ "default": "`Minimum value of ${this.min} not met`",
18498
+ "values": [
18499
+ {
18500
+ "type": "string"
18501
+ },
18502
+ {
18503
+ "type": "undefined"
18504
+ }
18505
+ ],
18506
+ "optional": true,
18507
+ "required": false,
18508
+ "getter": false,
18509
+ "setter": false
18510
+ },
18406
18511
  {
18407
18512
  "name": "name",
18408
18513
  "type": "string | undefined",
@@ -18813,7 +18918,7 @@
18813
18918
  "mutable": false,
18814
18919
  "attr": "validation-text",
18815
18920
  "reflectToAttr": false,
18816
- "docs": "The validation state - e.g. 'error' | 'warning' | 'success'.",
18921
+ "docs": "The text to display as the validation message.",
18817
18922
  "docsTags": [],
18818
18923
  "default": "\"\"",
18819
18924
  "values": [
@@ -19028,7 +19133,7 @@
19028
19133
  "filePath": "src/components/ic-theme/ic-theme.tsx",
19029
19134
  "encapsulation": "none",
19030
19135
  "tag": "ic-theme",
19031
- "readme": "# ic-theme\n\n\n",
19136
+ "readme": "# ic-theme\r\n\r\n\r\n\r",
19032
19137
  "docs": "",
19033
19138
  "docsTags": [],
19034
19139
  "usage": {},
@@ -19126,7 +19231,7 @@
19126
19231
  "filePath": "src/components/ic-toast/ic-toast.tsx",
19127
19232
  "encapsulation": "shadow",
19128
19233
  "tag": "ic-toast",
19129
- "readme": "# ic-toast\n\n\n",
19234
+ "readme": "# ic-toast\r\n\r\n\r\n\r",
19130
19235
  "docs": "",
19131
19236
  "docsTags": [
19132
19237
  {
@@ -19151,7 +19256,7 @@
19151
19256
  "mutable": true,
19152
19257
  "attr": "auto-dismiss-timeout",
19153
19258
  "reflectToAttr": false,
19154
- "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`)",
19259
+ "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`)",
19155
19260
  "docsTags": [],
19156
19261
  "default": "5000",
19157
19262
  "values": [
@@ -19444,7 +19549,7 @@
19444
19549
  "filePath": "src/components/ic-toast-region/ic-toast-region.tsx",
19445
19550
  "encapsulation": "none",
19446
19551
  "tag": "ic-toast-region",
19447
- "readme": "# ic-toast-region\n\n\n",
19552
+ "readme": "# ic-toast-region\r\n\r\n\r\n\r",
19448
19553
  "docs": "",
19449
19554
  "docsTags": [],
19450
19555
  "usage": {},
@@ -19500,7 +19605,7 @@
19500
19605
  "filePath": "src/components/ic-toggle-button/ic-toggle-button.tsx",
19501
19606
  "encapsulation": "shadow",
19502
19607
  "tag": "ic-toggle-button",
19503
- "readme": "# ic-toggle-button\n\n\n",
19608
+ "readme": "# ic-toggle-button\r\n\r\n\r\n\r",
19504
19609
  "docs": "",
19505
19610
  "docsTags": [
19506
19611
  {
@@ -19967,7 +20072,7 @@
19967
20072
  "filePath": "src/components/ic-toggle-button-group/ic-toggle-button-group.tsx",
19968
20073
  "encapsulation": "shadow",
19969
20074
  "tag": "ic-toggle-button-group",
19970
- "readme": "# ic-toggle-button-group\n\n\n",
20075
+ "readme": "# ic-toggle-button-group\r\n\r\n\r\n\r",
19971
20076
  "docs": "",
19972
20077
  "docsTags": [],
19973
20078
  "usage": {},
@@ -20413,7 +20518,7 @@
20413
20518
  "filePath": "src/components/ic-tooltip/ic-tooltip.tsx",
20414
20519
  "encapsulation": "shadow",
20415
20520
  "tag": "ic-tooltip",
20416
- "readme": "# ic-tooltip\n\n\n",
20521
+ "readme": "# ic-tooltip\r\n\r\n\r\n\r",
20417
20522
  "docs": "",
20418
20523
  "docsTags": [],
20419
20524
  "usage": {},
@@ -20765,7 +20870,7 @@
20765
20870
  "filePath": "src/components/ic-top-navigation/ic-top-navigation.tsx",
20766
20871
  "encapsulation": "shadow",
20767
20872
  "tag": "ic-top-navigation",
20768
- "readme": "# ic-top-navigation\n\n\n",
20873
+ "readme": "# ic-top-navigation\r\n\r\n\r\n\r",
20769
20874
  "docs": "",
20770
20875
  "docsTags": [
20771
20876
  {
@@ -21207,7 +21312,7 @@
21207
21312
  "filePath": "src/components/ic-typography/ic-typography.tsx",
21208
21313
  "encapsulation": "shadow",
21209
21314
  "tag": "ic-typography",
21210
- "readme": "# ic-typography\n\n\n",
21315
+ "readme": "# ic-typography\r\n\r\n\r\n\r",
21211
21316
  "docs": "",
21212
21317
  "docsTags": [],
21213
21318
  "usage": {},
@@ -21936,12 +22041,12 @@
21936
22041
  "path": "src/components/ic-menu-item/ic-menu-item.types.ts"
21937
22042
  },
21938
22043
  "src/components/ic-navigation-group/ic-navigation-group.types.ts::IcNavigationOpenEventDetail": {
21939
- "declaration": "export interface IcNavigationOpenEventDetail {\n source: HTMLElement;\n}",
22044
+ "declaration": "export interface IcNavigationOpenEventDetail {\r\n source: HTMLElement;\r\n}",
21940
22045
  "docstring": "",
21941
22046
  "path": "src/components/ic-navigation-group/ic-navigation-group.types.ts"
21942
22047
  },
21943
22048
  "src/components/ic-navigation-group/ic-navigation-group.types.ts::IcNavigationExpandEventDetail": {
21944
- "declaration": "export interface IcNavigationExpandEventDetail {\n expanded: boolean;\n}",
22049
+ "declaration": "export interface IcNavigationExpandEventDetail {\r\n expanded: boolean;\r\n}",
21945
22050
  "docstring": "",
21946
22051
  "path": "src/components/ic-navigation-group/ic-navigation-group.types.ts"
21947
22052
  },
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.14",
4
+ "version": "3.0.0-alpha.15",
5
5
  "description": "API documentation for @ukic 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": "e546aa169cbde94000232d3d27a474391e47b19f"
22
+ "gitHead": "0a55d7e265bdf3d5bbf46a26f34dbfb44e3d9670"
23
23
  }