@ukic/docs 2.1.0-beta.1 → 2.1.0-beta.2

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 +271 -280
  2. package/package.json +2 -2
package/docs.json CHANGED
@@ -1,5 +1,5 @@
1
1
  {
2
- "timestamp": "2022-12-22T16:13:17",
2
+ "timestamp": "2023-01-10T14:45:33",
3
3
  "compiler": {
4
4
  "name": "@stencil/core",
5
5
  "version": "2.20.0",
@@ -19,7 +19,7 @@
19
19
  },
20
20
  {
21
21
  "name": "slot",
22
- "text": "action - Content is placed to the left of the message."
22
+ "text": "action - Content is placed to the right of the message."
23
23
  }
24
24
  ],
25
25
  "usage": {},
@@ -30,7 +30,7 @@
30
30
  "mutable": false,
31
31
  "attr": "announced",
32
32
  "reflectToAttr": false,
33
- "docs": "Set whether the alert has the 'alert' aria role and will be announced to screen readers",
33
+ "docs": "If `true`, the alert will have the 'alert' ARIA role and will be announced to screen readers.",
34
34
  "docsTags": [],
35
35
  "default": "true",
36
36
  "values": [
@@ -47,7 +47,7 @@
47
47
  "mutable": false,
48
48
  "attr": "dismissible",
49
49
  "reflectToAttr": false,
50
- "docs": "Set whether the alert has a close icon at the end to dismiss it",
50
+ "docs": "If `true`, the alert will have a close icon at the end to dismiss it.",
51
51
  "docsTags": [],
52
52
  "default": "false",
53
53
  "values": [
@@ -64,7 +64,7 @@
64
64
  "mutable": false,
65
65
  "attr": "heading",
66
66
  "reflectToAttr": false,
67
- "docs": "Optional title to display at the start of the alert",
67
+ "docs": "The optional title to display at the start of the alert.",
68
68
  "docsTags": [],
69
69
  "default": "\"\"",
70
70
  "values": [
@@ -81,7 +81,7 @@
81
81
  "mutable": false,
82
82
  "attr": "message",
83
83
  "reflectToAttr": false,
84
- "docs": "Main body message of the alert",
84
+ "docs": "The main body message of the alert.",
85
85
  "docsTags": [],
86
86
  "values": [
87
87
  {
@@ -97,7 +97,7 @@
97
97
  "mutable": false,
98
98
  "attr": "title-above",
99
99
  "reflectToAttr": false,
100
- "docs": "Set whether the title and message appear inline or above and below",
100
+ "docs": "If `true`, the title and message will appear inline instead of above and below.",
101
101
  "docsTags": [],
102
102
  "default": "false",
103
103
  "values": [
@@ -114,7 +114,7 @@
114
114
  "mutable": false,
115
115
  "attr": "variant",
116
116
  "reflectToAttr": false,
117
- "docs": "Set which variant of the alert will be rendered",
117
+ "docs": "The variant of the alert which will be rendered.",
118
118
  "docsTags": [],
119
119
  "default": "\"neutral\"",
120
120
  "values": [
@@ -166,7 +166,7 @@
166
166
  "slots": [
167
167
  {
168
168
  "name": "action",
169
- "docs": "Content is placed to the left of the message."
169
+ "docs": "Content is placed to the right of the message."
170
170
  },
171
171
  {
172
172
  "name": "message",
@@ -253,7 +253,7 @@
253
253
  "mutable": false,
254
254
  "attr": "current",
255
255
  "reflectToAttr": false,
256
- "docs": "If true, aria-current will be set on the breadcrumb",
256
+ "docs": "If `true`, aria-current will be set on the breadcrumb.",
257
257
  "docsTags": [],
258
258
  "default": "false",
259
259
  "values": [
@@ -270,7 +270,7 @@
270
270
  "mutable": false,
271
271
  "attr": "href",
272
272
  "reflectToAttr": false,
273
- "docs": "Set breadcrumb location",
273
+ "docs": "The URL that the breadcrumb link points to.",
274
274
  "docsTags": [],
275
275
  "values": [
276
276
  {
@@ -286,7 +286,7 @@
286
286
  "mutable": false,
287
287
  "attr": "page-title",
288
288
  "reflectToAttr": false,
289
- "docs": "Set breadcrumb title",
289
+ "docs": "The title of the breadcrumb.",
290
290
  "docsTags": [],
291
291
  "values": [
292
292
  {
@@ -333,7 +333,7 @@
333
333
  "mutable": false,
334
334
  "attr": "back-breadcrumb-only",
335
335
  "reflectToAttr": false,
336
- "docs": "If true, display the parent page and back icon as breadcrumb",
336
+ "docs": "If `true`, display only a single breadcrumb for the parent page with a back icon.",
337
337
  "docsTags": [],
338
338
  "default": "false",
339
339
  "values": [
@@ -350,7 +350,7 @@
350
350
  "mutable": false,
351
351
  "attr": "collapsed",
352
352
  "reflectToAttr": false,
353
- "docs": "If true, all breadcrumbs between the first and last breadcrumb will be collapsed",
353
+ "docs": "If `true`, all breadcrumbs between the first and last breadcrumb will be collapsed.",
354
354
  "docsTags": [],
355
355
  "default": "false",
356
356
  "values": [
@@ -401,7 +401,7 @@
401
401
  "mutable": true,
402
402
  "attr": "appearance",
403
403
  "reflectToAttr": false,
404
- "docs": "Determines the whether the appearance of the button is dark, light, or the default.",
404
+ "docs": "The appearance of the button, e.g. dark, light, or the default.",
405
405
  "docsTags": [],
406
406
  "default": "\"default\"",
407
407
  "values": [
@@ -427,7 +427,7 @@
427
427
  "mutable": false,
428
428
  "attr": "disable-tooltip",
429
429
  "reflectToAttr": false,
430
- "docs": "Disable ic-tooltip which is shown for icon variant. Title or aria-label must be set if this prop is not applied.",
430
+ "docs": "If `true`, the ic-tooltip which is shown for icon variant will be disabled. Title or aria-label must be set if this prop is not applied.",
431
431
  "docsTags": [],
432
432
  "default": "false",
433
433
  "values": [
@@ -444,7 +444,7 @@
444
444
  "mutable": false,
445
445
  "attr": "disabled",
446
446
  "reflectToAttr": false,
447
- "docs": "Determines whether the button should be in disabled state.",
447
+ "docs": "If `true`, the button will be in disabled state.",
448
448
  "docsTags": [],
449
449
  "default": "false",
450
450
  "values": [
@@ -461,7 +461,7 @@
461
461
  "mutable": false,
462
462
  "attr": "download",
463
463
  "reflectToAttr": false,
464
- "docs": "Prompts the user to save the linked URL instead of navigating to it.",
464
+ "docs": "If `true`, the user can save the linked URL instead of navigating to it.",
465
465
  "docsTags": [],
466
466
  "default": "false",
467
467
  "values": [
@@ -481,7 +481,7 @@
481
481
  "mutable": false,
482
482
  "attr": "full-width",
483
483
  "reflectToAttr": false,
484
- "docs": "Fill the width of the container if true.",
484
+ "docs": "If `true`, the button will fill the width of the container.",
485
485
  "docsTags": [],
486
486
  "default": "false",
487
487
  "values": [
@@ -514,7 +514,7 @@
514
514
  "mutable": false,
515
515
  "attr": "hreflang",
516
516
  "reflectToAttr": false,
517
- "docs": "Hints at the human language of the linked URL.",
517
+ "docs": "The human language of the linked URL.",
518
518
  "docsTags": [],
519
519
  "values": [
520
520
  {
@@ -530,7 +530,7 @@
530
530
  "mutable": false,
531
531
  "attr": "loading",
532
532
  "reflectToAttr": false,
533
- "docs": "Determines whether the button should be in loading state.",
533
+ "docs": "If `true`, the button will be in loading state.",
534
534
  "docsTags": [],
535
535
  "default": "false",
536
536
  "values": [
@@ -637,7 +637,7 @@
637
637
  "mutable": false,
638
638
  "attr": "target",
639
639
  "reflectToAttr": false,
640
- "docs": "Where to display the linked URL, as the name for a browsing context (a tab, window, or iframe).",
640
+ "docs": "The place to display the linked URL, as the name for a browsing context (a tab, window, or iframe).",
641
641
  "docsTags": [],
642
642
  "values": [
643
643
  {
@@ -709,7 +709,7 @@
709
709
  "mutable": false,
710
710
  "attr": "variant",
711
711
  "reflectToAttr": false,
712
- "docs": "The button variant to be displayed.",
712
+ "docs": "The variant of the button to be displayed.",
713
713
  "docsTags": [],
714
714
  "default": "\"primary\"",
715
715
  "values": [
@@ -867,7 +867,7 @@
867
867
  "mutable": true,
868
868
  "attr": "clickable",
869
869
  "reflectToAttr": false,
870
- "docs": "Set the variant to static or clickable",
870
+ "docs": "If `true`, the card will be a clickable variant, instead of static.",
871
871
  "docsTags": [],
872
872
  "default": "false",
873
873
  "values": [
@@ -884,7 +884,7 @@
884
884
  "mutable": false,
885
885
  "attr": "disabled",
886
886
  "reflectToAttr": false,
887
- "docs": "Whether the card is disabled if it is clickable",
887
+ "docs": "If `true`, the card will be disabled if it is clickable.",
888
888
  "docsTags": [],
889
889
  "default": "false",
890
890
  "values": [
@@ -901,7 +901,7 @@
901
901
  "mutable": false,
902
902
  "attr": "full-width",
903
903
  "reflectToAttr": false,
904
- "docs": "If true then fill width of container",
904
+ "docs": "If `true`, the card will fill the width of the container.",
905
905
  "docsTags": [],
906
906
  "default": "false",
907
907
  "values": [
@@ -918,7 +918,7 @@
918
918
  "mutable": false,
919
919
  "attr": "heading",
920
920
  "reflectToAttr": false,
921
- "docs": "Title for the card",
921
+ "docs": "The title for the card.",
922
922
  "docsTags": [],
923
923
  "values": [
924
924
  {
@@ -934,7 +934,7 @@
934
934
  "mutable": false,
935
935
  "attr": "href",
936
936
  "reflectToAttr": false,
937
- "docs": "URL for clickable cards",
937
+ "docs": "The URL that the clickable card link points to.",
938
938
  "docsTags": [],
939
939
  "values": [
940
940
  {
@@ -950,7 +950,7 @@
950
950
  "mutable": false,
951
951
  "attr": "hreflang",
952
952
  "reflectToAttr": false,
953
- "docs": "Human readable explanation of the URL",
953
+ "docs": "The human language of the linked URL.",
954
954
  "docsTags": [],
955
955
  "default": "\"\"",
956
956
  "values": [
@@ -967,7 +967,7 @@
967
967
  "mutable": false,
968
968
  "attr": "message",
969
969
  "reflectToAttr": false,
970
- "docs": "Main body message of the card",
970
+ "docs": "The main body message of the card.",
971
971
  "docsTags": [],
972
972
  "default": "\"\"",
973
973
  "values": [
@@ -1048,7 +1048,7 @@
1048
1048
  "mutable": false,
1049
1049
  "attr": "target",
1050
1050
  "reflectToAttr": false,
1051
- "docs": "Where to display the linked URL, as the name for a browsing context (a tab, window, or iframe).",
1051
+ "docs": "The place to display the linked URL, as the name for a browsing context (a tab, window, or iframe).",
1052
1052
  "docsTags": [],
1053
1053
  "values": [
1054
1054
  {
@@ -1115,7 +1115,7 @@
1115
1115
  "mutable": false,
1116
1116
  "attr": "additional-field-display",
1117
1117
  "reflectToAttr": true,
1118
- "docs": "Set which style of additionalField will be displayed if used",
1118
+ "docs": "The style of additionalField that will be displayed if used.",
1119
1119
  "docsTags": [],
1120
1120
  "default": "\"static\"",
1121
1121
  "values": [
@@ -1137,7 +1137,7 @@
1137
1137
  "mutable": true,
1138
1138
  "attr": "checked",
1139
1139
  "reflectToAttr": true,
1140
- "docs": "Set the checkbox to the checked state",
1140
+ "docs": "If `true`, the checkbox will be set to the checked state.",
1141
1141
  "docsTags": [],
1142
1142
  "default": "false",
1143
1143
  "values": [
@@ -1154,7 +1154,7 @@
1154
1154
  "mutable": false,
1155
1155
  "attr": "disabled",
1156
1156
  "reflectToAttr": false,
1157
- "docs": "Set the checkbox to the disabled state",
1157
+ "docs": "If `true`, the checkbox will be set to the disabled state.",
1158
1158
  "docsTags": [],
1159
1159
  "default": "false",
1160
1160
  "values": [
@@ -1171,7 +1171,7 @@
1171
1171
  "mutable": false,
1172
1172
  "attr": "dynamic-text",
1173
1173
  "reflectToAttr": false,
1174
- "docs": "Provide a text prop for the dynamic text",
1174
+ "docs": "The text to be displayed when dynamic.",
1175
1175
  "docsTags": [],
1176
1176
  "default": "\"This selection requires additional answers\"",
1177
1177
  "values": [
@@ -1188,7 +1188,7 @@
1188
1188
  "mutable": false,
1189
1189
  "attr": "group-label",
1190
1190
  "reflectToAttr": false,
1191
- "docs": "Provide a group label for the input",
1191
+ "docs": "The group label for the checkbox.",
1192
1192
  "docsTags": [],
1193
1193
  "values": [
1194
1194
  {
@@ -1204,7 +1204,7 @@
1204
1204
  "mutable": false,
1205
1205
  "attr": "indeterminate",
1206
1206
  "reflectToAttr": false,
1207
- "docs": "Display the indeterminate state when checked",
1207
+ "docs": "If `true`, the indeterminate state will be displayed when checked.",
1208
1208
  "docsTags": [],
1209
1209
  "default": "false",
1210
1210
  "values": [
@@ -1221,7 +1221,7 @@
1221
1221
  "mutable": false,
1222
1222
  "attr": "label",
1223
1223
  "reflectToAttr": false,
1224
- "docs": "Provide a label for the input",
1224
+ "docs": "The label for the checkbox.",
1225
1225
  "docsTags": [],
1226
1226
  "values": [
1227
1227
  {
@@ -1237,7 +1237,7 @@
1237
1237
  "mutable": false,
1238
1238
  "attr": "name",
1239
1239
  "reflectToAttr": false,
1240
- "docs": "Provide a name for the input. If not set when used in a checkbox group, the name will be based on the group name.",
1240
+ "docs": "The name for the checkbox. If not set when used in a checkbox group, the name will be based on the group name.",
1241
1241
  "docsTags": [],
1242
1242
  "values": [
1243
1243
  {
@@ -1253,7 +1253,7 @@
1253
1253
  "mutable": false,
1254
1254
  "attr": "value",
1255
1255
  "reflectToAttr": false,
1256
- "docs": "Provide a value for the input",
1256
+ "docs": "The value for the checkbox.",
1257
1257
  "docsTags": [],
1258
1258
  "values": [
1259
1259
  {
@@ -1305,7 +1305,7 @@
1305
1305
  "mutable": false,
1306
1306
  "attr": "disabled",
1307
1307
  "reflectToAttr": false,
1308
- "docs": "Specify whether the input is disabled.",
1308
+ "docs": "If `true`, the checkbox group will be set to the disabled state.",
1309
1309
  "docsTags": [],
1310
1310
  "default": "false",
1311
1311
  "values": [
@@ -1322,7 +1322,7 @@
1322
1322
  "mutable": false,
1323
1323
  "attr": "helper-text",
1324
1324
  "reflectToAttr": false,
1325
- "docs": "Provide helper text to display additional field guidance.",
1325
+ "docs": "The helper text that will be displayed for additional field guidance.",
1326
1326
  "docsTags": [],
1327
1327
  "default": "\"\"",
1328
1328
  "values": [
@@ -1339,7 +1339,7 @@
1339
1339
  "mutable": false,
1340
1340
  "attr": "hide-label",
1341
1341
  "reflectToAttr": false,
1342
- "docs": "Hides the label and applies the required label value as an aria-label.",
1342
+ "docs": "If `true`, the label will be hidden and the required label value will be applied as an aria-label.",
1343
1343
  "docsTags": [],
1344
1344
  "default": "false",
1345
1345
  "values": [
@@ -1356,7 +1356,7 @@
1356
1356
  "mutable": false,
1357
1357
  "attr": "label",
1358
1358
  "reflectToAttr": false,
1359
- "docs": "Provide a label for the input.",
1359
+ "docs": "The label for the checkbox group to be displayed.",
1360
1360
  "docsTags": [],
1361
1361
  "values": [
1362
1362
  {
@@ -1372,7 +1372,7 @@
1372
1372
  "mutable": false,
1373
1373
  "attr": "name",
1374
1374
  "reflectToAttr": false,
1375
- "docs": "Provide a name for the input.",
1375
+ "docs": "The name for the checkbox group to differentiate from other groups.",
1376
1376
  "docsTags": [],
1377
1377
  "values": [
1378
1378
  {
@@ -1388,7 +1388,7 @@
1388
1388
  "mutable": false,
1389
1389
  "attr": "required",
1390
1390
  "reflectToAttr": false,
1391
- "docs": "Specify if the input requires a value.",
1391
+ "docs": "If `true`, the checkbox group will require a value.",
1392
1392
  "docsTags": [],
1393
1393
  "default": "false",
1394
1394
  "values": [
@@ -1405,7 +1405,7 @@
1405
1405
  "mutable": false,
1406
1406
  "attr": "small",
1407
1407
  "reflectToAttr": false,
1408
- "docs": "Specify whether small styling to be applied to element.",
1408
+ "docs": "If `true`, the small styling will be applied to the checkbox group.",
1409
1409
  "docsTags": [],
1410
1410
  "default": "false",
1411
1411
  "values": [
@@ -1422,7 +1422,7 @@
1422
1422
  "mutable": false,
1423
1423
  "attr": "validation-status",
1424
1424
  "reflectToAttr": false,
1425
- "docs": "Provide validation status - 'error'",
1425
+ "docs": "The validation status - e.g. 'error' | 'warning' | 'success'.",
1426
1426
  "docsTags": [],
1427
1427
  "default": "\"\"",
1428
1428
  "values": [
@@ -1451,7 +1451,7 @@
1451
1451
  "mutable": false,
1452
1452
  "attr": "validation-text",
1453
1453
  "reflectToAttr": false,
1454
- "docs": "Provide validation text - 'error'",
1454
+ "docs": "The validation text - e.g. 'error' | 'warning' | 'success'.",
1455
1455
  "docsTags": [],
1456
1456
  "default": "\"\"",
1457
1457
  "values": [
@@ -1518,7 +1518,7 @@
1518
1518
  "mutable": false,
1519
1519
  "attr": "additional-selectors",
1520
1520
  "reflectToAttr": false,
1521
- "docs": "Additional information to display after the classification",
1521
+ "docs": "The additional information that will be displayed after the classification.",
1522
1522
  "docsTags": [],
1523
1523
  "default": "\"\"",
1524
1524
  "values": [
@@ -1535,7 +1535,7 @@
1535
1535
  "mutable": false,
1536
1536
  "attr": "classification",
1537
1537
  "reflectToAttr": false,
1538
- "docs": "The classification level to be displayed also determines the banner and text colour",
1538
+ "docs": "The classification level to be displayed - also determines the banner and text colour.",
1539
1539
  "docsTags": [],
1540
1540
  "default": "\"default\"",
1541
1541
  "values": [
@@ -1569,7 +1569,7 @@
1569
1569
  "mutable": false,
1570
1570
  "attr": "country",
1571
1571
  "reflectToAttr": false,
1572
- "docs": "Optional text displayed before classification to specify relevant country/countries",
1572
+ "docs": "The optional text that will be displayed before classification to specify relevant country/countries.",
1573
1573
  "docsTags": [],
1574
1574
  "default": "\"uk\"",
1575
1575
  "values": [
@@ -1586,7 +1586,7 @@
1586
1586
  "mutable": false,
1587
1587
  "attr": "inline",
1588
1588
  "reflectToAttr": false,
1589
- "docs": "Determines whether the banner appears inline with the page or sticks to the bottom of the page",
1589
+ "docs": "If `true`, the banner will appear inline with the page, instead of sticking to the bottom of the page.",
1590
1590
  "docsTags": [],
1591
1591
  "default": "false",
1592
1592
  "values": [
@@ -1603,7 +1603,7 @@
1603
1603
  "mutable": false,
1604
1604
  "attr": "up-to",
1605
1605
  "reflectToAttr": false,
1606
- "docs": "Optionally display \"Up to\" before classification and country if set",
1606
+ "docs": "If `true`, \"Up to\" will be displayed before the classification and country.",
1607
1607
  "docsTags": [],
1608
1608
  "default": "false",
1609
1609
  "values": [
@@ -1646,7 +1646,7 @@
1646
1646
  "mutable": false,
1647
1647
  "attr": "heading",
1648
1648
  "reflectToAttr": false,
1649
- "docs": "Title for the data entity",
1649
+ "docs": "The title for the data entity.",
1650
1650
  "docsTags": [],
1651
1651
  "values": [
1652
1652
  {
@@ -1662,7 +1662,7 @@
1662
1662
  "mutable": false,
1663
1663
  "attr": "small",
1664
1664
  "reflectToAttr": false,
1665
- "docs": "Set the data heading and all child data rows to small styling",
1665
+ "docs": "If `true`, the small styling will be applied to the data heading and all child data rows.",
1666
1666
  "docsTags": [],
1667
1667
  "default": "false",
1668
1668
  "values": [
@@ -1718,7 +1718,7 @@
1718
1718
  "mutable": false,
1719
1719
  "attr": "label",
1720
1720
  "reflectToAttr": false,
1721
- "docs": "Set the label in the leftmost cell of the row",
1721
+ "docs": "The label in the leftmost cell of the row.",
1722
1722
  "docsTags": [],
1723
1723
  "values": [
1724
1724
  {
@@ -1734,7 +1734,7 @@
1734
1734
  "mutable": false,
1735
1735
  "attr": "small",
1736
1736
  "reflectToAttr": false,
1737
- "docs": "Set the row to small styling, this is automatically applied if small is set on the parent data heading",
1737
+ "docs": "If `true`, the small styling will be applied to the row. This is automatically applied if small is set on the parent data heading.",
1738
1738
  "docsTags": [],
1739
1739
  "default": "false",
1740
1740
  "values": [
@@ -1751,7 +1751,7 @@
1751
1751
  "mutable": false,
1752
1752
  "attr": "value",
1753
1753
  "reflectToAttr": false,
1754
- "docs": "Set the value of the middle (right if no addition supplied) cell of the row",
1754
+ "docs": "The value of the middle (right if no end-component supplied) cell of the row.",
1755
1755
  "docsTags": [],
1756
1756
  "values": [
1757
1757
  {
@@ -1832,19 +1832,19 @@
1832
1832
  "docsTags": [
1833
1833
  {
1834
1834
  "name": "slot",
1835
- "text": "description - Content will be rendered at the top of the footer"
1835
+ "text": "description - Content will be rendered at the top of the footer."
1836
1836
  },
1837
1837
  {
1838
1838
  "name": "slot",
1839
- "text": "link - Content will be rendered between description and logos"
1839
+ "text": "link - Content will be rendered between description and logos."
1840
1840
  },
1841
1841
  {
1842
1842
  "name": "slot",
1843
- "text": "logo - Content will be rendered underneath footer links"
1843
+ "text": "logo - Content will be rendered underneath footer links."
1844
1844
  },
1845
1845
  {
1846
1846
  "name": "slot",
1847
- "text": "caption - Content will be rendered above Crown Copyright"
1847
+ "text": "caption - Content will be rendered above Crown Copyright."
1848
1848
  }
1849
1849
  ],
1850
1850
  "usage": {},
@@ -1855,7 +1855,7 @@
1855
1855
  "mutable": false,
1856
1856
  "attr": "aligned",
1857
1857
  "reflectToAttr": false,
1858
- "docs": "Sets the aligned parameter for the section containers used within the footer",
1858
+ "docs": "The alignment of the section containers used within the footer.",
1859
1859
  "docsTags": [],
1860
1860
  "default": "\"left\"",
1861
1861
  "values": [
@@ -1881,7 +1881,7 @@
1881
1881
  "mutable": false,
1882
1882
  "attr": "breakpoint",
1883
1883
  "reflectToAttr": false,
1884
- "docs": "Sets the screen size breakpoint at which to switch to the small layout",
1884
+ "docs": "The screen size breakpoint at which to switch to the small layout.",
1885
1885
  "docsTags": [],
1886
1886
  "default": "\"medium\"",
1887
1887
  "values": [
@@ -1915,7 +1915,7 @@
1915
1915
  "mutable": false,
1916
1916
  "attr": "caption",
1917
1917
  "reflectToAttr": false,
1918
- "docs": "The caption displayed at the bottom of the footer",
1918
+ "docs": "The caption displayed at the bottom of the footer.",
1919
1919
  "docsTags": [],
1920
1920
  "values": [
1921
1921
  {
@@ -1931,7 +1931,7 @@
1931
1931
  "mutable": false,
1932
1932
  "attr": "copyright",
1933
1933
  "reflectToAttr": false,
1934
- "docs": "Whether the footer displays the crown copyright at the bottom",
1934
+ "docs": "If `true`, the footer will display the crown copyright at the bottom.",
1935
1935
  "docsTags": [],
1936
1936
  "default": "true",
1937
1937
  "values": [
@@ -1948,7 +1948,7 @@
1948
1948
  "mutable": false,
1949
1949
  "attr": "description",
1950
1950
  "reflectToAttr": false,
1951
- "docs": "The description displayed at the top of the footer",
1951
+ "docs": "The description displayed at the top of the footer.",
1952
1952
  "docsTags": [],
1953
1953
  "values": [
1954
1954
  {
@@ -1964,7 +1964,7 @@
1964
1964
  "mutable": false,
1965
1965
  "attr": "group-links",
1966
1966
  "reflectToAttr": false,
1967
- "docs": "Sets the footer up to handle link groups instead of standalone links",
1967
+ "docs": "If `true`, the footer will be set up to handle link groups instead of standalone links.",
1968
1968
  "docsTags": [],
1969
1969
  "default": "false",
1970
1970
  "values": [
@@ -2000,19 +2000,19 @@
2000
2000
  "slots": [
2001
2001
  {
2002
2002
  "name": "caption",
2003
- "docs": "Content will be rendered above Crown Copyright"
2003
+ "docs": "Content will be rendered above Crown Copyright."
2004
2004
  },
2005
2005
  {
2006
2006
  "name": "description",
2007
- "docs": "Content will be rendered at the top of the footer"
2007
+ "docs": "Content will be rendered at the top of the footer."
2008
2008
  },
2009
2009
  {
2010
2010
  "name": "link",
2011
- "docs": "Content will be rendered between description and logos"
2011
+ "docs": "Content will be rendered between description and logos."
2012
2012
  },
2013
2013
  {
2014
2014
  "name": "logo",
2015
- "docs": "Content will be rendered underneath footer links"
2015
+ "docs": "Content will be rendered underneath footer links."
2016
2016
  }
2017
2017
  ],
2018
2018
  "parts": [],
@@ -2093,7 +2093,7 @@
2093
2093
  "mutable": false,
2094
2094
  "attr": "group-title",
2095
2095
  "reflectToAttr": false,
2096
- "docs": "Sets the title of the link group for display",
2096
+ "docs": "The title of the link group to be displayed.",
2097
2097
  "docsTags": [],
2098
2098
  "values": [
2099
2099
  {
@@ -2167,7 +2167,7 @@
2167
2167
  "mutable": false,
2168
2168
  "attr": "aligned",
2169
2169
  "reflectToAttr": false,
2170
- "docs": "The alignment of the hero content",
2170
+ "docs": "The alignment of the hero.",
2171
2171
  "docsTags": [],
2172
2172
  "default": "\"left\"",
2173
2173
  "values": [
@@ -2193,7 +2193,7 @@
2193
2193
  "mutable": false,
2194
2194
  "attr": "background-image",
2195
2195
  "reflectToAttr": false,
2196
- "docs": "Optional background image",
2196
+ "docs": "The optional background image.",
2197
2197
  "docsTags": [],
2198
2198
  "values": [
2199
2199
  {
@@ -2209,7 +2209,7 @@
2209
2209
  "mutable": false,
2210
2210
  "attr": "content-aligned",
2211
2211
  "reflectToAttr": false,
2212
- "docs": "The alignment of the hero content",
2212
+ "docs": "The alignment of the hero content.",
2213
2213
  "docsTags": [],
2214
2214
  "default": "\"left\"",
2215
2215
  "values": [
@@ -2231,7 +2231,7 @@
2231
2231
  "mutable": false,
2232
2232
  "attr": "disable-background-parallax",
2233
2233
  "reflectToAttr": false,
2234
- "docs": "Whether the background image (if set) scrolls using a parallax effect.",
2234
+ "docs": "If `true`, the background image (if set) will not scroll using a parallax effect.",
2235
2235
  "docsTags": [],
2236
2236
  "default": "false",
2237
2237
  "values": [
@@ -2248,7 +2248,7 @@
2248
2248
  "mutable": false,
2249
2249
  "attr": "heading",
2250
2250
  "reflectToAttr": false,
2251
- "docs": "The heading of the hero",
2251
+ "docs": "The heading of the hero.",
2252
2252
  "docsTags": [],
2253
2253
  "values": [
2254
2254
  {
@@ -2264,7 +2264,7 @@
2264
2264
  "mutable": false,
2265
2265
  "attr": "secondary-heading",
2266
2266
  "reflectToAttr": false,
2267
- "docs": "Optional secondary heading, replaced by slotted right content",
2267
+ "docs": "The optional secondary heading, replaced by slotted right content.",
2268
2268
  "docsTags": [],
2269
2269
  "values": [
2270
2270
  {
@@ -2280,7 +2280,7 @@
2280
2280
  "mutable": false,
2281
2281
  "attr": "secondary-subheading",
2282
2282
  "reflectToAttr": false,
2283
- "docs": "Optional secondary subheading, replaced by slotted right content",
2283
+ "docs": "The optional secondary subheading, replaced by slotted right content.",
2284
2284
  "docsTags": [],
2285
2285
  "values": [
2286
2286
  {
@@ -2296,7 +2296,7 @@
2296
2296
  "mutable": false,
2297
2297
  "attr": "small",
2298
2298
  "reflectToAttr": false,
2299
- "docs": "Alter styling for use with small content/pages",
2299
+ "docs": "If `true`, the small styling will be applied to the hero.",
2300
2300
  "docsTags": [],
2301
2301
  "default": "false",
2302
2302
  "values": [
@@ -2313,7 +2313,7 @@
2313
2313
  "mutable": false,
2314
2314
  "attr": "subheading",
2315
2315
  "reflectToAttr": false,
2316
- "docs": "Description for the hero",
2316
+ "docs": "The description for the hero.",
2317
2317
  "docsTags": [],
2318
2318
  "values": [
2319
2319
  {
@@ -2392,7 +2392,7 @@
2392
2392
  "mutable": false,
2393
2393
  "attr": "dark",
2394
2394
  "reflectToAttr": false,
2395
- "docs": "Determines whether the dark variant of the input-component-container focus indicator should be displayed.",
2395
+ "docs": "If `true`, the dark variant of the input component container will be displayed.",
2396
2396
  "docsTags": [],
2397
2397
  "default": "false",
2398
2398
  "values": [
@@ -2409,7 +2409,7 @@
2409
2409
  "mutable": false,
2410
2410
  "attr": "disabled",
2411
2411
  "reflectToAttr": false,
2412
- "docs": "disabled",
2412
+ "docs": "If `true`, the disabled state will be set.",
2413
2413
  "docsTags": [],
2414
2414
  "default": "false",
2415
2415
  "values": [
@@ -2426,7 +2426,7 @@
2426
2426
  "mutable": false,
2427
2427
  "attr": "full-width",
2428
2428
  "reflectToAttr": false,
2429
- "docs": "If true then fill width of container",
2429
+ "docs": "If `true`, the input component container will fill the width of the container it is in.",
2430
2430
  "docsTags": [],
2431
2431
  "default": "false",
2432
2432
  "values": [
@@ -2443,7 +2443,7 @@
2443
2443
  "mutable": false,
2444
2444
  "attr": "multi-line",
2445
2445
  "reflectToAttr": false,
2446
- "docs": "multiLine",
2446
+ "docs": "If `true`, the input component container will allow for multiple lines.",
2447
2447
  "docsTags": [],
2448
2448
  "default": "false",
2449
2449
  "values": [
@@ -2460,7 +2460,7 @@
2460
2460
  "mutable": false,
2461
2461
  "attr": "readonly",
2462
2462
  "reflectToAttr": false,
2463
- "docs": "readonly",
2463
+ "docs": "If `true`, the readonly state will be set.",
2464
2464
  "docsTags": [],
2465
2465
  "default": "false",
2466
2466
  "values": [
@@ -2477,7 +2477,7 @@
2477
2477
  "mutable": false,
2478
2478
  "attr": "small",
2479
2479
  "reflectToAttr": false,
2480
- "docs": "small",
2480
+ "docs": "If `true`, the small styling will be applied to the input component container.",
2481
2481
  "docsTags": [],
2482
2482
  "default": "false",
2483
2483
  "values": [
@@ -2494,7 +2494,7 @@
2494
2494
  "mutable": false,
2495
2495
  "attr": "validation-inline",
2496
2496
  "reflectToAttr": false,
2497
- "docs": "validationInline",
2497
+ "docs": "If `true`, the validation will display inline.",
2498
2498
  "docsTags": [],
2499
2499
  "default": "false",
2500
2500
  "values": [
@@ -2511,7 +2511,7 @@
2511
2511
  "mutable": false,
2512
2512
  "attr": "validation-status",
2513
2513
  "reflectToAttr": false,
2514
- "docs": "validationStatus",
2514
+ "docs": "The validation status of the input component container - e.g. 'error' | 'warning' | 'success'.",
2515
2515
  "docsTags": [],
2516
2516
  "default": "\"\"",
2517
2517
  "values": [
@@ -2581,7 +2581,7 @@
2581
2581
  "mutable": false,
2582
2582
  "attr": "disabled",
2583
2583
  "reflectToAttr": false,
2584
- "docs": "disabled",
2584
+ "docs": "If `true`, the disabled state will be set.",
2585
2585
  "docsTags": [],
2586
2586
  "default": "false",
2587
2587
  "values": [
@@ -2598,7 +2598,7 @@
2598
2598
  "mutable": false,
2599
2599
  "attr": "readonly",
2600
2600
  "reflectToAttr": false,
2601
- "docs": "readonly",
2601
+ "docs": "If `true`, the readonly state will be set.",
2602
2602
  "docsTags": [],
2603
2603
  "default": "false",
2604
2604
  "values": [
@@ -2645,7 +2645,7 @@
2645
2645
  "mutable": false,
2646
2646
  "attr": "dark",
2647
2647
  "reflectToAttr": false,
2648
- "docs": "dark",
2648
+ "docs": "If `true`, the dark variant of the input label will be displayed.",
2649
2649
  "docsTags": [],
2650
2650
  "default": "false",
2651
2651
  "values": [
@@ -2662,7 +2662,7 @@
2662
2662
  "mutable": false,
2663
2663
  "attr": "disabled",
2664
2664
  "reflectToAttr": false,
2665
- "docs": "disabled",
2665
+ "docs": "If `true`, the disabled state will be set.",
2666
2666
  "docsTags": [],
2667
2667
  "default": "false",
2668
2668
  "values": [
@@ -2679,7 +2679,7 @@
2679
2679
  "mutable": false,
2680
2680
  "attr": "error",
2681
2681
  "reflectToAttr": false,
2682
- "docs": "error",
2682
+ "docs": "If `true`, the input label will display with error styling.",
2683
2683
  "docsTags": [],
2684
2684
  "default": "false",
2685
2685
  "values": [
@@ -2696,7 +2696,7 @@
2696
2696
  "mutable": false,
2697
2697
  "attr": "for",
2698
2698
  "reflectToAttr": false,
2699
- "docs": "for",
2699
+ "docs": "The ID of the form element the label is bound to.",
2700
2700
  "docsTags": [],
2701
2701
  "values": [
2702
2702
  {
@@ -2712,7 +2712,7 @@
2712
2712
  "mutable": false,
2713
2713
  "attr": "helper-text",
2714
2714
  "reflectToAttr": false,
2715
- "docs": "helperText",
2715
+ "docs": "The helper text that will be displayed.",
2716
2716
  "docsTags": [],
2717
2717
  "default": "\"\"",
2718
2718
  "values": [
@@ -2729,7 +2729,7 @@
2729
2729
  "mutable": false,
2730
2730
  "attr": "label",
2731
2731
  "reflectToAttr": false,
2732
- "docs": "label",
2732
+ "docs": "The text content of the label.",
2733
2733
  "docsTags": [],
2734
2734
  "values": [
2735
2735
  {
@@ -2745,7 +2745,7 @@
2745
2745
  "mutable": false,
2746
2746
  "attr": "readonly",
2747
2747
  "reflectToAttr": false,
2748
- "docs": "readonly",
2748
+ "docs": "If `true`, the readonly state will be set.",
2749
2749
  "docsTags": [],
2750
2750
  "default": "false",
2751
2751
  "values": [
@@ -2762,7 +2762,7 @@
2762
2762
  "mutable": false,
2763
2763
  "attr": "required",
2764
2764
  "reflectToAttr": false,
2765
- "docs": "required",
2765
+ "docs": "If `true`, the input label will require a value.",
2766
2766
  "docsTags": [],
2767
2767
  "default": "false",
2768
2768
  "values": [
@@ -2831,7 +2831,7 @@
2831
2831
  "mutable": false,
2832
2832
  "attr": "aria-live-mode",
2833
2833
  "reflectToAttr": false,
2834
- "docs": "aria live mode to apply to message",
2834
+ "docs": "The ARIA live mode to apply to the message.",
2835
2835
  "docsTags": [],
2836
2836
  "default": "\"polite\"",
2837
2837
  "values": [
@@ -2853,7 +2853,7 @@
2853
2853
  "mutable": false,
2854
2854
  "attr": "for",
2855
2855
  "reflectToAttr": false,
2856
- "docs": "The id of the input field the message relates to",
2856
+ "docs": "The ID of the form element the validation is bound to.",
2857
2857
  "docsTags": [],
2858
2858
  "values": [
2859
2859
  {
@@ -2869,7 +2869,7 @@
2869
2869
  "mutable": false,
2870
2870
  "attr": "full-width",
2871
2871
  "reflectToAttr": false,
2872
- "docs": "If true then fill width of container",
2872
+ "docs": "If `true`, the input validation will fill the width of the container.",
2873
2873
  "docsTags": [],
2874
2874
  "default": "false",
2875
2875
  "values": [
@@ -2886,7 +2886,7 @@
2886
2886
  "mutable": false,
2887
2887
  "attr": "message",
2888
2888
  "reflectToAttr": false,
2889
- "docs": "The validation message to display",
2889
+ "docs": "The validation message to display.",
2890
2890
  "docsTags": [],
2891
2891
  "values": [
2892
2892
  {
@@ -2902,7 +2902,7 @@
2902
2902
  "mutable": false,
2903
2903
  "attr": "status",
2904
2904
  "reflectToAttr": false,
2905
- "docs": "The status",
2905
+ "docs": "The status of the validation - e.g. 'error' | 'warning' | 'success'.",
2906
2906
  "docsTags": [],
2907
2907
  "default": "\"\"",
2908
2908
  "values": [
@@ -2973,7 +2973,7 @@
2973
2973
  "docsTags": [
2974
2974
  {
2975
2975
  "name": "slot",
2976
- "text": "router-item - Handle routing by nesting your routes in this slot"
2976
+ "text": "router-item - Handle routing by nesting your routes in this slot."
2977
2977
  }
2978
2978
  ],
2979
2979
  "usage": {},
@@ -2984,7 +2984,7 @@
2984
2984
  "mutable": true,
2985
2985
  "attr": "appearance",
2986
2986
  "reflectToAttr": false,
2987
- "docs": "Determines the whether the appearance is dark, light, or the default.",
2987
+ "docs": "The appearance of the link, e.g. dark, light, or default.",
2988
2988
  "docsTags": [],
2989
2989
  "default": "\"default\"",
2990
2990
  "values": [
@@ -3010,7 +3010,7 @@
3010
3010
  "mutable": false,
3011
3011
  "attr": "download",
3012
3012
  "reflectToAttr": false,
3013
- "docs": "Prompts the user to save the linked URL instead of navigating to it.",
3013
+ "docs": "If `true`, the user can save the linked URL instead of navigating to it.",
3014
3014
  "docsTags": [],
3015
3015
  "default": "false",
3016
3016
  "values": [
@@ -3047,7 +3047,7 @@
3047
3047
  "mutable": false,
3048
3048
  "attr": "hreflang",
3049
3049
  "reflectToAttr": false,
3050
- "docs": "Hints at the human language of the linked URL.",
3050
+ "docs": "The human language of the linked URL.",
3051
3051
  "docsTags": [],
3052
3052
  "values": [
3053
3053
  {
@@ -3127,7 +3127,7 @@
3127
3127
  "mutable": false,
3128
3128
  "attr": "show-icon",
3129
3129
  "reflectToAttr": false,
3130
- "docs": "Determines whether the 'open in new tab/window' icon is to be displayed.",
3130
+ "docs": "If `true`, the 'open in new tab/window' icon will be displayed.",
3131
3131
  "docsTags": [],
3132
3132
  "values": [
3133
3133
  {
@@ -3143,7 +3143,7 @@
3143
3143
  "mutable": false,
3144
3144
  "attr": "target",
3145
3145
  "reflectToAttr": false,
3146
- "docs": "Where to display the linked URL, as the name for a browsing context (a tab, window, or iframe).",
3146
+ "docs": "The place to display the linked URL, as the name for a browsing context (a tab, window, or iframe).",
3147
3147
  "docsTags": [],
3148
3148
  "values": [
3149
3149
  {
@@ -3168,7 +3168,7 @@
3168
3168
  "slots": [
3169
3169
  {
3170
3170
  "name": "router-item",
3171
- "docs": "Handle routing by nesting your routes in this slot"
3171
+ "docs": "Handle routing by nesting your routes in this slot."
3172
3172
  }
3173
3173
  ],
3174
3174
  "parts": [],
@@ -3197,7 +3197,7 @@
3197
3197
  "mutable": false,
3198
3198
  "attr": "appearance",
3199
3199
  "reflectToAttr": false,
3200
- "docs": "Determines whether the dark or light loading indicator should be displayed.",
3200
+ "docs": "The appearance of the loading indicator, e.g. dark or light.",
3201
3201
  "docsTags": [],
3202
3202
  "default": "\"dark\"",
3203
3203
  "values": [
@@ -3219,7 +3219,7 @@
3219
3219
  "mutable": false,
3220
3220
  "attr": "description",
3221
3221
  "reflectToAttr": false,
3222
- "docs": "Provide a description to be set as the aria-label of the loading indicator when not using a visible label.",
3222
+ "docs": "The description that will be set as the aria-label of the loading indicator when not using a visible label.",
3223
3223
  "docsTags": [],
3224
3224
  "default": "\"Loading\"",
3225
3225
  "values": [
@@ -3236,7 +3236,7 @@
3236
3236
  "mutable": false,
3237
3237
  "attr": "full-width",
3238
3238
  "reflectToAttr": true,
3239
- "docs": "When linear, determines whether the full-width version (i.e. without a border radius) should be displayed.",
3239
+ "docs": "If `true`, when linear, the full-width variant (i.e. without a border radius) will be displayed.",
3240
3240
  "docsTags": [],
3241
3241
  "default": "false",
3242
3242
  "values": [
@@ -3446,7 +3446,7 @@
3446
3446
  "type": "HTMLElement",
3447
3447
  "mutable": false,
3448
3448
  "reflectToAttr": false,
3449
- "docs": "Reference to an anchor element the menu will position itself from when rendered.",
3449
+ "docs": "The reference to an anchor element the menu will position itself from when rendered.",
3450
3450
  "docsTags": [],
3451
3451
  "values": [
3452
3452
  {
@@ -3462,7 +3462,7 @@
3462
3462
  "mutable": false,
3463
3463
  "attr": "full-width",
3464
3464
  "reflectToAttr": false,
3465
- "docs": "If true then fill width of container",
3465
+ "docs": "If `true`, the menu will fill the width of the container.",
3466
3466
  "docsTags": [],
3467
3467
  "default": "false",
3468
3468
  "values": [
@@ -3478,7 +3478,7 @@
3478
3478
  "type": "HTMLElement",
3479
3479
  "mutable": false,
3480
3480
  "reflectToAttr": false,
3481
- "docs": "Reference to the input element.",
3481
+ "docs": "The reference to the input element.",
3482
3482
  "docsTags": [],
3483
3483
  "values": [
3484
3484
  {
@@ -3494,7 +3494,7 @@
3494
3494
  "mutable": false,
3495
3495
  "attr": "input-label",
3496
3496
  "reflectToAttr": false,
3497
- "docs": "Label for the input element.",
3497
+ "docs": "The label for the input element.",
3498
3498
  "docsTags": [],
3499
3499
  "values": [
3500
3500
  {
@@ -3510,7 +3510,7 @@
3510
3510
  "mutable": false,
3511
3511
  "attr": "menu-id",
3512
3512
  "reflectToAttr": false,
3513
- "docs": "Id of the menu.",
3513
+ "docs": "The ID of the menu.",
3514
3514
  "docsTags": [],
3515
3515
  "values": [
3516
3516
  {
@@ -3526,7 +3526,7 @@
3526
3526
  "mutable": false,
3527
3527
  "attr": "open",
3528
3528
  "reflectToAttr": true,
3529
- "docs": "Specify whether the menu is open.",
3529
+ "docs": "If `true`, the menu will be displayed open.",
3530
3530
  "docsTags": [],
3531
3531
  "values": [
3532
3532
  {
@@ -3541,7 +3541,7 @@
3541
3541
  "type": "IcMenuOption[]",
3542
3542
  "mutable": false,
3543
3543
  "reflectToAttr": false,
3544
- "docs": "Provide the possible selection options.",
3544
+ "docs": "The possible menu selection options.",
3545
3545
  "docsTags": [],
3546
3546
  "values": [
3547
3547
  {
@@ -3557,7 +3557,7 @@
3557
3557
  "mutable": false,
3558
3558
  "attr": "small",
3559
3559
  "reflectToAttr": true,
3560
- "docs": "Specify whether small styling is to be applied to the element.",
3560
+ "docs": "If `true`, the small styling will be applied to the menu.",
3561
3561
  "docsTags": [],
3562
3562
  "default": "false",
3563
3563
  "values": [
@@ -3699,7 +3699,7 @@
3699
3699
  "mutable": false,
3700
3700
  "attr": "download",
3701
3701
  "reflectToAttr": false,
3702
- "docs": "Prompts the user to save the linked URL instead of navigating to it.",
3702
+ "docs": "If `true`, the user can save the linked URL instead of navigating to it.",
3703
3703
  "docsTags": [],
3704
3704
  "default": "false",
3705
3705
  "values": [
@@ -3735,7 +3735,7 @@
3735
3735
  "mutable": false,
3736
3736
  "attr": "hreflang",
3737
3737
  "reflectToAttr": false,
3738
- "docs": "Hints at the human language of the linked URL.",
3738
+ "docs": "The human language of the linked URL.",
3739
3739
  "docsTags": [],
3740
3740
  "values": [
3741
3741
  {
@@ -3751,7 +3751,7 @@
3751
3751
  "mutable": false,
3752
3752
  "attr": "label",
3753
3753
  "reflectToAttr": false,
3754
- "docs": "label info to display",
3754
+ "docs": "The label info to display.",
3755
3755
  "docsTags": [],
3756
3756
  "values": [
3757
3757
  {
@@ -3831,7 +3831,7 @@
3831
3831
  "mutable": false,
3832
3832
  "attr": "target",
3833
3833
  "reflectToAttr": false,
3834
- "docs": "Where to display the linked URL, as the name for a browsing context (a tab, window, or iframe).",
3834
+ "docs": "The place to display the linked URL, as the name for a browsing context (a tab, window, or iframe).",
3835
3835
  "docsTags": [],
3836
3836
  "values": [
3837
3837
  {
@@ -3919,7 +3919,7 @@
3919
3919
  "mutable": false,
3920
3920
  "attr": "expandable",
3921
3921
  "reflectToAttr": false,
3922
- "docs": "whether the group should be expandable/collapsible in the side menu",
3922
+ "docs": "If `true`, the group will be expandable in the side menu.",
3923
3923
  "docsTags": [],
3924
3924
  "default": "false",
3925
3925
  "values": [
@@ -3936,7 +3936,7 @@
3936
3936
  "mutable": false,
3937
3937
  "attr": "label",
3938
3938
  "reflectToAttr": false,
3939
- "docs": "label to display on the group",
3939
+ "docs": "The label to display on the group.",
3940
3940
  "docsTags": [],
3941
3941
  "values": [
3942
3942
  {
@@ -4012,7 +4012,7 @@
4012
4012
  "mutable": false,
4013
4013
  "attr": "href",
4014
4014
  "reflectToAttr": false,
4015
- "docs": "Destination of the navigation item",
4015
+ "docs": "The destination of the navigation item.",
4016
4016
  "docsTags": [],
4017
4017
  "default": "\"\"",
4018
4018
  "values": [
@@ -4029,7 +4029,7 @@
4029
4029
  "mutable": false,
4030
4030
  "attr": "label",
4031
4031
  "reflectToAttr": false,
4032
- "docs": "Label of the navigation item",
4032
+ "docs": "The label of the navigation item.",
4033
4033
  "docsTags": [],
4034
4034
  "values": [
4035
4035
  {
@@ -4045,7 +4045,7 @@
4045
4045
  "mutable": false,
4046
4046
  "attr": "selected",
4047
4047
  "reflectToAttr": false,
4048
- "docs": "If true, sets the navigation item in a selected state",
4048
+ "docs": "If `true`, the navigation item will be set in a selected state.",
4049
4049
  "docsTags": [],
4050
4050
  "default": "false",
4051
4051
  "values": [
@@ -4126,7 +4126,7 @@
4126
4126
  "mutable": false,
4127
4127
  "attr": "status",
4128
4128
  "reflectToAttr": false,
4129
- "docs": "Status info to display",
4129
+ "docs": "The status info to display.",
4130
4130
  "docsTags": [],
4131
4131
  "default": "\"\"",
4132
4132
  "values": [
@@ -4143,7 +4143,7 @@
4143
4143
  "mutable": false,
4144
4144
  "attr": "version",
4145
4145
  "reflectToAttr": false,
4146
- "docs": "Version info to display",
4146
+ "docs": "The version info to display.",
4147
4147
  "docsTags": [],
4148
4148
  "default": "\"\"",
4149
4149
  "values": [
@@ -4257,7 +4257,7 @@
4257
4257
  "mutable": false,
4258
4258
  "attr": "aligned",
4259
4259
  "reflectToAttr": false,
4260
- "docs": "How the component should be aligned.",
4260
+ "docs": "The alignment of the page header.",
4261
4261
  "docsTags": [],
4262
4262
  "default": "\"left\"",
4263
4263
  "values": [
@@ -4283,7 +4283,7 @@
4283
4283
  "mutable": false,
4284
4284
  "attr": "border",
4285
4285
  "reflectToAttr": false,
4286
- "docs": "Set whether the bottom border is used",
4286
+ "docs": "If `true`, a border will be displayed along the bottom of the page header.",
4287
4287
  "docsTags": [],
4288
4288
  "default": "true",
4289
4289
  "values": [
@@ -4300,7 +4300,7 @@
4300
4300
  "mutable": false,
4301
4301
  "attr": "heading",
4302
4302
  "reflectToAttr": false,
4303
- "docs": "The title to render on the component.",
4303
+ "docs": "The title to render on the page header.",
4304
4304
  "docsTags": [],
4305
4305
  "values": [
4306
4306
  {
@@ -4316,7 +4316,7 @@
4316
4316
  "mutable": false,
4317
4317
  "attr": "reverse-order",
4318
4318
  "reflectToAttr": false,
4319
- "docs": "Set whether the reading pattern and tab order change in the action area for viewport widths of above 576px and when actions have not wrapped",
4319
+ "docs": "If `true`, the reading pattern and tab order will change in the action area for viewport widths of above 576px and when actions have not wrapped.",
4320
4320
  "docsTags": [],
4321
4321
  "default": "false",
4322
4322
  "values": [
@@ -4333,7 +4333,7 @@
4333
4333
  "mutable": false,
4334
4334
  "attr": "small",
4335
4335
  "reflectToAttr": false,
4336
- "docs": "Whether the component uses small styling.",
4336
+ "docs": "If `true`, the small styling will be applied to the page header.",
4337
4337
  "docsTags": [],
4338
4338
  "default": "false",
4339
4339
  "values": [
@@ -4350,7 +4350,7 @@
4350
4350
  "mutable": false,
4351
4351
  "attr": "sticky",
4352
4352
  "reflectToAttr": false,
4353
- "docs": "Set whether the header is sticky at all breakpoints",
4353
+ "docs": "If `true`, the page header will be sticky at all breakpoints.",
4354
4354
  "docsTags": [],
4355
4355
  "default": "false",
4356
4356
  "values": [
@@ -4367,7 +4367,7 @@
4367
4367
  "mutable": false,
4368
4368
  "attr": "sticky-desktop-only",
4369
4369
  "reflectToAttr": false,
4370
- "docs": "Set whether the header is only sticky for viewport widths of 992px and above",
4370
+ "docs": "If `true`, the page header will only be sticky for viewport widths of 992px and above.",
4371
4371
  "docsTags": [],
4372
4372
  "default": "false",
4373
4373
  "values": [
@@ -4384,7 +4384,7 @@
4384
4384
  "mutable": false,
4385
4385
  "attr": "subheading",
4386
4386
  "reflectToAttr": false,
4387
- "docs": "The subtitle to render on the component.",
4387
+ "docs": "The subtitle to render on the page header.",
4388
4388
  "docsTags": [],
4389
4389
  "values": [
4390
4390
  {
@@ -4461,7 +4461,7 @@
4461
4461
  "mutable": false,
4462
4462
  "attr": "disabled",
4463
4463
  "reflectToAttr": false,
4464
- "docs": "Specify whether the input is disabled.",
4464
+ "docs": "If `true`, the disabled state will be set.",
4465
4465
  "docsTags": [],
4466
4466
  "default": "false",
4467
4467
  "values": [
@@ -4478,7 +4478,7 @@
4478
4478
  "mutable": false,
4479
4479
  "attr": "helper-text",
4480
4480
  "reflectToAttr": false,
4481
- "docs": "Provide helper text to display additional field guidance.",
4481
+ "docs": "The helper text that will be displayed for additional field guidance.",
4482
4482
  "docsTags": [],
4483
4483
  "values": [
4484
4484
  {
@@ -4494,7 +4494,7 @@
4494
4494
  "mutable": false,
4495
4495
  "attr": "hide-label",
4496
4496
  "reflectToAttr": false,
4497
- "docs": "Hides the label and applies the required label value as an aria-label.",
4497
+ "docs": "If `true`, the label will be hidden and the required label value will be applied as an aria-label.",
4498
4498
  "docsTags": [],
4499
4499
  "default": "false",
4500
4500
  "values": [
@@ -4511,7 +4511,7 @@
4511
4511
  "mutable": false,
4512
4512
  "attr": "label",
4513
4513
  "reflectToAttr": false,
4514
- "docs": "Provide a label for the input.",
4514
+ "docs": "The label for the radio group to be displayed.",
4515
4515
  "docsTags": [],
4516
4516
  "values": [
4517
4517
  {
@@ -4527,7 +4527,7 @@
4527
4527
  "mutable": false,
4528
4528
  "attr": "name",
4529
4529
  "reflectToAttr": false,
4530
- "docs": "Provide a name for the input.",
4530
+ "docs": "The name for the radio group to differentiate from other groups.",
4531
4531
  "docsTags": [],
4532
4532
  "values": [
4533
4533
  {
@@ -4543,7 +4543,7 @@
4543
4543
  "mutable": false,
4544
4544
  "attr": "required",
4545
4545
  "reflectToAttr": false,
4546
- "docs": "Specify if the input requires a value.",
4546
+ "docs": "If `true`, the radio group will require a value.",
4547
4547
  "docsTags": [],
4548
4548
  "default": "false",
4549
4549
  "values": [
@@ -4560,7 +4560,7 @@
4560
4560
  "mutable": false,
4561
4561
  "attr": "small",
4562
4562
  "reflectToAttr": false,
4563
- "docs": "Specify whether small styling is to be applied to the element.",
4563
+ "docs": "If `true`, the small styling will be applied to the radio group.",
4564
4564
  "docsTags": [],
4565
4565
  "default": "false",
4566
4566
  "values": [
@@ -4577,7 +4577,7 @@
4577
4577
  "mutable": false,
4578
4578
  "attr": "validation-status",
4579
4579
  "reflectToAttr": false,
4580
- "docs": "Provide validation status - 'error'",
4580
+ "docs": "The validation status - e.g. 'error' | 'warning' | 'success'.",
4581
4581
  "docsTags": [],
4582
4582
  "default": "\"\"",
4583
4583
  "values": [
@@ -4606,7 +4606,7 @@
4606
4606
  "mutable": false,
4607
4607
  "attr": "validation-text",
4608
4608
  "reflectToAttr": false,
4609
- "docs": "Provide validation text - 'error'",
4609
+ "docs": "The validation text - e.g. 'error' | 'warning' | 'success'.",
4610
4610
  "docsTags": [],
4611
4611
  "default": "\"\"",
4612
4612
  "values": [
@@ -4673,7 +4673,7 @@
4673
4673
  "mutable": false,
4674
4674
  "attr": "additional-field-display",
4675
4675
  "reflectToAttr": true,
4676
- "docs": "Determines type of additional text field in relation to radio option",
4676
+ "docs": "The style of additionalField that will be displayed if used.",
4677
4677
  "docsTags": [],
4678
4678
  "default": "\"static\"",
4679
4679
  "values": [
@@ -4695,7 +4695,7 @@
4695
4695
  "mutable": false,
4696
4696
  "attr": "disabled",
4697
4697
  "reflectToAttr": false,
4698
- "docs": "Determines whether the radio should be in disabled state.",
4698
+ "docs": "If `true`, the disabled state will be set.",
4699
4699
  "docsTags": [],
4700
4700
  "default": "false",
4701
4701
  "values": [
@@ -4712,7 +4712,7 @@
4712
4712
  "mutable": false,
4713
4713
  "attr": "dynamic-text",
4714
4714
  "reflectToAttr": false,
4715
- "docs": "Provide a text prop for the dynamic text.",
4715
+ "docs": "The text to be displayed when dynamic.",
4716
4716
  "docsTags": [],
4717
4717
  "default": "\"This selection requires additional answers\"",
4718
4718
  "values": [
@@ -4729,7 +4729,7 @@
4729
4729
  "mutable": false,
4730
4730
  "attr": "group-label",
4731
4731
  "reflectToAttr": false,
4732
- "docs": "Provide a group label for the input.",
4732
+ "docs": "The group label for the radio option.",
4733
4733
  "docsTags": [],
4734
4734
  "values": [
4735
4735
  {
@@ -4745,7 +4745,7 @@
4745
4745
  "mutable": false,
4746
4746
  "attr": "label",
4747
4747
  "reflectToAttr": false,
4748
- "docs": "Provide a label for the input.",
4748
+ "docs": "The label for the radio option.",
4749
4749
  "docsTags": [],
4750
4750
  "values": [
4751
4751
  {
@@ -4761,7 +4761,7 @@
4761
4761
  "mutable": false,
4762
4762
  "attr": "name",
4763
4763
  "reflectToAttr": false,
4764
- "docs": "Provide a name for the input.",
4764
+ "docs": "The name for the radio option.",
4765
4765
  "docsTags": [],
4766
4766
  "values": [
4767
4767
  {
@@ -4777,7 +4777,7 @@
4777
4777
  "mutable": true,
4778
4778
  "attr": "selected",
4779
4779
  "reflectToAttr": true,
4780
- "docs": "Determines whether the radio should be in selected state.",
4780
+ "docs": "If `true`, the radio option will be displayed in a selected state.",
4781
4781
  "docsTags": [],
4782
4782
  "default": "false",
4783
4783
  "values": [
@@ -4794,7 +4794,7 @@
4794
4794
  "mutable": true,
4795
4795
  "attr": "value",
4796
4796
  "reflectToAttr": false,
4797
- "docs": "Provide a value for the input.",
4797
+ "docs": "The value for the radio option.",
4798
4798
  "docsTags": [],
4799
4799
  "values": [
4800
4800
  {
@@ -4807,15 +4807,6 @@
4807
4807
  ],
4808
4808
  "methods": [],
4809
4809
  "events": [
4810
- {
4811
- "event": "icCheck",
4812
- "detail": "void",
4813
- "bubbles": true,
4814
- "cancelable": true,
4815
- "composed": true,
4816
- "docs": "Emitted when radio is checked",
4817
- "docsTags": []
4818
- },
4819
4810
  {
4820
4811
  "event": "radioOptionSelect",
4821
4812
  "detail": "IcValueEventDetail",
@@ -4861,7 +4852,7 @@
4861
4852
  "mutable": false,
4862
4853
  "attr": "autocapitalize",
4863
4854
  "reflectToAttr": false,
4864
- "docs": "Indicates whether and how the text value should be automatically capitalized as it is entered/edited by the user.\nAvailable options: \"off\", \"none\", \"on\", \"sentences\", \"words\", \"characters\".",
4855
+ "docs": "The automatic capitalisation of the text value as it is entered/edited by the user.\nAvailable options: \"off\", \"none\", \"on\", \"sentences\", \"words\", \"characters\".",
4865
4856
  "docsTags": [],
4866
4857
  "default": "\"off\"",
4867
4858
  "values": [
@@ -4878,7 +4869,7 @@
4878
4869
  "mutable": false,
4879
4870
  "attr": "autocomplete",
4880
4871
  "reflectToAttr": false,
4881
- "docs": "Indicates whether the value of the control can be automatically completed by the browser.",
4872
+ "docs": "The state of autocompletion the browser can apply on the text value.",
4882
4873
  "docsTags": [],
4883
4874
  "default": "\"off\"",
4884
4875
  "values": [
@@ -5108,7 +5099,7 @@
5108
5099
  "mutable": false,
5109
5100
  "attr": "autocorrect",
5110
5101
  "reflectToAttr": false,
5111
- "docs": "Whether auto correction should be enabled when the user is entering/editing the text value.",
5102
+ "docs": "The state of autocorrection the browser can apply when the user is entering/editing the text value.",
5112
5103
  "docsTags": [],
5113
5104
  "default": "\"off\"",
5114
5105
  "values": [
@@ -5130,7 +5121,7 @@
5130
5121
  "mutable": false,
5131
5122
  "attr": "autofocus",
5132
5123
  "reflectToAttr": false,
5133
- "docs": "This Boolean attribute lets you specify that a form control should have input focus when the page loads.",
5124
+ "docs": "If `true`, the form control will have input focus when the page loads.",
5134
5125
  "docsTags": [],
5135
5126
  "default": "false",
5136
5127
  "values": [
@@ -5147,7 +5138,7 @@
5147
5138
  "mutable": false,
5148
5139
  "attr": "characters-until-suggestion",
5149
5140
  "reflectToAttr": false,
5150
- "docs": "Number of characters until suggestions appear",
5141
+ "docs": "The number of characters until suggestions appear.",
5151
5142
  "docsTags": [],
5152
5143
  "default": "2",
5153
5144
  "values": [
@@ -5164,7 +5155,7 @@
5164
5155
  "mutable": true,
5165
5156
  "attr": "debounce",
5166
5157
  "reflectToAttr": false,
5167
- "docs": "Set the amount of time, in milliseconds, to wait to trigger the `icChange` event after each keystroke.",
5158
+ "docs": "The amount of time, in milliseconds, to wait to trigger the `icChange` event after each keystroke.",
5168
5159
  "docsTags": [],
5169
5160
  "default": "0",
5170
5161
  "values": [
@@ -5181,7 +5172,7 @@
5181
5172
  "mutable": false,
5182
5173
  "attr": "disable-filter",
5183
5174
  "reflectToAttr": false,
5184
- "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.",
5175
+ "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.",
5185
5176
  "docsTags": [],
5186
5177
  "default": "false",
5187
5178
  "values": [
@@ -5198,7 +5189,7 @@
5198
5189
  "mutable": false,
5199
5190
  "attr": "disabled",
5200
5191
  "reflectToAttr": false,
5201
- "docs": "Specify whether the input is disabled.",
5192
+ "docs": "If `true`, the disabled state will be set.",
5202
5193
  "docsTags": [],
5203
5194
  "default": "false",
5204
5195
  "values": [
@@ -5215,7 +5206,7 @@
5215
5206
  "mutable": false,
5216
5207
  "attr": "empty-option-list-text",
5217
5208
  "reflectToAttr": false,
5218
- "docs": "Provide text for empty results list",
5209
+ "docs": "The text displayed when there are no options in the option list.",
5219
5210
  "docsTags": [],
5220
5211
  "default": "\"No results found\"",
5221
5212
  "values": [
@@ -5232,7 +5223,7 @@
5232
5223
  "mutable": false,
5233
5224
  "attr": "focus-on-load",
5234
5225
  "reflectToAttr": false,
5235
- "docs": "Specify whether the input should be focussed when component loaded.",
5226
+ "docs": "If `true`, the search bar will be focused when component loaded.",
5236
5227
  "docsTags": [],
5237
5228
  "default": "false",
5238
5229
  "values": [
@@ -5249,7 +5240,7 @@
5249
5240
  "mutable": false,
5250
5241
  "attr": "full-width",
5251
5242
  "reflectToAttr": false,
5252
- "docs": "Specify whether the component fills the full width of the container.\nIf true, this overrides the --input-width css prop.",
5243
+ "docs": "Specify whether the search bar fills the full width of the container.\nIf `true`, this overrides the --input-width CSS variable.",
5253
5244
  "docsTags": [],
5254
5245
  "default": "false",
5255
5246
  "values": [
@@ -5266,7 +5257,7 @@
5266
5257
  "mutable": false,
5267
5258
  "attr": "helper-text",
5268
5259
  "reflectToAttr": false,
5269
- "docs": "Provide helper text to display additional field guidance.",
5260
+ "docs": "The helper text that will be displayed for additional field guidance.",
5270
5261
  "docsTags": [],
5271
5262
  "default": "\"\"",
5272
5263
  "values": [
@@ -5283,7 +5274,7 @@
5283
5274
  "mutable": false,
5284
5275
  "attr": "hide-label",
5285
5276
  "reflectToAttr": false,
5286
- "docs": "Hides the label and applies the required label value as an aria-label.",
5277
+ "docs": "If `true`, the label will be hidden and the required label value will be applied as an aria-label.",
5287
5278
  "docsTags": [],
5288
5279
  "default": "false",
5289
5280
  "values": [
@@ -5300,7 +5291,7 @@
5300
5291
  "mutable": false,
5301
5292
  "attr": "hint-text",
5302
5293
  "reflectToAttr": false,
5303
- "docs": "Provide hint text for hidden assistive description element.",
5294
+ "docs": "The hint text for the hidden assistive description element.",
5304
5295
  "docsTags": [],
5305
5296
  "default": "\"When autocomplete results are available use the up and down arrows to choose and press enter to select\"",
5306
5297
  "values": [
@@ -5317,7 +5308,7 @@
5317
5308
  "mutable": false,
5318
5309
  "attr": "label",
5319
5310
  "reflectToAttr": false,
5320
- "docs": "Provide a label for the input.",
5311
+ "docs": "The label for the search bar.",
5321
5312
  "docsTags": [],
5322
5313
  "values": [
5323
5314
  {
@@ -5349,7 +5340,7 @@
5349
5340
  "type": "IcMenuOption[]",
5350
5341
  "mutable": false,
5351
5342
  "reflectToAttr": false,
5352
- "docs": "Provide the suggested search options",
5343
+ "docs": "The suggested search options.",
5353
5344
  "docsTags": [],
5354
5345
  "default": "[]",
5355
5346
  "values": [
@@ -5366,7 +5357,7 @@
5366
5357
  "mutable": false,
5367
5358
  "attr": "placeholder",
5368
5359
  "reflectToAttr": false,
5369
- "docs": "Provide a placeholder value to display.",
5360
+ "docs": "The placeholder value to display.",
5370
5361
  "docsTags": [],
5371
5362
  "default": "\"Search\"",
5372
5363
  "values": [
@@ -5383,7 +5374,7 @@
5383
5374
  "mutable": false,
5384
5375
  "attr": "readonly",
5385
5376
  "reflectToAttr": false,
5386
- "docs": "Specify whether the input is read only.",
5377
+ "docs": "If `true`, the readonly state will be set.",
5387
5378
  "docsTags": [],
5388
5379
  "default": "false",
5389
5380
  "values": [
@@ -5400,7 +5391,7 @@
5400
5391
  "mutable": false,
5401
5392
  "attr": "required",
5402
5393
  "reflectToAttr": false,
5403
- "docs": "Specify if the input requires a value.",
5394
+ "docs": "If `true`, the search bar will require a value.",
5404
5395
  "docsTags": [],
5405
5396
  "default": "false",
5406
5397
  "values": [
@@ -5417,7 +5408,7 @@
5417
5408
  "mutable": false,
5418
5409
  "attr": "small",
5419
5410
  "reflectToAttr": false,
5420
- "docs": "Specify whether small styling is to be applied to the element.",
5411
+ "docs": "If `true`, the small styling will be applied to the search bar.",
5421
5412
  "docsTags": [],
5422
5413
  "default": "false",
5423
5414
  "values": [
@@ -5434,7 +5425,7 @@
5434
5425
  "mutable": false,
5435
5426
  "attr": "spellcheck",
5436
5427
  "reflectToAttr": false,
5437
- "docs": "If `true`, the element will have its spelling and grammar checked.",
5428
+ "docs": "If `true`, the value of the search will have its spelling and grammar checked.",
5438
5429
  "docsTags": [],
5439
5430
  "default": "false",
5440
5431
  "values": [
@@ -5451,7 +5442,7 @@
5451
5442
  "mutable": true,
5452
5443
  "attr": "value",
5453
5444
  "reflectToAttr": true,
5454
- "docs": "Value of Search input.",
5445
+ "docs": "The value of the search input.",
5455
5446
  "docsTags": [],
5456
5447
  "default": "\"\"",
5457
5448
  "values": [
@@ -5648,7 +5639,7 @@
5648
5639
  "mutable": false,
5649
5640
  "attr": "aligned",
5650
5641
  "reflectToAttr": false,
5651
- "docs": "How the container should be aligned.",
5642
+ "docs": "The alignment of the container.",
5652
5643
  "docsTags": [],
5653
5644
  "default": "\"left\"",
5654
5645
  "values": [
@@ -5674,7 +5665,7 @@
5674
5665
  "mutable": false,
5675
5666
  "attr": "full-height",
5676
5667
  "reflectToAttr": false,
5677
- "docs": "Removes the standard vertical padding from the container.",
5668
+ "docs": "If `true`, the standard vertical padding from the container will be removed.",
5678
5669
  "docsTags": [],
5679
5670
  "default": "false",
5680
5671
  "values": [
@@ -5733,7 +5724,7 @@
5733
5724
  "mutable": false,
5734
5725
  "attr": "characters-until-suggestions",
5735
5726
  "reflectToAttr": false,
5736
- "docs": "Number of characters until suggestions appear for a searchable select.",
5727
+ "docs": "The number of characters until suggestions appear for a searchable select.",
5737
5728
  "docsTags": [],
5738
5729
  "default": "0",
5739
5730
  "values": [
@@ -5750,7 +5741,7 @@
5750
5741
  "mutable": false,
5751
5742
  "attr": "disabled",
5752
5743
  "reflectToAttr": true,
5753
- "docs": "Specify whether the input is disabled.",
5744
+ "docs": "If `true`, the disabled state will be set.",
5754
5745
  "docsTags": [],
5755
5746
  "default": "false",
5756
5747
  "values": [
@@ -5767,7 +5758,7 @@
5767
5758
  "mutable": false,
5768
5759
  "attr": "empty-option-list-text",
5769
5760
  "reflectToAttr": false,
5770
- "docs": "Provide text for empty results list",
5761
+ "docs": "The text displayed when there are no options in the option list.",
5771
5762
  "docsTags": [],
5772
5763
  "default": "\"No results found\"",
5773
5764
  "values": [
@@ -5784,7 +5775,7 @@
5784
5775
  "mutable": false,
5785
5776
  "attr": "full-width",
5786
5777
  "reflectToAttr": false,
5787
- "docs": "If true, then fill width of container.",
5778
+ "docs": "If `true`, the select element will fill the width of the container.",
5788
5779
  "docsTags": [],
5789
5780
  "default": "false",
5790
5781
  "values": [
@@ -5801,7 +5792,7 @@
5801
5792
  "mutable": false,
5802
5793
  "attr": "helper-text",
5803
5794
  "reflectToAttr": false,
5804
- "docs": "Provide helper text to display additional field guidance.",
5795
+ "docs": "The helper text that will be displayed for additional field guidance.",
5805
5796
  "docsTags": [],
5806
5797
  "default": "\"\"",
5807
5798
  "values": [
@@ -5818,7 +5809,7 @@
5818
5809
  "mutable": false,
5819
5810
  "attr": "hide-label",
5820
5811
  "reflectToAttr": false,
5821
- "docs": "Hides the label and applies the required label value as an aria-label.",
5812
+ "docs": "If `true`, the label will be hidden and the required label value will be applied as an aria-label.",
5822
5813
  "docsTags": [],
5823
5814
  "default": "false",
5824
5815
  "values": [
@@ -5835,7 +5826,7 @@
5835
5826
  "mutable": false,
5836
5827
  "attr": "include-descriptions-in-search",
5837
5828
  "reflectToAttr": false,
5838
- "docs": "If true, descriptions of options are included when filtering options in a searchable select.",
5829
+ "docs": "If `true`, descriptions of options will be included when filtering options in a searchable select.",
5839
5830
  "docsTags": [],
5840
5831
  "default": "false",
5841
5832
  "values": [
@@ -5852,7 +5843,7 @@
5852
5843
  "mutable": false,
5853
5844
  "attr": "include-group-titles-in-search",
5854
5845
  "reflectToAttr": false,
5855
- "docs": "If true, group titles of grouped options are included when filtering options in a searchable select.",
5846
+ "docs": "If `true`, group titles of grouped options will be included when filtering options in a searchable select.",
5856
5847
  "docsTags": [],
5857
5848
  "default": "false",
5858
5849
  "values": [
@@ -5869,7 +5860,7 @@
5869
5860
  "mutable": false,
5870
5861
  "attr": "label",
5871
5862
  "reflectToAttr": false,
5872
- "docs": "Provide a label for the input.",
5863
+ "docs": "The label for the select.",
5873
5864
  "docsTags": [],
5874
5865
  "values": [
5875
5866
  {
@@ -5901,7 +5892,7 @@
5901
5892
  "type": "IcMenuOption[]",
5902
5893
  "mutable": false,
5903
5894
  "reflectToAttr": false,
5904
- "docs": "Provide the possible selection options.",
5895
+ "docs": "The possible selection options.",
5905
5896
  "docsTags": [],
5906
5897
  "default": "[]",
5907
5898
  "values": [
@@ -5918,7 +5909,7 @@
5918
5909
  "mutable": false,
5919
5910
  "attr": "placeholder",
5920
5911
  "reflectToAttr": false,
5921
- "docs": "Provide a placeholder value to display.",
5912
+ "docs": "The placeholder value to be displayed.",
5922
5913
  "docsTags": [],
5923
5914
  "default": "\"Select an option\"",
5924
5915
  "values": [
@@ -5935,7 +5926,7 @@
5935
5926
  "mutable": false,
5936
5927
  "attr": "readonly",
5937
5928
  "reflectToAttr": false,
5938
- "docs": "Specify whether the input is read only.",
5929
+ "docs": "If `true`, the readonly state will be set.",
5939
5930
  "docsTags": [],
5940
5931
  "default": "false",
5941
5932
  "values": [
@@ -5952,7 +5943,7 @@
5952
5943
  "mutable": false,
5953
5944
  "attr": "required",
5954
5945
  "reflectToAttr": false,
5955
- "docs": "Specify if the input requires a value.",
5946
+ "docs": "If `true`, the select will require a value.",
5956
5947
  "docsTags": [],
5957
5948
  "default": "false",
5958
5949
  "values": [
@@ -5991,7 +5982,7 @@
5991
5982
  "mutable": false,
5992
5983
  "attr": "searchable",
5993
5984
  "reflectToAttr": false,
5994
- "docs": "If true, the select can be typed in to filter options.",
5985
+ "docs": "If `true`, a searchable variant of the select will be displayed which can be typed in to filter options.",
5995
5986
  "docsTags": [],
5996
5987
  "default": "false",
5997
5988
  "values": [
@@ -6008,7 +5999,7 @@
6008
5999
  "mutable": false,
6009
6000
  "attr": "show-clear-button",
6010
6001
  "reflectToAttr": false,
6011
- "docs": "Display a button which clears the input when clicked. The button will always appear on the searchable select.",
6002
+ "docs": "If `true`, a button which clears the select input when clicked will be displayed. The button will always appear on the searchable select.",
6012
6003
  "docsTags": [],
6013
6004
  "default": "false",
6014
6005
  "values": [
@@ -6025,7 +6016,7 @@
6025
6016
  "mutable": false,
6026
6017
  "attr": "small",
6027
6018
  "reflectToAttr": false,
6028
- "docs": "Specify whether small styling is to be applied to the element.",
6019
+ "docs": "If `true`, the small styling will be applied to the select.",
6029
6020
  "docsTags": [],
6030
6021
  "default": "false",
6031
6022
  "values": [
@@ -6042,7 +6033,7 @@
6042
6033
  "mutable": false,
6043
6034
  "attr": "validation-status",
6044
6035
  "reflectToAttr": false,
6045
- "docs": "Provide a validation status.",
6036
+ "docs": "The validation status - e.g. 'error' | 'warning' | 'success'.",
6046
6037
  "docsTags": [],
6047
6038
  "default": "\"\"",
6048
6039
  "values": [
@@ -6071,7 +6062,7 @@
6071
6062
  "mutable": false,
6072
6063
  "attr": "validation-text",
6073
6064
  "reflectToAttr": false,
6074
- "docs": "Provide the text to display as the validation message.",
6065
+ "docs": "The text to display as the validation message.",
6075
6066
  "docsTags": [],
6076
6067
  "default": "\"\"",
6077
6068
  "values": [
@@ -6201,15 +6192,15 @@
6201
6192
  "docsTags": [
6202
6193
  {
6203
6194
  "name": "slot",
6204
- "text": "app-icon - Content will be rendered adjacent to the application title at the very top of the side navigation"
6195
+ "text": "app-icon - Content will be rendered adjacent to the app title at the very top of the side navigation."
6205
6196
  },
6206
6197
  {
6207
6198
  "name": "slot",
6208
- "text": "primary-navigation - Content will be rendered at the top of the side navigation"
6199
+ "text": "primary-navigation - Content will be rendered at the top of the side navigation."
6209
6200
  },
6210
6201
  {
6211
6202
  "name": "slot",
6212
- "text": "secondary-navigation - Content will be rendered at the bottom of the side navigation"
6203
+ "text": "secondary-navigation - Content will be rendered at the bottom of the side navigation."
6213
6204
  }
6214
6205
  ],
6215
6206
  "usage": {},
@@ -6220,7 +6211,7 @@
6220
6211
  "mutable": false,
6221
6212
  "attr": "app-title",
6222
6213
  "reflectToAttr": false,
6223
- "docs": "Title to display.",
6214
+ "docs": "The title of the app to be displayed.",
6224
6215
  "docsTags": [],
6225
6216
  "values": [
6226
6217
  {
@@ -6236,7 +6227,7 @@
6236
6227
  "mutable": false,
6237
6228
  "attr": "collapsed-icon-labels",
6238
6229
  "reflectToAttr": false,
6239
- "docs": "If true, the icon and label will appear when side navigation is collapsed",
6230
+ "docs": "If `true`, the icon and label will appear when side navigation is collapsed.",
6240
6231
  "docsTags": [],
6241
6232
  "default": "false",
6242
6233
  "values": [
@@ -6253,7 +6244,7 @@
6253
6244
  "mutable": false,
6254
6245
  "attr": "disable-auto-parent-styling",
6255
6246
  "reflectToAttr": false,
6256
- "docs": "If true, disable automatic parent wrapper styling",
6247
+ "docs": "If `true`, automatic parent wrapper styling will be disabled.",
6257
6248
  "docsTags": [],
6258
6249
  "default": "false",
6259
6250
  "values": [
@@ -6270,7 +6261,7 @@
6270
6261
  "mutable": false,
6271
6262
  "attr": "expanded",
6272
6263
  "reflectToAttr": false,
6273
- "docs": "If true, the ic-side-navigation will load in an expanded state",
6264
+ "docs": "If `true`, the side navigation will load in an expanded state.",
6274
6265
  "docsTags": [],
6275
6266
  "default": "false",
6276
6267
  "values": [
@@ -6287,7 +6278,7 @@
6287
6278
  "mutable": false,
6288
6279
  "attr": "href",
6289
6280
  "reflectToAttr": false,
6290
- "docs": "Set application title link",
6281
+ "docs": "The URL that the app title link points to.",
6291
6282
  "docsTags": [],
6292
6283
  "default": "\"/\"",
6293
6284
  "values": [
@@ -6304,7 +6295,7 @@
6304
6295
  "mutable": false,
6305
6296
  "attr": "inline",
6306
6297
  "reflectToAttr": false,
6307
- "docs": "If true, side navigation will be contained by parent element",
6298
+ "docs": "If `true`, side navigation will be contained by its parent element.",
6308
6299
  "docsTags": [],
6309
6300
  "default": "false",
6310
6301
  "values": [
@@ -6321,7 +6312,7 @@
6321
6312
  "mutable": false,
6322
6313
  "attr": "static",
6323
6314
  "reflectToAttr": false,
6324
- "docs": "If true, the menu expand button is removed (PLEASE NOTE: This takes effect on screen sizes 992px and above)",
6315
+ "docs": "If `true`, the menu expand button will be removed (PLEASE NOTE: This takes effect on screen sizes 992px and above).",
6325
6316
  "docsTags": [],
6326
6317
  "default": "false",
6327
6318
  "values": [
@@ -6338,7 +6329,7 @@
6338
6329
  "mutable": false,
6339
6330
  "attr": "status",
6340
6331
  "reflectToAttr": false,
6341
- "docs": "Status of application",
6332
+ "docs": "The status of the app to be displayed.",
6342
6333
  "docsTags": [],
6343
6334
  "values": [
6344
6335
  {
@@ -6354,7 +6345,7 @@
6354
6345
  "mutable": false,
6355
6346
  "attr": "version",
6356
6347
  "reflectToAttr": false,
6357
- "docs": "Version of application",
6348
+ "docs": "The version of the app to be displayed.",
6358
6349
  "docsTags": [],
6359
6350
  "values": [
6360
6351
  {
@@ -6379,15 +6370,15 @@
6379
6370
  "slots": [
6380
6371
  {
6381
6372
  "name": "app-icon",
6382
- "docs": "Content will be rendered adjacent to the application title at the very top of the side navigation"
6373
+ "docs": "Content will be rendered adjacent to the app title at the very top of the side navigation."
6383
6374
  },
6384
6375
  {
6385
6376
  "name": "primary-navigation",
6386
- "docs": "Content will be rendered at the top of the side navigation"
6377
+ "docs": "Content will be rendered at the top of the side navigation."
6387
6378
  },
6388
6379
  {
6389
6380
  "name": "secondary-navigation",
6390
- "docs": "Content will be rendered at the bottom of the side navigation"
6381
+ "docs": "Content will be rendered at the bottom of the side navigation."
6391
6382
  }
6392
6383
  ],
6393
6384
  "parts": [],
@@ -6430,7 +6421,7 @@
6430
6421
  "mutable": false,
6431
6422
  "attr": "light",
6432
6423
  "reflectToAttr": false,
6433
- "docs": "Set the skeleton to the light variant",
6424
+ "docs": "If `true`, the skeleton will be set to the light variant.",
6434
6425
  "docsTags": [],
6435
6426
  "default": "false",
6436
6427
  "values": [
@@ -6447,7 +6438,7 @@
6447
6438
  "mutable": false,
6448
6439
  "attr": "variant",
6449
6440
  "reflectToAttr": false,
6450
- "docs": "The variant of the skeleton that will be displayed",
6441
+ "docs": "The variant of the skeleton that will be displayed.",
6451
6442
  "docsTags": [],
6452
6443
  "default": "\"rectangle\"",
6453
6444
  "values": [
@@ -6531,7 +6522,7 @@
6531
6522
  "mutable": false,
6532
6523
  "attr": "small",
6533
6524
  "reflectToAttr": false,
6534
- "docs": "The size of the status tag.",
6525
+ "docs": "If `true`, the small styling will be applied to the status tag.",
6535
6526
  "docsTags": [],
6536
6527
  "default": "false",
6537
6528
  "values": [
@@ -6604,7 +6595,7 @@
6604
6595
  "mutable": false,
6605
6596
  "attr": "step-subtitle",
6606
6597
  "reflectToAttr": false,
6607
- "docs": "Additional information about step",
6598
+ "docs": "The additional information about the step.",
6608
6599
  "docsTags": [],
6609
6600
  "values": [
6610
6601
  {
@@ -6620,7 +6611,7 @@
6620
6611
  "mutable": false,
6621
6612
  "attr": "step-title",
6622
6613
  "reflectToAttr": false,
6623
- "docs": "Name of step",
6614
+ "docs": "The name of the step within the stepper.",
6624
6615
  "docsTags": [],
6625
6616
  "values": [
6626
6617
  {
@@ -6636,7 +6627,7 @@
6636
6627
  "mutable": false,
6637
6628
  "attr": "step-type",
6638
6629
  "reflectToAttr": false,
6639
- "docs": "State of step",
6630
+ "docs": "The state of the step within the stepper.",
6640
6631
  "docsTags": [],
6641
6632
  "default": "\"active\"",
6642
6633
  "values": [
@@ -6692,7 +6683,7 @@
6692
6683
  "mutable": false,
6693
6684
  "attr": "aligned",
6694
6685
  "reflectToAttr": false,
6695
- "docs": "How the stepper should be aligned in its container.",
6686
+ "docs": "The alignment of the stepper within its container.",
6696
6687
  "docsTags": [],
6697
6688
  "default": "\"full-width\"",
6698
6689
  "values": [
@@ -6756,7 +6747,7 @@
6756
6747
  "mutable": false,
6757
6748
  "attr": "checked",
6758
6749
  "reflectToAttr": false,
6759
- "docs": "If true, the component is checked.",
6750
+ "docs": "If `true`, the switch will display as checked.",
6760
6751
  "docsTags": [],
6761
6752
  "default": "false",
6762
6753
  "values": [
@@ -6773,7 +6764,7 @@
6773
6764
  "mutable": false,
6774
6765
  "attr": "disabled",
6775
6766
  "reflectToAttr": false,
6776
- "docs": "If true, the component is not interactive.",
6767
+ "docs": "If `true`, the disabled state will be set.",
6777
6768
  "docsTags": [],
6778
6769
  "default": "false",
6779
6770
  "values": [
@@ -6790,7 +6781,7 @@
6790
6781
  "mutable": false,
6791
6782
  "attr": "helper-text",
6792
6783
  "reflectToAttr": false,
6793
- "docs": "Provide helper text to display additional field guidance.",
6784
+ "docs": "The helper text that will be displayed for additional field guidance.",
6794
6785
  "docsTags": [],
6795
6786
  "default": "\"\"",
6796
6787
  "values": [
@@ -6807,7 +6798,7 @@
6807
6798
  "mutable": false,
6808
6799
  "attr": "hide-label",
6809
6800
  "reflectToAttr": false,
6810
- "docs": "Hides the label and applies the required label value as an aria-label.",
6801
+ "docs": "If `true`, the label will be hidden and the required label value will be applied as an aria-label.",
6811
6802
  "docsTags": [],
6812
6803
  "default": "false",
6813
6804
  "values": [
@@ -6824,7 +6815,7 @@
6824
6815
  "mutable": false,
6825
6816
  "attr": "label",
6826
6817
  "reflectToAttr": false,
6827
- "docs": "Applies an aria-label to the component, for when no visual 'name' is provided.",
6818
+ "docs": "The aria-label applied to the switch when no visual 'name' is provided.",
6828
6819
  "docsTags": [],
6829
6820
  "values": [
6830
6821
  {
@@ -6857,7 +6848,7 @@
6857
6848
  "mutable": false,
6858
6849
  "attr": "show-state",
6859
6850
  "reflectToAttr": false,
6860
- "docs": "If true, the component will render the On/Off state text.",
6851
+ "docs": "If `true`, the switch will render the On/Off state text.",
6861
6852
  "docsTags": [],
6862
6853
  "default": "false",
6863
6854
  "values": [
@@ -6874,7 +6865,7 @@
6874
6865
  "mutable": false,
6875
6866
  "attr": "small",
6876
6867
  "reflectToAttr": false,
6877
- "docs": "If true, the component reduces in size to the small state.",
6868
+ "docs": "If `true`, the small styling will be applied to the switch.",
6878
6869
  "docsTags": [],
6879
6870
  "default": "false",
6880
6871
  "values": [
@@ -6977,7 +6968,7 @@
6977
6968
  "mutable": false,
6978
6969
  "attr": "disabled",
6979
6970
  "reflectToAttr": false,
6980
- "docs": "Disables the tab.",
6971
+ "docs": "If `true`, the disabled state will be set.",
6981
6972
  "docsTags": [],
6982
6973
  "default": "false",
6983
6974
  "values": [
@@ -6997,7 +6988,7 @@
6997
6988
  "bubbles": true,
6998
6989
  "cancelable": true,
6999
6990
  "composed": true,
7000
- "docs": "Called when a tab is selected.",
6991
+ "docs": "Emitted when a tab is selected.",
7001
6992
  "docsTags": []
7002
6993
  }
7003
6994
  ],
@@ -7057,7 +7048,7 @@
7057
7048
  "mutable": false,
7058
7049
  "attr": "appearance",
7059
7050
  "reflectToAttr": false,
7060
- "docs": "Determines whether the light or dark variant of the tabs should be displayed.",
7051
+ "docs": "The appearance of the tab context, e.g dark, or light.",
7061
7052
  "docsTags": [],
7062
7053
  "default": "\"dark\"",
7063
7054
  "values": [
@@ -7079,7 +7070,7 @@
7079
7070
  "mutable": false,
7080
7071
  "attr": "context-id",
7081
7072
  "reflectToAttr": true,
7082
- "docs": "Provide a unique context if using multiple tabs inside one another i.e. rendering another set of tabs inside a tab panel.",
7073
+ "docs": "The unique context needed if using multiple tabs inside one another i.e. rendering another set of tabs inside a tab panel.",
7083
7074
  "docsTags": [],
7084
7075
  "default": "\"default\"",
7085
7076
  "values": [
@@ -7096,7 +7087,7 @@
7096
7087
  "mutable": false,
7097
7088
  "attr": "selected-tab-index",
7098
7089
  "reflectToAttr": false,
7099
- "docs": "Allows the user to control the selected tab. Must be used alongside the tabSelect event to manage tab selection.",
7090
+ "docs": "The selected tab to be controlled by the user. Must be used alongside the tabSelect event to manage tab selection.",
7100
7091
  "docsTags": [],
7101
7092
  "values": [
7102
7093
  {
@@ -7148,7 +7139,7 @@
7148
7139
  "mutable": false,
7149
7140
  "attr": "context-id",
7150
7141
  "reflectToAttr": true,
7151
- "docs": "Provide a unique context if using multiple tabs inside one another i.e. rendering another set of tabs inside a tab panel.",
7142
+ "docs": "The unique context needed if using multiple tabs inside one another i.e. rendering another set of tabs inside a tab panel.",
7152
7143
  "docsTags": [],
7153
7144
  "default": "\"default\"",
7154
7145
  "values": [
@@ -7165,7 +7156,7 @@
7165
7156
  "mutable": false,
7166
7157
  "attr": "inline",
7167
7158
  "reflectToAttr": true,
7168
- "docs": "Use when tabs and tab panels are to be positioned separately.",
7159
+ "docs": "If `true`, the tabs and tab panels will be positioned separately.",
7169
7160
  "docsTags": [],
7170
7161
  "default": "false",
7171
7162
  "values": [
@@ -7182,7 +7173,7 @@
7182
7173
  "mutable": false,
7183
7174
  "attr": "label",
7184
7175
  "reflectToAttr": false,
7185
- "docs": "Provide a label to describe the purpose of the set of tabs to screen reader users.",
7176
+ "docs": "The label to describe the purpose of the set of tabs to screen reader users.",
7186
7177
  "docsTags": [],
7187
7178
  "values": [
7188
7179
  {
@@ -7233,7 +7224,7 @@
7233
7224
  "mutable": false,
7234
7225
  "attr": "context-id",
7235
7226
  "reflectToAttr": true,
7236
- "docs": "Provide a unique context if using multiple tabs inside one another i.e. rendering another tabs inside a tab panel.",
7227
+ "docs": "The unique context needed if using multiple tabs inside one another i.e. rendering another tabs inside a tab panel.",
7237
7228
  "docsTags": [],
7238
7229
  "default": "\"default\"",
7239
7230
  "values": [
@@ -7275,7 +7266,7 @@
7275
7266
  "mutable": false,
7276
7267
  "attr": "auto-focus",
7277
7268
  "reflectToAttr": false,
7278
- "docs": "This Boolean attribute lets you specify that a form control should have input focus when the page loads.",
7269
+ "docs": "If `true`, the form control will have input focus when the page loads.",
7279
7270
  "docsTags": [],
7280
7271
  "default": "false",
7281
7272
  "values": [
@@ -7292,7 +7283,7 @@
7292
7283
  "mutable": false,
7293
7284
  "attr": "autocapitalize",
7294
7285
  "reflectToAttr": false,
7295
- "docs": "Indicates whether and how the text value should be automatically capitalized as it is entered/edited by the user.\nAvailable options: \"off\", \"none\", \"on\", \"sentences\", \"words\", \"characters\".",
7286
+ "docs": "The automatic capitalisation of the text value as it is entered/edited by the user.\nAvailable options: \"off\", \"none\", \"on\", \"sentences\", \"words\", \"characters\".",
7296
7287
  "docsTags": [],
7297
7288
  "default": "\"off\"",
7298
7289
  "values": [
@@ -7309,7 +7300,7 @@
7309
7300
  "mutable": false,
7310
7301
  "attr": "autocomplete",
7311
7302
  "reflectToAttr": false,
7312
- "docs": "Indicates whether the value of the control can be automatically completed by the browser.",
7303
+ "docs": "The state of autocompletion the browser can apply on the text value.",
7313
7304
  "docsTags": [],
7314
7305
  "default": "\"off\"",
7315
7306
  "values": [
@@ -7539,7 +7530,7 @@
7539
7530
  "mutable": false,
7540
7531
  "attr": "autocorrect",
7541
7532
  "reflectToAttr": false,
7542
- "docs": "Whether auto correction should be enabled when the user is entering/editing the text value.",
7533
+ "docs": "The state of autocorrection the browser can apply when the user is entering/editing the text value.",
7543
7534
  "docsTags": [],
7544
7535
  "default": "\"off\"",
7545
7536
  "values": [
@@ -7561,7 +7552,7 @@
7561
7552
  "mutable": false,
7562
7553
  "attr": "debounce",
7563
7554
  "reflectToAttr": false,
7564
- "docs": "Set the amount of time, in milliseconds, to wait to trigger the `icChange` event after each keystroke.",
7555
+ "docs": "The amount of time, in milliseconds, to wait to trigger the `icChange` event after each keystroke.",
7565
7556
  "docsTags": [],
7566
7557
  "default": "0",
7567
7558
  "values": [
@@ -7578,7 +7569,7 @@
7578
7569
  "mutable": false,
7579
7570
  "attr": "disabled",
7580
7571
  "reflectToAttr": false,
7581
- "docs": "Specify whether the input is disabled.",
7572
+ "docs": "If `true`, the disabled state will be set.",
7582
7573
  "docsTags": [],
7583
7574
  "default": "false",
7584
7575
  "values": [
@@ -7595,7 +7586,7 @@
7595
7586
  "mutable": false,
7596
7587
  "attr": "full-width",
7597
7588
  "reflectToAttr": false,
7598
- "docs": "Specify whether the component fills the full width of the container.\nIf true, this overrides the --input-width css prop.",
7589
+ "docs": "Specify whether the text field fills the full width of the container.\nIf `true`, this overrides the --input-width CSS variable.",
7599
7590
  "docsTags": [],
7600
7591
  "default": "false",
7601
7592
  "values": [
@@ -7612,7 +7603,7 @@
7612
7603
  "mutable": false,
7613
7604
  "attr": "helper-text",
7614
7605
  "reflectToAttr": false,
7615
- "docs": "Provide helper text to display additional field guidance.",
7606
+ "docs": "The helper text that will be displayed for additional field guidance.",
7616
7607
  "docsTags": [],
7617
7608
  "default": "\"\"",
7618
7609
  "values": [
@@ -7629,7 +7620,7 @@
7629
7620
  "mutable": false,
7630
7621
  "attr": "hide-label",
7631
7622
  "reflectToAttr": false,
7632
- "docs": "Hides the label and applies the required label value as an aria-label.",
7623
+ "docs": "If `true`, the label will be hidden and the required label value will be applied as an aria-label.",
7633
7624
  "docsTags": [],
7634
7625
  "default": "false",
7635
7626
  "values": [
@@ -7646,7 +7637,7 @@
7646
7637
  "mutable": false,
7647
7638
  "attr": "input-id",
7648
7639
  "reflectToAttr": false,
7649
- "docs": "Provide an id for the input",
7640
+ "docs": "The ID for the input.",
7650
7641
  "docsTags": [],
7651
7642
  "default": "`ic-text-field-input-${inputIds++}`",
7652
7643
  "values": [
@@ -7709,7 +7700,7 @@
7709
7700
  "mutable": false,
7710
7701
  "attr": "label",
7711
7702
  "reflectToAttr": false,
7712
- "docs": "Provide a label for the input.",
7703
+ "docs": "The label for the input.",
7713
7704
  "docsTags": [],
7714
7705
  "values": [
7715
7706
  {
@@ -7725,7 +7716,7 @@
7725
7716
  "mutable": false,
7726
7717
  "attr": "max-length",
7727
7718
  "reflectToAttr": false,
7728
- "docs": "Maximum number of characters that can be entered in the field.",
7719
+ "docs": "The maximum number of characters that can be entered in the field.",
7729
7720
  "docsTags": [],
7730
7721
  "default": "0",
7731
7722
  "values": [
@@ -7759,7 +7750,7 @@
7759
7750
  "mutable": false,
7760
7751
  "attr": "placeholder",
7761
7752
  "reflectToAttr": false,
7762
- "docs": "Provide a placeholder value to display.",
7753
+ "docs": "The placeholder value to be displayed.",
7763
7754
  "docsTags": [],
7764
7755
  "default": "\"\"",
7765
7756
  "values": [
@@ -7776,7 +7767,7 @@
7776
7767
  "mutable": false,
7777
7768
  "attr": "readonly",
7778
7769
  "reflectToAttr": false,
7779
- "docs": "Specify whether the input is read only.",
7770
+ "docs": "If `true`, the read only state will be set.",
7780
7771
  "docsTags": [],
7781
7772
  "default": "false",
7782
7773
  "values": [
@@ -7793,7 +7784,7 @@
7793
7784
  "mutable": false,
7794
7785
  "attr": "required",
7795
7786
  "reflectToAttr": false,
7796
- "docs": "Specify if the input requires a value.",
7787
+ "docs": "If `true`, the input will require a value.",
7797
7788
  "docsTags": [],
7798
7789
  "default": "false",
7799
7790
  "values": [
@@ -7810,7 +7801,7 @@
7810
7801
  "mutable": false,
7811
7802
  "attr": "resize",
7812
7803
  "reflectToAttr": false,
7813
- "docs": "Allow resizing of a multiline text area",
7804
+ "docs": "If `true`, the multiline text area will be resizeable.",
7814
7805
  "docsTags": [],
7815
7806
  "default": "false",
7816
7807
  "values": [
@@ -7827,7 +7818,7 @@
7827
7818
  "mutable": false,
7828
7819
  "attr": "rows",
7829
7820
  "reflectToAttr": false,
7830
- "docs": "Specify the number of rows to transform the text field into a text area with a specific height.",
7821
+ "docs": "The number of rows to transform the text field into a text area with a specific height.",
7831
7822
  "docsTags": [],
7832
7823
  "default": "1",
7833
7824
  "values": [
@@ -7844,7 +7835,7 @@
7844
7835
  "mutable": false,
7845
7836
  "attr": "small",
7846
7837
  "reflectToAttr": false,
7847
- "docs": "Specify whether small styling is to be applied to the element.",
7838
+ "docs": "If `true`, the small styling will be applied to the text field.",
7848
7839
  "docsTags": [],
7849
7840
  "default": "false",
7850
7841
  "values": [
@@ -7861,7 +7852,7 @@
7861
7852
  "mutable": false,
7862
7853
  "attr": "spellcheck",
7863
7854
  "reflectToAttr": false,
7864
- "docs": "If `true`, the element will have its spelling and grammar checked.",
7855
+ "docs": "If `true`, the value of the text field will have its spelling and grammar checked.",
7865
7856
  "docsTags": [],
7866
7857
  "default": "false",
7867
7858
  "values": [
@@ -7920,7 +7911,7 @@
7920
7911
  "mutable": false,
7921
7912
  "attr": "validation-inline",
7922
7913
  "reflectToAttr": false,
7923
- "docs": "Show icon in input control - only applies when validationStatus ='success'",
7914
+ "docs": "If `true`, the icon in input control will be displayed - only applies when validationStatus ='success'.",
7924
7915
  "docsTags": [],
7925
7916
  "default": "false",
7926
7917
  "values": [
@@ -7937,7 +7928,7 @@
7937
7928
  "mutable": false,
7938
7929
  "attr": "validation-status",
7939
7930
  "reflectToAttr": false,
7940
- "docs": "Provide validation state - 'error' | 'warning' | 'success'",
7931
+ "docs": "The validation state - e.g. 'error' | 'warning' | 'success'.",
7941
7932
  "docsTags": [],
7942
7933
  "default": "\"\"",
7943
7934
  "values": [
@@ -7966,7 +7957,7 @@
7966
7957
  "mutable": false,
7967
7958
  "attr": "validation-text",
7968
7959
  "reflectToAttr": false,
7969
- "docs": "Provide validation state - 'error' | 'warning' | 'success'",
7960
+ "docs": "The validation state - e.g. 'error' | 'warning' | 'success'.",
7970
7961
  "docsTags": [],
7971
7962
  "default": "\"\"",
7972
7963
  "values": [
@@ -7983,7 +7974,7 @@
7983
7974
  "mutable": true,
7984
7975
  "attr": "value",
7985
7976
  "reflectToAttr": true,
7986
- "docs": "Value of TextField.",
7977
+ "docs": "The value of the text field.",
7987
7978
  "docsTags": [],
7988
7979
  "default": "\"\"",
7989
7980
  "values": [
@@ -8120,7 +8111,7 @@
8120
8111
  "mutable": false,
8121
8112
  "attr": "color",
8122
8113
  "reflectToAttr": false,
8123
- "docs": "The theme colour. Can be a hex value eg \"#ff0000\" or RGB eg \"rgb(255, 0, 0)\"",
8114
+ "docs": "The theme colour. Can be a hex value e.g. \"#ff0000\", RGB e.g. \"rgb(255, 0, 0)\", or RGBA e.g. \"rgba(255, 0, 0, 1)\".",
8124
8115
  "docsTags": [],
8125
8116
  "default": "null",
8126
8117
  "values": [
@@ -8321,7 +8312,7 @@
8321
8312
  "mutable": false,
8322
8313
  "attr": "app-title",
8323
8314
  "reflectToAttr": false,
8324
- "docs": "Title to display",
8315
+ "docs": "The app title to be displayed.",
8325
8316
  "docsTags": [],
8326
8317
  "values": [
8327
8318
  {
@@ -8337,7 +8328,7 @@
8337
8328
  "mutable": false,
8338
8329
  "attr": "content-aligned",
8339
8330
  "reflectToAttr": false,
8340
- "docs": "The alignment of the top nav content",
8331
+ "docs": "The alignment of the top navigation content.",
8341
8332
  "docsTags": [],
8342
8333
  "default": "\"full-width\"",
8343
8334
  "values": [
@@ -8363,7 +8354,7 @@
8363
8354
  "mutable": false,
8364
8355
  "attr": "href",
8365
8356
  "reflectToAttr": false,
8366
- "docs": "The url to navigate to when title is clicked",
8357
+ "docs": "The URL to navigate to when the app title is clicked.",
8367
8358
  "docsTags": [],
8368
8359
  "default": "\"/\"",
8369
8360
  "values": [
@@ -8380,7 +8371,7 @@
8380
8371
  "mutable": false,
8381
8372
  "attr": "inline",
8382
8373
  "reflectToAttr": false,
8383
- "docs": "If true, the flyout navigation menu on small devices will be contained by the parent element",
8374
+ "docs": "If `true`, the flyout navigation menu on small devices will be contained by the parent element.",
8384
8375
  "docsTags": [],
8385
8376
  "default": "false",
8386
8377
  "values": [
@@ -8397,7 +8388,7 @@
8397
8388
  "mutable": false,
8398
8389
  "attr": "status",
8399
8390
  "reflectToAttr": false,
8400
- "docs": "Status info to display",
8391
+ "docs": "The status info to be displayed.",
8401
8392
  "docsTags": [],
8402
8393
  "default": "\"\"",
8403
8394
  "values": [
@@ -8414,7 +8405,7 @@
8414
8405
  "mutable": false,
8415
8406
  "attr": "version",
8416
8407
  "reflectToAttr": false,
8417
- "docs": "Version info to display",
8408
+ "docs": "The version info to be displayed.",
8418
8409
  "docsTags": [],
8419
8410
  "default": "\"\"",
8420
8411
  "values": [
@@ -8520,7 +8511,7 @@
8520
8511
  "mutable": false,
8521
8512
  "attr": "apply-vertical-margins",
8522
8513
  "reflectToAttr": false,
8523
- "docs": "Adds appropriate margins to the top and bottom of the typography.",
8514
+ "docs": "If `true`, appropriate top and bottom margins will be applied to the typography.",
8524
8515
  "docsTags": [],
8525
8516
  "default": "false",
8526
8517
  "values": [