@ukic/docs 2.1.0-beta.0 → 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 (3) hide show
  1. package/docs.d.ts +1 -1
  2. package/docs.json +279 -282
  3. package/package.json +2 -2
package/docs.json CHANGED
@@ -1,9 +1,9 @@
1
1
  {
2
- "timestamp": "2022-12-01T15:41:36",
2
+ "timestamp": "2023-01-10T14:45:33",
3
3
  "compiler": {
4
4
  "name": "@stencil/core",
5
- "version": "2.19.1",
6
- "typescriptVersion": "4.7.4"
5
+ "version": "2.20.0",
6
+ "typescriptVersion": "4.8.4"
7
7
  },
8
8
  "components": [
9
9
  {
@@ -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
  {
@@ -1066,6 +1066,12 @@
1066
1066
  "event": "click",
1067
1067
  "capture": true,
1068
1068
  "passive": false
1069
+ },
1070
+ {
1071
+ "event": "icThemeChange",
1072
+ "target": "document",
1073
+ "capture": false,
1074
+ "passive": false
1069
1075
  }
1070
1076
  ],
1071
1077
  "styles": [],
@@ -1109,7 +1115,7 @@
1109
1115
  "mutable": false,
1110
1116
  "attr": "additional-field-display",
1111
1117
  "reflectToAttr": true,
1112
- "docs": "Set which style of additionalField will be displayed if used",
1118
+ "docs": "The style of additionalField that will be displayed if used.",
1113
1119
  "docsTags": [],
1114
1120
  "default": "\"static\"",
1115
1121
  "values": [
@@ -1131,7 +1137,7 @@
1131
1137
  "mutable": true,
1132
1138
  "attr": "checked",
1133
1139
  "reflectToAttr": true,
1134
- "docs": "Set the checkbox to the checked state",
1140
+ "docs": "If `true`, the checkbox will be set to the checked state.",
1135
1141
  "docsTags": [],
1136
1142
  "default": "false",
1137
1143
  "values": [
@@ -1148,7 +1154,7 @@
1148
1154
  "mutable": false,
1149
1155
  "attr": "disabled",
1150
1156
  "reflectToAttr": false,
1151
- "docs": "Set the checkbox to the disabled state",
1157
+ "docs": "If `true`, the checkbox will be set to the disabled state.",
1152
1158
  "docsTags": [],
1153
1159
  "default": "false",
1154
1160
  "values": [
@@ -1165,7 +1171,7 @@
1165
1171
  "mutable": false,
1166
1172
  "attr": "dynamic-text",
1167
1173
  "reflectToAttr": false,
1168
- "docs": "Provide a text prop for the dynamic text",
1174
+ "docs": "The text to be displayed when dynamic.",
1169
1175
  "docsTags": [],
1170
1176
  "default": "\"This selection requires additional answers\"",
1171
1177
  "values": [
@@ -1182,7 +1188,7 @@
1182
1188
  "mutable": false,
1183
1189
  "attr": "group-label",
1184
1190
  "reflectToAttr": false,
1185
- "docs": "Provide a group label for the input",
1191
+ "docs": "The group label for the checkbox.",
1186
1192
  "docsTags": [],
1187
1193
  "values": [
1188
1194
  {
@@ -1198,7 +1204,7 @@
1198
1204
  "mutable": false,
1199
1205
  "attr": "indeterminate",
1200
1206
  "reflectToAttr": false,
1201
- "docs": "Display the indeterminate state when checked",
1207
+ "docs": "If `true`, the indeterminate state will be displayed when checked.",
1202
1208
  "docsTags": [],
1203
1209
  "default": "false",
1204
1210
  "values": [
@@ -1215,7 +1221,7 @@
1215
1221
  "mutable": false,
1216
1222
  "attr": "label",
1217
1223
  "reflectToAttr": false,
1218
- "docs": "Provide a label for the input",
1224
+ "docs": "The label for the checkbox.",
1219
1225
  "docsTags": [],
1220
1226
  "values": [
1221
1227
  {
@@ -1231,7 +1237,7 @@
1231
1237
  "mutable": false,
1232
1238
  "attr": "name",
1233
1239
  "reflectToAttr": false,
1234
- "docs": "Provide a name for the input",
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.",
1235
1241
  "docsTags": [],
1236
1242
  "values": [
1237
1243
  {
@@ -1247,7 +1253,7 @@
1247
1253
  "mutable": false,
1248
1254
  "attr": "value",
1249
1255
  "reflectToAttr": false,
1250
- "docs": "Provide a value for the input",
1256
+ "docs": "The value for the checkbox.",
1251
1257
  "docsTags": [],
1252
1258
  "values": [
1253
1259
  {
@@ -1299,7 +1305,7 @@
1299
1305
  "mutable": false,
1300
1306
  "attr": "disabled",
1301
1307
  "reflectToAttr": false,
1302
- "docs": "Specify whether the input is disabled.",
1308
+ "docs": "If `true`, the checkbox group will be set to the disabled state.",
1303
1309
  "docsTags": [],
1304
1310
  "default": "false",
1305
1311
  "values": [
@@ -1316,7 +1322,7 @@
1316
1322
  "mutable": false,
1317
1323
  "attr": "helper-text",
1318
1324
  "reflectToAttr": false,
1319
- "docs": "Provide helper text to display additional field guidance.",
1325
+ "docs": "The helper text that will be displayed for additional field guidance.",
1320
1326
  "docsTags": [],
1321
1327
  "default": "\"\"",
1322
1328
  "values": [
@@ -1333,7 +1339,7 @@
1333
1339
  "mutable": false,
1334
1340
  "attr": "hide-label",
1335
1341
  "reflectToAttr": false,
1336
- "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.",
1337
1343
  "docsTags": [],
1338
1344
  "default": "false",
1339
1345
  "values": [
@@ -1350,7 +1356,7 @@
1350
1356
  "mutable": false,
1351
1357
  "attr": "label",
1352
1358
  "reflectToAttr": false,
1353
- "docs": "Provide a label for the input.",
1359
+ "docs": "The label for the checkbox group to be displayed.",
1354
1360
  "docsTags": [],
1355
1361
  "values": [
1356
1362
  {
@@ -1366,7 +1372,7 @@
1366
1372
  "mutable": false,
1367
1373
  "attr": "name",
1368
1374
  "reflectToAttr": false,
1369
- "docs": "Provide a name for the input.",
1375
+ "docs": "The name for the checkbox group to differentiate from other groups.",
1370
1376
  "docsTags": [],
1371
1377
  "values": [
1372
1378
  {
@@ -1382,7 +1388,7 @@
1382
1388
  "mutable": false,
1383
1389
  "attr": "required",
1384
1390
  "reflectToAttr": false,
1385
- "docs": "Specify if the input requires a value.",
1391
+ "docs": "If `true`, the checkbox group will require a value.",
1386
1392
  "docsTags": [],
1387
1393
  "default": "false",
1388
1394
  "values": [
@@ -1399,7 +1405,7 @@
1399
1405
  "mutable": false,
1400
1406
  "attr": "small",
1401
1407
  "reflectToAttr": false,
1402
- "docs": "Specify whether small styling to be applied to element.",
1408
+ "docs": "If `true`, the small styling will be applied to the checkbox group.",
1403
1409
  "docsTags": [],
1404
1410
  "default": "false",
1405
1411
  "values": [
@@ -1416,7 +1422,7 @@
1416
1422
  "mutable": false,
1417
1423
  "attr": "validation-status",
1418
1424
  "reflectToAttr": false,
1419
- "docs": "Provide validation status - 'error'",
1425
+ "docs": "The validation status - e.g. 'error' | 'warning' | 'success'.",
1420
1426
  "docsTags": [],
1421
1427
  "default": "\"\"",
1422
1428
  "values": [
@@ -1445,7 +1451,7 @@
1445
1451
  "mutable": false,
1446
1452
  "attr": "validation-text",
1447
1453
  "reflectToAttr": false,
1448
- "docs": "Provide validation text - 'error'",
1454
+ "docs": "The validation text - e.g. 'error' | 'warning' | 'success'.",
1449
1455
  "docsTags": [],
1450
1456
  "default": "\"\"",
1451
1457
  "values": [
@@ -1512,7 +1518,7 @@
1512
1518
  "mutable": false,
1513
1519
  "attr": "additional-selectors",
1514
1520
  "reflectToAttr": false,
1515
- "docs": "Additional information to display after the classification",
1521
+ "docs": "The additional information that will be displayed after the classification.",
1516
1522
  "docsTags": [],
1517
1523
  "default": "\"\"",
1518
1524
  "values": [
@@ -1529,7 +1535,7 @@
1529
1535
  "mutable": false,
1530
1536
  "attr": "classification",
1531
1537
  "reflectToAttr": false,
1532
- "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.",
1533
1539
  "docsTags": [],
1534
1540
  "default": "\"default\"",
1535
1541
  "values": [
@@ -1563,7 +1569,7 @@
1563
1569
  "mutable": false,
1564
1570
  "attr": "country",
1565
1571
  "reflectToAttr": false,
1566
- "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.",
1567
1573
  "docsTags": [],
1568
1574
  "default": "\"uk\"",
1569
1575
  "values": [
@@ -1580,7 +1586,7 @@
1580
1586
  "mutable": false,
1581
1587
  "attr": "inline",
1582
1588
  "reflectToAttr": false,
1583
- "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.",
1584
1590
  "docsTags": [],
1585
1591
  "default": "false",
1586
1592
  "values": [
@@ -1597,7 +1603,7 @@
1597
1603
  "mutable": false,
1598
1604
  "attr": "up-to",
1599
1605
  "reflectToAttr": false,
1600
- "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.",
1601
1607
  "docsTags": [],
1602
1608
  "default": "false",
1603
1609
  "values": [
@@ -1640,7 +1646,7 @@
1640
1646
  "mutable": false,
1641
1647
  "attr": "heading",
1642
1648
  "reflectToAttr": false,
1643
- "docs": "Title for the data entity",
1649
+ "docs": "The title for the data entity.",
1644
1650
  "docsTags": [],
1645
1651
  "values": [
1646
1652
  {
@@ -1656,7 +1662,7 @@
1656
1662
  "mutable": false,
1657
1663
  "attr": "small",
1658
1664
  "reflectToAttr": false,
1659
- "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.",
1660
1666
  "docsTags": [],
1661
1667
  "default": "false",
1662
1668
  "values": [
@@ -1712,7 +1718,7 @@
1712
1718
  "mutable": false,
1713
1719
  "attr": "label",
1714
1720
  "reflectToAttr": false,
1715
- "docs": "Set the label in the leftmost cell of the row",
1721
+ "docs": "The label in the leftmost cell of the row.",
1716
1722
  "docsTags": [],
1717
1723
  "values": [
1718
1724
  {
@@ -1728,7 +1734,7 @@
1728
1734
  "mutable": false,
1729
1735
  "attr": "small",
1730
1736
  "reflectToAttr": false,
1731
- "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.",
1732
1738
  "docsTags": [],
1733
1739
  "default": "false",
1734
1740
  "values": [
@@ -1745,7 +1751,7 @@
1745
1751
  "mutable": false,
1746
1752
  "attr": "value",
1747
1753
  "reflectToAttr": false,
1748
- "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.",
1749
1755
  "docsTags": [],
1750
1756
  "values": [
1751
1757
  {
@@ -1826,19 +1832,19 @@
1826
1832
  "docsTags": [
1827
1833
  {
1828
1834
  "name": "slot",
1829
- "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."
1830
1836
  },
1831
1837
  {
1832
1838
  "name": "slot",
1833
- "text": "link - Content will be rendered between description and logos"
1839
+ "text": "link - Content will be rendered between description and logos."
1834
1840
  },
1835
1841
  {
1836
1842
  "name": "slot",
1837
- "text": "logo - Content will be rendered underneath footer links"
1843
+ "text": "logo - Content will be rendered underneath footer links."
1838
1844
  },
1839
1845
  {
1840
1846
  "name": "slot",
1841
- "text": "caption - Content will be rendered above Crown Copyright"
1847
+ "text": "caption - Content will be rendered above Crown Copyright."
1842
1848
  }
1843
1849
  ],
1844
1850
  "usage": {},
@@ -1849,7 +1855,7 @@
1849
1855
  "mutable": false,
1850
1856
  "attr": "aligned",
1851
1857
  "reflectToAttr": false,
1852
- "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.",
1853
1859
  "docsTags": [],
1854
1860
  "default": "\"left\"",
1855
1861
  "values": [
@@ -1875,7 +1881,7 @@
1875
1881
  "mutable": false,
1876
1882
  "attr": "breakpoint",
1877
1883
  "reflectToAttr": false,
1878
- "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.",
1879
1885
  "docsTags": [],
1880
1886
  "default": "\"medium\"",
1881
1887
  "values": [
@@ -1909,7 +1915,7 @@
1909
1915
  "mutable": false,
1910
1916
  "attr": "caption",
1911
1917
  "reflectToAttr": false,
1912
- "docs": "The caption displayed at the bottom of the footer",
1918
+ "docs": "The caption displayed at the bottom of the footer.",
1913
1919
  "docsTags": [],
1914
1920
  "values": [
1915
1921
  {
@@ -1925,7 +1931,7 @@
1925
1931
  "mutable": false,
1926
1932
  "attr": "copyright",
1927
1933
  "reflectToAttr": false,
1928
- "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.",
1929
1935
  "docsTags": [],
1930
1936
  "default": "true",
1931
1937
  "values": [
@@ -1942,7 +1948,7 @@
1942
1948
  "mutable": false,
1943
1949
  "attr": "description",
1944
1950
  "reflectToAttr": false,
1945
- "docs": "The description displayed at the top of the footer",
1951
+ "docs": "The description displayed at the top of the footer.",
1946
1952
  "docsTags": [],
1947
1953
  "values": [
1948
1954
  {
@@ -1958,7 +1964,7 @@
1958
1964
  "mutable": false,
1959
1965
  "attr": "group-links",
1960
1966
  "reflectToAttr": false,
1961
- "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.",
1962
1968
  "docsTags": [],
1963
1969
  "default": "false",
1964
1970
  "values": [
@@ -1994,19 +2000,19 @@
1994
2000
  "slots": [
1995
2001
  {
1996
2002
  "name": "caption",
1997
- "docs": "Content will be rendered above Crown Copyright"
2003
+ "docs": "Content will be rendered above Crown Copyright."
1998
2004
  },
1999
2005
  {
2000
2006
  "name": "description",
2001
- "docs": "Content will be rendered at the top of the footer"
2007
+ "docs": "Content will be rendered at the top of the footer."
2002
2008
  },
2003
2009
  {
2004
2010
  "name": "link",
2005
- "docs": "Content will be rendered between description and logos"
2011
+ "docs": "Content will be rendered between description and logos."
2006
2012
  },
2007
2013
  {
2008
2014
  "name": "logo",
2009
- "docs": "Content will be rendered underneath footer links"
2015
+ "docs": "Content will be rendered underneath footer links."
2010
2016
  }
2011
2017
  ],
2012
2018
  "parts": [],
@@ -2087,7 +2093,7 @@
2087
2093
  "mutable": false,
2088
2094
  "attr": "group-title",
2089
2095
  "reflectToAttr": false,
2090
- "docs": "Sets the title of the link group for display",
2096
+ "docs": "The title of the link group to be displayed.",
2091
2097
  "docsTags": [],
2092
2098
  "values": [
2093
2099
  {
@@ -2161,7 +2167,7 @@
2161
2167
  "mutable": false,
2162
2168
  "attr": "aligned",
2163
2169
  "reflectToAttr": false,
2164
- "docs": "The alignment of the hero content",
2170
+ "docs": "The alignment of the hero.",
2165
2171
  "docsTags": [],
2166
2172
  "default": "\"left\"",
2167
2173
  "values": [
@@ -2187,7 +2193,7 @@
2187
2193
  "mutable": false,
2188
2194
  "attr": "background-image",
2189
2195
  "reflectToAttr": false,
2190
- "docs": "Optional background image",
2196
+ "docs": "The optional background image.",
2191
2197
  "docsTags": [],
2192
2198
  "values": [
2193
2199
  {
@@ -2203,7 +2209,7 @@
2203
2209
  "mutable": false,
2204
2210
  "attr": "content-aligned",
2205
2211
  "reflectToAttr": false,
2206
- "docs": "The alignment of the hero content",
2212
+ "docs": "The alignment of the hero content.",
2207
2213
  "docsTags": [],
2208
2214
  "default": "\"left\"",
2209
2215
  "values": [
@@ -2225,7 +2231,7 @@
2225
2231
  "mutable": false,
2226
2232
  "attr": "disable-background-parallax",
2227
2233
  "reflectToAttr": false,
2228
- "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.",
2229
2235
  "docsTags": [],
2230
2236
  "default": "false",
2231
2237
  "values": [
@@ -2242,7 +2248,7 @@
2242
2248
  "mutable": false,
2243
2249
  "attr": "heading",
2244
2250
  "reflectToAttr": false,
2245
- "docs": "The heading of the hero",
2251
+ "docs": "The heading of the hero.",
2246
2252
  "docsTags": [],
2247
2253
  "values": [
2248
2254
  {
@@ -2258,7 +2264,7 @@
2258
2264
  "mutable": false,
2259
2265
  "attr": "secondary-heading",
2260
2266
  "reflectToAttr": false,
2261
- "docs": "Optional secondary heading, replaced by slotted right content",
2267
+ "docs": "The optional secondary heading, replaced by slotted right content.",
2262
2268
  "docsTags": [],
2263
2269
  "values": [
2264
2270
  {
@@ -2274,7 +2280,7 @@
2274
2280
  "mutable": false,
2275
2281
  "attr": "secondary-subheading",
2276
2282
  "reflectToAttr": false,
2277
- "docs": "Optional secondary subheading, replaced by slotted right content",
2283
+ "docs": "The optional secondary subheading, replaced by slotted right content.",
2278
2284
  "docsTags": [],
2279
2285
  "values": [
2280
2286
  {
@@ -2290,7 +2296,7 @@
2290
2296
  "mutable": false,
2291
2297
  "attr": "small",
2292
2298
  "reflectToAttr": false,
2293
- "docs": "Alter styling for use with small content/pages",
2299
+ "docs": "If `true`, the small styling will be applied to the hero.",
2294
2300
  "docsTags": [],
2295
2301
  "default": "false",
2296
2302
  "values": [
@@ -2307,7 +2313,7 @@
2307
2313
  "mutable": false,
2308
2314
  "attr": "subheading",
2309
2315
  "reflectToAttr": false,
2310
- "docs": "Description for the hero",
2316
+ "docs": "The description for the hero.",
2311
2317
  "docsTags": [],
2312
2318
  "values": [
2313
2319
  {
@@ -2386,7 +2392,7 @@
2386
2392
  "mutable": false,
2387
2393
  "attr": "dark",
2388
2394
  "reflectToAttr": false,
2389
- "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.",
2390
2396
  "docsTags": [],
2391
2397
  "default": "false",
2392
2398
  "values": [
@@ -2403,7 +2409,7 @@
2403
2409
  "mutable": false,
2404
2410
  "attr": "disabled",
2405
2411
  "reflectToAttr": false,
2406
- "docs": "disabled",
2412
+ "docs": "If `true`, the disabled state will be set.",
2407
2413
  "docsTags": [],
2408
2414
  "default": "false",
2409
2415
  "values": [
@@ -2420,7 +2426,7 @@
2420
2426
  "mutable": false,
2421
2427
  "attr": "full-width",
2422
2428
  "reflectToAttr": false,
2423
- "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.",
2424
2430
  "docsTags": [],
2425
2431
  "default": "false",
2426
2432
  "values": [
@@ -2437,7 +2443,7 @@
2437
2443
  "mutable": false,
2438
2444
  "attr": "multi-line",
2439
2445
  "reflectToAttr": false,
2440
- "docs": "multiLine",
2446
+ "docs": "If `true`, the input component container will allow for multiple lines.",
2441
2447
  "docsTags": [],
2442
2448
  "default": "false",
2443
2449
  "values": [
@@ -2454,7 +2460,7 @@
2454
2460
  "mutable": false,
2455
2461
  "attr": "readonly",
2456
2462
  "reflectToAttr": false,
2457
- "docs": "readonly",
2463
+ "docs": "If `true`, the readonly state will be set.",
2458
2464
  "docsTags": [],
2459
2465
  "default": "false",
2460
2466
  "values": [
@@ -2471,7 +2477,7 @@
2471
2477
  "mutable": false,
2472
2478
  "attr": "small",
2473
2479
  "reflectToAttr": false,
2474
- "docs": "small",
2480
+ "docs": "If `true`, the small styling will be applied to the input component container.",
2475
2481
  "docsTags": [],
2476
2482
  "default": "false",
2477
2483
  "values": [
@@ -2488,7 +2494,7 @@
2488
2494
  "mutable": false,
2489
2495
  "attr": "validation-inline",
2490
2496
  "reflectToAttr": false,
2491
- "docs": "validationInline",
2497
+ "docs": "If `true`, the validation will display inline.",
2492
2498
  "docsTags": [],
2493
2499
  "default": "false",
2494
2500
  "values": [
@@ -2505,7 +2511,7 @@
2505
2511
  "mutable": false,
2506
2512
  "attr": "validation-status",
2507
2513
  "reflectToAttr": false,
2508
- "docs": "validationStatus",
2514
+ "docs": "The validation status of the input component container - e.g. 'error' | 'warning' | 'success'.",
2509
2515
  "docsTags": [],
2510
2516
  "default": "\"\"",
2511
2517
  "values": [
@@ -2575,7 +2581,7 @@
2575
2581
  "mutable": false,
2576
2582
  "attr": "disabled",
2577
2583
  "reflectToAttr": false,
2578
- "docs": "disabled",
2584
+ "docs": "If `true`, the disabled state will be set.",
2579
2585
  "docsTags": [],
2580
2586
  "default": "false",
2581
2587
  "values": [
@@ -2592,7 +2598,7 @@
2592
2598
  "mutable": false,
2593
2599
  "attr": "readonly",
2594
2600
  "reflectToAttr": false,
2595
- "docs": "readonly",
2601
+ "docs": "If `true`, the readonly state will be set.",
2596
2602
  "docsTags": [],
2597
2603
  "default": "false",
2598
2604
  "values": [
@@ -2639,7 +2645,7 @@
2639
2645
  "mutable": false,
2640
2646
  "attr": "dark",
2641
2647
  "reflectToAttr": false,
2642
- "docs": "dark",
2648
+ "docs": "If `true`, the dark variant of the input label will be displayed.",
2643
2649
  "docsTags": [],
2644
2650
  "default": "false",
2645
2651
  "values": [
@@ -2656,7 +2662,7 @@
2656
2662
  "mutable": false,
2657
2663
  "attr": "disabled",
2658
2664
  "reflectToAttr": false,
2659
- "docs": "disabled",
2665
+ "docs": "If `true`, the disabled state will be set.",
2660
2666
  "docsTags": [],
2661
2667
  "default": "false",
2662
2668
  "values": [
@@ -2673,7 +2679,7 @@
2673
2679
  "mutable": false,
2674
2680
  "attr": "error",
2675
2681
  "reflectToAttr": false,
2676
- "docs": "error",
2682
+ "docs": "If `true`, the input label will display with error styling.",
2677
2683
  "docsTags": [],
2678
2684
  "default": "false",
2679
2685
  "values": [
@@ -2690,7 +2696,7 @@
2690
2696
  "mutable": false,
2691
2697
  "attr": "for",
2692
2698
  "reflectToAttr": false,
2693
- "docs": "for",
2699
+ "docs": "The ID of the form element the label is bound to.",
2694
2700
  "docsTags": [],
2695
2701
  "values": [
2696
2702
  {
@@ -2706,7 +2712,7 @@
2706
2712
  "mutable": false,
2707
2713
  "attr": "helper-text",
2708
2714
  "reflectToAttr": false,
2709
- "docs": "helperText",
2715
+ "docs": "The helper text that will be displayed.",
2710
2716
  "docsTags": [],
2711
2717
  "default": "\"\"",
2712
2718
  "values": [
@@ -2723,7 +2729,7 @@
2723
2729
  "mutable": false,
2724
2730
  "attr": "label",
2725
2731
  "reflectToAttr": false,
2726
- "docs": "label",
2732
+ "docs": "The text content of the label.",
2727
2733
  "docsTags": [],
2728
2734
  "values": [
2729
2735
  {
@@ -2739,7 +2745,7 @@
2739
2745
  "mutable": false,
2740
2746
  "attr": "readonly",
2741
2747
  "reflectToAttr": false,
2742
- "docs": "readonly",
2748
+ "docs": "If `true`, the readonly state will be set.",
2743
2749
  "docsTags": [],
2744
2750
  "default": "false",
2745
2751
  "values": [
@@ -2756,7 +2762,7 @@
2756
2762
  "mutable": false,
2757
2763
  "attr": "required",
2758
2764
  "reflectToAttr": false,
2759
- "docs": "required",
2765
+ "docs": "If `true`, the input label will require a value.",
2760
2766
  "docsTags": [],
2761
2767
  "default": "false",
2762
2768
  "values": [
@@ -2825,7 +2831,7 @@
2825
2831
  "mutable": false,
2826
2832
  "attr": "aria-live-mode",
2827
2833
  "reflectToAttr": false,
2828
- "docs": "aria live mode to apply to message",
2834
+ "docs": "The ARIA live mode to apply to the message.",
2829
2835
  "docsTags": [],
2830
2836
  "default": "\"polite\"",
2831
2837
  "values": [
@@ -2847,7 +2853,7 @@
2847
2853
  "mutable": false,
2848
2854
  "attr": "for",
2849
2855
  "reflectToAttr": false,
2850
- "docs": "The id of the input field the message relates to",
2856
+ "docs": "The ID of the form element the validation is bound to.",
2851
2857
  "docsTags": [],
2852
2858
  "values": [
2853
2859
  {
@@ -2863,7 +2869,7 @@
2863
2869
  "mutable": false,
2864
2870
  "attr": "full-width",
2865
2871
  "reflectToAttr": false,
2866
- "docs": "If true then fill width of container",
2872
+ "docs": "If `true`, the input validation will fill the width of the container.",
2867
2873
  "docsTags": [],
2868
2874
  "default": "false",
2869
2875
  "values": [
@@ -2880,7 +2886,7 @@
2880
2886
  "mutable": false,
2881
2887
  "attr": "message",
2882
2888
  "reflectToAttr": false,
2883
- "docs": "The validation message to display",
2889
+ "docs": "The validation message to display.",
2884
2890
  "docsTags": [],
2885
2891
  "values": [
2886
2892
  {
@@ -2896,7 +2902,7 @@
2896
2902
  "mutable": false,
2897
2903
  "attr": "status",
2898
2904
  "reflectToAttr": false,
2899
- "docs": "The status",
2905
+ "docs": "The status of the validation - e.g. 'error' | 'warning' | 'success'.",
2900
2906
  "docsTags": [],
2901
2907
  "default": "\"\"",
2902
2908
  "values": [
@@ -2967,7 +2973,7 @@
2967
2973
  "docsTags": [
2968
2974
  {
2969
2975
  "name": "slot",
2970
- "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."
2971
2977
  }
2972
2978
  ],
2973
2979
  "usage": {},
@@ -2978,7 +2984,7 @@
2978
2984
  "mutable": true,
2979
2985
  "attr": "appearance",
2980
2986
  "reflectToAttr": false,
2981
- "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.",
2982
2988
  "docsTags": [],
2983
2989
  "default": "\"default\"",
2984
2990
  "values": [
@@ -3004,7 +3010,7 @@
3004
3010
  "mutable": false,
3005
3011
  "attr": "download",
3006
3012
  "reflectToAttr": false,
3007
- "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.",
3008
3014
  "docsTags": [],
3009
3015
  "default": "false",
3010
3016
  "values": [
@@ -3041,7 +3047,7 @@
3041
3047
  "mutable": false,
3042
3048
  "attr": "hreflang",
3043
3049
  "reflectToAttr": false,
3044
- "docs": "Hints at the human language of the linked URL.",
3050
+ "docs": "The human language of the linked URL.",
3045
3051
  "docsTags": [],
3046
3052
  "values": [
3047
3053
  {
@@ -3121,7 +3127,7 @@
3121
3127
  "mutable": false,
3122
3128
  "attr": "show-icon",
3123
3129
  "reflectToAttr": false,
3124
- "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.",
3125
3131
  "docsTags": [],
3126
3132
  "values": [
3127
3133
  {
@@ -3137,7 +3143,7 @@
3137
3143
  "mutable": false,
3138
3144
  "attr": "target",
3139
3145
  "reflectToAttr": false,
3140
- "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).",
3141
3147
  "docsTags": [],
3142
3148
  "values": [
3143
3149
  {
@@ -3162,7 +3168,7 @@
3162
3168
  "slots": [
3163
3169
  {
3164
3170
  "name": "router-item",
3165
- "docs": "Handle routing by nesting your routes in this slot"
3171
+ "docs": "Handle routing by nesting your routes in this slot."
3166
3172
  }
3167
3173
  ],
3168
3174
  "parts": [],
@@ -3191,7 +3197,7 @@
3191
3197
  "mutable": false,
3192
3198
  "attr": "appearance",
3193
3199
  "reflectToAttr": false,
3194
- "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.",
3195
3201
  "docsTags": [],
3196
3202
  "default": "\"dark\"",
3197
3203
  "values": [
@@ -3213,7 +3219,7 @@
3213
3219
  "mutable": false,
3214
3220
  "attr": "description",
3215
3221
  "reflectToAttr": false,
3216
- "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.",
3217
3223
  "docsTags": [],
3218
3224
  "default": "\"Loading\"",
3219
3225
  "values": [
@@ -3230,7 +3236,7 @@
3230
3236
  "mutable": false,
3231
3237
  "attr": "full-width",
3232
3238
  "reflectToAttr": true,
3233
- "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.",
3234
3240
  "docsTags": [],
3235
3241
  "default": "false",
3236
3242
  "values": [
@@ -3440,7 +3446,7 @@
3440
3446
  "type": "HTMLElement",
3441
3447
  "mutable": false,
3442
3448
  "reflectToAttr": false,
3443
- "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.",
3444
3450
  "docsTags": [],
3445
3451
  "values": [
3446
3452
  {
@@ -3456,7 +3462,7 @@
3456
3462
  "mutable": false,
3457
3463
  "attr": "full-width",
3458
3464
  "reflectToAttr": false,
3459
- "docs": "If true then fill width of container",
3465
+ "docs": "If `true`, the menu will fill the width of the container.",
3460
3466
  "docsTags": [],
3461
3467
  "default": "false",
3462
3468
  "values": [
@@ -3472,7 +3478,7 @@
3472
3478
  "type": "HTMLElement",
3473
3479
  "mutable": false,
3474
3480
  "reflectToAttr": false,
3475
- "docs": "Reference to the input element.",
3481
+ "docs": "The reference to the input element.",
3476
3482
  "docsTags": [],
3477
3483
  "values": [
3478
3484
  {
@@ -3488,7 +3494,7 @@
3488
3494
  "mutable": false,
3489
3495
  "attr": "input-label",
3490
3496
  "reflectToAttr": false,
3491
- "docs": "Label for the input element.",
3497
+ "docs": "The label for the input element.",
3492
3498
  "docsTags": [],
3493
3499
  "values": [
3494
3500
  {
@@ -3504,7 +3510,7 @@
3504
3510
  "mutable": false,
3505
3511
  "attr": "menu-id",
3506
3512
  "reflectToAttr": false,
3507
- "docs": "Id of the menu.",
3513
+ "docs": "The ID of the menu.",
3508
3514
  "docsTags": [],
3509
3515
  "values": [
3510
3516
  {
@@ -3520,7 +3526,7 @@
3520
3526
  "mutable": false,
3521
3527
  "attr": "open",
3522
3528
  "reflectToAttr": true,
3523
- "docs": "Specify whether the menu is open.",
3529
+ "docs": "If `true`, the menu will be displayed open.",
3524
3530
  "docsTags": [],
3525
3531
  "values": [
3526
3532
  {
@@ -3535,7 +3541,7 @@
3535
3541
  "type": "IcMenuOption[]",
3536
3542
  "mutable": false,
3537
3543
  "reflectToAttr": false,
3538
- "docs": "Provide the possible selection options.",
3544
+ "docs": "The possible menu selection options.",
3539
3545
  "docsTags": [],
3540
3546
  "values": [
3541
3547
  {
@@ -3551,7 +3557,7 @@
3551
3557
  "mutable": false,
3552
3558
  "attr": "small",
3553
3559
  "reflectToAttr": true,
3554
- "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.",
3555
3561
  "docsTags": [],
3556
3562
  "default": "false",
3557
3563
  "values": [
@@ -3693,7 +3699,7 @@
3693
3699
  "mutable": false,
3694
3700
  "attr": "download",
3695
3701
  "reflectToAttr": false,
3696
- "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.",
3697
3703
  "docsTags": [],
3698
3704
  "default": "false",
3699
3705
  "values": [
@@ -3729,7 +3735,7 @@
3729
3735
  "mutable": false,
3730
3736
  "attr": "hreflang",
3731
3737
  "reflectToAttr": false,
3732
- "docs": "Hints at the human language of the linked URL.",
3738
+ "docs": "The human language of the linked URL.",
3733
3739
  "docsTags": [],
3734
3740
  "values": [
3735
3741
  {
@@ -3745,7 +3751,7 @@
3745
3751
  "mutable": false,
3746
3752
  "attr": "label",
3747
3753
  "reflectToAttr": false,
3748
- "docs": "label info to display",
3754
+ "docs": "The label info to display.",
3749
3755
  "docsTags": [],
3750
3756
  "values": [
3751
3757
  {
@@ -3825,7 +3831,7 @@
3825
3831
  "mutable": false,
3826
3832
  "attr": "target",
3827
3833
  "reflectToAttr": false,
3828
- "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).",
3829
3835
  "docsTags": [],
3830
3836
  "values": [
3831
3837
  {
@@ -3913,7 +3919,7 @@
3913
3919
  "mutable": false,
3914
3920
  "attr": "expandable",
3915
3921
  "reflectToAttr": false,
3916
- "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.",
3917
3923
  "docsTags": [],
3918
3924
  "default": "false",
3919
3925
  "values": [
@@ -3930,7 +3936,7 @@
3930
3936
  "mutable": false,
3931
3937
  "attr": "label",
3932
3938
  "reflectToAttr": false,
3933
- "docs": "label to display on the group",
3939
+ "docs": "The label to display on the group.",
3934
3940
  "docsTags": [],
3935
3941
  "values": [
3936
3942
  {
@@ -4006,7 +4012,7 @@
4006
4012
  "mutable": false,
4007
4013
  "attr": "href",
4008
4014
  "reflectToAttr": false,
4009
- "docs": "Destination of the navigation item",
4015
+ "docs": "The destination of the navigation item.",
4010
4016
  "docsTags": [],
4011
4017
  "default": "\"\"",
4012
4018
  "values": [
@@ -4023,7 +4029,7 @@
4023
4029
  "mutable": false,
4024
4030
  "attr": "label",
4025
4031
  "reflectToAttr": false,
4026
- "docs": "Label of the navigation item",
4032
+ "docs": "The label of the navigation item.",
4027
4033
  "docsTags": [],
4028
4034
  "values": [
4029
4035
  {
@@ -4039,7 +4045,7 @@
4039
4045
  "mutable": false,
4040
4046
  "attr": "selected",
4041
4047
  "reflectToAttr": false,
4042
- "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.",
4043
4049
  "docsTags": [],
4044
4050
  "default": "false",
4045
4051
  "values": [
@@ -4120,7 +4126,7 @@
4120
4126
  "mutable": false,
4121
4127
  "attr": "status",
4122
4128
  "reflectToAttr": false,
4123
- "docs": "Status info to display",
4129
+ "docs": "The status info to display.",
4124
4130
  "docsTags": [],
4125
4131
  "default": "\"\"",
4126
4132
  "values": [
@@ -4137,7 +4143,7 @@
4137
4143
  "mutable": false,
4138
4144
  "attr": "version",
4139
4145
  "reflectToAttr": false,
4140
- "docs": "Version info to display",
4146
+ "docs": "The version info to display.",
4141
4147
  "docsTags": [],
4142
4148
  "default": "\"\"",
4143
4149
  "values": [
@@ -4251,7 +4257,7 @@
4251
4257
  "mutable": false,
4252
4258
  "attr": "aligned",
4253
4259
  "reflectToAttr": false,
4254
- "docs": "How the component should be aligned.",
4260
+ "docs": "The alignment of the page header.",
4255
4261
  "docsTags": [],
4256
4262
  "default": "\"left\"",
4257
4263
  "values": [
@@ -4277,7 +4283,7 @@
4277
4283
  "mutable": false,
4278
4284
  "attr": "border",
4279
4285
  "reflectToAttr": false,
4280
- "docs": "Set whether the bottom border is used",
4286
+ "docs": "If `true`, a border will be displayed along the bottom of the page header.",
4281
4287
  "docsTags": [],
4282
4288
  "default": "true",
4283
4289
  "values": [
@@ -4294,7 +4300,7 @@
4294
4300
  "mutable": false,
4295
4301
  "attr": "heading",
4296
4302
  "reflectToAttr": false,
4297
- "docs": "The title to render on the component.",
4303
+ "docs": "The title to render on the page header.",
4298
4304
  "docsTags": [],
4299
4305
  "values": [
4300
4306
  {
@@ -4310,7 +4316,7 @@
4310
4316
  "mutable": false,
4311
4317
  "attr": "reverse-order",
4312
4318
  "reflectToAttr": false,
4313
- "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.",
4314
4320
  "docsTags": [],
4315
4321
  "default": "false",
4316
4322
  "values": [
@@ -4327,7 +4333,7 @@
4327
4333
  "mutable": false,
4328
4334
  "attr": "small",
4329
4335
  "reflectToAttr": false,
4330
- "docs": "Whether the component uses small styling.",
4336
+ "docs": "If `true`, the small styling will be applied to the page header.",
4331
4337
  "docsTags": [],
4332
4338
  "default": "false",
4333
4339
  "values": [
@@ -4344,7 +4350,7 @@
4344
4350
  "mutable": false,
4345
4351
  "attr": "sticky",
4346
4352
  "reflectToAttr": false,
4347
- "docs": "Set whether the header is sticky at all breakpoints",
4353
+ "docs": "If `true`, the page header will be sticky at all breakpoints.",
4348
4354
  "docsTags": [],
4349
4355
  "default": "false",
4350
4356
  "values": [
@@ -4361,7 +4367,7 @@
4361
4367
  "mutable": false,
4362
4368
  "attr": "sticky-desktop-only",
4363
4369
  "reflectToAttr": false,
4364
- "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.",
4365
4371
  "docsTags": [],
4366
4372
  "default": "false",
4367
4373
  "values": [
@@ -4378,7 +4384,7 @@
4378
4384
  "mutable": false,
4379
4385
  "attr": "subheading",
4380
4386
  "reflectToAttr": false,
4381
- "docs": "The subtitle to render on the component.",
4387
+ "docs": "The subtitle to render on the page header.",
4382
4388
  "docsTags": [],
4383
4389
  "values": [
4384
4390
  {
@@ -4455,7 +4461,7 @@
4455
4461
  "mutable": false,
4456
4462
  "attr": "disabled",
4457
4463
  "reflectToAttr": false,
4458
- "docs": "Specify whether the input is disabled.",
4464
+ "docs": "If `true`, the disabled state will be set.",
4459
4465
  "docsTags": [],
4460
4466
  "default": "false",
4461
4467
  "values": [
@@ -4472,7 +4478,7 @@
4472
4478
  "mutable": false,
4473
4479
  "attr": "helper-text",
4474
4480
  "reflectToAttr": false,
4475
- "docs": "Provide helper text to display additional field guidance.",
4481
+ "docs": "The helper text that will be displayed for additional field guidance.",
4476
4482
  "docsTags": [],
4477
4483
  "values": [
4478
4484
  {
@@ -4488,7 +4494,7 @@
4488
4494
  "mutable": false,
4489
4495
  "attr": "hide-label",
4490
4496
  "reflectToAttr": false,
4491
- "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.",
4492
4498
  "docsTags": [],
4493
4499
  "default": "false",
4494
4500
  "values": [
@@ -4505,7 +4511,7 @@
4505
4511
  "mutable": false,
4506
4512
  "attr": "label",
4507
4513
  "reflectToAttr": false,
4508
- "docs": "Provide a label for the input.",
4514
+ "docs": "The label for the radio group to be displayed.",
4509
4515
  "docsTags": [],
4510
4516
  "values": [
4511
4517
  {
@@ -4521,7 +4527,7 @@
4521
4527
  "mutable": false,
4522
4528
  "attr": "name",
4523
4529
  "reflectToAttr": false,
4524
- "docs": "Provide a name for the input.",
4530
+ "docs": "The name for the radio group to differentiate from other groups.",
4525
4531
  "docsTags": [],
4526
4532
  "values": [
4527
4533
  {
@@ -4537,7 +4543,7 @@
4537
4543
  "mutable": false,
4538
4544
  "attr": "required",
4539
4545
  "reflectToAttr": false,
4540
- "docs": "Specify if the input requires a value.",
4546
+ "docs": "If `true`, the radio group will require a value.",
4541
4547
  "docsTags": [],
4542
4548
  "default": "false",
4543
4549
  "values": [
@@ -4554,7 +4560,7 @@
4554
4560
  "mutable": false,
4555
4561
  "attr": "small",
4556
4562
  "reflectToAttr": false,
4557
- "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.",
4558
4564
  "docsTags": [],
4559
4565
  "default": "false",
4560
4566
  "values": [
@@ -4571,7 +4577,7 @@
4571
4577
  "mutable": false,
4572
4578
  "attr": "validation-status",
4573
4579
  "reflectToAttr": false,
4574
- "docs": "Provide validation status - 'error'",
4580
+ "docs": "The validation status - e.g. 'error' | 'warning' | 'success'.",
4575
4581
  "docsTags": [],
4576
4582
  "default": "\"\"",
4577
4583
  "values": [
@@ -4600,7 +4606,7 @@
4600
4606
  "mutable": false,
4601
4607
  "attr": "validation-text",
4602
4608
  "reflectToAttr": false,
4603
- "docs": "Provide validation text - 'error'",
4609
+ "docs": "The validation text - e.g. 'error' | 'warning' | 'success'.",
4604
4610
  "docsTags": [],
4605
4611
  "default": "\"\"",
4606
4612
  "values": [
@@ -4667,7 +4673,7 @@
4667
4673
  "mutable": false,
4668
4674
  "attr": "additional-field-display",
4669
4675
  "reflectToAttr": true,
4670
- "docs": "Determines type of additional text field in relation to radio option",
4676
+ "docs": "The style of additionalField that will be displayed if used.",
4671
4677
  "docsTags": [],
4672
4678
  "default": "\"static\"",
4673
4679
  "values": [
@@ -4689,7 +4695,7 @@
4689
4695
  "mutable": false,
4690
4696
  "attr": "disabled",
4691
4697
  "reflectToAttr": false,
4692
- "docs": "Determines whether the radio should be in disabled state.",
4698
+ "docs": "If `true`, the disabled state will be set.",
4693
4699
  "docsTags": [],
4694
4700
  "default": "false",
4695
4701
  "values": [
@@ -4706,7 +4712,7 @@
4706
4712
  "mutable": false,
4707
4713
  "attr": "dynamic-text",
4708
4714
  "reflectToAttr": false,
4709
- "docs": "Provide a text prop for the dynamic text.",
4715
+ "docs": "The text to be displayed when dynamic.",
4710
4716
  "docsTags": [],
4711
4717
  "default": "\"This selection requires additional answers\"",
4712
4718
  "values": [
@@ -4723,7 +4729,7 @@
4723
4729
  "mutable": false,
4724
4730
  "attr": "group-label",
4725
4731
  "reflectToAttr": false,
4726
- "docs": "Provide a group label for the input.",
4732
+ "docs": "The group label for the radio option.",
4727
4733
  "docsTags": [],
4728
4734
  "values": [
4729
4735
  {
@@ -4739,7 +4745,7 @@
4739
4745
  "mutable": false,
4740
4746
  "attr": "label",
4741
4747
  "reflectToAttr": false,
4742
- "docs": "Provide a label for the input.",
4748
+ "docs": "The label for the radio option.",
4743
4749
  "docsTags": [],
4744
4750
  "values": [
4745
4751
  {
@@ -4755,7 +4761,7 @@
4755
4761
  "mutable": false,
4756
4762
  "attr": "name",
4757
4763
  "reflectToAttr": false,
4758
- "docs": "Provide a name for the input.",
4764
+ "docs": "The name for the radio option.",
4759
4765
  "docsTags": [],
4760
4766
  "values": [
4761
4767
  {
@@ -4771,7 +4777,7 @@
4771
4777
  "mutable": true,
4772
4778
  "attr": "selected",
4773
4779
  "reflectToAttr": true,
4774
- "docs": "Determines whether the radio should be in selected state.",
4780
+ "docs": "If `true`, the radio option will be displayed in a selected state.",
4775
4781
  "docsTags": [],
4776
4782
  "default": "false",
4777
4783
  "values": [
@@ -4788,7 +4794,7 @@
4788
4794
  "mutable": true,
4789
4795
  "attr": "value",
4790
4796
  "reflectToAttr": false,
4791
- "docs": "Provide a value for the input.",
4797
+ "docs": "The value for the radio option.",
4792
4798
  "docsTags": [],
4793
4799
  "values": [
4794
4800
  {
@@ -4801,15 +4807,6 @@
4801
4807
  ],
4802
4808
  "methods": [],
4803
4809
  "events": [
4804
- {
4805
- "event": "icCheck",
4806
- "detail": "void",
4807
- "bubbles": true,
4808
- "cancelable": true,
4809
- "composed": true,
4810
- "docs": "Emitted when radio is checked",
4811
- "docsTags": []
4812
- },
4813
4810
  {
4814
4811
  "event": "radioOptionSelect",
4815
4812
  "detail": "IcValueEventDetail",
@@ -4855,7 +4852,7 @@
4855
4852
  "mutable": false,
4856
4853
  "attr": "autocapitalize",
4857
4854
  "reflectToAttr": false,
4858
- "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\".",
4859
4856
  "docsTags": [],
4860
4857
  "default": "\"off\"",
4861
4858
  "values": [
@@ -4872,7 +4869,7 @@
4872
4869
  "mutable": false,
4873
4870
  "attr": "autocomplete",
4874
4871
  "reflectToAttr": false,
4875
- "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.",
4876
4873
  "docsTags": [],
4877
4874
  "default": "\"off\"",
4878
4875
  "values": [
@@ -5102,7 +5099,7 @@
5102
5099
  "mutable": false,
5103
5100
  "attr": "autocorrect",
5104
5101
  "reflectToAttr": false,
5105
- "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.",
5106
5103
  "docsTags": [],
5107
5104
  "default": "\"off\"",
5108
5105
  "values": [
@@ -5124,7 +5121,7 @@
5124
5121
  "mutable": false,
5125
5122
  "attr": "autofocus",
5126
5123
  "reflectToAttr": false,
5127
- "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.",
5128
5125
  "docsTags": [],
5129
5126
  "default": "false",
5130
5127
  "values": [
@@ -5141,7 +5138,7 @@
5141
5138
  "mutable": false,
5142
5139
  "attr": "characters-until-suggestion",
5143
5140
  "reflectToAttr": false,
5144
- "docs": "Number of characters until suggestions appear",
5141
+ "docs": "The number of characters until suggestions appear.",
5145
5142
  "docsTags": [],
5146
5143
  "default": "2",
5147
5144
  "values": [
@@ -5158,7 +5155,7 @@
5158
5155
  "mutable": true,
5159
5156
  "attr": "debounce",
5160
5157
  "reflectToAttr": false,
5161
- "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.",
5162
5159
  "docsTags": [],
5163
5160
  "default": "0",
5164
5161
  "values": [
@@ -5175,7 +5172,7 @@
5175
5172
  "mutable": false,
5176
5173
  "attr": "disable-filter",
5177
5174
  "reflectToAttr": false,
5178
- "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.",
5179
5176
  "docsTags": [],
5180
5177
  "default": "false",
5181
5178
  "values": [
@@ -5192,7 +5189,7 @@
5192
5189
  "mutable": false,
5193
5190
  "attr": "disabled",
5194
5191
  "reflectToAttr": false,
5195
- "docs": "Specify whether the input is disabled.",
5192
+ "docs": "If `true`, the disabled state will be set.",
5196
5193
  "docsTags": [],
5197
5194
  "default": "false",
5198
5195
  "values": [
@@ -5209,7 +5206,7 @@
5209
5206
  "mutable": false,
5210
5207
  "attr": "empty-option-list-text",
5211
5208
  "reflectToAttr": false,
5212
- "docs": "Provide text for empty results list",
5209
+ "docs": "The text displayed when there are no options in the option list.",
5213
5210
  "docsTags": [],
5214
5211
  "default": "\"No results found\"",
5215
5212
  "values": [
@@ -5226,7 +5223,7 @@
5226
5223
  "mutable": false,
5227
5224
  "attr": "focus-on-load",
5228
5225
  "reflectToAttr": false,
5229
- "docs": "Specify whether the input should be focussed when component loaded.",
5226
+ "docs": "If `true`, the search bar will be focused when component loaded.",
5230
5227
  "docsTags": [],
5231
5228
  "default": "false",
5232
5229
  "values": [
@@ -5243,7 +5240,7 @@
5243
5240
  "mutable": false,
5244
5241
  "attr": "full-width",
5245
5242
  "reflectToAttr": false,
5246
- "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.",
5247
5244
  "docsTags": [],
5248
5245
  "default": "false",
5249
5246
  "values": [
@@ -5260,7 +5257,7 @@
5260
5257
  "mutable": false,
5261
5258
  "attr": "helper-text",
5262
5259
  "reflectToAttr": false,
5263
- "docs": "Provide helper text to display additional field guidance.",
5260
+ "docs": "The helper text that will be displayed for additional field guidance.",
5264
5261
  "docsTags": [],
5265
5262
  "default": "\"\"",
5266
5263
  "values": [
@@ -5277,7 +5274,7 @@
5277
5274
  "mutable": false,
5278
5275
  "attr": "hide-label",
5279
5276
  "reflectToAttr": false,
5280
- "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.",
5281
5278
  "docsTags": [],
5282
5279
  "default": "false",
5283
5280
  "values": [
@@ -5294,7 +5291,7 @@
5294
5291
  "mutable": false,
5295
5292
  "attr": "hint-text",
5296
5293
  "reflectToAttr": false,
5297
- "docs": "Provide hint text for hidden assistive description element.",
5294
+ "docs": "The hint text for the hidden assistive description element.",
5298
5295
  "docsTags": [],
5299
5296
  "default": "\"When autocomplete results are available use the up and down arrows to choose and press enter to select\"",
5300
5297
  "values": [
@@ -5311,7 +5308,7 @@
5311
5308
  "mutable": false,
5312
5309
  "attr": "label",
5313
5310
  "reflectToAttr": false,
5314
- "docs": "Provide a label for the input.",
5311
+ "docs": "The label for the search bar.",
5315
5312
  "docsTags": [],
5316
5313
  "values": [
5317
5314
  {
@@ -5343,7 +5340,7 @@
5343
5340
  "type": "IcMenuOption[]",
5344
5341
  "mutable": false,
5345
5342
  "reflectToAttr": false,
5346
- "docs": "Provide the suggested search options",
5343
+ "docs": "The suggested search options.",
5347
5344
  "docsTags": [],
5348
5345
  "default": "[]",
5349
5346
  "values": [
@@ -5360,7 +5357,7 @@
5360
5357
  "mutable": false,
5361
5358
  "attr": "placeholder",
5362
5359
  "reflectToAttr": false,
5363
- "docs": "Provide a placeholder value to display.",
5360
+ "docs": "The placeholder value to display.",
5364
5361
  "docsTags": [],
5365
5362
  "default": "\"Search\"",
5366
5363
  "values": [
@@ -5377,7 +5374,7 @@
5377
5374
  "mutable": false,
5378
5375
  "attr": "readonly",
5379
5376
  "reflectToAttr": false,
5380
- "docs": "Specify whether the input is read only.",
5377
+ "docs": "If `true`, the readonly state will be set.",
5381
5378
  "docsTags": [],
5382
5379
  "default": "false",
5383
5380
  "values": [
@@ -5394,7 +5391,7 @@
5394
5391
  "mutable": false,
5395
5392
  "attr": "required",
5396
5393
  "reflectToAttr": false,
5397
- "docs": "Specify if the input requires a value.",
5394
+ "docs": "If `true`, the search bar will require a value.",
5398
5395
  "docsTags": [],
5399
5396
  "default": "false",
5400
5397
  "values": [
@@ -5411,7 +5408,7 @@
5411
5408
  "mutable": false,
5412
5409
  "attr": "small",
5413
5410
  "reflectToAttr": false,
5414
- "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.",
5415
5412
  "docsTags": [],
5416
5413
  "default": "false",
5417
5414
  "values": [
@@ -5428,7 +5425,7 @@
5428
5425
  "mutable": false,
5429
5426
  "attr": "spellcheck",
5430
5427
  "reflectToAttr": false,
5431
- "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.",
5432
5429
  "docsTags": [],
5433
5430
  "default": "false",
5434
5431
  "values": [
@@ -5445,7 +5442,7 @@
5445
5442
  "mutable": true,
5446
5443
  "attr": "value",
5447
5444
  "reflectToAttr": true,
5448
- "docs": "Value of Search input.",
5445
+ "docs": "The value of the search input.",
5449
5446
  "docsTags": [],
5450
5447
  "default": "\"\"",
5451
5448
  "values": [
@@ -5642,7 +5639,7 @@
5642
5639
  "mutable": false,
5643
5640
  "attr": "aligned",
5644
5641
  "reflectToAttr": false,
5645
- "docs": "How the container should be aligned.",
5642
+ "docs": "The alignment of the container.",
5646
5643
  "docsTags": [],
5647
5644
  "default": "\"left\"",
5648
5645
  "values": [
@@ -5668,7 +5665,7 @@
5668
5665
  "mutable": false,
5669
5666
  "attr": "full-height",
5670
5667
  "reflectToAttr": false,
5671
- "docs": "Removes the standard vertical padding from the container.",
5668
+ "docs": "If `true`, the standard vertical padding from the container will be removed.",
5672
5669
  "docsTags": [],
5673
5670
  "default": "false",
5674
5671
  "values": [
@@ -5727,7 +5724,7 @@
5727
5724
  "mutable": false,
5728
5725
  "attr": "characters-until-suggestions",
5729
5726
  "reflectToAttr": false,
5730
- "docs": "Number of characters until suggestions appear for a searchable select.",
5727
+ "docs": "The number of characters until suggestions appear for a searchable select.",
5731
5728
  "docsTags": [],
5732
5729
  "default": "0",
5733
5730
  "values": [
@@ -5744,7 +5741,7 @@
5744
5741
  "mutable": false,
5745
5742
  "attr": "disabled",
5746
5743
  "reflectToAttr": true,
5747
- "docs": "Specify whether the input is disabled.",
5744
+ "docs": "If `true`, the disabled state will be set.",
5748
5745
  "docsTags": [],
5749
5746
  "default": "false",
5750
5747
  "values": [
@@ -5761,7 +5758,7 @@
5761
5758
  "mutable": false,
5762
5759
  "attr": "empty-option-list-text",
5763
5760
  "reflectToAttr": false,
5764
- "docs": "Provide text for empty results list",
5761
+ "docs": "The text displayed when there are no options in the option list.",
5765
5762
  "docsTags": [],
5766
5763
  "default": "\"No results found\"",
5767
5764
  "values": [
@@ -5778,7 +5775,7 @@
5778
5775
  "mutable": false,
5779
5776
  "attr": "full-width",
5780
5777
  "reflectToAttr": false,
5781
- "docs": "If true, then fill width of container.",
5778
+ "docs": "If `true`, the select element will fill the width of the container.",
5782
5779
  "docsTags": [],
5783
5780
  "default": "false",
5784
5781
  "values": [
@@ -5795,7 +5792,7 @@
5795
5792
  "mutable": false,
5796
5793
  "attr": "helper-text",
5797
5794
  "reflectToAttr": false,
5798
- "docs": "Provide helper text to display additional field guidance.",
5795
+ "docs": "The helper text that will be displayed for additional field guidance.",
5799
5796
  "docsTags": [],
5800
5797
  "default": "\"\"",
5801
5798
  "values": [
@@ -5812,7 +5809,7 @@
5812
5809
  "mutable": false,
5813
5810
  "attr": "hide-label",
5814
5811
  "reflectToAttr": false,
5815
- "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.",
5816
5813
  "docsTags": [],
5817
5814
  "default": "false",
5818
5815
  "values": [
@@ -5829,7 +5826,7 @@
5829
5826
  "mutable": false,
5830
5827
  "attr": "include-descriptions-in-search",
5831
5828
  "reflectToAttr": false,
5832
- "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.",
5833
5830
  "docsTags": [],
5834
5831
  "default": "false",
5835
5832
  "values": [
@@ -5846,7 +5843,7 @@
5846
5843
  "mutable": false,
5847
5844
  "attr": "include-group-titles-in-search",
5848
5845
  "reflectToAttr": false,
5849
- "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.",
5850
5847
  "docsTags": [],
5851
5848
  "default": "false",
5852
5849
  "values": [
@@ -5863,7 +5860,7 @@
5863
5860
  "mutable": false,
5864
5861
  "attr": "label",
5865
5862
  "reflectToAttr": false,
5866
- "docs": "Provide a label for the input.",
5863
+ "docs": "The label for the select.",
5867
5864
  "docsTags": [],
5868
5865
  "values": [
5869
5866
  {
@@ -5895,7 +5892,7 @@
5895
5892
  "type": "IcMenuOption[]",
5896
5893
  "mutable": false,
5897
5894
  "reflectToAttr": false,
5898
- "docs": "Provide the possible selection options.",
5895
+ "docs": "The possible selection options.",
5899
5896
  "docsTags": [],
5900
5897
  "default": "[]",
5901
5898
  "values": [
@@ -5912,7 +5909,7 @@
5912
5909
  "mutable": false,
5913
5910
  "attr": "placeholder",
5914
5911
  "reflectToAttr": false,
5915
- "docs": "Provide a placeholder value to display.",
5912
+ "docs": "The placeholder value to be displayed.",
5916
5913
  "docsTags": [],
5917
5914
  "default": "\"Select an option\"",
5918
5915
  "values": [
@@ -5929,7 +5926,7 @@
5929
5926
  "mutable": false,
5930
5927
  "attr": "readonly",
5931
5928
  "reflectToAttr": false,
5932
- "docs": "Specify whether the input is read only.",
5929
+ "docs": "If `true`, the readonly state will be set.",
5933
5930
  "docsTags": [],
5934
5931
  "default": "false",
5935
5932
  "values": [
@@ -5946,7 +5943,7 @@
5946
5943
  "mutable": false,
5947
5944
  "attr": "required",
5948
5945
  "reflectToAttr": false,
5949
- "docs": "Specify if the input requires a value.",
5946
+ "docs": "If `true`, the select will require a value.",
5950
5947
  "docsTags": [],
5951
5948
  "default": "false",
5952
5949
  "values": [
@@ -5985,7 +5982,7 @@
5985
5982
  "mutable": false,
5986
5983
  "attr": "searchable",
5987
5984
  "reflectToAttr": false,
5988
- "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.",
5989
5986
  "docsTags": [],
5990
5987
  "default": "false",
5991
5988
  "values": [
@@ -6002,7 +5999,7 @@
6002
5999
  "mutable": false,
6003
6000
  "attr": "show-clear-button",
6004
6001
  "reflectToAttr": false,
6005
- "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.",
6006
6003
  "docsTags": [],
6007
6004
  "default": "false",
6008
6005
  "values": [
@@ -6019,7 +6016,7 @@
6019
6016
  "mutable": false,
6020
6017
  "attr": "small",
6021
6018
  "reflectToAttr": false,
6022
- "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.",
6023
6020
  "docsTags": [],
6024
6021
  "default": "false",
6025
6022
  "values": [
@@ -6036,7 +6033,7 @@
6036
6033
  "mutable": false,
6037
6034
  "attr": "validation-status",
6038
6035
  "reflectToAttr": false,
6039
- "docs": "Provide a validation status.",
6036
+ "docs": "The validation status - e.g. 'error' | 'warning' | 'success'.",
6040
6037
  "docsTags": [],
6041
6038
  "default": "\"\"",
6042
6039
  "values": [
@@ -6065,7 +6062,7 @@
6065
6062
  "mutable": false,
6066
6063
  "attr": "validation-text",
6067
6064
  "reflectToAttr": false,
6068
- "docs": "Provide the text to display as the validation message.",
6065
+ "docs": "The text to display as the validation message.",
6069
6066
  "docsTags": [],
6070
6067
  "default": "\"\"",
6071
6068
  "values": [
@@ -6195,15 +6192,15 @@
6195
6192
  "docsTags": [
6196
6193
  {
6197
6194
  "name": "slot",
6198
- "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."
6199
6196
  },
6200
6197
  {
6201
6198
  "name": "slot",
6202
- "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."
6203
6200
  },
6204
6201
  {
6205
6202
  "name": "slot",
6206
- "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."
6207
6204
  }
6208
6205
  ],
6209
6206
  "usage": {},
@@ -6214,7 +6211,7 @@
6214
6211
  "mutable": false,
6215
6212
  "attr": "app-title",
6216
6213
  "reflectToAttr": false,
6217
- "docs": "Title to display.",
6214
+ "docs": "The title of the app to be displayed.",
6218
6215
  "docsTags": [],
6219
6216
  "values": [
6220
6217
  {
@@ -6230,7 +6227,7 @@
6230
6227
  "mutable": false,
6231
6228
  "attr": "collapsed-icon-labels",
6232
6229
  "reflectToAttr": false,
6233
- "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.",
6234
6231
  "docsTags": [],
6235
6232
  "default": "false",
6236
6233
  "values": [
@@ -6247,7 +6244,7 @@
6247
6244
  "mutable": false,
6248
6245
  "attr": "disable-auto-parent-styling",
6249
6246
  "reflectToAttr": false,
6250
- "docs": "If true, disable automatic parent wrapper styling",
6247
+ "docs": "If `true`, automatic parent wrapper styling will be disabled.",
6251
6248
  "docsTags": [],
6252
6249
  "default": "false",
6253
6250
  "values": [
@@ -6264,7 +6261,7 @@
6264
6261
  "mutable": false,
6265
6262
  "attr": "expanded",
6266
6263
  "reflectToAttr": false,
6267
- "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.",
6268
6265
  "docsTags": [],
6269
6266
  "default": "false",
6270
6267
  "values": [
@@ -6281,7 +6278,7 @@
6281
6278
  "mutable": false,
6282
6279
  "attr": "href",
6283
6280
  "reflectToAttr": false,
6284
- "docs": "Set application title link",
6281
+ "docs": "The URL that the app title link points to.",
6285
6282
  "docsTags": [],
6286
6283
  "default": "\"/\"",
6287
6284
  "values": [
@@ -6298,7 +6295,7 @@
6298
6295
  "mutable": false,
6299
6296
  "attr": "inline",
6300
6297
  "reflectToAttr": false,
6301
- "docs": "If true, side navigation will be contained by parent element",
6298
+ "docs": "If `true`, side navigation will be contained by its parent element.",
6302
6299
  "docsTags": [],
6303
6300
  "default": "false",
6304
6301
  "values": [
@@ -6315,7 +6312,7 @@
6315
6312
  "mutable": false,
6316
6313
  "attr": "static",
6317
6314
  "reflectToAttr": false,
6318
- "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).",
6319
6316
  "docsTags": [],
6320
6317
  "default": "false",
6321
6318
  "values": [
@@ -6332,7 +6329,7 @@
6332
6329
  "mutable": false,
6333
6330
  "attr": "status",
6334
6331
  "reflectToAttr": false,
6335
- "docs": "Status of application",
6332
+ "docs": "The status of the app to be displayed.",
6336
6333
  "docsTags": [],
6337
6334
  "values": [
6338
6335
  {
@@ -6348,7 +6345,7 @@
6348
6345
  "mutable": false,
6349
6346
  "attr": "version",
6350
6347
  "reflectToAttr": false,
6351
- "docs": "Version of application",
6348
+ "docs": "The version of the app to be displayed.",
6352
6349
  "docsTags": [],
6353
6350
  "values": [
6354
6351
  {
@@ -6373,15 +6370,15 @@
6373
6370
  "slots": [
6374
6371
  {
6375
6372
  "name": "app-icon",
6376
- "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."
6377
6374
  },
6378
6375
  {
6379
6376
  "name": "primary-navigation",
6380
- "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."
6381
6378
  },
6382
6379
  {
6383
6380
  "name": "secondary-navigation",
6384
- "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."
6385
6382
  }
6386
6383
  ],
6387
6384
  "parts": [],
@@ -6424,7 +6421,7 @@
6424
6421
  "mutable": false,
6425
6422
  "attr": "light",
6426
6423
  "reflectToAttr": false,
6427
- "docs": "Set the skeleton to the light variant",
6424
+ "docs": "If `true`, the skeleton will be set to the light variant.",
6428
6425
  "docsTags": [],
6429
6426
  "default": "false",
6430
6427
  "values": [
@@ -6441,7 +6438,7 @@
6441
6438
  "mutable": false,
6442
6439
  "attr": "variant",
6443
6440
  "reflectToAttr": false,
6444
- "docs": "The variant of the skeleton that will be displayed",
6441
+ "docs": "The variant of the skeleton that will be displayed.",
6445
6442
  "docsTags": [],
6446
6443
  "default": "\"rectangle\"",
6447
6444
  "values": [
@@ -6525,7 +6522,7 @@
6525
6522
  "mutable": false,
6526
6523
  "attr": "small",
6527
6524
  "reflectToAttr": false,
6528
- "docs": "The size of the status tag.",
6525
+ "docs": "If `true`, the small styling will be applied to the status tag.",
6529
6526
  "docsTags": [],
6530
6527
  "default": "false",
6531
6528
  "values": [
@@ -6598,7 +6595,7 @@
6598
6595
  "mutable": false,
6599
6596
  "attr": "step-subtitle",
6600
6597
  "reflectToAttr": false,
6601
- "docs": "Additional information about step",
6598
+ "docs": "The additional information about the step.",
6602
6599
  "docsTags": [],
6603
6600
  "values": [
6604
6601
  {
@@ -6614,7 +6611,7 @@
6614
6611
  "mutable": false,
6615
6612
  "attr": "step-title",
6616
6613
  "reflectToAttr": false,
6617
- "docs": "Name of step",
6614
+ "docs": "The name of the step within the stepper.",
6618
6615
  "docsTags": [],
6619
6616
  "values": [
6620
6617
  {
@@ -6630,7 +6627,7 @@
6630
6627
  "mutable": false,
6631
6628
  "attr": "step-type",
6632
6629
  "reflectToAttr": false,
6633
- "docs": "State of step",
6630
+ "docs": "The state of the step within the stepper.",
6634
6631
  "docsTags": [],
6635
6632
  "default": "\"active\"",
6636
6633
  "values": [
@@ -6686,7 +6683,7 @@
6686
6683
  "mutable": false,
6687
6684
  "attr": "aligned",
6688
6685
  "reflectToAttr": false,
6689
- "docs": "How the stepper should be aligned in its container.",
6686
+ "docs": "The alignment of the stepper within its container.",
6690
6687
  "docsTags": [],
6691
6688
  "default": "\"full-width\"",
6692
6689
  "values": [
@@ -6750,7 +6747,7 @@
6750
6747
  "mutable": false,
6751
6748
  "attr": "checked",
6752
6749
  "reflectToAttr": false,
6753
- "docs": "If true, the component is checked.",
6750
+ "docs": "If `true`, the switch will display as checked.",
6754
6751
  "docsTags": [],
6755
6752
  "default": "false",
6756
6753
  "values": [
@@ -6767,7 +6764,7 @@
6767
6764
  "mutable": false,
6768
6765
  "attr": "disabled",
6769
6766
  "reflectToAttr": false,
6770
- "docs": "If true, the component is not interactive.",
6767
+ "docs": "If `true`, the disabled state will be set.",
6771
6768
  "docsTags": [],
6772
6769
  "default": "false",
6773
6770
  "values": [
@@ -6784,7 +6781,7 @@
6784
6781
  "mutable": false,
6785
6782
  "attr": "helper-text",
6786
6783
  "reflectToAttr": false,
6787
- "docs": "Provide helper text to display additional field guidance.",
6784
+ "docs": "The helper text that will be displayed for additional field guidance.",
6788
6785
  "docsTags": [],
6789
6786
  "default": "\"\"",
6790
6787
  "values": [
@@ -6801,7 +6798,7 @@
6801
6798
  "mutable": false,
6802
6799
  "attr": "hide-label",
6803
6800
  "reflectToAttr": false,
6804
- "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.",
6805
6802
  "docsTags": [],
6806
6803
  "default": "false",
6807
6804
  "values": [
@@ -6818,7 +6815,7 @@
6818
6815
  "mutable": false,
6819
6816
  "attr": "label",
6820
6817
  "reflectToAttr": false,
6821
- "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.",
6822
6819
  "docsTags": [],
6823
6820
  "values": [
6824
6821
  {
@@ -6851,7 +6848,7 @@
6851
6848
  "mutable": false,
6852
6849
  "attr": "show-state",
6853
6850
  "reflectToAttr": false,
6854
- "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.",
6855
6852
  "docsTags": [],
6856
6853
  "default": "false",
6857
6854
  "values": [
@@ -6868,7 +6865,7 @@
6868
6865
  "mutable": false,
6869
6866
  "attr": "small",
6870
6867
  "reflectToAttr": false,
6871
- "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.",
6872
6869
  "docsTags": [],
6873
6870
  "default": "false",
6874
6871
  "values": [
@@ -6971,7 +6968,7 @@
6971
6968
  "mutable": false,
6972
6969
  "attr": "disabled",
6973
6970
  "reflectToAttr": false,
6974
- "docs": "Disables the tab.",
6971
+ "docs": "If `true`, the disabled state will be set.",
6975
6972
  "docsTags": [],
6976
6973
  "default": "false",
6977
6974
  "values": [
@@ -6991,7 +6988,7 @@
6991
6988
  "bubbles": true,
6992
6989
  "cancelable": true,
6993
6990
  "composed": true,
6994
- "docs": "Called when a tab is selected.",
6991
+ "docs": "Emitted when a tab is selected.",
6995
6992
  "docsTags": []
6996
6993
  }
6997
6994
  ],
@@ -7051,7 +7048,7 @@
7051
7048
  "mutable": false,
7052
7049
  "attr": "appearance",
7053
7050
  "reflectToAttr": false,
7054
- "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.",
7055
7052
  "docsTags": [],
7056
7053
  "default": "\"dark\"",
7057
7054
  "values": [
@@ -7073,7 +7070,7 @@
7073
7070
  "mutable": false,
7074
7071
  "attr": "context-id",
7075
7072
  "reflectToAttr": true,
7076
- "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.",
7077
7074
  "docsTags": [],
7078
7075
  "default": "\"default\"",
7079
7076
  "values": [
@@ -7090,7 +7087,7 @@
7090
7087
  "mutable": false,
7091
7088
  "attr": "selected-tab-index",
7092
7089
  "reflectToAttr": false,
7093
- "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.",
7094
7091
  "docsTags": [],
7095
7092
  "values": [
7096
7093
  {
@@ -7142,7 +7139,7 @@
7142
7139
  "mutable": false,
7143
7140
  "attr": "context-id",
7144
7141
  "reflectToAttr": true,
7145
- "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.",
7146
7143
  "docsTags": [],
7147
7144
  "default": "\"default\"",
7148
7145
  "values": [
@@ -7159,7 +7156,7 @@
7159
7156
  "mutable": false,
7160
7157
  "attr": "inline",
7161
7158
  "reflectToAttr": true,
7162
- "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.",
7163
7160
  "docsTags": [],
7164
7161
  "default": "false",
7165
7162
  "values": [
@@ -7176,7 +7173,7 @@
7176
7173
  "mutable": false,
7177
7174
  "attr": "label",
7178
7175
  "reflectToAttr": false,
7179
- "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.",
7180
7177
  "docsTags": [],
7181
7178
  "values": [
7182
7179
  {
@@ -7227,7 +7224,7 @@
7227
7224
  "mutable": false,
7228
7225
  "attr": "context-id",
7229
7226
  "reflectToAttr": true,
7230
- "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.",
7231
7228
  "docsTags": [],
7232
7229
  "default": "\"default\"",
7233
7230
  "values": [
@@ -7269,7 +7266,7 @@
7269
7266
  "mutable": false,
7270
7267
  "attr": "auto-focus",
7271
7268
  "reflectToAttr": false,
7272
- "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.",
7273
7270
  "docsTags": [],
7274
7271
  "default": "false",
7275
7272
  "values": [
@@ -7286,7 +7283,7 @@
7286
7283
  "mutable": false,
7287
7284
  "attr": "autocapitalize",
7288
7285
  "reflectToAttr": false,
7289
- "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\".",
7290
7287
  "docsTags": [],
7291
7288
  "default": "\"off\"",
7292
7289
  "values": [
@@ -7303,7 +7300,7 @@
7303
7300
  "mutable": false,
7304
7301
  "attr": "autocomplete",
7305
7302
  "reflectToAttr": false,
7306
- "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.",
7307
7304
  "docsTags": [],
7308
7305
  "default": "\"off\"",
7309
7306
  "values": [
@@ -7533,7 +7530,7 @@
7533
7530
  "mutable": false,
7534
7531
  "attr": "autocorrect",
7535
7532
  "reflectToAttr": false,
7536
- "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.",
7537
7534
  "docsTags": [],
7538
7535
  "default": "\"off\"",
7539
7536
  "values": [
@@ -7555,7 +7552,7 @@
7555
7552
  "mutable": false,
7556
7553
  "attr": "debounce",
7557
7554
  "reflectToAttr": false,
7558
- "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.",
7559
7556
  "docsTags": [],
7560
7557
  "default": "0",
7561
7558
  "values": [
@@ -7572,7 +7569,7 @@
7572
7569
  "mutable": false,
7573
7570
  "attr": "disabled",
7574
7571
  "reflectToAttr": false,
7575
- "docs": "Specify whether the input is disabled.",
7572
+ "docs": "If `true`, the disabled state will be set.",
7576
7573
  "docsTags": [],
7577
7574
  "default": "false",
7578
7575
  "values": [
@@ -7589,7 +7586,7 @@
7589
7586
  "mutable": false,
7590
7587
  "attr": "full-width",
7591
7588
  "reflectToAttr": false,
7592
- "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.",
7593
7590
  "docsTags": [],
7594
7591
  "default": "false",
7595
7592
  "values": [
@@ -7606,7 +7603,7 @@
7606
7603
  "mutable": false,
7607
7604
  "attr": "helper-text",
7608
7605
  "reflectToAttr": false,
7609
- "docs": "Provide helper text to display additional field guidance.",
7606
+ "docs": "The helper text that will be displayed for additional field guidance.",
7610
7607
  "docsTags": [],
7611
7608
  "default": "\"\"",
7612
7609
  "values": [
@@ -7623,7 +7620,7 @@
7623
7620
  "mutable": false,
7624
7621
  "attr": "hide-label",
7625
7622
  "reflectToAttr": false,
7626
- "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.",
7627
7624
  "docsTags": [],
7628
7625
  "default": "false",
7629
7626
  "values": [
@@ -7640,7 +7637,7 @@
7640
7637
  "mutable": false,
7641
7638
  "attr": "input-id",
7642
7639
  "reflectToAttr": false,
7643
- "docs": "Provide an id for the input",
7640
+ "docs": "The ID for the input.",
7644
7641
  "docsTags": [],
7645
7642
  "default": "`ic-text-field-input-${inputIds++}`",
7646
7643
  "values": [
@@ -7703,7 +7700,7 @@
7703
7700
  "mutable": false,
7704
7701
  "attr": "label",
7705
7702
  "reflectToAttr": false,
7706
- "docs": "Provide a label for the input.",
7703
+ "docs": "The label for the input.",
7707
7704
  "docsTags": [],
7708
7705
  "values": [
7709
7706
  {
@@ -7719,7 +7716,7 @@
7719
7716
  "mutable": false,
7720
7717
  "attr": "max-length",
7721
7718
  "reflectToAttr": false,
7722
- "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.",
7723
7720
  "docsTags": [],
7724
7721
  "default": "0",
7725
7722
  "values": [
@@ -7753,7 +7750,7 @@
7753
7750
  "mutable": false,
7754
7751
  "attr": "placeholder",
7755
7752
  "reflectToAttr": false,
7756
- "docs": "Provide a placeholder value to display.",
7753
+ "docs": "The placeholder value to be displayed.",
7757
7754
  "docsTags": [],
7758
7755
  "default": "\"\"",
7759
7756
  "values": [
@@ -7770,7 +7767,7 @@
7770
7767
  "mutable": false,
7771
7768
  "attr": "readonly",
7772
7769
  "reflectToAttr": false,
7773
- "docs": "Specify whether the input is read only.",
7770
+ "docs": "If `true`, the read only state will be set.",
7774
7771
  "docsTags": [],
7775
7772
  "default": "false",
7776
7773
  "values": [
@@ -7787,7 +7784,7 @@
7787
7784
  "mutable": false,
7788
7785
  "attr": "required",
7789
7786
  "reflectToAttr": false,
7790
- "docs": "Specify if the input requires a value.",
7787
+ "docs": "If `true`, the input will require a value.",
7791
7788
  "docsTags": [],
7792
7789
  "default": "false",
7793
7790
  "values": [
@@ -7804,7 +7801,7 @@
7804
7801
  "mutable": false,
7805
7802
  "attr": "resize",
7806
7803
  "reflectToAttr": false,
7807
- "docs": "Allow resizing of a multiline text area",
7804
+ "docs": "If `true`, the multiline text area will be resizeable.",
7808
7805
  "docsTags": [],
7809
7806
  "default": "false",
7810
7807
  "values": [
@@ -7821,7 +7818,7 @@
7821
7818
  "mutable": false,
7822
7819
  "attr": "rows",
7823
7820
  "reflectToAttr": false,
7824
- "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.",
7825
7822
  "docsTags": [],
7826
7823
  "default": "1",
7827
7824
  "values": [
@@ -7838,7 +7835,7 @@
7838
7835
  "mutable": false,
7839
7836
  "attr": "small",
7840
7837
  "reflectToAttr": false,
7841
- "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.",
7842
7839
  "docsTags": [],
7843
7840
  "default": "false",
7844
7841
  "values": [
@@ -7855,7 +7852,7 @@
7855
7852
  "mutable": false,
7856
7853
  "attr": "spellcheck",
7857
7854
  "reflectToAttr": false,
7858
- "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.",
7859
7856
  "docsTags": [],
7860
7857
  "default": "false",
7861
7858
  "values": [
@@ -7914,7 +7911,7 @@
7914
7911
  "mutable": false,
7915
7912
  "attr": "validation-inline",
7916
7913
  "reflectToAttr": false,
7917
- "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'.",
7918
7915
  "docsTags": [],
7919
7916
  "default": "false",
7920
7917
  "values": [
@@ -7931,7 +7928,7 @@
7931
7928
  "mutable": false,
7932
7929
  "attr": "validation-status",
7933
7930
  "reflectToAttr": false,
7934
- "docs": "Provide validation state - 'error' | 'warning' | 'success'",
7931
+ "docs": "The validation state - e.g. 'error' | 'warning' | 'success'.",
7935
7932
  "docsTags": [],
7936
7933
  "default": "\"\"",
7937
7934
  "values": [
@@ -7960,7 +7957,7 @@
7960
7957
  "mutable": false,
7961
7958
  "attr": "validation-text",
7962
7959
  "reflectToAttr": false,
7963
- "docs": "Provide validation state - 'error' | 'warning' | 'success'",
7960
+ "docs": "The validation state - e.g. 'error' | 'warning' | 'success'.",
7964
7961
  "docsTags": [],
7965
7962
  "default": "\"\"",
7966
7963
  "values": [
@@ -7977,7 +7974,7 @@
7977
7974
  "mutable": true,
7978
7975
  "attr": "value",
7979
7976
  "reflectToAttr": true,
7980
- "docs": "Value of TextField.",
7977
+ "docs": "The value of the text field.",
7981
7978
  "docsTags": [],
7982
7979
  "default": "\"\"",
7983
7980
  "values": [
@@ -8114,7 +8111,7 @@
8114
8111
  "mutable": false,
8115
8112
  "attr": "color",
8116
8113
  "reflectToAttr": false,
8117
- "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)\".",
8118
8115
  "docsTags": [],
8119
8116
  "default": "null",
8120
8117
  "values": [
@@ -8315,7 +8312,7 @@
8315
8312
  "mutable": false,
8316
8313
  "attr": "app-title",
8317
8314
  "reflectToAttr": false,
8318
- "docs": "Title to display",
8315
+ "docs": "The app title to be displayed.",
8319
8316
  "docsTags": [],
8320
8317
  "values": [
8321
8318
  {
@@ -8331,7 +8328,7 @@
8331
8328
  "mutable": false,
8332
8329
  "attr": "content-aligned",
8333
8330
  "reflectToAttr": false,
8334
- "docs": "The alignment of the top nav content",
8331
+ "docs": "The alignment of the top navigation content.",
8335
8332
  "docsTags": [],
8336
8333
  "default": "\"full-width\"",
8337
8334
  "values": [
@@ -8357,7 +8354,7 @@
8357
8354
  "mutable": false,
8358
8355
  "attr": "href",
8359
8356
  "reflectToAttr": false,
8360
- "docs": "The url to navigate to when title is clicked",
8357
+ "docs": "The URL to navigate to when the app title is clicked.",
8361
8358
  "docsTags": [],
8362
8359
  "default": "\"/\"",
8363
8360
  "values": [
@@ -8374,7 +8371,7 @@
8374
8371
  "mutable": false,
8375
8372
  "attr": "inline",
8376
8373
  "reflectToAttr": false,
8377
- "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.",
8378
8375
  "docsTags": [],
8379
8376
  "default": "false",
8380
8377
  "values": [
@@ -8391,7 +8388,7 @@
8391
8388
  "mutable": false,
8392
8389
  "attr": "status",
8393
8390
  "reflectToAttr": false,
8394
- "docs": "Status info to display",
8391
+ "docs": "The status info to be displayed.",
8395
8392
  "docsTags": [],
8396
8393
  "default": "\"\"",
8397
8394
  "values": [
@@ -8408,7 +8405,7 @@
8408
8405
  "mutable": false,
8409
8406
  "attr": "version",
8410
8407
  "reflectToAttr": false,
8411
- "docs": "Version info to display",
8408
+ "docs": "The version info to be displayed.",
8412
8409
  "docsTags": [],
8413
8410
  "default": "\"\"",
8414
8411
  "values": [
@@ -8514,7 +8511,7 @@
8514
8511
  "mutable": false,
8515
8512
  "attr": "apply-vertical-margins",
8516
8513
  "reflectToAttr": false,
8517
- "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.",
8518
8515
  "docsTags": [],
8519
8516
  "default": "false",
8520
8517
  "values": [