@ukic/docs 2.13.1 → 2.13.3

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 +118 -67
  2. package/package.json +2 -2
package/docs.json CHANGED
@@ -1,5 +1,4 @@
1
1
  {
2
- "timestamp": "2024-08-29T10:35:38",
3
2
  "compiler": {
4
3
  "name": "@stencil/core",
5
4
  "version": "4.10.0",
@@ -10,7 +9,7 @@
10
9
  "filePath": "src/components/ic-accordion/ic-accordion.tsx",
11
10
  "encapsulation": "shadow",
12
11
  "tag": "ic-accordion",
13
- "readme": "# ic-accordion\n\n\n",
12
+ "readme": "# ic-accordion\r\n\r\n\r\n\r",
14
13
  "docs": "",
15
14
  "docsTags": [
16
15
  {
@@ -202,7 +201,7 @@
202
201
  "filePath": "src/components/ic-accordion-group/ic-accordion-group.tsx",
203
202
  "encapsulation": "shadow",
204
203
  "tag": "ic-accordion-group",
205
- "readme": "# ic-accordion-title\n\n\n",
204
+ "readme": "# ic-accordion-title\r\n\r\n\r\n\r",
206
205
  "docs": "",
207
206
  "docsTags": [
208
207
  {
@@ -441,7 +440,7 @@
441
440
  "filePath": "src/components/ic-alert/ic-alert.tsx",
442
441
  "encapsulation": "shadow",
443
442
  "tag": "ic-alert",
444
- "readme": "# ic-alert\n\n\n",
443
+ "readme": "# ic-alert\r\n\r\n\r\n\r",
445
444
  "docs": "",
446
445
  "docsTags": [
447
446
  {
@@ -451,6 +450,10 @@
451
450
  {
452
451
  "name": "slot",
453
452
  "text": "action - Content is placed to the right of the message."
453
+ },
454
+ {
455
+ "name": "slot",
456
+ "text": "neutral-icon - A custom neutral icon is placed to the left of the title. This will override the default icon if used."
454
457
  }
455
458
  ],
456
459
  "usage": {},
@@ -542,6 +545,28 @@
542
545
  "optional": true,
543
546
  "required": false
544
547
  },
548
+ {
549
+ "name": "showDefaultIcon",
550
+ "type": "boolean",
551
+ "complexType": {
552
+ "original": "boolean",
553
+ "resolved": "boolean",
554
+ "references": {}
555
+ },
556
+ "mutable": false,
557
+ "attr": "show-default-icon",
558
+ "reflectToAttr": false,
559
+ "docs": "If `true`, the default icon for the neutral variant will be appear on the left of the alert.",
560
+ "docsTags": [],
561
+ "default": "true",
562
+ "values": [
563
+ {
564
+ "type": "boolean"
565
+ }
566
+ ],
567
+ "optional": false,
568
+ "required": false
569
+ },
545
570
  {
546
571
  "name": "titleAbove",
547
572
  "type": "boolean",
@@ -663,6 +688,10 @@
663
688
  {
664
689
  "name": "message",
665
690
  "docs": "Content is placed to the right of the title."
691
+ },
692
+ {
693
+ "name": "neutral-icon",
694
+ "docs": "A custom neutral icon is placed to the left of the title. This will override the default icon if used."
666
695
  }
667
696
  ],
668
697
  "parts": [],
@@ -697,7 +726,7 @@
697
726
  "filePath": "src/components/ic-back-to-top/ic-back-to-top.tsx",
698
727
  "encapsulation": "shadow",
699
728
  "tag": "ic-back-to-top",
700
- "readme": "# ic-back-to-top\n\n\n",
729
+ "readme": "# ic-back-to-top\r\n\r\n\r\n\r",
701
730
  "docs": "",
702
731
  "docsTags": [],
703
732
  "usage": {},
@@ -788,7 +817,7 @@
788
817
  "filePath": "src/components/ic-badge/ic-badge.tsx",
789
818
  "encapsulation": "shadow",
790
819
  "tag": "ic-badge",
791
- "readme": "# ic-badge\n\n\n",
820
+ "readme": "# ic-badge\r\n\r\n\r\n\r",
792
821
  "docs": "",
793
822
  "docsTags": [
794
823
  {
@@ -1164,7 +1193,7 @@
1164
1193
  "filePath": "src/components/ic-breadcrumb/ic-breadcrumb.tsx",
1165
1194
  "encapsulation": "shadow",
1166
1195
  "tag": "ic-breadcrumb",
1167
- "readme": "# ic-breadcrumb\n\n\n",
1196
+ "readme": "# ic-breadcrumb\r\n\r\n\r\n\r",
1168
1197
  "docs": "",
1169
1198
  "docsTags": [
1170
1199
  {
@@ -1292,7 +1321,7 @@
1292
1321
  "filePath": "src/components/ic-breadcrumb-group/ic-breadcrumb-group.tsx",
1293
1322
  "encapsulation": "shadow",
1294
1323
  "tag": "ic-breadcrumb-group",
1295
- "readme": "# ic-breadcrumb-group\n\n\n",
1324
+ "readme": "# ic-breadcrumb-group\r\n\r\n\r\n\r",
1296
1325
  "docs": "",
1297
1326
  "docsTags": [],
1298
1327
  "usage": {},
@@ -1402,7 +1431,7 @@
1402
1431
  "filePath": "src/components/ic-button/ic-button.tsx",
1403
1432
  "encapsulation": "shadow",
1404
1433
  "tag": "ic-button",
1405
- "readme": "# ic-button\n",
1434
+ "readme": "# ic-button\r\n\r",
1406
1435
  "docs": "",
1407
1436
  "docsTags": [
1408
1437
  {
@@ -2414,7 +2443,7 @@
2414
2443
  "filePath": "src/components/ic-card/ic-card.tsx",
2415
2444
  "encapsulation": "shadow",
2416
2445
  "tag": "ic-card",
2417
- "readme": "# ic-card\n\n\n",
2446
+ "readme": "# ic-card\r\n\r\n\r\n\r",
2418
2447
  "docs": "",
2419
2448
  "docsTags": [
2420
2449
  {
@@ -2865,7 +2894,7 @@
2865
2894
  "filePath": "src/components/ic-checkbox/ic-checkbox.tsx",
2866
2895
  "encapsulation": "shadow",
2867
2896
  "tag": "ic-checkbox",
2868
- "readme": "# ic-checkbox\n\n\n",
2897
+ "readme": "# ic-checkbox\r\n\r\n\r\n\r",
2869
2898
  "docs": "",
2870
2899
  "docsTags": [
2871
2900
  {
@@ -3402,7 +3431,7 @@
3402
3431
  "filePath": "src/components/ic-checkbox-group/ic-checkbox-group.tsx",
3403
3432
  "encapsulation": "shadow",
3404
3433
  "tag": "ic-checkbox-group",
3405
- "readme": "# ic-checkbox-group\n\n\n",
3434
+ "readme": "# ic-checkbox-group\r\n\r\n\r\n\r",
3406
3435
  "docs": "",
3407
3436
  "docsTags": [],
3408
3437
  "usage": {},
@@ -3725,7 +3754,7 @@
3725
3754
  "filePath": "src/components/ic-chip/ic-chip.tsx",
3726
3755
  "encapsulation": "shadow",
3727
3756
  "tag": "ic-chip",
3728
- "readme": "# ic-chip\n\n\n",
3757
+ "readme": "# ic-chip\r\n\r\n\r\n\r",
3729
3758
  "docs": "",
3730
3759
  "docsTags": [
3731
3760
  {
@@ -4067,7 +4096,7 @@
4067
4096
  "filePath": "src/components/ic-classification-banner/ic-classification-banner.tsx",
4068
4097
  "encapsulation": "shadow",
4069
4098
  "tag": "ic-classification-banner",
4070
- "readme": "# ic-classification-banner\n\n\n",
4099
+ "readme": "# ic-classification-banner\r\n\r\n\r\n\r",
4071
4100
  "docs": "",
4072
4101
  "docsTags": [],
4073
4102
  "usage": {},
@@ -4232,7 +4261,7 @@
4232
4261
  "filePath": "src/components/ic-data-entity/ic-data-entity.tsx",
4233
4262
  "encapsulation": "shadow",
4234
4263
  "tag": "ic-data-entity",
4235
- "readme": "# ic-data-entity\n\n\n",
4264
+ "readme": "# ic-data-entity\r\n\r\n\r\n\r",
4236
4265
  "docs": "",
4237
4266
  "docsTags": [
4238
4267
  {
@@ -4350,7 +4379,7 @@
4350
4379
  "filePath": "src/components/ic-data-row/ic-data-row.tsx",
4351
4380
  "encapsulation": "shadow",
4352
4381
  "tag": "ic-data-row",
4353
- "readme": "# ic-data-row\n\n\n",
4382
+ "readme": "# ic-data-row\r\n\r\n\r\n\r",
4354
4383
  "docs": "",
4355
4384
  "docsTags": [
4356
4385
  {
@@ -4505,7 +4534,7 @@
4505
4534
  "filePath": "src/components/ic-dialog/ic-dialog.tsx",
4506
4535
  "encapsulation": "shadow",
4507
4536
  "tag": "ic-dialog",
4508
- "readme": "# ic-dialog\n\n\n",
4537
+ "readme": "# ic-dialog\r\n\r\n\r\n\r",
4509
4538
  "docs": "",
4510
4539
  "docsTags": [
4511
4540
  {
@@ -4635,7 +4664,7 @@
4635
4664
  "mutable": false,
4636
4665
  "attr": "close-on-backdrop-click",
4637
4666
  "reflectToAttr": false,
4638
- "docs": "If set to `true`, the dialog will not close when the backdrop is clicked.",
4667
+ "docs": "If set to `false`, the dialog will not close when the backdrop is clicked.",
4639
4668
  "docsTags": [],
4640
4669
  "default": "true",
4641
4670
  "values": [
@@ -5127,7 +5156,7 @@
5127
5156
  "filePath": "src/components/ic-divider/ic-divider.tsx",
5128
5157
  "encapsulation": "scoped",
5129
5158
  "tag": "ic-divider",
5130
- "readme": "# ic-divider\n\n\n",
5159
+ "readme": "# ic-divider\r\n\r\n\r\n\r",
5131
5160
  "docs": "",
5132
5161
  "docsTags": [],
5133
5162
  "usage": {},
@@ -5159,7 +5188,7 @@
5159
5188
  "filePath": "src/components/ic-empty-state/ic-empty-state.tsx",
5160
5189
  "encapsulation": "shadow",
5161
5190
  "tag": "ic-empty-state",
5162
- "readme": "# ic-empty-state\n\n\n",
5191
+ "readme": "# ic-empty-state\r\n\r\n\r\n\r",
5163
5192
  "docs": "",
5164
5193
  "docsTags": [
5165
5194
  {
@@ -5385,7 +5414,7 @@
5385
5414
  "filePath": "src/components/ic-footer/ic-footer.tsx",
5386
5415
  "encapsulation": "shadow",
5387
5416
  "tag": "ic-footer",
5388
- "readme": "# ic-footer\n\n\n",
5417
+ "readme": "# ic-footer\r\n\r\n\r\n\r",
5389
5418
  "docs": "",
5390
5419
  "docsTags": [
5391
5420
  {
@@ -5622,7 +5651,7 @@
5622
5651
  "filePath": "src/components/ic-footer-link/ic-footer-link.tsx",
5623
5652
  "encapsulation": "shadow",
5624
5653
  "tag": "ic-footer-link",
5625
- "readme": "# ic-footer-link\n\n\n",
5654
+ "readme": "# ic-footer-link\r\n\r\n\r\n\r",
5626
5655
  "docs": "",
5627
5656
  "docsTags": [],
5628
5657
  "usage": {},
@@ -5823,7 +5852,7 @@
5823
5852
  "filePath": "src/components/ic-footer-link-group/ic-footer-link-group.tsx",
5824
5853
  "encapsulation": "shadow",
5825
5854
  "tag": "ic-footer-link-group",
5826
- "readme": "# ic-footer-link-group\n\n\n",
5855
+ "readme": "# ic-footer-link-group\r\n\r\n\r\n\r",
5827
5856
  "docs": "",
5828
5857
  "docsTags": [],
5829
5858
  "usage": {},
@@ -5885,7 +5914,7 @@
5885
5914
  "filePath": "src/components/ic-hero/ic-hero.tsx",
5886
5915
  "encapsulation": "shadow",
5887
5916
  "tag": "ic-hero",
5888
- "readme": "# ic-hero\n\n\n",
5917
+ "readme": "# ic-hero\r\n\r\n\r\n\r",
5889
5918
  "docs": "",
5890
5919
  "docsTags": [
5891
5920
  {
@@ -6218,7 +6247,7 @@
6218
6247
  "filePath": "src/components/ic-horizontal-scroll/ic-horizontal-scroll.tsx",
6219
6248
  "encapsulation": "shadow",
6220
6249
  "tag": "ic-horizontal-scroll",
6221
- "readme": "# ic-horizontal-scroll\n\n\n",
6250
+ "readme": "# ic-horizontal-scroll\r\n\r\n\r\n\r",
6222
6251
  "docs": "",
6223
6252
  "docsTags": [],
6224
6253
  "usage": {},
@@ -6304,7 +6333,7 @@
6304
6333
  "filePath": "src/components/ic-input-component-container/ic-input-component-container.tsx",
6305
6334
  "encapsulation": "none",
6306
6335
  "tag": "ic-input-component-container",
6307
- "readme": "# ic-input-container\n\n\n",
6336
+ "readme": "# ic-input-container\r\n\r\n\r\n\r",
6308
6337
  "docs": "",
6309
6338
  "docsTags": [
6310
6339
  {
@@ -6620,7 +6649,7 @@
6620
6649
  "filePath": "src/components/ic-input-container/ic-input-container.tsx",
6621
6650
  "encapsulation": "none",
6622
6651
  "tag": "ic-input-container",
6623
- "readme": "# ic-input-container\n\n\n",
6652
+ "readme": "# ic-input-container\r\n\r\n\r\n\r",
6624
6653
  "docs": "",
6625
6654
  "docsTags": [],
6626
6655
  "usage": {},
@@ -6694,7 +6723,7 @@
6694
6723
  "filePath": "src/components/ic-input-label/ic-input-label.tsx",
6695
6724
  "encapsulation": "none",
6696
6725
  "tag": "ic-input-label",
6697
- "readme": "# ic-input-label\n\n\n",
6726
+ "readme": "# ic-input-label\r\n\r\n\r\n\r",
6698
6727
  "docs": "",
6699
6728
  "docsTags": [],
6700
6729
  "usage": {},
@@ -6948,7 +6977,7 @@
6948
6977
  "filePath": "src/components/ic-input-validation/ic-input-validation.tsx",
6949
6978
  "encapsulation": "none",
6950
6979
  "tag": "ic-input-validation",
6951
- "readme": "# ic-input-validation\n\n\n",
6980
+ "readme": "# ic-input-validation\r\n\r\n\r\n\r",
6952
6981
  "docs": "",
6953
6982
  "docsTags": [
6954
6983
  {
@@ -7138,7 +7167,7 @@
7138
7167
  "filePath": "src/components/ic-link/ic-link.tsx",
7139
7168
  "encapsulation": "shadow",
7140
7169
  "tag": "ic-link",
7141
- "readme": "# ic-link\n\n\n",
7170
+ "readme": "# ic-link\r\n\r\n\r\n\r",
7142
7171
  "docs": "",
7143
7172
  "docsTags": [
7144
7173
  {
@@ -7436,7 +7465,7 @@
7436
7465
  "filePath": "src/components/ic-loading-indicator/ic-loading-indicator.tsx",
7437
7466
  "encapsulation": "shadow",
7438
7467
  "tag": "ic-loading-indicator",
7439
- "readme": "# ic-loading\n\n\n",
7468
+ "readme": "# ic-loading\r\n\r\n\r\n\r",
7440
7469
  "docs": "",
7441
7470
  "docsTags": [],
7442
7471
  "usage": {},
@@ -7749,7 +7778,7 @@
7749
7778
  "filePath": "src/components/ic-menu/ic-menu.tsx",
7750
7779
  "encapsulation": "scoped",
7751
7780
  "tag": "ic-menu",
7752
- "readme": "# ic-menu\n\n\n",
7781
+ "readme": "# ic-menu\r\n\r\n\r\n\r",
7753
7782
  "docs": "",
7754
7783
  "docsTags": [],
7755
7784
  "usage": {},
@@ -8205,7 +8234,7 @@
8205
8234
  "filePath": "src/components/ic-menu-group/ic-menu-group.tsx",
8206
8235
  "encapsulation": "shadow",
8207
8236
  "tag": "ic-menu-group",
8208
- "readme": "# ic-menu-group\n\n\n",
8237
+ "readme": "# ic-menu-group\r\n\r\n\r\n\r",
8209
8238
  "docs": "",
8210
8239
  "docsTags": [],
8211
8240
  "usage": {},
@@ -8252,7 +8281,7 @@
8252
8281
  "filePath": "src/components/ic-menu-item/ic-menu-item.tsx",
8253
8282
  "encapsulation": "shadow",
8254
8283
  "tag": "ic-menu-item",
8255
- "readme": "# ic-menu-item\n\n\n",
8284
+ "readme": "# ic-menu-item\r\n\r\n\r\n\r",
8256
8285
  "docs": "",
8257
8286
  "docsTags": [
8258
8287
  {
@@ -8596,7 +8625,7 @@
8596
8625
  "filePath": "src/components/ic-navigation-button/ic-navigation-button.tsx",
8597
8626
  "encapsulation": "shadow",
8598
8627
  "tag": "ic-navigation-button",
8599
- "readme": "# ic-navigation-button\n\n\n",
8628
+ "readme": "# ic-navigation-button\r\n\r\n\r\n\r",
8600
8629
  "docs": "",
8601
8630
  "docsTags": [
8602
8631
  {
@@ -8880,7 +8909,7 @@
8880
8909
  "filePath": "src/components/ic-navigation-group/ic-navigation-group.tsx",
8881
8910
  "encapsulation": "shadow",
8882
8911
  "tag": "ic-navigation-group",
8883
- "readme": "# ic-navigation-group\n\n\n",
8912
+ "readme": "# ic-navigation-group\r\n\r\n\r\n\r",
8884
8913
  "docs": "",
8885
8914
  "docsTags": [],
8886
8915
  "usage": {},
@@ -8995,7 +9024,7 @@
8995
9024
  "filePath": "src/components/ic-navigation-item/ic-navigation-item.tsx",
8996
9025
  "encapsulation": "shadow",
8997
9026
  "tag": "ic-navigation-item",
8998
- "readme": "# ic-navigation-item\n\n\n",
9027
+ "readme": "# ic-navigation-item\r\n\r\n\r\n\r",
8999
9028
  "docs": "",
9000
9029
  "docsTags": [
9001
9030
  {
@@ -9300,7 +9329,7 @@
9300
9329
  "filePath": "src/components/ic-navigation-menu/ic-navigation-menu.tsx",
9301
9330
  "encapsulation": "shadow",
9302
9331
  "tag": "ic-navigation-menu",
9303
- "readme": "# ic-navigation-menu\n\n\n",
9332
+ "readme": "# ic-navigation-menu\r\n\r\n\r\n\r",
9304
9333
  "docs": "",
9305
9334
  "docsTags": [
9306
9335
  {
@@ -9423,7 +9452,7 @@
9423
9452
  "filePath": "src/components/ic-page-header/ic-page-header.tsx",
9424
9453
  "encapsulation": "shadow",
9425
9454
  "tag": "ic-page-header",
9426
- "readme": "# ic-page-header\n\n\n",
9455
+ "readme": "# ic-page-header\r\n\r\n\r\n\r",
9427
9456
  "docs": "",
9428
9457
  "docsTags": [
9429
9458
  {
@@ -9766,7 +9795,7 @@
9766
9795
  "filePath": "src/components/ic-pagination/ic-pagination.tsx",
9767
9796
  "encapsulation": "shadow",
9768
9797
  "tag": "ic-pagination",
9769
- "readme": "# ic-pagination\n\n\n",
9798
+ "readme": "# ic-pagination\r\n\r\n\r\n\r",
9770
9799
  "docs": "",
9771
9800
  "docsTags": [],
9772
9801
  "usage": {},
@@ -10141,7 +10170,7 @@
10141
10170
  "filePath": "src/components/ic-pagination-item/ic-pagination-item.tsx",
10142
10171
  "encapsulation": "shadow",
10143
10172
  "tag": "ic-pagination-item",
10144
- "readme": "# ic-pagination-item\n\n\n",
10173
+ "readme": "# ic-pagination-item\r\n\r\n\r\n\r",
10145
10174
  "docs": "",
10146
10175
  "docsTags": [],
10147
10176
  "usage": {},
@@ -10332,7 +10361,7 @@
10332
10361
  "filePath": "src/components/ic-popover-menu/ic-popover-menu.tsx",
10333
10362
  "encapsulation": "shadow",
10334
10363
  "tag": "ic-popover-menu",
10335
- "readme": "# ic-popover-menu\n\nThis is a wrapper component to be placed around one or more ic-menu-item components.\n",
10364
+ "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",
10336
10365
  "docs": "This is a wrapper component to be placed around one or more ic-menu-item components.",
10337
10366
  "docsTags": [],
10338
10367
  "usage": {},
@@ -10491,7 +10520,7 @@
10491
10520
  "filePath": "src/components/ic-radio-group/ic-radio-group.tsx",
10492
10521
  "encapsulation": "shadow",
10493
10522
  "tag": "ic-radio-group",
10494
- "readme": "# ic-radio-group\n\n\n",
10523
+ "readme": "# ic-radio-group\r\n\r\n\r\n\r",
10495
10524
  "docs": "",
10496
10525
  "docsTags": [],
10497
10526
  "usage": {},
@@ -10842,7 +10871,7 @@
10842
10871
  "filePath": "src/components/ic-radio-option/ic-radio-option.tsx",
10843
10872
  "encapsulation": "shadow",
10844
10873
  "tag": "ic-radio-option",
10845
- "readme": "# ic-radio-option\n\n\n",
10874
+ "readme": "# ic-radio-option\r\n\r\n\r\n\r",
10846
10875
  "docs": "",
10847
10876
  "docsTags": [
10848
10877
  {
@@ -11277,7 +11306,7 @@
11277
11306
  "filePath": "src/components/ic-search-bar/ic-search-bar.tsx",
11278
11307
  "encapsulation": "shadow",
11279
11308
  "tag": "ic-search-bar",
11280
- "readme": "# ic-search-bar\n\n\n",
11309
+ "readme": "# ic-search-bar\r\n\r\n\r\n\r",
11281
11310
  "docs": "",
11282
11311
  "docsTags": [],
11283
11312
  "usage": {},
@@ -12539,7 +12568,7 @@
12539
12568
  "filePath": "src/components/ic-section-container/ic-section-container.tsx",
12540
12569
  "encapsulation": "shadow",
12541
12570
  "tag": "ic-section-container",
12542
- "readme": "# ic-section-container\n\n\n",
12571
+ "readme": "# ic-section-container\r\n\r\n\r\n\r",
12543
12572
  "docs": "",
12544
12573
  "docsTags": [],
12545
12574
  "usage": {},
@@ -12640,7 +12669,7 @@
12640
12669
  "filePath": "src/components/ic-select/ic-select.tsx",
12641
12670
  "encapsulation": "shadow",
12642
12671
  "tag": "ic-select",
12643
- "readme": "# ic-select\n\n\n",
12672
+ "readme": "# ic-select\r\n\r\n\r\n\r",
12644
12673
  "docs": "",
12645
12674
  "docsTags": [
12646
12675
  {
@@ -13716,7 +13745,7 @@
13716
13745
  "filePath": "src/components/ic-side-navigation/ic-side-navigation.tsx",
13717
13746
  "encapsulation": "shadow",
13718
13747
  "tag": "ic-side-navigation",
13719
- "readme": "# ic-side-navigation\n\n\n",
13748
+ "readme": "# ic-side-navigation\r\n\r\n\r\n\r",
13720
13749
  "docs": "",
13721
13750
  "docsTags": [
13722
13751
  {
@@ -14041,8 +14070,8 @@
14041
14070
  "filePath": "src/components/ic-skeleton/ic-skeleton.tsx",
14042
14071
  "encapsulation": "shadow",
14043
14072
  "tag": "ic-skeleton",
14044
- "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",
14045
- "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.",
14073
+ "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",
14074
+ "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.",
14046
14075
  "docsTags": [],
14047
14076
  "usage": {},
14048
14077
  "props": [
@@ -14153,7 +14182,7 @@
14153
14182
  "filePath": "src/components/ic-status-tag/ic-status-tag.tsx",
14154
14183
  "encapsulation": "shadow",
14155
14184
  "tag": "ic-status-tag",
14156
- "readme": "# ic-status-tag\n\n\n",
14185
+ "readme": "# ic-status-tag\r\n\r\n\r\n\r",
14157
14186
  "docs": "",
14158
14187
  "docsTags": [],
14159
14188
  "usage": {},
@@ -14399,7 +14428,7 @@
14399
14428
  "filePath": "src/components/ic-step/ic-step.tsx",
14400
14429
  "encapsulation": "shadow",
14401
14430
  "tag": "ic-step",
14402
- "readme": "# ic-step\n\n\n",
14431
+ "readme": "# ic-step\r\n\r\n\r\n\r",
14403
14432
  "docs": "",
14404
14433
  "docsTags": [],
14405
14434
  "usage": {},
@@ -14545,7 +14574,7 @@
14545
14574
  "filePath": "src/components/ic-stepper/ic-stepper.tsx",
14546
14575
  "encapsulation": "shadow",
14547
14576
  "tag": "ic-stepper",
14548
- "readme": "# ic-stepper\n\nThis is a wrapper component to be placed around one or more ic-step components\n",
14577
+ "readme": "# ic-stepper\r\n\r\nThis is a wrapper component to be placed around one or more ic-step components\r\n\r",
14549
14578
  "docs": "This is a wrapper component to be placed around one or more ic-step components",
14550
14579
  "docsTags": [],
14551
14580
  "usage": {},
@@ -14702,7 +14731,7 @@
14702
14731
  "filePath": "src/components/ic-switch/ic-switch.tsx",
14703
14732
  "encapsulation": "shadow",
14704
14733
  "tag": "ic-switch",
14705
- "readme": "# ic-switch\n\n\n",
14734
+ "readme": "# ic-switch\r\n\r\n\r\n\r",
14706
14735
  "docs": "",
14707
14736
  "docsTags": [
14708
14737
  {
@@ -15051,7 +15080,7 @@
15051
15080
  "filePath": "src/components/ic-tab/ic-tab.tsx",
15052
15081
  "encapsulation": "shadow",
15053
15082
  "tag": "ic-tab",
15054
- "readme": "# ic-tab\n\n\n",
15083
+ "readme": "# ic-tab\r\n\r\n\r\n\r",
15055
15084
  "docs": "",
15056
15085
  "docsTags": [
15057
15086
  {
@@ -15140,7 +15169,7 @@
15140
15169
  "filePath": "src/components/ic-tab-context/ic-tab-context.tsx",
15141
15170
  "encapsulation": "none",
15142
15171
  "tag": "ic-tab-context",
15143
- "readme": "# ic-tab-context\n\n\n",
15172
+ "readme": "# ic-tab-context\r\n\r\n\r\n\r",
15144
15173
  "docs": "",
15145
15174
  "docsTags": [],
15146
15175
  "usage": {},
@@ -15337,7 +15366,7 @@
15337
15366
  "filePath": "src/components/ic-tab-group/ic-tab-group.tsx",
15338
15367
  "encapsulation": "shadow",
15339
15368
  "tag": "ic-tab-group",
15340
- "readme": "# ic-tab-group\n\n\n",
15369
+ "readme": "# ic-tab-group\r\n\r\n\r\n\r",
15341
15370
  "docs": "",
15342
15371
  "docsTags": [],
15343
15372
  "usage": {},
@@ -15447,7 +15476,7 @@
15447
15476
  "filePath": "src/components/ic-tab-panel/ic-tab-panel.tsx",
15448
15477
  "encapsulation": "shadow",
15449
15478
  "tag": "ic-tab-panel",
15450
- "readme": "# ic-tab-panel\n\n\n",
15479
+ "readme": "# ic-tab-panel\r\n\r\n\r\n\r",
15451
15480
  "docs": "",
15452
15481
  "docsTags": [],
15453
15482
  "usage": {},
@@ -15495,7 +15524,7 @@
15495
15524
  "filePath": "src/components/ic-text-field/ic-text-field.tsx",
15496
15525
  "encapsulation": "shadow",
15497
15526
  "tag": "ic-text-field",
15498
- "readme": "# ic-textfield\n\n\n",
15527
+ "readme": "# ic-textfield\r\n\r\n\r\n\r",
15499
15528
  "docs": "",
15500
15529
  "docsTags": [
15501
15530
  {
@@ -16102,6 +16131,28 @@
16102
16131
  "optional": false,
16103
16132
  "required": false
16104
16133
  },
16134
+ {
16135
+ "name": "maxLengthMessage",
16136
+ "type": "string",
16137
+ "complexType": {
16138
+ "original": "string",
16139
+ "resolved": "string",
16140
+ "references": {}
16141
+ },
16142
+ "mutable": false,
16143
+ "attr": "max-length-message",
16144
+ "reflectToAttr": false,
16145
+ "docs": "The text to display as the validation message when the maximum length is exceeded.",
16146
+ "docsTags": [],
16147
+ "default": "\"Maximum length exceeded\"",
16148
+ "values": [
16149
+ {
16150
+ "type": "string"
16151
+ }
16152
+ ],
16153
+ "optional": false,
16154
+ "required": false
16155
+ },
16105
16156
  {
16106
16157
  "name": "min",
16107
16158
  "type": "number | string",
@@ -16703,7 +16754,7 @@
16703
16754
  "filePath": "src/components/ic-theme/ic-theme.tsx",
16704
16755
  "encapsulation": "shadow",
16705
16756
  "tag": "ic-theme",
16706
- "readme": "# ic-theme\n\n\n",
16757
+ "readme": "# ic-theme\r\n\r\n\r\n\r",
16707
16758
  "docs": "",
16708
16759
  "docsTags": [],
16709
16760
  "usage": {},
@@ -16757,7 +16808,7 @@
16757
16808
  "filePath": "src/components/ic-toast/ic-toast.tsx",
16758
16809
  "encapsulation": "shadow",
16759
16810
  "tag": "ic-toast",
16760
- "readme": "# ic-toast\n\n\n",
16811
+ "readme": "# ic-toast\r\n\r\n\r\n\r",
16761
16812
  "docs": "",
16762
16813
  "docsTags": [
16763
16814
  {
@@ -17042,7 +17093,7 @@
17042
17093
  "filePath": "src/components/ic-toast-region/ic-toast-region.tsx",
17043
17094
  "encapsulation": "none",
17044
17095
  "tag": "ic-toast-region",
17045
- "readme": "# ic-toast-region\n\n\n",
17096
+ "readme": "# ic-toast-region\r\n\r\n\r\n\r",
17046
17097
  "docs": "",
17047
17098
  "docsTags": [],
17048
17099
  "usage": {},
@@ -17142,7 +17193,7 @@
17142
17193
  "filePath": "src/components/ic-toggle-button/ic-toggle-button.tsx",
17143
17194
  "encapsulation": "shadow",
17144
17195
  "tag": "ic-toggle-button",
17145
- "readme": "# ic-toggle-button\n\n\n",
17196
+ "readme": "# ic-toggle-button\r\n\r\n\r\n\r",
17146
17197
  "docs": "",
17147
17198
  "docsTags": [
17148
17199
  {
@@ -17478,7 +17529,7 @@
17478
17529
  "filePath": "src/components/ic-toggle-button-group/ic-toggle-button-group.tsx",
17479
17530
  "encapsulation": "shadow",
17480
17531
  "tag": "ic-toggle-button-group",
17481
- "readme": "# ic-toggle-button-group\n\n\n",
17532
+ "readme": "# ic-toggle-button-group\r\n\r\n\r\n\r",
17482
17533
  "docs": "",
17483
17534
  "docsTags": [],
17484
17535
  "usage": {},
@@ -17810,7 +17861,7 @@
17810
17861
  "filePath": "src/components/ic-tooltip/ic-tooltip.tsx",
17811
17862
  "encapsulation": "shadow",
17812
17863
  "tag": "ic-tooltip",
17813
- "readme": "# ic-tooltip\n\n\n",
17864
+ "readme": "# ic-tooltip\r\n\r\n\r\n\r",
17814
17865
  "docs": "",
17815
17866
  "docsTags": [],
17816
17867
  "usage": {},
@@ -18075,7 +18126,7 @@
18075
18126
  "filePath": "src/components/ic-top-navigation/ic-top-navigation.tsx",
18076
18127
  "encapsulation": "shadow",
18077
18128
  "tag": "ic-top-navigation",
18078
- "readme": "# ic-top-navigation\n\n\n",
18129
+ "readme": "# ic-top-navigation\r\n\r\n\r\n\r",
18079
18130
  "docs": "",
18080
18131
  "docsTags": [
18081
18132
  {
@@ -18434,7 +18485,7 @@
18434
18485
  "filePath": "src/components/ic-typography/ic-typography.tsx",
18435
18486
  "encapsulation": "shadow",
18436
18487
  "tag": "ic-typography",
18437
- "readme": "# ic-typography\n\n\n",
18488
+ "readme": "# ic-typography\r\n\r\n\r\n\r",
18438
18489
  "docs": "",
18439
18490
  "docsTags": [],
18440
18491
  "usage": {},
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "author": "mi6",
3
3
  "name": "@ukic/docs",
4
- "version": "2.13.1",
4
+ "version": "2.13.3",
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": "bb0e87b80748fefad6c6e21b193365731e43e53a"
21
+ "gitHead": "eac36044d122bbfe72142a35877135ebff6dce5e"
22
22
  }