@momentum-design/components 0.101.2 → 0.101.4

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.
@@ -968,6 +968,218 @@
968
968
  }
969
969
  ]
970
970
  },
971
+ {
972
+ "kind": "javascript-module",
973
+ "path": "components/animation/animation.component.js",
974
+ "declarations": [
975
+ {
976
+ "kind": "class",
977
+ "description": "The `mdc-animation` component is a wrapper around the Lottie animation library.\nIt fetches the animation data dynamically based on the provided name and renders it.\nThis is a display only component that does not have any interactive functionality.\nFrom accessibility perspective, (by default) it is a decorative image component.",
978
+ "name": "Animation",
979
+ "members": [
980
+ {
981
+ "kind": "field",
982
+ "name": "name",
983
+ "type": {
984
+ "text": "AnimationNames | undefined"
985
+ },
986
+ "description": "Name of the animation (= filename)",
987
+ "attribute": "name",
988
+ "reflects": true
989
+ },
990
+ {
991
+ "kind": "field",
992
+ "name": "loop",
993
+ "type": {
994
+ "text": "LoopType | undefined"
995
+ },
996
+ "description": "How many times to loop the animation\n- \"true\" - infinite\n- \"false\" - no loop\n- number - number of times to loop",
997
+ "attribute": "loop",
998
+ "reflects": true
999
+ },
1000
+ {
1001
+ "kind": "field",
1002
+ "name": "autoplay",
1003
+ "type": {
1004
+ "text": "boolean | undefined"
1005
+ },
1006
+ "description": "Weather start the animation automatically",
1007
+ "attribute": "autoplay",
1008
+ "reflects": true
1009
+ },
1010
+ {
1011
+ "kind": "field",
1012
+ "name": "ariaLabel",
1013
+ "type": {
1014
+ "text": "string | null"
1015
+ },
1016
+ "default": "null",
1017
+ "description": "Aria-label attribute to be set for accessibility",
1018
+ "attribute": "aria-label"
1019
+ },
1020
+ {
1021
+ "kind": "field",
1022
+ "name": "ariaLabelledBy",
1023
+ "type": {
1024
+ "text": "string | null"
1025
+ },
1026
+ "default": "null",
1027
+ "description": "Aria-labelledby attribute to be set for accessibility",
1028
+ "attribute": "aria-labelledby"
1029
+ },
1030
+ {
1031
+ "kind": "field",
1032
+ "name": "lottieInstance",
1033
+ "type": {
1034
+ "text": "AnimationItem | undefined"
1035
+ },
1036
+ "privacy": "private",
1037
+ "description": "Lottie animation instance"
1038
+ },
1039
+ {
1040
+ "kind": "field",
1041
+ "name": "containerRef",
1042
+ "type": {
1043
+ "text": "Ref<HTMLDivElement>"
1044
+ },
1045
+ "privacy": "private",
1046
+ "description": "Container for the animation"
1047
+ },
1048
+ {
1049
+ "kind": "field",
1050
+ "name": "animation",
1051
+ "description": "Exposed API of the animation library (lottie)",
1052
+ "readonly": true
1053
+ },
1054
+ {
1055
+ "kind": "method",
1056
+ "name": "getLoopValue",
1057
+ "privacy": "private"
1058
+ },
1059
+ {
1060
+ "kind": "method",
1061
+ "name": "onLoadSuccessHandler",
1062
+ "privacy": "private",
1063
+ "parameters": [
1064
+ {
1065
+ "name": "animationData",
1066
+ "type": {
1067
+ "text": "any"
1068
+ }
1069
+ }
1070
+ ],
1071
+ "description": "Create new lotty instance for the loaded data"
1072
+ },
1073
+ {
1074
+ "kind": "method",
1075
+ "name": "onLoadFailHandler",
1076
+ "privacy": "private",
1077
+ "parameters": [
1078
+ {
1079
+ "name": "error",
1080
+ "type": {
1081
+ "text": "Error"
1082
+ }
1083
+ }
1084
+ ],
1085
+ "description": "Error handler for animation loading"
1086
+ },
1087
+ {
1088
+ "kind": "method",
1089
+ "name": "getAnimationData",
1090
+ "privacy": "private",
1091
+ "description": "Import animation data dynamically"
1092
+ },
1093
+ {
1094
+ "kind": "field",
1095
+ "name": "onCompleteHandler",
1096
+ "description": "Re-dispatch the complete event from the animation library\n\nThis handler called with the animation instance instead of the component instance\nso we need to bind it to the component instance. The arrow function just does that."
1097
+ }
1098
+ ],
1099
+ "events": [
1100
+ {
1101
+ "name": "load",
1102
+ "type": {
1103
+ "text": "CustomEvent"
1104
+ },
1105
+ "description": "(React: onLoad) This event is dispatched when the animation is loaded",
1106
+ "reactName": "onLoad"
1107
+ },
1108
+ {
1109
+ "description": "(React: onComplete) This event is dispatched when all animation loops completed",
1110
+ "name": "complete",
1111
+ "reactName": "onComplete"
1112
+ },
1113
+ {
1114
+ "description": "(React: onError) This event is dispatched when animation loading failed",
1115
+ "name": "error",
1116
+ "reactName": "onError"
1117
+ }
1118
+ ],
1119
+ "attributes": [
1120
+ {
1121
+ "name": "name",
1122
+ "type": {
1123
+ "text": "AnimationNames | undefined"
1124
+ },
1125
+ "description": "Name of the animation (= filename)",
1126
+ "fieldName": "name"
1127
+ },
1128
+ {
1129
+ "name": "loop",
1130
+ "type": {
1131
+ "text": "LoopType | undefined"
1132
+ },
1133
+ "description": "How many times to loop the animation\n- \"true\" - infinite\n- \"false\" - no loop\n- number - number of times to loop",
1134
+ "fieldName": "loop"
1135
+ },
1136
+ {
1137
+ "name": "autoplay",
1138
+ "type": {
1139
+ "text": "boolean | undefined"
1140
+ },
1141
+ "description": "Weather start the animation automatically",
1142
+ "fieldName": "autoplay"
1143
+ },
1144
+ {
1145
+ "name": "aria-label",
1146
+ "type": {
1147
+ "text": "string | null"
1148
+ },
1149
+ "default": "null",
1150
+ "description": "Aria-label attribute to be set for accessibility",
1151
+ "fieldName": "ariaLabel"
1152
+ },
1153
+ {
1154
+ "name": "aria-labelledby",
1155
+ "type": {
1156
+ "text": "string | null"
1157
+ },
1158
+ "default": "null",
1159
+ "description": "Aria-labelledby attribute to be set for accessibility",
1160
+ "fieldName": "ariaLabelledBy"
1161
+ }
1162
+ ],
1163
+ "superclass": {
1164
+ "name": "Component",
1165
+ "module": "/src/models"
1166
+ },
1167
+ "tagName": "mdc-animation",
1168
+ "jsDoc": "/**\n * The `mdc-animation` component is a wrapper around the Lottie animation library.\n * It fetches the animation data dynamically based on the provided name and renders it.\n * This is a display only component that does not have any interactive functionality.\n * From accessibility perspective, (by default) it is a decorative image component.\n *\n * @tagname mdc-animation\n *\n * @event load - (React: onLoad) This event is dispatched when the animation is loaded\n * @event complete - (React: onComplete) This event is dispatched when all animation loops completed\n * @event error - (React: onError) This event is dispatched when animation loading failed\n */",
1169
+ "customElement": true
1170
+ }
1171
+ ],
1172
+ "exports": [
1173
+ {
1174
+ "kind": "js",
1175
+ "name": "default",
1176
+ "declaration": {
1177
+ "name": "Animation",
1178
+ "module": "components/animation/animation.component.js"
1179
+ }
1180
+ }
1181
+ ]
1182
+ },
971
1183
  {
972
1184
  "kind": "javascript-module",
973
1185
  "path": "components/alertchip/alertchip.component.js",
@@ -1504,236 +1716,24 @@
1504
1716
  },
1505
1717
  {
1506
1718
  "kind": "javascript-module",
1507
- "path": "components/animation/animation.component.js",
1719
+ "path": "components/appheader/appheader.component.js",
1508
1720
  "declarations": [
1509
1721
  {
1510
1722
  "kind": "class",
1511
- "description": "The `mdc-animation` component is a wrapper around the Lottie animation library.\nIt fetches the animation data dynamically based on the provided name and renders it.\nThis is a display only component that does not have any interactive functionality.\nFrom accessibility perspective, (by default) it is a decorative image component.",
1512
- "name": "Animation",
1513
- "members": [
1723
+ "description": "The `mdc-appheader` component provides a structured and accessible app header layout.\nIt consists of three primary sections: leading, center, and trailing.\n\n- The **leading section** typically holds a **brand logo**, **brand name** or **menu icon**.\n- The **center section** can contain a **search bar**, **icons** or action controls.\n- The **trailing section** generally includes a **profile avatar**, **additional icons** or **action controls**.",
1724
+ "name": "Appheader",
1725
+ "cssParts": [
1514
1726
  {
1515
- "kind": "field",
1516
- "name": "name",
1517
- "type": {
1518
- "text": "AnimationNames | undefined"
1519
- },
1520
- "description": "Name of the animation (= filename)",
1521
- "attribute": "name",
1522
- "reflects": true
1727
+ "description": "The main container for styling the header.",
1728
+ "name": "container"
1523
1729
  },
1524
1730
  {
1525
- "kind": "field",
1526
- "name": "loop",
1527
- "type": {
1528
- "text": "LoopType | undefined"
1529
- },
1530
- "description": "How many times to loop the animation\n- \"true\" - infinite\n- \"false\" - no loop\n- number - number of times to loop",
1531
- "attribute": "loop",
1532
- "reflects": true
1731
+ "description": "The leading section of the header.",
1732
+ "name": "leading-section"
1533
1733
  },
1534
1734
  {
1535
- "kind": "field",
1536
- "name": "autoplay",
1537
- "type": {
1538
- "text": "boolean | undefined"
1539
- },
1540
- "description": "Weather start the animation automatically",
1541
- "attribute": "autoplay",
1542
- "reflects": true
1543
- },
1544
- {
1545
- "kind": "field",
1546
- "name": "ariaLabel",
1547
- "type": {
1548
- "text": "string | null"
1549
- },
1550
- "default": "null",
1551
- "description": "Aria-label attribute to be set for accessibility",
1552
- "attribute": "aria-label"
1553
- },
1554
- {
1555
- "kind": "field",
1556
- "name": "ariaLabelledBy",
1557
- "type": {
1558
- "text": "string | null"
1559
- },
1560
- "default": "null",
1561
- "description": "Aria-labelledby attribute to be set for accessibility",
1562
- "attribute": "aria-labelledby"
1563
- },
1564
- {
1565
- "kind": "field",
1566
- "name": "lottieInstance",
1567
- "type": {
1568
- "text": "AnimationItem | undefined"
1569
- },
1570
- "privacy": "private",
1571
- "description": "Lottie animation instance"
1572
- },
1573
- {
1574
- "kind": "field",
1575
- "name": "containerRef",
1576
- "type": {
1577
- "text": "Ref<HTMLDivElement>"
1578
- },
1579
- "privacy": "private",
1580
- "description": "Container for the animation"
1581
- },
1582
- {
1583
- "kind": "field",
1584
- "name": "animation",
1585
- "description": "Exposed API of the animation library (lottie)",
1586
- "readonly": true
1587
- },
1588
- {
1589
- "kind": "method",
1590
- "name": "getLoopValue",
1591
- "privacy": "private"
1592
- },
1593
- {
1594
- "kind": "method",
1595
- "name": "onLoadSuccessHandler",
1596
- "privacy": "private",
1597
- "parameters": [
1598
- {
1599
- "name": "animationData",
1600
- "type": {
1601
- "text": "any"
1602
- }
1603
- }
1604
- ],
1605
- "description": "Create new lotty instance for the loaded data"
1606
- },
1607
- {
1608
- "kind": "method",
1609
- "name": "onLoadFailHandler",
1610
- "privacy": "private",
1611
- "parameters": [
1612
- {
1613
- "name": "error",
1614
- "type": {
1615
- "text": "Error"
1616
- }
1617
- }
1618
- ],
1619
- "description": "Error handler for animation loading"
1620
- },
1621
- {
1622
- "kind": "method",
1623
- "name": "getAnimationData",
1624
- "privacy": "private",
1625
- "description": "Import animation data dynamically"
1626
- },
1627
- {
1628
- "kind": "field",
1629
- "name": "onCompleteHandler",
1630
- "description": "Re-dispatch the complete event from the animation library\n\nThis handler called with the animation instance instead of the component instance\nso we need to bind it to the component instance. The arrow function just does that."
1631
- }
1632
- ],
1633
- "events": [
1634
- {
1635
- "name": "load",
1636
- "type": {
1637
- "text": "CustomEvent"
1638
- },
1639
- "description": "(React: onLoad) This event is dispatched when the animation is loaded",
1640
- "reactName": "onLoad"
1641
- },
1642
- {
1643
- "description": "(React: onComplete) This event is dispatched when all animation loops completed",
1644
- "name": "complete",
1645
- "reactName": "onComplete"
1646
- },
1647
- {
1648
- "description": "(React: onError) This event is dispatched when animation loading failed",
1649
- "name": "error",
1650
- "reactName": "onError"
1651
- }
1652
- ],
1653
- "attributes": [
1654
- {
1655
- "name": "name",
1656
- "type": {
1657
- "text": "AnimationNames | undefined"
1658
- },
1659
- "description": "Name of the animation (= filename)",
1660
- "fieldName": "name"
1661
- },
1662
- {
1663
- "name": "loop",
1664
- "type": {
1665
- "text": "LoopType | undefined"
1666
- },
1667
- "description": "How many times to loop the animation\n- \"true\" - infinite\n- \"false\" - no loop\n- number - number of times to loop",
1668
- "fieldName": "loop"
1669
- },
1670
- {
1671
- "name": "autoplay",
1672
- "type": {
1673
- "text": "boolean | undefined"
1674
- },
1675
- "description": "Weather start the animation automatically",
1676
- "fieldName": "autoplay"
1677
- },
1678
- {
1679
- "name": "aria-label",
1680
- "type": {
1681
- "text": "string | null"
1682
- },
1683
- "default": "null",
1684
- "description": "Aria-label attribute to be set for accessibility",
1685
- "fieldName": "ariaLabel"
1686
- },
1687
- {
1688
- "name": "aria-labelledby",
1689
- "type": {
1690
- "text": "string | null"
1691
- },
1692
- "default": "null",
1693
- "description": "Aria-labelledby attribute to be set for accessibility",
1694
- "fieldName": "ariaLabelledBy"
1695
- }
1696
- ],
1697
- "superclass": {
1698
- "name": "Component",
1699
- "module": "/src/models"
1700
- },
1701
- "tagName": "mdc-animation",
1702
- "jsDoc": "/**\n * The `mdc-animation` component is a wrapper around the Lottie animation library.\n * It fetches the animation data dynamically based on the provided name and renders it.\n * This is a display only component that does not have any interactive functionality.\n * From accessibility perspective, (by default) it is a decorative image component.\n *\n * @tagname mdc-animation\n *\n * @event load - (React: onLoad) This event is dispatched when the animation is loaded\n * @event complete - (React: onComplete) This event is dispatched when all animation loops completed\n * @event error - (React: onError) This event is dispatched when animation loading failed\n */",
1703
- "customElement": true
1704
- }
1705
- ],
1706
- "exports": [
1707
- {
1708
- "kind": "js",
1709
- "name": "default",
1710
- "declaration": {
1711
- "name": "Animation",
1712
- "module": "components/animation/animation.component.js"
1713
- }
1714
- }
1715
- ]
1716
- },
1717
- {
1718
- "kind": "javascript-module",
1719
- "path": "components/appheader/appheader.component.js",
1720
- "declarations": [
1721
- {
1722
- "kind": "class",
1723
- "description": "The `mdc-appheader` component provides a structured and accessible app header layout.\nIt consists of three primary sections: leading, center, and trailing.\n\n- The **leading section** typically holds a **brand logo**, **brand name** or **menu icon**.\n- The **center section** can contain a **search bar**, **icons** or action controls.\n- The **trailing section** generally includes a **profile avatar**, **additional icons** or **action controls**.",
1724
- "name": "Appheader",
1725
- "cssParts": [
1726
- {
1727
- "description": "The main container for styling the header.",
1728
- "name": "container"
1729
- },
1730
- {
1731
- "description": "The leading section of the header.",
1732
- "name": "leading-section"
1733
- },
1734
- {
1735
- "description": "The center section of the header.",
1736
- "name": "center-section"
1735
+ "description": "The center section of the header.",
1736
+ "name": "center-section"
1737
1737
  },
1738
1738
  {
1739
1739
  "description": "The trailing section of the header.",
@@ -7071,175 +7071,35 @@
7071
7071
  },
7072
7072
  {
7073
7073
  "kind": "javascript-module",
7074
- "path": "components/cardradio/cardradio.component.js",
7074
+ "path": "components/checkbox/checkbox.component.js",
7075
7075
  "declarations": [
7076
7076
  {
7077
7077
  "kind": "class",
7078
- "description": "cardradio component extends `mdc-card` and supports radio selection interaction addtionally.\n\nWhile using this component within a form or group of cards, make sure cards are in a role = \"radio-group\".\nThis card would have events for selected and unselected (similar to radio)\n\n**Note**: This is a single selection card i.e. interacting anywhere on the card would toggle the checked state.\nMake sure to pass only non-interactable elements within the slots.\n\nMake sure to pass the `card-title` mandatorily for this card.",
7079
- "name": "CardRadio",
7078
+ "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.",
7079
+ "name": "Checkbox",
7080
7080
  "cssProperties": [
7081
7081
  {
7082
- "description": "The width of the card",
7083
- "name": "--mdc-card-width",
7084
- "inheritedFrom": {
7085
- "name": "Card",
7086
- "module": "src/components/card/card.component.ts"
7087
- }
7088
- }
7089
- ],
7090
- "cssParts": [
7091
- {
7092
- "description": "The header part of the card",
7093
- "name": "header",
7094
- "inheritedFrom": {
7095
- "name": "Card",
7096
- "module": "src/components/card/card.component.ts"
7097
- }
7098
- },
7099
- {
7100
- "description": "The icon part of the card header",
7101
- "name": "icon",
7102
- "inheritedFrom": {
7103
- "name": "Card",
7104
- "module": "src/components/card/card.component.ts"
7105
- }
7082
+ "description": "Allows customization of the background color on hover.",
7083
+ "name": "--mdc-checkbox-background-color-hover"
7106
7084
  },
7107
7085
  {
7108
- "description": "The body part of the card",
7109
- "name": "body",
7110
- "inheritedFrom": {
7111
- "name": "Card",
7112
- "module": "src/components/card/card.component.ts"
7113
- }
7086
+ "description": "Background color for a selected checkbox when hovered.",
7087
+ "name": "--mdc-checkbox-checked-background-color-hover"
7114
7088
  },
7115
7089
  {
7116
- "description": "The image part of the card",
7117
- "name": "image",
7118
- "inheritedFrom": {
7119
- "name": "Card",
7120
- "module": "src/components/card/card.component.ts"
7121
- }
7090
+ "description": "Background color for a selected checkbox when pressed.",
7091
+ "name": "--mdc-checkbox-checked-pressed-icon-color"
7122
7092
  },
7123
7093
  {
7124
- "description": "The footer part of the card",
7125
- "name": "footer",
7126
- "inheritedFrom": {
7127
- "name": "Card",
7128
- "module": "src/components/card/card.component.ts"
7129
- }
7094
+ "description": "Background color for a selected checkbox when pressed.",
7095
+ "name": "--mdc-checkbox-pressed-icon-color"
7130
7096
  },
7131
7097
  {
7132
- "description": "The link part of the card footer",
7133
- "name": "footer-link",
7134
- "inheritedFrom": {
7135
- "name": "Card",
7136
- "module": "src/components/card/card.component.ts"
7137
- }
7138
- },
7139
- {
7140
- "description": "The primary button part of the card footer",
7141
- "name": "footer-button-primary",
7142
- "inheritedFrom": {
7143
- "name": "Card",
7144
- "module": "src/components/card/card.component.ts"
7145
- }
7146
- },
7147
- {
7148
- "description": "The secondary button part of the card footer",
7149
- "name": "footer-button-secondary",
7150
- "inheritedFrom": {
7151
- "name": "Card",
7152
- "module": "src/components/card/card.component.ts"
7153
- }
7154
- },
7155
- {
7156
- "description": "The icon button part of the card header",
7157
- "name": "icon-button",
7158
- "inheritedFrom": {
7159
- "name": "Card",
7160
- "module": "src/components/card/card.component.ts"
7161
- }
7162
- },
7163
- {
7164
- "description": "The text part of the card",
7165
- "name": "text",
7166
- "inheritedFrom": {
7167
- "name": "Card",
7168
- "module": "src/components/card/card.component.ts"
7169
- }
7170
- },
7171
- {
7172
- "description": "The check part of the card",
7173
- "name": "check"
7174
- },
7175
- {
7176
- "description": "The check icon part of the card",
7177
- "name": "check-icon"
7178
- },
7179
- {
7180
- "description": "The check icon button part of the card",
7181
- "name": "check-icon-button"
7182
- }
7183
- ],
7184
- "slots": [
7185
- {
7186
- "description": "This slot is for passing the content before the body",
7187
- "name": "before-body",
7188
- "inheritedFrom": {
7189
- "name": "Card",
7190
- "module": "src/components/card/card.component.ts"
7191
- }
7192
- },
7193
- {
7194
- "description": "This slot is for passing the text content for the card",
7195
- "name": "body",
7196
- "inheritedFrom": {
7197
- "name": "Card",
7198
- "module": "src/components/card/card.component.ts"
7199
- }
7200
- },
7201
- {
7202
- "description": "This slot is for passing the content after the body",
7203
- "name": "after-body",
7204
- "inheritedFrom": {
7205
- "name": "Card",
7206
- "module": "src/components/card/card.component.ts"
7207
- }
7208
- },
7209
- {
7210
- "description": "This slot is for passing `mdc-link` component within the footer section.",
7211
- "name": "footer-link",
7212
- "inheritedFrom": {
7213
- "name": "Card",
7214
- "module": "src/components/card/card.component.ts"
7215
- }
7216
- },
7217
- {
7218
- "description": "This slot is for passing primary variant of `mdc-button` component within the footer section.",
7219
- "name": "footer-button-primary",
7220
- "inheritedFrom": {
7221
- "name": "Card",
7222
- "module": "src/components/card/card.component.ts"
7223
- }
7224
- },
7225
- {
7226
- "description": "This slot is for passing secondary variant of `mdc-button` component within the footer section.",
7227
- "name": "footer-button-secondary",
7228
- "inheritedFrom": {
7229
- "name": "Card",
7230
- "module": "src/components/card/card.component.ts"
7231
- }
7232
- },
7233
- {
7234
- "description": " This slot is for passing custom footer content. Only use this if really needed, using the footer-link and footer-button slots is preferred.",
7235
- "name": "footer",
7236
- "inheritedFrom": {
7237
- "name": "Card",
7238
- "module": "src/components/card/card.component.ts"
7239
- }
7240
- }
7241
- ],
7242
- "members": [
7098
+ "description": "Background color for a selected checkbox when disabled.",
7099
+ "name": "--mdc-checkbox-disabled-checked-icon-color"
7100
+ }
7101
+ ],
7102
+ "members": [
7243
7103
  {
7244
7104
  "kind": "field",
7245
7105
  "name": "checked",
@@ -7247,376 +7107,432 @@
7247
7107
  "text": "boolean"
7248
7108
  },
7249
7109
  "default": "false",
7250
- "description": "The checked state of the card",
7110
+ "description": "Determines whether the checkbox is selected or unselected.",
7251
7111
  "attribute": "checked",
7252
7112
  "reflects": true
7253
7113
  },
7254
7114
  {
7255
7115
  "kind": "field",
7256
- "name": "name",
7116
+ "name": "indeterminate",
7257
7117
  "type": {
7258
- "text": "string"
7118
+ "text": "boolean"
7259
7119
  },
7260
- "default": "''",
7261
- "description": "The name of the radio.",
7262
- "attribute": "name"
7120
+ "default": "false",
7121
+ "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.",
7122
+ "attribute": "indeterminate",
7123
+ "reflects": true
7124
+ },
7125
+ {
7126
+ "kind": "field",
7127
+ "name": "autofocus",
7128
+ "type": {
7129
+ "text": "boolean"
7130
+ },
7131
+ "default": "false",
7132
+ "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)",
7133
+ "attribute": "autofocus",
7134
+ "reflects": true
7263
7135
  },
7264
7136
  {
7265
7137
  "kind": "method",
7266
- "name": "getAllCardsWithinSameGroup",
7138
+ "name": "setFormValue",
7267
7139
  "privacy": "private",
7268
- "return": {
7269
- "type": {
7270
- "text": "CardRadio[]"
7271
- }
7272
- },
7273
- "description": "Returns all cards within the same group (name)."
7140
+ "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."
7274
7141
  },
7275
7142
  {
7276
7143
  "kind": "method",
7277
- "name": "toggleChecked",
7144
+ "name": "manageRequired",
7278
7145
  "privacy": "private",
7279
- "return": {
7280
- "type": {
7281
- "text": "void"
7282
- }
7283
- },
7284
- "description": "Handles the change event on the radio element.\nThis will toggle the state of the radio element.\nDispatches the change event."
7146
+ "description": "Manages the required state of the checkbox.\nIf the checkbox is not checked and the required property is set, then the checkbox is invalid."
7285
7147
  },
7286
7148
  {
7287
7149
  "kind": "method",
7288
- "name": "setDisabled",
7150
+ "name": "toggleState",
7151
+ "privacy": "private",
7289
7152
  "return": {
7290
7153
  "type": {
7291
7154
  "text": "void"
7292
7155
  }
7293
7156
  },
7294
- "parameters": [
7295
- {
7296
- "name": "disabled",
7297
- "type": {
7298
- "text": "boolean"
7299
- }
7300
- }
7301
- ]
7157
+ "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."
7302
7158
  },
7303
7159
  {
7304
7160
  "kind": "method",
7305
- "name": "updateCardRadio",
7161
+ "name": "handleKeyDown",
7306
7162
  "privacy": "private",
7307
7163
  "return": {
7308
7164
  "type": {
7309
7165
  "text": "void"
7310
7166
  }
7311
7167
  },
7312
- "parameters": [
7313
- {
7314
- "name": "cards",
7315
- "type": {
7316
- "text": "CardRadio[]"
7317
- }
7318
- },
7319
- {
7320
- "name": "index",
7321
- "type": {
7322
- "text": "number"
7323
- }
7324
- }
7325
- ]
7326
- },
7327
- {
7328
- "kind": "method",
7329
- "name": "toggleOnEnter",
7330
- "privacy": "private",
7331
7168
  "parameters": [
7332
7169
  {
7333
7170
  "name": "event",
7334
7171
  "type": {
7335
7172
  "text": "KeyboardEvent"
7336
7173
  },
7337
- "description": "The keyboard event"
7174
+ "description": "The keyboard event."
7338
7175
  }
7339
7176
  ],
7340
- "description": "Toggles the checked state when enter key is used"
7177
+ "description": "Handles the keydown event on the checkbox.\nWhen the user presses Enter, the form is submitted."
7341
7178
  },
7342
7179
  {
7343
7180
  "kind": "method",
7344
- "name": "toggleOnSpace",
7345
- "privacy": "private",
7181
+ "name": "handleChange",
7182
+ "privacy": "public",
7183
+ "return": {
7184
+ "type": {
7185
+ "text": "void"
7186
+ }
7187
+ },
7346
7188
  "parameters": [
7347
7189
  {
7348
7190
  "name": "event",
7349
7191
  "type": {
7350
- "text": "KeyboardEvent"
7351
- },
7352
- "description": "The keyboard event"
7192
+ "text": "Event"
7193
+ }
7353
7194
  }
7354
7195
  ],
7355
- "description": "Toggles the checked state when space key is used"
7196
+ "description": "Toggles the state of the checkbox element.\nand dispatch the new change event."
7356
7197
  },
7357
7198
  {
7358
- "kind": "method",
7359
- "name": "renderHeader",
7360
- "privacy": "protected",
7361
- "description": "Renders the header of the card",
7362
- "return": {
7363
- "type": {
7364
- "text": ""
7365
- }
7366
- },
7367
- "inheritedFrom": {
7368
- "name": "Card",
7369
- "module": "components/card/card.component.js"
7370
- }
7199
+ "kind": "field",
7200
+ "name": "renderLabelAndHelperText",
7201
+ "privacy": "private"
7371
7202
  },
7372
7203
  {
7373
7204
  "kind": "field",
7374
- "name": "disabled",
7205
+ "name": "name",
7375
7206
  "type": {
7376
- "text": "boolean | undefined"
7207
+ "text": "string"
7377
7208
  },
7378
- "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
7379
- "default": "undefined",
7380
- "attribute": "disabled",
7209
+ "default": "''",
7210
+ "description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
7211
+ "attribute": "name",
7381
7212
  "reflects": true,
7382
7213
  "inheritedFrom": {
7383
- "name": "DisabledMixin",
7384
- "module": "utils/mixins/DisabledMixin.js"
7214
+ "name": "FormInternalsMixin",
7215
+ "module": "utils/mixins/FormInternalsMixin.js"
7385
7216
  }
7386
7217
  },
7387
7218
  {
7388
7219
  "kind": "field",
7389
- "name": "tabIndex",
7220
+ "name": "value",
7390
7221
  "type": {
7391
- "text": "number"
7222
+ "text": "string"
7392
7223
  },
7393
- "default": "0",
7394
- "description": "This property specifies the tab order of the element.",
7395
- "attribute": "tabIndex",
7224
+ "default": "''",
7225
+ "description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
7226
+ "attribute": "value",
7396
7227
  "reflects": true,
7397
7228
  "inheritedFrom": {
7398
- "name": "TabIndexMixin",
7399
- "module": "utils/mixins/TabIndexMixin.js"
7229
+ "name": "FormInternalsMixin",
7230
+ "module": "utils/mixins/FormInternalsMixin.js"
7400
7231
  }
7401
7232
  },
7402
7233
  {
7403
7234
  "kind": "field",
7404
- "name": "cardTitle",
7235
+ "name": "validationMessage",
7405
7236
  "type": {
7406
- "text": "string"
7237
+ "text": "string | undefined"
7407
7238
  },
7408
- "default": "''",
7409
- "description": "The title of the card - part of header section",
7410
- "attribute": "card-title",
7239
+ "description": "Custom validation message that will override the default message and displayed when the input is invalid.\n\nTo display custom validation messages, you must listen for input events (or other relevant events)\non your component and update the `validationMessage` property with the desired message string.\nUpdating this property will ensure that new validation messages are shown to the user.\n- The `validationMessage` property overrides the default browser validation message when set.\n- Consumers are responsible for updating `validationMessage` in response to input or validation state changes.",
7240
+ "attribute": "validation-message",
7411
7241
  "reflects": true,
7412
7242
  "inheritedFrom": {
7413
- "name": "Card",
7414
- "module": "components/card/card.component.js"
7243
+ "name": "FormInternalsMixin",
7244
+ "module": "utils/mixins/FormInternalsMixin.js"
7415
7245
  }
7416
7246
  },
7417
7247
  {
7418
7248
  "kind": "field",
7419
- "name": "subtitle",
7249
+ "name": "validity",
7420
7250
  "type": {
7421
- "text": "string"
7251
+ "text": "ValidityState"
7422
7252
  },
7423
- "default": "''",
7424
- "description": "The subtitle of the card - part of header section",
7425
- "attribute": "subtitle",
7253
+ "readonly": true,
7254
+ "inheritedFrom": {
7255
+ "name": "FormInternalsMixin",
7256
+ "module": "utils/mixins/FormInternalsMixin.js"
7257
+ }
7258
+ },
7259
+ {
7260
+ "kind": "field",
7261
+ "name": "willValidate",
7262
+ "readonly": true,
7263
+ "inheritedFrom": {
7264
+ "name": "FormInternalsMixin",
7265
+ "module": "utils/mixins/FormInternalsMixin.js"
7266
+ }
7267
+ },
7268
+ {
7269
+ "kind": "method",
7270
+ "name": "setValidity",
7271
+ "description": "Sets the validity of the input field based on the input field's validity.",
7272
+ "return": {
7273
+ "type": {
7274
+ "text": ""
7275
+ }
7276
+ },
7277
+ "inheritedFrom": {
7278
+ "name": "FormInternalsMixin",
7279
+ "module": "utils/mixins/FormInternalsMixin.js"
7280
+ }
7281
+ },
7282
+ {
7283
+ "kind": "method",
7284
+ "name": "checkValidity",
7285
+ "return": {
7286
+ "type": {
7287
+ "text": "boolean"
7288
+ }
7289
+ },
7290
+ "inheritedFrom": {
7291
+ "name": "FormInternalsMixin",
7292
+ "module": "utils/mixins/FormInternalsMixin.js"
7293
+ }
7294
+ },
7295
+ {
7296
+ "kind": "method",
7297
+ "name": "reportValidity",
7298
+ "inheritedFrom": {
7299
+ "name": "FormInternalsMixin",
7300
+ "module": "utils/mixins/FormInternalsMixin.js"
7301
+ }
7302
+ },
7303
+ {
7304
+ "kind": "field",
7305
+ "name": "dataAriaLabel",
7306
+ "type": {
7307
+ "text": "string | null"
7308
+ },
7309
+ "default": "null",
7310
+ "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
7311
+ "attribute": "data-aria-label",
7426
7312
  "reflects": true,
7427
7313
  "inheritedFrom": {
7428
- "name": "Card",
7429
- "module": "components/card/card.component.js"
7314
+ "name": "DataAriaLabelMixin",
7315
+ "module": "utils/mixins/DataAriaLabelMixin.js"
7430
7316
  }
7431
7317
  },
7432
7318
  {
7433
7319
  "kind": "field",
7434
- "name": "imageSrc",
7320
+ "name": "disabled",
7435
7321
  "type": {
7436
- "text": "string"
7322
+ "text": "boolean | undefined"
7437
7323
  },
7438
- "default": "''",
7439
- "description": "The image source URL to render on the card",
7440
- "attribute": "image-src",
7324
+ "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
7325
+ "default": "undefined",
7326
+ "attribute": "disabled",
7441
7327
  "reflects": true,
7442
7328
  "inheritedFrom": {
7443
- "name": "Card",
7444
- "module": "components/card/card.component.js"
7329
+ "name": "DisabledMixin",
7330
+ "module": "utils/mixins/DisabledMixin.js"
7445
7331
  }
7446
7332
  },
7447
7333
  {
7448
7334
  "kind": "field",
7449
- "name": "imageAlt",
7335
+ "name": "label",
7336
+ "type": {
7337
+ "text": "string | undefined"
7338
+ },
7339
+ "description": "The label of the input field. It is linked to the input field using the `for` attribute.",
7340
+ "attribute": "label",
7341
+ "reflects": true,
7342
+ "inheritedFrom": {
7343
+ "name": "FormfieldWrapper",
7344
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
7345
+ }
7346
+ },
7347
+ {
7348
+ "kind": "field",
7349
+ "name": "required",
7350
+ "type": {
7351
+ "text": "boolean"
7352
+ },
7353
+ "default": "false",
7354
+ "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
7355
+ "attribute": "required",
7356
+ "reflects": true,
7357
+ "inheritedFrom": {
7358
+ "name": "FormfieldWrapper",
7359
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
7360
+ }
7361
+ },
7362
+ {
7363
+ "kind": "field",
7364
+ "name": "id",
7450
7365
  "type": {
7451
7366
  "text": "string"
7452
7367
  },
7453
7368
  "default": "''",
7454
- "description": "The image alt for accessibility support",
7455
- "attribute": "image-alt",
7456
- "reflects": true,
7369
+ "description": "The unique id of the input field. It is used to link the input field with the label.",
7370
+ "attribute": "id",
7457
7371
  "inheritedFrom": {
7458
- "name": "Card",
7459
- "module": "components/card/card.component.js"
7372
+ "name": "FormfieldWrapper",
7373
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
7460
7374
  }
7461
7375
  },
7462
7376
  {
7463
7377
  "kind": "field",
7464
- "name": "variant",
7378
+ "name": "helpTextType",
7465
7379
  "type": {
7466
- "text": "CardVariant"
7380
+ "text": "ValidationType"
7467
7381
  },
7468
- "description": "The variant of the card. It can either be set to 'border' or 'ghost'",
7469
- "default": "'border'",
7470
- "attribute": "variant",
7382
+ "description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
7383
+ "attribute": "help-text-type",
7471
7384
  "reflects": true,
7472
7385
  "inheritedFrom": {
7473
- "name": "Card",
7474
- "module": "components/card/card.component.js"
7386
+ "name": "FormfieldWrapper",
7387
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
7475
7388
  }
7476
7389
  },
7477
7390
  {
7478
7391
  "kind": "field",
7479
- "name": "orientation",
7392
+ "name": "helpText",
7480
7393
  "type": {
7481
- "text": "CardOrientation"
7394
+ "text": "string | undefined"
7482
7395
  },
7483
- "description": "The orientation of the card. It can either be set to 'vertical' or 'horizontal'",
7484
- "default": "'vertical'",
7485
- "attribute": "orientation",
7396
+ "description": "The help text that is displayed below the input field.",
7397
+ "attribute": "help-text",
7486
7398
  "reflects": true,
7487
7399
  "inheritedFrom": {
7488
- "name": "Card",
7489
- "module": "components/card/card.component.js"
7400
+ "name": "FormfieldWrapper",
7401
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
7490
7402
  }
7491
7403
  },
7492
7404
  {
7493
7405
  "kind": "field",
7494
- "name": "titleTagName",
7406
+ "name": "toggletipText",
7495
7407
  "type": {
7496
- "text": "TagNameType"
7408
+ "text": "string | undefined"
7497
7409
  },
7498
- "description": "The tag name for the card title. It supports all the types that `mdc-text` supports",
7499
- "default": "'span'",
7500
- "attribute": "title-tag-name",
7410
+ "description": "The toggletip text that is displayed when the label is hovered.\nIt is used to provide additional information about the label.",
7411
+ "attribute": "toggletip-text",
7501
7412
  "reflects": true,
7502
7413
  "inheritedFrom": {
7503
- "name": "Card",
7504
- "module": "components/card/card.component.js"
7414
+ "name": "FormfieldWrapper",
7415
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
7505
7416
  }
7506
7417
  },
7507
7418
  {
7508
7419
  "kind": "field",
7509
- "name": "subtitleTagName",
7420
+ "name": "toggletipPlacement",
7510
7421
  "type": {
7511
- "text": "TagNameType"
7422
+ "text": "PopoverPlacement"
7512
7423
  },
7513
- "description": "The tag name for the subtitle. It supports all the types that `mdc-text` supports",
7514
- "default": "'span'",
7515
- "attribute": "subtitle-tag-name",
7424
+ "description": "The placement of the toggletip that is displayed when the info icon is hovered.",
7425
+ "default": "'top'",
7426
+ "attribute": "toggletip-placement",
7516
7427
  "reflects": true,
7517
7428
  "inheritedFrom": {
7518
- "name": "Card",
7519
- "module": "components/card/card.component.js"
7429
+ "name": "FormfieldWrapper",
7430
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
7520
7431
  }
7521
7432
  },
7522
7433
  {
7523
7434
  "kind": "field",
7524
- "name": "iconName",
7435
+ "name": "infoIconAriaLabel",
7525
7436
  "type": {
7526
- "text": "IconNames | undefined"
7437
+ "text": "string | undefined"
7527
7438
  },
7528
- "description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
7529
- "attribute": "icon-name",
7439
+ "description": "Aria label for the info icon that is displayed next to the label when `toggletipText` is set.\nThis is used for accessibility purposes to provide a description of the icon.",
7440
+ "attribute": "info-icon-aria-label",
7530
7441
  "reflects": true,
7531
7442
  "inheritedFrom": {
7532
- "name": "Card",
7533
- "module": "components/card/card.component.js"
7443
+ "name": "FormfieldWrapper",
7444
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
7534
7445
  }
7535
7446
  },
7536
7447
  {
7537
7448
  "kind": "method",
7538
- "name": "renderImage",
7449
+ "name": "renderLabelElement",
7539
7450
  "privacy": "protected",
7540
- "description": "Renders the image on the card if image source is provided",
7451
+ "description": "creates the label element when the label property is set.\nid is used to link the label with the input field.",
7541
7452
  "return": {
7542
7453
  "type": {
7543
7454
  "text": ""
7544
7455
  }
7545
7456
  },
7546
7457
  "inheritedFrom": {
7547
- "name": "Card",
7548
- "module": "components/card/card.component.js"
7458
+ "name": "FormfieldWrapper",
7459
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
7549
7460
  }
7550
7461
  },
7551
7462
  {
7552
7463
  "kind": "method",
7553
- "name": "renderIcon",
7464
+ "name": "renderHelpTextIcon",
7554
7465
  "privacy": "protected",
7555
- "description": "Renders the icon on the card if icon name is provided",
7466
+ "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.",
7556
7467
  "return": {
7557
7468
  "type": {
7558
7469
  "text": ""
7559
7470
  }
7560
7471
  },
7561
7472
  "inheritedFrom": {
7562
- "name": "Card",
7563
- "module": "components/card/card.component.js"
7473
+ "name": "FormfieldWrapper",
7474
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
7564
7475
  }
7565
7476
  },
7566
7477
  {
7567
7478
  "kind": "method",
7568
- "name": "renderTitle",
7479
+ "name": "renderHelpText",
7569
7480
  "privacy": "protected",
7570
- "description": "Renders the title and subtitle on the card",
7481
+ "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.",
7571
7482
  "return": {
7572
7483
  "type": {
7573
7484
  "text": ""
7574
7485
  }
7575
7486
  },
7576
7487
  "inheritedFrom": {
7577
- "name": "Card",
7578
- "module": "components/card/card.component.js"
7488
+ "name": "FormfieldWrapper",
7489
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
7579
7490
  }
7580
7491
  },
7581
7492
  {
7582
7493
  "kind": "method",
7583
- "name": "renderFooter",
7494
+ "name": "renderLabel",
7584
7495
  "privacy": "protected",
7585
- "description": "Renders the footer of the card if footer-link,\nfooter-button-primary, or footer-button-secondary slots are provided",
7496
+ "description": "renders the mdc-label-text container that contains the label and labelInfoToggleTip.",
7586
7497
  "return": {
7587
7498
  "type": {
7588
7499
  "text": ""
7589
7500
  }
7590
7501
  },
7591
7502
  "inheritedFrom": {
7592
- "name": "Card",
7593
- "module": "components/card/card.component.js"
7503
+ "name": "FormfieldWrapper",
7504
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
7505
+ }
7506
+ },
7507
+ {
7508
+ "kind": "method",
7509
+ "name": "renderHelperText",
7510
+ "privacy": "protected",
7511
+ "description": "renders the mdc-help-text container that contains the helpertext icon and helpertext.",
7512
+ "return": {
7513
+ "type": {
7514
+ "text": ""
7515
+ }
7516
+ },
7517
+ "inheritedFrom": {
7518
+ "name": "FormfieldWrapper",
7519
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
7594
7520
  }
7595
7521
  }
7596
7522
  ],
7597
7523
  "events": [
7598
7524
  {
7599
- "description": "(React: onClick) Event that gets dispatched when the card is clicked. It toggles the checked state.",
7600
- "name": "click",
7601
- "reactName": "onClick"
7602
- },
7603
- {
7604
- "description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the card. It toggles the checked state when enter key is used.",
7605
- "name": "keydown",
7606
- "reactName": "onKeyDown"
7607
- },
7608
- {
7609
- "description": "(React: onKeyUp) This event is dispatched when a key is released on the card. It toggles the checked state when space key is used.",
7610
- "name": "keyup",
7611
- "reactName": "onKeyUp"
7525
+ "type": {
7526
+ "text": "EventConstructor"
7527
+ }
7612
7528
  },
7613
7529
  {
7614
- "description": "(React: onChange) Event that gets dispatched when the card state changes.",
7530
+ "description": "(React: onChange) Event that gets dispatched when the checkbox state changes.",
7615
7531
  "name": "change",
7616
7532
  "reactName": "onChange"
7617
7533
  },
7618
7534
  {
7619
- "description": "(React: onFocus) Event that gets dispatched when the card receives focus.",
7535
+ "description": "(React: onFocus) Event that gets dispatched when the checkbox receives focus.",
7620
7536
  "name": "focus",
7621
7537
  "reactName": "onFocus"
7622
7538
  }
@@ -7628,177 +7544,207 @@
7628
7544
  "text": "boolean"
7629
7545
  },
7630
7546
  "default": "false",
7631
- "description": "The checked state of the card",
7547
+ "description": "Determines whether the checkbox is selected or unselected.",
7632
7548
  "fieldName": "checked"
7633
7549
  },
7550
+ {
7551
+ "name": "indeterminate",
7552
+ "type": {
7553
+ "text": "boolean"
7554
+ },
7555
+ "default": "false",
7556
+ "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.",
7557
+ "fieldName": "indeterminate"
7558
+ },
7559
+ {
7560
+ "name": "autofocus",
7561
+ "type": {
7562
+ "text": "boolean"
7563
+ },
7564
+ "default": "false",
7565
+ "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)",
7566
+ "fieldName": "autofocus"
7567
+ },
7634
7568
  {
7635
7569
  "name": "name",
7636
7570
  "type": {
7637
7571
  "text": "string"
7638
7572
  },
7639
7573
  "default": "''",
7640
- "description": "The name of the radio.",
7641
- "fieldName": "name"
7574
+ "description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
7575
+ "fieldName": "name",
7576
+ "inheritedFrom": {
7577
+ "name": "FormInternalsMixin",
7578
+ "module": "src/utils/mixins/FormInternalsMixin.ts"
7579
+ }
7642
7580
  },
7643
7581
  {
7644
- "name": "disabled",
7582
+ "name": "value",
7645
7583
  "type": {
7646
- "text": "boolean | undefined"
7584
+ "text": "string"
7647
7585
  },
7648
- "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
7649
- "default": "undefined",
7650
- "fieldName": "disabled",
7586
+ "default": "''",
7587
+ "description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
7588
+ "fieldName": "value",
7651
7589
  "inheritedFrom": {
7652
- "name": "DisabledMixin",
7653
- "module": "src/utils/mixins/DisabledMixin.ts"
7590
+ "name": "FormInternalsMixin",
7591
+ "module": "src/utils/mixins/FormInternalsMixin.ts"
7654
7592
  }
7655
7593
  },
7656
7594
  {
7657
- "name": "tabIndex",
7595
+ "name": "validation-message",
7658
7596
  "type": {
7659
- "text": "number"
7597
+ "text": "string | undefined"
7660
7598
  },
7661
- "default": "0",
7662
- "description": "This property specifies the tab order of the element.",
7663
- "fieldName": "tabIndex",
7599
+ "description": "Custom validation message that will override the default message and displayed when the input is invalid.\n\nTo display custom validation messages, you must listen for input events (or other relevant events)\non your component and update the `validationMessage` property with the desired message string.\nUpdating this property will ensure that new validation messages are shown to the user.\n- The `validationMessage` property overrides the default browser validation message when set.\n- Consumers are responsible for updating `validationMessage` in response to input or validation state changes.",
7600
+ "fieldName": "validationMessage",
7664
7601
  "inheritedFrom": {
7665
- "name": "TabIndexMixin",
7666
- "module": "src/utils/mixins/TabIndexMixin.ts"
7602
+ "name": "FormInternalsMixin",
7603
+ "module": "src/utils/mixins/FormInternalsMixin.ts"
7667
7604
  }
7668
7605
  },
7669
7606
  {
7670
- "name": "card-title",
7607
+ "name": "data-aria-label",
7671
7608
  "type": {
7672
- "text": "string"
7609
+ "text": "string | null"
7673
7610
  },
7674
- "default": "''",
7675
- "description": "The title of the card - part of header section",
7676
- "fieldName": "cardTitle",
7611
+ "default": "null",
7612
+ "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
7613
+ "fieldName": "dataAriaLabel",
7677
7614
  "inheritedFrom": {
7678
- "name": "Card",
7679
- "module": "src/components/card/card.component.ts"
7615
+ "name": "DataAriaLabelMixin",
7616
+ "module": "src/utils/mixins/DataAriaLabelMixin.ts"
7680
7617
  }
7681
7618
  },
7682
7619
  {
7683
- "name": "subtitle",
7620
+ "name": "disabled",
7684
7621
  "type": {
7685
- "text": "string"
7622
+ "text": "boolean | undefined"
7686
7623
  },
7687
- "default": "''",
7688
- "description": "The subtitle of the card - part of header section",
7689
- "fieldName": "subtitle",
7624
+ "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
7625
+ "default": "undefined",
7626
+ "fieldName": "disabled",
7690
7627
  "inheritedFrom": {
7691
- "name": "Card",
7692
- "module": "src/components/card/card.component.ts"
7628
+ "name": "DisabledMixin",
7629
+ "module": "src/utils/mixins/DisabledMixin.ts"
7693
7630
  }
7694
7631
  },
7695
7632
  {
7696
- "name": "image-src",
7633
+ "name": "label",
7697
7634
  "type": {
7698
- "text": "string"
7635
+ "text": "string | undefined"
7699
7636
  },
7700
- "default": "''",
7701
- "description": "The image source URL to render on the card",
7702
- "fieldName": "imageSrc",
7637
+ "description": "The label of the input field. It is linked to the input field using the `for` attribute.",
7638
+ "fieldName": "label",
7703
7639
  "inheritedFrom": {
7704
- "name": "Card",
7705
- "module": "src/components/card/card.component.ts"
7640
+ "name": "FormfieldWrapper",
7641
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
7706
7642
  }
7707
7643
  },
7708
7644
  {
7709
- "name": "image-alt",
7645
+ "name": "required",
7646
+ "type": {
7647
+ "text": "boolean"
7648
+ },
7649
+ "default": "false",
7650
+ "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
7651
+ "fieldName": "required",
7652
+ "inheritedFrom": {
7653
+ "name": "FormfieldWrapper",
7654
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
7655
+ }
7656
+ },
7657
+ {
7658
+ "name": "id",
7710
7659
  "type": {
7711
7660
  "text": "string"
7712
7661
  },
7713
7662
  "default": "''",
7714
- "description": "The image alt for accessibility support",
7715
- "fieldName": "imageAlt",
7663
+ "description": "The unique id of the input field. It is used to link the input field with the label.",
7664
+ "fieldName": "id",
7716
7665
  "inheritedFrom": {
7717
- "name": "Card",
7718
- "module": "src/components/card/card.component.ts"
7666
+ "name": "FormfieldWrapper",
7667
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
7719
7668
  }
7720
7669
  },
7721
7670
  {
7722
- "name": "variant",
7671
+ "name": "help-text-type",
7723
7672
  "type": {
7724
- "text": "CardVariant"
7673
+ "text": "ValidationType"
7725
7674
  },
7726
- "description": "The variant of the card. It can either be set to 'border' or 'ghost'",
7727
- "default": "'border'",
7728
- "fieldName": "variant",
7675
+ "description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
7676
+ "fieldName": "helpTextType",
7729
7677
  "inheritedFrom": {
7730
- "name": "Card",
7731
- "module": "src/components/card/card.component.ts"
7678
+ "name": "FormfieldWrapper",
7679
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
7732
7680
  }
7733
7681
  },
7734
7682
  {
7735
- "name": "orientation",
7683
+ "name": "help-text",
7736
7684
  "type": {
7737
- "text": "CardOrientation"
7685
+ "text": "string | undefined"
7738
7686
  },
7739
- "description": "The orientation of the card. It can either be set to 'vertical' or 'horizontal'",
7740
- "default": "'vertical'",
7741
- "fieldName": "orientation",
7687
+ "description": "The help text that is displayed below the input field.",
7688
+ "fieldName": "helpText",
7742
7689
  "inheritedFrom": {
7743
- "name": "Card",
7744
- "module": "src/components/card/card.component.ts"
7690
+ "name": "FormfieldWrapper",
7691
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
7745
7692
  }
7746
7693
  },
7747
7694
  {
7748
- "name": "title-tag-name",
7695
+ "name": "toggletip-text",
7749
7696
  "type": {
7750
- "text": "TagNameType"
7697
+ "text": "string | undefined"
7751
7698
  },
7752
- "description": "The tag name for the card title. It supports all the types that `mdc-text` supports",
7753
- "default": "'span'",
7754
- "fieldName": "titleTagName",
7699
+ "description": "The toggletip text that is displayed when the label is hovered.\nIt is used to provide additional information about the label.",
7700
+ "fieldName": "toggletipText",
7755
7701
  "inheritedFrom": {
7756
- "name": "Card",
7757
- "module": "src/components/card/card.component.ts"
7702
+ "name": "FormfieldWrapper",
7703
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
7758
7704
  }
7759
7705
  },
7760
7706
  {
7761
- "name": "subtitle-tag-name",
7707
+ "name": "toggletip-placement",
7762
7708
  "type": {
7763
- "text": "TagNameType"
7709
+ "text": "PopoverPlacement"
7764
7710
  },
7765
- "description": "The tag name for the subtitle. It supports all the types that `mdc-text` supports",
7766
- "default": "'span'",
7767
- "fieldName": "subtitleTagName",
7711
+ "description": "The placement of the toggletip that is displayed when the info icon is hovered.",
7712
+ "default": "'top'",
7713
+ "fieldName": "toggletipPlacement",
7768
7714
  "inheritedFrom": {
7769
- "name": "Card",
7770
- "module": "src/components/card/card.component.ts"
7715
+ "name": "FormfieldWrapper",
7716
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
7771
7717
  }
7772
7718
  },
7773
7719
  {
7774
- "name": "icon-name",
7720
+ "name": "info-icon-aria-label",
7775
7721
  "type": {
7776
- "text": "IconNames | undefined"
7722
+ "text": "string | undefined"
7777
7723
  },
7778
- "description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
7779
- "fieldName": "iconName",
7724
+ "description": "Aria label for the info icon that is displayed next to the label when `toggletipText` is set.\nThis is used for accessibility purposes to provide a description of the icon.",
7725
+ "fieldName": "infoIconAriaLabel",
7780
7726
  "inheritedFrom": {
7781
- "name": "Card",
7782
- "module": "src/components/card/card.component.ts"
7727
+ "name": "FormfieldWrapper",
7728
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
7783
7729
  }
7784
7730
  }
7785
7731
  ],
7786
7732
  "mixins": [
7787
7733
  {
7788
- "name": "DisabledMixin",
7789
- "module": "/src/utils/mixins/DisabledMixin"
7734
+ "name": "FormInternalsMixin",
7735
+ "module": "/src/utils/mixins/FormInternalsMixin"
7790
7736
  },
7791
7737
  {
7792
- "name": "TabIndexMixin",
7793
- "module": "/src/utils/mixins/TabIndexMixin"
7738
+ "name": "DataAriaLabelMixin",
7739
+ "module": "/src/utils/mixins/DataAriaLabelMixin"
7794
7740
  }
7795
7741
  ],
7796
7742
  "superclass": {
7797
- "name": "Card",
7798
- "module": "/src/components/card/card.component"
7743
+ "name": "FormfieldWrapper",
7744
+ "module": "/src/components/formfieldwrapper/formfieldwrapper.component"
7799
7745
  },
7800
- "tagName": "mdc-cardradio",
7801
- "jsDoc": "/**\n * cardradio component extends `mdc-card` and supports radio selection interaction addtionally.\n *\n * While using this component within a form or group of cards, make sure cards are in a role = \"radio-group\".\n * This card would have events for selected and unselected (similar to radio)\n *\n * **Note**: This is a single selection card i.e. interacting anywhere on the card would toggle the checked state.\n * Make sure to pass only non-interactable elements within the slots.\n *\n * Make sure to pass the `card-title` mandatorily for this card.\n *\n * @tagname mdc-cardradio\n *\n * @dependency mdc-icon\n * @dependency mdc-staticradio\n * @dependency mdc-text\n *\n * @slot before-body - This slot is for passing the content before the body\n * @slot body - This slot is for passing the text content for the card\n * @slot after-body - This slot is for passing the content after the body\n * @slot footer-link - This slot is for passing `mdc-link` component within the footer section.\n * @slot footer-button-primary - This slot is for passing primary variant of `mdc-button` component within the footer section.\n *\n * @csspart header - The header part of the card\n * @csspart icon - The icon part of the card header\n * @csspart body - The body part of the card\n * @csspart image - The image part of the card\n * @csspart footer - The footer part of the card\n * @csspart footer-link - The link part of the card footer\n * @csspart footer-button-primary - The primary button part of the card footer\n * @csspart footer-button-secondary - The secondary button part of the card footer\n * @csspart icon-button - The icon button part of the card header\n * @csspart text - The text part of the card\n * @csspart check - The check part of the card\n * @csspart check-icon - The check icon part of the card\n * @csspart check-icon-button - The check icon button part of the card\n *\n * @cssproperty --mdc-card-width - The width of the card\n *\n * @event click - (React: onClick) Event that gets dispatched when the card is clicked. It toggles the checked state.\n * @event keydown - (React: onKeyDown) This event is dispatched when a key is pressed down on the card.\n * It toggles the checked state when enter key is used.\n * @event keyup - (React: onKeyUp) This event is dispatched when a key is released on the card.\n * It toggles the checked state when space key is used.\n * @event change - (React: onChange) Event that gets dispatched when the card state changes.\n * @event focus - (React: onFocus) Event that gets dispatched when the card receives focus.\n *\n */",
7746
+ "tagName": "mdc-checkbox",
7747
+ "jsDoc": "/**\n * Checkboxes allow users to select multiple options from a list or turn an item/feature on or off.\n * These are often used in forms, settings, and selections in lists.\n *\n * A checkbox component contains an optional label and an optional helper text.\n *\n * To create a group of checkboxes, use the FormFieldGroup component.\n *\n * @dependency mdc-button\n * @dependency mdc-icon\n * @dependency mdc-staticcheckbox\n * @dependency mdc-text\n * @dependency mdc-toggletip\n *\n * @tagname mdc-checkbox\n *\n * @event change - (React: onChange) Event that gets dispatched when the checkbox state changes.\n * @event focus - (React: onFocus) Event that gets dispatched when the checkbox receives focus.\n *\n * @cssproperty --mdc-checkbox-background-color-hover - Allows customization of the background color on hover.\n * @cssproperty --mdc-checkbox-checked-background-color-hover - Background color for a selected checkbox when hovered.\n * @cssproperty --mdc-checkbox-checked-pressed-icon-color - Background color for a selected checkbox when pressed.\n * @cssproperty --mdc-checkbox-pressed-icon-color - Background color for a selected checkbox when pressed.\n * @cssproperty --mdc-checkbox-disabled-checked-icon-color - Background color for a selected checkbox when disabled.\n */",
7802
7748
  "customElement": true
7803
7749
  }
7804
7750
  ],
@@ -7807,256 +7753,310 @@
7807
7753
  "kind": "js",
7808
7754
  "name": "default",
7809
7755
  "declaration": {
7810
- "name": "CardRadio",
7811
- "module": "components/cardradio/cardradio.component.js"
7756
+ "name": "Checkbox",
7757
+ "module": "components/checkbox/checkbox.component.js"
7812
7758
  }
7813
7759
  }
7814
7760
  ]
7815
7761
  },
7816
7762
  {
7817
7763
  "kind": "javascript-module",
7818
- "path": "components/checkbox/checkbox.component.js",
7764
+ "path": "components/cardradio/cardradio.component.js",
7819
7765
  "declarations": [
7820
7766
  {
7821
7767
  "kind": "class",
7822
- "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.",
7823
- "name": "Checkbox",
7768
+ "description": "cardradio component extends `mdc-card` and supports radio selection interaction addtionally.\n\nWhile using this component within a form or group of cards, make sure cards are in a role = \"radio-group\".\nThis card would have events for selected and unselected (similar to radio)\n\n**Note**: This is a single selection card i.e. interacting anywhere on the card would toggle the checked state.\nMake sure to pass only non-interactable elements within the slots.\n\nMake sure to pass the `card-title` mandatorily for this card.",
7769
+ "name": "CardRadio",
7824
7770
  "cssProperties": [
7825
7771
  {
7826
- "description": "Allows customization of the background color on hover.",
7827
- "name": "--mdc-checkbox-background-color-hover"
7772
+ "description": "The width of the card",
7773
+ "name": "--mdc-card-width",
7774
+ "inheritedFrom": {
7775
+ "name": "Card",
7776
+ "module": "src/components/card/card.component.ts"
7777
+ }
7778
+ }
7779
+ ],
7780
+ "cssParts": [
7781
+ {
7782
+ "description": "The header part of the card",
7783
+ "name": "header",
7784
+ "inheritedFrom": {
7785
+ "name": "Card",
7786
+ "module": "src/components/card/card.component.ts"
7787
+ }
7828
7788
  },
7829
7789
  {
7830
- "description": "Background color for a selected checkbox when hovered.",
7831
- "name": "--mdc-checkbox-checked-background-color-hover"
7790
+ "description": "The icon part of the card header",
7791
+ "name": "icon",
7792
+ "inheritedFrom": {
7793
+ "name": "Card",
7794
+ "module": "src/components/card/card.component.ts"
7795
+ }
7832
7796
  },
7833
7797
  {
7834
- "description": "Background color for a selected checkbox when pressed.",
7835
- "name": "--mdc-checkbox-checked-pressed-icon-color"
7798
+ "description": "The body part of the card",
7799
+ "name": "body",
7800
+ "inheritedFrom": {
7801
+ "name": "Card",
7802
+ "module": "src/components/card/card.component.ts"
7803
+ }
7836
7804
  },
7837
7805
  {
7838
- "description": "Background color for a selected checkbox when pressed.",
7839
- "name": "--mdc-checkbox-pressed-icon-color"
7806
+ "description": "The image part of the card",
7807
+ "name": "image",
7808
+ "inheritedFrom": {
7809
+ "name": "Card",
7810
+ "module": "src/components/card/card.component.ts"
7811
+ }
7840
7812
  },
7841
7813
  {
7842
- "description": "Background color for a selected checkbox when disabled.",
7843
- "name": "--mdc-checkbox-disabled-checked-icon-color"
7844
- }
7845
- ],
7846
- "members": [
7814
+ "description": "The footer part of the card",
7815
+ "name": "footer",
7816
+ "inheritedFrom": {
7817
+ "name": "Card",
7818
+ "module": "src/components/card/card.component.ts"
7819
+ }
7820
+ },
7847
7821
  {
7848
- "kind": "field",
7849
- "name": "checked",
7850
- "type": {
7851
- "text": "boolean"
7852
- },
7853
- "default": "false",
7854
- "description": "Determines whether the checkbox is selected or unselected.",
7855
- "attribute": "checked",
7856
- "reflects": true
7822
+ "description": "The link part of the card footer",
7823
+ "name": "footer-link",
7824
+ "inheritedFrom": {
7825
+ "name": "Card",
7826
+ "module": "src/components/card/card.component.ts"
7827
+ }
7857
7828
  },
7858
7829
  {
7859
- "kind": "field",
7860
- "name": "indeterminate",
7861
- "type": {
7862
- "text": "boolean"
7863
- },
7864
- "default": "false",
7865
- "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.",
7866
- "attribute": "indeterminate",
7867
- "reflects": true
7830
+ "description": "The primary button part of the card footer",
7831
+ "name": "footer-button-primary",
7832
+ "inheritedFrom": {
7833
+ "name": "Card",
7834
+ "module": "src/components/card/card.component.ts"
7835
+ }
7868
7836
  },
7869
7837
  {
7870
- "kind": "field",
7871
- "name": "autofocus",
7872
- "type": {
7873
- "text": "boolean"
7874
- },
7875
- "default": "false",
7876
- "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)",
7877
- "attribute": "autofocus",
7878
- "reflects": true
7838
+ "description": "The secondary button part of the card footer",
7839
+ "name": "footer-button-secondary",
7840
+ "inheritedFrom": {
7841
+ "name": "Card",
7842
+ "module": "src/components/card/card.component.ts"
7843
+ }
7879
7844
  },
7880
7845
  {
7881
- "kind": "method",
7882
- "name": "setFormValue",
7883
- "privacy": "private",
7884
- "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."
7846
+ "description": "The icon button part of the card header",
7847
+ "name": "icon-button",
7848
+ "inheritedFrom": {
7849
+ "name": "Card",
7850
+ "module": "src/components/card/card.component.ts"
7851
+ }
7885
7852
  },
7886
7853
  {
7887
- "kind": "method",
7888
- "name": "manageRequired",
7889
- "privacy": "private",
7890
- "description": "Manages the required state of the checkbox.\nIf the checkbox is not checked and the required property is set, then the checkbox is invalid."
7854
+ "description": "The text part of the card",
7855
+ "name": "text",
7856
+ "inheritedFrom": {
7857
+ "name": "Card",
7858
+ "module": "src/components/card/card.component.ts"
7859
+ }
7891
7860
  },
7892
7861
  {
7893
- "kind": "method",
7894
- "name": "toggleState",
7895
- "privacy": "private",
7896
- "return": {
7897
- "type": {
7898
- "text": "void"
7899
- }
7900
- },
7901
- "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."
7862
+ "description": "The check part of the card",
7863
+ "name": "check"
7902
7864
  },
7903
7865
  {
7904
- "kind": "method",
7905
- "name": "handleKeyDown",
7906
- "privacy": "private",
7907
- "return": {
7908
- "type": {
7909
- "text": "void"
7910
- }
7911
- },
7912
- "parameters": [
7913
- {
7914
- "name": "event",
7915
- "type": {
7916
- "text": "KeyboardEvent"
7917
- },
7918
- "description": "The keyboard event."
7919
- }
7920
- ],
7921
- "description": "Handles the keydown event on the checkbox.\nWhen the user presses Enter, the form is submitted."
7866
+ "description": "The check icon part of the card",
7867
+ "name": "check-icon"
7922
7868
  },
7923
7869
  {
7924
- "kind": "method",
7925
- "name": "handleChange",
7926
- "privacy": "public",
7927
- "return": {
7928
- "type": {
7929
- "text": "void"
7930
- }
7931
- },
7932
- "parameters": [
7933
- {
7934
- "name": "event",
7935
- "type": {
7936
- "text": "Event"
7937
- }
7938
- }
7939
- ],
7940
- "description": "Toggles the state of the checkbox element.\nand dispatch the new change event."
7870
+ "description": "The check icon button part of the card",
7871
+ "name": "check-icon-button"
7872
+ }
7873
+ ],
7874
+ "slots": [
7875
+ {
7876
+ "description": "This slot is for passing the content before the body",
7877
+ "name": "before-body",
7878
+ "inheritedFrom": {
7879
+ "name": "Card",
7880
+ "module": "src/components/card/card.component.ts"
7881
+ }
7941
7882
  },
7942
7883
  {
7943
- "kind": "field",
7944
- "name": "renderLabelAndHelperText",
7945
- "privacy": "private"
7884
+ "description": "This slot is for passing the text content for the card",
7885
+ "name": "body",
7886
+ "inheritedFrom": {
7887
+ "name": "Card",
7888
+ "module": "src/components/card/card.component.ts"
7889
+ }
7946
7890
  },
7947
7891
  {
7948
- "kind": "field",
7949
- "name": "name",
7950
- "type": {
7951
- "text": "string"
7952
- },
7953
- "default": "''",
7954
- "description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
7955
- "attribute": "name",
7956
- "reflects": true,
7892
+ "description": "This slot is for passing the content after the body",
7893
+ "name": "after-body",
7957
7894
  "inheritedFrom": {
7958
- "name": "FormInternalsMixin",
7959
- "module": "utils/mixins/FormInternalsMixin.js"
7895
+ "name": "Card",
7896
+ "module": "src/components/card/card.component.ts"
7960
7897
  }
7961
7898
  },
7962
7899
  {
7963
- "kind": "field",
7964
- "name": "value",
7965
- "type": {
7966
- "text": "string"
7967
- },
7968
- "default": "''",
7969
- "description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
7970
- "attribute": "value",
7971
- "reflects": true,
7900
+ "description": "This slot is for passing `mdc-link` component within the footer section.",
7901
+ "name": "footer-link",
7972
7902
  "inheritedFrom": {
7973
- "name": "FormInternalsMixin",
7974
- "module": "utils/mixins/FormInternalsMixin.js"
7903
+ "name": "Card",
7904
+ "module": "src/components/card/card.component.ts"
7905
+ }
7906
+ },
7907
+ {
7908
+ "description": "This slot is for passing primary variant of `mdc-button` component within the footer section.",
7909
+ "name": "footer-button-primary",
7910
+ "inheritedFrom": {
7911
+ "name": "Card",
7912
+ "module": "src/components/card/card.component.ts"
7913
+ }
7914
+ },
7915
+ {
7916
+ "description": "This slot is for passing secondary variant of `mdc-button` component within the footer section.",
7917
+ "name": "footer-button-secondary",
7918
+ "inheritedFrom": {
7919
+ "name": "Card",
7920
+ "module": "src/components/card/card.component.ts"
7975
7921
  }
7976
7922
  },
7923
+ {
7924
+ "description": " This slot is for passing custom footer content. Only use this if really needed, using the footer-link and footer-button slots is preferred.",
7925
+ "name": "footer",
7926
+ "inheritedFrom": {
7927
+ "name": "Card",
7928
+ "module": "src/components/card/card.component.ts"
7929
+ }
7930
+ }
7931
+ ],
7932
+ "members": [
7977
7933
  {
7978
7934
  "kind": "field",
7979
- "name": "validationMessage",
7935
+ "name": "checked",
7980
7936
  "type": {
7981
- "text": "string | undefined"
7937
+ "text": "boolean"
7982
7938
  },
7983
- "description": "Custom validation message that will override the default message and displayed when the input is invalid.\n\nTo display custom validation messages, you must listen for input events (or other relevant events)\non your component and update the `validationMessage` property with the desired message string.\nUpdating this property will ensure that new validation messages are shown to the user.\n- The `validationMessage` property overrides the default browser validation message when set.\n- Consumers are responsible for updating `validationMessage` in response to input or validation state changes.",
7984
- "attribute": "validation-message",
7985
- "reflects": true,
7986
- "inheritedFrom": {
7987
- "name": "FormInternalsMixin",
7988
- "module": "utils/mixins/FormInternalsMixin.js"
7989
- }
7939
+ "default": "false",
7940
+ "description": "The checked state of the card",
7941
+ "attribute": "checked",
7942
+ "reflects": true
7990
7943
  },
7991
7944
  {
7992
7945
  "kind": "field",
7993
- "name": "validity",
7946
+ "name": "name",
7994
7947
  "type": {
7995
- "text": "ValidityState"
7948
+ "text": "string"
7949
+ },
7950
+ "default": "''",
7951
+ "description": "The name of the radio.",
7952
+ "attribute": "name"
7953
+ },
7954
+ {
7955
+ "kind": "method",
7956
+ "name": "getAllCardsWithinSameGroup",
7957
+ "privacy": "private",
7958
+ "return": {
7959
+ "type": {
7960
+ "text": "CardRadio[]"
7961
+ }
7996
7962
  },
7997
- "readonly": true,
7998
- "inheritedFrom": {
7999
- "name": "FormInternalsMixin",
8000
- "module": "utils/mixins/FormInternalsMixin.js"
8001
- }
7963
+ "description": "Returns all cards within the same group (name)."
8002
7964
  },
8003
7965
  {
8004
- "kind": "field",
8005
- "name": "willValidate",
8006
- "readonly": true,
8007
- "inheritedFrom": {
8008
- "name": "FormInternalsMixin",
8009
- "module": "utils/mixins/FormInternalsMixin.js"
8010
- }
7966
+ "kind": "method",
7967
+ "name": "toggleChecked",
7968
+ "privacy": "private",
7969
+ "return": {
7970
+ "type": {
7971
+ "text": "void"
7972
+ }
7973
+ },
7974
+ "description": "Handles the change event on the radio element.\nThis will toggle the state of the radio element.\nDispatches the change event."
8011
7975
  },
8012
7976
  {
8013
7977
  "kind": "method",
8014
- "name": "setValidity",
8015
- "description": "Sets the validity of the input field based on the input field's validity.",
7978
+ "name": "setDisabled",
8016
7979
  "return": {
8017
7980
  "type": {
8018
- "text": ""
7981
+ "text": "void"
8019
7982
  }
8020
7983
  },
8021
- "inheritedFrom": {
8022
- "name": "FormInternalsMixin",
8023
- "module": "utils/mixins/FormInternalsMixin.js"
8024
- }
7984
+ "parameters": [
7985
+ {
7986
+ "name": "disabled",
7987
+ "type": {
7988
+ "text": "boolean"
7989
+ }
7990
+ }
7991
+ ]
8025
7992
  },
8026
7993
  {
8027
7994
  "kind": "method",
8028
- "name": "checkValidity",
7995
+ "name": "updateCardRadio",
7996
+ "privacy": "private",
8029
7997
  "return": {
8030
7998
  "type": {
8031
- "text": "boolean"
7999
+ "text": "void"
8032
8000
  }
8033
8001
  },
8034
- "inheritedFrom": {
8035
- "name": "FormInternalsMixin",
8036
- "module": "utils/mixins/FormInternalsMixin.js"
8037
- }
8002
+ "parameters": [
8003
+ {
8004
+ "name": "cards",
8005
+ "type": {
8006
+ "text": "CardRadio[]"
8007
+ }
8008
+ },
8009
+ {
8010
+ "name": "index",
8011
+ "type": {
8012
+ "text": "number"
8013
+ }
8014
+ }
8015
+ ]
8038
8016
  },
8039
8017
  {
8040
8018
  "kind": "method",
8041
- "name": "reportValidity",
8042
- "inheritedFrom": {
8043
- "name": "FormInternalsMixin",
8044
- "module": "utils/mixins/FormInternalsMixin.js"
8045
- }
8019
+ "name": "toggleOnEnter",
8020
+ "privacy": "private",
8021
+ "parameters": [
8022
+ {
8023
+ "name": "event",
8024
+ "type": {
8025
+ "text": "KeyboardEvent"
8026
+ },
8027
+ "description": "The keyboard event"
8028
+ }
8029
+ ],
8030
+ "description": "Toggles the checked state when enter key is used"
8046
8031
  },
8047
8032
  {
8048
- "kind": "field",
8049
- "name": "dataAriaLabel",
8050
- "type": {
8051
- "text": "string | null"
8033
+ "kind": "method",
8034
+ "name": "toggleOnSpace",
8035
+ "privacy": "private",
8036
+ "parameters": [
8037
+ {
8038
+ "name": "event",
8039
+ "type": {
8040
+ "text": "KeyboardEvent"
8041
+ },
8042
+ "description": "The keyboard event"
8043
+ }
8044
+ ],
8045
+ "description": "Toggles the checked state when space key is used"
8046
+ },
8047
+ {
8048
+ "kind": "method",
8049
+ "name": "renderHeader",
8050
+ "privacy": "protected",
8051
+ "description": "Renders the header of the card",
8052
+ "return": {
8053
+ "type": {
8054
+ "text": ""
8055
+ }
8052
8056
  },
8053
- "default": "null",
8054
- "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
8055
- "attribute": "data-aria-label",
8056
- "reflects": true,
8057
8057
  "inheritedFrom": {
8058
- "name": "DataAriaLabelMixin",
8059
- "module": "utils/mixins/DataAriaLabelMixin.js"
8058
+ "name": "Card",
8059
+ "module": "components/card/card.component.js"
8060
8060
  }
8061
8061
  },
8062
8062
  {
@@ -8076,207 +8076,237 @@
8076
8076
  },
8077
8077
  {
8078
8078
  "kind": "field",
8079
- "name": "label",
8079
+ "name": "tabIndex",
8080
8080
  "type": {
8081
- "text": "string | undefined"
8081
+ "text": "number"
8082
8082
  },
8083
- "description": "The label of the input field. It is linked to the input field using the `for` attribute.",
8084
- "attribute": "label",
8083
+ "default": "0",
8084
+ "description": "This property specifies the tab order of the element.",
8085
+ "attribute": "tabIndex",
8085
8086
  "reflects": true,
8086
8087
  "inheritedFrom": {
8087
- "name": "FormfieldWrapper",
8088
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
8088
+ "name": "TabIndexMixin",
8089
+ "module": "utils/mixins/TabIndexMixin.js"
8089
8090
  }
8090
8091
  },
8091
8092
  {
8092
8093
  "kind": "field",
8093
- "name": "required",
8094
+ "name": "cardTitle",
8094
8095
  "type": {
8095
- "text": "boolean"
8096
+ "text": "string"
8096
8097
  },
8097
- "default": "false",
8098
- "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
8099
- "attribute": "required",
8098
+ "default": "''",
8099
+ "description": "The title of the card - part of header section",
8100
+ "attribute": "card-title",
8100
8101
  "reflects": true,
8101
8102
  "inheritedFrom": {
8102
- "name": "FormfieldWrapper",
8103
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
8103
+ "name": "Card",
8104
+ "module": "components/card/card.component.js"
8104
8105
  }
8105
8106
  },
8106
8107
  {
8107
8108
  "kind": "field",
8108
- "name": "id",
8109
+ "name": "subtitle",
8109
8110
  "type": {
8110
8111
  "text": "string"
8111
8112
  },
8112
8113
  "default": "''",
8113
- "description": "The unique id of the input field. It is used to link the input field with the label.",
8114
- "attribute": "id",
8114
+ "description": "The subtitle of the card - part of header section",
8115
+ "attribute": "subtitle",
8116
+ "reflects": true,
8115
8117
  "inheritedFrom": {
8116
- "name": "FormfieldWrapper",
8117
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
8118
+ "name": "Card",
8119
+ "module": "components/card/card.component.js"
8118
8120
  }
8119
8121
  },
8120
8122
  {
8121
8123
  "kind": "field",
8122
- "name": "helpTextType",
8124
+ "name": "imageSrc",
8123
8125
  "type": {
8124
- "text": "ValidationType"
8126
+ "text": "string"
8125
8127
  },
8126
- "description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
8127
- "attribute": "help-text-type",
8128
+ "default": "''",
8129
+ "description": "The image source URL to render on the card",
8130
+ "attribute": "image-src",
8128
8131
  "reflects": true,
8129
8132
  "inheritedFrom": {
8130
- "name": "FormfieldWrapper",
8131
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
8133
+ "name": "Card",
8134
+ "module": "components/card/card.component.js"
8132
8135
  }
8133
8136
  },
8134
8137
  {
8135
8138
  "kind": "field",
8136
- "name": "helpText",
8139
+ "name": "imageAlt",
8137
8140
  "type": {
8138
- "text": "string | undefined"
8141
+ "text": "string"
8139
8142
  },
8140
- "description": "The help text that is displayed below the input field.",
8141
- "attribute": "help-text",
8143
+ "default": "''",
8144
+ "description": "The image alt for accessibility support",
8145
+ "attribute": "image-alt",
8142
8146
  "reflects": true,
8143
8147
  "inheritedFrom": {
8144
- "name": "FormfieldWrapper",
8145
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
8148
+ "name": "Card",
8149
+ "module": "components/card/card.component.js"
8146
8150
  }
8147
8151
  },
8148
8152
  {
8149
8153
  "kind": "field",
8150
- "name": "toggletipText",
8154
+ "name": "variant",
8151
8155
  "type": {
8152
- "text": "string | undefined"
8156
+ "text": "CardVariant"
8153
8157
  },
8154
- "description": "The toggletip text that is displayed when the label is hovered.\nIt is used to provide additional information about the label.",
8155
- "attribute": "toggletip-text",
8158
+ "description": "The variant of the card. It can either be set to 'border' or 'ghost'",
8159
+ "default": "'border'",
8160
+ "attribute": "variant",
8156
8161
  "reflects": true,
8157
8162
  "inheritedFrom": {
8158
- "name": "FormfieldWrapper",
8159
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
8163
+ "name": "Card",
8164
+ "module": "components/card/card.component.js"
8160
8165
  }
8161
8166
  },
8162
8167
  {
8163
8168
  "kind": "field",
8164
- "name": "toggletipPlacement",
8169
+ "name": "orientation",
8165
8170
  "type": {
8166
- "text": "PopoverPlacement"
8171
+ "text": "CardOrientation"
8167
8172
  },
8168
- "description": "The placement of the toggletip that is displayed when the info icon is hovered.",
8169
- "default": "'top'",
8170
- "attribute": "toggletip-placement",
8173
+ "description": "The orientation of the card. It can either be set to 'vertical' or 'horizontal'",
8174
+ "default": "'vertical'",
8175
+ "attribute": "orientation",
8171
8176
  "reflects": true,
8172
8177
  "inheritedFrom": {
8173
- "name": "FormfieldWrapper",
8174
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
8178
+ "name": "Card",
8179
+ "module": "components/card/card.component.js"
8175
8180
  }
8176
8181
  },
8177
8182
  {
8178
8183
  "kind": "field",
8179
- "name": "infoIconAriaLabel",
8184
+ "name": "titleTagName",
8180
8185
  "type": {
8181
- "text": "string | undefined"
8186
+ "text": "TagNameType"
8182
8187
  },
8183
- "description": "Aria label for the info icon that is displayed next to the label when `toggletipText` is set.\nThis is used for accessibility purposes to provide a description of the icon.",
8184
- "attribute": "info-icon-aria-label",
8188
+ "description": "The tag name for the card title. It supports all the types that `mdc-text` supports",
8189
+ "default": "'span'",
8190
+ "attribute": "title-tag-name",
8185
8191
  "reflects": true,
8186
8192
  "inheritedFrom": {
8187
- "name": "FormfieldWrapper",
8188
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
8193
+ "name": "Card",
8194
+ "module": "components/card/card.component.js"
8189
8195
  }
8190
8196
  },
8191
8197
  {
8192
- "kind": "method",
8193
- "name": "renderLabelElement",
8194
- "privacy": "protected",
8195
- "description": "creates the label element when the label property is set.\nid is used to link the label with the input field.",
8196
- "return": {
8197
- "type": {
8198
- "text": ""
8199
- }
8198
+ "kind": "field",
8199
+ "name": "subtitleTagName",
8200
+ "type": {
8201
+ "text": "TagNameType"
8200
8202
  },
8203
+ "description": "The tag name for the subtitle. It supports all the types that `mdc-text` supports",
8204
+ "default": "'span'",
8205
+ "attribute": "subtitle-tag-name",
8206
+ "reflects": true,
8201
8207
  "inheritedFrom": {
8202
- "name": "FormfieldWrapper",
8203
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
8208
+ "name": "Card",
8209
+ "module": "components/card/card.component.js"
8210
+ }
8211
+ },
8212
+ {
8213
+ "kind": "field",
8214
+ "name": "iconName",
8215
+ "type": {
8216
+ "text": "IconNames | undefined"
8217
+ },
8218
+ "description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
8219
+ "attribute": "icon-name",
8220
+ "reflects": true,
8221
+ "inheritedFrom": {
8222
+ "name": "Card",
8223
+ "module": "components/card/card.component.js"
8204
8224
  }
8205
8225
  },
8206
8226
  {
8207
8227
  "kind": "method",
8208
- "name": "renderHelpTextIcon",
8228
+ "name": "renderImage",
8209
8229
  "privacy": "protected",
8210
- "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.",
8230
+ "description": "Renders the image on the card if image source is provided",
8211
8231
  "return": {
8212
8232
  "type": {
8213
8233
  "text": ""
8214
8234
  }
8215
8235
  },
8216
8236
  "inheritedFrom": {
8217
- "name": "FormfieldWrapper",
8218
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
8237
+ "name": "Card",
8238
+ "module": "components/card/card.component.js"
8219
8239
  }
8220
8240
  },
8221
8241
  {
8222
8242
  "kind": "method",
8223
- "name": "renderHelpText",
8243
+ "name": "renderIcon",
8224
8244
  "privacy": "protected",
8225
- "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.",
8245
+ "description": "Renders the icon on the card if icon name is provided",
8226
8246
  "return": {
8227
8247
  "type": {
8228
8248
  "text": ""
8229
8249
  }
8230
8250
  },
8231
8251
  "inheritedFrom": {
8232
- "name": "FormfieldWrapper",
8233
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
8252
+ "name": "Card",
8253
+ "module": "components/card/card.component.js"
8234
8254
  }
8235
8255
  },
8236
8256
  {
8237
8257
  "kind": "method",
8238
- "name": "renderLabel",
8258
+ "name": "renderTitle",
8239
8259
  "privacy": "protected",
8240
- "description": "renders the mdc-label-text container that contains the label and labelInfoToggleTip.",
8260
+ "description": "Renders the title and subtitle on the card",
8241
8261
  "return": {
8242
8262
  "type": {
8243
8263
  "text": ""
8244
8264
  }
8245
8265
  },
8246
8266
  "inheritedFrom": {
8247
- "name": "FormfieldWrapper",
8248
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
8267
+ "name": "Card",
8268
+ "module": "components/card/card.component.js"
8249
8269
  }
8250
8270
  },
8251
8271
  {
8252
8272
  "kind": "method",
8253
- "name": "renderHelperText",
8273
+ "name": "renderFooter",
8254
8274
  "privacy": "protected",
8255
- "description": "renders the mdc-help-text container that contains the helpertext icon and helpertext.",
8275
+ "description": "Renders the footer of the card if footer-link,\nfooter-button-primary, or footer-button-secondary slots are provided",
8256
8276
  "return": {
8257
8277
  "type": {
8258
8278
  "text": ""
8259
8279
  }
8260
8280
  },
8261
8281
  "inheritedFrom": {
8262
- "name": "FormfieldWrapper",
8263
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
8282
+ "name": "Card",
8283
+ "module": "components/card/card.component.js"
8264
8284
  }
8265
8285
  }
8266
8286
  ],
8267
8287
  "events": [
8268
8288
  {
8269
- "type": {
8270
- "text": "EventConstructor"
8271
- }
8289
+ "description": "(React: onClick) Event that gets dispatched when the card is clicked. It toggles the checked state.",
8290
+ "name": "click",
8291
+ "reactName": "onClick"
8272
8292
  },
8273
8293
  {
8274
- "description": "(React: onChange) Event that gets dispatched when the checkbox state changes.",
8294
+ "description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the card. It toggles the checked state when enter key is used.",
8295
+ "name": "keydown",
8296
+ "reactName": "onKeyDown"
8297
+ },
8298
+ {
8299
+ "description": "(React: onKeyUp) This event is dispatched when a key is released on the card. It toggles the checked state when space key is used.",
8300
+ "name": "keyup",
8301
+ "reactName": "onKeyUp"
8302
+ },
8303
+ {
8304
+ "description": "(React: onChange) Event that gets dispatched when the card state changes.",
8275
8305
  "name": "change",
8276
8306
  "reactName": "onChange"
8277
8307
  },
8278
8308
  {
8279
- "description": "(React: onFocus) Event that gets dispatched when the checkbox receives focus.",
8309
+ "description": "(React: onFocus) Event that gets dispatched when the card receives focus.",
8280
8310
  "name": "focus",
8281
8311
  "reactName": "onFocus"
8282
8312
  }
@@ -8288,207 +8318,177 @@
8288
8318
  "text": "boolean"
8289
8319
  },
8290
8320
  "default": "false",
8291
- "description": "Determines whether the checkbox is selected or unselected.",
8321
+ "description": "The checked state of the card",
8292
8322
  "fieldName": "checked"
8293
8323
  },
8294
- {
8295
- "name": "indeterminate",
8296
- "type": {
8297
- "text": "boolean"
8298
- },
8299
- "default": "false",
8300
- "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.",
8301
- "fieldName": "indeterminate"
8302
- },
8303
- {
8304
- "name": "autofocus",
8305
- "type": {
8306
- "text": "boolean"
8307
- },
8308
- "default": "false",
8309
- "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)",
8310
- "fieldName": "autofocus"
8311
- },
8312
8324
  {
8313
8325
  "name": "name",
8314
8326
  "type": {
8315
8327
  "text": "string"
8316
8328
  },
8317
8329
  "default": "''",
8318
- "description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
8319
- "fieldName": "name",
8320
- "inheritedFrom": {
8321
- "name": "FormInternalsMixin",
8322
- "module": "src/utils/mixins/FormInternalsMixin.ts"
8323
- }
8324
- },
8325
- {
8326
- "name": "value",
8327
- "type": {
8328
- "text": "string"
8329
- },
8330
- "default": "''",
8331
- "description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
8332
- "fieldName": "value",
8333
- "inheritedFrom": {
8334
- "name": "FormInternalsMixin",
8335
- "module": "src/utils/mixins/FormInternalsMixin.ts"
8336
- }
8330
+ "description": "The name of the radio.",
8331
+ "fieldName": "name"
8337
8332
  },
8338
8333
  {
8339
- "name": "validation-message",
8334
+ "name": "disabled",
8340
8335
  "type": {
8341
- "text": "string | undefined"
8336
+ "text": "boolean | undefined"
8342
8337
  },
8343
- "description": "Custom validation message that will override the default message and displayed when the input is invalid.\n\nTo display custom validation messages, you must listen for input events (or other relevant events)\non your component and update the `validationMessage` property with the desired message string.\nUpdating this property will ensure that new validation messages are shown to the user.\n- The `validationMessage` property overrides the default browser validation message when set.\n- Consumers are responsible for updating `validationMessage` in response to input or validation state changes.",
8344
- "fieldName": "validationMessage",
8338
+ "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
8339
+ "default": "undefined",
8340
+ "fieldName": "disabled",
8345
8341
  "inheritedFrom": {
8346
- "name": "FormInternalsMixin",
8347
- "module": "src/utils/mixins/FormInternalsMixin.ts"
8342
+ "name": "DisabledMixin",
8343
+ "module": "src/utils/mixins/DisabledMixin.ts"
8348
8344
  }
8349
8345
  },
8350
8346
  {
8351
- "name": "data-aria-label",
8347
+ "name": "tabIndex",
8352
8348
  "type": {
8353
- "text": "string | null"
8349
+ "text": "number"
8354
8350
  },
8355
- "default": "null",
8356
- "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
8357
- "fieldName": "dataAriaLabel",
8351
+ "default": "0",
8352
+ "description": "This property specifies the tab order of the element.",
8353
+ "fieldName": "tabIndex",
8358
8354
  "inheritedFrom": {
8359
- "name": "DataAriaLabelMixin",
8360
- "module": "src/utils/mixins/DataAriaLabelMixin.ts"
8355
+ "name": "TabIndexMixin",
8356
+ "module": "src/utils/mixins/TabIndexMixin.ts"
8361
8357
  }
8362
8358
  },
8363
8359
  {
8364
- "name": "disabled",
8360
+ "name": "card-title",
8365
8361
  "type": {
8366
- "text": "boolean | undefined"
8362
+ "text": "string"
8367
8363
  },
8368
- "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
8369
- "default": "undefined",
8370
- "fieldName": "disabled",
8364
+ "default": "''",
8365
+ "description": "The title of the card - part of header section",
8366
+ "fieldName": "cardTitle",
8371
8367
  "inheritedFrom": {
8372
- "name": "DisabledMixin",
8373
- "module": "src/utils/mixins/DisabledMixin.ts"
8368
+ "name": "Card",
8369
+ "module": "src/components/card/card.component.ts"
8374
8370
  }
8375
8371
  },
8376
8372
  {
8377
- "name": "label",
8373
+ "name": "subtitle",
8378
8374
  "type": {
8379
- "text": "string | undefined"
8375
+ "text": "string"
8380
8376
  },
8381
- "description": "The label of the input field. It is linked to the input field using the `for` attribute.",
8382
- "fieldName": "label",
8377
+ "default": "''",
8378
+ "description": "The subtitle of the card - part of header section",
8379
+ "fieldName": "subtitle",
8383
8380
  "inheritedFrom": {
8384
- "name": "FormfieldWrapper",
8385
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
8381
+ "name": "Card",
8382
+ "module": "src/components/card/card.component.ts"
8386
8383
  }
8387
8384
  },
8388
8385
  {
8389
- "name": "required",
8386
+ "name": "image-src",
8390
8387
  "type": {
8391
- "text": "boolean"
8388
+ "text": "string"
8392
8389
  },
8393
- "default": "false",
8394
- "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
8395
- "fieldName": "required",
8390
+ "default": "''",
8391
+ "description": "The image source URL to render on the card",
8392
+ "fieldName": "imageSrc",
8396
8393
  "inheritedFrom": {
8397
- "name": "FormfieldWrapper",
8398
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
8394
+ "name": "Card",
8395
+ "module": "src/components/card/card.component.ts"
8399
8396
  }
8400
8397
  },
8401
8398
  {
8402
- "name": "id",
8399
+ "name": "image-alt",
8403
8400
  "type": {
8404
8401
  "text": "string"
8405
8402
  },
8406
8403
  "default": "''",
8407
- "description": "The unique id of the input field. It is used to link the input field with the label.",
8408
- "fieldName": "id",
8404
+ "description": "The image alt for accessibility support",
8405
+ "fieldName": "imageAlt",
8409
8406
  "inheritedFrom": {
8410
- "name": "FormfieldWrapper",
8411
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
8407
+ "name": "Card",
8408
+ "module": "src/components/card/card.component.ts"
8412
8409
  }
8413
8410
  },
8414
8411
  {
8415
- "name": "help-text-type",
8412
+ "name": "variant",
8416
8413
  "type": {
8417
- "text": "ValidationType"
8414
+ "text": "CardVariant"
8418
8415
  },
8419
- "description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
8420
- "fieldName": "helpTextType",
8416
+ "description": "The variant of the card. It can either be set to 'border' or 'ghost'",
8417
+ "default": "'border'",
8418
+ "fieldName": "variant",
8421
8419
  "inheritedFrom": {
8422
- "name": "FormfieldWrapper",
8423
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
8420
+ "name": "Card",
8421
+ "module": "src/components/card/card.component.ts"
8424
8422
  }
8425
8423
  },
8426
8424
  {
8427
- "name": "help-text",
8425
+ "name": "orientation",
8428
8426
  "type": {
8429
- "text": "string | undefined"
8427
+ "text": "CardOrientation"
8430
8428
  },
8431
- "description": "The help text that is displayed below the input field.",
8432
- "fieldName": "helpText",
8429
+ "description": "The orientation of the card. It can either be set to 'vertical' or 'horizontal'",
8430
+ "default": "'vertical'",
8431
+ "fieldName": "orientation",
8433
8432
  "inheritedFrom": {
8434
- "name": "FormfieldWrapper",
8435
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
8433
+ "name": "Card",
8434
+ "module": "src/components/card/card.component.ts"
8436
8435
  }
8437
8436
  },
8438
8437
  {
8439
- "name": "toggletip-text",
8438
+ "name": "title-tag-name",
8440
8439
  "type": {
8441
- "text": "string | undefined"
8440
+ "text": "TagNameType"
8442
8441
  },
8443
- "description": "The toggletip text that is displayed when the label is hovered.\nIt is used to provide additional information about the label.",
8444
- "fieldName": "toggletipText",
8442
+ "description": "The tag name for the card title. It supports all the types that `mdc-text` supports",
8443
+ "default": "'span'",
8444
+ "fieldName": "titleTagName",
8445
8445
  "inheritedFrom": {
8446
- "name": "FormfieldWrapper",
8447
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
8446
+ "name": "Card",
8447
+ "module": "src/components/card/card.component.ts"
8448
8448
  }
8449
8449
  },
8450
8450
  {
8451
- "name": "toggletip-placement",
8451
+ "name": "subtitle-tag-name",
8452
8452
  "type": {
8453
- "text": "PopoverPlacement"
8453
+ "text": "TagNameType"
8454
8454
  },
8455
- "description": "The placement of the toggletip that is displayed when the info icon is hovered.",
8456
- "default": "'top'",
8457
- "fieldName": "toggletipPlacement",
8455
+ "description": "The tag name for the subtitle. It supports all the types that `mdc-text` supports",
8456
+ "default": "'span'",
8457
+ "fieldName": "subtitleTagName",
8458
8458
  "inheritedFrom": {
8459
- "name": "FormfieldWrapper",
8460
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
8459
+ "name": "Card",
8460
+ "module": "src/components/card/card.component.ts"
8461
8461
  }
8462
8462
  },
8463
8463
  {
8464
- "name": "info-icon-aria-label",
8464
+ "name": "icon-name",
8465
8465
  "type": {
8466
- "text": "string | undefined"
8466
+ "text": "IconNames | undefined"
8467
8467
  },
8468
- "description": "Aria label for the info icon that is displayed next to the label when `toggletipText` is set.\nThis is used for accessibility purposes to provide a description of the icon.",
8469
- "fieldName": "infoIconAriaLabel",
8468
+ "description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
8469
+ "fieldName": "iconName",
8470
8470
  "inheritedFrom": {
8471
- "name": "FormfieldWrapper",
8472
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
8471
+ "name": "Card",
8472
+ "module": "src/components/card/card.component.ts"
8473
8473
  }
8474
8474
  }
8475
8475
  ],
8476
8476
  "mixins": [
8477
8477
  {
8478
- "name": "FormInternalsMixin",
8479
- "module": "/src/utils/mixins/FormInternalsMixin"
8478
+ "name": "DisabledMixin",
8479
+ "module": "/src/utils/mixins/DisabledMixin"
8480
8480
  },
8481
8481
  {
8482
- "name": "DataAriaLabelMixin",
8483
- "module": "/src/utils/mixins/DataAriaLabelMixin"
8482
+ "name": "TabIndexMixin",
8483
+ "module": "/src/utils/mixins/TabIndexMixin"
8484
8484
  }
8485
8485
  ],
8486
8486
  "superclass": {
8487
- "name": "FormfieldWrapper",
8488
- "module": "/src/components/formfieldwrapper/formfieldwrapper.component"
8487
+ "name": "Card",
8488
+ "module": "/src/components/card/card.component"
8489
8489
  },
8490
- "tagName": "mdc-checkbox",
8491
- "jsDoc": "/**\n * Checkboxes allow users to select multiple options from a list or turn an item/feature on or off.\n * These are often used in forms, settings, and selections in lists.\n *\n * A checkbox component contains an optional label and an optional helper text.\n *\n * To create a group of checkboxes, use the FormFieldGroup component.\n *\n * @dependency mdc-button\n * @dependency mdc-icon\n * @dependency mdc-staticcheckbox\n * @dependency mdc-text\n * @dependency mdc-toggletip\n *\n * @tagname mdc-checkbox\n *\n * @event change - (React: onChange) Event that gets dispatched when the checkbox state changes.\n * @event focus - (React: onFocus) Event that gets dispatched when the checkbox receives focus.\n *\n * @cssproperty --mdc-checkbox-background-color-hover - Allows customization of the background color on hover.\n * @cssproperty --mdc-checkbox-checked-background-color-hover - Background color for a selected checkbox when hovered.\n * @cssproperty --mdc-checkbox-checked-pressed-icon-color - Background color for a selected checkbox when pressed.\n * @cssproperty --mdc-checkbox-pressed-icon-color - Background color for a selected checkbox when pressed.\n * @cssproperty --mdc-checkbox-disabled-checked-icon-color - Background color for a selected checkbox when disabled.\n */",
8490
+ "tagName": "mdc-cardradio",
8491
+ "jsDoc": "/**\n * cardradio component extends `mdc-card` and supports radio selection interaction addtionally.\n *\n * While using this component within a form or group of cards, make sure cards are in a role = \"radio-group\".\n * This card would have events for selected and unselected (similar to radio)\n *\n * **Note**: This is a single selection card i.e. interacting anywhere on the card would toggle the checked state.\n * Make sure to pass only non-interactable elements within the slots.\n *\n * Make sure to pass the `card-title` mandatorily for this card.\n *\n * @tagname mdc-cardradio\n *\n * @dependency mdc-icon\n * @dependency mdc-staticradio\n * @dependency mdc-text\n *\n * @slot before-body - This slot is for passing the content before the body\n * @slot body - This slot is for passing the text content for the card\n * @slot after-body - This slot is for passing the content after the body\n * @slot footer-link - This slot is for passing `mdc-link` component within the footer section.\n * @slot footer-button-primary - This slot is for passing primary variant of `mdc-button` component within the footer section.\n *\n * @csspart header - The header part of the card\n * @csspart icon - The icon part of the card header\n * @csspart body - The body part of the card\n * @csspart image - The image part of the card\n * @csspart footer - The footer part of the card\n * @csspart footer-link - The link part of the card footer\n * @csspart footer-button-primary - The primary button part of the card footer\n * @csspart footer-button-secondary - The secondary button part of the card footer\n * @csspart icon-button - The icon button part of the card header\n * @csspart text - The text part of the card\n * @csspart check - The check part of the card\n * @csspart check-icon - The check icon part of the card\n * @csspart check-icon-button - The check icon button part of the card\n *\n * @cssproperty --mdc-card-width - The width of the card\n *\n * @event click - (React: onClick) Event that gets dispatched when the card is clicked. It toggles the checked state.\n * @event keydown - (React: onKeyDown) This event is dispatched when a key is pressed down on the card.\n * It toggles the checked state when enter key is used.\n * @event keyup - (React: onKeyUp) This event is dispatched when a key is released on the card.\n * It toggles the checked state when space key is used.\n * @event change - (React: onChange) Event that gets dispatched when the card state changes.\n * @event focus - (React: onFocus) Event that gets dispatched when the card receives focus.\n *\n */",
8492
8492
  "customElement": true
8493
8493
  }
8494
8494
  ],
@@ -8497,8 +8497,8 @@
8497
8497
  "kind": "js",
8498
8498
  "name": "default",
8499
8499
  "declaration": {
8500
- "name": "Checkbox",
8501
- "module": "components/checkbox/checkbox.component.js"
8500
+ "name": "CardRadio",
8501
+ "module": "components/cardradio/cardradio.component.js"
8502
8502
  }
8503
8503
  }
8504
8504
  ]