@momentum-design/components 0.29.1 → 0.30.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1244,33 +1244,48 @@
1244
1244
  },
1245
1245
  {
1246
1246
  "kind": "javascript-module",
1247
- "path": "components/buttonsimple/buttonsimple.component.js",
1247
+ "path": "components/button/button.component.js",
1248
1248
  "declarations": [
1249
1249
  {
1250
1250
  "kind": "class",
1251
- "description": "`mdc-buttonsimple` is a component that can be configured in various ways to suit different use cases.\nIt is used as an internal component and is not intended to be used directly by consumers.\nConsumers should use the `mdc-button` component instead.",
1252
- "name": "Buttonsimple",
1251
+ "description": "`mdc-button` is a component that can be configured in various ways to suit different use cases.\n\nButton Variants:\n- **Primary**: Solid background color.\n- **Secondary**: Transparent background with a solid border.\n- **Tertiary**: No background or border, appears as plain text but retains all button functionalities.\n\nButton Colors:\n- **Positive**: Green color.\n- **Negative**: Red color.\n- **Accent**: Blue color.\n- **Promotional**: Purple color.\n- **Default**: White color.\n\nButton Sizes (in REM units):\n- **Pill button**: 40, 32, 28, 24.\n- **Icon button**: 64, 52, 40, 32, 28, 24.\n- **Tertiary icon button**: 20.\n\nButton Types:\n- **Pill button**: A button that contains text value. Commonly used for call to action, tags, or filters.\n- **Pill button with icons**: A button containing an icon either on the left or right side of the button.\n- **Icon button**: A button represented by just an icon without any text.\nThe type of button is inferred based on the presence of slot and/or prefix and postfix icons.",
1252
+ "name": "Button",
1253
+ "slots": [
1254
+ {
1255
+ "description": "Text label of the button.",
1256
+ "name": ""
1257
+ }
1258
+ ],
1253
1259
  "members": [
1254
1260
  {
1255
1261
  "kind": "field",
1256
- "name": "active",
1262
+ "name": "prefixIcon",
1257
1263
  "type": {
1258
- "text": "boolean"
1264
+ "text": "string | undefined"
1259
1265
  },
1260
- "default": "false",
1261
- "description": "The button's active state indicates whether it is currently toggled on (active) or off (inactive).\nWhen the active state is true, the button is considered to be in an active state, meaning it is toggled on.\nConversely, when the active state is false, the button is in an inactive state, indicating it is toggled off.",
1262
- "attribute": "active",
1266
+ "description": "The name of the icon to display as a prefix.\nThe icon is displayed on the left side of the button.",
1267
+ "attribute": "prefix-icon",
1263
1268
  "reflects": true
1264
1269
  },
1265
1270
  {
1266
1271
  "kind": "field",
1267
- "name": "softDisabled",
1272
+ "name": "postfixIcon",
1268
1273
  "type": {
1269
- "text": "boolean"
1274
+ "text": "string | undefined"
1270
1275
  },
1271
- "default": "false",
1272
- "description": "Indicates whether the button is soft disabled.\nWhen set to `true`, the button appears visually disabled but still allows\nfocus, click, and keyboard actions to be passed through.\n\n**Important:** When using soft disabled, consumers must ensure that\nthe button behaves like a disabled button, allowing only focus and\npreventing any interactions (clicks or keyboard actions) from triggering unintended actions.",
1273
- "attribute": "soft-disabled"
1276
+ "description": "The name of the icon to display as a postfix.\nThe icon is displayed on the right side of the button.",
1277
+ "attribute": "postfix-icon",
1278
+ "reflects": true
1279
+ },
1280
+ {
1281
+ "kind": "field",
1282
+ "name": "variant",
1283
+ "type": {
1284
+ "text": "ButtonVariant"
1285
+ },
1286
+ "description": "There are 3 variants of button: primary, secondary, tertiary. They are styled differently.\n- **Primary**: Solid background color.\n- **Secondary**: Transparent background with a solid border.\n- **Tertiary**: No background or border, appears as plain text but retains all button functionalities.",
1287
+ "default": "primary",
1288
+ "attribute": "variant"
1274
1289
  },
1275
1290
  {
1276
1291
  "kind": "field",
@@ -1278,18 +1293,170 @@
1278
1293
  "type": {
1279
1294
  "text": "ButtonSize"
1280
1295
  },
1281
- "description": "Simplebutton size is a super set of all the sizes supported by children components.",
1296
+ "description": "Button sizing is based on the button type.\n- **Pill button**: 40, 32, 28, 24.\n- **Icon button**: 64, 52, 40, 32, 28, 24.\n- Tertiary icon button can also be 20.",
1282
1297
  "default": "32",
1283
1298
  "attribute": "size",
1284
- "reflects": true
1299
+ "reflects": true,
1300
+ "inheritedFrom": {
1301
+ "name": "Buttonsimple",
1302
+ "module": "components/buttonsimple/buttonsimple.component.js"
1303
+ }
1304
+ },
1305
+ {
1306
+ "kind": "field",
1307
+ "name": "color",
1308
+ "type": {
1309
+ "text": "ButtonColor"
1310
+ },
1311
+ "description": "There are 5 colors for button: positive, negative, accent, promotional, default.",
1312
+ "default": "default",
1313
+ "attribute": "color"
1285
1314
  },
1286
1315
  {
1287
1316
  "kind": "field",
1288
1317
  "name": "role",
1289
1318
  "description": "This property defines the ARIA role for the element. By default, it is set to 'button'.\nConsumers should override this role when:\n- The element is being used in a context where a different role is more appropriate.\n- Custom behaviors are implemented that require a specific ARIA role for accessibility purposes.",
1290
- "default": "button",
1319
+ "default": "'button'",
1291
1320
  "attribute": "role",
1292
- "reflects": true
1321
+ "reflects": true,
1322
+ "type": {
1323
+ "text": "string"
1324
+ },
1325
+ "inheritedFrom": {
1326
+ "name": "Buttonsimple",
1327
+ "module": "components/buttonsimple/buttonsimple.component.js"
1328
+ }
1329
+ },
1330
+ {
1331
+ "kind": "method",
1332
+ "name": "modifyIconName",
1333
+ "privacy": "private",
1334
+ "parameters": [
1335
+ {
1336
+ "name": "active",
1337
+ "type": {
1338
+ "text": "boolean"
1339
+ },
1340
+ "description": "The active state."
1341
+ }
1342
+ ],
1343
+ "description": "Modifies the icon name based on the active state.\nIf the button is active, the icon name is suffixed with '-filled'.\nIf the button is inactive, the icon name is restored to its original value.\nIf '-filled' icon is not available, the icon name remains unchanged."
1344
+ },
1345
+ {
1346
+ "kind": "method",
1347
+ "name": "setVariant",
1348
+ "privacy": "private",
1349
+ "parameters": [
1350
+ {
1351
+ "name": "variant",
1352
+ "type": {
1353
+ "text": "ButtonVariant"
1354
+ },
1355
+ "description": "The variant to set."
1356
+ }
1357
+ ],
1358
+ "description": "Sets the variant attribute for the button component.\nIf the provided variant is not included in the BUTTON_VARIANTS,\nit defaults to the value specified in DEFAULTS.VARIANT."
1359
+ },
1360
+ {
1361
+ "kind": "method",
1362
+ "name": "setSize",
1363
+ "privacy": "private",
1364
+ "parameters": [
1365
+ {
1366
+ "name": "size",
1367
+ "type": {
1368
+ "text": "PillButtonSize | IconButtonSize"
1369
+ },
1370
+ "description": "The size to set."
1371
+ }
1372
+ ],
1373
+ "description": "Sets the size attribute for the button component.\nValidates the size based on the button type (icon, pill, or tertiary).\nDefaults to DEFAULTS.SIZE if invalid."
1374
+ },
1375
+ {
1376
+ "kind": "method",
1377
+ "name": "setColor",
1378
+ "privacy": "private",
1379
+ "parameters": [
1380
+ {
1381
+ "name": "color",
1382
+ "type": {
1383
+ "text": "ButtonColor"
1384
+ },
1385
+ "description": "The color to set."
1386
+ }
1387
+ ],
1388
+ "description": "Sets the color attribute for the button.\nDefaults to DEFAULTS.COLOR if invalid or for tertiary buttons."
1389
+ },
1390
+ {
1391
+ "kind": "method",
1392
+ "name": "inferButtonType",
1393
+ "privacy": "private",
1394
+ "description": "Infers the type of button based on the presence of slot and/or prefix and postfix icons.",
1395
+ "parameters": [
1396
+ {
1397
+ "description": "default slot of button",
1398
+ "name": "slot"
1399
+ }
1400
+ ]
1401
+ },
1402
+ {
1403
+ "kind": "field",
1404
+ "name": "tabIndex",
1405
+ "type": {
1406
+ "text": "number"
1407
+ },
1408
+ "default": "0",
1409
+ "description": "This property specifies the tab order of the element.",
1410
+ "attribute": "tabIndex",
1411
+ "reflects": true,
1412
+ "inheritedFrom": {
1413
+ "name": "TabIndexMixin",
1414
+ "module": "utils/mixins/TabIndexMixin.js"
1415
+ }
1416
+ },
1417
+ {
1418
+ "kind": "field",
1419
+ "name": "disabled",
1420
+ "type": {
1421
+ "text": "boolean"
1422
+ },
1423
+ "default": "false",
1424
+ "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
1425
+ "attribute": "disabled",
1426
+ "reflects": true,
1427
+ "inheritedFrom": {
1428
+ "name": "DisabledMixin",
1429
+ "module": "utils/mixins/DisabledMixin.js"
1430
+ }
1431
+ },
1432
+ {
1433
+ "kind": "field",
1434
+ "name": "active",
1435
+ "type": {
1436
+ "text": "boolean"
1437
+ },
1438
+ "default": "false",
1439
+ "description": "The button's active state indicates whether it is currently toggled on (active) or off (inactive).\nWhen the active state is true, the button is considered to be in an active state, meaning it is toggled on.\nConversely, when the active state is false, the button is in an inactive state, indicating it is toggled off.",
1440
+ "attribute": "active",
1441
+ "reflects": true,
1442
+ "inheritedFrom": {
1443
+ "name": "Buttonsimple",
1444
+ "module": "components/buttonsimple/buttonsimple.component.js"
1445
+ }
1446
+ },
1447
+ {
1448
+ "kind": "field",
1449
+ "name": "softDisabled",
1450
+ "type": {
1451
+ "text": "boolean"
1452
+ },
1453
+ "default": "false",
1454
+ "description": "Indicates whether the button is soft disabled.\nWhen set to `true`, the button appears visually disabled but still allows\nfocus, click, and keyboard actions to be passed through.\n\n**Important:** When using soft disabled, consumers must ensure that\nthe button behaves like a disabled button, allowing only focus and\npreventing any interactions (clicks or keyboard actions) from triggering unintended actions.",
1455
+ "attribute": "soft-disabled",
1456
+ "inheritedFrom": {
1457
+ "name": "Buttonsimple",
1458
+ "module": "components/buttonsimple/buttonsimple.component.js"
1459
+ }
1293
1460
  },
1294
1461
  {
1295
1462
  "kind": "field",
@@ -1300,12 +1467,20 @@
1300
1467
  "description": "This property defines the type attribute for the button element.\nThe type attribute specifies the behavior of the button when it is clicked.\n- **submit**: The button submits the form data to the server.\n- **reset**: The button resets the form data to its initial state.\n- **button**: The button does nothing when clicked.",
1301
1468
  "default": "button",
1302
1469
  "attribute": "type",
1303
- "reflects": true
1470
+ "reflects": true,
1471
+ "inheritedFrom": {
1472
+ "name": "Buttonsimple",
1473
+ "module": "components/buttonsimple/buttonsimple.component.js"
1474
+ }
1304
1475
  },
1305
1476
  {
1306
1477
  "kind": "method",
1307
1478
  "name": "executeAction",
1308
- "privacy": "protected"
1479
+ "privacy": "protected",
1480
+ "inheritedFrom": {
1481
+ "name": "Buttonsimple",
1482
+ "module": "components/buttonsimple/buttonsimple.component.js"
1483
+ }
1309
1484
  },
1310
1485
  {
1311
1486
  "kind": "method",
@@ -1327,7 +1502,11 @@
1327
1502
  "description": "The active state of the element"
1328
1503
  }
1329
1504
  ],
1330
- "description": "Sets the aria-pressed attribute based on the active state of the button."
1505
+ "description": "Sets the aria-pressed attribute based on the active state of the button.",
1506
+ "inheritedFrom": {
1507
+ "name": "Buttonsimple",
1508
+ "module": "components/buttonsimple/buttonsimple.component.js"
1509
+ }
1331
1510
  },
1332
1511
  {
1333
1512
  "kind": "method",
@@ -1349,7 +1528,11 @@
1349
1528
  "description": "The soft-disabled state."
1350
1529
  }
1351
1530
  ],
1352
- "description": "Sets the soft-disabled attribute for the button.\nWhen soft-disabled, the button looks to be disabled but remains focusable and clickable.\nAlso sets/removes aria-disabled attribute."
1531
+ "description": "Sets the soft-disabled attribute for the button.\nWhen soft-disabled, the button looks to be disabled but remains focusable and clickable.\nAlso sets/removes aria-disabled attribute.",
1532
+ "inheritedFrom": {
1533
+ "name": "Buttonsimple",
1534
+ "module": "components/buttonsimple/buttonsimple.component.js"
1535
+ }
1353
1536
  },
1354
1537
  {
1355
1538
  "kind": "method",
@@ -1371,18 +1554,30 @@
1371
1554
  "description": "The disabled state."
1372
1555
  }
1373
1556
  ],
1374
- "description": "Sets the disabled attribute for the button.\nWhen disabled, the button is not focusable or clickable, and tabindex is set to -1.\nThe previous tabindex is stored and restored when enabled.\nAlso sets/removes aria-disabled attribute."
1557
+ "description": "Sets the disabled attribute for the button.\nWhen disabled, the button is not focusable or clickable, and tabindex is set to -1.\nThe previous tabindex is stored and restored when enabled.\nAlso sets/removes aria-disabled attribute.",
1558
+ "inheritedFrom": {
1559
+ "name": "Buttonsimple",
1560
+ "module": "components/buttonsimple/buttonsimple.component.js"
1561
+ }
1375
1562
  },
1376
1563
  {
1377
1564
  "kind": "method",
1378
1565
  "name": "triggerClickEvent",
1379
- "privacy": "private"
1566
+ "privacy": "private",
1567
+ "inheritedFrom": {
1568
+ "name": "Buttonsimple",
1569
+ "module": "components/buttonsimple/buttonsimple.component.js"
1570
+ }
1380
1571
  },
1381
1572
  {
1382
1573
  "kind": "method",
1383
1574
  "name": "handleBlur",
1384
1575
  "privacy": "private",
1385
- "description": "In case the button is pressed and the focus is lost while pressing,\nthe pressed class is removed."
1576
+ "description": "In case the button is pressed and the focus is lost while pressing,\nthe pressed class is removed.",
1577
+ "inheritedFrom": {
1578
+ "name": "Buttonsimple",
1579
+ "module": "components/buttonsimple/buttonsimple.component.js"
1580
+ }
1386
1581
  },
1387
1582
  {
1388
1583
  "kind": "method",
@@ -1397,7 +1592,11 @@
1397
1592
  "description": "The keyboard event."
1398
1593
  }
1399
1594
  ],
1400
- "description": "Handles the keydown event on the button.\nIf the key is 'Enter' or 'Space', the button is pressed.\nIf the key is 'Enter', the button is pressed. The native HTML button works in the same way."
1595
+ "description": "Handles the keydown event on the button.\nIf the key is 'Enter' or 'Space', the button is pressed.\nIf the key is 'Enter', the button is pressed. The native HTML button works in the same way.",
1596
+ "inheritedFrom": {
1597
+ "name": "Buttonsimple",
1598
+ "module": "components/buttonsimple/buttonsimple.component.js"
1599
+ }
1401
1600
  },
1402
1601
  {
1403
1602
  "kind": "method",
@@ -1412,36 +1611,10 @@
1412
1611
  "description": "The keyboard event."
1413
1612
  }
1414
1613
  ],
1415
- "description": "Handles the keyup event on the button.\nIf the key is 'Enter' or 'Space', the button is clicked.\nIf the key is 'Space', the button is pressed. The native HTML button works in the same way."
1416
- },
1417
- {
1418
- "kind": "field",
1419
- "name": "tabIndex",
1420
- "type": {
1421
- "text": "number"
1422
- },
1423
- "default": "0",
1424
- "description": "This property specifies the tab order of the element.",
1425
- "attribute": "tabIndex",
1426
- "reflects": true,
1427
- "inheritedFrom": {
1428
- "name": "TabIndexMixin",
1429
- "module": "utils/mixins/TabIndexMixin.js"
1430
- }
1431
- },
1432
- {
1433
- "kind": "field",
1434
- "name": "disabled",
1435
- "type": {
1436
- "text": "boolean"
1437
- },
1438
- "default": "false",
1439
- "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
1440
- "attribute": "disabled",
1441
- "reflects": true,
1614
+ "description": "Handles the keyup event on the button.\nIf the key is 'Enter' or 'Space', the button is clicked.\nIf the key is 'Space', the button is pressed. The native HTML button works in the same way.",
1442
1615
  "inheritedFrom": {
1443
- "name": "DisabledMixin",
1444
- "module": "utils/mixins/DisabledMixin.js"
1616
+ "name": "Buttonsimple",
1617
+ "module": "components/buttonsimple/buttonsimple.component.js"
1445
1618
  }
1446
1619
  }
1447
1620
  ],
@@ -1450,69 +1623,103 @@
1450
1623
  "description": "(React: onClick) This event is dispatched when the button is clicked.",
1451
1624
  "name": "click",
1452
1625
  "reactName": "onClick",
1453
- "eventName": "ClickEvent"
1626
+ "eventName": "ClickEvent",
1627
+ "inheritedFrom": {
1628
+ "name": "Buttonsimple",
1629
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
1630
+ }
1454
1631
  },
1455
1632
  {
1456
1633
  "description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the button.",
1457
1634
  "name": "keydown",
1458
1635
  "reactName": "onKeyDown",
1459
- "eventName": "KeydownEvent"
1636
+ "eventName": "KeydownEvent",
1637
+ "inheritedFrom": {
1638
+ "name": "Buttonsimple",
1639
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
1640
+ }
1460
1641
  },
1461
1642
  {
1462
1643
  "description": "(React: onKeyUp) This event is dispatched when a key is released on the button.",
1463
1644
  "name": "keyup",
1464
1645
  "reactName": "onKeyUp",
1465
- "eventName": "KeyupEvent"
1646
+ "eventName": "KeyupEvent",
1647
+ "inheritedFrom": {
1648
+ "name": "Buttonsimple",
1649
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
1650
+ }
1466
1651
  },
1467
1652
  {
1468
1653
  "description": "(React: onFocus) This event is dispatched when the button receives focus.",
1469
1654
  "name": "focus",
1470
1655
  "reactName": "onFocus",
1471
- "eventName": "FocusEvent"
1656
+ "eventName": "FocusEvent",
1657
+ "inheritedFrom": {
1658
+ "name": "Buttonsimple",
1659
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
1660
+ }
1472
1661
  }
1473
1662
  ],
1474
1663
  "attributes": [
1475
1664
  {
1476
- "name": "active",
1665
+ "name": "prefix-icon",
1477
1666
  "type": {
1478
- "text": "boolean"
1667
+ "text": "string | undefined"
1479
1668
  },
1480
- "default": "false",
1481
- "description": "The button's active state indicates whether it is currently toggled on (active) or off (inactive).\nWhen the active state is true, the button is considered to be in an active state, meaning it is toggled on.\nConversely, when the active state is false, the button is in an inactive state, indicating it is toggled off.",
1482
- "fieldName": "active"
1669
+ "description": "The name of the icon to display as a prefix.\nThe icon is displayed on the left side of the button.",
1670
+ "fieldName": "prefixIcon"
1483
1671
  },
1484
1672
  {
1485
- "name": "soft-disabled",
1673
+ "name": "postfix-icon",
1486
1674
  "type": {
1487
- "text": "boolean"
1675
+ "text": "string | undefined"
1488
1676
  },
1489
- "default": "false",
1490
- "description": "Indicates whether the button is soft disabled.\nWhen set to `true`, the button appears visually disabled but still allows\nfocus, click, and keyboard actions to be passed through.\n\n**Important:** When using soft disabled, consumers must ensure that\nthe button behaves like a disabled button, allowing only focus and\npreventing any interactions (clicks or keyboard actions) from triggering unintended actions.",
1491
- "fieldName": "softDisabled"
1677
+ "description": "The name of the icon to display as a postfix.\nThe icon is displayed on the right side of the button.",
1678
+ "fieldName": "postfixIcon"
1679
+ },
1680
+ {
1681
+ "name": "variant",
1682
+ "type": {
1683
+ "text": "ButtonVariant"
1684
+ },
1685
+ "description": "There are 3 variants of button: primary, secondary, tertiary. They are styled differently.\n- **Primary**: Solid background color.\n- **Secondary**: Transparent background with a solid border.\n- **Tertiary**: No background or border, appears as plain text but retains all button functionalities.",
1686
+ "default": "primary",
1687
+ "fieldName": "variant"
1492
1688
  },
1493
1689
  {
1494
1690
  "name": "size",
1495
1691
  "type": {
1496
1692
  "text": "ButtonSize"
1497
1693
  },
1498
- "description": "Simplebutton size is a super set of all the sizes supported by children components.",
1694
+ "description": "Button sizing is based on the button type.\n- **Pill button**: 40, 32, 28, 24.\n- **Icon button**: 64, 52, 40, 32, 28, 24.\n- Tertiary icon button can also be 20.",
1499
1695
  "default": "32",
1500
- "fieldName": "size"
1696
+ "fieldName": "size",
1697
+ "inheritedFrom": {
1698
+ "name": "Buttonsimple",
1699
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
1700
+ }
1501
1701
  },
1502
1702
  {
1503
- "name": "role",
1504
- "description": "This property defines the ARIA role for the element. By default, it is set to 'button'.\nConsumers should override this role when:\n- The element is being used in a context where a different role is more appropriate.\n- Custom behaviors are implemented that require a specific ARIA role for accessibility purposes.",
1505
- "default": "button",
1506
- "fieldName": "role"
1703
+ "name": "color",
1704
+ "type": {
1705
+ "text": "ButtonColor"
1706
+ },
1707
+ "description": "There are 5 colors for button: positive, negative, accent, promotional, default.",
1708
+ "default": "default",
1709
+ "fieldName": "color"
1507
1710
  },
1508
1711
  {
1509
- "name": "type",
1712
+ "name": "role",
1713
+ "description": "This property defines the ARIA role for the element. By default, it is set to 'button'.\nConsumers should override this role when:\n- The element is being used in a context where a different role is more appropriate.\n- Custom behaviors are implemented that require a specific ARIA role for accessibility purposes.",
1714
+ "default": "'button'",
1715
+ "fieldName": "role",
1510
1716
  "type": {
1511
- "text": "ButtonType"
1717
+ "text": "string"
1512
1718
  },
1513
- "description": "This property defines the type attribute for the button element.\nThe type attribute specifies the behavior of the button when it is clicked.\n- **submit**: The button submits the form data to the server.\n- **reset**: The button resets the form data to its initial state.\n- **button**: The button does nothing when clicked.",
1514
- "default": "button",
1515
- "fieldName": "type"
1719
+ "inheritedFrom": {
1720
+ "name": "Buttonsimple",
1721
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
1722
+ }
1516
1723
  },
1517
1724
  {
1518
1725
  "name": "tabIndex",
@@ -1539,24 +1746,53 @@
1539
1746
  "name": "DisabledMixin",
1540
1747
  "module": "src/utils/mixins/DisabledMixin.ts"
1541
1748
  }
1542
- }
1543
- ],
1544
- "mixins": [
1749
+ },
1545
1750
  {
1546
- "name": "TabIndexMixin",
1547
- "module": "/src/utils/mixins/TabIndexMixin"
1751
+ "name": "active",
1752
+ "type": {
1753
+ "text": "boolean"
1754
+ },
1755
+ "default": "false",
1756
+ "description": "The button's active state indicates whether it is currently toggled on (active) or off (inactive).\nWhen the active state is true, the button is considered to be in an active state, meaning it is toggled on.\nConversely, when the active state is false, the button is in an inactive state, indicating it is toggled off.",
1757
+ "fieldName": "active",
1758
+ "inheritedFrom": {
1759
+ "name": "Buttonsimple",
1760
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
1761
+ }
1548
1762
  },
1549
1763
  {
1550
- "name": "DisabledMixin",
1551
- "module": "/src/utils/mixins/DisabledMixin"
1764
+ "name": "soft-disabled",
1765
+ "type": {
1766
+ "text": "boolean"
1767
+ },
1768
+ "default": "false",
1769
+ "description": "Indicates whether the button is soft disabled.\nWhen set to `true`, the button appears visually disabled but still allows\nfocus, click, and keyboard actions to be passed through.\n\n**Important:** When using soft disabled, consumers must ensure that\nthe button behaves like a disabled button, allowing only focus and\npreventing any interactions (clicks or keyboard actions) from triggering unintended actions.",
1770
+ "fieldName": "softDisabled",
1771
+ "inheritedFrom": {
1772
+ "name": "Buttonsimple",
1773
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
1774
+ }
1775
+ },
1776
+ {
1777
+ "name": "type",
1778
+ "type": {
1779
+ "text": "ButtonType"
1780
+ },
1781
+ "description": "This property defines the type attribute for the button element.\nThe type attribute specifies the behavior of the button when it is clicked.\n- **submit**: The button submits the form data to the server.\n- **reset**: The button resets the form data to its initial state.\n- **button**: The button does nothing when clicked.",
1782
+ "default": "button",
1783
+ "fieldName": "type",
1784
+ "inheritedFrom": {
1785
+ "name": "Buttonsimple",
1786
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
1787
+ }
1552
1788
  }
1553
1789
  ],
1554
1790
  "superclass": {
1555
- "name": "Component",
1556
- "module": "/src/models"
1791
+ "name": "Buttonsimple",
1792
+ "module": "/src/components/buttonsimple/buttonsimple.component"
1557
1793
  },
1558
- "tagName": "mdc-buttonsimple",
1559
- "jsDoc": "/**\n * `mdc-buttonsimple` is a component that can be configured in various ways to suit different use cases.\n * It is used as an internal component and is not intended to be used directly by consumers.\n * Consumers should use the `mdc-button` component instead.\n *\n * @event click - (React: onClick) This event is dispatched when the button is clicked.\n * @event keydown - (React: onKeyDown) This event is dispatched when a key is pressed down on the button.\n * @event keyup - (React: onKeyUp) This event is dispatched when a key is released on the button.\n * @event focus - (React: onFocus) This event is dispatched when the button receives focus.\n *\n * @tagname mdc-buttonsimple\n */",
1794
+ "tagName": "mdc-button",
1795
+ "jsDoc": "/**\n * `mdc-button` is a component that can be configured in various ways to suit different use cases.\n *\n * Button Variants:\n * - **Primary**: Solid background color.\n * - **Secondary**: Transparent background with a solid border.\n * - **Tertiary**: No background or border, appears as plain text but retains all button functionalities.\n *\n * Button Colors:\n * - **Positive**: Green color.\n * - **Negative**: Red color.\n * - **Accent**: Blue color.\n * - **Promotional**: Purple color.\n * - **Default**: White color.\n *\n * Button Sizes (in REM units):\n * - **Pill button**: 40, 32, 28, 24.\n * - **Icon button**: 64, 52, 40, 32, 28, 24.\n * - **Tertiary icon button**: 20.\n *\n * Button Types:\n * - **Pill button**: A button that contains text value. Commonly used for call to action, tags, or filters.\n * - **Pill button with icons**: A button containing an icon either on the left or right side of the button.\n * - **Icon button**: A button represented by just an icon without any text.\n * The type of button is inferred based on the presence of slot and/or prefix and postfix icons.\n *\n * @dependency mdc-icon\n *\n * @event click - (React: onClick) This event is dispatched when the button is clicked.\n * @event keydown - (React: onKeyDown) This event is dispatched when a key is pressed down on the button.\n * @event keyup - (React: onKeyUp) This event is dispatched when a key is released on the button.\n * @event focus - (React: onFocus) This event is dispatched when the button receives focus.\n *\n * @tagname mdc-button\n *\n * @slot - Text label of the button.\n */",
1560
1796
  "customElement": true
1561
1797
  }
1562
1798
  ],
@@ -1565,140 +1801,158 @@
1565
1801
  "kind": "js",
1566
1802
  "name": "default",
1567
1803
  "declaration": {
1568
- "name": "Buttonsimple",
1569
- "module": "components/buttonsimple/buttonsimple.component.js"
1804
+ "name": "Button",
1805
+ "module": "components/button/button.component.js"
1570
1806
  }
1571
1807
  }
1572
1808
  ]
1573
1809
  },
1574
1810
  {
1575
1811
  "kind": "javascript-module",
1576
- "path": "components/checkbox/checkbox.component.js",
1812
+ "path": "components/buttonsimple/buttonsimple.component.js",
1577
1813
  "declarations": [
1578
1814
  {
1579
1815
  "kind": "class",
1580
- "description": "Checkboxes allow users to select multiple options from a list or turn an item/feature on or off.\nThese are often used in forms, settings, and selections in lists.\n\nA checkbox component contains an optional label and an optional helper text.\n\nTo create a group of checkboxes, use the FormFieldGroup component.",
1581
- "name": "Checkbox",
1582
- "cssProperties": [
1583
- {
1584
- "description": "Allows customization of the background color on hover.",
1585
- "name": "--mdc-checkbox-background-color-hover"
1586
- },
1587
- {
1588
- "description": "Border color in high contrast.",
1589
- "name": "--mdc-checkbox-border-color"
1590
- },
1591
- {
1592
- "description": "Background color for a selected checkbox.",
1593
- "name": "--mdc-checkbox-checked-background-color"
1594
- },
1595
- {
1596
- "description": "Background color for a selected checkbox when hovered.",
1597
- "name": "--mdc-checkbox-checked-background-color-hover"
1598
- },
1599
- {
1600
- "description": "Background color for a selected checkbox when pressed.",
1601
- "name": "--mdc-checkbox-checked-pressed-icon-color"
1602
- },
1603
- {
1604
- "description": "Background color for a disabled checkbox.",
1605
- "name": "--mdc-checkbox-disabled-background-color"
1606
- },
1607
- {
1608
- "description": "Border color for a disabled checkbox.",
1609
- "name": "--mdc-checkbox-disabled-border-color"
1610
- },
1611
- {
1612
- "description": "Background color for a disabled, selected checkbox.",
1613
- "name": "--mdc-checkbox-disabled-checked-icon-color"
1614
- },
1615
- {
1616
- "description": "Icon color for a disabled checkbox.",
1617
- "name": "--mdc-checkbox-disabled-icon-color"
1618
- },
1619
- {
1620
- "description": "Background color for an unselected checkbox.",
1621
- "name": "--mdc-checkbox-icon-background-color"
1622
- },
1623
- {
1624
- "description": "Default background color for an unselected checkbox.",
1625
- "name": "--mdc-checkbox-icon-border-color"
1626
- },
1627
- {
1628
- "description": "Icon color for an unselected checkbox.",
1629
- "name": "--mdc-checkbox-icon-color"
1630
- },
1631
- {
1632
- "description": "Background color for a selected checkbox when pressed.",
1633
- "name": "--mdc-checkbox-pressed-icon-color"
1634
- }
1635
- ],
1816
+ "description": "`mdc-buttonsimple` is a component that can be configured in various ways to suit different use cases.\nIt is used as an internal component and is not intended to be used directly by consumers.\nConsumers should use the `mdc-button` component instead.",
1817
+ "name": "Buttonsimple",
1636
1818
  "members": [
1637
1819
  {
1638
1820
  "kind": "field",
1639
- "name": "checked",
1821
+ "name": "active",
1640
1822
  "type": {
1641
1823
  "text": "boolean"
1642
1824
  },
1643
1825
  "default": "false",
1644
- "description": "Determines whether the checkbox is selected or unselected.",
1645
- "attribute": "checked",
1826
+ "description": "The button's active state indicates whether it is currently toggled on (active) or off (inactive).\nWhen the active state is true, the button is considered to be in an active state, meaning it is toggled on.\nConversely, when the active state is false, the button is in an inactive state, indicating it is toggled off.",
1827
+ "attribute": "active",
1646
1828
  "reflects": true
1647
1829
  },
1648
1830
  {
1649
1831
  "kind": "field",
1650
- "name": "indeterminate",
1832
+ "name": "softDisabled",
1651
1833
  "type": {
1652
1834
  "text": "boolean"
1653
1835
  },
1654
1836
  "default": "false",
1655
- "description": "This property is used to determine the parent checkbox in a nested checkbox group.\nIf any one of the children is unselected, then the parent checkbox will be indeterminate.\nIf all children are either selected or unselected, then the parent checkbox will not be indeterminate.",
1656
- "attribute": "indeterminate",
1657
- "reflects": true
1837
+ "description": "Indicates whether the button is soft disabled.\nWhen set to `true`, the button appears visually disabled but still allows\nfocus, click, and keyboard actions to be passed through.\n\n**Important:** When using soft disabled, consumers must ensure that\nthe button behaves like a disabled button, allowing only focus and\npreventing any interactions (clicks or keyboard actions) from triggering unintended actions.",
1838
+ "attribute": "soft-disabled"
1658
1839
  },
1659
1840
  {
1660
1841
  "kind": "field",
1661
- "name": "autofocus",
1842
+ "name": "size",
1662
1843
  "type": {
1663
- "text": "boolean"
1844
+ "text": "ButtonSize"
1664
1845
  },
1665
- "default": "false",
1666
- "description": "Automatically focus on the element when the page loads.\n[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/autofocus)",
1667
- "attribute": "autofocus",
1846
+ "description": "Simplebutton size is a super set of all the sizes supported by children components.",
1847
+ "default": "32",
1848
+ "attribute": "size",
1668
1849
  "reflects": true
1669
1850
  },
1670
1851
  {
1671
- "kind": "method",
1672
- "name": "setFormValue",
1673
- "privacy": "private",
1674
- "description": "Updates the form value to reflect the current state of the checkbox.\nIf checked, the value is set to either the user-provided value or 'on' if no value is provided.\nIf unchecked, the value is set to null."
1675
- },
1676
- {
1677
- "kind": "method",
1678
- "name": "manageRequired",
1679
- "privacy": "private",
1680
- "description": "Manages the required state of the checkbox.\nIf the checkbox is not checked and the requiredLabel property is set, then the checkbox is invalid."
1852
+ "kind": "field",
1853
+ "name": "role",
1854
+ "description": "This property defines the ARIA role for the element. By default, it is set to 'button'.\nConsumers should override this role when:\n- The element is being used in a context where a different role is more appropriate.\n- Custom behaviors are implemented that require a specific ARIA role for accessibility purposes.",
1855
+ "default": "button",
1856
+ "attribute": "role",
1857
+ "reflects": true
1858
+ },
1859
+ {
1860
+ "kind": "field",
1861
+ "name": "type",
1862
+ "type": {
1863
+ "text": "ButtonType"
1864
+ },
1865
+ "description": "This property defines the type attribute for the button element.\nThe type attribute specifies the behavior of the button when it is clicked.\n- **submit**: The button submits the form data to the server.\n- **reset**: The button resets the form data to its initial state.\n- **button**: The button does nothing when clicked.",
1866
+ "default": "button",
1867
+ "attribute": "type",
1868
+ "reflects": true
1681
1869
  },
1682
1870
  {
1683
1871
  "kind": "method",
1684
- "name": "toggleState",
1872
+ "name": "executeAction",
1873
+ "privacy": "protected"
1874
+ },
1875
+ {
1876
+ "kind": "method",
1877
+ "name": "setActive",
1878
+ "privacy": "protected",
1879
+ "parameters": [
1880
+ {
1881
+ "name": "element",
1882
+ "type": {
1883
+ "text": "HTMLElement"
1884
+ },
1885
+ "description": "The button element"
1886
+ },
1887
+ {
1888
+ "name": "active",
1889
+ "type": {
1890
+ "text": "boolean"
1891
+ },
1892
+ "description": "The active state of the element"
1893
+ }
1894
+ ],
1895
+ "description": "Sets the aria-pressed attribute based on the active state of the button."
1896
+ },
1897
+ {
1898
+ "kind": "method",
1899
+ "name": "setSoftDisabled",
1685
1900
  "privacy": "private",
1686
- "return": {
1687
- "type": {
1688
- "text": "void"
1901
+ "parameters": [
1902
+ {
1903
+ "name": "element",
1904
+ "type": {
1905
+ "text": "HTMLElement"
1906
+ },
1907
+ "description": "The button element."
1908
+ },
1909
+ {
1910
+ "name": "softDisabled",
1911
+ "type": {
1912
+ "text": "boolean"
1913
+ },
1914
+ "description": "The soft-disabled state."
1689
1915
  }
1690
- },
1691
- "description": "Toggles the state of the checkbox element.\nIf the element is not disabled, then\nthe checked property is toggled and the indeterminate property is set to false."
1916
+ ],
1917
+ "description": "Sets the soft-disabled attribute for the button.\nWhen soft-disabled, the button looks to be disabled but remains focusable and clickable.\nAlso sets/removes aria-disabled attribute."
1692
1918
  },
1693
1919
  {
1694
1920
  "kind": "method",
1695
- "name": "handleKeyDown",
1921
+ "name": "setDisabled",
1696
1922
  "privacy": "private",
1697
- "return": {
1698
- "type": {
1699
- "text": "void"
1923
+ "parameters": [
1924
+ {
1925
+ "name": "element",
1926
+ "type": {
1927
+ "text": "HTMLElement"
1928
+ },
1929
+ "description": "The button element."
1930
+ },
1931
+ {
1932
+ "name": "disabled",
1933
+ "type": {
1934
+ "text": "boolean"
1935
+ },
1936
+ "description": "The disabled state."
1700
1937
  }
1701
- },
1938
+ ],
1939
+ "description": "Sets the disabled attribute for the button.\nWhen disabled, the button is not focusable or clickable, and tabindex is set to -1.\nThe previous tabindex is stored and restored when enabled.\nAlso sets/removes aria-disabled attribute."
1940
+ },
1941
+ {
1942
+ "kind": "method",
1943
+ "name": "triggerClickEvent",
1944
+ "privacy": "private"
1945
+ },
1946
+ {
1947
+ "kind": "method",
1948
+ "name": "handleBlur",
1949
+ "privacy": "private",
1950
+ "description": "In case the button is pressed and the focus is lost while pressing,\nthe pressed class is removed."
1951
+ },
1952
+ {
1953
+ "kind": "method",
1954
+ "name": "handleKeyDown",
1955
+ "privacy": "private",
1702
1956
  "parameters": [
1703
1957
  {
1704
1958
  "name": "event",
@@ -1708,501 +1962,812 @@
1708
1962
  "description": "The keyboard event."
1709
1963
  }
1710
1964
  ],
1711
- "description": "Handles the keydown event on the checkbox.\nWhen the user presses Enter, the form is submitted."
1965
+ "description": "Handles the keydown event on the button.\nIf the key is 'Enter' or 'Space', the button is pressed.\nIf the key is 'Enter', the button is pressed. The native HTML button works in the same way."
1712
1966
  },
1713
1967
  {
1714
1968
  "kind": "method",
1715
- "name": "handleChange",
1716
- "privacy": "public",
1717
- "return": {
1718
- "type": {
1719
- "text": "void"
1720
- }
1721
- },
1969
+ "name": "handleKeyUp",
1970
+ "privacy": "private",
1722
1971
  "parameters": [
1723
1972
  {
1724
1973
  "name": "event",
1725
1974
  "type": {
1726
- "text": "Event"
1727
- }
1975
+ "text": "KeyboardEvent"
1976
+ },
1977
+ "description": "The keyboard event."
1728
1978
  }
1729
1979
  ],
1730
- "description": "Toggles the state of the checkbox element.\nand dispatch the new change event."
1731
- },
1732
- {
1733
- "kind": "field",
1734
- "name": "renderLabelAndHelperText",
1735
- "privacy": "private"
1980
+ "description": "Handles the keyup event on the button.\nIf the key is 'Enter' or 'Space', the button is clicked.\nIf the key is 'Space', the button is pressed. The native HTML button works in the same way."
1736
1981
  },
1737
1982
  {
1738
1983
  "kind": "field",
1739
- "name": "helpTextType",
1984
+ "name": "tabIndex",
1740
1985
  "type": {
1741
- "text": "ValidationType"
1986
+ "text": "number"
1742
1987
  },
1743
- "description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
1744
- "attribute": "help-text-type",
1988
+ "default": "0",
1989
+ "description": "This property specifies the tab order of the element.",
1990
+ "attribute": "tabIndex",
1745
1991
  "reflects": true,
1746
- "default": "undefined as unknown",
1747
1992
  "inheritedFrom": {
1748
- "name": "FormfieldWrapper",
1749
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
1993
+ "name": "TabIndexMixin",
1994
+ "module": "utils/mixins/TabIndexMixin.js"
1750
1995
  }
1751
1996
  },
1752
1997
  {
1753
1998
  "kind": "field",
1754
- "name": "name",
1999
+ "name": "disabled",
1755
2000
  "type": {
1756
- "text": "string"
2001
+ "text": "boolean"
1757
2002
  },
1758
- "default": "''",
1759
- "description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
1760
- "attribute": "name",
2003
+ "default": "false",
2004
+ "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
2005
+ "attribute": "disabled",
1761
2006
  "reflects": true,
1762
2007
  "inheritedFrom": {
1763
- "name": "FormInternalsMixin",
1764
- "module": "utils/mixins/FormInternalsMixin.js"
2008
+ "name": "DisabledMixin",
2009
+ "module": "utils/mixins/DisabledMixin.js"
1765
2010
  }
2011
+ }
2012
+ ],
2013
+ "events": [
2014
+ {
2015
+ "description": "(React: onClick) This event is dispatched when the button is clicked.",
2016
+ "name": "click",
2017
+ "reactName": "onClick",
2018
+ "eventName": "ClickEvent"
1766
2019
  },
1767
2020
  {
1768
- "kind": "field",
1769
- "name": "value",
2021
+ "description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the button.",
2022
+ "name": "keydown",
2023
+ "reactName": "onKeyDown",
2024
+ "eventName": "KeydownEvent"
2025
+ },
2026
+ {
2027
+ "description": "(React: onKeyUp) This event is dispatched when a key is released on the button.",
2028
+ "name": "keyup",
2029
+ "reactName": "onKeyUp",
2030
+ "eventName": "KeyupEvent"
2031
+ },
2032
+ {
2033
+ "description": "(React: onFocus) This event is dispatched when the button receives focus.",
2034
+ "name": "focus",
2035
+ "reactName": "onFocus",
2036
+ "eventName": "FocusEvent"
2037
+ }
2038
+ ],
2039
+ "attributes": [
2040
+ {
2041
+ "name": "active",
1770
2042
  "type": {
1771
- "text": "string"
2043
+ "text": "boolean"
1772
2044
  },
1773
- "default": "''",
1774
- "description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
1775
- "attribute": "value",
1776
- "reflects": true,
1777
- "inheritedFrom": {
1778
- "name": "FormInternalsMixin",
1779
- "module": "utils/mixins/FormInternalsMixin.js"
1780
- }
2045
+ "default": "false",
2046
+ "description": "The button's active state indicates whether it is currently toggled on (active) or off (inactive).\nWhen the active state is true, the button is considered to be in an active state, meaning it is toggled on.\nConversely, when the active state is false, the button is in an inactive state, indicating it is toggled off.",
2047
+ "fieldName": "active"
1781
2048
  },
1782
2049
  {
1783
- "kind": "field",
1784
- "name": "validationMessage",
2050
+ "name": "soft-disabled",
1785
2051
  "type": {
1786
- "text": "string | undefined"
2052
+ "text": "boolean"
1787
2053
  },
1788
- "description": "Custom validation message that will override the default message and displayed when the input is invalid.",
1789
- "attribute": "validation-message",
1790
- "reflects": true,
1791
- "inheritedFrom": {
1792
- "name": "FormInternalsMixin",
1793
- "module": "utils/mixins/FormInternalsMixin.js"
1794
- }
2054
+ "default": "false",
2055
+ "description": "Indicates whether the button is soft disabled.\nWhen set to `true`, the button appears visually disabled but still allows\nfocus, click, and keyboard actions to be passed through.\n\n**Important:** When using soft disabled, consumers must ensure that\nthe button behaves like a disabled button, allowing only focus and\npreventing any interactions (clicks or keyboard actions) from triggering unintended actions.",
2056
+ "fieldName": "softDisabled"
1795
2057
  },
1796
2058
  {
1797
- "kind": "field",
1798
- "name": "validity",
2059
+ "name": "size",
1799
2060
  "type": {
1800
- "text": "ValidityState"
2061
+ "text": "ButtonSize"
1801
2062
  },
1802
- "readonly": true,
1803
- "inheritedFrom": {
1804
- "name": "FormInternalsMixin",
1805
- "module": "utils/mixins/FormInternalsMixin.js"
1806
- }
2063
+ "description": "Simplebutton size is a super set of all the sizes supported by children components.",
2064
+ "default": "32",
2065
+ "fieldName": "size"
1807
2066
  },
1808
2067
  {
1809
- "kind": "field",
1810
- "name": "willValidate",
1811
- "readonly": true,
1812
- "inheritedFrom": {
1813
- "name": "FormInternalsMixin",
1814
- "module": "utils/mixins/FormInternalsMixin.js"
1815
- }
2068
+ "name": "role",
2069
+ "description": "This property defines the ARIA role for the element. By default, it is set to 'button'.\nConsumers should override this role when:\n- The element is being used in a context where a different role is more appropriate.\n- Custom behaviors are implemented that require a specific ARIA role for accessibility purposes.",
2070
+ "default": "button",
2071
+ "fieldName": "role"
1816
2072
  },
1817
2073
  {
1818
- "kind": "method",
1819
- "name": "setValidity",
1820
- "description": "Sets the validity of the input field based on the input field's validity.",
1821
- "return": {
1822
- "type": {
1823
- "text": ""
1824
- }
2074
+ "name": "type",
2075
+ "type": {
2076
+ "text": "ButtonType"
1825
2077
  },
1826
- "inheritedFrom": {
1827
- "name": "FormInternalsMixin",
1828
- "module": "utils/mixins/FormInternalsMixin.js"
1829
- }
1830
- },
1831
- {
1832
- "kind": "method",
1833
- "name": "checkValidity",
1834
- "return": {
1835
- "type": {
1836
- "text": "boolean"
1837
- }
1838
- },
1839
- "inheritedFrom": {
1840
- "name": "FormInternalsMixin",
1841
- "module": "utils/mixins/FormInternalsMixin.js"
1842
- }
1843
- },
1844
- {
1845
- "kind": "method",
1846
- "name": "reportValidity",
1847
- "inheritedFrom": {
1848
- "name": "FormInternalsMixin",
1849
- "module": "utils/mixins/FormInternalsMixin.js"
1850
- }
1851
- },
1852
- {
1853
- "kind": "field",
1854
- "name": "id",
1855
- "type": {
1856
- "text": "string"
1857
- },
1858
- "default": "`mdc-input-${uuidv4()}`",
1859
- "description": "The unique id of the input field. It is used to link the input field with the label.",
1860
- "attribute": "id",
1861
- "inheritedFrom": {
1862
- "name": "FormfieldWrapper",
1863
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
1864
- }
2078
+ "description": "This property defines the type attribute for the button element.\nThe type attribute specifies the behavior of the button when it is clicked.\n- **submit**: The button submits the form data to the server.\n- **reset**: The button resets the form data to its initial state.\n- **button**: The button does nothing when clicked.",
2079
+ "default": "button",
2080
+ "fieldName": "type"
1865
2081
  },
1866
2082
  {
1867
- "kind": "field",
1868
- "name": "dataAriaLabel",
2083
+ "name": "tabIndex",
1869
2084
  "type": {
1870
- "text": "string | null"
2085
+ "text": "number"
1871
2086
  },
1872
- "default": "null",
1873
- "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
1874
- "attribute": "data-aria-label",
1875
- "reflects": true,
2087
+ "default": "0",
2088
+ "description": "This property specifies the tab order of the element.",
2089
+ "fieldName": "tabIndex",
1876
2090
  "inheritedFrom": {
1877
- "name": "DataAriaLabelMixin",
1878
- "module": "utils/mixins/DataAriaLabelMixin.js"
2091
+ "name": "TabIndexMixin",
2092
+ "module": "src/utils/mixins/TabIndexMixin.ts"
1879
2093
  }
1880
2094
  },
1881
2095
  {
1882
- "kind": "field",
1883
2096
  "name": "disabled",
1884
2097
  "type": {
1885
2098
  "text": "boolean"
1886
2099
  },
1887
2100
  "default": "false",
1888
2101
  "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
1889
- "attribute": "disabled",
1890
- "reflects": true,
2102
+ "fieldName": "disabled",
1891
2103
  "inheritedFrom": {
1892
2104
  "name": "DisabledMixin",
1893
- "module": "utils/mixins/DisabledMixin.js"
2105
+ "module": "src/utils/mixins/DisabledMixin.ts"
1894
2106
  }
2107
+ }
2108
+ ],
2109
+ "mixins": [
2110
+ {
2111
+ "name": "TabIndexMixin",
2112
+ "module": "/src/utils/mixins/TabIndexMixin"
1895
2113
  },
1896
2114
  {
1897
- "kind": "field",
1898
- "name": "label",
1899
- "type": {
1900
- "text": "string | undefined"
1901
- },
1902
- "description": "The label of the input field. It is linked to the input field using the `for` attribute.",
1903
- "attribute": "label",
1904
- "reflects": true,
1905
- "inheritedFrom": {
1906
- "name": "FormfieldWrapper",
1907
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
1908
- }
2115
+ "name": "DisabledMixin",
2116
+ "module": "/src/utils/mixins/DisabledMixin"
2117
+ }
2118
+ ],
2119
+ "superclass": {
2120
+ "name": "Component",
2121
+ "module": "/src/models"
2122
+ },
2123
+ "tagName": "mdc-buttonsimple",
2124
+ "jsDoc": "/**\n * `mdc-buttonsimple` is a component that can be configured in various ways to suit different use cases.\n * It is used as an internal component and is not intended to be used directly by consumers.\n * Consumers should use the `mdc-button` component instead.\n *\n * @event click - (React: onClick) This event is dispatched when the button is clicked.\n * @event keydown - (React: onKeyDown) This event is dispatched when a key is pressed down on the button.\n * @event keyup - (React: onKeyUp) This event is dispatched when a key is released on the button.\n * @event focus - (React: onFocus) This event is dispatched when the button receives focus.\n *\n * @tagname mdc-buttonsimple\n */",
2125
+ "customElement": true
2126
+ }
2127
+ ],
2128
+ "exports": [
2129
+ {
2130
+ "kind": "js",
2131
+ "name": "default",
2132
+ "declaration": {
2133
+ "name": "Buttonsimple",
2134
+ "module": "components/buttonsimple/buttonsimple.component.js"
2135
+ }
2136
+ }
2137
+ ]
2138
+ },
2139
+ {
2140
+ "kind": "javascript-module",
2141
+ "path": "components/checkbox/checkbox.component.js",
2142
+ "declarations": [
2143
+ {
2144
+ "kind": "class",
2145
+ "description": "Checkboxes allow users to select multiple options from a list or turn an item/feature on or off.\nThese are often used in forms, settings, and selections in lists.\n\nA checkbox component contains an optional label and an optional helper text.\n\nTo create a group of checkboxes, use the FormFieldGroup component.",
2146
+ "name": "Checkbox",
2147
+ "cssProperties": [
2148
+ {
2149
+ "description": "Allows customization of the background color on hover.",
2150
+ "name": "--mdc-checkbox-background-color-hover"
1909
2151
  },
1910
2152
  {
1911
- "kind": "field",
1912
- "name": "requiredLabel",
1913
- "type": {
1914
- "text": "string | undefined"
1915
- },
1916
- "description": "The required label of the input field.\nWhen an appropriate string value is set,\nthe input field is marked as required and the label is appended with this text.",
1917
- "attribute": "required-label",
1918
- "reflects": true,
1919
- "inheritedFrom": {
1920
- "name": "FormfieldWrapper",
1921
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
1922
- }
2153
+ "description": "Border color in high contrast.",
2154
+ "name": "--mdc-checkbox-border-color"
1923
2155
  },
1924
2156
  {
1925
- "kind": "field",
1926
- "name": "helpText",
1927
- "type": {
1928
- "text": "string | undefined"
1929
- },
1930
- "description": "The help text that is displayed below the input field.",
1931
- "attribute": "help-text",
1932
- "reflects": true,
1933
- "inheritedFrom": {
1934
- "name": "FormfieldWrapper",
1935
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
1936
- }
2157
+ "description": "Background color for a selected checkbox.",
2158
+ "name": "--mdc-checkbox-checked-background-color"
1937
2159
  },
1938
2160
  {
1939
- "kind": "method",
1940
- "name": "renderLabelElement",
1941
- "privacy": "protected",
1942
- "description": "creates the label element when the label property is set.\nid is used to link the label with the input field.",
1943
- "return": {
1944
- "type": {
1945
- "text": ""
1946
- }
1947
- },
1948
- "inheritedFrom": {
1949
- "name": "FormfieldWrapper",
1950
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
1951
- }
2161
+ "description": "Background color for a selected checkbox when hovered.",
2162
+ "name": "--mdc-checkbox-checked-background-color-hover"
1952
2163
  },
1953
2164
  {
1954
- "kind": "method",
1955
- "name": "renderRequiredLabel",
1956
- "privacy": "protected",
1957
- "inheritedFrom": {
1958
- "name": "FormfieldWrapper",
1959
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
1960
- }
2165
+ "description": "Background color for a selected checkbox when pressed.",
2166
+ "name": "--mdc-checkbox-checked-pressed-icon-color"
1961
2167
  },
1962
2168
  {
1963
- "kind": "method",
1964
- "name": "renderHelpTextIcon",
1965
- "privacy": "protected",
1966
- "description": "creates the helpertext icon based on the helpTextType for validation.\nIf the helpTextType is not set, it defaults to 'default' and it doesn't display any icon.",
1967
- "return": {
1968
- "type": {
1969
- "text": ""
1970
- }
1971
- },
1972
- "inheritedFrom": {
1973
- "name": "FormfieldWrapper",
1974
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
1975
- }
2169
+ "description": "Background color for a disabled checkbox.",
2170
+ "name": "--mdc-checkbox-disabled-background-color"
1976
2171
  },
1977
2172
  {
1978
- "kind": "method",
1979
- "name": "renderHelpText",
1980
- "privacy": "protected",
1981
- "description": "creates the helper text component when the helpertext value is set.\nIt is also used to display the validation message based on the helpTextType.",
1982
- "return": {
1983
- "type": {
1984
- "text": ""
1985
- }
1986
- },
1987
- "inheritedFrom": {
1988
- "name": "FormfieldWrapper",
1989
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
1990
- }
2173
+ "description": "Border color for a disabled checkbox.",
2174
+ "name": "--mdc-checkbox-disabled-border-color"
1991
2175
  },
1992
2176
  {
1993
- "kind": "method",
1994
- "name": "renderLabel",
1995
- "privacy": "protected",
1996
- "description": "renders the mdc-label-text container that contains the label and labelInfoToggleTip.",
1997
- "return": {
1998
- "type": {
1999
- "text": ""
2000
- }
2001
- },
2002
- "inheritedFrom": {
2003
- "name": "FormfieldWrapper",
2004
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
2005
- }
2177
+ "description": "Background color for a disabled, selected checkbox.",
2178
+ "name": "--mdc-checkbox-disabled-checked-icon-color"
2006
2179
  },
2007
2180
  {
2008
- "kind": "method",
2009
- "name": "renderHelperText",
2010
- "privacy": "protected",
2011
- "description": "renders the mdc-help-text container that contains the helpertext icon and helpertext.",
2012
- "return": {
2013
- "type": {
2014
- "text": ""
2015
- }
2016
- },
2017
- "inheritedFrom": {
2018
- "name": "FormfieldWrapper",
2019
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
2020
- }
2021
- }
2022
- ],
2023
- "events": [
2181
+ "description": "Icon color for a disabled checkbox.",
2182
+ "name": "--mdc-checkbox-disabled-icon-color"
2183
+ },
2024
2184
  {
2025
- "type": {
2026
- "text": "EventConstructor"
2027
- }
2185
+ "description": "Background color for an unselected checkbox.",
2186
+ "name": "--mdc-checkbox-icon-background-color"
2028
2187
  },
2029
2188
  {
2030
- "description": "(React: onChange) Event that gets dispatched when the checkbox state changes.",
2031
- "name": "change",
2032
- "reactName": "onChange",
2033
- "eventName": "ChangeEvent"
2189
+ "description": "Default background color for an unselected checkbox.",
2190
+ "name": "--mdc-checkbox-icon-border-color"
2034
2191
  },
2035
2192
  {
2036
- "description": "(React: onFocus) Event that gets dispatched when the checkbox receives focus.",
2037
- "name": "focus",
2038
- "reactName": "onFocus",
2039
- "eventName": "FocusEvent"
2193
+ "description": "Icon color for an unselected checkbox.",
2194
+ "name": "--mdc-checkbox-icon-color"
2195
+ },
2196
+ {
2197
+ "description": "Background color for a selected checkbox when pressed.",
2198
+ "name": "--mdc-checkbox-pressed-icon-color"
2040
2199
  }
2041
2200
  ],
2042
- "attributes": [
2201
+ "members": [
2043
2202
  {
2203
+ "kind": "field",
2044
2204
  "name": "checked",
2045
2205
  "type": {
2046
2206
  "text": "boolean"
2047
2207
  },
2048
2208
  "default": "false",
2049
2209
  "description": "Determines whether the checkbox is selected or unselected.",
2050
- "fieldName": "checked"
2210
+ "attribute": "checked",
2211
+ "reflects": true
2051
2212
  },
2052
2213
  {
2214
+ "kind": "field",
2053
2215
  "name": "indeterminate",
2054
2216
  "type": {
2055
2217
  "text": "boolean"
2056
2218
  },
2057
2219
  "default": "false",
2058
2220
  "description": "This property is used to determine the parent checkbox in a nested checkbox group.\nIf any one of the children is unselected, then the parent checkbox will be indeterminate.\nIf all children are either selected or unselected, then the parent checkbox will not be indeterminate.",
2059
- "fieldName": "indeterminate"
2221
+ "attribute": "indeterminate",
2222
+ "reflects": true
2060
2223
  },
2061
2224
  {
2225
+ "kind": "field",
2062
2226
  "name": "autofocus",
2063
2227
  "type": {
2064
2228
  "text": "boolean"
2065
2229
  },
2066
2230
  "default": "false",
2067
2231
  "description": "Automatically focus on the element when the page loads.\n[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/autofocus)",
2068
- "fieldName": "autofocus"
2232
+ "attribute": "autofocus",
2233
+ "reflects": true
2234
+ },
2235
+ {
2236
+ "kind": "method",
2237
+ "name": "setFormValue",
2238
+ "privacy": "private",
2239
+ "description": "Updates the form value to reflect the current state of the checkbox.\nIf checked, the value is set to either the user-provided value or 'on' if no value is provided.\nIf unchecked, the value is set to null."
2240
+ },
2241
+ {
2242
+ "kind": "method",
2243
+ "name": "manageRequired",
2244
+ "privacy": "private",
2245
+ "description": "Manages the required state of the checkbox.\nIf the checkbox is not checked and the requiredLabel property is set, then the checkbox is invalid."
2246
+ },
2247
+ {
2248
+ "kind": "method",
2249
+ "name": "toggleState",
2250
+ "privacy": "private",
2251
+ "return": {
2252
+ "type": {
2253
+ "text": "void"
2254
+ }
2255
+ },
2256
+ "description": "Toggles the state of the checkbox element.\nIf the element is not disabled, then\nthe checked property is toggled and the indeterminate property is set to false."
2257
+ },
2258
+ {
2259
+ "kind": "method",
2260
+ "name": "handleKeyDown",
2261
+ "privacy": "private",
2262
+ "return": {
2263
+ "type": {
2264
+ "text": "void"
2265
+ }
2266
+ },
2267
+ "parameters": [
2268
+ {
2269
+ "name": "event",
2270
+ "type": {
2271
+ "text": "KeyboardEvent"
2272
+ },
2273
+ "description": "The keyboard event."
2274
+ }
2275
+ ],
2276
+ "description": "Handles the keydown event on the checkbox.\nWhen the user presses Enter, the form is submitted."
2277
+ },
2278
+ {
2279
+ "kind": "method",
2280
+ "name": "handleChange",
2281
+ "privacy": "public",
2282
+ "return": {
2283
+ "type": {
2284
+ "text": "void"
2285
+ }
2286
+ },
2287
+ "parameters": [
2288
+ {
2289
+ "name": "event",
2290
+ "type": {
2291
+ "text": "Event"
2292
+ }
2293
+ }
2294
+ ],
2295
+ "description": "Toggles the state of the checkbox element.\nand dispatch the new change event."
2296
+ },
2297
+ {
2298
+ "kind": "field",
2299
+ "name": "renderLabelAndHelperText",
2300
+ "privacy": "private"
2301
+ },
2302
+ {
2303
+ "kind": "field",
2304
+ "name": "helpTextType",
2305
+ "type": {
2306
+ "text": "ValidationType"
2307
+ },
2308
+ "description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
2309
+ "attribute": "help-text-type",
2310
+ "reflects": true,
2311
+ "default": "undefined as unknown",
2312
+ "inheritedFrom": {
2313
+ "name": "FormfieldWrapper",
2314
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
2315
+ }
2069
2316
  },
2070
2317
  {
2318
+ "kind": "field",
2071
2319
  "name": "name",
2072
2320
  "type": {
2073
2321
  "text": "string"
2074
2322
  },
2075
2323
  "default": "''",
2076
2324
  "description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
2077
- "fieldName": "name",
2325
+ "attribute": "name",
2326
+ "reflects": true,
2078
2327
  "inheritedFrom": {
2079
2328
  "name": "FormInternalsMixin",
2080
- "module": "src/utils/mixins/FormInternalsMixin.ts"
2329
+ "module": "utils/mixins/FormInternalsMixin.js"
2081
2330
  }
2082
2331
  },
2083
2332
  {
2333
+ "kind": "field",
2084
2334
  "name": "value",
2085
2335
  "type": {
2086
2336
  "text": "string"
2087
2337
  },
2088
2338
  "default": "''",
2089
2339
  "description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
2090
- "fieldName": "value",
2340
+ "attribute": "value",
2341
+ "reflects": true,
2091
2342
  "inheritedFrom": {
2092
2343
  "name": "FormInternalsMixin",
2093
- "module": "src/utils/mixins/FormInternalsMixin.ts"
2344
+ "module": "utils/mixins/FormInternalsMixin.js"
2094
2345
  }
2095
2346
  },
2096
2347
  {
2097
- "name": "validation-message",
2348
+ "kind": "field",
2349
+ "name": "validationMessage",
2098
2350
  "type": {
2099
2351
  "text": "string | undefined"
2100
2352
  },
2101
2353
  "description": "Custom validation message that will override the default message and displayed when the input is invalid.",
2102
- "fieldName": "validationMessage",
2354
+ "attribute": "validation-message",
2355
+ "reflects": true,
2103
2356
  "inheritedFrom": {
2104
2357
  "name": "FormInternalsMixin",
2105
- "module": "src/utils/mixins/FormInternalsMixin.ts"
2358
+ "module": "utils/mixins/FormInternalsMixin.js"
2106
2359
  }
2107
2360
  },
2108
2361
  {
2109
- "name": "data-aria-label",
2362
+ "kind": "field",
2363
+ "name": "validity",
2364
+ "type": {
2365
+ "text": "ValidityState"
2366
+ },
2367
+ "readonly": true,
2368
+ "inheritedFrom": {
2369
+ "name": "FormInternalsMixin",
2370
+ "module": "utils/mixins/FormInternalsMixin.js"
2371
+ }
2372
+ },
2373
+ {
2374
+ "kind": "field",
2375
+ "name": "willValidate",
2376
+ "readonly": true,
2377
+ "inheritedFrom": {
2378
+ "name": "FormInternalsMixin",
2379
+ "module": "utils/mixins/FormInternalsMixin.js"
2380
+ }
2381
+ },
2382
+ {
2383
+ "kind": "method",
2384
+ "name": "setValidity",
2385
+ "description": "Sets the validity of the input field based on the input field's validity.",
2386
+ "return": {
2387
+ "type": {
2388
+ "text": ""
2389
+ }
2390
+ },
2391
+ "inheritedFrom": {
2392
+ "name": "FormInternalsMixin",
2393
+ "module": "utils/mixins/FormInternalsMixin.js"
2394
+ }
2395
+ },
2396
+ {
2397
+ "kind": "method",
2398
+ "name": "checkValidity",
2399
+ "return": {
2400
+ "type": {
2401
+ "text": "boolean"
2402
+ }
2403
+ },
2404
+ "inheritedFrom": {
2405
+ "name": "FormInternalsMixin",
2406
+ "module": "utils/mixins/FormInternalsMixin.js"
2407
+ }
2408
+ },
2409
+ {
2410
+ "kind": "method",
2411
+ "name": "reportValidity",
2412
+ "inheritedFrom": {
2413
+ "name": "FormInternalsMixin",
2414
+ "module": "utils/mixins/FormInternalsMixin.js"
2415
+ }
2416
+ },
2417
+ {
2418
+ "kind": "field",
2419
+ "name": "id",
2420
+ "type": {
2421
+ "text": "string"
2422
+ },
2423
+ "default": "`mdc-input-${uuidv4()}`",
2424
+ "description": "The unique id of the input field. It is used to link the input field with the label.",
2425
+ "attribute": "id",
2426
+ "inheritedFrom": {
2427
+ "name": "FormfieldWrapper",
2428
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
2429
+ }
2430
+ },
2431
+ {
2432
+ "kind": "field",
2433
+ "name": "dataAriaLabel",
2110
2434
  "type": {
2111
2435
  "text": "string | null"
2112
2436
  },
2113
2437
  "default": "null",
2114
2438
  "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
2115
- "fieldName": "dataAriaLabel",
2439
+ "attribute": "data-aria-label",
2440
+ "reflects": true,
2116
2441
  "inheritedFrom": {
2117
2442
  "name": "DataAriaLabelMixin",
2118
- "module": "src/utils/mixins/DataAriaLabelMixin.ts"
2443
+ "module": "utils/mixins/DataAriaLabelMixin.js"
2119
2444
  }
2120
2445
  },
2121
2446
  {
2447
+ "kind": "field",
2122
2448
  "name": "disabled",
2123
2449
  "type": {
2124
2450
  "text": "boolean"
2125
2451
  },
2126
2452
  "default": "false",
2127
2453
  "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
2128
- "fieldName": "disabled",
2454
+ "attribute": "disabled",
2455
+ "reflects": true,
2129
2456
  "inheritedFrom": {
2130
2457
  "name": "DisabledMixin",
2131
- "module": "src/utils/mixins/DisabledMixin.ts"
2458
+ "module": "utils/mixins/DisabledMixin.js"
2132
2459
  }
2133
2460
  },
2134
2461
  {
2462
+ "kind": "field",
2135
2463
  "name": "label",
2136
2464
  "type": {
2137
2465
  "text": "string | undefined"
2138
2466
  },
2139
2467
  "description": "The label of the input field. It is linked to the input field using the `for` attribute.",
2140
- "fieldName": "label",
2468
+ "attribute": "label",
2469
+ "reflects": true,
2141
2470
  "inheritedFrom": {
2142
2471
  "name": "FormfieldWrapper",
2143
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
2472
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
2144
2473
  }
2145
2474
  },
2146
2475
  {
2147
- "name": "required-label",
2476
+ "kind": "field",
2477
+ "name": "requiredLabel",
2148
2478
  "type": {
2149
2479
  "text": "string | undefined"
2150
2480
  },
2151
2481
  "description": "The required label of the input field.\nWhen an appropriate string value is set,\nthe input field is marked as required and the label is appended with this text.",
2152
- "fieldName": "requiredLabel",
2482
+ "attribute": "required-label",
2483
+ "reflects": true,
2153
2484
  "inheritedFrom": {
2154
2485
  "name": "FormfieldWrapper",
2155
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
2486
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
2156
2487
  }
2157
2488
  },
2158
2489
  {
2159
- "name": "id",
2490
+ "kind": "field",
2491
+ "name": "helpText",
2160
2492
  "type": {
2161
- "text": "string"
2493
+ "text": "string | undefined"
2162
2494
  },
2163
- "default": "''",
2164
- "description": "The unique id of the input field. It is used to link the input field with the label.",
2165
- "fieldName": "id",
2495
+ "description": "The help text that is displayed below the input field.",
2496
+ "attribute": "help-text",
2497
+ "reflects": true,
2166
2498
  "inheritedFrom": {
2167
2499
  "name": "FormfieldWrapper",
2168
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
2500
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
2169
2501
  }
2170
2502
  },
2171
2503
  {
2172
- "name": "help-text-type",
2173
- "type": {
2174
- "text": "ValidationType"
2504
+ "kind": "method",
2505
+ "name": "renderLabelElement",
2506
+ "privacy": "protected",
2507
+ "description": "creates the label element when the label property is set.\nid is used to link the label with the input field.",
2508
+ "return": {
2509
+ "type": {
2510
+ "text": ""
2511
+ }
2175
2512
  },
2176
- "description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
2177
- "fieldName": "helpTextType",
2178
2513
  "inheritedFrom": {
2179
2514
  "name": "FormfieldWrapper",
2180
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
2515
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
2181
2516
  }
2182
2517
  },
2183
2518
  {
2184
- "name": "help-text",
2185
- "type": {
2186
- "text": "string | undefined"
2187
- },
2188
- "description": "The help text that is displayed below the input field.",
2189
- "fieldName": "helpText",
2519
+ "kind": "method",
2520
+ "name": "renderRequiredLabel",
2521
+ "privacy": "protected",
2190
2522
  "inheritedFrom": {
2191
2523
  "name": "FormfieldWrapper",
2192
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
2524
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
2193
2525
  }
2194
- }
2195
- ],
2196
- "mixins": [
2197
- {
2198
- "name": "FormInternalsMixin",
2199
- "module": "/src/utils/mixins/FormInternalsMixin"
2200
2526
  },
2201
2527
  {
2202
- "name": "DataAriaLabelMixin",
2203
- "module": "/src/utils/mixins/DataAriaLabelMixin"
2204
- }
2205
- ],
2528
+ "kind": "method",
2529
+ "name": "renderHelpTextIcon",
2530
+ "privacy": "protected",
2531
+ "description": "creates the helpertext icon based on the helpTextType for validation.\nIf the helpTextType is not set, it defaults to 'default' and it doesn't display any icon.",
2532
+ "return": {
2533
+ "type": {
2534
+ "text": ""
2535
+ }
2536
+ },
2537
+ "inheritedFrom": {
2538
+ "name": "FormfieldWrapper",
2539
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
2540
+ }
2541
+ },
2542
+ {
2543
+ "kind": "method",
2544
+ "name": "renderHelpText",
2545
+ "privacy": "protected",
2546
+ "description": "creates the helper text component when the helpertext value is set.\nIt is also used to display the validation message based on the helpTextType.",
2547
+ "return": {
2548
+ "type": {
2549
+ "text": ""
2550
+ }
2551
+ },
2552
+ "inheritedFrom": {
2553
+ "name": "FormfieldWrapper",
2554
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
2555
+ }
2556
+ },
2557
+ {
2558
+ "kind": "method",
2559
+ "name": "renderLabel",
2560
+ "privacy": "protected",
2561
+ "description": "renders the mdc-label-text container that contains the label and labelInfoToggleTip.",
2562
+ "return": {
2563
+ "type": {
2564
+ "text": ""
2565
+ }
2566
+ },
2567
+ "inheritedFrom": {
2568
+ "name": "FormfieldWrapper",
2569
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
2570
+ }
2571
+ },
2572
+ {
2573
+ "kind": "method",
2574
+ "name": "renderHelperText",
2575
+ "privacy": "protected",
2576
+ "description": "renders the mdc-help-text container that contains the helpertext icon and helpertext.",
2577
+ "return": {
2578
+ "type": {
2579
+ "text": ""
2580
+ }
2581
+ },
2582
+ "inheritedFrom": {
2583
+ "name": "FormfieldWrapper",
2584
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
2585
+ }
2586
+ }
2587
+ ],
2588
+ "events": [
2589
+ {
2590
+ "type": {
2591
+ "text": "EventConstructor"
2592
+ }
2593
+ },
2594
+ {
2595
+ "description": "(React: onChange) Event that gets dispatched when the checkbox state changes.",
2596
+ "name": "change",
2597
+ "reactName": "onChange",
2598
+ "eventName": "ChangeEvent"
2599
+ },
2600
+ {
2601
+ "description": "(React: onFocus) Event that gets dispatched when the checkbox receives focus.",
2602
+ "name": "focus",
2603
+ "reactName": "onFocus",
2604
+ "eventName": "FocusEvent"
2605
+ }
2606
+ ],
2607
+ "attributes": [
2608
+ {
2609
+ "name": "checked",
2610
+ "type": {
2611
+ "text": "boolean"
2612
+ },
2613
+ "default": "false",
2614
+ "description": "Determines whether the checkbox is selected or unselected.",
2615
+ "fieldName": "checked"
2616
+ },
2617
+ {
2618
+ "name": "indeterminate",
2619
+ "type": {
2620
+ "text": "boolean"
2621
+ },
2622
+ "default": "false",
2623
+ "description": "This property is used to determine the parent checkbox in a nested checkbox group.\nIf any one of the children is unselected, then the parent checkbox will be indeterminate.\nIf all children are either selected or unselected, then the parent checkbox will not be indeterminate.",
2624
+ "fieldName": "indeterminate"
2625
+ },
2626
+ {
2627
+ "name": "autofocus",
2628
+ "type": {
2629
+ "text": "boolean"
2630
+ },
2631
+ "default": "false",
2632
+ "description": "Automatically focus on the element when the page loads.\n[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/autofocus)",
2633
+ "fieldName": "autofocus"
2634
+ },
2635
+ {
2636
+ "name": "name",
2637
+ "type": {
2638
+ "text": "string"
2639
+ },
2640
+ "default": "''",
2641
+ "description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
2642
+ "fieldName": "name",
2643
+ "inheritedFrom": {
2644
+ "name": "FormInternalsMixin",
2645
+ "module": "src/utils/mixins/FormInternalsMixin.ts"
2646
+ }
2647
+ },
2648
+ {
2649
+ "name": "value",
2650
+ "type": {
2651
+ "text": "string"
2652
+ },
2653
+ "default": "''",
2654
+ "description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
2655
+ "fieldName": "value",
2656
+ "inheritedFrom": {
2657
+ "name": "FormInternalsMixin",
2658
+ "module": "src/utils/mixins/FormInternalsMixin.ts"
2659
+ }
2660
+ },
2661
+ {
2662
+ "name": "validation-message",
2663
+ "type": {
2664
+ "text": "string | undefined"
2665
+ },
2666
+ "description": "Custom validation message that will override the default message and displayed when the input is invalid.",
2667
+ "fieldName": "validationMessage",
2668
+ "inheritedFrom": {
2669
+ "name": "FormInternalsMixin",
2670
+ "module": "src/utils/mixins/FormInternalsMixin.ts"
2671
+ }
2672
+ },
2673
+ {
2674
+ "name": "data-aria-label",
2675
+ "type": {
2676
+ "text": "string | null"
2677
+ },
2678
+ "default": "null",
2679
+ "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
2680
+ "fieldName": "dataAriaLabel",
2681
+ "inheritedFrom": {
2682
+ "name": "DataAriaLabelMixin",
2683
+ "module": "src/utils/mixins/DataAriaLabelMixin.ts"
2684
+ }
2685
+ },
2686
+ {
2687
+ "name": "disabled",
2688
+ "type": {
2689
+ "text": "boolean"
2690
+ },
2691
+ "default": "false",
2692
+ "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
2693
+ "fieldName": "disabled",
2694
+ "inheritedFrom": {
2695
+ "name": "DisabledMixin",
2696
+ "module": "src/utils/mixins/DisabledMixin.ts"
2697
+ }
2698
+ },
2699
+ {
2700
+ "name": "label",
2701
+ "type": {
2702
+ "text": "string | undefined"
2703
+ },
2704
+ "description": "The label of the input field. It is linked to the input field using the `for` attribute.",
2705
+ "fieldName": "label",
2706
+ "inheritedFrom": {
2707
+ "name": "FormfieldWrapper",
2708
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
2709
+ }
2710
+ },
2711
+ {
2712
+ "name": "required-label",
2713
+ "type": {
2714
+ "text": "string | undefined"
2715
+ },
2716
+ "description": "The required label of the input field.\nWhen an appropriate string value is set,\nthe input field is marked as required and the label is appended with this text.",
2717
+ "fieldName": "requiredLabel",
2718
+ "inheritedFrom": {
2719
+ "name": "FormfieldWrapper",
2720
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
2721
+ }
2722
+ },
2723
+ {
2724
+ "name": "id",
2725
+ "type": {
2726
+ "text": "string"
2727
+ },
2728
+ "default": "''",
2729
+ "description": "The unique id of the input field. It is used to link the input field with the label.",
2730
+ "fieldName": "id",
2731
+ "inheritedFrom": {
2732
+ "name": "FormfieldWrapper",
2733
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
2734
+ }
2735
+ },
2736
+ {
2737
+ "name": "help-text-type",
2738
+ "type": {
2739
+ "text": "ValidationType"
2740
+ },
2741
+ "description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
2742
+ "fieldName": "helpTextType",
2743
+ "inheritedFrom": {
2744
+ "name": "FormfieldWrapper",
2745
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
2746
+ }
2747
+ },
2748
+ {
2749
+ "name": "help-text",
2750
+ "type": {
2751
+ "text": "string | undefined"
2752
+ },
2753
+ "description": "The help text that is displayed below the input field.",
2754
+ "fieldName": "helpText",
2755
+ "inheritedFrom": {
2756
+ "name": "FormfieldWrapper",
2757
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
2758
+ }
2759
+ }
2760
+ ],
2761
+ "mixins": [
2762
+ {
2763
+ "name": "FormInternalsMixin",
2764
+ "module": "/src/utils/mixins/FormInternalsMixin"
2765
+ },
2766
+ {
2767
+ "name": "DataAriaLabelMixin",
2768
+ "module": "/src/utils/mixins/DataAriaLabelMixin"
2769
+ }
2770
+ ],
2206
2771
  "superclass": {
2207
2772
  "name": "FormfieldWrapper",
2208
2773
  "module": "/src/components/formfieldwrapper/formfieldwrapper.component"
@@ -4842,6 +5407,10 @@
4842
5407
  {
4843
5408
  "description": "Allows customization of the secondary and teritary label text slot color.",
4844
5409
  "name": "--mdc-listitem-secondary-label-color"
5410
+ },
5411
+ {
5412
+ "description": "Allows customization of the disabled color.",
5413
+ "name": "--mdc-listitem-disabled-color"
4845
5414
  }
4846
5415
  ],
4847
5416
  "slots": [
@@ -4877,32 +5446,18 @@
4877
5446
  "members": [
4878
5447
  {
4879
5448
  "kind": "field",
4880
- "name": "leadingControlsSlot",
5449
+ "name": "variant",
4881
5450
  "type": {
4882
- "text": "Array<HTMLElement>"
4883
- }
5451
+ "text": "ListItemVariants"
5452
+ },
5453
+ "description": "The variant of the list item. It can be a pill, rectangle or a full-width.",
5454
+ "default": "'full-width'",
5455
+ "attribute": "variant",
5456
+ "reflects": true
4884
5457
  },
4885
5458
  {
4886
5459
  "kind": "field",
4887
- "name": "trailingControlsSlot",
4888
- "type": {
4889
- "text": "Array<HTMLElement>"
4890
- }
4891
- },
4892
- {
4893
- "kind": "field",
4894
- "name": "variant",
4895
- "type": {
4896
- "text": "ListItemVariants"
4897
- },
4898
- "description": "The variant of the list item. It can be a pill, rectangle or a full-width.",
4899
- "default": "'full-width'",
4900
- "attribute": "variant",
4901
- "reflects": true
4902
- },
4903
- {
4904
- "kind": "field",
4905
- "name": "label",
5460
+ "name": "label",
4906
5461
  "type": {
4907
5462
  "text": "string | undefined"
4908
5463
  },
@@ -5059,6 +5614,32 @@
5059
5614
  }
5060
5615
  }
5061
5616
  ],
5617
+ "events": [
5618
+ {
5619
+ "description": "(React: onClick) This event is dispatched when the listitem is clicked.",
5620
+ "name": "click",
5621
+ "reactName": "onClick",
5622
+ "eventName": "ClickEvent"
5623
+ },
5624
+ {
5625
+ "description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the listitem.",
5626
+ "name": "keydown",
5627
+ "reactName": "onKeyDown",
5628
+ "eventName": "KeydownEvent"
5629
+ },
5630
+ {
5631
+ "description": "(React: onKeyUp) This event is dispatched when a key is released on the listitem.",
5632
+ "name": "keyup",
5633
+ "reactName": "onKeyUp",
5634
+ "eventName": "KeyupEvent"
5635
+ },
5636
+ {
5637
+ "description": "(React: onFocus) This event is dispatched when the listitem receives focus.",
5638
+ "name": "focus",
5639
+ "reactName": "onFocus",
5640
+ "eventName": "FocusEvent"
5641
+ }
5642
+ ],
5062
5643
  "attributes": [
5063
5644
  {
5064
5645
  "name": "variant",
@@ -5168,7 +5749,7 @@
5168
5749
  "module": "/src/models"
5169
5750
  },
5170
5751
  "tagName": "mdc-listitem",
5171
- "jsDoc": "/**\n * mdc-listitem component is used to display a label with different types of controls.\n * There can be three types of controls, a radio button, a checkbox on the\n * leading side and a toggle on the trailing side.\n * The list item can contain an avatar on the leading side and a badge on the trailing side.\n * Additionally, the list item can contain a side header and a subline text.\n *\n * The leading and trailing slots can be used to display controls and text. <br/>\n * Based on the leading/trailing slot, the position of the controls and text can be adjusted. <br/>\n * Please use mdc-list as a parent element even when there is only listitem for a11y purpose.\n *\n * @tagname mdc-listitem\n *\n * @dependency mdc-text\n *\n * @slot leading-controls - slot for list item controls to appear of leading end.\n * @slot leading-text-primary-label - slot for list item primary label.\n * @slot leading-text-secondary-label - slot for list item secondary label.\n * @slot leading-text-tertiary-label - slot for list item tertiary label.\n * @slot trailing-text-side-header - slot for list item side header text.\n * @slot trailing-text-subline - slot for list item subline text.\n * @slot trailing-controls - slot for list item controls to appear of trailing end.\n *\n * @cssproperty --mdc-listitem-default-background-color - Allows customization of the default background color.\n * @cssproperty --mdc-listitem-background-color-hover - Allows customization of the background color on hover.\n * @cssproperty --mdc-listitem-background-color-active - Allows customization of the background color when pressed.\n * @cssproperty --mdc-listitem-primary-label-color\n * - Allows customization of the primary label, side header and subline text slot color.\n * @cssproperty --mdc-listitem-secondary-label-color\n * - Allows customization of the secondary and teritary label text slot color.\n */",
5752
+ "jsDoc": "/**\n * mdc-listitem component is used to display a label with different types of controls.\n * There can be three types of controls, a radio button, a checkbox on the\n * leading side and a toggle on the trailing side.\n * The list item can contain an avatar on the leading side and a badge on the trailing side.\n * Additionally, the list item can contain a side header and a subline text.\n *\n * The leading and trailing slots can be used to display controls and text. <br/>\n * Based on the leading/trailing slot, the position of the controls and text can be adjusted. <br/>\n * Please use mdc-list as a parent element even when there is only listitem for a11y purpose.\n *\n * @tagname mdc-listitem\n *\n * @dependency mdc-text\n *\n * @slot leading-controls - slot for list item controls to appear of leading end.\n * @slot leading-text-primary-label - slot for list item primary label.\n * @slot leading-text-secondary-label - slot for list item secondary label.\n * @slot leading-text-tertiary-label - slot for list item tertiary label.\n * @slot trailing-text-side-header - slot for list item side header text.\n * @slot trailing-text-subline - slot for list item subline text.\n * @slot trailing-controls - slot for list item controls to appear of trailing end.\n *\n * @cssproperty --mdc-listitem-default-background-color - Allows customization of the default background color.\n * @cssproperty --mdc-listitem-background-color-hover - Allows customization of the background color on hover.\n * @cssproperty --mdc-listitem-background-color-active - Allows customization of the background color when pressed.\n * @cssproperty --mdc-listitem-primary-label-color\n * - Allows customization of the primary label, side header and subline text slot color.\n * @cssproperty --mdc-listitem-secondary-label-color\n * - Allows customization of the secondary and teritary label text slot color.\n * @cssproperty --mdc-listitem-disabled-color - Allows customization of the disabled color.\n *\n * @event click - (React: onClick) This event is dispatched when the listitem is clicked.\n * @event keydown - (React: onKeyDown) This event is dispatched when a key is pressed down on the listitem.\n * @event keyup - (React: onKeyUp) This event is dispatched when a key is released on the listitem.\n * @event focus - (React: onFocus) This event is dispatched when the listitem receives focus.\n */",
5172
5753
  "customElement": true
5173
5754
  }
5174
5755
  ],
@@ -7143,562 +7724,138 @@
7143
7724
  "text": "KeyboardEvent"
7144
7725
  }
7145
7726
  }
7146
- ],
7147
- "description": "Handles the keydown event (Arrow Up/Down/Left/Right) on the radio element."
7148
- },
7149
- {
7150
- "kind": "method",
7151
- "name": "updateTabIndex",
7152
- "privacy": "private",
7153
- "return": {
7154
- "type": {
7155
- "text": "void"
7156
- }
7157
- },
7158
- "description": "Update tab index for all radios in the same group (name)\nIf any radio group is checked, it will have a tab index of 0\nIf no radio group is checked, the first enabled radio will have a tab index of 0"
7159
- },
7160
- {
7161
- "kind": "field",
7162
- "name": "renderLabelAndHelperText",
7163
- "privacy": "private"
7164
- },
7165
- {
7166
- "kind": "field",
7167
- "name": "helpTextType",
7168
- "type": {
7169
- "text": "ValidationType"
7170
- },
7171
- "description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
7172
- "attribute": "help-text-type",
7173
- "reflects": true,
7174
- "default": "undefined as unknown",
7175
- "inheritedFrom": {
7176
- "name": "FormfieldWrapper",
7177
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
7178
- }
7179
- },
7180
- {
7181
- "kind": "field",
7182
- "name": "name",
7183
- "type": {
7184
- "text": "string"
7185
- },
7186
- "default": "''",
7187
- "description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
7188
- "attribute": "name",
7189
- "reflects": true,
7190
- "inheritedFrom": {
7191
- "name": "FormInternalsMixin",
7192
- "module": "utils/mixins/FormInternalsMixin.js"
7193
- }
7194
- },
7195
- {
7196
- "kind": "field",
7197
- "name": "value",
7198
- "type": {
7199
- "text": "string"
7200
- },
7201
- "default": "''",
7202
- "description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
7203
- "attribute": "value",
7204
- "reflects": true,
7205
- "inheritedFrom": {
7206
- "name": "FormInternalsMixin",
7207
- "module": "utils/mixins/FormInternalsMixin.js"
7208
- }
7209
- },
7210
- {
7211
- "kind": "field",
7212
- "name": "validationMessage",
7213
- "type": {
7214
- "text": "string | undefined"
7215
- },
7216
- "description": "Custom validation message that will override the default message and displayed when the input is invalid.",
7217
- "attribute": "validation-message",
7218
- "reflects": true,
7219
- "inheritedFrom": {
7220
- "name": "FormInternalsMixin",
7221
- "module": "utils/mixins/FormInternalsMixin.js"
7222
- }
7223
- },
7224
- {
7225
- "kind": "field",
7226
- "name": "validity",
7227
- "type": {
7228
- "text": "ValidityState"
7229
- },
7230
- "readonly": true,
7231
- "inheritedFrom": {
7232
- "name": "FormInternalsMixin",
7233
- "module": "utils/mixins/FormInternalsMixin.js"
7234
- }
7235
- },
7236
- {
7237
- "kind": "field",
7238
- "name": "willValidate",
7239
- "readonly": true,
7240
- "inheritedFrom": {
7241
- "name": "FormInternalsMixin",
7242
- "module": "utils/mixins/FormInternalsMixin.js"
7243
- }
7244
- },
7245
- {
7246
- "kind": "method",
7247
- "name": "setValidity",
7248
- "description": "Sets the validity of the input field based on the input field's validity.",
7249
- "return": {
7250
- "type": {
7251
- "text": ""
7252
- }
7253
- },
7254
- "inheritedFrom": {
7255
- "name": "FormInternalsMixin",
7256
- "module": "utils/mixins/FormInternalsMixin.js"
7257
- }
7258
- },
7259
- {
7260
- "kind": "method",
7261
- "name": "checkValidity",
7262
- "return": {
7263
- "type": {
7264
- "text": "boolean"
7265
- }
7266
- },
7267
- "inheritedFrom": {
7268
- "name": "FormInternalsMixin",
7269
- "module": "utils/mixins/FormInternalsMixin.js"
7270
- }
7271
- },
7272
- {
7273
- "kind": "method",
7274
- "name": "reportValidity",
7275
- "inheritedFrom": {
7276
- "name": "FormInternalsMixin",
7277
- "module": "utils/mixins/FormInternalsMixin.js"
7278
- }
7279
- },
7280
- {
7281
- "kind": "field",
7282
- "name": "id",
7283
- "type": {
7284
- "text": "string"
7285
- },
7286
- "default": "`mdc-input-${uuidv4()}`",
7287
- "description": "The unique id of the input field. It is used to link the input field with the label.",
7288
- "attribute": "id",
7289
- "inheritedFrom": {
7290
- "name": "FormfieldWrapper",
7291
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
7292
- }
7293
- },
7294
- {
7295
- "kind": "field",
7296
- "name": "dataAriaLabel",
7297
- "type": {
7298
- "text": "string | null"
7299
- },
7300
- "default": "null",
7301
- "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
7302
- "attribute": "data-aria-label",
7303
- "reflects": true,
7304
- "inheritedFrom": {
7305
- "name": "DataAriaLabelMixin",
7306
- "module": "utils/mixins/DataAriaLabelMixin.js"
7307
- }
7308
- },
7309
- {
7310
- "kind": "field",
7311
- "name": "disabled",
7312
- "type": {
7313
- "text": "boolean"
7314
- },
7315
- "default": "false",
7316
- "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
7317
- "attribute": "disabled",
7318
- "reflects": true,
7319
- "inheritedFrom": {
7320
- "name": "FormfieldWrapper",
7321
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
7322
- }
7323
- },
7324
- {
7325
- "kind": "field",
7326
- "name": "label",
7327
- "type": {
7328
- "text": "string | undefined"
7329
- },
7330
- "description": "The label of the input field. It is linked to the input field using the `for` attribute.",
7331
- "attribute": "label",
7332
- "reflects": true,
7333
- "inheritedFrom": {
7334
- "name": "FormfieldWrapper",
7335
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
7336
- }
7337
- },
7338
- {
7339
- "kind": "field",
7340
- "name": "requiredLabel",
7341
- "type": {
7342
- "text": "string | undefined"
7343
- },
7344
- "description": "The required label of the input field.\nWhen an appropriate string value is set,\nthe input field is marked as required and the label is appended with this text.",
7345
- "attribute": "required-label",
7346
- "reflects": true,
7347
- "inheritedFrom": {
7348
- "name": "FormfieldWrapper",
7349
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
7350
- }
7351
- },
7352
- {
7353
- "kind": "field",
7354
- "name": "helpText",
7355
- "type": {
7356
- "text": "string | undefined"
7357
- },
7358
- "description": "The help text that is displayed below the input field.",
7359
- "attribute": "help-text",
7360
- "reflects": true,
7361
- "inheritedFrom": {
7362
- "name": "FormfieldWrapper",
7363
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
7364
- }
7365
- },
7366
- {
7367
- "kind": "method",
7368
- "name": "renderLabelElement",
7369
- "privacy": "protected",
7370
- "description": "creates the label element when the label property is set.\nid is used to link the label with the input field.",
7371
- "return": {
7372
- "type": {
7373
- "text": ""
7374
- }
7375
- },
7376
- "inheritedFrom": {
7377
- "name": "FormfieldWrapper",
7378
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
7379
- }
7380
- },
7381
- {
7382
- "kind": "method",
7383
- "name": "renderRequiredLabel",
7384
- "privacy": "protected",
7385
- "inheritedFrom": {
7386
- "name": "FormfieldWrapper",
7387
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
7388
- }
7389
- },
7390
- {
7391
- "kind": "method",
7392
- "name": "renderHelpTextIcon",
7393
- "privacy": "protected",
7394
- "description": "creates the helpertext icon based on the helpTextType for validation.\nIf the helpTextType is not set, it defaults to 'default' and it doesn't display any icon.",
7395
- "return": {
7396
- "type": {
7397
- "text": ""
7398
- }
7399
- },
7400
- "inheritedFrom": {
7401
- "name": "FormfieldWrapper",
7402
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
7403
- }
7404
- },
7405
- {
7406
- "kind": "method",
7407
- "name": "renderHelpText",
7408
- "privacy": "protected",
7409
- "description": "creates the helper text component when the helpertext value is set.\nIt is also used to display the validation message based on the helpTextType.",
7410
- "return": {
7411
- "type": {
7412
- "text": ""
7413
- }
7414
- },
7415
- "inheritedFrom": {
7416
- "name": "FormfieldWrapper",
7417
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
7418
- }
7419
- },
7420
- {
7421
- "kind": "method",
7422
- "name": "renderLabel",
7423
- "privacy": "protected",
7424
- "description": "renders the mdc-label-text container that contains the label and labelInfoToggleTip.",
7425
- "return": {
7426
- "type": {
7427
- "text": ""
7428
- }
7429
- },
7430
- "inheritedFrom": {
7431
- "name": "FormfieldWrapper",
7432
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
7433
- }
7727
+ ],
7728
+ "description": "Handles the keydown event (Arrow Up/Down/Left/Right) on the radio element."
7434
7729
  },
7435
7730
  {
7436
7731
  "kind": "method",
7437
- "name": "renderHelperText",
7438
- "privacy": "protected",
7439
- "description": "renders the mdc-help-text container that contains the helpertext icon and helpertext.",
7732
+ "name": "updateTabIndex",
7733
+ "privacy": "private",
7440
7734
  "return": {
7441
7735
  "type": {
7442
- "text": ""
7736
+ "text": "void"
7443
7737
  }
7444
7738
  },
7445
- "inheritedFrom": {
7446
- "name": "FormfieldWrapper",
7447
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
7448
- }
7449
- }
7450
- ],
7451
- "events": [
7452
- {
7453
- "type": {
7454
- "text": "EventConstructor"
7455
- }
7456
- },
7457
- {
7458
- "description": "(React: onChange) Event that gets dispatched when the radio state changes.",
7459
- "name": "change",
7460
- "reactName": "onChange",
7461
- "eventName": "ChangeEvent"
7462
- },
7463
- {
7464
- "description": "(React: onFocus) Event that gets dispatched when the radio receives focus.",
7465
- "name": "focus",
7466
- "reactName": "onFocus",
7467
- "eventName": "FocusEvent"
7468
- }
7469
- ],
7470
- "attributes": [
7471
- {
7472
- "name": "checked",
7473
- "type": {
7474
- "text": "boolean"
7475
- },
7476
- "default": "false",
7477
- "description": "Determines whether the radio is selected or unselected.",
7478
- "fieldName": "checked"
7739
+ "description": "Update tab index for all radios in the same group (name)\nIf any radio group is checked, it will have a tab index of 0\nIf no radio group is checked, the first enabled radio will have a tab index of 0"
7479
7740
  },
7480
7741
  {
7481
- "name": "readonly",
7482
- "type": {
7483
- "text": "boolean"
7484
- },
7485
- "default": "false",
7486
- "description": "Determines whether the radio is read-only.",
7487
- "fieldName": "readonly"
7742
+ "kind": "field",
7743
+ "name": "renderLabelAndHelperText",
7744
+ "privacy": "private"
7488
7745
  },
7489
7746
  {
7490
- "name": "autofocus",
7747
+ "kind": "field",
7748
+ "name": "helpTextType",
7491
7749
  "type": {
7492
- "text": "boolean"
7750
+ "text": "ValidationType"
7493
7751
  },
7494
- "default": "false",
7495
- "description": "Automatically focus on the element when the page loads.\n[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/autofocus)",
7496
- "fieldName": "autofocus"
7752
+ "description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
7753
+ "attribute": "help-text-type",
7754
+ "reflects": true,
7755
+ "default": "undefined as unknown",
7756
+ "inheritedFrom": {
7757
+ "name": "FormfieldWrapper",
7758
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
7759
+ }
7497
7760
  },
7498
7761
  {
7762
+ "kind": "field",
7499
7763
  "name": "name",
7500
7764
  "type": {
7501
7765
  "text": "string"
7502
7766
  },
7503
7767
  "default": "''",
7504
7768
  "description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
7505
- "fieldName": "name",
7769
+ "attribute": "name",
7770
+ "reflects": true,
7506
7771
  "inheritedFrom": {
7507
7772
  "name": "FormInternalsMixin",
7508
- "module": "src/utils/mixins/FormInternalsMixin.ts"
7773
+ "module": "utils/mixins/FormInternalsMixin.js"
7509
7774
  }
7510
7775
  },
7511
7776
  {
7777
+ "kind": "field",
7512
7778
  "name": "value",
7513
7779
  "type": {
7514
7780
  "text": "string"
7515
7781
  },
7516
7782
  "default": "''",
7517
7783
  "description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
7518
- "fieldName": "value",
7784
+ "attribute": "value",
7785
+ "reflects": true,
7519
7786
  "inheritedFrom": {
7520
7787
  "name": "FormInternalsMixin",
7521
- "module": "src/utils/mixins/FormInternalsMixin.ts"
7788
+ "module": "utils/mixins/FormInternalsMixin.js"
7522
7789
  }
7523
7790
  },
7524
7791
  {
7525
- "name": "validation-message",
7792
+ "kind": "field",
7793
+ "name": "validationMessage",
7526
7794
  "type": {
7527
7795
  "text": "string | undefined"
7528
7796
  },
7529
7797
  "description": "Custom validation message that will override the default message and displayed when the input is invalid.",
7530
- "fieldName": "validationMessage",
7798
+ "attribute": "validation-message",
7799
+ "reflects": true,
7531
7800
  "inheritedFrom": {
7532
7801
  "name": "FormInternalsMixin",
7533
- "module": "src/utils/mixins/FormInternalsMixin.ts"
7534
- }
7535
- },
7536
- {
7537
- "name": "data-aria-label",
7538
- "type": {
7539
- "text": "string | null"
7540
- },
7541
- "default": "null",
7542
- "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
7543
- "fieldName": "dataAriaLabel",
7544
- "inheritedFrom": {
7545
- "name": "DataAriaLabelMixin",
7546
- "module": "src/utils/mixins/DataAriaLabelMixin.ts"
7547
- }
7548
- },
7549
- {
7550
- "name": "disabled",
7551
- "type": {
7552
- "text": "boolean"
7553
- },
7554
- "default": "false",
7555
- "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
7556
- "fieldName": "disabled",
7557
- "inheritedFrom": {
7558
- "name": "FormfieldWrapper",
7559
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
7560
- }
7561
- },
7562
- {
7563
- "name": "label",
7564
- "type": {
7565
- "text": "string | undefined"
7566
- },
7567
- "description": "The label of the input field. It is linked to the input field using the `for` attribute.",
7568
- "fieldName": "label",
7569
- "inheritedFrom": {
7570
- "name": "FormfieldWrapper",
7571
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
7572
- }
7573
- },
7574
- {
7575
- "name": "required-label",
7576
- "type": {
7577
- "text": "string | undefined"
7578
- },
7579
- "description": "The required label of the input field.\nWhen an appropriate string value is set,\nthe input field is marked as required and the label is appended with this text.",
7580
- "fieldName": "requiredLabel",
7581
- "inheritedFrom": {
7582
- "name": "FormfieldWrapper",
7583
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
7802
+ "module": "utils/mixins/FormInternalsMixin.js"
7584
7803
  }
7585
7804
  },
7586
7805
  {
7587
- "name": "id",
7806
+ "kind": "field",
7807
+ "name": "validity",
7588
7808
  "type": {
7589
- "text": "string"
7809
+ "text": "ValidityState"
7590
7810
  },
7591
- "default": "''",
7592
- "description": "The unique id of the input field. It is used to link the input field with the label.",
7593
- "fieldName": "id",
7811
+ "readonly": true,
7594
7812
  "inheritedFrom": {
7595
- "name": "FormfieldWrapper",
7596
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
7813
+ "name": "FormInternalsMixin",
7814
+ "module": "utils/mixins/FormInternalsMixin.js"
7597
7815
  }
7598
7816
  },
7599
7817
  {
7600
- "name": "help-text-type",
7601
- "type": {
7602
- "text": "ValidationType"
7603
- },
7604
- "description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
7605
- "fieldName": "helpTextType",
7818
+ "kind": "field",
7819
+ "name": "willValidate",
7820
+ "readonly": true,
7606
7821
  "inheritedFrom": {
7607
- "name": "FormfieldWrapper",
7608
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
7822
+ "name": "FormInternalsMixin",
7823
+ "module": "utils/mixins/FormInternalsMixin.js"
7609
7824
  }
7610
7825
  },
7611
7826
  {
7612
- "name": "help-text",
7613
- "type": {
7614
- "text": "string | undefined"
7827
+ "kind": "method",
7828
+ "name": "setValidity",
7829
+ "description": "Sets the validity of the input field based on the input field's validity.",
7830
+ "return": {
7831
+ "type": {
7832
+ "text": ""
7833
+ }
7615
7834
  },
7616
- "description": "The help text that is displayed below the input field.",
7617
- "fieldName": "helpText",
7618
7835
  "inheritedFrom": {
7619
- "name": "FormfieldWrapper",
7620
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
7836
+ "name": "FormInternalsMixin",
7837
+ "module": "utils/mixins/FormInternalsMixin.js"
7621
7838
  }
7622
- }
7623
- ],
7624
- "mixins": [
7625
- {
7626
- "name": "FormInternalsMixin",
7627
- "module": "/src/utils/mixins/FormInternalsMixin"
7628
7839
  },
7629
7840
  {
7630
- "name": "DataAriaLabelMixin",
7631
- "module": "/src/utils/mixins/DataAriaLabelMixin"
7632
- }
7633
- ],
7634
- "superclass": {
7635
- "name": "FormfieldWrapper",
7636
- "module": "/src/components/formfieldwrapper/formfieldwrapper.component"
7637
- },
7638
- "tagName": "mdc-radio",
7639
- "jsDoc": "/**\n * Radio allow users to select single options from a list or turn an item/feature on or off.\n * These are often used in forms, settings, and selection in lists.\n *\n * A radio component contains an optional label, optional info icon and an optional helper text.\n * @dependency mdc-formfieldwrapper\n *\n * @tagname mdc-radio\n *\n * @event change - (React: onChange) Event that gets dispatched when the radio state changes.\n * @event focus - (React: onFocus) Event that gets dispatched when the radio receives focus.\n *\n * @cssproperty --mdc-radio-inner-circle-size - size of the inner circle\n * @cssproperty --mdc-radio-text-disabled-color - color of the label when disabled\n * @cssproperty --mdc-radio-disabled-border-color - color of the radio button border when disabled\n * @cssproperty --mdc-radio-normal-border-color - color of the radio button border when normal\n * @cssproperty --mdc-radio-inner-circle-normal-background - background color of the inner circle when normal\n * @cssproperty --mdc-radio-inner-circle-disabled-background - background color of the inner circle when disabled\n * @cssproperty --mdc-radio-control-inactive-color - color of the radio button when inactive\n * @cssproperty --mdc-radio-control-inactive-hover - color of the radio button when inactive and hovered\n * @cssproperty --mdc-radio-control-inactive-pressed-color - color of the radio button when inactive and pressed\n * @cssproperty --mdc-radio-control-inactive-disabled-background - background color of the radio button when\n * inactive and disabled\n * @cssproperty --mdc-radio-control-active-color - color of the radio button when active\n * @cssproperty --mdc-radio-control-active-hover-color - color of the radio button when active and hovered\n * @cssproperty --mdc-radio-control-active-pressed-color - color of the radio button when active and pressed\n * @cssproperty --mdc-radio-control-active-disabled-background - background color of the radio button\n * when active and disabled\n *\n */",
7640
- "customElement": true,
7641
- "slots": [
7642
- {
7643
- "description": "slot to add the label info icon",
7644
- "name": "label-info",
7645
- "inheritedFrom": {
7646
- "name": "FormfieldWrapper",
7647
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
7648
- }
7649
- }
7650
- ]
7651
- }
7652
- ],
7653
- "exports": [
7654
- {
7655
- "kind": "js",
7656
- "name": "default",
7657
- "declaration": {
7658
- "name": "Radio",
7659
- "module": "components/radio/radio.component.js"
7660
- }
7661
- }
7662
- ]
7663
- },
7664
- {
7665
- "kind": "javascript-module",
7666
- "path": "components/radiogroup/radiogroup.component.js",
7667
- "declarations": [
7668
- {
7669
- "kind": "class",
7670
- "description": "`mdc-radiogroup` - This is the wrapper component for radio buttons which are grouped together.\nIt can have a header text and a description. It enables users to select a single option from a set of options.\nIt is often used in forms, settings, and selection in lists. It automatically group the radio buttons inside it.",
7671
- "name": "RadioGroup",
7672
- "cssProperties": [
7673
- {
7674
- "description": "color of the description text",
7675
- "name": "--mdc-radiogroup-description-text-normal"
7676
- }
7677
- ],
7678
- "members": [
7679
- {
7680
- "kind": "field",
7681
- "name": "name",
7682
- "type": {
7683
- "text": "string"
7841
+ "kind": "method",
7842
+ "name": "checkValidity",
7843
+ "return": {
7844
+ "type": {
7845
+ "text": "boolean"
7846
+ }
7684
7847
  },
7685
- "default": "''",
7686
- "description": "Name of the radio group.\nThey are used to group elements in a form together.",
7687
- "attribute": "name"
7848
+ "inheritedFrom": {
7849
+ "name": "FormInternalsMixin",
7850
+ "module": "utils/mixins/FormInternalsMixin.js"
7851
+ }
7688
7852
  },
7689
7853
  {
7690
- "kind": "field",
7691
- "name": "dataAriaLabel",
7692
- "type": {
7693
- "text": "string | null"
7694
- },
7695
- "default": "null",
7696
- "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
7697
- "attribute": "data-aria-label",
7698
- "reflects": true,
7854
+ "kind": "method",
7855
+ "name": "reportValidity",
7699
7856
  "inheritedFrom": {
7700
- "name": "DataAriaLabelMixin",
7701
- "module": "utils/mixins/DataAriaLabelMixin.js"
7857
+ "name": "FormInternalsMixin",
7858
+ "module": "utils/mixins/FormInternalsMixin.js"
7702
7859
  }
7703
7860
  },
7704
7861
  {
@@ -7707,7 +7864,7 @@
7707
7864
  "type": {
7708
7865
  "text": "string"
7709
7866
  },
7710
- "default": "''",
7867
+ "default": "`mdc-input-${uuidv4()}`",
7711
7868
  "description": "The unique id of the input field. It is used to link the input field with the label.",
7712
7869
  "attribute": "id",
7713
7870
  "inheritedFrom": {
@@ -7717,17 +7874,17 @@
7717
7874
  },
7718
7875
  {
7719
7876
  "kind": "field",
7720
- "name": "helpTextType",
7877
+ "name": "dataAriaLabel",
7721
7878
  "type": {
7722
- "text": "ValidationType"
7879
+ "text": "string | null"
7723
7880
  },
7724
- "description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
7725
- "attribute": "help-text-type",
7881
+ "default": "null",
7882
+ "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
7883
+ "attribute": "data-aria-label",
7726
7884
  "reflects": true,
7727
- "default": "undefined as unknown",
7728
7885
  "inheritedFrom": {
7729
- "name": "FormfieldWrapper",
7730
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
7886
+ "name": "DataAriaLabelMixin",
7887
+ "module": "utils/mixins/DataAriaLabelMixin.js"
7731
7888
  }
7732
7889
  },
7733
7890
  {
@@ -7736,7 +7893,7 @@
7736
7893
  "type": {
7737
7894
  "text": "boolean"
7738
7895
  },
7739
- "default": "undefined as unknown",
7896
+ "default": "false",
7740
7897
  "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
7741
7898
  "attribute": "disabled",
7742
7899
  "reflects": true,
@@ -7872,262 +8029,206 @@
7872
8029
  }
7873
8030
  }
7874
8031
  ],
8032
+ "events": [
8033
+ {
8034
+ "type": {
8035
+ "text": "EventConstructor"
8036
+ }
8037
+ },
8038
+ {
8039
+ "description": "(React: onChange) Event that gets dispatched when the radio state changes.",
8040
+ "name": "change",
8041
+ "reactName": "onChange",
8042
+ "eventName": "ChangeEvent"
8043
+ },
8044
+ {
8045
+ "description": "(React: onFocus) Event that gets dispatched when the radio receives focus.",
8046
+ "name": "focus",
8047
+ "reactName": "onFocus",
8048
+ "eventName": "FocusEvent"
8049
+ }
8050
+ ],
7875
8051
  "attributes": [
7876
8052
  {
7877
- "name": "name",
8053
+ "name": "checked",
7878
8054
  "type": {
7879
- "text": "string"
8055
+ "text": "boolean"
7880
8056
  },
7881
- "default": "''",
7882
- "description": "Name of the radio group.\nThey are used to group elements in a form together.",
7883
- "fieldName": "name"
8057
+ "default": "false",
8058
+ "description": "Determines whether the radio is selected or unselected.",
8059
+ "fieldName": "checked"
7884
8060
  },
7885
8061
  {
7886
- "name": "data-aria-label",
8062
+ "name": "readonly",
7887
8063
  "type": {
7888
- "text": "string | null"
8064
+ "text": "boolean"
7889
8065
  },
7890
- "default": "null",
7891
- "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
7892
- "fieldName": "dataAriaLabel",
7893
- "inheritedFrom": {
7894
- "name": "DataAriaLabelMixin",
7895
- "module": "src/utils/mixins/DataAriaLabelMixin.ts"
7896
- }
8066
+ "default": "false",
8067
+ "description": "Determines whether the radio is read-only.",
8068
+ "fieldName": "readonly"
7897
8069
  },
7898
8070
  {
7899
- "name": "disabled",
8071
+ "name": "autofocus",
7900
8072
  "type": {
7901
8073
  "text": "boolean"
7902
8074
  },
7903
8075
  "default": "false",
7904
- "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
7905
- "fieldName": "disabled",
8076
+ "description": "Automatically focus on the element when the page loads.\n[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/autofocus)",
8077
+ "fieldName": "autofocus"
8078
+ },
8079
+ {
8080
+ "name": "name",
8081
+ "type": {
8082
+ "text": "string"
8083
+ },
8084
+ "default": "''",
8085
+ "description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
8086
+ "fieldName": "name",
7906
8087
  "inheritedFrom": {
7907
- "name": "FormfieldWrapper",
7908
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
8088
+ "name": "FormInternalsMixin",
8089
+ "module": "src/utils/mixins/FormInternalsMixin.ts"
7909
8090
  }
7910
8091
  },
7911
8092
  {
7912
- "name": "label",
8093
+ "name": "value",
7913
8094
  "type": {
7914
- "text": "string | undefined"
8095
+ "text": "string"
7915
8096
  },
7916
- "description": "The label of the input field. It is linked to the input field using the `for` attribute.",
7917
- "fieldName": "label",
8097
+ "default": "''",
8098
+ "description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
8099
+ "fieldName": "value",
7918
8100
  "inheritedFrom": {
7919
- "name": "FormfieldWrapper",
7920
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
8101
+ "name": "FormInternalsMixin",
8102
+ "module": "src/utils/mixins/FormInternalsMixin.ts"
7921
8103
  }
7922
8104
  },
7923
8105
  {
7924
- "name": "required-label",
8106
+ "name": "validation-message",
7925
8107
  "type": {
7926
8108
  "text": "string | undefined"
7927
8109
  },
7928
- "description": "The required label of the input field.\nWhen an appropriate string value is set,\nthe input field is marked as required and the label is appended with this text.",
7929
- "fieldName": "requiredLabel",
8110
+ "description": "Custom validation message that will override the default message and displayed when the input is invalid.",
8111
+ "fieldName": "validationMessage",
7930
8112
  "inheritedFrom": {
7931
- "name": "FormfieldWrapper",
7932
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
8113
+ "name": "FormInternalsMixin",
8114
+ "module": "src/utils/mixins/FormInternalsMixin.ts"
7933
8115
  }
7934
8116
  },
7935
8117
  {
7936
- "name": "id",
8118
+ "name": "data-aria-label",
7937
8119
  "type": {
7938
- "text": "string"
8120
+ "text": "string | null"
7939
8121
  },
7940
- "default": "''",
7941
- "description": "The unique id of the input field. It is used to link the input field with the label.",
7942
- "fieldName": "id",
8122
+ "default": "null",
8123
+ "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
8124
+ "fieldName": "dataAriaLabel",
7943
8125
  "inheritedFrom": {
7944
- "name": "FormfieldWrapper",
7945
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
8126
+ "name": "DataAriaLabelMixin",
8127
+ "module": "src/utils/mixins/DataAriaLabelMixin.ts"
7946
8128
  }
7947
8129
  },
7948
8130
  {
7949
- "name": "help-text-type",
8131
+ "name": "disabled",
7950
8132
  "type": {
7951
- "text": "ValidationType"
8133
+ "text": "boolean"
7952
8134
  },
7953
- "description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
7954
- "fieldName": "helpTextType",
8135
+ "default": "false",
8136
+ "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
8137
+ "fieldName": "disabled",
7955
8138
  "inheritedFrom": {
7956
8139
  "name": "FormfieldWrapper",
7957
8140
  "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
7958
8141
  }
7959
8142
  },
7960
8143
  {
7961
- "name": "help-text",
8144
+ "name": "label",
7962
8145
  "type": {
7963
8146
  "text": "string | undefined"
7964
8147
  },
7965
- "description": "The help text that is displayed below the input field.",
7966
- "fieldName": "helpText",
8148
+ "description": "The label of the input field. It is linked to the input field using the `for` attribute.",
8149
+ "fieldName": "label",
7967
8150
  "inheritedFrom": {
7968
8151
  "name": "FormfieldWrapper",
7969
8152
  "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
7970
8153
  }
7971
- }
7972
- ],
7973
- "superclass": {
7974
- "name": "FormfieldGroup",
7975
- "module": "/src/components/formfieldgroup"
7976
- },
7977
- "tagName": "mdc-radiogroup",
7978
- "jsDoc": "/**\n * `mdc-radiogroup` - This is the wrapper component for radio buttons which are grouped together.\n * It can have a header text and a description. It enables users to select a single option from a set of options.\n * It is often used in forms, settings, and selection in lists. It automatically group the radio buttons inside it.\n *\n * @tagname mdc-radiogroup\n *\n * @cssproperty --mdc-radiogroup-description-text-normal - color of the description text\n *\n */",
7979
- "customElement": true,
7980
- "slots": [
7981
- {
7982
- "description": "This is a default slot for checkbox or toggle components.",
7983
- "name": "default",
7984
- "inheritedFrom": {
7985
- "name": "FormfieldGroup",
7986
- "module": "src/components/formfieldgroup/formfieldgroup.component.ts"
7987
- }
7988
8154
  },
7989
8155
  {
7990
- "description": "slot to add the label info icon",
7991
- "name": "label-info",
8156
+ "name": "required-label",
8157
+ "type": {
8158
+ "text": "string | undefined"
8159
+ },
8160
+ "description": "The required label of the input field.\nWhen an appropriate string value is set,\nthe input field is marked as required and the label is appended with this text.",
8161
+ "fieldName": "requiredLabel",
7992
8162
  "inheritedFrom": {
7993
8163
  "name": "FormfieldWrapper",
7994
8164
  "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
7995
8165
  }
7996
- }
7997
- ]
7998
- }
7999
- ],
8000
- "exports": [
8001
- {
8002
- "kind": "js",
8003
- "name": "default",
8004
- "declaration": {
8005
- "name": "RadioGroup",
8006
- "module": "components/radiogroup/radiogroup.component.js"
8007
- }
8008
- }
8009
- ]
8010
- },
8011
- {
8012
- "kind": "javascript-module",
8013
- "path": "components/spinner/spinner.component.js",
8014
- "declarations": [
8015
- {
8016
- "kind": "class",
8017
- "description": "`mdc-spinner` is loading spinner which is an indeterminate progress indicator, meaning\nit's best for cases where the progress or duration of a process is variable or unknown.\n\nSpinner Variants:\n- **Standalone (Default)**: Track has a blue color.\n- **Button**: To be used when placed in a button to show that the button’s action is currently in progress.\nTo ensure a minimum 3:1 contrast ratio, the color is changed internally to be the same color as the button’s\nicon or label text.\n\nSpinner Sizes:\n- **Large (96px)**: Use when replacing entire regions or pages that are still loading\n- **MidSize (48px) (Default)**: Use for most use cases.\n- **Small (24px)**: Use for inline with loading text.\n\nCustomisation of the spinner size is allowed by setting the size to undefined and using the --mdc-spinner-size\nCSS property.\n\nSpinner Colors:\n- **Default**: Use for most use cases.\n- **Inverted**: Only to be used within inverted components, such as coachmarks.\n\nRegarding accessibility, if an aria-label is provided, the role will be set to 'img'; if it is absent, the role\nwill be unset\nand aria-hidden will be set to 'true' so the spinner will be ignored by screen readers.",
8018
- "name": "Spinner",
8019
- "cssProperties": [
8020
- {
8021
- "description": "Allows customization of the default spinner color.",
8022
- "name": "--mdc-spinner-default-color"
8023
- },
8024
- {
8025
- "description": "Allows customization of the inverted spinner color.",
8026
- "name": "--mdc-spinner-inverted-color"
8027
- },
8028
- {
8029
- "description": "Allows customization of the spinner Button variant color.",
8030
- "name": "--mdc-spinner-button-variant-color"
8031
- },
8032
- {
8033
- "description": "Allows customization of the spinner size.",
8034
- "name": "--mdc-spinner-size"
8035
- }
8036
- ],
8037
- "cssParts": [
8038
- {
8039
- "description": "The svg which contains the circle spinner.",
8040
- "name": "container"
8041
- },
8042
- {
8043
- "description": "The circle of the spinner.",
8044
- "name": "circle"
8045
- }
8046
- ],
8047
- "members": [
8048
- {
8049
- "kind": "field",
8050
- "name": "inverted",
8051
- "description": "The spinner color can be inverted by setting the inverted attribute to true.",
8052
- "default": "false",
8053
- "attribute": "inverted",
8054
- "reflects": true
8055
- },
8056
- {
8057
- "kind": "field",
8058
- "name": "size",
8059
- "type": {
8060
- "text": "SpinnerSize | undefined"
8061
- },
8062
- "description": "Size of the spinner.\nAcceptable values include:\n\n- 'small'\n- 'midsize'\n- 'large'\n- 'undefined'",
8063
- "default": "midsize",
8064
- "attribute": "size",
8065
- "reflects": true
8066
- },
8067
- {
8068
- "kind": "field",
8069
- "name": "ariaLabel",
8070
- "type": {
8071
- "text": "string | null"
8072
- },
8073
- "default": "null",
8074
- "description": "Aria-label attribute to be set for accessibility",
8075
- "attribute": "aria-label"
8076
8166
  },
8077
8167
  {
8078
- "kind": "field",
8079
- "name": "variant",
8168
+ "name": "id",
8080
8169
  "type": {
8081
- "text": "SpinnerVariant"
8170
+ "text": "string"
8082
8171
  },
8083
- "description": "There are 2 variants of spinner: default and button. Their coloring is different.\n- **Standalone (Default)**: Track has a blue color.\n- **Button**: To be used when placed in a button to show that the button’s action is currently in progress.\nTo ensure a minimum 3:1 contrast ratio, change the active indicator color to be the same color as the button’s\nicon or label text.",
8084
- "default": "standalone",
8085
- "attribute": "variant",
8086
- "reflects": true
8087
- }
8088
- ],
8089
- "attributes": [
8090
- {
8091
- "name": "inverted",
8092
- "description": "The spinner color can be inverted by setting the inverted attribute to true.",
8093
- "default": "false",
8094
- "fieldName": "inverted"
8172
+ "default": "''",
8173
+ "description": "The unique id of the input field. It is used to link the input field with the label.",
8174
+ "fieldName": "id",
8175
+ "inheritedFrom": {
8176
+ "name": "FormfieldWrapper",
8177
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
8178
+ }
8095
8179
  },
8096
8180
  {
8097
- "name": "size",
8181
+ "name": "help-text-type",
8098
8182
  "type": {
8099
- "text": "SpinnerSize | undefined"
8183
+ "text": "ValidationType"
8100
8184
  },
8101
- "description": "Size of the spinner.\nAcceptable values include:\n\n- 'small'\n- 'midsize'\n- 'large'\n- 'undefined'",
8102
- "default": "midsize",
8103
- "fieldName": "size"
8185
+ "description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
8186
+ "fieldName": "helpTextType",
8187
+ "inheritedFrom": {
8188
+ "name": "FormfieldWrapper",
8189
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
8190
+ }
8104
8191
  },
8105
8192
  {
8106
- "name": "aria-label",
8193
+ "name": "help-text",
8107
8194
  "type": {
8108
- "text": "string | null"
8195
+ "text": "string | undefined"
8109
8196
  },
8110
- "default": "null",
8111
- "description": "Aria-label attribute to be set for accessibility",
8112
- "fieldName": "ariaLabel"
8197
+ "description": "The help text that is displayed below the input field.",
8198
+ "fieldName": "helpText",
8199
+ "inheritedFrom": {
8200
+ "name": "FormfieldWrapper",
8201
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
8202
+ }
8203
+ }
8204
+ ],
8205
+ "mixins": [
8206
+ {
8207
+ "name": "FormInternalsMixin",
8208
+ "module": "/src/utils/mixins/FormInternalsMixin"
8113
8209
  },
8114
8210
  {
8115
- "name": "variant",
8116
- "type": {
8117
- "text": "SpinnerVariant"
8118
- },
8119
- "description": "There are 2 variants of spinner: default and button. Their coloring is different.\n- **Standalone (Default)**: Track has a blue color.\n- **Button**: To be used when placed in a button to show that the button’s action is currently in progress.\nTo ensure a minimum 3:1 contrast ratio, change the active indicator color to be the same color as the button’s\nicon or label text.",
8120
- "default": "standalone",
8121
- "fieldName": "variant"
8211
+ "name": "DataAriaLabelMixin",
8212
+ "module": "/src/utils/mixins/DataAriaLabelMixin"
8122
8213
  }
8123
8214
  ],
8124
8215
  "superclass": {
8125
- "name": "Component",
8126
- "module": "/src/models"
8216
+ "name": "FormfieldWrapper",
8217
+ "module": "/src/components/formfieldwrapper/formfieldwrapper.component"
8127
8218
  },
8128
- "tagName": "mdc-spinner",
8129
- "jsDoc": "/**\n * `mdc-spinner` is loading spinner which is an indeterminate progress indicator, meaning\n * it's best for cases where the progress or duration of a process is variable or unknown.\n *\n * Spinner Variants:\n * - **Standalone (Default)**: Track has a blue color.\n * - **Button**: To be used when placed in a button to show that the button’s action is currently in progress.\n * To ensure a minimum 3:1 contrast ratio, the color is changed internally to be the same color as the button’s\n * icon or label text.\n *\n * Spinner Sizes:\n * - **Large (96px)**: Use when replacing entire regions or pages that are still loading\n * - **MidSize (48px) (Default)**: Use for most use cases.\n * - **Small (24px)**: Use for inline with loading text.\n *\n * Customisation of the spinner size is allowed by setting the size to undefined and using the --mdc-spinner-size\n * CSS property.\n *\n * Spinner Colors:\n * - **Default**: Use for most use cases.\n * - **Inverted**: Only to be used within inverted components, such as coachmarks.\n *\n * Regarding accessibility, if an aria-label is provided, the role will be set to 'img'; if it is absent, the role\n * will be unset\n * and aria-hidden will be set to 'true' so the spinner will be ignored by screen readers.\n *\n * @tagname mdc-spinner\n *\n * @cssproperty --mdc-spinner-default-color - Allows customization of the default spinner color.\n * @cssproperty --mdc-spinner-inverted-color - Allows customization of the inverted spinner color.\n * @cssproperty --mdc-spinner-button-variant-color - Allows customization of the spinner Button variant color.\n * @cssproperty --mdc-spinner-size - Allows customization of the spinner size.\n *\n * @csspart container - The svg which contains the circle spinner.\n * @csspart circle - The circle of the spinner.\n */",
8130
- "customElement": true
8219
+ "tagName": "mdc-radio",
8220
+ "jsDoc": "/**\n * Radio allow users to select single options from a list or turn an item/feature on or off.\n * These are often used in forms, settings, and selection in lists.\n *\n * A radio component contains an optional label, optional info icon and an optional helper text.\n * @dependency mdc-formfieldwrapper\n *\n * @tagname mdc-radio\n *\n * @event change - (React: onChange) Event that gets dispatched when the radio state changes.\n * @event focus - (React: onFocus) Event that gets dispatched when the radio receives focus.\n *\n * @cssproperty --mdc-radio-inner-circle-size - size of the inner circle\n * @cssproperty --mdc-radio-text-disabled-color - color of the label when disabled\n * @cssproperty --mdc-radio-disabled-border-color - color of the radio button border when disabled\n * @cssproperty --mdc-radio-normal-border-color - color of the radio button border when normal\n * @cssproperty --mdc-radio-inner-circle-normal-background - background color of the inner circle when normal\n * @cssproperty --mdc-radio-inner-circle-disabled-background - background color of the inner circle when disabled\n * @cssproperty --mdc-radio-control-inactive-color - color of the radio button when inactive\n * @cssproperty --mdc-radio-control-inactive-hover - color of the radio button when inactive and hovered\n * @cssproperty --mdc-radio-control-inactive-pressed-color - color of the radio button when inactive and pressed\n * @cssproperty --mdc-radio-control-inactive-disabled-background - background color of the radio button when\n * inactive and disabled\n * @cssproperty --mdc-radio-control-active-color - color of the radio button when active\n * @cssproperty --mdc-radio-control-active-hover-color - color of the radio button when active and hovered\n * @cssproperty --mdc-radio-control-active-pressed-color - color of the radio button when active and pressed\n * @cssproperty --mdc-radio-control-active-disabled-background - background color of the radio button\n * when active and disabled\n *\n */",
8221
+ "customElement": true,
8222
+ "slots": [
8223
+ {
8224
+ "description": "slot to add the label info icon",
8225
+ "name": "label-info",
8226
+ "inheritedFrom": {
8227
+ "name": "FormfieldWrapper",
8228
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
8229
+ }
8230
+ }
8231
+ ]
8131
8232
  }
8132
8233
  ],
8133
8234
  "exports": [
@@ -8135,182 +8236,79 @@
8135
8236
  "kind": "js",
8136
8237
  "name": "default",
8137
8238
  "declaration": {
8138
- "name": "Spinner",
8139
- "module": "components/spinner/spinner.component.js"
8239
+ "name": "Radio",
8240
+ "module": "components/radio/radio.component.js"
8140
8241
  }
8141
8242
  }
8142
8243
  ]
8143
8244
  },
8144
8245
  {
8145
8246
  "kind": "javascript-module",
8146
- "path": "components/button/button.component.js",
8247
+ "path": "components/radiogroup/radiogroup.component.js",
8147
8248
  "declarations": [
8148
8249
  {
8149
8250
  "kind": "class",
8150
- "description": "`mdc-button` is a component that can be configured in various ways to suit different use cases.\n\nButton Variants:\n- **Primary**: Solid background color.\n- **Secondary**: Transparent background with a solid border.\n- **Tertiary**: No background or border, appears as plain text but retains all button functionalities.\n\nButton Colors:\n- **Positive**: Green color.\n- **Negative**: Red color.\n- **Accent**: Blue color.\n- **Promotional**: Purple color.\n- **Default**: White color.\n\nButton Sizes (in REM units):\n- **Pill button**: 40, 32, 28, 24.\n- **Icon button**: 64, 52, 40, 32, 28, 24.\n- **Tertiary icon button**: 20.\n\nButton Types:\n- **Pill button**: A button that contains text value. Commonly used for call to action, tags, or filters.\n- **Pill button with icons**: A button containing an icon either on the left or right side of the button.\n- **Icon button**: A button represented by just an icon without any text.\nThe type of button is inferred based on the presence of slot and/or prefix and postfix icons.",
8151
- "name": "Button",
8152
- "slots": [
8251
+ "description": "`mdc-radiogroup` - This is the wrapper component for radio buttons which are grouped together.\nIt can have a header text and a description. It enables users to select a single option from a set of options.\nIt is often used in forms, settings, and selection in lists. It automatically group the radio buttons inside it.",
8252
+ "name": "RadioGroup",
8253
+ "cssProperties": [
8153
8254
  {
8154
- "description": "Text label of the button.",
8155
- "name": ""
8255
+ "description": "color of the description text",
8256
+ "name": "--mdc-radiogroup-description-text-normal"
8156
8257
  }
8157
8258
  ],
8158
8259
  "members": [
8159
8260
  {
8160
8261
  "kind": "field",
8161
- "name": "prefixIcon",
8162
- "type": {
8163
- "text": "string | undefined"
8164
- },
8165
- "description": "The name of the icon to display as a prefix.\nThe icon is displayed on the left side of the button.",
8166
- "attribute": "prefix-icon",
8167
- "reflects": true
8168
- },
8169
- {
8170
- "kind": "field",
8171
- "name": "postfixIcon",
8172
- "type": {
8173
- "text": "string | undefined"
8174
- },
8175
- "description": "The name of the icon to display as a postfix.\nThe icon is displayed on the right side of the button.",
8176
- "attribute": "postfix-icon",
8177
- "reflects": true
8178
- },
8179
- {
8180
- "kind": "field",
8181
- "name": "variant",
8262
+ "name": "name",
8182
8263
  "type": {
8183
- "text": "ButtonVariant"
8264
+ "text": "string"
8184
8265
  },
8185
- "description": "There are 3 variants of button: primary, secondary, tertiary. They are styled differently.\n- **Primary**: Solid background color.\n- **Secondary**: Transparent background with a solid border.\n- **Tertiary**: No background or border, appears as plain text but retains all button functionalities.",
8186
- "default": "primary",
8187
- "attribute": "variant"
8266
+ "default": "''",
8267
+ "description": "Name of the radio group.\nThey are used to group elements in a form together.",
8268
+ "attribute": "name"
8188
8269
  },
8189
8270
  {
8190
8271
  "kind": "field",
8191
- "name": "size",
8272
+ "name": "dataAriaLabel",
8192
8273
  "type": {
8193
- "text": "ButtonSize"
8274
+ "text": "string | null"
8194
8275
  },
8195
- "description": "Button sizing is based on the button type.\n- **Pill button**: 40, 32, 28, 24.\n- **Icon button**: 64, 52, 40, 32, 28, 24.\n- Tertiary icon button can also be 20.",
8196
- "default": "32",
8197
- "attribute": "size",
8276
+ "default": "null",
8277
+ "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
8278
+ "attribute": "data-aria-label",
8198
8279
  "reflects": true,
8199
8280
  "inheritedFrom": {
8200
- "name": "Buttonsimple",
8201
- "module": "components/buttonsimple/buttonsimple.component.js"
8281
+ "name": "DataAriaLabelMixin",
8282
+ "module": "utils/mixins/DataAriaLabelMixin.js"
8202
8283
  }
8203
8284
  },
8204
8285
  {
8205
8286
  "kind": "field",
8206
- "name": "color",
8207
- "type": {
8208
- "text": "ButtonColor"
8209
- },
8210
- "description": "There are 5 colors for button: positive, negative, accent, promotional, default.",
8211
- "default": "default",
8212
- "attribute": "color"
8213
- },
8214
- {
8215
- "kind": "field",
8216
- "name": "role",
8217
- "description": "This property defines the ARIA role for the element. By default, it is set to 'button'.\nConsumers should override this role when:\n- The element is being used in a context where a different role is more appropriate.\n- Custom behaviors are implemented that require a specific ARIA role for accessibility purposes.",
8218
- "default": "'button'",
8219
- "attribute": "role",
8220
- "reflects": true,
8287
+ "name": "id",
8221
8288
  "type": {
8222
8289
  "text": "string"
8223
8290
  },
8291
+ "default": "''",
8292
+ "description": "The unique id of the input field. It is used to link the input field with the label.",
8293
+ "attribute": "id",
8224
8294
  "inheritedFrom": {
8225
- "name": "Buttonsimple",
8226
- "module": "components/buttonsimple/buttonsimple.component.js"
8295
+ "name": "FormfieldWrapper",
8296
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
8227
8297
  }
8228
8298
  },
8229
- {
8230
- "kind": "method",
8231
- "name": "modifyIconName",
8232
- "privacy": "private",
8233
- "parameters": [
8234
- {
8235
- "name": "active",
8236
- "type": {
8237
- "text": "boolean"
8238
- },
8239
- "description": "The active state."
8240
- }
8241
- ],
8242
- "description": "Modifies the icon name based on the active state.\nIf the button is active, the icon name is suffixed with '-filled'.\nIf the button is inactive, the icon name is restored to its original value.\nIf '-filled' icon is not available, the icon name remains unchanged."
8243
- },
8244
- {
8245
- "kind": "method",
8246
- "name": "setVariant",
8247
- "privacy": "private",
8248
- "parameters": [
8249
- {
8250
- "name": "variant",
8251
- "type": {
8252
- "text": "ButtonVariant"
8253
- },
8254
- "description": "The variant to set."
8255
- }
8256
- ],
8257
- "description": "Sets the variant attribute for the button component.\nIf the provided variant is not included in the BUTTON_VARIANTS,\nit defaults to the value specified in DEFAULTS.VARIANT."
8258
- },
8259
- {
8260
- "kind": "method",
8261
- "name": "setSize",
8262
- "privacy": "private",
8263
- "parameters": [
8264
- {
8265
- "name": "size",
8266
- "type": {
8267
- "text": "PillButtonSize | IconButtonSize"
8268
- },
8269
- "description": "The size to set."
8270
- }
8271
- ],
8272
- "description": "Sets the size attribute for the button component.\nValidates the size based on the button type (icon, pill, or tertiary).\nDefaults to DEFAULTS.SIZE if invalid."
8273
- },
8274
- {
8275
- "kind": "method",
8276
- "name": "setColor",
8277
- "privacy": "private",
8278
- "parameters": [
8279
- {
8280
- "name": "color",
8281
- "type": {
8282
- "text": "ButtonColor"
8283
- },
8284
- "description": "The color to set."
8285
- }
8286
- ],
8287
- "description": "Sets the color attribute for the button.\nDefaults to DEFAULTS.COLOR if invalid or for tertiary buttons."
8288
- },
8289
- {
8290
- "kind": "method",
8291
- "name": "inferButtonType",
8292
- "privacy": "private",
8293
- "description": "Infers the type of button based on the presence of slot and/or prefix and postfix icons.",
8294
- "parameters": [
8295
- {
8296
- "description": "default slot of button",
8297
- "name": "slot"
8298
- }
8299
- ]
8300
- },
8301
8299
  {
8302
8300
  "kind": "field",
8303
- "name": "tabIndex",
8301
+ "name": "helpTextType",
8304
8302
  "type": {
8305
- "text": "number"
8303
+ "text": "ValidationType"
8306
8304
  },
8307
- "default": "0",
8308
- "description": "This property specifies the tab order of the element.",
8309
- "attribute": "tabIndex",
8305
+ "description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
8306
+ "attribute": "help-text-type",
8310
8307
  "reflects": true,
8308
+ "default": "undefined as unknown",
8311
8309
  "inheritedFrom": {
8312
- "name": "Buttonsimple",
8313
- "module": "components/buttonsimple/buttonsimple.component.js"
8310
+ "name": "FormfieldWrapper",
8311
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
8314
8312
  }
8315
8313
  },
8316
8314
  {
@@ -8319,379 +8317,397 @@
8319
8317
  "type": {
8320
8318
  "text": "boolean"
8321
8319
  },
8322
- "default": "false",
8320
+ "default": "undefined as unknown",
8323
8321
  "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
8324
8322
  "attribute": "disabled",
8325
8323
  "reflects": true,
8326
8324
  "inheritedFrom": {
8327
- "name": "Buttonsimple",
8328
- "module": "components/buttonsimple/buttonsimple.component.js"
8325
+ "name": "FormfieldWrapper",
8326
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
8329
8327
  }
8330
8328
  },
8331
8329
  {
8332
8330
  "kind": "field",
8333
- "name": "active",
8331
+ "name": "label",
8334
8332
  "type": {
8335
- "text": "boolean"
8333
+ "text": "string | undefined"
8336
8334
  },
8337
- "default": "false",
8338
- "description": "The button's active state indicates whether it is currently toggled on (active) or off (inactive).\nWhen the active state is true, the button is considered to be in an active state, meaning it is toggled on.\nConversely, when the active state is false, the button is in an inactive state, indicating it is toggled off.",
8339
- "attribute": "active",
8335
+ "description": "The label of the input field. It is linked to the input field using the `for` attribute.",
8336
+ "attribute": "label",
8340
8337
  "reflects": true,
8341
8338
  "inheritedFrom": {
8342
- "name": "Buttonsimple",
8343
- "module": "components/buttonsimple/buttonsimple.component.js"
8339
+ "name": "FormfieldWrapper",
8340
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
8344
8341
  }
8345
8342
  },
8346
8343
  {
8347
8344
  "kind": "field",
8348
- "name": "softDisabled",
8345
+ "name": "requiredLabel",
8349
8346
  "type": {
8350
- "text": "boolean"
8347
+ "text": "string | undefined"
8351
8348
  },
8352
- "default": "false",
8353
- "description": "Indicates whether the button is soft disabled.\nWhen set to `true`, the button appears visually disabled but still allows\nfocus, click, and keyboard actions to be passed through.\n\n**Important:** When using soft disabled, consumers must ensure that\nthe button behaves like a disabled button, allowing only focus and\npreventing any interactions (clicks or keyboard actions) from triggering unintended actions.",
8354
- "attribute": "soft-disabled",
8349
+ "description": "The required label of the input field.\nWhen an appropriate string value is set,\nthe input field is marked as required and the label is appended with this text.",
8350
+ "attribute": "required-label",
8351
+ "reflects": true,
8355
8352
  "inheritedFrom": {
8356
- "name": "Buttonsimple",
8357
- "module": "components/buttonsimple/buttonsimple.component.js"
8353
+ "name": "FormfieldWrapper",
8354
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
8358
8355
  }
8359
8356
  },
8360
8357
  {
8361
8358
  "kind": "field",
8362
- "name": "type",
8359
+ "name": "helpText",
8363
8360
  "type": {
8364
- "text": "ButtonType"
8361
+ "text": "string | undefined"
8365
8362
  },
8366
- "description": "This property defines the type attribute for the button element.\nThe type attribute specifies the behavior of the button when it is clicked.\n- **submit**: The button submits the form data to the server.\n- **reset**: The button resets the form data to its initial state.\n- **button**: The button does nothing when clicked.",
8367
- "default": "button",
8368
- "attribute": "type",
8363
+ "description": "The help text that is displayed below the input field.",
8364
+ "attribute": "help-text",
8369
8365
  "reflects": true,
8370
8366
  "inheritedFrom": {
8371
- "name": "Buttonsimple",
8372
- "module": "components/buttonsimple/buttonsimple.component.js"
8367
+ "name": "FormfieldWrapper",
8368
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
8373
8369
  }
8374
8370
  },
8375
8371
  {
8376
8372
  "kind": "method",
8377
- "name": "executeAction",
8373
+ "name": "renderLabelElement",
8378
8374
  "privacy": "protected",
8375
+ "description": "creates the label element when the label property is set.\nid is used to link the label with the input field.",
8376
+ "return": {
8377
+ "type": {
8378
+ "text": ""
8379
+ }
8380
+ },
8379
8381
  "inheritedFrom": {
8380
- "name": "Buttonsimple",
8381
- "module": "components/buttonsimple/buttonsimple.component.js"
8382
+ "name": "FormfieldWrapper",
8383
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
8382
8384
  }
8383
8385
  },
8384
8386
  {
8385
8387
  "kind": "method",
8386
- "name": "setActive",
8388
+ "name": "renderRequiredLabel",
8387
8389
  "privacy": "protected",
8388
- "parameters": [
8389
- {
8390
- "name": "element",
8391
- "type": {
8392
- "text": "HTMLElement"
8393
- },
8394
- "description": "The button element"
8395
- },
8396
- {
8397
- "name": "active",
8398
- "type": {
8399
- "text": "boolean"
8400
- },
8401
- "description": "The active state of the element"
8402
- }
8403
- ],
8404
- "description": "Sets the aria-pressed attribute based on the active state of the button.",
8405
8390
  "inheritedFrom": {
8406
- "name": "Buttonsimple",
8407
- "module": "components/buttonsimple/buttonsimple.component.js"
8391
+ "name": "FormfieldWrapper",
8392
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
8408
8393
  }
8409
8394
  },
8410
8395
  {
8411
8396
  "kind": "method",
8412
- "name": "setSoftDisabled",
8413
- "privacy": "private",
8414
- "parameters": [
8415
- {
8416
- "name": "element",
8417
- "type": {
8418
- "text": "HTMLElement"
8419
- },
8420
- "description": "The button element."
8421
- },
8422
- {
8423
- "name": "softDisabled",
8424
- "type": {
8425
- "text": "boolean"
8426
- },
8427
- "description": "The soft-disabled state."
8397
+ "name": "renderHelpTextIcon",
8398
+ "privacy": "protected",
8399
+ "description": "creates the helpertext icon based on the helpTextType for validation.\nIf the helpTextType is not set, it defaults to 'default' and it doesn't display any icon.",
8400
+ "return": {
8401
+ "type": {
8402
+ "text": ""
8428
8403
  }
8429
- ],
8430
- "description": "Sets the soft-disabled attribute for the button.\nWhen soft-disabled, the button looks to be disabled but remains focusable and clickable.\nAlso sets/removes aria-disabled attribute.",
8404
+ },
8431
8405
  "inheritedFrom": {
8432
- "name": "Buttonsimple",
8433
- "module": "components/buttonsimple/buttonsimple.component.js"
8406
+ "name": "FormfieldWrapper",
8407
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
8434
8408
  }
8435
8409
  },
8436
8410
  {
8437
8411
  "kind": "method",
8438
- "name": "setDisabled",
8439
- "privacy": "private",
8440
- "parameters": [
8441
- {
8442
- "name": "element",
8443
- "type": {
8444
- "text": "HTMLElement"
8445
- },
8446
- "description": "The button element."
8447
- },
8448
- {
8449
- "name": "disabled",
8450
- "type": {
8451
- "text": "boolean"
8452
- },
8453
- "description": "The disabled state."
8412
+ "name": "renderHelpText",
8413
+ "privacy": "protected",
8414
+ "description": "creates the helper text component when the helpertext value is set.\nIt is also used to display the validation message based on the helpTextType.",
8415
+ "return": {
8416
+ "type": {
8417
+ "text": ""
8454
8418
  }
8455
- ],
8456
- "description": "Sets the disabled attribute for the button.\nWhen disabled, the button is not focusable or clickable, and tabindex is set to -1.\nThe previous tabindex is stored and restored when enabled.\nAlso sets/removes aria-disabled attribute.",
8457
- "inheritedFrom": {
8458
- "name": "Buttonsimple",
8459
- "module": "components/buttonsimple/buttonsimple.component.js"
8460
- }
8461
- },
8462
- {
8463
- "kind": "method",
8464
- "name": "triggerClickEvent",
8465
- "privacy": "private",
8466
- "inheritedFrom": {
8467
- "name": "Buttonsimple",
8468
- "module": "components/buttonsimple/buttonsimple.component.js"
8469
- }
8470
- },
8471
- {
8472
- "kind": "method",
8473
- "name": "handleBlur",
8474
- "privacy": "private",
8475
- "description": "In case the button is pressed and the focus is lost while pressing,\nthe pressed class is removed.",
8419
+ },
8476
8420
  "inheritedFrom": {
8477
- "name": "Buttonsimple",
8478
- "module": "components/buttonsimple/buttonsimple.component.js"
8421
+ "name": "FormfieldWrapper",
8422
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
8479
8423
  }
8480
8424
  },
8481
8425
  {
8482
8426
  "kind": "method",
8483
- "name": "handleKeyDown",
8484
- "privacy": "private",
8485
- "parameters": [
8486
- {
8487
- "name": "event",
8488
- "type": {
8489
- "text": "KeyboardEvent"
8490
- },
8491
- "description": "The keyboard event."
8427
+ "name": "renderLabel",
8428
+ "privacy": "protected",
8429
+ "description": "renders the mdc-label-text container that contains the label and labelInfoToggleTip.",
8430
+ "return": {
8431
+ "type": {
8432
+ "text": ""
8492
8433
  }
8493
- ],
8494
- "description": "Handles the keydown event on the button.\nIf the key is 'Enter' or 'Space', the button is pressed.\nIf the key is 'Enter', the button is pressed. The native HTML button works in the same way.",
8434
+ },
8495
8435
  "inheritedFrom": {
8496
- "name": "Buttonsimple",
8497
- "module": "components/buttonsimple/buttonsimple.component.js"
8436
+ "name": "FormfieldWrapper",
8437
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
8498
8438
  }
8499
8439
  },
8500
8440
  {
8501
8441
  "kind": "method",
8502
- "name": "handleKeyUp",
8503
- "privacy": "private",
8504
- "parameters": [
8505
- {
8506
- "name": "event",
8507
- "type": {
8508
- "text": "KeyboardEvent"
8509
- },
8510
- "description": "The keyboard event."
8442
+ "name": "renderHelperText",
8443
+ "privacy": "protected",
8444
+ "description": "renders the mdc-help-text container that contains the helpertext icon and helpertext.",
8445
+ "return": {
8446
+ "type": {
8447
+ "text": ""
8511
8448
  }
8512
- ],
8513
- "description": "Handles the keyup event on the button.\nIf the key is 'Enter' or 'Space', the button is clicked.\nIf the key is 'Space', the button is pressed. The native HTML button works in the same way.",
8449
+ },
8514
8450
  "inheritedFrom": {
8515
- "name": "Buttonsimple",
8516
- "module": "components/buttonsimple/buttonsimple.component.js"
8451
+ "name": "FormfieldWrapper",
8452
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
8517
8453
  }
8518
8454
  }
8519
8455
  ],
8520
- "events": [
8521
- {
8522
- "description": "(React: onClick) This event is dispatched when the button is clicked.",
8523
- "name": "click",
8524
- "reactName": "onClick",
8525
- "eventName": "ClickEvent",
8526
- "inheritedFrom": {
8527
- "name": "Buttonsimple",
8528
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
8529
- }
8530
- },
8456
+ "attributes": [
8531
8457
  {
8532
- "description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the button.",
8533
- "name": "keydown",
8534
- "reactName": "onKeyDown",
8535
- "eventName": "KeydownEvent",
8536
- "inheritedFrom": {
8537
- "name": "Buttonsimple",
8538
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
8539
- }
8458
+ "name": "name",
8459
+ "type": {
8460
+ "text": "string"
8461
+ },
8462
+ "default": "''",
8463
+ "description": "Name of the radio group.\nThey are used to group elements in a form together.",
8464
+ "fieldName": "name"
8540
8465
  },
8541
8466
  {
8542
- "description": "(React: onKeyUp) This event is dispatched when a key is released on the button.",
8543
- "name": "keyup",
8544
- "reactName": "onKeyUp",
8545
- "eventName": "KeyupEvent",
8467
+ "name": "data-aria-label",
8468
+ "type": {
8469
+ "text": "string | null"
8470
+ },
8471
+ "default": "null",
8472
+ "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
8473
+ "fieldName": "dataAriaLabel",
8546
8474
  "inheritedFrom": {
8547
- "name": "Buttonsimple",
8548
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
8475
+ "name": "DataAriaLabelMixin",
8476
+ "module": "src/utils/mixins/DataAriaLabelMixin.ts"
8549
8477
  }
8550
8478
  },
8551
8479
  {
8552
- "description": "(React: onFocus) This event is dispatched when the button receives focus.",
8553
- "name": "focus",
8554
- "reactName": "onFocus",
8555
- "eventName": "FocusEvent",
8480
+ "name": "disabled",
8481
+ "type": {
8482
+ "text": "boolean"
8483
+ },
8484
+ "default": "false",
8485
+ "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
8486
+ "fieldName": "disabled",
8556
8487
  "inheritedFrom": {
8557
- "name": "Buttonsimple",
8558
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
8488
+ "name": "FormfieldWrapper",
8489
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
8559
8490
  }
8560
- }
8561
- ],
8562
- "attributes": [
8491
+ },
8563
8492
  {
8564
- "name": "prefix-icon",
8493
+ "name": "label",
8565
8494
  "type": {
8566
8495
  "text": "string | undefined"
8567
8496
  },
8568
- "description": "The name of the icon to display as a prefix.\nThe icon is displayed on the left side of the button.",
8569
- "fieldName": "prefixIcon"
8497
+ "description": "The label of the input field. It is linked to the input field using the `for` attribute.",
8498
+ "fieldName": "label",
8499
+ "inheritedFrom": {
8500
+ "name": "FormfieldWrapper",
8501
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
8502
+ }
8570
8503
  },
8571
8504
  {
8572
- "name": "postfix-icon",
8505
+ "name": "required-label",
8573
8506
  "type": {
8574
8507
  "text": "string | undefined"
8575
8508
  },
8576
- "description": "The name of the icon to display as a postfix.\nThe icon is displayed on the right side of the button.",
8577
- "fieldName": "postfixIcon"
8509
+ "description": "The required label of the input field.\nWhen an appropriate string value is set,\nthe input field is marked as required and the label is appended with this text.",
8510
+ "fieldName": "requiredLabel",
8511
+ "inheritedFrom": {
8512
+ "name": "FormfieldWrapper",
8513
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
8514
+ }
8578
8515
  },
8579
8516
  {
8580
- "name": "variant",
8517
+ "name": "id",
8581
8518
  "type": {
8582
- "text": "ButtonVariant"
8519
+ "text": "string"
8583
8520
  },
8584
- "description": "There are 3 variants of button: primary, secondary, tertiary. They are styled differently.\n- **Primary**: Solid background color.\n- **Secondary**: Transparent background with a solid border.\n- **Tertiary**: No background or border, appears as plain text but retains all button functionalities.",
8585
- "default": "primary",
8586
- "fieldName": "variant"
8521
+ "default": "''",
8522
+ "description": "The unique id of the input field. It is used to link the input field with the label.",
8523
+ "fieldName": "id",
8524
+ "inheritedFrom": {
8525
+ "name": "FormfieldWrapper",
8526
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
8527
+ }
8587
8528
  },
8588
8529
  {
8589
- "name": "size",
8530
+ "name": "help-text-type",
8590
8531
  "type": {
8591
- "text": "ButtonSize"
8532
+ "text": "ValidationType"
8592
8533
  },
8593
- "description": "Button sizing is based on the button type.\n- **Pill button**: 40, 32, 28, 24.\n- **Icon button**: 64, 52, 40, 32, 28, 24.\n- Tertiary icon button can also be 20.",
8594
- "default": "32",
8595
- "fieldName": "size",
8534
+ "description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
8535
+ "fieldName": "helpTextType",
8596
8536
  "inheritedFrom": {
8597
- "name": "Buttonsimple",
8598
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
8537
+ "name": "FormfieldWrapper",
8538
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
8599
8539
  }
8600
8540
  },
8601
8541
  {
8602
- "name": "color",
8542
+ "name": "help-text",
8603
8543
  "type": {
8604
- "text": "ButtonColor"
8544
+ "text": "string | undefined"
8605
8545
  },
8606
- "description": "There are 5 colors for button: positive, negative, accent, promotional, default.",
8607
- "default": "default",
8608
- "fieldName": "color"
8546
+ "description": "The help text that is displayed below the input field.",
8547
+ "fieldName": "helpText",
8548
+ "inheritedFrom": {
8549
+ "name": "FormfieldWrapper",
8550
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
8551
+ }
8552
+ }
8553
+ ],
8554
+ "superclass": {
8555
+ "name": "FormfieldGroup",
8556
+ "module": "/src/components/formfieldgroup"
8557
+ },
8558
+ "tagName": "mdc-radiogroup",
8559
+ "jsDoc": "/**\n * `mdc-radiogroup` - This is the wrapper component for radio buttons which are grouped together.\n * It can have a header text and a description. It enables users to select a single option from a set of options.\n * It is often used in forms, settings, and selection in lists. It automatically group the radio buttons inside it.\n *\n * @tagname mdc-radiogroup\n *\n * @cssproperty --mdc-radiogroup-description-text-normal - color of the description text\n *\n */",
8560
+ "customElement": true,
8561
+ "slots": [
8562
+ {
8563
+ "description": "This is a default slot for checkbox or toggle components.",
8564
+ "name": "default",
8565
+ "inheritedFrom": {
8566
+ "name": "FormfieldGroup",
8567
+ "module": "src/components/formfieldgroup/formfieldgroup.component.ts"
8568
+ }
8609
8569
  },
8610
8570
  {
8611
- "name": "role",
8612
- "description": "This property defines the ARIA role for the element. By default, it is set to 'button'.\nConsumers should override this role when:\n- The element is being used in a context where a different role is more appropriate.\n- Custom behaviors are implemented that require a specific ARIA role for accessibility purposes.",
8613
- "default": "'button'",
8614
- "fieldName": "role",
8615
- "type": {
8616
- "text": "string"
8617
- },
8571
+ "description": "slot to add the label info icon",
8572
+ "name": "label-info",
8618
8573
  "inheritedFrom": {
8619
- "name": "Buttonsimple",
8620
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
8574
+ "name": "FormfieldWrapper",
8575
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
8621
8576
  }
8577
+ }
8578
+ ]
8579
+ }
8580
+ ],
8581
+ "exports": [
8582
+ {
8583
+ "kind": "js",
8584
+ "name": "default",
8585
+ "declaration": {
8586
+ "name": "RadioGroup",
8587
+ "module": "components/radiogroup/radiogroup.component.js"
8588
+ }
8589
+ }
8590
+ ]
8591
+ },
8592
+ {
8593
+ "kind": "javascript-module",
8594
+ "path": "components/spinner/spinner.component.js",
8595
+ "declarations": [
8596
+ {
8597
+ "kind": "class",
8598
+ "description": "`mdc-spinner` is loading spinner which is an indeterminate progress indicator, meaning\nit's best for cases where the progress or duration of a process is variable or unknown.\n\nSpinner Variants:\n- **Standalone (Default)**: Track has a blue color.\n- **Button**: To be used when placed in a button to show that the button’s action is currently in progress.\nTo ensure a minimum 3:1 contrast ratio, the color is changed internally to be the same color as the button’s\nicon or label text.\n\nSpinner Sizes:\n- **Large (96px)**: Use when replacing entire regions or pages that are still loading\n- **MidSize (48px) (Default)**: Use for most use cases.\n- **Small (24px)**: Use for inline with loading text.\n\nCustomisation of the spinner size is allowed by setting the size to undefined and using the --mdc-spinner-size\nCSS property.\n\nSpinner Colors:\n- **Default**: Use for most use cases.\n- **Inverted**: Only to be used within inverted components, such as coachmarks.\n\nRegarding accessibility, if an aria-label is provided, the role will be set to 'img'; if it is absent, the role\nwill be unset\nand aria-hidden will be set to 'true' so the spinner will be ignored by screen readers.",
8599
+ "name": "Spinner",
8600
+ "cssProperties": [
8601
+ {
8602
+ "description": "Allows customization of the default spinner color.",
8603
+ "name": "--mdc-spinner-default-color"
8622
8604
  },
8623
8605
  {
8624
- "name": "tabIndex",
8606
+ "description": "Allows customization of the inverted spinner color.",
8607
+ "name": "--mdc-spinner-inverted-color"
8608
+ },
8609
+ {
8610
+ "description": "Allows customization of the spinner Button variant color.",
8611
+ "name": "--mdc-spinner-button-variant-color"
8612
+ },
8613
+ {
8614
+ "description": "Allows customization of the spinner size.",
8615
+ "name": "--mdc-spinner-size"
8616
+ }
8617
+ ],
8618
+ "cssParts": [
8619
+ {
8620
+ "description": "The svg which contains the circle spinner.",
8621
+ "name": "container"
8622
+ },
8623
+ {
8624
+ "description": "The circle of the spinner.",
8625
+ "name": "circle"
8626
+ }
8627
+ ],
8628
+ "members": [
8629
+ {
8630
+ "kind": "field",
8631
+ "name": "inverted",
8632
+ "description": "The spinner color can be inverted by setting the inverted attribute to true.",
8633
+ "default": "false",
8634
+ "attribute": "inverted",
8635
+ "reflects": true
8636
+ },
8637
+ {
8638
+ "kind": "field",
8639
+ "name": "size",
8625
8640
  "type": {
8626
- "text": "number"
8641
+ "text": "SpinnerSize | undefined"
8627
8642
  },
8628
- "default": "0",
8629
- "description": "This property specifies the tab order of the element.",
8630
- "fieldName": "tabIndex",
8631
- "inheritedFrom": {
8632
- "name": "Buttonsimple",
8633
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
8634
- }
8643
+ "description": "Size of the spinner.\nAcceptable values include:\n\n- 'small'\n- 'midsize'\n- 'large'\n- 'undefined'",
8644
+ "default": "midsize",
8645
+ "attribute": "size",
8646
+ "reflects": true
8635
8647
  },
8636
8648
  {
8637
- "name": "disabled",
8649
+ "kind": "field",
8650
+ "name": "ariaLabel",
8638
8651
  "type": {
8639
- "text": "boolean"
8652
+ "text": "string | null"
8640
8653
  },
8641
- "default": "false",
8642
- "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
8643
- "fieldName": "disabled",
8644
- "inheritedFrom": {
8645
- "name": "Buttonsimple",
8646
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
8647
- }
8654
+ "default": "null",
8655
+ "description": "Aria-label attribute to be set for accessibility",
8656
+ "attribute": "aria-label"
8648
8657
  },
8649
8658
  {
8650
- "name": "active",
8659
+ "kind": "field",
8660
+ "name": "variant",
8651
8661
  "type": {
8652
- "text": "boolean"
8662
+ "text": "SpinnerVariant"
8653
8663
  },
8664
+ "description": "There are 2 variants of spinner: default and button. Their coloring is different.\n- **Standalone (Default)**: Track has a blue color.\n- **Button**: To be used when placed in a button to show that the button’s action is currently in progress.\nTo ensure a minimum 3:1 contrast ratio, change the active indicator color to be the same color as the button’s\nicon or label text.",
8665
+ "default": "standalone",
8666
+ "attribute": "variant",
8667
+ "reflects": true
8668
+ }
8669
+ ],
8670
+ "attributes": [
8671
+ {
8672
+ "name": "inverted",
8673
+ "description": "The spinner color can be inverted by setting the inverted attribute to true.",
8654
8674
  "default": "false",
8655
- "description": "The button's active state indicates whether it is currently toggled on (active) or off (inactive).\nWhen the active state is true, the button is considered to be in an active state, meaning it is toggled on.\nConversely, when the active state is false, the button is in an inactive state, indicating it is toggled off.",
8656
- "fieldName": "active",
8657
- "inheritedFrom": {
8658
- "name": "Buttonsimple",
8659
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
8660
- }
8675
+ "fieldName": "inverted"
8661
8676
  },
8662
8677
  {
8663
- "name": "soft-disabled",
8678
+ "name": "size",
8664
8679
  "type": {
8665
- "text": "boolean"
8680
+ "text": "SpinnerSize | undefined"
8666
8681
  },
8667
- "default": "false",
8668
- "description": "Indicates whether the button is soft disabled.\nWhen set to `true`, the button appears visually disabled but still allows\nfocus, click, and keyboard actions to be passed through.\n\n**Important:** When using soft disabled, consumers must ensure that\nthe button behaves like a disabled button, allowing only focus and\npreventing any interactions (clicks or keyboard actions) from triggering unintended actions.",
8669
- "fieldName": "softDisabled",
8670
- "inheritedFrom": {
8671
- "name": "Buttonsimple",
8672
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
8673
- }
8682
+ "description": "Size of the spinner.\nAcceptable values include:\n\n- 'small'\n- 'midsize'\n- 'large'\n- 'undefined'",
8683
+ "default": "midsize",
8684
+ "fieldName": "size"
8674
8685
  },
8675
8686
  {
8676
- "name": "type",
8687
+ "name": "aria-label",
8677
8688
  "type": {
8678
- "text": "ButtonType"
8689
+ "text": "string | null"
8679
8690
  },
8680
- "description": "This property defines the type attribute for the button element.\nThe type attribute specifies the behavior of the button when it is clicked.\n- **submit**: The button submits the form data to the server.\n- **reset**: The button resets the form data to its initial state.\n- **button**: The button does nothing when clicked.",
8681
- "default": "button",
8682
- "fieldName": "type",
8683
- "inheritedFrom": {
8684
- "name": "Buttonsimple",
8685
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
8686
- }
8691
+ "default": "null",
8692
+ "description": "Aria-label attribute to be set for accessibility",
8693
+ "fieldName": "ariaLabel"
8694
+ },
8695
+ {
8696
+ "name": "variant",
8697
+ "type": {
8698
+ "text": "SpinnerVariant"
8699
+ },
8700
+ "description": "There are 2 variants of spinner: default and button. Their coloring is different.\n- **Standalone (Default)**: Track has a blue color.\n- **Button**: To be used when placed in a button to show that the button’s action is currently in progress.\nTo ensure a minimum 3:1 contrast ratio, change the active indicator color to be the same color as the button’s\nicon or label text.",
8701
+ "default": "standalone",
8702
+ "fieldName": "variant"
8687
8703
  }
8688
8704
  ],
8689
8705
  "superclass": {
8690
- "name": "Buttonsimple",
8691
- "module": "/src/components/buttonsimple/buttonsimple.component"
8706
+ "name": "Component",
8707
+ "module": "/src/models"
8692
8708
  },
8693
- "tagName": "mdc-button",
8694
- "jsDoc": "/**\n * `mdc-button` is a component that can be configured in various ways to suit different use cases.\n *\n * Button Variants:\n * - **Primary**: Solid background color.\n * - **Secondary**: Transparent background with a solid border.\n * - **Tertiary**: No background or border, appears as plain text but retains all button functionalities.\n *\n * Button Colors:\n * - **Positive**: Green color.\n * - **Negative**: Red color.\n * - **Accent**: Blue color.\n * - **Promotional**: Purple color.\n * - **Default**: White color.\n *\n * Button Sizes (in REM units):\n * - **Pill button**: 40, 32, 28, 24.\n * - **Icon button**: 64, 52, 40, 32, 28, 24.\n * - **Tertiary icon button**: 20.\n *\n * Button Types:\n * - **Pill button**: A button that contains text value. Commonly used for call to action, tags, or filters.\n * - **Pill button with icons**: A button containing an icon either on the left or right side of the button.\n * - **Icon button**: A button represented by just an icon without any text.\n * The type of button is inferred based on the presence of slot and/or prefix and postfix icons.\n *\n * @dependency mdc-icon\n *\n * @event click - (React: onClick) This event is dispatched when the button is clicked.\n * @event keydown - (React: onKeyDown) This event is dispatched when a key is pressed down on the button.\n * @event keyup - (React: onKeyUp) This event is dispatched when a key is released on the button.\n * @event focus - (React: onFocus) This event is dispatched when the button receives focus.\n *\n * @tagname mdc-button\n *\n * @slot - Text label of the button.\n */",
8709
+ "tagName": "mdc-spinner",
8710
+ "jsDoc": "/**\n * `mdc-spinner` is loading spinner which is an indeterminate progress indicator, meaning\n * it's best for cases where the progress or duration of a process is variable or unknown.\n *\n * Spinner Variants:\n * - **Standalone (Default)**: Track has a blue color.\n * - **Button**: To be used when placed in a button to show that the button’s action is currently in progress.\n * To ensure a minimum 3:1 contrast ratio, the color is changed internally to be the same color as the button’s\n * icon or label text.\n *\n * Spinner Sizes:\n * - **Large (96px)**: Use when replacing entire regions or pages that are still loading\n * - **MidSize (48px) (Default)**: Use for most use cases.\n * - **Small (24px)**: Use for inline with loading text.\n *\n * Customisation of the spinner size is allowed by setting the size to undefined and using the --mdc-spinner-size\n * CSS property.\n *\n * Spinner Colors:\n * - **Default**: Use for most use cases.\n * - **Inverted**: Only to be used within inverted components, such as coachmarks.\n *\n * Regarding accessibility, if an aria-label is provided, the role will be set to 'img'; if it is absent, the role\n * will be unset\n * and aria-hidden will be set to 'true' so the spinner will be ignored by screen readers.\n *\n * @tagname mdc-spinner\n *\n * @cssproperty --mdc-spinner-default-color - Allows customization of the default spinner color.\n * @cssproperty --mdc-spinner-inverted-color - Allows customization of the inverted spinner color.\n * @cssproperty --mdc-spinner-button-variant-color - Allows customization of the spinner Button variant color.\n * @cssproperty --mdc-spinner-size - Allows customization of the spinner size.\n *\n * @csspart container - The svg which contains the circle spinner.\n * @csspart circle - The circle of the spinner.\n */",
8695
8711
  "customElement": true
8696
8712
  }
8697
8713
  ],
@@ -8700,8 +8716,8 @@
8700
8716
  "kind": "js",
8701
8717
  "name": "default",
8702
8718
  "declaration": {
8703
- "name": "Button",
8704
- "module": "components/button/button.component.js"
8719
+ "name": "Spinner",
8720
+ "module": "components/spinner/spinner.component.js"
8705
8721
  }
8706
8722
  }
8707
8723
  ]
@@ -9517,7 +9533,7 @@
9517
9533
  "declarations": [
9518
9534
  {
9519
9535
  "kind": "class",
9520
- "description": "ThemeProvider component, which sets the passed in themeclass as class.\nIf the themeclass switches, the existing themeclass will be removed as a class\nand the new themeclass will be added.\n\nCSS variables defined in the themeclass will be used for the styling of child dom nodes.\n\nThemeclass context can be be consumed from Lit child components\n(see providerUtils.consume for how to consume)\n\nThemeProvider also includes basic font defaults for text.",
9536
+ "description": "ThemeProvider component, which sets the passed in themeclass as class.\nIf the themeclass switches, the existing themeclass will be removed as a class\nand the new themeclass will be added.\n\nCSS variables defined in the themeclass will be used for the styling of child dom nodes.\n\nAvailable Momentum theme classes:\n\n`mds-theme-stable-darkWebex`, `mds-theme-stable-lightWebex`\n\n`mds-theme-stable-darkBronzeWebex`, `mds-theme-stable-lightBronzeWebex`\n\n`mds-theme-stable-darkIndigoWebex`, `mds-theme-stable-lightIndigoWebex`\n\n`mds-theme-stable-darkJadeWebex`, `mds-theme-stable-lightJadeWebex`\n\n`mds-theme-stable-darkLavenderWebex`, `mds-theme-stable-lightLavenderWebex`\n\n`mds-theme-stable-darkRoseWebex`, `mds-theme-stable-lightRoseWebex`\n\nThemeclass context can be be consumed from Lit child components\n(see providerUtils.consume for how to consume)\n\nThemeProvider also includes basic font defaults for text.",
9521
9537
  "name": "ThemeProvider",
9522
9538
  "cssProperties": [
9523
9539
  {
@@ -9614,7 +9630,7 @@
9614
9630
  "module": "/src/models"
9615
9631
  },
9616
9632
  "tagName": "mdc-themeprovider",
9617
- "jsDoc": "/**\n * ThemeProvider component, which sets the passed in themeclass as class.\n * If the themeclass switches, the existing themeclass will be removed as a class\n * and the new themeclass will be added.\n *\n * CSS variables defined in the themeclass will be used for the styling of child dom nodes.\n *\n * Themeclass context can be be consumed from Lit child components\n * (see providerUtils.consume for how to consume)\n *\n * ThemeProvider also includes basic font defaults for text.\n *\n * @tagname mdc-themeprovider\n *\n * @slot - children\n *\n * @cssproperty --mdc-themeprovider-color-default - Option to override the default color,\n * default: color-theme-text-primary-normal\n * @cssproperty --mdc-themeprovider-font-family - Option to override the font family,\n * default: `Momentum` (from momentum-design/fonts)\n * @cssproperty --mdc-themeprovider-font-weight - Option to override the font weight, default: `400`\n * @cssproperty --mdc-themeprovider-letter-spacing-adjustment - Option to override the default letter-spacing,\n * default: `-0.25px` (this is to match the old CiscoSans)\n * @cssproperty --mdc-themeprovider-font-feature-settings - Option to override the font feature settings,\n * default: `\"ss02\" on`\n * @cssproperty --mdc-themeprovider-scrollbar-track-color - Option to override the color of the scrollbar track.\n * @cssproperty --mdc-themeprovider-scrollbar-thumb-color - Option to override the color of the scrollbar thumb.\n * @cssproperty --mdc-themeprovider-scrollbar-thumb-hover-color - Option to override the color of the\n * scrollbar thumb on hover. Applicable only on webkit browsers.\n * @cssproperty --mdc-themeprovider-scrollbar-thumb-active-color - Option to override the color of the\n * scrollbar thumb on press. Applicable only on webkit browsers.\n */",
9633
+ "jsDoc": "/**\n * ThemeProvider component, which sets the passed in themeclass as class.\n * If the themeclass switches, the existing themeclass will be removed as a class\n * and the new themeclass will be added.\n *\n * CSS variables defined in the themeclass will be used for the styling of child dom nodes.\n *\n * Available Momentum theme classes:\n *\n * `mds-theme-stable-darkWebex`, `mds-theme-stable-lightWebex`\n *\n * `mds-theme-stable-darkBronzeWebex`, `mds-theme-stable-lightBronzeWebex`\n *\n * `mds-theme-stable-darkIndigoWebex`, `mds-theme-stable-lightIndigoWebex`\n *\n * `mds-theme-stable-darkJadeWebex`, `mds-theme-stable-lightJadeWebex`\n *\n * `mds-theme-stable-darkLavenderWebex`, `mds-theme-stable-lightLavenderWebex`\n *\n * `mds-theme-stable-darkRoseWebex`, `mds-theme-stable-lightRoseWebex`\n *\n * Themeclass context can be be consumed from Lit child components\n * (see providerUtils.consume for how to consume)\n *\n * ThemeProvider also includes basic font defaults for text.\n *\n * @tagname mdc-themeprovider\n *\n * @slot - children\n *\n * @cssproperty --mdc-themeprovider-color-default - Option to override the default color,\n * default: color-theme-text-primary-normal\n * @cssproperty --mdc-themeprovider-font-family - Option to override the font family,\n * default: `Momentum` (from momentum-design/fonts)\n * @cssproperty --mdc-themeprovider-font-weight - Option to override the font weight, default: `400`\n * @cssproperty --mdc-themeprovider-letter-spacing-adjustment - Option to override the default letter-spacing,\n * default: `-0.25px` (this is to match the old CiscoSans)\n * @cssproperty --mdc-themeprovider-font-feature-settings - Option to override the font feature settings,\n * default: `\"ss02\" on`\n * @cssproperty --mdc-themeprovider-scrollbar-track-color - Option to override the color of the scrollbar track.\n * @cssproperty --mdc-themeprovider-scrollbar-thumb-color - Option to override the color of the scrollbar thumb.\n * @cssproperty --mdc-themeprovider-scrollbar-thumb-hover-color - Option to override the color of the\n * scrollbar thumb on hover. Applicable only on webkit browsers.\n * @cssproperty --mdc-themeprovider-scrollbar-thumb-active-color - Option to override the color of the\n * scrollbar thumb on press. Applicable only on webkit browsers.\n */",
9618
9634
  "customElement": true
9619
9635
  }
9620
9636
  ],