@ukic/docs 2.13.3 → 2.14.1
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.
- package/docs.json +127 -68
- 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\
|
|
12
|
+
"readme": "# ic-accordion\n\n\n",
|
|
13
13
|
"docs": "",
|
|
14
14
|
"docsTags": [
|
|
15
15
|
{
|
|
@@ -201,7 +201,7 @@
|
|
|
201
201
|
"filePath": "src/components/ic-accordion-group/ic-accordion-group.tsx",
|
|
202
202
|
"encapsulation": "shadow",
|
|
203
203
|
"tag": "ic-accordion-group",
|
|
204
|
-
"readme": "# ic-accordion-title\
|
|
204
|
+
"readme": "# ic-accordion-title\n\n\n",
|
|
205
205
|
"docs": "",
|
|
206
206
|
"docsTags": [
|
|
207
207
|
{
|
|
@@ -440,7 +440,7 @@
|
|
|
440
440
|
"filePath": "src/components/ic-alert/ic-alert.tsx",
|
|
441
441
|
"encapsulation": "shadow",
|
|
442
442
|
"tag": "ic-alert",
|
|
443
|
-
"readme": "# ic-alert\
|
|
443
|
+
"readme": "# ic-alert\n\n\n",
|
|
444
444
|
"docs": "",
|
|
445
445
|
"docsTags": [
|
|
446
446
|
{
|
|
@@ -556,7 +556,7 @@
|
|
|
556
556
|
"mutable": false,
|
|
557
557
|
"attr": "show-default-icon",
|
|
558
558
|
"reflectToAttr": false,
|
|
559
|
-
"docs": "If `true`, the default icon for the neutral variant will
|
|
559
|
+
"docs": "If `true`, the default icon for the neutral variant will appear on the left of the alert.",
|
|
560
560
|
"docsTags": [],
|
|
561
561
|
"default": "true",
|
|
562
562
|
"values": [
|
|
@@ -726,7 +726,7 @@
|
|
|
726
726
|
"filePath": "src/components/ic-back-to-top/ic-back-to-top.tsx",
|
|
727
727
|
"encapsulation": "shadow",
|
|
728
728
|
"tag": "ic-back-to-top",
|
|
729
|
-
"readme": "# ic-back-to-top\
|
|
729
|
+
"readme": "# ic-back-to-top\n\n\n",
|
|
730
730
|
"docs": "",
|
|
731
731
|
"docsTags": [],
|
|
732
732
|
"usage": {},
|
|
@@ -817,7 +817,7 @@
|
|
|
817
817
|
"filePath": "src/components/ic-badge/ic-badge.tsx",
|
|
818
818
|
"encapsulation": "shadow",
|
|
819
819
|
"tag": "ic-badge",
|
|
820
|
-
"readme": "# ic-badge\
|
|
820
|
+
"readme": "# ic-badge\n\n\n",
|
|
821
821
|
"docs": "",
|
|
822
822
|
"docsTags": [
|
|
823
823
|
{
|
|
@@ -1193,7 +1193,7 @@
|
|
|
1193
1193
|
"filePath": "src/components/ic-breadcrumb/ic-breadcrumb.tsx",
|
|
1194
1194
|
"encapsulation": "shadow",
|
|
1195
1195
|
"tag": "ic-breadcrumb",
|
|
1196
|
-
"readme": "# ic-breadcrumb\
|
|
1196
|
+
"readme": "# ic-breadcrumb\n\n\n",
|
|
1197
1197
|
"docs": "",
|
|
1198
1198
|
"docsTags": [
|
|
1199
1199
|
{
|
|
@@ -1321,7 +1321,7 @@
|
|
|
1321
1321
|
"filePath": "src/components/ic-breadcrumb-group/ic-breadcrumb-group.tsx",
|
|
1322
1322
|
"encapsulation": "shadow",
|
|
1323
1323
|
"tag": "ic-breadcrumb-group",
|
|
1324
|
-
"readme": "# ic-breadcrumb-group\
|
|
1324
|
+
"readme": "# ic-breadcrumb-group\n\n\n",
|
|
1325
1325
|
"docs": "",
|
|
1326
1326
|
"docsTags": [],
|
|
1327
1327
|
"usage": {},
|
|
@@ -1431,7 +1431,7 @@
|
|
|
1431
1431
|
"filePath": "src/components/ic-button/ic-button.tsx",
|
|
1432
1432
|
"encapsulation": "shadow",
|
|
1433
1433
|
"tag": "ic-button",
|
|
1434
|
-
"readme": "# ic-button\
|
|
1434
|
+
"readme": "# ic-button\n",
|
|
1435
1435
|
"docs": "",
|
|
1436
1436
|
"docsTags": [
|
|
1437
1437
|
{
|
|
@@ -2443,7 +2443,7 @@
|
|
|
2443
2443
|
"filePath": "src/components/ic-card/ic-card.tsx",
|
|
2444
2444
|
"encapsulation": "shadow",
|
|
2445
2445
|
"tag": "ic-card",
|
|
2446
|
-
"readme": "# ic-card\
|
|
2446
|
+
"readme": "# ic-card\n\n\n",
|
|
2447
2447
|
"docs": "",
|
|
2448
2448
|
"docsTags": [
|
|
2449
2449
|
{
|
|
@@ -2894,7 +2894,7 @@
|
|
|
2894
2894
|
"filePath": "src/components/ic-checkbox/ic-checkbox.tsx",
|
|
2895
2895
|
"encapsulation": "shadow",
|
|
2896
2896
|
"tag": "ic-checkbox",
|
|
2897
|
-
"readme": "# ic-checkbox\
|
|
2897
|
+
"readme": "# ic-checkbox\n\n\n",
|
|
2898
2898
|
"docs": "",
|
|
2899
2899
|
"docsTags": [
|
|
2900
2900
|
{
|
|
@@ -2948,7 +2948,7 @@
|
|
|
2948
2948
|
"mutable": true,
|
|
2949
2949
|
"attr": "checked",
|
|
2950
2950
|
"reflectToAttr": true,
|
|
2951
|
-
"docs": "If `true`, the checkbox will be set to the checked state.",
|
|
2951
|
+
"docs": "If `true`, the checkbox will be set to the checked state. This is only the initial state and will be updated to unchecked if the checkbox is clicked.",
|
|
2952
2952
|
"docsTags": [],
|
|
2953
2953
|
"default": "false",
|
|
2954
2954
|
"values": [
|
|
@@ -3431,7 +3431,7 @@
|
|
|
3431
3431
|
"filePath": "src/components/ic-checkbox-group/ic-checkbox-group.tsx",
|
|
3432
3432
|
"encapsulation": "shadow",
|
|
3433
3433
|
"tag": "ic-checkbox-group",
|
|
3434
|
-
"readme": "# ic-checkbox-group\
|
|
3434
|
+
"readme": "# ic-checkbox-group\n\n\n",
|
|
3435
3435
|
"docs": "",
|
|
3436
3436
|
"docsTags": [],
|
|
3437
3437
|
"usage": {},
|
|
@@ -3754,7 +3754,7 @@
|
|
|
3754
3754
|
"filePath": "src/components/ic-chip/ic-chip.tsx",
|
|
3755
3755
|
"encapsulation": "shadow",
|
|
3756
3756
|
"tag": "ic-chip",
|
|
3757
|
-
"readme": "# ic-chip\
|
|
3757
|
+
"readme": "# ic-chip\n\n\n",
|
|
3758
3758
|
"docs": "",
|
|
3759
3759
|
"docsTags": [
|
|
3760
3760
|
{
|
|
@@ -4096,7 +4096,7 @@
|
|
|
4096
4096
|
"filePath": "src/components/ic-classification-banner/ic-classification-banner.tsx",
|
|
4097
4097
|
"encapsulation": "shadow",
|
|
4098
4098
|
"tag": "ic-classification-banner",
|
|
4099
|
-
"readme": "# ic-classification-banner\
|
|
4099
|
+
"readme": "# ic-classification-banner\n\n\n",
|
|
4100
4100
|
"docs": "",
|
|
4101
4101
|
"docsTags": [],
|
|
4102
4102
|
"usage": {},
|
|
@@ -4261,7 +4261,7 @@
|
|
|
4261
4261
|
"filePath": "src/components/ic-data-entity/ic-data-entity.tsx",
|
|
4262
4262
|
"encapsulation": "shadow",
|
|
4263
4263
|
"tag": "ic-data-entity",
|
|
4264
|
-
"readme": "# ic-data-entity\
|
|
4264
|
+
"readme": "# ic-data-entity\n\n\n",
|
|
4265
4265
|
"docs": "",
|
|
4266
4266
|
"docsTags": [
|
|
4267
4267
|
{
|
|
@@ -4379,7 +4379,7 @@
|
|
|
4379
4379
|
"filePath": "src/components/ic-data-row/ic-data-row.tsx",
|
|
4380
4380
|
"encapsulation": "shadow",
|
|
4381
4381
|
"tag": "ic-data-row",
|
|
4382
|
-
"readme": "# ic-data-row\
|
|
4382
|
+
"readme": "# ic-data-row\n\n\n",
|
|
4383
4383
|
"docs": "",
|
|
4384
4384
|
"docsTags": [
|
|
4385
4385
|
{
|
|
@@ -4534,7 +4534,7 @@
|
|
|
4534
4534
|
"filePath": "src/components/ic-dialog/ic-dialog.tsx",
|
|
4535
4535
|
"encapsulation": "shadow",
|
|
4536
4536
|
"tag": "ic-dialog",
|
|
4537
|
-
"readme": "# ic-dialog\
|
|
4537
|
+
"readme": "# ic-dialog\n\n\n",
|
|
4538
4538
|
"docs": "",
|
|
4539
4539
|
"docsTags": [
|
|
4540
4540
|
{
|
|
@@ -5156,7 +5156,7 @@
|
|
|
5156
5156
|
"filePath": "src/components/ic-divider/ic-divider.tsx",
|
|
5157
5157
|
"encapsulation": "scoped",
|
|
5158
5158
|
"tag": "ic-divider",
|
|
5159
|
-
"readme": "# ic-divider\
|
|
5159
|
+
"readme": "# ic-divider\n\n\n",
|
|
5160
5160
|
"docs": "",
|
|
5161
5161
|
"docsTags": [],
|
|
5162
5162
|
"usage": {},
|
|
@@ -5188,7 +5188,7 @@
|
|
|
5188
5188
|
"filePath": "src/components/ic-empty-state/ic-empty-state.tsx",
|
|
5189
5189
|
"encapsulation": "shadow",
|
|
5190
5190
|
"tag": "ic-empty-state",
|
|
5191
|
-
"readme": "# ic-empty-state\
|
|
5191
|
+
"readme": "# ic-empty-state\n\n\n",
|
|
5192
5192
|
"docs": "",
|
|
5193
5193
|
"docsTags": [
|
|
5194
5194
|
{
|
|
@@ -5414,7 +5414,7 @@
|
|
|
5414
5414
|
"filePath": "src/components/ic-footer/ic-footer.tsx",
|
|
5415
5415
|
"encapsulation": "shadow",
|
|
5416
5416
|
"tag": "ic-footer",
|
|
5417
|
-
"readme": "# ic-footer\
|
|
5417
|
+
"readme": "# ic-footer\n\n\n",
|
|
5418
5418
|
"docs": "",
|
|
5419
5419
|
"docsTags": [
|
|
5420
5420
|
{
|
|
@@ -5651,7 +5651,7 @@
|
|
|
5651
5651
|
"filePath": "src/components/ic-footer-link/ic-footer-link.tsx",
|
|
5652
5652
|
"encapsulation": "shadow",
|
|
5653
5653
|
"tag": "ic-footer-link",
|
|
5654
|
-
"readme": "# ic-footer-link\
|
|
5654
|
+
"readme": "# ic-footer-link\n\n\n",
|
|
5655
5655
|
"docs": "",
|
|
5656
5656
|
"docsTags": [],
|
|
5657
5657
|
"usage": {},
|
|
@@ -5852,7 +5852,7 @@
|
|
|
5852
5852
|
"filePath": "src/components/ic-footer-link-group/ic-footer-link-group.tsx",
|
|
5853
5853
|
"encapsulation": "shadow",
|
|
5854
5854
|
"tag": "ic-footer-link-group",
|
|
5855
|
-
"readme": "# ic-footer-link-group\
|
|
5855
|
+
"readme": "# ic-footer-link-group\n\n\n",
|
|
5856
5856
|
"docs": "",
|
|
5857
5857
|
"docsTags": [],
|
|
5858
5858
|
"usage": {},
|
|
@@ -5914,7 +5914,7 @@
|
|
|
5914
5914
|
"filePath": "src/components/ic-hero/ic-hero.tsx",
|
|
5915
5915
|
"encapsulation": "shadow",
|
|
5916
5916
|
"tag": "ic-hero",
|
|
5917
|
-
"readme": "# ic-hero\
|
|
5917
|
+
"readme": "# ic-hero\n\n\n",
|
|
5918
5918
|
"docs": "",
|
|
5919
5919
|
"docsTags": [
|
|
5920
5920
|
{
|
|
@@ -6247,7 +6247,7 @@
|
|
|
6247
6247
|
"filePath": "src/components/ic-horizontal-scroll/ic-horizontal-scroll.tsx",
|
|
6248
6248
|
"encapsulation": "shadow",
|
|
6249
6249
|
"tag": "ic-horizontal-scroll",
|
|
6250
|
-
"readme": "# ic-horizontal-scroll\
|
|
6250
|
+
"readme": "# ic-horizontal-scroll\n\n\n",
|
|
6251
6251
|
"docs": "",
|
|
6252
6252
|
"docsTags": [],
|
|
6253
6253
|
"usage": {},
|
|
@@ -6333,7 +6333,7 @@
|
|
|
6333
6333
|
"filePath": "src/components/ic-input-component-container/ic-input-component-container.tsx",
|
|
6334
6334
|
"encapsulation": "none",
|
|
6335
6335
|
"tag": "ic-input-component-container",
|
|
6336
|
-
"readme": "# ic-input-container\
|
|
6336
|
+
"readme": "# ic-input-container\n\n\n",
|
|
6337
6337
|
"docs": "",
|
|
6338
6338
|
"docsTags": [
|
|
6339
6339
|
{
|
|
@@ -6649,7 +6649,7 @@
|
|
|
6649
6649
|
"filePath": "src/components/ic-input-container/ic-input-container.tsx",
|
|
6650
6650
|
"encapsulation": "none",
|
|
6651
6651
|
"tag": "ic-input-container",
|
|
6652
|
-
"readme": "# ic-input-container\
|
|
6652
|
+
"readme": "# ic-input-container\n\n\n",
|
|
6653
6653
|
"docs": "",
|
|
6654
6654
|
"docsTags": [],
|
|
6655
6655
|
"usage": {},
|
|
@@ -6723,7 +6723,7 @@
|
|
|
6723
6723
|
"filePath": "src/components/ic-input-label/ic-input-label.tsx",
|
|
6724
6724
|
"encapsulation": "none",
|
|
6725
6725
|
"tag": "ic-input-label",
|
|
6726
|
-
"readme": "# ic-input-label\
|
|
6726
|
+
"readme": "# ic-input-label\n\n\n",
|
|
6727
6727
|
"docs": "",
|
|
6728
6728
|
"docsTags": [],
|
|
6729
6729
|
"usage": {},
|
|
@@ -6870,6 +6870,28 @@
|
|
|
6870
6870
|
"optional": false,
|
|
6871
6871
|
"required": false
|
|
6872
6872
|
},
|
|
6873
|
+
{
|
|
6874
|
+
"name": "hideLabel",
|
|
6875
|
+
"type": "boolean",
|
|
6876
|
+
"complexType": {
|
|
6877
|
+
"original": "boolean",
|
|
6878
|
+
"resolved": "boolean",
|
|
6879
|
+
"references": {}
|
|
6880
|
+
},
|
|
6881
|
+
"mutable": false,
|
|
6882
|
+
"attr": "hide-label",
|
|
6883
|
+
"reflectToAttr": false,
|
|
6884
|
+
"docs": "The label will be visually hidden.",
|
|
6885
|
+
"docsTags": [],
|
|
6886
|
+
"default": "false",
|
|
6887
|
+
"values": [
|
|
6888
|
+
{
|
|
6889
|
+
"type": "boolean"
|
|
6890
|
+
}
|
|
6891
|
+
],
|
|
6892
|
+
"optional": false,
|
|
6893
|
+
"required": false
|
|
6894
|
+
},
|
|
6873
6895
|
{
|
|
6874
6896
|
"name": "label",
|
|
6875
6897
|
"type": "string",
|
|
@@ -6977,7 +6999,7 @@
|
|
|
6977
6999
|
"filePath": "src/components/ic-input-validation/ic-input-validation.tsx",
|
|
6978
7000
|
"encapsulation": "none",
|
|
6979
7001
|
"tag": "ic-input-validation",
|
|
6980
|
-
"readme": "# ic-input-validation\
|
|
7002
|
+
"readme": "# ic-input-validation\n\n\n",
|
|
6981
7003
|
"docs": "",
|
|
6982
7004
|
"docsTags": [
|
|
6983
7005
|
{
|
|
@@ -7167,7 +7189,7 @@
|
|
|
7167
7189
|
"filePath": "src/components/ic-link/ic-link.tsx",
|
|
7168
7190
|
"encapsulation": "shadow",
|
|
7169
7191
|
"tag": "ic-link",
|
|
7170
|
-
"readme": "# ic-link\
|
|
7192
|
+
"readme": "# ic-link\n\n\n",
|
|
7171
7193
|
"docs": "",
|
|
7172
7194
|
"docsTags": [
|
|
7173
7195
|
{
|
|
@@ -7465,7 +7487,7 @@
|
|
|
7465
7487
|
"filePath": "src/components/ic-loading-indicator/ic-loading-indicator.tsx",
|
|
7466
7488
|
"encapsulation": "shadow",
|
|
7467
7489
|
"tag": "ic-loading-indicator",
|
|
7468
|
-
"readme": "# ic-loading\
|
|
7490
|
+
"readme": "# ic-loading\n\n\n",
|
|
7469
7491
|
"docs": "",
|
|
7470
7492
|
"docsTags": [],
|
|
7471
7493
|
"usage": {},
|
|
@@ -7778,7 +7800,7 @@
|
|
|
7778
7800
|
"filePath": "src/components/ic-menu/ic-menu.tsx",
|
|
7779
7801
|
"encapsulation": "scoped",
|
|
7780
7802
|
"tag": "ic-menu",
|
|
7781
|
-
"readme": "# ic-menu\
|
|
7803
|
+
"readme": "# ic-menu\n\n\n",
|
|
7782
7804
|
"docs": "",
|
|
7783
7805
|
"docsTags": [],
|
|
7784
7806
|
"usage": {},
|
|
@@ -8234,7 +8256,7 @@
|
|
|
8234
8256
|
"filePath": "src/components/ic-menu-group/ic-menu-group.tsx",
|
|
8235
8257
|
"encapsulation": "shadow",
|
|
8236
8258
|
"tag": "ic-menu-group",
|
|
8237
|
-
"readme": "# ic-menu-group\
|
|
8259
|
+
"readme": "# ic-menu-group\n\n\n",
|
|
8238
8260
|
"docs": "",
|
|
8239
8261
|
"docsTags": [],
|
|
8240
8262
|
"usage": {},
|
|
@@ -8281,7 +8303,7 @@
|
|
|
8281
8303
|
"filePath": "src/components/ic-menu-item/ic-menu-item.tsx",
|
|
8282
8304
|
"encapsulation": "shadow",
|
|
8283
8305
|
"tag": "ic-menu-item",
|
|
8284
|
-
"readme": "# ic-menu-item\
|
|
8306
|
+
"readme": "# ic-menu-item\n\n\n",
|
|
8285
8307
|
"docs": "",
|
|
8286
8308
|
"docsTags": [
|
|
8287
8309
|
{
|
|
@@ -8539,6 +8561,28 @@
|
|
|
8539
8561
|
"optional": true,
|
|
8540
8562
|
"required": false
|
|
8541
8563
|
},
|
|
8564
|
+
{
|
|
8565
|
+
"name": "toggleChecked",
|
|
8566
|
+
"type": "boolean",
|
|
8567
|
+
"complexType": {
|
|
8568
|
+
"original": "boolean",
|
|
8569
|
+
"resolved": "boolean",
|
|
8570
|
+
"references": {}
|
|
8571
|
+
},
|
|
8572
|
+
"mutable": true,
|
|
8573
|
+
"attr": "toggle-checked",
|
|
8574
|
+
"reflectToAttr": true,
|
|
8575
|
+
"docs": "If `true`, the menu item will be in a checked state. This is only applicable when variant is set to `toggle`.",
|
|
8576
|
+
"docsTags": [],
|
|
8577
|
+
"default": "false",
|
|
8578
|
+
"values": [
|
|
8579
|
+
{
|
|
8580
|
+
"type": "boolean"
|
|
8581
|
+
}
|
|
8582
|
+
],
|
|
8583
|
+
"optional": false,
|
|
8584
|
+
"required": false
|
|
8585
|
+
},
|
|
8542
8586
|
{
|
|
8543
8587
|
"name": "variant",
|
|
8544
8588
|
"type": "\"default\" | \"destructive\" | \"toggle\"",
|
|
@@ -8578,7 +8622,22 @@
|
|
|
8578
8622
|
}
|
|
8579
8623
|
],
|
|
8580
8624
|
"methods": [],
|
|
8581
|
-
"events": [
|
|
8625
|
+
"events": [
|
|
8626
|
+
{
|
|
8627
|
+
"event": "icToggleChecked",
|
|
8628
|
+
"detail": "{ checked: boolean; }",
|
|
8629
|
+
"bubbles": true,
|
|
8630
|
+
"complexType": {
|
|
8631
|
+
"original": "{\n checked: boolean;\n }",
|
|
8632
|
+
"resolved": "{ checked: boolean; }",
|
|
8633
|
+
"references": {}
|
|
8634
|
+
},
|
|
8635
|
+
"cancelable": true,
|
|
8636
|
+
"composed": true,
|
|
8637
|
+
"docs": "Emitted when the user clicks a menu item that is set to the toggle variant.",
|
|
8638
|
+
"docsTags": []
|
|
8639
|
+
}
|
|
8640
|
+
],
|
|
8582
8641
|
"listeners": [
|
|
8583
8642
|
{
|
|
8584
8643
|
"event": "click",
|
|
@@ -8625,7 +8684,7 @@
|
|
|
8625
8684
|
"filePath": "src/components/ic-navigation-button/ic-navigation-button.tsx",
|
|
8626
8685
|
"encapsulation": "shadow",
|
|
8627
8686
|
"tag": "ic-navigation-button",
|
|
8628
|
-
"readme": "# ic-navigation-button\
|
|
8687
|
+
"readme": "# ic-navigation-button\n\n\n",
|
|
8629
8688
|
"docs": "",
|
|
8630
8689
|
"docsTags": [
|
|
8631
8690
|
{
|
|
@@ -8909,7 +8968,7 @@
|
|
|
8909
8968
|
"filePath": "src/components/ic-navigation-group/ic-navigation-group.tsx",
|
|
8910
8969
|
"encapsulation": "shadow",
|
|
8911
8970
|
"tag": "ic-navigation-group",
|
|
8912
|
-
"readme": "# ic-navigation-group\
|
|
8971
|
+
"readme": "# ic-navigation-group\n\n\n",
|
|
8913
8972
|
"docs": "",
|
|
8914
8973
|
"docsTags": [],
|
|
8915
8974
|
"usage": {},
|
|
@@ -9024,7 +9083,7 @@
|
|
|
9024
9083
|
"filePath": "src/components/ic-navigation-item/ic-navigation-item.tsx",
|
|
9025
9084
|
"encapsulation": "shadow",
|
|
9026
9085
|
"tag": "ic-navigation-item",
|
|
9027
|
-
"readme": "# ic-navigation-item\
|
|
9086
|
+
"readme": "# ic-navigation-item\n\n\n",
|
|
9028
9087
|
"docs": "",
|
|
9029
9088
|
"docsTags": [
|
|
9030
9089
|
{
|
|
@@ -9329,7 +9388,7 @@
|
|
|
9329
9388
|
"filePath": "src/components/ic-navigation-menu/ic-navigation-menu.tsx",
|
|
9330
9389
|
"encapsulation": "shadow",
|
|
9331
9390
|
"tag": "ic-navigation-menu",
|
|
9332
|
-
"readme": "# ic-navigation-menu\
|
|
9391
|
+
"readme": "# ic-navigation-menu\n\n\n",
|
|
9333
9392
|
"docs": "",
|
|
9334
9393
|
"docsTags": [
|
|
9335
9394
|
{
|
|
@@ -9452,7 +9511,7 @@
|
|
|
9452
9511
|
"filePath": "src/components/ic-page-header/ic-page-header.tsx",
|
|
9453
9512
|
"encapsulation": "shadow",
|
|
9454
9513
|
"tag": "ic-page-header",
|
|
9455
|
-
"readme": "# ic-page-header\
|
|
9514
|
+
"readme": "# ic-page-header\n\n\n",
|
|
9456
9515
|
"docs": "",
|
|
9457
9516
|
"docsTags": [
|
|
9458
9517
|
{
|
|
@@ -9795,7 +9854,7 @@
|
|
|
9795
9854
|
"filePath": "src/components/ic-pagination/ic-pagination.tsx",
|
|
9796
9855
|
"encapsulation": "shadow",
|
|
9797
9856
|
"tag": "ic-pagination",
|
|
9798
|
-
"readme": "# ic-pagination\
|
|
9857
|
+
"readme": "# ic-pagination\n\n\n",
|
|
9799
9858
|
"docs": "",
|
|
9800
9859
|
"docsTags": [],
|
|
9801
9860
|
"usage": {},
|
|
@@ -10170,7 +10229,7 @@
|
|
|
10170
10229
|
"filePath": "src/components/ic-pagination-item/ic-pagination-item.tsx",
|
|
10171
10230
|
"encapsulation": "shadow",
|
|
10172
10231
|
"tag": "ic-pagination-item",
|
|
10173
|
-
"readme": "# ic-pagination-item\
|
|
10232
|
+
"readme": "# ic-pagination-item\n\n\n",
|
|
10174
10233
|
"docs": "",
|
|
10175
10234
|
"docsTags": [],
|
|
10176
10235
|
"usage": {},
|
|
@@ -10361,7 +10420,7 @@
|
|
|
10361
10420
|
"filePath": "src/components/ic-popover-menu/ic-popover-menu.tsx",
|
|
10362
10421
|
"encapsulation": "shadow",
|
|
10363
10422
|
"tag": "ic-popover-menu",
|
|
10364
|
-
"readme": "# ic-popover-menu\
|
|
10423
|
+
"readme": "# ic-popover-menu\n\nThis is a wrapper component to be placed around one or more ic-menu-item components.\n",
|
|
10365
10424
|
"docs": "This is a wrapper component to be placed around one or more ic-menu-item components.",
|
|
10366
10425
|
"docsTags": [],
|
|
10367
10426
|
"usage": {},
|
|
@@ -10520,7 +10579,7 @@
|
|
|
10520
10579
|
"filePath": "src/components/ic-radio-group/ic-radio-group.tsx",
|
|
10521
10580
|
"encapsulation": "shadow",
|
|
10522
10581
|
"tag": "ic-radio-group",
|
|
10523
|
-
"readme": "# ic-radio-group\
|
|
10582
|
+
"readme": "# ic-radio-group\n\n\n",
|
|
10524
10583
|
"docs": "",
|
|
10525
10584
|
"docsTags": [],
|
|
10526
10585
|
"usage": {},
|
|
@@ -10871,7 +10930,7 @@
|
|
|
10871
10930
|
"filePath": "src/components/ic-radio-option/ic-radio-option.tsx",
|
|
10872
10931
|
"encapsulation": "shadow",
|
|
10873
10932
|
"tag": "ic-radio-option",
|
|
10874
|
-
"readme": "# ic-radio-option\
|
|
10933
|
+
"readme": "# ic-radio-option\n\n\n",
|
|
10875
10934
|
"docs": "",
|
|
10876
10935
|
"docsTags": [
|
|
10877
10936
|
{
|
|
@@ -11306,7 +11365,7 @@
|
|
|
11306
11365
|
"filePath": "src/components/ic-search-bar/ic-search-bar.tsx",
|
|
11307
11366
|
"encapsulation": "shadow",
|
|
11308
11367
|
"tag": "ic-search-bar",
|
|
11309
|
-
"readme": "# ic-search-bar\
|
|
11368
|
+
"readme": "# ic-search-bar\n\n\n",
|
|
11310
11369
|
"docs": "",
|
|
11311
11370
|
"docsTags": [],
|
|
11312
11371
|
"usage": {},
|
|
@@ -12568,7 +12627,7 @@
|
|
|
12568
12627
|
"filePath": "src/components/ic-section-container/ic-section-container.tsx",
|
|
12569
12628
|
"encapsulation": "shadow",
|
|
12570
12629
|
"tag": "ic-section-container",
|
|
12571
|
-
"readme": "# ic-section-container\
|
|
12630
|
+
"readme": "# ic-section-container\n\n\n",
|
|
12572
12631
|
"docs": "",
|
|
12573
12632
|
"docsTags": [],
|
|
12574
12633
|
"usage": {},
|
|
@@ -12669,7 +12728,7 @@
|
|
|
12669
12728
|
"filePath": "src/components/ic-select/ic-select.tsx",
|
|
12670
12729
|
"encapsulation": "shadow",
|
|
12671
12730
|
"tag": "ic-select",
|
|
12672
|
-
"readme": "# ic-select\
|
|
12731
|
+
"readme": "# ic-select\n\n\n",
|
|
12673
12732
|
"docs": "",
|
|
12674
12733
|
"docsTags": [
|
|
12675
12734
|
{
|
|
@@ -13745,7 +13804,7 @@
|
|
|
13745
13804
|
"filePath": "src/components/ic-side-navigation/ic-side-navigation.tsx",
|
|
13746
13805
|
"encapsulation": "shadow",
|
|
13747
13806
|
"tag": "ic-side-navigation",
|
|
13748
|
-
"readme": "# ic-side-navigation\
|
|
13807
|
+
"readme": "# ic-side-navigation\n\n\n",
|
|
13749
13808
|
"docs": "",
|
|
13750
13809
|
"docsTags": [
|
|
13751
13810
|
{
|
|
@@ -14070,8 +14129,8 @@
|
|
|
14070
14129
|
"filePath": "src/components/ic-skeleton/ic-skeleton.tsx",
|
|
14071
14130
|
"encapsulation": "shadow",
|
|
14072
14131
|
"tag": "ic-skeleton",
|
|
14073
|
-
"readme": "# ic-skeleton\
|
|
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\
|
|
14132
|
+
"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",
|
|
14133
|
+
"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.",
|
|
14075
14134
|
"docsTags": [],
|
|
14076
14135
|
"usage": {},
|
|
14077
14136
|
"props": [
|
|
@@ -14182,7 +14241,7 @@
|
|
|
14182
14241
|
"filePath": "src/components/ic-status-tag/ic-status-tag.tsx",
|
|
14183
14242
|
"encapsulation": "shadow",
|
|
14184
14243
|
"tag": "ic-status-tag",
|
|
14185
|
-
"readme": "# ic-status-tag\
|
|
14244
|
+
"readme": "# ic-status-tag\n\n\n",
|
|
14186
14245
|
"docs": "",
|
|
14187
14246
|
"docsTags": [],
|
|
14188
14247
|
"usage": {},
|
|
@@ -14428,7 +14487,7 @@
|
|
|
14428
14487
|
"filePath": "src/components/ic-step/ic-step.tsx",
|
|
14429
14488
|
"encapsulation": "shadow",
|
|
14430
14489
|
"tag": "ic-step",
|
|
14431
|
-
"readme": "# ic-step\
|
|
14490
|
+
"readme": "# ic-step\n\n\n",
|
|
14432
14491
|
"docs": "",
|
|
14433
14492
|
"docsTags": [],
|
|
14434
14493
|
"usage": {},
|
|
@@ -14574,7 +14633,7 @@
|
|
|
14574
14633
|
"filePath": "src/components/ic-stepper/ic-stepper.tsx",
|
|
14575
14634
|
"encapsulation": "shadow",
|
|
14576
14635
|
"tag": "ic-stepper",
|
|
14577
|
-
"readme": "# ic-stepper\
|
|
14636
|
+
"readme": "# ic-stepper\n\nThis is a wrapper component to be placed around one or more ic-step components\n",
|
|
14578
14637
|
"docs": "This is a wrapper component to be placed around one or more ic-step components",
|
|
14579
14638
|
"docsTags": [],
|
|
14580
14639
|
"usage": {},
|
|
@@ -14731,7 +14790,7 @@
|
|
|
14731
14790
|
"filePath": "src/components/ic-switch/ic-switch.tsx",
|
|
14732
14791
|
"encapsulation": "shadow",
|
|
14733
14792
|
"tag": "ic-switch",
|
|
14734
|
-
"readme": "# ic-switch\
|
|
14793
|
+
"readme": "# ic-switch\n\n\n",
|
|
14735
14794
|
"docs": "",
|
|
14736
14795
|
"docsTags": [
|
|
14737
14796
|
{
|
|
@@ -15080,7 +15139,7 @@
|
|
|
15080
15139
|
"filePath": "src/components/ic-tab/ic-tab.tsx",
|
|
15081
15140
|
"encapsulation": "shadow",
|
|
15082
15141
|
"tag": "ic-tab",
|
|
15083
|
-
"readme": "# ic-tab\
|
|
15142
|
+
"readme": "# ic-tab\n\n\n",
|
|
15084
15143
|
"docs": "",
|
|
15085
15144
|
"docsTags": [
|
|
15086
15145
|
{
|
|
@@ -15169,7 +15228,7 @@
|
|
|
15169
15228
|
"filePath": "src/components/ic-tab-context/ic-tab-context.tsx",
|
|
15170
15229
|
"encapsulation": "none",
|
|
15171
15230
|
"tag": "ic-tab-context",
|
|
15172
|
-
"readme": "# ic-tab-context\
|
|
15231
|
+
"readme": "# ic-tab-context\n\n\n",
|
|
15173
15232
|
"docs": "",
|
|
15174
15233
|
"docsTags": [],
|
|
15175
15234
|
"usage": {},
|
|
@@ -15366,7 +15425,7 @@
|
|
|
15366
15425
|
"filePath": "src/components/ic-tab-group/ic-tab-group.tsx",
|
|
15367
15426
|
"encapsulation": "shadow",
|
|
15368
15427
|
"tag": "ic-tab-group",
|
|
15369
|
-
"readme": "# ic-tab-group\
|
|
15428
|
+
"readme": "# ic-tab-group\n\n\n",
|
|
15370
15429
|
"docs": "",
|
|
15371
15430
|
"docsTags": [],
|
|
15372
15431
|
"usage": {},
|
|
@@ -15476,7 +15535,7 @@
|
|
|
15476
15535
|
"filePath": "src/components/ic-tab-panel/ic-tab-panel.tsx",
|
|
15477
15536
|
"encapsulation": "shadow",
|
|
15478
15537
|
"tag": "ic-tab-panel",
|
|
15479
|
-
"readme": "# ic-tab-panel\
|
|
15538
|
+
"readme": "# ic-tab-panel\n\n\n",
|
|
15480
15539
|
"docs": "",
|
|
15481
15540
|
"docsTags": [],
|
|
15482
15541
|
"usage": {},
|
|
@@ -15524,7 +15583,7 @@
|
|
|
15524
15583
|
"filePath": "src/components/ic-text-field/ic-text-field.tsx",
|
|
15525
15584
|
"encapsulation": "shadow",
|
|
15526
15585
|
"tag": "ic-text-field",
|
|
15527
|
-
"readme": "# ic-textfield\
|
|
15586
|
+
"readme": "# ic-textfield\n\n\n",
|
|
15528
15587
|
"docs": "",
|
|
15529
15588
|
"docsTags": [
|
|
15530
15589
|
{
|
|
@@ -16754,7 +16813,7 @@
|
|
|
16754
16813
|
"filePath": "src/components/ic-theme/ic-theme.tsx",
|
|
16755
16814
|
"encapsulation": "shadow",
|
|
16756
16815
|
"tag": "ic-theme",
|
|
16757
|
-
"readme": "# ic-theme\
|
|
16816
|
+
"readme": "# ic-theme\n\n\n",
|
|
16758
16817
|
"docs": "",
|
|
16759
16818
|
"docsTags": [],
|
|
16760
16819
|
"usage": {},
|
|
@@ -16808,7 +16867,7 @@
|
|
|
16808
16867
|
"filePath": "src/components/ic-toast/ic-toast.tsx",
|
|
16809
16868
|
"encapsulation": "shadow",
|
|
16810
16869
|
"tag": "ic-toast",
|
|
16811
|
-
"readme": "# ic-toast\
|
|
16870
|
+
"readme": "# ic-toast\n\n\n",
|
|
16812
16871
|
"docs": "",
|
|
16813
16872
|
"docsTags": [
|
|
16814
16873
|
{
|
|
@@ -17093,7 +17152,7 @@
|
|
|
17093
17152
|
"filePath": "src/components/ic-toast-region/ic-toast-region.tsx",
|
|
17094
17153
|
"encapsulation": "none",
|
|
17095
17154
|
"tag": "ic-toast-region",
|
|
17096
|
-
"readme": "# ic-toast-region\
|
|
17155
|
+
"readme": "# ic-toast-region\n\n\n",
|
|
17097
17156
|
"docs": "",
|
|
17098
17157
|
"docsTags": [],
|
|
17099
17158
|
"usage": {},
|
|
@@ -17193,7 +17252,7 @@
|
|
|
17193
17252
|
"filePath": "src/components/ic-toggle-button/ic-toggle-button.tsx",
|
|
17194
17253
|
"encapsulation": "shadow",
|
|
17195
17254
|
"tag": "ic-toggle-button",
|
|
17196
|
-
"readme": "# ic-toggle-button\
|
|
17255
|
+
"readme": "# ic-toggle-button\n\n\n",
|
|
17197
17256
|
"docs": "",
|
|
17198
17257
|
"docsTags": [
|
|
17199
17258
|
{
|
|
@@ -17529,7 +17588,7 @@
|
|
|
17529
17588
|
"filePath": "src/components/ic-toggle-button-group/ic-toggle-button-group.tsx",
|
|
17530
17589
|
"encapsulation": "shadow",
|
|
17531
17590
|
"tag": "ic-toggle-button-group",
|
|
17532
|
-
"readme": "# ic-toggle-button-group\
|
|
17591
|
+
"readme": "# ic-toggle-button-group\n\n\n",
|
|
17533
17592
|
"docs": "",
|
|
17534
17593
|
"docsTags": [],
|
|
17535
17594
|
"usage": {},
|
|
@@ -17861,7 +17920,7 @@
|
|
|
17861
17920
|
"filePath": "src/components/ic-tooltip/ic-tooltip.tsx",
|
|
17862
17921
|
"encapsulation": "shadow",
|
|
17863
17922
|
"tag": "ic-tooltip",
|
|
17864
|
-
"readme": "# ic-tooltip\
|
|
17923
|
+
"readme": "# ic-tooltip\n\n\n",
|
|
17865
17924
|
"docs": "",
|
|
17866
17925
|
"docsTags": [],
|
|
17867
17926
|
"usage": {},
|
|
@@ -18126,7 +18185,7 @@
|
|
|
18126
18185
|
"filePath": "src/components/ic-top-navigation/ic-top-navigation.tsx",
|
|
18127
18186
|
"encapsulation": "shadow",
|
|
18128
18187
|
"tag": "ic-top-navigation",
|
|
18129
|
-
"readme": "# ic-top-navigation\
|
|
18188
|
+
"readme": "# ic-top-navigation\n\n\n",
|
|
18130
18189
|
"docs": "",
|
|
18131
18190
|
"docsTags": [
|
|
18132
18191
|
{
|
|
@@ -18485,7 +18544,7 @@
|
|
|
18485
18544
|
"filePath": "src/components/ic-typography/ic-typography.tsx",
|
|
18486
18545
|
"encapsulation": "shadow",
|
|
18487
18546
|
"tag": "ic-typography",
|
|
18488
|
-
"readme": "# ic-typography\
|
|
18547
|
+
"readme": "# ic-typography\n\n\n",
|
|
18489
18548
|
"docs": "",
|
|
18490
18549
|
"docsTags": [],
|
|
18491
18550
|
"usage": {},
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"author": "mi6",
|
|
3
3
|
"name": "@ukic/docs",
|
|
4
|
-
"version": "2.
|
|
4
|
+
"version": "2.14.1",
|
|
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": "
|
|
21
|
+
"gitHead": "8f1cf8223eb9c9d871cca4af42fc7c39db4f1b6a"
|
|
22
22
|
}
|