@momentum-design/components 0.112.2 → 0.112.3

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",
@@ -1556,236 +1768,24 @@
1556
1768
  },
1557
1769
  {
1558
1770
  "kind": "javascript-module",
1559
- "path": "components/animation/animation.component.js",
1771
+ "path": "components/appheader/appheader.component.js",
1560
1772
  "declarations": [
1561
1773
  {
1562
1774
  "kind": "class",
1563
- "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.",
1564
- "name": "Animation",
1565
- "members": [
1775
+ "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**.",
1776
+ "name": "Appheader",
1777
+ "cssParts": [
1566
1778
  {
1567
- "kind": "field",
1568
- "name": "name",
1569
- "type": {
1570
- "text": "AnimationNames | undefined"
1571
- },
1572
- "description": "Name of the animation (= filename)",
1573
- "attribute": "name",
1574
- "reflects": true
1779
+ "description": "The main container for styling the header.",
1780
+ "name": "container"
1575
1781
  },
1576
1782
  {
1577
- "kind": "field",
1578
- "name": "loop",
1579
- "type": {
1580
- "text": "LoopType | undefined"
1581
- },
1582
- "description": "How many times to loop the animation\n- \"true\" - infinite\n- \"false\" - no loop\n- number - number of times to loop",
1583
- "attribute": "loop",
1584
- "reflects": true
1783
+ "description": "The leading section of the header.",
1784
+ "name": "leading-section"
1585
1785
  },
1586
1786
  {
1587
- "kind": "field",
1588
- "name": "autoplay",
1589
- "type": {
1590
- "text": "boolean | undefined"
1591
- },
1592
- "description": "Weather start the animation automatically",
1593
- "attribute": "autoplay",
1594
- "reflects": true
1595
- },
1596
- {
1597
- "kind": "field",
1598
- "name": "ariaLabel",
1599
- "type": {
1600
- "text": "string | null"
1601
- },
1602
- "default": "null",
1603
- "description": "Aria-label attribute to be set for accessibility",
1604
- "attribute": "aria-label"
1605
- },
1606
- {
1607
- "kind": "field",
1608
- "name": "ariaLabelledBy",
1609
- "type": {
1610
- "text": "string | null"
1611
- },
1612
- "default": "null",
1613
- "description": "Aria-labelledby attribute to be set for accessibility",
1614
- "attribute": "aria-labelledby"
1615
- },
1616
- {
1617
- "kind": "field",
1618
- "name": "lottieInstance",
1619
- "type": {
1620
- "text": "AnimationItem | undefined"
1621
- },
1622
- "privacy": "private",
1623
- "description": "Lottie animation instance"
1624
- },
1625
- {
1626
- "kind": "field",
1627
- "name": "containerRef",
1628
- "type": {
1629
- "text": "Ref<HTMLDivElement>"
1630
- },
1631
- "privacy": "private",
1632
- "description": "Container for the animation"
1633
- },
1634
- {
1635
- "kind": "field",
1636
- "name": "animation",
1637
- "description": "Exposed API of the animation library (lottie)",
1638
- "readonly": true
1639
- },
1640
- {
1641
- "kind": "method",
1642
- "name": "getLoopValue",
1643
- "privacy": "private"
1644
- },
1645
- {
1646
- "kind": "method",
1647
- "name": "onLoadSuccessHandler",
1648
- "privacy": "private",
1649
- "parameters": [
1650
- {
1651
- "name": "animationData",
1652
- "type": {
1653
- "text": "any"
1654
- }
1655
- }
1656
- ],
1657
- "description": "Create new lotty instance for the loaded data"
1658
- },
1659
- {
1660
- "kind": "method",
1661
- "name": "onLoadFailHandler",
1662
- "privacy": "private",
1663
- "parameters": [
1664
- {
1665
- "name": "error",
1666
- "type": {
1667
- "text": "Error"
1668
- }
1669
- }
1670
- ],
1671
- "description": "Error handler for animation loading"
1672
- },
1673
- {
1674
- "kind": "method",
1675
- "name": "getAnimationData",
1676
- "privacy": "private",
1677
- "description": "Import animation data dynamically"
1678
- },
1679
- {
1680
- "kind": "field",
1681
- "name": "onCompleteHandler",
1682
- "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."
1683
- }
1684
- ],
1685
- "events": [
1686
- {
1687
- "name": "load",
1688
- "type": {
1689
- "text": "CustomEvent"
1690
- },
1691
- "description": "(React: onLoad) This event is dispatched when the animation is loaded",
1692
- "reactName": "onLoad"
1693
- },
1694
- {
1695
- "description": "(React: onComplete) This event is dispatched when all animation loops completed",
1696
- "name": "complete",
1697
- "reactName": "onComplete"
1698
- },
1699
- {
1700
- "description": "(React: onError) This event is dispatched when animation loading failed",
1701
- "name": "error",
1702
- "reactName": "onError"
1703
- }
1704
- ],
1705
- "attributes": [
1706
- {
1707
- "name": "name",
1708
- "type": {
1709
- "text": "AnimationNames | undefined"
1710
- },
1711
- "description": "Name of the animation (= filename)",
1712
- "fieldName": "name"
1713
- },
1714
- {
1715
- "name": "loop",
1716
- "type": {
1717
- "text": "LoopType | undefined"
1718
- },
1719
- "description": "How many times to loop the animation\n- \"true\" - infinite\n- \"false\" - no loop\n- number - number of times to loop",
1720
- "fieldName": "loop"
1721
- },
1722
- {
1723
- "name": "autoplay",
1724
- "type": {
1725
- "text": "boolean | undefined"
1726
- },
1727
- "description": "Weather start the animation automatically",
1728
- "fieldName": "autoplay"
1729
- },
1730
- {
1731
- "name": "aria-label",
1732
- "type": {
1733
- "text": "string | null"
1734
- },
1735
- "default": "null",
1736
- "description": "Aria-label attribute to be set for accessibility",
1737
- "fieldName": "ariaLabel"
1738
- },
1739
- {
1740
- "name": "aria-labelledby",
1741
- "type": {
1742
- "text": "string | null"
1743
- },
1744
- "default": "null",
1745
- "description": "Aria-labelledby attribute to be set for accessibility",
1746
- "fieldName": "ariaLabelledBy"
1747
- }
1748
- ],
1749
- "superclass": {
1750
- "name": "Component",
1751
- "module": "/src/models"
1752
- },
1753
- "tagName": "mdc-animation",
1754
- "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 */",
1755
- "customElement": true
1756
- }
1757
- ],
1758
- "exports": [
1759
- {
1760
- "kind": "js",
1761
- "name": "default",
1762
- "declaration": {
1763
- "name": "Animation",
1764
- "module": "components/animation/animation.component.js"
1765
- }
1766
- }
1767
- ]
1768
- },
1769
- {
1770
- "kind": "javascript-module",
1771
- "path": "components/appheader/appheader.component.js",
1772
- "declarations": [
1773
- {
1774
- "kind": "class",
1775
- "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**.",
1776
- "name": "Appheader",
1777
- "cssParts": [
1778
- {
1779
- "description": "The main container for styling the header.",
1780
- "name": "container"
1781
- },
1782
- {
1783
- "description": "The leading section of the header.",
1784
- "name": "leading-section"
1785
- },
1786
- {
1787
- "description": "The center section of the header.",
1788
- "name": "center-section"
1787
+ "description": "The center section of the header.",
1788
+ "name": "center-section"
1789
1789
  },
1790
1790
  {
1791
1791
  "description": "The trailing section of the header.",
@@ -2095,218 +2095,156 @@
2095
2095
  },
2096
2096
  {
2097
2097
  "kind": "javascript-module",
2098
- "path": "components/badge/badge.component.js",
2098
+ "path": "components/avatarbutton/avatarbutton.component.js",
2099
2099
  "declarations": [
2100
2100
  {
2101
2101
  "kind": "class",
2102
- "description": "The `mdc-badge` component is a versatile UI element used to\ndisplay dot, icons, counters, success, warning and error type badge.\n\nSupported badge types:\n- `dot`: Displays a dot notification badge with a blue color.\n- `icon`: Displays a badge with a specified icon using the `icon-name` attribute.\n- `counter`: Displays a badge with a counter value. If the counter exceeds the `max-counter`,\nit shows `maxCounter+`. The maximum value of the counter is 999 and anything above that will be set to `999+`.\n- `success`: Displays a success badge with a check circle icon and green color.\n- `warning`: Displays a warning badge with a warning icon and yellow color.\n- `error`: Displays a error badge with a error legacy icon and red color.\n\nFor `icon`, `success`, `warning` and `error` types, the `mdc-icon` component is used to render the icon.\n\nFor the `counter` type, the `mdc-text` component is used to render the counter value.",
2103
- "name": "Badge",
2102
+ "description": "The `mdc-avatarbutton` component is an interactable version of the `mdc-avatar` component.\n\nThis component is made by extending `buttonsimple` class.\nThe button component acts as a wrapper for the avatar component.\n\nTo override styles of the avatar inside, use the specified css parts.",
2103
+ "name": "AvatarButton",
2104
2104
  "cssProperties": [
2105
2105
  {
2106
- "description": "The foreground color of the primary badge.",
2107
- "name": "--mdc-badge-primary-foreground-color"
2108
- },
2109
- {
2110
- "description": "The background color of the primary badge.",
2111
- "name": "--mdc-badge-primary-background-color"
2112
- },
2113
- {
2114
- "description": "The foreground color of the secondary badge.",
2115
- "name": "--mdc-badge-secondary-foreground-color"
2106
+ "description": "Background color of the overlay in rest state",
2107
+ "name": "--mdc-avatarbutton-overlay-background-color-rest"
2116
2108
  },
2117
2109
  {
2118
- "description": "The background color of the secondary badge.",
2119
- "name": "--mdc-badge-secondary-background-color"
2110
+ "description": "Background color of the overlay in hover state",
2111
+ "name": "--mdc-avatarbutton-overlay-background-color-hover"
2120
2112
  },
2121
2113
  {
2122
- "description": "The foreground color of the success badge.",
2123
- "name": "--mdc-badge-success-foreground-color"
2124
- },
2114
+ "description": "Background color of the overlay in active state",
2115
+ "name": "--mdc-avatarbutton-overlay-background-color-active"
2116
+ }
2117
+ ],
2118
+ "cssParts": [
2125
2119
  {
2126
- "description": "The background color of the success badge.",
2127
- "name": "--mdc-badge-success-background-color"
2120
+ "description": "The overlay part of the avatar button.",
2121
+ "name": "overlay"
2128
2122
  },
2129
2123
  {
2130
- "description": "The foreground color of the warning badge.",
2131
- "name": "--mdc-badge-warning-foreground-color"
2124
+ "description": "The main content of the avatar.",
2125
+ "name": "content"
2132
2126
  },
2133
2127
  {
2134
- "description": "The background color of the warning badge.",
2135
- "name": "--mdc-badge-warning-background-color"
2128
+ "description": "The photo part of the avatar.",
2129
+ "name": "photo"
2136
2130
  },
2137
2131
  {
2138
- "description": "The foreground color of the error badge.",
2139
- "name": "--mdc-badge-error-foreground-color"
2132
+ "description": "The presence indicator part of the avatar.",
2133
+ "name": "presence"
2140
2134
  },
2141
2135
  {
2142
- "description": "The background color of the error badge.",
2143
- "name": "--mdc-badge-error-background-color"
2136
+ "description": "The wrapper for the loading indicator of the avatar.",
2137
+ "name": "loading-wrapper"
2144
2138
  },
2145
2139
  {
2146
- "description": "The background color of the badge overlay.",
2147
- "name": "--mdc-badge-overlay-background-color"
2140
+ "description": "The loading indicator part of the avatar.",
2141
+ "name": "loader"
2148
2142
  }
2149
2143
  ],
2150
2144
  "members": [
2151
2145
  {
2152
2146
  "kind": "field",
2153
- "name": "type",
2147
+ "name": "ariaLabel",
2154
2148
  "type": {
2155
- "text": "BadgeType | undefined"
2149
+ "text": "string | null"
2156
2150
  },
2157
- "description": "Type of the badge\nCan be `dot` (notification) , `icon`, `counter`, `success`, `warning` or `error`.",
2158
- "attribute": "type",
2159
- "reflects": true
2151
+ "default": "null",
2152
+ "description": "Aria-label attribute to be set for accessibility",
2153
+ "attribute": "aria-label"
2160
2154
  },
2161
2155
  {
2162
- "kind": "field",
2163
- "name": "variant",
2164
- "type": {
2165
- "text": "IconVariant"
2166
- },
2167
- "description": "Type of the variant can be `primary` or `secondary`.\nIt defines the background and foreground color of the icon.",
2168
- "default": "primary",
2169
- "attribute": "variant",
2170
- "reflects": true
2156
+ "kind": "method",
2157
+ "name": "setSize",
2158
+ "privacy": "private",
2159
+ "parameters": [
2160
+ {
2161
+ "name": "size",
2162
+ "type": {
2163
+ "text": "AvatarSize"
2164
+ }
2165
+ }
2166
+ ]
2171
2167
  },
2172
2168
  {
2173
2169
  "kind": "field",
2174
- "name": "counter",
2170
+ "name": "src",
2175
2171
  "type": {
2176
- "text": "number | undefined"
2172
+ "text": "string | undefined"
2177
2173
  },
2178
- "description": "Counter is the number which can be provided in the badge.",
2179
- "attribute": "counter"
2174
+ "description": "The src is the url which will be used to display the avatar.\nWhen the src is loading, we will display the initials as a placeholder.",
2175
+ "attribute": "src",
2176
+ "inheritedFrom": {
2177
+ "name": "AvatarComponentMixin",
2178
+ "module": "utils/mixins/AvatarComponentMixin.js"
2179
+ }
2180
2180
  },
2181
2181
  {
2182
2182
  "kind": "field",
2183
- "name": "maxCounter",
2183
+ "name": "initials",
2184
2184
  "type": {
2185
- "text": "number"
2185
+ "text": "string | undefined"
2186
2186
  },
2187
- "description": "The maximum number can be set up to 999, anything above that will be rendered as _999+_.\nThe max counter can be `9`, `99` or `999`.",
2188
- "default": "99",
2189
- "attribute": "max-counter",
2190
- "reflects": true
2187
+ "description": "The initials to be displayed for the avatar.",
2188
+ "attribute": "initials",
2189
+ "inheritedFrom": {
2190
+ "name": "AvatarComponentMixin",
2191
+ "module": "utils/mixins/AvatarComponentMixin.js"
2192
+ }
2191
2193
  },
2192
2194
  {
2193
2195
  "kind": "field",
2194
- "name": "overlay",
2196
+ "name": "presence",
2195
2197
  "type": {
2196
- "text": "boolean"
2198
+ "text": "PresenceType | undefined"
2197
2199
  },
2198
- "default": "false",
2199
- "description": "Overlay is to add a thin outline to the badge.\nThis will help distinguish between the badge and the button,\nwhere the badge will be layered on top of a button.",
2200
- "attribute": "overlay"
2200
+ "description": "The presence is the status which can be used to display the\nactivity state of a user or a space within an avatar component.\n\nAcceptable values include:\n- `active`\n- `away`\n- `away-calling`\n- `busy`\n- `dnd`\n- `meeting`\n- `on-call`\n- `on-device`\n- `on-mobile`\n- `pause`\n- `pto`\n- `presenting`\n- `quiet`\n- `scheduled`",
2201
+ "attribute": "presence",
2202
+ "inheritedFrom": {
2203
+ "name": "AvatarComponentMixin",
2204
+ "module": "utils/mixins/AvatarComponentMixin.js"
2205
+ }
2201
2206
  },
2202
2207
  {
2203
2208
  "kind": "field",
2204
- "name": "ariaLabel",
2209
+ "name": "size",
2205
2210
  "type": {
2206
- "text": "string | null"
2207
- },
2208
- "default": "null",
2209
- "description": "Aria-label attribute to be set for accessibility",
2210
- "attribute": "aria-label"
2211
- },
2212
- {
2213
- "kind": "method",
2214
- "name": "getCounterText",
2215
- "privacy": "private",
2216
- "return": {
2217
- "type": {
2218
- "text": ""
2219
- }
2220
- },
2221
- "parameters": [
2222
- {
2223
- "name": "maxCounter",
2224
- "type": {
2225
- "text": "number"
2226
- },
2227
- "description": "the maximum limit which can be displayed on the badge"
2228
- },
2229
- {
2230
- "name": "counter",
2231
- "optional": true,
2232
- "type": {
2233
- "text": "number"
2234
- },
2235
- "description": "the number to be displayed on the badge"
2236
- }
2237
- ],
2238
- "description": "If `type` is set to `counter` and if `counter` is greater than `maxCounter`,\nthen it will return a string the maxCounter value as string.\nOtherwise, it will return a string representation of `counter`.\nIf `counter` is not a number, it will return an empty string."
2239
- },
2240
- {
2241
- "kind": "method",
2242
- "name": "getBadgeIcon",
2243
- "privacy": "private",
2244
- "return": {
2245
- "type": {
2246
- "text": ""
2247
- }
2248
- },
2249
- "parameters": [
2250
- {
2251
- "name": "iconName",
2252
- "type": {
2253
- "text": "string"
2254
- },
2255
- "description": "the name of the icon from the icon set"
2256
- },
2257
- {
2258
- "name": "backgroundClassPostfix",
2259
- "type": {
2260
- "text": "string"
2261
- },
2262
- "description": "postfix for the class to style the badge icon."
2263
- }
2264
- ],
2265
- "description": "Method to generate the badge icon."
2266
- },
2267
- {
2268
- "kind": "method",
2269
- "name": "getBadgeDot",
2270
- "privacy": "private",
2271
- "return": {
2272
- "type": {
2273
- "text": ""
2274
- }
2275
- },
2276
- "description": "Method to generate the badge dot template."
2277
- },
2278
- {
2279
- "kind": "method",
2280
- "name": "getBadgeCounterText",
2281
- "privacy": "private",
2282
- "return": {
2283
- "type": {
2284
- "text": ""
2285
- }
2211
+ "text": "ButtonSize"
2286
2212
  },
2287
- "description": "Method to generate the badge text and counter template."
2213
+ "description": "Acceptable values include (size in px unit):\n- 24\n- 32\n- 48\n- 64\n- 72\n- 88\n- 124",
2214
+ "default": "32",
2215
+ "attribute": "size",
2216
+ "reflects": true,
2217
+ "inheritedFrom": {
2218
+ "name": "Buttonsimple",
2219
+ "module": "components/buttonsimple/buttonsimple.component.js"
2220
+ }
2288
2221
  },
2289
2222
  {
2290
- "kind": "method",
2291
- "name": "setRoleByAriaLabel",
2292
- "privacy": "private",
2293
- "return": {
2294
- "type": {
2295
- "text": "void"
2296
- }
2223
+ "kind": "field",
2224
+ "name": "counter",
2225
+ "type": {
2226
+ "text": "number | undefined"
2297
2227
  },
2298
- "description": "Method to set the role based on the aria-label provided.\nIf the aria-label is provided, the role of the element will be 'img'.\nOtherwise, the role will be null."
2228
+ "description": "The counter is the number which can be displayed on the avatar.\nThe maximum number is 99 and if the given number is greater than 99,\nthen the avatar will be displayed as `99+`.\nIf the given number is a negative number,\nthen the avatar will be displayed as `0`.",
2229
+ "attribute": "counter",
2230
+ "inheritedFrom": {
2231
+ "name": "AvatarComponentMixin",
2232
+ "module": "utils/mixins/AvatarComponentMixin.js"
2233
+ }
2299
2234
  },
2300
2235
  {
2301
- "kind": "method",
2302
- "name": "getBadgeContentBasedOnType",
2303
- "privacy": "private",
2304
- "return": {
2305
- "type": {
2306
- "text": ""
2307
- }
2236
+ "kind": "field",
2237
+ "name": "isTyping",
2238
+ "type": {
2239
+ "text": "boolean"
2308
2240
  },
2309
- "description": "Generates the badge content based on the badge type.\nUtilizes various helper methods to create the appropriate badge template based on the\ncurrent badge type. Supports 'dot', 'icon', 'counter', 'success', 'warning', and 'error'\ntypes, returning the corresponding template result for each type."
2241
+ "default": "false",
2242
+ "description": "Represents the typing indicator when the user is typing.",
2243
+ "attribute": "is-typing",
2244
+ "inheritedFrom": {
2245
+ "name": "AvatarComponentMixin",
2246
+ "module": "utils/mixins/AvatarComponentMixin.js"
2247
+ }
2310
2248
  },
2311
2249
  {
2312
2250
  "kind": "field",
@@ -2320,858 +2258,876 @@
2320
2258
  "name": "IconNameMixin",
2321
2259
  "module": "utils/mixins/IconNameMixin.js"
2322
2260
  }
2323
- }
2324
- ],
2325
- "attributes": [
2261
+ },
2326
2262
  {
2327
- "name": "type",
2263
+ "kind": "field",
2264
+ "name": "autoFocusOnMount",
2328
2265
  "type": {
2329
- "text": "BadgeType | undefined"
2266
+ "text": "boolean"
2330
2267
  },
2331
- "description": "Type of the badge\nCan be `dot` (notification) , `icon`, `counter`, `success`, `warning` or `error`.",
2332
- "fieldName": "type"
2268
+ "default": "false",
2269
+ "description": "This property indicates whether the element should receive focus automatically when it is mounted.\n\nIt will not focus if the element is re-attached to the DOM after being removed.",
2270
+ "attribute": "auto-focus-on-mount",
2271
+ "reflects": true,
2272
+ "inheritedFrom": {
2273
+ "name": "AutoFocusOnMountMixin",
2274
+ "module": "utils/mixins/AutoFocusOnMountMixin.js"
2275
+ }
2333
2276
  },
2334
2277
  {
2335
- "name": "variant",
2278
+ "kind": "field",
2279
+ "name": "tabIndex",
2336
2280
  "type": {
2337
- "text": "IconVariant"
2281
+ "text": "number"
2338
2282
  },
2339
- "description": "Type of the variant can be `primary` or `secondary`.\nIt defines the background and foreground color of the icon.",
2340
- "default": "primary",
2341
- "fieldName": "variant"
2283
+ "default": "0",
2284
+ "description": "This property specifies the tab order of the element.",
2285
+ "attribute": "tabIndex",
2286
+ "reflects": true,
2287
+ "inheritedFrom": {
2288
+ "name": "TabIndexMixin",
2289
+ "module": "utils/mixins/TabIndexMixin.js"
2290
+ }
2342
2291
  },
2343
2292
  {
2344
- "name": "counter",
2293
+ "kind": "field",
2294
+ "name": "disabled",
2345
2295
  "type": {
2346
- "text": "number | undefined"
2296
+ "text": "boolean | undefined"
2347
2297
  },
2348
- "description": "Counter is the number which can be provided in the badge.",
2349
- "fieldName": "counter"
2298
+ "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
2299
+ "default": "undefined",
2300
+ "attribute": "disabled",
2301
+ "reflects": true,
2302
+ "inheritedFrom": {
2303
+ "name": "DisabledMixin",
2304
+ "module": "utils/mixins/DisabledMixin.js"
2305
+ }
2350
2306
  },
2351
2307
  {
2352
- "name": "max-counter",
2308
+ "kind": "field",
2309
+ "name": "active",
2353
2310
  "type": {
2354
- "text": "number"
2311
+ "text": "boolean | undefined"
2355
2312
  },
2356
- "description": "The maximum number can be set up to 999, anything above that will be rendered as _999+_.\nThe max counter can be `9`, `99` or `999`.",
2357
- "default": "99",
2358
- "fieldName": "maxCounter"
2313
+ "description": "The button's active state indicates whether it is currently toggled on (active) or off (inactive).\nWhen the active state is true, the button is considered to be in an active state, meaning it is toggled on.\nConversely, when the active state is false, the button is in an inactive state, indicating it is toggled off.\n\nThis attribute is used to set the provided `ariaStateKey` to true or false.",
2314
+ "default": "undefined",
2315
+ "attribute": "active",
2316
+ "reflects": true,
2317
+ "inheritedFrom": {
2318
+ "name": "Buttonsimple",
2319
+ "module": "components/buttonsimple/buttonsimple.component.js"
2320
+ }
2359
2321
  },
2360
2322
  {
2361
- "name": "overlay",
2323
+ "kind": "field",
2324
+ "name": "softDisabled",
2362
2325
  "type": {
2363
- "text": "boolean"
2326
+ "text": "boolean | undefined"
2364
2327
  },
2365
- "default": "false",
2366
- "description": "Overlay is to add a thin outline to the badge.\nThis will help distinguish between the badge and the button,\nwhere the badge will be layered on top of a button.",
2367
- "fieldName": "overlay"
2328
+ "description": "Indicates whether the button is soft disabled.\nWhen set to `true`, the button appears visually disabled but still allows\nfocus, click, and keyboard actions to be passed through.\n\n**Important:** When using soft disabled, consumers must ensure that\nthe button behaves like a disabled button, allowing only focus and\npreventing any interactions (clicks or keyboard actions) from triggering unintended actions.",
2329
+ "default": "undefined",
2330
+ "attribute": "soft-disabled",
2331
+ "reflects": true,
2332
+ "inheritedFrom": {
2333
+ "name": "Buttonsimple",
2334
+ "module": "components/buttonsimple/buttonsimple.component.js"
2335
+ }
2368
2336
  },
2369
2337
  {
2370
- "name": "aria-label",
2338
+ "kind": "field",
2339
+ "name": "role",
2371
2340
  "type": {
2372
- "text": "string | null"
2341
+ "text": "RoleType"
2373
2342
  },
2374
- "default": "null",
2375
- "description": "Aria-label attribute to be set for accessibility",
2376
- "fieldName": "ariaLabel"
2343
+ "description": "This property defines the ARIA role for the element. By default, it is set to 'button'.\nConsumers should override this role when:\n- The element is being used in a context where a different role is more appropriate.\n- Custom behaviors are implemented that require a specific ARIA role for accessibility purposes.",
2344
+ "default": "button",
2345
+ "attribute": "role",
2346
+ "reflects": true,
2347
+ "inheritedFrom": {
2348
+ "name": "Buttonsimple",
2349
+ "module": "components/buttonsimple/buttonsimple.component.js"
2350
+ }
2377
2351
  },
2378
2352
  {
2379
- "name": "icon-name",
2353
+ "kind": "field",
2354
+ "name": "ariaStateKey",
2380
2355
  "type": {
2381
- "text": "IconNames | undefined"
2356
+ "text": "string | undefined"
2382
2357
  },
2383
- "description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
2384
- "fieldName": "iconName",
2358
+ "description": "This property defines the ARIA state key, which will be toggled when the\nButton is set to `active`.\nThe default value is 'aria-pressed', which is commonly used for toggle buttons.\n\nConsumers can override this property to use a different ARIA state key if needed.\nIn case multiple aria attributes should be toggled, they can be passed in as\na comma separated string.\nFor example: `aria-pressed,aria-expanded`",
2359
+ "default": "'aria-pressed' (when)",
2360
+ "attribute": "ariaStateKey",
2361
+ "reflects": true,
2385
2362
  "inheritedFrom": {
2386
- "name": "IconNameMixin",
2387
- "module": "src/utils/mixins/IconNameMixin.ts"
2363
+ "name": "Buttonsimple",
2364
+ "module": "components/buttonsimple/buttonsimple.component.js"
2388
2365
  }
2389
- }
2390
- ],
2391
- "mixins": [
2392
- {
2393
- "name": "IconNameMixin",
2394
- "module": "/src/utils/mixins/IconNameMixin"
2395
- }
2396
- ],
2397
- "superclass": {
2398
- "name": "Component",
2399
- "module": "/src/models"
2400
- },
2401
- "tagName": "mdc-badge",
2402
- "jsDoc": "/**\n * The `mdc-badge` component is a versatile UI element used to\n * display dot, icons, counters, success, warning and error type badge.\n *\n * Supported badge types:\n * - `dot`: Displays a dot notification badge with a blue color.\n * - `icon`: Displays a badge with a specified icon using the `icon-name` attribute.\n * - `counter`: Displays a badge with a counter value. If the counter exceeds the `max-counter`,\n * it shows `maxCounter+`. The maximum value of the counter is 999 and anything above that will be set to `999+`.\n * - `success`: Displays a success badge with a check circle icon and green color.\n * - `warning`: Displays a warning badge with a warning icon and yellow color.\n * - `error`: Displays a error badge with a error legacy icon and red color.\n *\n * For `icon`, `success`, `warning` and `error` types, the `mdc-icon` component is used to render the icon.\n *\n * For the `counter` type, the `mdc-text` component is used to render the counter value.\n *\n * @dependency mdc-icon\n * @dependency mdc-text\n *\n * @tagname mdc-badge\n *\n * @cssproperty --mdc-badge-primary-foreground-color - The foreground color of the primary badge.\n * @cssproperty --mdc-badge-primary-background-color - The background color of the primary badge.\n * @cssproperty --mdc-badge-secondary-foreground-color - The foreground color of the secondary badge.\n * @cssproperty --mdc-badge-secondary-background-color - The background color of the secondary badge.\n * @cssproperty --mdc-badge-success-foreground-color - The foreground color of the success badge.\n * @cssproperty --mdc-badge-success-background-color - The background color of the success badge.\n * @cssproperty --mdc-badge-warning-foreground-color - The foreground color of the warning badge.\n * @cssproperty --mdc-badge-warning-background-color - The background color of the warning badge.\n * @cssproperty --mdc-badge-error-foreground-color - The foreground color of the error badge.\n * @cssproperty --mdc-badge-error-background-color - The background color of the error badge.\n * @cssproperty --mdc-badge-overlay-background-color - The background color of the badge overlay.\n */",
2403
- "customElement": true
2404
- }
2405
- ],
2406
- "exports": [
2407
- {
2408
- "kind": "js",
2409
- "name": "default",
2410
- "declaration": {
2411
- "name": "Badge",
2412
- "module": "components/badge/badge.component.js"
2413
- }
2414
- }
2415
- ]
2416
- },
2417
- {
2418
- "kind": "javascript-module",
2419
- "path": "components/brandvisual/brandvisual.component.js",
2420
- "declarations": [
2421
- {
2422
- "kind": "class",
2423
- "description": "The `mdc-brandvisual` component is responsible for rendering logos dynamically & ensures they are\ndisplayed correctly within applications.\n\nFeatures:\n- Dynamically loads brandvisuals based on the `name` attribute.\n- Emits a `load` event when the brandvisual is successfully fetched.\n- Emits an `error` event when the brandvisual import fails.\n- Supports accessibility best practices.\n- Used for brand representation within the design system.",
2424
- "name": "Brandvisual",
2425
- "members": [
2366
+ },
2426
2367
  {
2427
2368
  "kind": "field",
2428
- "name": "brandVisualData",
2369
+ "name": "type",
2429
2370
  "type": {
2430
- "text": "Element | TemplateResult | undefined"
2371
+ "text": "ButtonType"
2431
2372
  },
2432
- "privacy": "private"
2373
+ "description": "This property defines the type attribute for the button element.\nThe type attribute specifies the behavior of the button when it is clicked.\n- **submit**: The button submits the form data to the server.\n- **reset**: The button resets the form data to its initial state.\n- **button**: The button does nothing when clicked.",
2374
+ "default": "button",
2375
+ "attribute": "type",
2376
+ "reflects": true,
2377
+ "inheritedFrom": {
2378
+ "name": "Buttonsimple",
2379
+ "module": "components/buttonsimple/buttonsimple.component.js"
2380
+ }
2433
2381
  },
2434
2382
  {
2435
2383
  "kind": "field",
2436
2384
  "name": "name",
2437
2385
  "type": {
2438
- "text": "BrandVisualNames | undefined"
2386
+ "text": "string | undefined"
2439
2387
  },
2440
- "description": "Name of the brandVisual (= filename)",
2388
+ "description": "The name of the button, submitted as a pair with the button's value as part of the form data,\nwhen that button is used to submit the form.",
2441
2389
  "attribute": "name",
2442
- "reflects": true
2390
+ "reflects": true,
2391
+ "inheritedFrom": {
2392
+ "name": "Buttonsimple",
2393
+ "module": "components/buttonsimple/buttonsimple.component.js"
2394
+ }
2443
2395
  },
2444
2396
  {
2445
2397
  "kind": "field",
2446
- "name": "altText",
2398
+ "name": "value",
2447
2399
  "type": {
2448
2400
  "text": "string | undefined"
2449
2401
  },
2450
- "description": "Alt text for the brandvisual image for accessibility.\nThis will only be set if the brandvisual is an image (png).",
2451
- "attribute": "altText",
2452
- "reflects": true
2402
+ "description": "Defines the value associated with the button's name when it's submitted with the form data.\nThis value is passed to the server in params when the form is submitted using this button.",
2403
+ "attribute": "value",
2404
+ "reflects": true,
2405
+ "inheritedFrom": {
2406
+ "name": "Buttonsimple",
2407
+ "module": "components/buttonsimple/buttonsimple.component.js"
2408
+ }
2453
2409
  },
2454
2410
  {
2455
2411
  "kind": "method",
2456
- "name": "getBrandVisualData",
2457
- "privacy": "private"
2412
+ "name": "executeAction",
2413
+ "privacy": "protected",
2414
+ "inheritedFrom": {
2415
+ "name": "Buttonsimple",
2416
+ "module": "components/buttonsimple/buttonsimple.component.js"
2417
+ }
2458
2418
  },
2459
2419
  {
2460
2420
  "kind": "method",
2461
- "name": "injectTemplateAttributes",
2462
- "privacy": "private",
2463
- "return": {
2464
- "type": {
2465
- "text": "Element | TemplateResult"
2466
- }
2467
- },
2421
+ "name": "setActive",
2422
+ "privacy": "protected",
2468
2423
  "parameters": [
2469
2424
  {
2470
- "name": "litTemplate",
2425
+ "name": "element",
2471
2426
  "type": {
2472
- "text": "TemplateResult"
2473
- }
2427
+ "text": "HTMLElement"
2428
+ },
2429
+ "description": "The button element"
2474
2430
  },
2475
2431
  {
2476
- "name": "tag",
2432
+ "name": "active",
2433
+ "optional": true,
2477
2434
  "type": {
2478
- "text": "string"
2479
- }
2435
+ "text": "boolean"
2436
+ },
2437
+ "description": "The active state of the element"
2438
+ }
2439
+ ],
2440
+ "description": "Sets the ariaStateKey attributes based on the active state of the button.",
2441
+ "inheritedFrom": {
2442
+ "name": "Buttonsimple",
2443
+ "module": "components/buttonsimple/buttonsimple.component.js"
2444
+ }
2445
+ },
2446
+ {
2447
+ "kind": "method",
2448
+ "name": "setSoftDisabled",
2449
+ "privacy": "private",
2450
+ "parameters": [
2451
+ {
2452
+ "name": "element",
2453
+ "type": {
2454
+ "text": "HTMLElement"
2455
+ },
2456
+ "description": "The button element."
2480
2457
  },
2481
2458
  {
2482
- "name": "props",
2459
+ "name": "softDisabled",
2460
+ "optional": true,
2483
2461
  "type": {
2484
- "text": "any"
2485
- }
2462
+ "text": "boolean"
2463
+ },
2464
+ "description": "The soft-disabled state."
2486
2465
  }
2487
- ]
2466
+ ],
2467
+ "description": "Sets the soft-disabled attribute for the button.\nWhen soft-disabled, the button looks to be disabled but remains focusable and clickable.\nAlso sets/removes aria-disabled attribute.",
2468
+ "inheritedFrom": {
2469
+ "name": "Buttonsimple",
2470
+ "module": "components/buttonsimple/buttonsimple.component.js"
2471
+ }
2488
2472
  },
2489
2473
  {
2490
2474
  "kind": "method",
2491
- "name": "injectHtmlAttributes",
2475
+ "name": "setDisabled",
2492
2476
  "privacy": "private",
2493
- "return": {
2494
- "type": {
2495
- "text": "Element"
2496
- }
2497
- },
2498
2477
  "parameters": [
2499
2478
  {
2500
- "name": "html",
2479
+ "name": "element",
2501
2480
  "type": {
2502
- "text": "Element"
2503
- }
2481
+ "text": "HTMLElement"
2482
+ },
2483
+ "description": "The button element."
2504
2484
  },
2505
2485
  {
2506
- "name": "props",
2486
+ "name": "disabled",
2507
2487
  "type": {
2508
- "text": "imageProps"
2509
- }
2488
+ "text": "boolean"
2489
+ },
2490
+ "description": "The disabled state."
2510
2491
  }
2511
- ]
2492
+ ],
2493
+ "description": "Sets the disabled attribute for the button.\nWhen disabled, the button is not focusable or clickable, and tabindex is set to -1.\nThe previous tabindex is stored and restored when enabled.\nAlso sets/removes aria-disabled attribute.",
2494
+ "inheritedFrom": {
2495
+ "name": "Buttonsimple",
2496
+ "module": "components/buttonsimple/buttonsimple.component.js"
2497
+ }
2512
2498
  },
2513
2499
  {
2514
2500
  "kind": "method",
2515
- "name": "handleBrandVisualLoadedSuccess",
2501
+ "name": "triggerClickEvent",
2502
+ "privacy": "private",
2503
+ "inheritedFrom": {
2504
+ "name": "Buttonsimple",
2505
+ "module": "components/buttonsimple/buttonsimple.component.js"
2506
+ }
2507
+ },
2508
+ {
2509
+ "kind": "method",
2510
+ "name": "handleBlur",
2511
+ "privacy": "private",
2512
+ "description": "In case the button is pressed and the focus is lost while pressing,\nthe pressed class is removed.",
2513
+ "inheritedFrom": {
2514
+ "name": "Buttonsimple",
2515
+ "module": "components/buttonsimple/buttonsimple.component.js"
2516
+ }
2517
+ },
2518
+ {
2519
+ "kind": "method",
2520
+ "name": "handleKeyDown",
2516
2521
  "privacy": "private",
2517
2522
  "parameters": [
2518
2523
  {
2519
- "name": "brandVisualHtml",
2524
+ "name": "event",
2520
2525
  "type": {
2521
- "text": "TemplateResult"
2526
+ "text": "KeyboardEvent"
2522
2527
  },
2523
- "description": "The brandvisual html element which has been fetched from the brandvisual provider."
2528
+ "description": "The keyboard event."
2524
2529
  }
2525
2530
  ],
2526
- "description": "Sets the brandVisualData state to the fetched brandvisual.\nDispatches a 'load' event on the component once the brandvisual has been successfully loaded."
2531
+ "description": "Handles the keydown event on the button.\nIf the key is 'Enter' or 'Space', the button is pressed.\nIf the key is 'Enter', the button is pressed. The native HTML button works in the same way.\nIf the key is 'Space', the button's default is prevent to avoid scrolling etc in the host application.",
2532
+ "inheritedFrom": {
2533
+ "name": "Buttonsimple",
2534
+ "module": "components/buttonsimple/buttonsimple.component.js"
2535
+ }
2527
2536
  },
2528
2537
  {
2529
2538
  "kind": "method",
2530
- "name": "handleBrandVisualLoadedFailure",
2539
+ "name": "handleKeyUp",
2531
2540
  "privacy": "private",
2532
2541
  "parameters": [
2533
2542
  {
2534
- "name": "error",
2543
+ "name": "event",
2535
2544
  "type": {
2536
- "text": "unknown"
2537
- }
2545
+ "text": "KeyboardEvent"
2546
+ },
2547
+ "description": "The keyboard event."
2538
2548
  }
2539
2549
  ],
2540
- "description": "Dispatches an 'error' event on the component when the brandvisual import has failed.\nThis event bubbles and is cancelable.\nThe error detail is set to the error object."
2550
+ "description": "Handles the keyup event on the button.\nIf the key is 'Enter' or 'Space', the button is clicked.\nIf the key is 'Space', the button is pressed. The native HTML button works in the same way.",
2551
+ "inheritedFrom": {
2552
+ "name": "Buttonsimple",
2553
+ "module": "components/buttonsimple/buttonsimple.component.js"
2554
+ }
2541
2555
  }
2542
2556
  ],
2543
2557
  "events": [
2544
2558
  {
2545
- "description": "(React: onLoad) This event is dispatched when the brandvisual has been successfully loaded.",
2546
- "name": "load",
2547
- "reactName": "onLoad"
2548
- },
2549
- {
2550
- "description": "(React: onError) This event is dispatched when the brandvisual fetching has failed.",
2551
- "name": "error",
2552
- "reactName": "onError"
2553
- }
2554
- ],
2555
- "attributes": [
2556
- {
2557
- "name": "name",
2558
- "type": {
2559
- "text": "BrandVisualNames | undefined"
2560
- },
2561
- "description": "Name of the brandVisual (= filename)",
2562
- "fieldName": "name"
2563
- },
2564
- {
2565
- "name": "altText",
2566
- "type": {
2567
- "text": "string | undefined"
2568
- },
2569
- "description": "Alt text for the brandvisual image for accessibility.\nThis will only be set if the brandvisual is an image (png).",
2570
- "fieldName": "altText"
2571
- }
2572
- ],
2573
- "superclass": {
2574
- "name": "Component",
2575
- "module": "/src/models"
2576
- },
2577
- "tagName": "mdc-brandvisual",
2578
- "jsDoc": "/**\n * The `mdc-brandvisual` component is responsible for rendering logos dynamically & ensures they are\n * displayed correctly within applications.\n *\n * Features:\n * - Dynamically loads brandvisuals based on the `name` attribute.\n * - Emits a `load` event when the brandvisual is successfully fetched.\n * - Emits an `error` event when the brandvisual import fails.\n * - Supports accessibility best practices.\n * - Used for brand representation within the design system.\n *\n * @tagname mdc-brandvisual\n *\n * @event load - (React: onLoad) This event is dispatched when the brandvisual has been successfully loaded.\n * @event error - (React: onError) This event is dispatched when the brandvisual fetching has failed.\n *\n */",
2579
- "customElement": true
2580
- }
2581
- ],
2582
- "exports": [
2583
- {
2584
- "kind": "js",
2585
- "name": "default",
2586
- "declaration": {
2587
- "name": "Brandvisual",
2588
- "module": "components/brandvisual/brandvisual.component.js"
2589
- }
2590
- }
2591
- ]
2592
- },
2593
- {
2594
- "kind": "javascript-module",
2595
- "path": "components/avatarbutton/avatarbutton.component.js",
2596
- "declarations": [
2597
- {
2598
- "kind": "class",
2599
- "description": "The `mdc-avatarbutton` component is an interactable version of the `mdc-avatar` component.\n\nThis component is made by extending `buttonsimple` class.\nThe button component acts as a wrapper for the avatar component.\n\nTo override styles of the avatar inside, use the specified css parts.",
2600
- "name": "AvatarButton",
2601
- "cssProperties": [
2602
- {
2603
- "description": "Background color of the overlay in rest state",
2604
- "name": "--mdc-avatarbutton-overlay-background-color-rest"
2605
- },
2606
- {
2607
- "description": "Background color of the overlay in hover state",
2608
- "name": "--mdc-avatarbutton-overlay-background-color-hover"
2609
- },
2610
- {
2611
- "description": "Background color of the overlay in active state",
2612
- "name": "--mdc-avatarbutton-overlay-background-color-active"
2613
- }
2614
- ],
2615
- "cssParts": [
2616
- {
2617
- "description": "The overlay part of the avatar button.",
2618
- "name": "overlay"
2619
- },
2620
- {
2621
- "description": "The main content of the avatar.",
2622
- "name": "content"
2623
- },
2624
- {
2625
- "description": "The photo part of the avatar.",
2626
- "name": "photo"
2559
+ "description": "(React: onClick) This event is dispatched when the avatarbutton is clicked.",
2560
+ "name": "click",
2561
+ "reactName": "onClick",
2562
+ "inheritedFrom": {
2563
+ "name": "Buttonsimple",
2564
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
2565
+ }
2627
2566
  },
2628
2567
  {
2629
- "description": "The presence indicator part of the avatar.",
2630
- "name": "presence"
2568
+ "description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the avatarbutton.",
2569
+ "name": "keydown",
2570
+ "reactName": "onKeyDown",
2571
+ "inheritedFrom": {
2572
+ "name": "Buttonsimple",
2573
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
2574
+ }
2631
2575
  },
2632
2576
  {
2633
- "description": "The wrapper for the loading indicator of the avatar.",
2634
- "name": "loading-wrapper"
2577
+ "description": "(React: onKeyUp) This event is dispatched when a key is released on the avatarbutton.",
2578
+ "name": "keyup",
2579
+ "reactName": "onKeyUp",
2580
+ "inheritedFrom": {
2581
+ "name": "Buttonsimple",
2582
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
2583
+ }
2635
2584
  },
2636
2585
  {
2637
- "description": "The loading indicator part of the avatar.",
2638
- "name": "loader"
2586
+ "description": "(React: onFocus) This event is dispatched when the avatarbutton receives focus.",
2587
+ "name": "focus",
2588
+ "reactName": "onFocus",
2589
+ "inheritedFrom": {
2590
+ "name": "Buttonsimple",
2591
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
2592
+ }
2639
2593
  }
2640
2594
  ],
2641
- "members": [
2595
+ "attributes": [
2642
2596
  {
2643
- "kind": "field",
2644
- "name": "ariaLabel",
2597
+ "name": "aria-label",
2645
2598
  "type": {
2646
2599
  "text": "string | null"
2647
2600
  },
2648
2601
  "default": "null",
2649
2602
  "description": "Aria-label attribute to be set for accessibility",
2650
- "attribute": "aria-label"
2651
- },
2652
- {
2653
- "kind": "method",
2654
- "name": "setSize",
2655
- "privacy": "private",
2656
- "parameters": [
2657
- {
2658
- "name": "size",
2659
- "type": {
2660
- "text": "AvatarSize"
2661
- }
2662
- }
2663
- ]
2603
+ "fieldName": "ariaLabel"
2664
2604
  },
2665
2605
  {
2666
- "kind": "field",
2667
2606
  "name": "src",
2668
2607
  "type": {
2669
2608
  "text": "string | undefined"
2670
2609
  },
2671
2610
  "description": "The src is the url which will be used to display the avatar.\nWhen the src is loading, we will display the initials as a placeholder.",
2672
- "attribute": "src",
2611
+ "fieldName": "src",
2673
2612
  "inheritedFrom": {
2674
2613
  "name": "AvatarComponentMixin",
2675
- "module": "utils/mixins/AvatarComponentMixin.js"
2614
+ "module": "src/utils/mixins/AvatarComponentMixin.ts"
2676
2615
  }
2677
2616
  },
2678
2617
  {
2679
- "kind": "field",
2680
2618
  "name": "initials",
2681
2619
  "type": {
2682
2620
  "text": "string | undefined"
2683
2621
  },
2684
2622
  "description": "The initials to be displayed for the avatar.",
2685
- "attribute": "initials",
2623
+ "fieldName": "initials",
2686
2624
  "inheritedFrom": {
2687
2625
  "name": "AvatarComponentMixin",
2688
- "module": "utils/mixins/AvatarComponentMixin.js"
2626
+ "module": "src/utils/mixins/AvatarComponentMixin.ts"
2689
2627
  }
2690
2628
  },
2691
2629
  {
2692
- "kind": "field",
2693
2630
  "name": "presence",
2694
2631
  "type": {
2695
2632
  "text": "PresenceType | undefined"
2696
2633
  },
2697
2634
  "description": "The presence is the status which can be used to display the\nactivity state of a user or a space within an avatar component.\n\nAcceptable values include:\n- `active`\n- `away`\n- `away-calling`\n- `busy`\n- `dnd`\n- `meeting`\n- `on-call`\n- `on-device`\n- `on-mobile`\n- `pause`\n- `pto`\n- `presenting`\n- `quiet`\n- `scheduled`",
2698
- "attribute": "presence",
2635
+ "fieldName": "presence",
2699
2636
  "inheritedFrom": {
2700
2637
  "name": "AvatarComponentMixin",
2701
- "module": "utils/mixins/AvatarComponentMixin.js"
2638
+ "module": "src/utils/mixins/AvatarComponentMixin.ts"
2702
2639
  }
2703
2640
  },
2704
2641
  {
2705
- "kind": "field",
2706
2642
  "name": "size",
2707
2643
  "type": {
2708
2644
  "text": "ButtonSize"
2709
2645
  },
2710
2646
  "description": "Acceptable values include (size in px unit):\n- 24\n- 32\n- 48\n- 64\n- 72\n- 88\n- 124",
2711
2647
  "default": "32",
2712
- "attribute": "size",
2713
- "reflects": true,
2648
+ "fieldName": "size",
2714
2649
  "inheritedFrom": {
2715
2650
  "name": "Buttonsimple",
2716
- "module": "components/buttonsimple/buttonsimple.component.js"
2651
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
2717
2652
  }
2718
2653
  },
2719
2654
  {
2720
- "kind": "field",
2721
2655
  "name": "counter",
2722
2656
  "type": {
2723
2657
  "text": "number | undefined"
2724
2658
  },
2725
2659
  "description": "The counter is the number which can be displayed on the avatar.\nThe maximum number is 99 and if the given number is greater than 99,\nthen the avatar will be displayed as `99+`.\nIf the given number is a negative number,\nthen the avatar will be displayed as `0`.",
2726
- "attribute": "counter",
2660
+ "fieldName": "counter",
2727
2661
  "inheritedFrom": {
2728
2662
  "name": "AvatarComponentMixin",
2729
- "module": "utils/mixins/AvatarComponentMixin.js"
2663
+ "module": "src/utils/mixins/AvatarComponentMixin.ts"
2730
2664
  }
2731
2665
  },
2732
2666
  {
2733
- "kind": "field",
2734
- "name": "isTyping",
2667
+ "name": "is-typing",
2735
2668
  "type": {
2736
2669
  "text": "boolean"
2737
2670
  },
2738
2671
  "default": "false",
2739
2672
  "description": "Represents the typing indicator when the user is typing.",
2740
- "attribute": "is-typing",
2673
+ "fieldName": "isTyping",
2741
2674
  "inheritedFrom": {
2742
2675
  "name": "AvatarComponentMixin",
2743
- "module": "utils/mixins/AvatarComponentMixin.js"
2676
+ "module": "src/utils/mixins/AvatarComponentMixin.ts"
2744
2677
  }
2745
2678
  },
2746
2679
  {
2747
- "kind": "field",
2748
- "name": "iconName",
2680
+ "name": "icon-name",
2749
2681
  "type": {
2750
2682
  "text": "IconNames | undefined"
2751
2683
  },
2752
2684
  "description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
2753
- "attribute": "icon-name",
2685
+ "fieldName": "iconName",
2754
2686
  "inheritedFrom": {
2755
2687
  "name": "IconNameMixin",
2756
- "module": "utils/mixins/IconNameMixin.js"
2688
+ "module": "src/utils/mixins/IconNameMixin.ts"
2757
2689
  }
2758
2690
  },
2759
2691
  {
2760
- "kind": "field",
2761
- "name": "autoFocusOnMount",
2692
+ "name": "auto-focus-on-mount",
2762
2693
  "type": {
2763
2694
  "text": "boolean"
2764
2695
  },
2765
2696
  "default": "false",
2766
2697
  "description": "This property indicates whether the element should receive focus automatically when it is mounted.\n\nIt will not focus if the element is re-attached to the DOM after being removed.",
2767
- "attribute": "auto-focus-on-mount",
2768
- "reflects": true,
2698
+ "fieldName": "autoFocusOnMount",
2769
2699
  "inheritedFrom": {
2770
2700
  "name": "AutoFocusOnMountMixin",
2771
- "module": "utils/mixins/AutoFocusOnMountMixin.js"
2701
+ "module": "src/utils/mixins/AutoFocusOnMountMixin.ts"
2772
2702
  }
2773
2703
  },
2774
2704
  {
2775
- "kind": "field",
2776
2705
  "name": "tabIndex",
2777
2706
  "type": {
2778
2707
  "text": "number"
2779
2708
  },
2780
2709
  "default": "0",
2781
2710
  "description": "This property specifies the tab order of the element.",
2782
- "attribute": "tabIndex",
2783
- "reflects": true,
2711
+ "fieldName": "tabIndex",
2784
2712
  "inheritedFrom": {
2785
2713
  "name": "TabIndexMixin",
2786
- "module": "utils/mixins/TabIndexMixin.js"
2714
+ "module": "src/utils/mixins/TabIndexMixin.ts"
2787
2715
  }
2788
2716
  },
2789
2717
  {
2790
- "kind": "field",
2791
2718
  "name": "disabled",
2792
2719
  "type": {
2793
2720
  "text": "boolean | undefined"
2794
2721
  },
2795
2722
  "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
2796
2723
  "default": "undefined",
2797
- "attribute": "disabled",
2798
- "reflects": true,
2724
+ "fieldName": "disabled",
2799
2725
  "inheritedFrom": {
2800
2726
  "name": "DisabledMixin",
2801
- "module": "utils/mixins/DisabledMixin.js"
2727
+ "module": "src/utils/mixins/DisabledMixin.ts"
2802
2728
  }
2803
2729
  },
2804
2730
  {
2805
- "kind": "field",
2806
2731
  "name": "active",
2807
2732
  "type": {
2808
2733
  "text": "boolean | undefined"
2809
2734
  },
2810
2735
  "description": "The button's active state indicates whether it is currently toggled on (active) or off (inactive).\nWhen the active state is true, the button is considered to be in an active state, meaning it is toggled on.\nConversely, when the active state is false, the button is in an inactive state, indicating it is toggled off.\n\nThis attribute is used to set the provided `ariaStateKey` to true or false.",
2811
2736
  "default": "undefined",
2812
- "attribute": "active",
2813
- "reflects": true,
2737
+ "fieldName": "active",
2814
2738
  "inheritedFrom": {
2815
2739
  "name": "Buttonsimple",
2816
- "module": "components/buttonsimple/buttonsimple.component.js"
2740
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
2817
2741
  }
2818
2742
  },
2819
2743
  {
2820
- "kind": "field",
2821
- "name": "softDisabled",
2744
+ "name": "soft-disabled",
2822
2745
  "type": {
2823
2746
  "text": "boolean | undefined"
2824
2747
  },
2825
2748
  "description": "Indicates whether the button is soft disabled.\nWhen set to `true`, the button appears visually disabled but still allows\nfocus, click, and keyboard actions to be passed through.\n\n**Important:** When using soft disabled, consumers must ensure that\nthe button behaves like a disabled button, allowing only focus and\npreventing any interactions (clicks or keyboard actions) from triggering unintended actions.",
2826
2749
  "default": "undefined",
2827
- "attribute": "soft-disabled",
2828
- "reflects": true,
2750
+ "fieldName": "softDisabled",
2829
2751
  "inheritedFrom": {
2830
2752
  "name": "Buttonsimple",
2831
- "module": "components/buttonsimple/buttonsimple.component.js"
2753
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
2832
2754
  }
2833
2755
  },
2834
2756
  {
2835
- "kind": "field",
2836
2757
  "name": "role",
2837
2758
  "type": {
2838
2759
  "text": "RoleType"
2839
2760
  },
2840
2761
  "description": "This property defines the ARIA role for the element. By default, it is set to 'button'.\nConsumers should override this role when:\n- The element is being used in a context where a different role is more appropriate.\n- Custom behaviors are implemented that require a specific ARIA role for accessibility purposes.",
2841
2762
  "default": "button",
2842
- "attribute": "role",
2843
- "reflects": true,
2763
+ "fieldName": "role",
2844
2764
  "inheritedFrom": {
2845
2765
  "name": "Buttonsimple",
2846
- "module": "components/buttonsimple/buttonsimple.component.js"
2766
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
2847
2767
  }
2848
2768
  },
2849
2769
  {
2850
- "kind": "field",
2851
2770
  "name": "ariaStateKey",
2852
2771
  "type": {
2853
2772
  "text": "string | undefined"
2854
2773
  },
2855
2774
  "description": "This property defines the ARIA state key, which will be toggled when the\nButton is set to `active`.\nThe default value is 'aria-pressed', which is commonly used for toggle buttons.\n\nConsumers can override this property to use a different ARIA state key if needed.\nIn case multiple aria attributes should be toggled, they can be passed in as\na comma separated string.\nFor example: `aria-pressed,aria-expanded`",
2856
2775
  "default": "'aria-pressed' (when)",
2857
- "attribute": "ariaStateKey",
2858
- "reflects": true,
2776
+ "fieldName": "ariaStateKey",
2859
2777
  "inheritedFrom": {
2860
2778
  "name": "Buttonsimple",
2861
- "module": "components/buttonsimple/buttonsimple.component.js"
2779
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
2862
2780
  }
2863
2781
  },
2864
2782
  {
2865
- "kind": "field",
2866
2783
  "name": "type",
2867
2784
  "type": {
2868
2785
  "text": "ButtonType"
2869
2786
  },
2870
2787
  "description": "This property defines the type attribute for the button element.\nThe type attribute specifies the behavior of the button when it is clicked.\n- **submit**: The button submits the form data to the server.\n- **reset**: The button resets the form data to its initial state.\n- **button**: The button does nothing when clicked.",
2871
2788
  "default": "button",
2872
- "attribute": "type",
2873
- "reflects": true,
2789
+ "fieldName": "type",
2874
2790
  "inheritedFrom": {
2875
2791
  "name": "Buttonsimple",
2876
- "module": "components/buttonsimple/buttonsimple.component.js"
2792
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
2877
2793
  }
2878
2794
  },
2879
2795
  {
2880
- "kind": "field",
2881
2796
  "name": "name",
2882
2797
  "type": {
2883
2798
  "text": "string | undefined"
2884
2799
  },
2885
2800
  "description": "The name of the button, submitted as a pair with the button's value as part of the form data,\nwhen that button is used to submit the form.",
2886
- "attribute": "name",
2887
- "reflects": true,
2801
+ "fieldName": "name",
2888
2802
  "inheritedFrom": {
2889
2803
  "name": "Buttonsimple",
2890
- "module": "components/buttonsimple/buttonsimple.component.js"
2804
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
2891
2805
  }
2892
2806
  },
2893
2807
  {
2894
- "kind": "field",
2895
2808
  "name": "value",
2896
2809
  "type": {
2897
2810
  "text": "string | undefined"
2898
2811
  },
2899
2812
  "description": "Defines the value associated with the button's name when it's submitted with the form data.\nThis value is passed to the server in params when the form is submitted using this button.",
2900
- "attribute": "value",
2901
- "reflects": true,
2813
+ "fieldName": "value",
2902
2814
  "inheritedFrom": {
2903
2815
  "name": "Buttonsimple",
2904
- "module": "components/buttonsimple/buttonsimple.component.js"
2816
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
2905
2817
  }
2906
- },
2818
+ }
2819
+ ],
2820
+ "mixins": [
2907
2821
  {
2908
- "kind": "method",
2909
- "name": "executeAction",
2910
- "privacy": "protected",
2911
- "inheritedFrom": {
2912
- "name": "Buttonsimple",
2913
- "module": "components/buttonsimple/buttonsimple.component.js"
2914
- }
2822
+ "name": "AvatarComponentMixin",
2823
+ "module": "/src/utils/mixins/AvatarComponentMixin"
2915
2824
  },
2916
2825
  {
2917
- "kind": "method",
2918
- "name": "setActive",
2919
- "privacy": "protected",
2920
- "parameters": [
2921
- {
2922
- "name": "element",
2923
- "type": {
2924
- "text": "HTMLElement"
2925
- },
2926
- "description": "The button element"
2927
- },
2928
- {
2929
- "name": "active",
2930
- "optional": true,
2931
- "type": {
2932
- "text": "boolean"
2933
- },
2934
- "description": "The active state of the element"
2935
- }
2936
- ],
2937
- "description": "Sets the ariaStateKey attributes based on the active state of the button.",
2938
- "inheritedFrom": {
2939
- "name": "Buttonsimple",
2940
- "module": "components/buttonsimple/buttonsimple.component.js"
2941
- }
2826
+ "name": "IconNameMixin",
2827
+ "module": "/src/utils/mixins/IconNameMixin"
2828
+ }
2829
+ ],
2830
+ "superclass": {
2831
+ "name": "Buttonsimple",
2832
+ "module": "/src/components/buttonsimple/buttonsimple.component"
2833
+ },
2834
+ "tagName": "mdc-avatarbutton",
2835
+ "jsDoc": "/**\n * The `mdc-avatarbutton` component is an interactable version of the `mdc-avatar` component.\n *\n * This component is made by extending `buttonsimple` class.\n * The button component acts as a wrapper for the avatar component.\n *\n * To override styles of the avatar inside, use the specified css parts.\n *\n * @dependency mdc-avatar\n *\n * @event click - (React: onClick) This event is dispatched when the avatarbutton is clicked.\n * @event keydown - (React: onKeyDown) This event is dispatched when a key is pressed down on the avatarbutton.\n * @event keyup - (React: onKeyUp) This event is dispatched when a key is released on the avatarbutton.\n * @event focus - (React: onFocus) This event is dispatched when the avatarbutton receives focus.\n *\n * @tagname mdc-avatarbutton\n *\n * @cssproperty --mdc-avatarbutton-overlay-background-color-rest - Background color of the overlay in rest state\n * @cssproperty --mdc-avatarbutton-overlay-background-color-hover - Background color of the overlay in hover state\n * @cssproperty --mdc-avatarbutton-overlay-background-color-active - Background color of the overlay in active state\n *\n * @csspart overlay - The overlay part of the avatar button.\n * @csspart content - The main content of the avatar.\n * @csspart photo - The photo part of the avatar.\n * @csspart presence - The presence indicator part of the avatar.\n * @csspart loading-wrapper - The wrapper for the loading indicator of the avatar.\n * @csspart loader - The loading indicator part of the avatar.\n */",
2836
+ "customElement": true
2837
+ }
2838
+ ],
2839
+ "exports": [
2840
+ {
2841
+ "kind": "js",
2842
+ "name": "default",
2843
+ "declaration": {
2844
+ "name": "AvatarButton",
2845
+ "module": "components/avatarbutton/avatarbutton.component.js"
2846
+ }
2847
+ }
2848
+ ]
2849
+ },
2850
+ {
2851
+ "kind": "javascript-module",
2852
+ "path": "components/badge/badge.component.js",
2853
+ "declarations": [
2854
+ {
2855
+ "kind": "class",
2856
+ "description": "The `mdc-badge` component is a versatile UI element used to\ndisplay dot, icons, counters, success, warning and error type badge.\n\nSupported badge types:\n- `dot`: Displays a dot notification badge with a blue color.\n- `icon`: Displays a badge with a specified icon using the `icon-name` attribute.\n- `counter`: Displays a badge with a counter value. If the counter exceeds the `max-counter`,\nit shows `maxCounter+`. The maximum value of the counter is 999 and anything above that will be set to `999+`.\n- `success`: Displays a success badge with a check circle icon and green color.\n- `warning`: Displays a warning badge with a warning icon and yellow color.\n- `error`: Displays a error badge with a error legacy icon and red color.\n\nFor `icon`, `success`, `warning` and `error` types, the `mdc-icon` component is used to render the icon.\n\nFor the `counter` type, the `mdc-text` component is used to render the counter value.",
2857
+ "name": "Badge",
2858
+ "cssProperties": [
2859
+ {
2860
+ "description": "The foreground color of the primary badge.",
2861
+ "name": "--mdc-badge-primary-foreground-color"
2862
+ },
2863
+ {
2864
+ "description": "The background color of the primary badge.",
2865
+ "name": "--mdc-badge-primary-background-color"
2866
+ },
2867
+ {
2868
+ "description": "The foreground color of the secondary badge.",
2869
+ "name": "--mdc-badge-secondary-foreground-color"
2870
+ },
2871
+ {
2872
+ "description": "The background color of the secondary badge.",
2873
+ "name": "--mdc-badge-secondary-background-color"
2874
+ },
2875
+ {
2876
+ "description": "The foreground color of the success badge.",
2877
+ "name": "--mdc-badge-success-foreground-color"
2878
+ },
2879
+ {
2880
+ "description": "The background color of the success badge.",
2881
+ "name": "--mdc-badge-success-background-color"
2882
+ },
2883
+ {
2884
+ "description": "The foreground color of the warning badge.",
2885
+ "name": "--mdc-badge-warning-foreground-color"
2886
+ },
2887
+ {
2888
+ "description": "The background color of the warning badge.",
2889
+ "name": "--mdc-badge-warning-background-color"
2890
+ },
2891
+ {
2892
+ "description": "The foreground color of the error badge.",
2893
+ "name": "--mdc-badge-error-foreground-color"
2894
+ },
2895
+ {
2896
+ "description": "The background color of the error badge.",
2897
+ "name": "--mdc-badge-error-background-color"
2898
+ },
2899
+ {
2900
+ "description": "The background color of the badge overlay.",
2901
+ "name": "--mdc-badge-overlay-background-color"
2902
+ }
2903
+ ],
2904
+ "members": [
2905
+ {
2906
+ "kind": "field",
2907
+ "name": "type",
2908
+ "type": {
2909
+ "text": "BadgeType | undefined"
2910
+ },
2911
+ "description": "Type of the badge\nCan be `dot` (notification) , `icon`, `counter`, `success`, `warning` or `error`.",
2912
+ "attribute": "type",
2913
+ "reflects": true
2914
+ },
2915
+ {
2916
+ "kind": "field",
2917
+ "name": "variant",
2918
+ "type": {
2919
+ "text": "IconVariant"
2920
+ },
2921
+ "description": "Type of the variant can be `primary` or `secondary`.\nIt defines the background and foreground color of the icon.",
2922
+ "default": "primary",
2923
+ "attribute": "variant",
2924
+ "reflects": true
2925
+ },
2926
+ {
2927
+ "kind": "field",
2928
+ "name": "counter",
2929
+ "type": {
2930
+ "text": "number | undefined"
2931
+ },
2932
+ "description": "Counter is the number which can be provided in the badge.",
2933
+ "attribute": "counter"
2934
+ },
2935
+ {
2936
+ "kind": "field",
2937
+ "name": "maxCounter",
2938
+ "type": {
2939
+ "text": "number"
2940
+ },
2941
+ "description": "The maximum number can be set up to 999, anything above that will be rendered as _999+_.\nThe max counter can be `9`, `99` or `999`.",
2942
+ "default": "99",
2943
+ "attribute": "max-counter",
2944
+ "reflects": true
2945
+ },
2946
+ {
2947
+ "kind": "field",
2948
+ "name": "overlay",
2949
+ "type": {
2950
+ "text": "boolean"
2951
+ },
2952
+ "default": "false",
2953
+ "description": "Overlay is to add a thin outline to the badge.\nThis will help distinguish between the badge and the button,\nwhere the badge will be layered on top of a button.",
2954
+ "attribute": "overlay"
2955
+ },
2956
+ {
2957
+ "kind": "field",
2958
+ "name": "ariaLabel",
2959
+ "type": {
2960
+ "text": "string | null"
2961
+ },
2962
+ "default": "null",
2963
+ "description": "Aria-label attribute to be set for accessibility",
2964
+ "attribute": "aria-label"
2942
2965
  },
2943
2966
  {
2944
2967
  "kind": "method",
2945
- "name": "setSoftDisabled",
2968
+ "name": "getCounterText",
2946
2969
  "privacy": "private",
2970
+ "return": {
2971
+ "type": {
2972
+ "text": ""
2973
+ }
2974
+ },
2947
2975
  "parameters": [
2948
2976
  {
2949
- "name": "element",
2977
+ "name": "maxCounter",
2950
2978
  "type": {
2951
- "text": "HTMLElement"
2979
+ "text": "number"
2952
2980
  },
2953
- "description": "The button element."
2981
+ "description": "the maximum limit which can be displayed on the badge"
2954
2982
  },
2955
2983
  {
2956
- "name": "softDisabled",
2984
+ "name": "counter",
2957
2985
  "optional": true,
2958
2986
  "type": {
2959
- "text": "boolean"
2987
+ "text": "number"
2960
2988
  },
2961
- "description": "The soft-disabled state."
2989
+ "description": "the number to be displayed on the badge"
2962
2990
  }
2963
2991
  ],
2964
- "description": "Sets the soft-disabled attribute for the button.\nWhen soft-disabled, the button looks to be disabled but remains focusable and clickable.\nAlso sets/removes aria-disabled attribute.",
2965
- "inheritedFrom": {
2966
- "name": "Buttonsimple",
2967
- "module": "components/buttonsimple/buttonsimple.component.js"
2968
- }
2992
+ "description": "If `type` is set to `counter` and if `counter` is greater than `maxCounter`,\nthen it will return a string the maxCounter value as string.\nOtherwise, it will return a string representation of `counter`.\nIf `counter` is not a number, it will return an empty string."
2969
2993
  },
2970
2994
  {
2971
2995
  "kind": "method",
2972
- "name": "setDisabled",
2996
+ "name": "getBadgeIcon",
2973
2997
  "privacy": "private",
2998
+ "return": {
2999
+ "type": {
3000
+ "text": ""
3001
+ }
3002
+ },
2974
3003
  "parameters": [
2975
3004
  {
2976
- "name": "element",
3005
+ "name": "iconName",
2977
3006
  "type": {
2978
- "text": "HTMLElement"
3007
+ "text": "string"
2979
3008
  },
2980
- "description": "The button element."
3009
+ "description": "the name of the icon from the icon set"
2981
3010
  },
2982
3011
  {
2983
- "name": "disabled",
3012
+ "name": "backgroundClassPostfix",
2984
3013
  "type": {
2985
- "text": "boolean"
3014
+ "text": "string"
2986
3015
  },
2987
- "description": "The disabled state."
3016
+ "description": "postfix for the class to style the badge icon."
2988
3017
  }
2989
3018
  ],
2990
- "description": "Sets the disabled attribute for the button.\nWhen disabled, the button is not focusable or clickable, and tabindex is set to -1.\nThe previous tabindex is stored and restored when enabled.\nAlso sets/removes aria-disabled attribute.",
2991
- "inheritedFrom": {
2992
- "name": "Buttonsimple",
2993
- "module": "components/buttonsimple/buttonsimple.component.js"
2994
- }
3019
+ "description": "Method to generate the badge icon."
2995
3020
  },
2996
3021
  {
2997
3022
  "kind": "method",
2998
- "name": "triggerClickEvent",
3023
+ "name": "getBadgeDot",
2999
3024
  "privacy": "private",
3000
- "inheritedFrom": {
3001
- "name": "Buttonsimple",
3002
- "module": "components/buttonsimple/buttonsimple.component.js"
3003
- }
3025
+ "return": {
3026
+ "type": {
3027
+ "text": ""
3028
+ }
3029
+ },
3030
+ "description": "Method to generate the badge dot template."
3004
3031
  },
3005
3032
  {
3006
3033
  "kind": "method",
3007
- "name": "handleBlur",
3034
+ "name": "getBadgeCounterText",
3008
3035
  "privacy": "private",
3009
- "description": "In case the button is pressed and the focus is lost while pressing,\nthe pressed class is removed.",
3010
- "inheritedFrom": {
3011
- "name": "Buttonsimple",
3012
- "module": "components/buttonsimple/buttonsimple.component.js"
3013
- }
3036
+ "return": {
3037
+ "type": {
3038
+ "text": ""
3039
+ }
3040
+ },
3041
+ "description": "Method to generate the badge text and counter template."
3014
3042
  },
3015
3043
  {
3016
3044
  "kind": "method",
3017
- "name": "handleKeyDown",
3045
+ "name": "setRoleByAriaLabel",
3018
3046
  "privacy": "private",
3019
- "parameters": [
3020
- {
3021
- "name": "event",
3022
- "type": {
3023
- "text": "KeyboardEvent"
3024
- },
3025
- "description": "The keyboard event."
3047
+ "return": {
3048
+ "type": {
3049
+ "text": "void"
3026
3050
  }
3027
- ],
3028
- "description": "Handles the keydown event on the button.\nIf the key is 'Enter' or 'Space', the button is pressed.\nIf the key is 'Enter', the button is pressed. The native HTML button works in the same way.\nIf the key is 'Space', the button's default is prevent to avoid scrolling etc in the host application.",
3029
- "inheritedFrom": {
3030
- "name": "Buttonsimple",
3031
- "module": "components/buttonsimple/buttonsimple.component.js"
3032
- }
3051
+ },
3052
+ "description": "Method to set the role based on the aria-label provided.\nIf the aria-label is provided, the role of the element will be 'img'.\nOtherwise, the role will be null."
3033
3053
  },
3034
3054
  {
3035
3055
  "kind": "method",
3036
- "name": "handleKeyUp",
3056
+ "name": "getBadgeContentBasedOnType",
3037
3057
  "privacy": "private",
3038
- "parameters": [
3039
- {
3040
- "name": "event",
3041
- "type": {
3042
- "text": "KeyboardEvent"
3043
- },
3044
- "description": "The keyboard event."
3058
+ "return": {
3059
+ "type": {
3060
+ "text": ""
3045
3061
  }
3046
- ],
3047
- "description": "Handles the keyup event on the button.\nIf the key is 'Enter' or 'Space', the button is clicked.\nIf the key is 'Space', the button is pressed. The native HTML button works in the same way.",
3048
- "inheritedFrom": {
3049
- "name": "Buttonsimple",
3050
- "module": "components/buttonsimple/buttonsimple.component.js"
3051
- }
3052
- }
3053
- ],
3054
- "events": [
3055
- {
3056
- "description": "(React: onClick) This event is dispatched when the avatarbutton is clicked.",
3057
- "name": "click",
3058
- "reactName": "onClick",
3059
- "inheritedFrom": {
3060
- "name": "Buttonsimple",
3061
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
3062
- }
3063
- },
3064
- {
3065
- "description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the avatarbutton.",
3066
- "name": "keydown",
3067
- "reactName": "onKeyDown",
3068
- "inheritedFrom": {
3069
- "name": "Buttonsimple",
3070
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
3071
- }
3072
- },
3073
- {
3074
- "description": "(React: onKeyUp) This event is dispatched when a key is released on the avatarbutton.",
3075
- "name": "keyup",
3076
- "reactName": "onKeyUp",
3077
- "inheritedFrom": {
3078
- "name": "Buttonsimple",
3079
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
3080
- }
3062
+ },
3063
+ "description": "Generates the badge content based on the badge type.\nUtilizes various helper methods to create the appropriate badge template based on the\ncurrent badge type. Supports 'dot', 'icon', 'counter', 'success', 'warning', and 'error'\ntypes, returning the corresponding template result for each type."
3081
3064
  },
3082
3065
  {
3083
- "description": "(React: onFocus) This event is dispatched when the avatarbutton receives focus.",
3084
- "name": "focus",
3085
- "reactName": "onFocus",
3066
+ "kind": "field",
3067
+ "name": "iconName",
3068
+ "type": {
3069
+ "text": "IconNames | undefined"
3070
+ },
3071
+ "description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
3072
+ "attribute": "icon-name",
3086
3073
  "inheritedFrom": {
3087
- "name": "Buttonsimple",
3088
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
3074
+ "name": "IconNameMixin",
3075
+ "module": "utils/mixins/IconNameMixin.js"
3089
3076
  }
3090
3077
  }
3091
3078
  ],
3092
3079
  "attributes": [
3093
3080
  {
3094
- "name": "aria-label",
3095
- "type": {
3096
- "text": "string | null"
3097
- },
3098
- "default": "null",
3099
- "description": "Aria-label attribute to be set for accessibility",
3100
- "fieldName": "ariaLabel"
3101
- },
3102
- {
3103
- "name": "src",
3081
+ "name": "type",
3104
3082
  "type": {
3105
- "text": "string | undefined"
3083
+ "text": "BadgeType | undefined"
3106
3084
  },
3107
- "description": "The src is the url which will be used to display the avatar.\nWhen the src is loading, we will display the initials as a placeholder.",
3108
- "fieldName": "src",
3109
- "inheritedFrom": {
3110
- "name": "AvatarComponentMixin",
3111
- "module": "src/utils/mixins/AvatarComponentMixin.ts"
3112
- }
3085
+ "description": "Type of the badge\nCan be `dot` (notification) , `icon`, `counter`, `success`, `warning` or `error`.",
3086
+ "fieldName": "type"
3113
3087
  },
3114
3088
  {
3115
- "name": "initials",
3089
+ "name": "variant",
3116
3090
  "type": {
3117
- "text": "string | undefined"
3091
+ "text": "IconVariant"
3118
3092
  },
3119
- "description": "The initials to be displayed for the avatar.",
3120
- "fieldName": "initials",
3121
- "inheritedFrom": {
3122
- "name": "AvatarComponentMixin",
3123
- "module": "src/utils/mixins/AvatarComponentMixin.ts"
3124
- }
3093
+ "description": "Type of the variant can be `primary` or `secondary`.\nIt defines the background and foreground color of the icon.",
3094
+ "default": "primary",
3095
+ "fieldName": "variant"
3125
3096
  },
3126
3097
  {
3127
- "name": "presence",
3098
+ "name": "counter",
3128
3099
  "type": {
3129
- "text": "PresenceType | undefined"
3100
+ "text": "number | undefined"
3130
3101
  },
3131
- "description": "The presence is the status which can be used to display the\nactivity state of a user or a space within an avatar component.\n\nAcceptable values include:\n- `active`\n- `away`\n- `away-calling`\n- `busy`\n- `dnd`\n- `meeting`\n- `on-call`\n- `on-device`\n- `on-mobile`\n- `pause`\n- `pto`\n- `presenting`\n- `quiet`\n- `scheduled`",
3132
- "fieldName": "presence",
3133
- "inheritedFrom": {
3134
- "name": "AvatarComponentMixin",
3135
- "module": "src/utils/mixins/AvatarComponentMixin.ts"
3136
- }
3102
+ "description": "Counter is the number which can be provided in the badge.",
3103
+ "fieldName": "counter"
3137
3104
  },
3138
3105
  {
3139
- "name": "size",
3106
+ "name": "max-counter",
3140
3107
  "type": {
3141
- "text": "ButtonSize"
3108
+ "text": "number"
3142
3109
  },
3143
- "description": "Acceptable values include (size in px unit):\n- 24\n- 32\n- 48\n- 64\n- 72\n- 88\n- 124",
3144
- "default": "32",
3145
- "fieldName": "size",
3146
- "inheritedFrom": {
3147
- "name": "Buttonsimple",
3148
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
3149
- }
3110
+ "description": "The maximum number can be set up to 999, anything above that will be rendered as _999+_.\nThe max counter can be `9`, `99` or `999`.",
3111
+ "default": "99",
3112
+ "fieldName": "maxCounter"
3150
3113
  },
3151
3114
  {
3152
- "name": "counter",
3115
+ "name": "overlay",
3153
3116
  "type": {
3154
- "text": "number | undefined"
3117
+ "text": "boolean"
3155
3118
  },
3156
- "description": "The counter is the number which can be displayed on the avatar.\nThe maximum number is 99 and if the given number is greater than 99,\nthen the avatar will be displayed as `99+`.\nIf the given number is a negative number,\nthen the avatar will be displayed as `0`.",
3157
- "fieldName": "counter",
3158
- "inheritedFrom": {
3159
- "name": "AvatarComponentMixin",
3160
- "module": "src/utils/mixins/AvatarComponentMixin.ts"
3161
- }
3119
+ "default": "false",
3120
+ "description": "Overlay is to add a thin outline to the badge.\nThis will help distinguish between the badge and the button,\nwhere the badge will be layered on top of a button.",
3121
+ "fieldName": "overlay"
3162
3122
  },
3163
3123
  {
3164
- "name": "is-typing",
3124
+ "name": "aria-label",
3165
3125
  "type": {
3166
- "text": "boolean"
3126
+ "text": "string | null"
3167
3127
  },
3168
- "default": "false",
3169
- "description": "Represents the typing indicator when the user is typing.",
3170
- "fieldName": "isTyping",
3171
- "inheritedFrom": {
3172
- "name": "AvatarComponentMixin",
3173
- "module": "src/utils/mixins/AvatarComponentMixin.ts"
3174
- }
3128
+ "default": "null",
3129
+ "description": "Aria-label attribute to be set for accessibility",
3130
+ "fieldName": "ariaLabel"
3175
3131
  },
3176
3132
  {
3177
3133
  "name": "icon-name",
@@ -3184,152 +3140,196 @@
3184
3140
  "name": "IconNameMixin",
3185
3141
  "module": "src/utils/mixins/IconNameMixin.ts"
3186
3142
  }
3187
- },
3143
+ }
3144
+ ],
3145
+ "mixins": [
3188
3146
  {
3189
- "name": "auto-focus-on-mount",
3147
+ "name": "IconNameMixin",
3148
+ "module": "/src/utils/mixins/IconNameMixin"
3149
+ }
3150
+ ],
3151
+ "superclass": {
3152
+ "name": "Component",
3153
+ "module": "/src/models"
3154
+ },
3155
+ "tagName": "mdc-badge",
3156
+ "jsDoc": "/**\n * The `mdc-badge` component is a versatile UI element used to\n * display dot, icons, counters, success, warning and error type badge.\n *\n * Supported badge types:\n * - `dot`: Displays a dot notification badge with a blue color.\n * - `icon`: Displays a badge with a specified icon using the `icon-name` attribute.\n * - `counter`: Displays a badge with a counter value. If the counter exceeds the `max-counter`,\n * it shows `maxCounter+`. The maximum value of the counter is 999 and anything above that will be set to `999+`.\n * - `success`: Displays a success badge with a check circle icon and green color.\n * - `warning`: Displays a warning badge with a warning icon and yellow color.\n * - `error`: Displays a error badge with a error legacy icon and red color.\n *\n * For `icon`, `success`, `warning` and `error` types, the `mdc-icon` component is used to render the icon.\n *\n * For the `counter` type, the `mdc-text` component is used to render the counter value.\n *\n * @dependency mdc-icon\n * @dependency mdc-text\n *\n * @tagname mdc-badge\n *\n * @cssproperty --mdc-badge-primary-foreground-color - The foreground color of the primary badge.\n * @cssproperty --mdc-badge-primary-background-color - The background color of the primary badge.\n * @cssproperty --mdc-badge-secondary-foreground-color - The foreground color of the secondary badge.\n * @cssproperty --mdc-badge-secondary-background-color - The background color of the secondary badge.\n * @cssproperty --mdc-badge-success-foreground-color - The foreground color of the success badge.\n * @cssproperty --mdc-badge-success-background-color - The background color of the success badge.\n * @cssproperty --mdc-badge-warning-foreground-color - The foreground color of the warning badge.\n * @cssproperty --mdc-badge-warning-background-color - The background color of the warning badge.\n * @cssproperty --mdc-badge-error-foreground-color - The foreground color of the error badge.\n * @cssproperty --mdc-badge-error-background-color - The background color of the error badge.\n * @cssproperty --mdc-badge-overlay-background-color - The background color of the badge overlay.\n */",
3157
+ "customElement": true
3158
+ }
3159
+ ],
3160
+ "exports": [
3161
+ {
3162
+ "kind": "js",
3163
+ "name": "default",
3164
+ "declaration": {
3165
+ "name": "Badge",
3166
+ "module": "components/badge/badge.component.js"
3167
+ }
3168
+ }
3169
+ ]
3170
+ },
3171
+ {
3172
+ "kind": "javascript-module",
3173
+ "path": "components/brandvisual/brandvisual.component.js",
3174
+ "declarations": [
3175
+ {
3176
+ "kind": "class",
3177
+ "description": "The `mdc-brandvisual` component is responsible for rendering logos dynamically & ensures they are\ndisplayed correctly within applications.\n\nFeatures:\n- Dynamically loads brandvisuals based on the `name` attribute.\n- Emits a `load` event when the brandvisual is successfully fetched.\n- Emits an `error` event when the brandvisual import fails.\n- Supports accessibility best practices.\n- Used for brand representation within the design system.",
3178
+ "name": "Brandvisual",
3179
+ "members": [
3180
+ {
3181
+ "kind": "field",
3182
+ "name": "brandVisualData",
3190
3183
  "type": {
3191
- "text": "boolean"
3184
+ "text": "Element | TemplateResult | undefined"
3192
3185
  },
3193
- "default": "false",
3194
- "description": "This property indicates whether the element should receive focus automatically when it is mounted.\n\nIt will not focus if the element is re-attached to the DOM after being removed.",
3195
- "fieldName": "autoFocusOnMount",
3196
- "inheritedFrom": {
3197
- "name": "AutoFocusOnMountMixin",
3198
- "module": "src/utils/mixins/AutoFocusOnMountMixin.ts"
3199
- }
3186
+ "privacy": "private"
3200
3187
  },
3201
3188
  {
3202
- "name": "tabIndex",
3189
+ "kind": "field",
3190
+ "name": "name",
3203
3191
  "type": {
3204
- "text": "number"
3192
+ "text": "BrandVisualNames | undefined"
3205
3193
  },
3206
- "default": "0",
3207
- "description": "This property specifies the tab order of the element.",
3208
- "fieldName": "tabIndex",
3209
- "inheritedFrom": {
3210
- "name": "TabIndexMixin",
3211
- "module": "src/utils/mixins/TabIndexMixin.ts"
3212
- }
3194
+ "description": "Name of the brandVisual (= filename)",
3195
+ "attribute": "name",
3196
+ "reflects": true
3213
3197
  },
3214
3198
  {
3215
- "name": "disabled",
3199
+ "kind": "field",
3200
+ "name": "altText",
3216
3201
  "type": {
3217
- "text": "boolean | undefined"
3202
+ "text": "string | undefined"
3218
3203
  },
3219
- "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
3220
- "default": "undefined",
3221
- "fieldName": "disabled",
3222
- "inheritedFrom": {
3223
- "name": "DisabledMixin",
3224
- "module": "src/utils/mixins/DisabledMixin.ts"
3225
- }
3204
+ "description": "Alt text for the brandvisual image for accessibility.\nThis will only be set if the brandvisual is an image (png).",
3205
+ "attribute": "altText",
3206
+ "reflects": true
3226
3207
  },
3227
3208
  {
3228
- "name": "active",
3229
- "type": {
3230
- "text": "boolean | undefined"
3231
- },
3232
- "description": "The button's active state indicates whether it is currently toggled on (active) or off (inactive).\nWhen the active state is true, the button is considered to be in an active state, meaning it is toggled on.\nConversely, when the active state is false, the button is in an inactive state, indicating it is toggled off.\n\nThis attribute is used to set the provided `ariaStateKey` to true or false.",
3233
- "default": "undefined",
3234
- "fieldName": "active",
3235
- "inheritedFrom": {
3236
- "name": "Buttonsimple",
3237
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
3238
- }
3209
+ "kind": "method",
3210
+ "name": "getBrandVisualData",
3211
+ "privacy": "private"
3239
3212
  },
3240
3213
  {
3241
- "name": "soft-disabled",
3242
- "type": {
3243
- "text": "boolean | undefined"
3214
+ "kind": "method",
3215
+ "name": "injectTemplateAttributes",
3216
+ "privacy": "private",
3217
+ "return": {
3218
+ "type": {
3219
+ "text": "Element | TemplateResult"
3220
+ }
3244
3221
  },
3245
- "description": "Indicates whether the button is soft disabled.\nWhen set to `true`, the button appears visually disabled but still allows\nfocus, click, and keyboard actions to be passed through.\n\n**Important:** When using soft disabled, consumers must ensure that\nthe button behaves like a disabled button, allowing only focus and\npreventing any interactions (clicks or keyboard actions) from triggering unintended actions.",
3246
- "default": "undefined",
3247
- "fieldName": "softDisabled",
3248
- "inheritedFrom": {
3249
- "name": "Buttonsimple",
3250
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
3251
- }
3222
+ "parameters": [
3223
+ {
3224
+ "name": "litTemplate",
3225
+ "type": {
3226
+ "text": "TemplateResult"
3227
+ }
3228
+ },
3229
+ {
3230
+ "name": "tag",
3231
+ "type": {
3232
+ "text": "string"
3233
+ }
3234
+ },
3235
+ {
3236
+ "name": "props",
3237
+ "type": {
3238
+ "text": "any"
3239
+ }
3240
+ }
3241
+ ]
3252
3242
  },
3253
3243
  {
3254
- "name": "role",
3255
- "type": {
3256
- "text": "RoleType"
3244
+ "kind": "method",
3245
+ "name": "injectHtmlAttributes",
3246
+ "privacy": "private",
3247
+ "return": {
3248
+ "type": {
3249
+ "text": "Element"
3250
+ }
3257
3251
  },
3258
- "description": "This property defines the ARIA role for the element. By default, it is set to 'button'.\nConsumers should override this role when:\n- The element is being used in a context where a different role is more appropriate.\n- Custom behaviors are implemented that require a specific ARIA role for accessibility purposes.",
3259
- "default": "button",
3260
- "fieldName": "role",
3261
- "inheritedFrom": {
3262
- "name": "Buttonsimple",
3263
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
3264
- }
3252
+ "parameters": [
3253
+ {
3254
+ "name": "html",
3255
+ "type": {
3256
+ "text": "Element"
3257
+ }
3258
+ },
3259
+ {
3260
+ "name": "props",
3261
+ "type": {
3262
+ "text": "imageProps"
3263
+ }
3264
+ }
3265
+ ]
3265
3266
  },
3266
3267
  {
3267
- "name": "ariaStateKey",
3268
- "type": {
3269
- "text": "string | undefined"
3270
- },
3271
- "description": "This property defines the ARIA state key, which will be toggled when the\nButton is set to `active`.\nThe default value is 'aria-pressed', which is commonly used for toggle buttons.\n\nConsumers can override this property to use a different ARIA state key if needed.\nIn case multiple aria attributes should be toggled, they can be passed in as\na comma separated string.\nFor example: `aria-pressed,aria-expanded`",
3272
- "default": "'aria-pressed' (when)",
3273
- "fieldName": "ariaStateKey",
3274
- "inheritedFrom": {
3275
- "name": "Buttonsimple",
3276
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
3277
- }
3268
+ "kind": "method",
3269
+ "name": "handleBrandVisualLoadedSuccess",
3270
+ "privacy": "private",
3271
+ "parameters": [
3272
+ {
3273
+ "name": "brandVisualHtml",
3274
+ "type": {
3275
+ "text": "TemplateResult"
3276
+ },
3277
+ "description": "The brandvisual html element which has been fetched from the brandvisual provider."
3278
+ }
3279
+ ],
3280
+ "description": "Sets the brandVisualData state to the fetched brandvisual.\nDispatches a 'load' event on the component once the brandvisual has been successfully loaded."
3278
3281
  },
3279
3282
  {
3280
- "name": "type",
3281
- "type": {
3282
- "text": "ButtonType"
3283
- },
3284
- "description": "This property defines the type attribute for the button element.\nThe type attribute specifies the behavior of the button when it is clicked.\n- **submit**: The button submits the form data to the server.\n- **reset**: The button resets the form data to its initial state.\n- **button**: The button does nothing when clicked.",
3285
- "default": "button",
3286
- "fieldName": "type",
3287
- "inheritedFrom": {
3288
- "name": "Buttonsimple",
3289
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
3290
- }
3283
+ "kind": "method",
3284
+ "name": "handleBrandVisualLoadedFailure",
3285
+ "privacy": "private",
3286
+ "parameters": [
3287
+ {
3288
+ "name": "error",
3289
+ "type": {
3290
+ "text": "unknown"
3291
+ }
3292
+ }
3293
+ ],
3294
+ "description": "Dispatches an 'error' event on the component when the brandvisual import has failed.\nThis event bubbles and is cancelable.\nThe error detail is set to the error object."
3295
+ }
3296
+ ],
3297
+ "events": [
3298
+ {
3299
+ "description": "(React: onLoad) This event is dispatched when the brandvisual has been successfully loaded.",
3300
+ "name": "load",
3301
+ "reactName": "onLoad"
3291
3302
  },
3303
+ {
3304
+ "description": "(React: onError) This event is dispatched when the brandvisual fetching has failed.",
3305
+ "name": "error",
3306
+ "reactName": "onError"
3307
+ }
3308
+ ],
3309
+ "attributes": [
3292
3310
  {
3293
3311
  "name": "name",
3294
3312
  "type": {
3295
- "text": "string | undefined"
3313
+ "text": "BrandVisualNames | undefined"
3296
3314
  },
3297
- "description": "The name of the button, submitted as a pair with the button's value as part of the form data,\nwhen that button is used to submit the form.",
3298
- "fieldName": "name",
3299
- "inheritedFrom": {
3300
- "name": "Buttonsimple",
3301
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
3302
- }
3315
+ "description": "Name of the brandVisual (= filename)",
3316
+ "fieldName": "name"
3303
3317
  },
3304
3318
  {
3305
- "name": "value",
3319
+ "name": "altText",
3306
3320
  "type": {
3307
3321
  "text": "string | undefined"
3308
3322
  },
3309
- "description": "Defines the value associated with the button's name when it's submitted with the form data.\nThis value is passed to the server in params when the form is submitted using this button.",
3310
- "fieldName": "value",
3311
- "inheritedFrom": {
3312
- "name": "Buttonsimple",
3313
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
3314
- }
3315
- }
3316
- ],
3317
- "mixins": [
3318
- {
3319
- "name": "AvatarComponentMixin",
3320
- "module": "/src/utils/mixins/AvatarComponentMixin"
3321
- },
3322
- {
3323
- "name": "IconNameMixin",
3324
- "module": "/src/utils/mixins/IconNameMixin"
3323
+ "description": "Alt text for the brandvisual image for accessibility.\nThis will only be set if the brandvisual is an image (png).",
3324
+ "fieldName": "altText"
3325
3325
  }
3326
3326
  ],
3327
3327
  "superclass": {
3328
- "name": "Buttonsimple",
3329
- "module": "/src/components/buttonsimple/buttonsimple.component"
3328
+ "name": "Component",
3329
+ "module": "/src/models"
3330
3330
  },
3331
- "tagName": "mdc-avatarbutton",
3332
- "jsDoc": "/**\n * The `mdc-avatarbutton` component is an interactable version of the `mdc-avatar` component.\n *\n * This component is made by extending `buttonsimple` class.\n * The button component acts as a wrapper for the avatar component.\n *\n * To override styles of the avatar inside, use the specified css parts.\n *\n * @dependency mdc-avatar\n *\n * @event click - (React: onClick) This event is dispatched when the avatarbutton is clicked.\n * @event keydown - (React: onKeyDown) This event is dispatched when a key is pressed down on the avatarbutton.\n * @event keyup - (React: onKeyUp) This event is dispatched when a key is released on the avatarbutton.\n * @event focus - (React: onFocus) This event is dispatched when the avatarbutton receives focus.\n *\n * @tagname mdc-avatarbutton\n *\n * @cssproperty --mdc-avatarbutton-overlay-background-color-rest - Background color of the overlay in rest state\n * @cssproperty --mdc-avatarbutton-overlay-background-color-hover - Background color of the overlay in hover state\n * @cssproperty --mdc-avatarbutton-overlay-background-color-active - Background color of the overlay in active state\n *\n * @csspart overlay - The overlay part of the avatar button.\n * @csspart content - The main content of the avatar.\n * @csspart photo - The photo part of the avatar.\n * @csspart presence - The presence indicator part of the avatar.\n * @csspart loading-wrapper - The wrapper for the loading indicator of the avatar.\n * @csspart loader - The loading indicator part of the avatar.\n */",
3331
+ "tagName": "mdc-brandvisual",
3332
+ "jsDoc": "/**\n * The `mdc-brandvisual` component is responsible for rendering logos dynamically & ensures they are\n * displayed correctly within applications.\n *\n * Features:\n * - Dynamically loads brandvisuals based on the `name` attribute.\n * - Emits a `load` event when the brandvisual is successfully fetched.\n * - Emits an `error` event when the brandvisual import fails.\n * - Supports accessibility best practices.\n * - Used for brand representation within the design system.\n *\n * @tagname mdc-brandvisual\n *\n * @event load - (React: onLoad) This event is dispatched when the brandvisual has been successfully loaded.\n * @event error - (React: onError) This event is dispatched when the brandvisual fetching has failed.\n *\n */",
3333
3333
  "customElement": true
3334
3334
  }
3335
3335
  ],
@@ -3338,8 +3338,8 @@
3338
3338
  "kind": "js",
3339
3339
  "name": "default",
3340
3340
  "declaration": {
3341
- "name": "AvatarButton",
3342
- "module": "components/avatarbutton/avatarbutton.component.js"
3341
+ "name": "Brandvisual",
3342
+ "module": "components/brandvisual/brandvisual.component.js"
3343
3343
  }
3344
3344
  }
3345
3345
  ]
@@ -12581,354 +12581,108 @@
12581
12581
  "name": "aria-description",
12582
12582
  "type": {
12583
12583
  "text": "string | null"
12584
- },
12585
- "default": "null",
12586
- "description": "Defines a string value for the aria-description attribute that refers to the element\ndescribing the dialog for accessibility",
12587
- "fieldName": "ariaDescription"
12588
- },
12589
- {
12590
- "name": "header-text",
12591
- "type": {
12592
- "text": "string | undefined"
12593
- },
12594
- "description": "Defines a string value to display as the title of the dialog",
12595
- "fieldName": "headerText"
12596
- },
12597
- {
12598
- "name": "description-text",
12599
- "type": {
12600
- "text": "string | undefined"
12601
- },
12602
- "description": "Defines a string value to display as the under-header description of the dialog",
12603
- "fieldName": "descriptionText"
12604
- },
12605
- {
12606
- "name": "header-tag-name",
12607
- "type": {
12608
- "text": "string"
12609
- },
12610
- "description": "The html tag to be used for the header text",
12611
- "fieldName": "headerTagName"
12612
- },
12613
- {
12614
- "name": "description-tag-name",
12615
- "type": {
12616
- "text": "string"
12617
- },
12618
- "description": "The html tag to be used for the below-header description text",
12619
- "fieldName": "descriptionTagName"
12620
- },
12621
- {
12622
- "name": "role",
12623
- "type": {
12624
- "text": "DialogRole"
12625
- },
12626
- "description": "Role of the dialog",
12627
- "default": "dialog",
12628
- "fieldName": "role"
12629
- },
12630
- {
12631
- "name": "disable-aria-haspopup",
12632
- "type": {
12633
- "text": "boolean"
12634
- },
12635
- "description": "Disable setting the aria-haspopup attribute on trigger element.\nMake sure to set this to true when the popover is extended and its role\nis not 'dialog' or 'alertdialog' i.e. listbox, menu, etc.",
12636
- "default": "false",
12637
- "fieldName": "disableAriaHasPopup"
12638
- },
12639
- {
12640
- "name": "focus-trap",
12641
- "type": {
12642
- "text": "boolean"
12643
- },
12644
- "description": "Determines whether the focus trap is enabled.\nIf true, focus will be restricted to the content within this component.\n\nNOTE: this should only be disabled in rare cases! By default a Modal Dialog\nshould trap focus always.",
12645
- "default": "true",
12646
- "fieldName": "focusTrap"
12647
- },
12648
- {
12649
- "name": "should-focus-trap-wrap",
12650
- "type": {
12651
- "text": "boolean"
12652
- },
12653
- "default": "true",
12654
- "description": "Determines whether focus should wrap around when reaching the first or last focusable element.\nIf true, focus will cycle from end to start and vice versa.\n\nThis only applies when `focusTrap` is true.",
12655
- "fieldName": "shouldFocusTrapWrap",
12656
- "inheritedFrom": {
12657
- "name": "FocusTrapMixin",
12658
- "module": "src/utils/mixins/FocusTrapMixin.ts"
12659
- }
12660
- }
12661
- ],
12662
- "mixins": [
12663
- {
12664
- "name": "BackdropMixin",
12665
- "module": "/src/utils/mixins/BackdropMixin"
12666
- },
12667
- {
12668
- "name": "PreventScrollMixin",
12669
- "module": "/src/utils/mixins/PreventScrollMixin"
12670
- },
12671
- {
12672
- "name": "FocusTrapMixin",
12673
- "module": "/src/utils/mixins/FocusTrapMixin"
12674
- },
12675
- {
12676
- "name": "FooterMixin",
12677
- "module": "/src/utils/mixins/FooterMixin"
12678
- }
12679
- ],
12680
- "superclass": {
12681
- "name": "Component",
12682
- "module": "/src/models"
12683
- },
12684
- "tagName": "mdc-dialog",
12685
- "jsDoc": "/**\n * Dialog component is a modal dialog that can be used to display information or prompt the user for input.\n * It can be used to create custom dialogs where content for the body and footer actions is provided by the consumer.\n * The dialog is available in 5 sizes: small, medium, large, xlarge and fullscreen. It may also receive custom styling/sizing.\n * The dialog interrupts the user and will block interaction with the rest of the application until it is closed.\n *\n * The dialog can be controlled solely through the `visible` property, no trigger element is required.\n * If a `triggerId` is provided, the dialog will manage focus with that element, otherwise it will\n * remember the previously focused element before the dialog was opened.\n *\n * The dialog is a controlled component, meaning it does not have its own state management for visibility.\n * Use the `visible` property to control the visibility of the dialog.\n * Use the `onClose` event to handle the close action of the dialog (fired when Close button is clicked\n * or Escape is pressed).\n *\n * Dialog component have 2 variants: default and promotional.\n *\n * **Accessibility notes for consuming (have to be explicitly set when you consume the component)**\n *\n * - The dialog should have an aria-label or aria-labelledby attribute to provide a label for screen readers.\n * - Use aria-labelledby to reference the ID of the element that labels the dialog when there is no visible title.\n *\n * **Note: Programmatic show/hide requires the ? prefix on the visible attribute**\n * - Use `?visible=true/false` as an attribute instead of `visible=true/false`\n * - Reference docs for more info: https://lit.dev/docs/templates/expressions/#boolean-attribute-expressions\n *\n * @dependency mdc-button\n * @dependency mdc-text\n *\n * @tagname mdc-dialog\n *\n * @event shown - (React: onShown) Dispatched when the dialog is shown\n * @event hidden - (React: onHidden) Dispatched when the dialog is hidden\n * @event created - (React: onCreated) Dispatched when the dialog is created (added to the DOM)\n * @event destroyed - (React: onDestroyed) Dispatched when the dialog is destroyed (removed from the DOM)\n * @event close - (React: onClose) Dispatched when the Close Button is clicked or Escape key is pressed\n * (this does not hide the dialog)\n *\n * @cssproperty --mdc-dialog-primary-background-color - primary background color of the dialog\n * @cssproperty --mdc-dialog-border-color - border color of the dialog\n * @cssproperty --mdc-dialog-header-text-color - text color of the header/title of the dialog\n * @cssproperty --mdc-dialog-description-text-color - text color of the below header description of the dialog\n * @cssproperty --mdc-dialog-elevation-3 - elevation of the dialog\n * @cssproperty --mdc-dialog-width - width of the dialog\n *\n * @slot header-prefix - Slot for the dialog header content. This can be used to pass custom header content.\n * @slot dialog-body - Slot for the dialog body content\n * @slot footer-link - This slot is for passing `mdc-link` component within the footer section.\n * @slot footer-button-secondary - This slot is for passing secondary variant of `mdc-button` component\n * within the footer section.\n * @slot footer-button-primary - This slot is for passing primary variant of\n * `mdc-button` component within the footer section.\n * @slot footer - This slot is for passing custom footer content. Only use this if really needed,\n * using the footer-link and footer-button slots is preferred\n */",
12686
- "customElement": true
12687
- }
12688
- ],
12689
- "exports": [
12690
- {
12691
- "kind": "js",
12692
- "name": "default",
12693
- "declaration": {
12694
- "name": "Dialog",
12695
- "module": "components/dialog/dialog.component.js"
12696
- }
12697
- }
12698
- ]
12699
- },
12700
- {
12701
- "kind": "javascript-module",
12702
- "path": "components/divider/divider.component.js",
12703
- "declarations": [
12704
- {
12705
- "kind": "class",
12706
- "description": "`mdc-divider` is a component that provides a line to separate and organize content.\nIt can also include a button or text positioned centrally, allowing users to interact with the layout.\n\n**Divider Orientation:**\n- **Horizontal**: A thin, horizontal line.\n- **Vertical**: A thin, vertical line.\n\n**Divider Variants:**\n- **solid**: Solid line.\n- **gradient**: Gradient Line.\n\n**Divider Types:**\n- The type of divider is inferred based on the kind of slot present.\n - **Primary**: A simple horizontal or vertical divider.\n - **Text**: A horizontal divider with a text label in the center.\n - **Grabber Button**: A horizontal or vertical divider with a styled button in the center.\n\n**Accessibility:**\n- When the slot is replaced by an `mdc-button`:\n - `aria-label` should be passed to the `mdc-button`.\n - `aria-expanded` should be passed to the `mdc-button`.\n\n**Notes:**\n- If the slot is replaced by an invalid tag name or contains multiple elements,\n the divider defaults to the **Primary** type.\n- To override the styles of the divider, use the provided CSS custom properties.",
12707
- "name": "Divider",
12708
- "cssProperties": [
12709
- {
12710
- "description": "background color of the divider",
12711
- "name": "--mdc-divider-background-color"
12712
- },
12713
- {
12714
- "description": "width of the divider",
12715
- "name": "--mdc-divider-width"
12716
- },
12717
- {
12718
- "description": "gradient of the horizontal divider",
12719
- "name": "--mdc-divider-horizontal-gradient"
12720
- },
12721
- {
12722
- "description": "gradient of the vertical divider",
12723
- "name": "--mdc-divider-vertical-gradient"
12724
- },
12725
- {
12726
- "description": "font size of label in the text divider",
12727
- "name": "--mdc-divider-text-size"
12728
- },
12729
- {
12730
- "description": "font color of label in the text divider",
12731
- "name": "--mdc-divider-text-color"
12732
- },
12733
- {
12734
- "description": "left and right margin of label in the text divider",
12735
- "name": "--mdc-divider-text-margin"
12736
- },
12737
- {
12738
- "description": "line height of label in the text divider",
12739
- "name": "--mdc-divider-text-line-height"
12740
- },
12741
- {
12742
- "description": "background color of the grabber button in rest state",
12743
- "name": "--mdc-divider-grabber-button-background-color-normal"
12744
- },
12745
- {
12746
- "description": "background color of the grabber button in hover state",
12747
- "name": "--mdc-divider-grabber-button-background-color-hover"
12748
- },
12749
- {
12750
- "description": "background color of the grabber button in pressed state",
12751
- "name": "--mdc-divider-grabber-button-background-color-pressed"
12752
- },
12753
- {
12754
- "description": "border color of the grabber button",
12755
- "name": "--mdc-divider-grabber-button-border-color"
12756
- },
12757
- {
12758
- "description": "border radius of the grabber button",
12759
- "name": "--mdc-divider-grabber-button-border-radius"
12760
- }
12761
- ],
12762
- "members": [
12763
- {
12764
- "kind": "field",
12765
- "name": "orientation",
12766
- "type": {
12767
- "text": "DividerOrientation"
12768
- },
12769
- "description": "Two orientations of divider\n- **horizontal**: A thin, horizontal line with 0.0625rem width.\n- **vertical**: A thin, vertical line with 0.0625rem width.\n\nNote: We do not support \"Vertical Text Divider\" as of now.",
12770
- "default": "horizontal",
12771
- "attribute": "orientation",
12772
- "reflects": true
12773
- },
12774
- {
12775
- "kind": "field",
12776
- "name": "variant",
12777
- "type": {
12778
- "text": "DividerVariant"
12779
- },
12780
- "description": "Two variants of divider\n- **solid**: Solid line.\n- **gradient**: Gradient Line that fades on either sides of the divider.",
12781
- "default": "solid",
12782
- "attribute": "variant",
12783
- "reflects": true
12784
- },
12785
- {
12786
- "kind": "field",
12787
- "name": "arrowDirection",
12788
- "type": {
12789
- "text": "Directions"
12790
- },
12791
- "description": "Direction of the arrow icon, if applicable.\n- **positive**\n- **negative**\n\nNote: Positive and Negative directions are defined based on Cartesian plane.",
12792
- "default": "'negative'",
12793
- "attribute": "arrow-direction",
12794
- "reflects": true
12795
- },
12796
- {
12797
- "kind": "field",
12798
- "name": "buttonPosition",
12799
- "type": {
12800
- "text": "Directions"
12801
- },
12802
- "description": "Position of the button, if applicable.\n- **positive**\n- **negative**\n\nNote: Positive and Negative directions are defined based on Cartesian plane.",
12803
- "default": "'negative'",
12804
- "attribute": "button-position",
12805
- "reflects": true
12806
- },
12807
- {
12808
- "kind": "method",
12809
- "name": "setVariant",
12810
- "privacy": "private",
12811
- "parameters": [
12812
- {
12813
- "name": "variant",
12814
- "type": {
12815
- "text": "DividerVariant"
12816
- },
12817
- "description": "The variant to set."
12818
- }
12819
- ],
12820
- "description": "Sets the variant attribute for the divider component.\nIf the provided variant is not included in the DIVIDER_VARIANT,\nit defaults to the value specified in DEFAULTS.VARIANT."
12821
- },
12822
- {
12823
- "kind": "method",
12824
- "name": "setOrientation",
12825
- "privacy": "private",
12826
- "parameters": [
12827
- {
12828
- "name": "orientation",
12829
- "type": {
12830
- "text": "DividerOrientation"
12831
- },
12832
- "description": "The orientation to set."
12833
- }
12834
- ],
12835
- "description": "Sets the orientation attribute for the divider component.\nIf the provided orientation is not included in the DIVIDER_ORIENTATION,\nit defaults to the value specified in DEFAULTS.ORIENTATION."
12584
+ },
12585
+ "default": "null",
12586
+ "description": "Defines a string value for the aria-description attribute that refers to the element\ndescribing the dialog for accessibility",
12587
+ "fieldName": "ariaDescription"
12836
12588
  },
12837
12589
  {
12838
- "kind": "method",
12839
- "name": "ensureValidDirections",
12840
- "privacy": "private",
12841
- "description": "Sets the buttonPosition and arrowDirection attribute for the divider component.\nIf the provided buttonPosition and arrowDirection are not included in the DIRECTIONS,\nit defaults to the value specified in DIRECTIONS based on the ORIENTATION.",
12842
- "parameters": [
12843
- {
12844
- "description": "The buttonPosition to set.",
12845
- "name": "buttonPosition"
12846
- },
12847
- {
12848
- "description": "The arrowDirection to set.",
12849
- "name": "arrowDirection"
12850
- }
12851
- ]
12590
+ "name": "header-text",
12591
+ "type": {
12592
+ "text": "string | undefined"
12593
+ },
12594
+ "description": "Defines a string value to display as the title of the dialog",
12595
+ "fieldName": "headerText"
12852
12596
  },
12853
12597
  {
12854
- "kind": "method",
12855
- "name": "setGrabberButton",
12856
- "privacy": "private",
12857
- "return": {
12858
- "type": {
12859
- "text": "void"
12860
- }
12598
+ "name": "description-text",
12599
+ "type": {
12600
+ "text": "string | undefined"
12861
12601
  },
12862
- "description": "Configures the grabber button within the divider.\n\n- Sets the `prefix-icon` attribute for the grabber button based\non the `arrow-direction` and `orientation` properties.\n\nThis method updates the DOM element dynamically if a grabber button is present."
12602
+ "description": "Defines a string value to display as the under-header description of the dialog",
12603
+ "fieldName": "descriptionText"
12863
12604
  },
12864
12605
  {
12865
- "kind": "method",
12866
- "name": "getArrowIcon",
12867
- "privacy": "private",
12868
- "return": {
12869
- "type": {
12870
- "text": ""
12871
- }
12606
+ "name": "header-tag-name",
12607
+ "type": {
12608
+ "text": "string"
12872
12609
  },
12873
- "description": "Determines the arrow icon based on the consumer-defined `arrowDirection`."
12610
+ "description": "The html tag to be used for the header text",
12611
+ "fieldName": "headerTagName"
12874
12612
  },
12875
12613
  {
12876
- "kind": "method",
12877
- "name": "inferDividerType",
12878
- "privacy": "private",
12879
- "description": "Infers the type of divider based on the kind of slot present.",
12880
- "parameters": [
12881
- {
12882
- "description": "default slot of divider",
12883
- "name": "slot"
12884
- }
12885
- ]
12886
- }
12887
- ],
12888
- "attributes": [
12614
+ "name": "description-tag-name",
12615
+ "type": {
12616
+ "text": "string"
12617
+ },
12618
+ "description": "The html tag to be used for the below-header description text",
12619
+ "fieldName": "descriptionTagName"
12620
+ },
12889
12621
  {
12890
- "name": "orientation",
12622
+ "name": "role",
12891
12623
  "type": {
12892
- "text": "DividerOrientation"
12624
+ "text": "DialogRole"
12893
12625
  },
12894
- "description": "Two orientations of divider\n- **horizontal**: A thin, horizontal line with 0.0625rem width.\n- **vertical**: A thin, vertical line with 0.0625rem width.\n\nNote: We do not support \"Vertical Text Divider\" as of now.",
12895
- "default": "horizontal",
12896
- "fieldName": "orientation"
12626
+ "description": "Role of the dialog",
12627
+ "default": "dialog",
12628
+ "fieldName": "role"
12897
12629
  },
12898
12630
  {
12899
- "name": "variant",
12631
+ "name": "disable-aria-haspopup",
12900
12632
  "type": {
12901
- "text": "DividerVariant"
12633
+ "text": "boolean"
12902
12634
  },
12903
- "description": "Two variants of divider\n- **solid**: Solid line.\n- **gradient**: Gradient Line that fades on either sides of the divider.",
12904
- "default": "solid",
12905
- "fieldName": "variant"
12635
+ "description": "Disable setting the aria-haspopup attribute on trigger element.\nMake sure to set this to true when the popover is extended and its role\nis not 'dialog' or 'alertdialog' i.e. listbox, menu, etc.",
12636
+ "default": "false",
12637
+ "fieldName": "disableAriaHasPopup"
12906
12638
  },
12907
12639
  {
12908
- "name": "arrow-direction",
12640
+ "name": "focus-trap",
12909
12641
  "type": {
12910
- "text": "Directions"
12642
+ "text": "boolean"
12911
12643
  },
12912
- "description": "Direction of the arrow icon, if applicable.\n- **positive**\n- **negative**\n\nNote: Positive and Negative directions are defined based on Cartesian plane.",
12913
- "default": "'negative'",
12914
- "fieldName": "arrowDirection"
12644
+ "description": "Determines whether the focus trap is enabled.\nIf true, focus will be restricted to the content within this component.\n\nNOTE: this should only be disabled in rare cases! By default a Modal Dialog\nshould trap focus always.",
12645
+ "default": "true",
12646
+ "fieldName": "focusTrap"
12915
12647
  },
12916
12648
  {
12917
- "name": "button-position",
12649
+ "name": "should-focus-trap-wrap",
12918
12650
  "type": {
12919
- "text": "Directions"
12651
+ "text": "boolean"
12920
12652
  },
12921
- "description": "Position of the button, if applicable.\n- **positive**\n- **negative**\n\nNote: Positive and Negative directions are defined based on Cartesian plane.",
12922
- "default": "'negative'",
12923
- "fieldName": "buttonPosition"
12653
+ "default": "true",
12654
+ "description": "Determines whether focus should wrap around when reaching the first or last focusable element.\nIf true, focus will cycle from end to start and vice versa.\n\nThis only applies when `focusTrap` is true.",
12655
+ "fieldName": "shouldFocusTrapWrap",
12656
+ "inheritedFrom": {
12657
+ "name": "FocusTrapMixin",
12658
+ "module": "src/utils/mixins/FocusTrapMixin.ts"
12659
+ }
12660
+ }
12661
+ ],
12662
+ "mixins": [
12663
+ {
12664
+ "name": "BackdropMixin",
12665
+ "module": "/src/utils/mixins/BackdropMixin"
12666
+ },
12667
+ {
12668
+ "name": "PreventScrollMixin",
12669
+ "module": "/src/utils/mixins/PreventScrollMixin"
12670
+ },
12671
+ {
12672
+ "name": "FocusTrapMixin",
12673
+ "module": "/src/utils/mixins/FocusTrapMixin"
12674
+ },
12675
+ {
12676
+ "name": "FooterMixin",
12677
+ "module": "/src/utils/mixins/FooterMixin"
12924
12678
  }
12925
12679
  ],
12926
12680
  "superclass": {
12927
12681
  "name": "Component",
12928
12682
  "module": "/src/models"
12929
12683
  },
12930
- "tagName": "mdc-divider",
12931
- "jsDoc": "/**\n * `mdc-divider` is a component that provides a line to separate and organize content.\n * It can also include a button or text positioned centrally, allowing users to interact with the layout.\n *\n * **Divider Orientation:**\n * - **Horizontal**: A thin, horizontal line.\n * - **Vertical**: A thin, vertical line.\n *\n * **Divider Variants:**\n * - **solid**: Solid line.\n * - **gradient**: Gradient Line.\n *\n * **Divider Types:**\n * - The type of divider is inferred based on the kind of slot present.\n * - **Primary**: A simple horizontal or vertical divider.\n * - **Text**: A horizontal divider with a text label in the center.\n * - **Grabber Button**: A horizontal or vertical divider with a styled button in the center.\n *\n * **Accessibility:**\n * - When the slot is replaced by an `mdc-button`:\n * - `aria-label` should be passed to the `mdc-button`.\n * - `aria-expanded` should be passed to the `mdc-button`.\n *\n * **Notes:**\n * - If the slot is replaced by an invalid tag name or contains multiple elements,\n * the divider defaults to the **Primary** type.\n * - To override the styles of the divider, use the provided CSS custom properties.\n *\n * @tagname mdc-divider\n *\n * @cssproperty --mdc-divider-background-color - background color of the divider\n * @cssproperty --mdc-divider-width - width of the divider\n * @cssproperty --mdc-divider-horizontal-gradient - gradient of the horizontal divider\n * @cssproperty --mdc-divider-vertical-gradient - gradient of the vertical divider\n * @cssproperty --mdc-divider-text-size - font size of label in the text divider\n * @cssproperty --mdc-divider-text-color - font color of label in the text divider\n * @cssproperty --mdc-divider-text-margin - left and right margin of label in the text divider\n * @cssproperty --mdc-divider-text-line-height - line height of label in the text divider\n * @cssproperty --mdc-divider-grabber-button-background-color-normal - background color of the grabber button\n * in rest state\n * @cssproperty --mdc-divider-grabber-button-background-color-hover - background color of the grabber button\n * in hover state\n * @cssproperty --mdc-divider-grabber-button-background-color-pressed - background color of the grabber button\n * in pressed state\n * @cssproperty --mdc-divider-grabber-button-border-color - border color of the grabber button\n * @cssproperty --mdc-divider-grabber-button-border-radius - border radius of the grabber button\n */",
12684
+ "tagName": "mdc-dialog",
12685
+ "jsDoc": "/**\n * Dialog component is a modal dialog that can be used to display information or prompt the user for input.\n * It can be used to create custom dialogs where content for the body and footer actions is provided by the consumer.\n * The dialog is available in 5 sizes: small, medium, large, xlarge and fullscreen. It may also receive custom styling/sizing.\n * The dialog interrupts the user and will block interaction with the rest of the application until it is closed.\n *\n * The dialog can be controlled solely through the `visible` property, no trigger element is required.\n * If a `triggerId` is provided, the dialog will manage focus with that element, otherwise it will\n * remember the previously focused element before the dialog was opened.\n *\n * The dialog is a controlled component, meaning it does not have its own state management for visibility.\n * Use the `visible` property to control the visibility of the dialog.\n * Use the `onClose` event to handle the close action of the dialog (fired when Close button is clicked\n * or Escape is pressed).\n *\n * Dialog component have 2 variants: default and promotional.\n *\n * **Accessibility notes for consuming (have to be explicitly set when you consume the component)**\n *\n * - The dialog should have an aria-label or aria-labelledby attribute to provide a label for screen readers.\n * - Use aria-labelledby to reference the ID of the element that labels the dialog when there is no visible title.\n *\n * **Note: Programmatic show/hide requires the ? prefix on the visible attribute**\n * - Use `?visible=true/false` as an attribute instead of `visible=true/false`\n * - Reference docs for more info: https://lit.dev/docs/templates/expressions/#boolean-attribute-expressions\n *\n * @dependency mdc-button\n * @dependency mdc-text\n *\n * @tagname mdc-dialog\n *\n * @event shown - (React: onShown) Dispatched when the dialog is shown\n * @event hidden - (React: onHidden) Dispatched when the dialog is hidden\n * @event created - (React: onCreated) Dispatched when the dialog is created (added to the DOM)\n * @event destroyed - (React: onDestroyed) Dispatched when the dialog is destroyed (removed from the DOM)\n * @event close - (React: onClose) Dispatched when the Close Button is clicked or Escape key is pressed\n * (this does not hide the dialog)\n *\n * @cssproperty --mdc-dialog-primary-background-color - primary background color of the dialog\n * @cssproperty --mdc-dialog-border-color - border color of the dialog\n * @cssproperty --mdc-dialog-header-text-color - text color of the header/title of the dialog\n * @cssproperty --mdc-dialog-description-text-color - text color of the below header description of the dialog\n * @cssproperty --mdc-dialog-elevation-3 - elevation of the dialog\n * @cssproperty --mdc-dialog-width - width of the dialog\n *\n * @slot header-prefix - Slot for the dialog header content. This can be used to pass custom header content.\n * @slot dialog-body - Slot for the dialog body content\n * @slot footer-link - This slot is for passing `mdc-link` component within the footer section.\n * @slot footer-button-secondary - This slot is for passing secondary variant of `mdc-button` component\n * within the footer section.\n * @slot footer-button-primary - This slot is for passing primary variant of\n * `mdc-button` component within the footer section.\n * @slot footer - This slot is for passing custom footer content. Only use this if really needed,\n * using the footer-link and footer-button slots is preferred\n */",
12932
12686
  "customElement": true
12933
12687
  }
12934
12688
  ],
@@ -12937,360 +12691,245 @@
12937
12691
  "kind": "js",
12938
12692
  "name": "default",
12939
12693
  "declaration": {
12940
- "name": "Divider",
12941
- "module": "components/divider/divider.component.js"
12694
+ "name": "Dialog",
12695
+ "module": "components/dialog/dialog.component.js"
12942
12696
  }
12943
12697
  }
12944
12698
  ]
12945
12699
  },
12946
12700
  {
12947
12701
  "kind": "javascript-module",
12948
- "path": "components/formfieldgroup/formfieldgroup.component.js",
12702
+ "path": "components/divider/divider.component.js",
12949
12703
  "declarations": [
12950
12704
  {
12951
12705
  "kind": "class",
12952
- "description": "`mdc-formfieldgroup` component, groups the form field components together.\nAll passed in children will have a gap of 12px (0.75rem) each applied.\n\nThis component is specifically for creating a `checkbox` group and a `toggle` group component.\nFor the radiogroup use the RadioGroup component instead.\n\nThe header text and description text are displayed above the items with accessible labels.<br/>\nThe consumer has to provide atleast the header-text or the aria-label,\nlike one of them <b>has</b> to be passed in always, otherwise its not accessible.\n\nThe role will be set to `group`.\nThe aria-label will be set with the data-aria-label property.\nThe aria-labelledby will be set with the header id which contains the header text information.\nThe aria-describedby will be set with the description id which contains the description text information.",
12953
- "name": "FormfieldGroup",
12954
- "slots": [
12706
+ "description": "`mdc-divider` is a component that provides a line to separate and organize content.\nIt can also include a button or text positioned centrally, allowing users to interact with the layout.\n\n**Divider Orientation:**\n- **Horizontal**: A thin, horizontal line.\n- **Vertical**: A thin, vertical line.\n\n**Divider Variants:**\n- **solid**: Solid line.\n- **gradient**: Gradient Line.\n\n**Divider Types:**\n- The type of divider is inferred based on the kind of slot present.\n - **Primary**: A simple horizontal or vertical divider.\n - **Text**: A horizontal divider with a text label in the center.\n - **Grabber Button**: A horizontal or vertical divider with a styled button in the center.\n\n**Accessibility:**\n- When the slot is replaced by an `mdc-button`:\n - `aria-label` should be passed to the `mdc-button`.\n - `aria-expanded` should be passed to the `mdc-button`.\n\n**Notes:**\n- If the slot is replaced by an invalid tag name or contains multiple elements,\n the divider defaults to the **Primary** type.\n- To override the styles of the divider, use the provided CSS custom properties.",
12707
+ "name": "Divider",
12708
+ "cssProperties": [
12955
12709
  {
12956
- "description": "This is a default slot for checkbox or toggle components.",
12957
- "name": "default"
12958
- }
12959
- ],
12960
- "members": [
12710
+ "description": "background color of the divider",
12711
+ "name": "--mdc-divider-background-color"
12712
+ },
12961
12713
  {
12962
- "kind": "field",
12963
- "name": "dataAriaLabel",
12964
- "type": {
12965
- "text": "string | null"
12966
- },
12967
- "default": "null",
12968
- "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
12969
- "attribute": "data-aria-label",
12970
- "reflects": true,
12971
- "inheritedFrom": {
12972
- "name": "DataAriaLabelMixin",
12973
- "module": "utils/mixins/DataAriaLabelMixin.js"
12974
- }
12714
+ "description": "width of the divider",
12715
+ "name": "--mdc-divider-width"
12975
12716
  },
12976
12717
  {
12977
- "kind": "field",
12978
- "name": "disabled",
12979
- "type": {
12980
- "text": "boolean | undefined"
12981
- },
12982
- "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
12983
- "default": "undefined",
12984
- "attribute": "disabled",
12985
- "reflects": true,
12986
- "inheritedFrom": {
12987
- "name": "DisabledMixin",
12988
- "module": "utils/mixins/DisabledMixin.js"
12989
- }
12718
+ "description": "gradient of the horizontal divider",
12719
+ "name": "--mdc-divider-horizontal-gradient"
12990
12720
  },
12991
12721
  {
12992
- "kind": "field",
12993
- "name": "label",
12994
- "type": {
12995
- "text": "string | undefined"
12996
- },
12997
- "description": "The label of the input field. It is linked to the input field using the `for` attribute.",
12998
- "attribute": "label",
12999
- "reflects": true,
13000
- "inheritedFrom": {
13001
- "name": "FormfieldWrapper",
13002
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
13003
- }
12722
+ "description": "gradient of the vertical divider",
12723
+ "name": "--mdc-divider-vertical-gradient"
13004
12724
  },
13005
12725
  {
13006
- "kind": "field",
13007
- "name": "required",
13008
- "type": {
13009
- "text": "boolean"
13010
- },
13011
- "default": "false",
13012
- "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
13013
- "attribute": "required",
13014
- "reflects": true,
13015
- "inheritedFrom": {
13016
- "name": "FormfieldWrapper",
13017
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
13018
- }
12726
+ "description": "font size of label in the text divider",
12727
+ "name": "--mdc-divider-text-size"
13019
12728
  },
13020
12729
  {
13021
- "kind": "field",
13022
- "name": "helpTextType",
13023
- "type": {
13024
- "text": "ValidationType"
13025
- },
13026
- "description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
13027
- "attribute": "help-text-type",
13028
- "reflects": true,
13029
- "inheritedFrom": {
13030
- "name": "FormfieldWrapper",
13031
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
13032
- }
12730
+ "description": "font color of label in the text divider",
12731
+ "name": "--mdc-divider-text-color"
12732
+ },
12733
+ {
12734
+ "description": "left and right margin of label in the text divider",
12735
+ "name": "--mdc-divider-text-margin"
12736
+ },
12737
+ {
12738
+ "description": "line height of label in the text divider",
12739
+ "name": "--mdc-divider-text-line-height"
12740
+ },
12741
+ {
12742
+ "description": "background color of the grabber button in rest state",
12743
+ "name": "--mdc-divider-grabber-button-background-color-normal"
12744
+ },
12745
+ {
12746
+ "description": "background color of the grabber button in hover state",
12747
+ "name": "--mdc-divider-grabber-button-background-color-hover"
12748
+ },
12749
+ {
12750
+ "description": "background color of the grabber button in pressed state",
12751
+ "name": "--mdc-divider-grabber-button-background-color-pressed"
12752
+ },
12753
+ {
12754
+ "description": "border color of the grabber button",
12755
+ "name": "--mdc-divider-grabber-button-border-color"
13033
12756
  },
12757
+ {
12758
+ "description": "border radius of the grabber button",
12759
+ "name": "--mdc-divider-grabber-button-border-radius"
12760
+ }
12761
+ ],
12762
+ "members": [
13034
12763
  {
13035
12764
  "kind": "field",
13036
- "name": "helpText",
12765
+ "name": "orientation",
13037
12766
  "type": {
13038
- "text": "string | undefined"
12767
+ "text": "DividerOrientation"
13039
12768
  },
13040
- "description": "The help text that is displayed below the input field.",
13041
- "attribute": "help-text",
13042
- "reflects": true,
13043
- "inheritedFrom": {
13044
- "name": "FormfieldWrapper",
13045
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
13046
- }
12769
+ "description": "Two orientations of divider\n- **horizontal**: A thin, horizontal line with 0.0625rem width.\n- **vertical**: A thin, vertical line with 0.0625rem width.\n\nNote: We do not support \"Vertical Text Divider\" as of now.",
12770
+ "default": "horizontal",
12771
+ "attribute": "orientation",
12772
+ "reflects": true
13047
12773
  },
13048
12774
  {
13049
12775
  "kind": "field",
13050
- "name": "toggletipText",
12776
+ "name": "variant",
13051
12777
  "type": {
13052
- "text": "string | undefined"
12778
+ "text": "DividerVariant"
13053
12779
  },
13054
- "description": "The toggletip text that is displayed when the label is hovered.\nIt is used to provide additional information about the label.",
13055
- "attribute": "toggletip-text",
13056
- "reflects": true,
13057
- "inheritedFrom": {
13058
- "name": "FormfieldWrapper",
13059
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
13060
- }
12780
+ "description": "Two variants of divider\n- **solid**: Solid line.\n- **gradient**: Gradient Line that fades on either sides of the divider.",
12781
+ "default": "solid",
12782
+ "attribute": "variant",
12783
+ "reflects": true
13061
12784
  },
13062
12785
  {
13063
12786
  "kind": "field",
13064
- "name": "toggletipPlacement",
12787
+ "name": "arrowDirection",
13065
12788
  "type": {
13066
- "text": "PopoverPlacement"
12789
+ "text": "Directions"
13067
12790
  },
13068
- "description": "The placement of the toggletip that is displayed when the info icon is hovered.",
13069
- "default": "'top'",
13070
- "attribute": "toggletip-placement",
13071
- "reflects": true,
13072
- "inheritedFrom": {
13073
- "name": "FormfieldWrapper",
13074
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
13075
- }
12791
+ "description": "Direction of the arrow icon, if applicable.\n- **positive**\n- **negative**\n\nNote: Positive and Negative directions are defined based on Cartesian plane.",
12792
+ "default": "'negative'",
12793
+ "attribute": "arrow-direction",
12794
+ "reflects": true
13076
12795
  },
13077
12796
  {
13078
12797
  "kind": "field",
13079
- "name": "infoIconAriaLabel",
12798
+ "name": "buttonPosition",
13080
12799
  "type": {
13081
- "text": "string | undefined"
12800
+ "text": "Directions"
13082
12801
  },
13083
- "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.",
13084
- "attribute": "info-icon-aria-label",
13085
- "reflects": true,
13086
- "inheritedFrom": {
13087
- "name": "FormfieldWrapper",
13088
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
13089
- }
12802
+ "description": "Position of the button, if applicable.\n- **positive**\n- **negative**\n\nNote: Positive and Negative directions are defined based on Cartesian plane.",
12803
+ "default": "'negative'",
12804
+ "attribute": "button-position",
12805
+ "reflects": true
13090
12806
  },
13091
12807
  {
13092
12808
  "kind": "method",
13093
- "name": "renderLabelElement",
13094
- "privacy": "protected",
13095
- "description": "creates the label element when the label property is set.\nid is used to link the label with the input field.",
13096
- "return": {
13097
- "type": {
13098
- "text": ""
12809
+ "name": "setVariant",
12810
+ "privacy": "private",
12811
+ "parameters": [
12812
+ {
12813
+ "name": "variant",
12814
+ "type": {
12815
+ "text": "DividerVariant"
12816
+ },
12817
+ "description": "The variant to set."
13099
12818
  }
13100
- },
13101
- "inheritedFrom": {
13102
- "name": "FormfieldWrapper",
13103
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
13104
- }
12819
+ ],
12820
+ "description": "Sets the variant attribute for the divider component.\nIf the provided variant is not included in the DIVIDER_VARIANT,\nit defaults to the value specified in DEFAULTS.VARIANT."
13105
12821
  },
13106
12822
  {
13107
12823
  "kind": "method",
13108
- "name": "renderHelpTextIcon",
13109
- "privacy": "protected",
13110
- "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.",
13111
- "return": {
13112
- "type": {
13113
- "text": ""
12824
+ "name": "setOrientation",
12825
+ "privacy": "private",
12826
+ "parameters": [
12827
+ {
12828
+ "name": "orientation",
12829
+ "type": {
12830
+ "text": "DividerOrientation"
12831
+ },
12832
+ "description": "The orientation to set."
13114
12833
  }
13115
- },
13116
- "inheritedFrom": {
13117
- "name": "FormfieldWrapper",
13118
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
13119
- }
12834
+ ],
12835
+ "description": "Sets the orientation attribute for the divider component.\nIf the provided orientation is not included in the DIVIDER_ORIENTATION,\nit defaults to the value specified in DEFAULTS.ORIENTATION."
13120
12836
  },
13121
12837
  {
13122
12838
  "kind": "method",
13123
- "name": "renderHelpText",
13124
- "privacy": "protected",
13125
- "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.",
13126
- "return": {
13127
- "type": {
13128
- "text": ""
12839
+ "name": "ensureValidDirections",
12840
+ "privacy": "private",
12841
+ "description": "Sets the buttonPosition and arrowDirection attribute for the divider component.\nIf the provided buttonPosition and arrowDirection are not included in the DIRECTIONS,\nit defaults to the value specified in DIRECTIONS based on the ORIENTATION.",
12842
+ "parameters": [
12843
+ {
12844
+ "description": "The buttonPosition to set.",
12845
+ "name": "buttonPosition"
12846
+ },
12847
+ {
12848
+ "description": "The arrowDirection to set.",
12849
+ "name": "arrowDirection"
13129
12850
  }
13130
- },
13131
- "inheritedFrom": {
13132
- "name": "FormfieldWrapper",
13133
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
13134
- }
12851
+ ]
13135
12852
  },
13136
12853
  {
13137
12854
  "kind": "method",
13138
- "name": "renderLabel",
13139
- "privacy": "protected",
13140
- "description": "renders the mdc-label-text container that contains the label and labelInfoToggleTip.",
12855
+ "name": "setGrabberButton",
12856
+ "privacy": "private",
13141
12857
  "return": {
13142
12858
  "type": {
13143
- "text": ""
12859
+ "text": "void"
13144
12860
  }
13145
12861
  },
13146
- "inheritedFrom": {
13147
- "name": "FormfieldWrapper",
13148
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
13149
- }
12862
+ "description": "Configures the grabber button within the divider.\n\n- Sets the `prefix-icon` attribute for the grabber button based\non the `arrow-direction` and `orientation` properties.\n\nThis method updates the DOM element dynamically if a grabber button is present."
13150
12863
  },
13151
12864
  {
13152
12865
  "kind": "method",
13153
- "name": "renderHelperText",
13154
- "privacy": "protected",
13155
- "description": "renders the mdc-help-text container that contains the helpertext icon and helpertext.",
12866
+ "name": "getArrowIcon",
12867
+ "privacy": "private",
13156
12868
  "return": {
13157
12869
  "type": {
13158
12870
  "text": ""
13159
12871
  }
13160
12872
  },
13161
- "inheritedFrom": {
13162
- "name": "FormfieldWrapper",
13163
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
13164
- }
13165
- }
13166
- ],
13167
- "mixins": [
12873
+ "description": "Determines the arrow icon based on the consumer-defined `arrowDirection`."
12874
+ },
13168
12875
  {
13169
- "name": "DataAriaLabelMixin",
13170
- "module": "/src/utils/mixins/DataAriaLabelMixin"
12876
+ "kind": "method",
12877
+ "name": "inferDividerType",
12878
+ "privacy": "private",
12879
+ "description": "Infers the type of divider based on the kind of slot present.",
12880
+ "parameters": [
12881
+ {
12882
+ "description": "default slot of divider",
12883
+ "name": "slot"
12884
+ }
12885
+ ]
13171
12886
  }
13172
12887
  ],
13173
- "superclass": {
13174
- "name": "FormfieldWrapper",
13175
- "module": "/src/components/formfieldwrapper/formfieldwrapper.component"
13176
- },
13177
- "tagName": "mdc-formfieldgroup",
13178
- "jsDoc": "/**\n * `mdc-formfieldgroup` component, groups the form field components together.\n * All passed in children will have a gap of 12px (0.75rem) each applied.\n *\n * This component is specifically for creating a `checkbox` group and a `toggle` group component.\n * For the radiogroup use the RadioGroup component instead.\n *\n * The header text and description text are displayed above the items with accessible labels.<br/>\n * The consumer has to provide atleast the header-text or the aria-label,\n * like one of them <b>has</b> to be passed in always, otherwise its not accessible.\n *\n * The role will be set to `group`.\n * The aria-label will be set with the data-aria-label property.\n * The aria-labelledby will be set with the header id which contains the header text information.\n * The aria-describedby will be set with the description id which contains the description text information.\n *\n * @tagname mdc-formfieldgroup\n *\n * @dependency mdc-button\n * @dependency mdc-icon\n * @dependency mdc-text\n * @dependency mdc-toggletip\n *\n * @slot default - This is a default slot for checkbox or toggle components.\n */",
13179
- "customElement": true,
13180
12888
  "attributes": [
13181
12889
  {
13182
- "name": "data-aria-label",
13183
- "type": {
13184
- "text": "string | null"
13185
- },
13186
- "default": "null",
13187
- "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
13188
- "fieldName": "dataAriaLabel",
13189
- "inheritedFrom": {
13190
- "name": "DataAriaLabelMixin",
13191
- "module": "src/utils/mixins/DataAriaLabelMixin.ts"
13192
- }
13193
- },
13194
- {
13195
- "name": "disabled",
13196
- "type": {
13197
- "text": "boolean | undefined"
13198
- },
13199
- "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
13200
- "default": "undefined",
13201
- "fieldName": "disabled",
13202
- "inheritedFrom": {
13203
- "name": "DisabledMixin",
13204
- "module": "src/utils/mixins/DisabledMixin.ts"
13205
- }
13206
- },
13207
- {
13208
- "name": "label",
13209
- "type": {
13210
- "text": "string | undefined"
13211
- },
13212
- "description": "The label of the input field. It is linked to the input field using the `for` attribute.",
13213
- "fieldName": "label",
13214
- "inheritedFrom": {
13215
- "name": "FormfieldWrapper",
13216
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
13217
- }
13218
- },
13219
- {
13220
- "name": "required",
13221
- "type": {
13222
- "text": "boolean"
13223
- },
13224
- "default": "false",
13225
- "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
13226
- "fieldName": "required",
13227
- "inheritedFrom": {
13228
- "name": "FormfieldWrapper",
13229
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
13230
- }
13231
- },
13232
- {
13233
- "name": "help-text-type",
13234
- "type": {
13235
- "text": "ValidationType"
13236
- },
13237
- "description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
13238
- "fieldName": "helpTextType",
13239
- "inheritedFrom": {
13240
- "name": "FormfieldWrapper",
13241
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
13242
- }
13243
- },
13244
- {
13245
- "name": "help-text",
12890
+ "name": "orientation",
13246
12891
  "type": {
13247
- "text": "string | undefined"
12892
+ "text": "DividerOrientation"
13248
12893
  },
13249
- "description": "The help text that is displayed below the input field.",
13250
- "fieldName": "helpText",
13251
- "inheritedFrom": {
13252
- "name": "FormfieldWrapper",
13253
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
13254
- }
12894
+ "description": "Two orientations of divider\n- **horizontal**: A thin, horizontal line with 0.0625rem width.\n- **vertical**: A thin, vertical line with 0.0625rem width.\n\nNote: We do not support \"Vertical Text Divider\" as of now.",
12895
+ "default": "horizontal",
12896
+ "fieldName": "orientation"
13255
12897
  },
13256
12898
  {
13257
- "name": "toggletip-text",
12899
+ "name": "variant",
13258
12900
  "type": {
13259
- "text": "string | undefined"
12901
+ "text": "DividerVariant"
13260
12902
  },
13261
- "description": "The toggletip text that is displayed when the label is hovered.\nIt is used to provide additional information about the label.",
13262
- "fieldName": "toggletipText",
13263
- "inheritedFrom": {
13264
- "name": "FormfieldWrapper",
13265
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
13266
- }
12903
+ "description": "Two variants of divider\n- **solid**: Solid line.\n- **gradient**: Gradient Line that fades on either sides of the divider.",
12904
+ "default": "solid",
12905
+ "fieldName": "variant"
13267
12906
  },
13268
12907
  {
13269
- "name": "toggletip-placement",
12908
+ "name": "arrow-direction",
13270
12909
  "type": {
13271
- "text": "PopoverPlacement"
12910
+ "text": "Directions"
13272
12911
  },
13273
- "description": "The placement of the toggletip that is displayed when the info icon is hovered.",
13274
- "default": "'top'",
13275
- "fieldName": "toggletipPlacement",
13276
- "inheritedFrom": {
13277
- "name": "FormfieldWrapper",
13278
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
13279
- }
12912
+ "description": "Direction of the arrow icon, if applicable.\n- **positive**\n- **negative**\n\nNote: Positive and Negative directions are defined based on Cartesian plane.",
12913
+ "default": "'negative'",
12914
+ "fieldName": "arrowDirection"
13280
12915
  },
13281
12916
  {
13282
- "name": "info-icon-aria-label",
12917
+ "name": "button-position",
13283
12918
  "type": {
13284
- "text": "string | undefined"
12919
+ "text": "Directions"
13285
12920
  },
13286
- "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.",
13287
- "fieldName": "infoIconAriaLabel",
13288
- "inheritedFrom": {
13289
- "name": "FormfieldWrapper",
13290
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
13291
- }
12921
+ "description": "Position of the button, if applicable.\n- **positive**\n- **negative**\n\nNote: Positive and Negative directions are defined based on Cartesian plane.",
12922
+ "default": "'negative'",
12923
+ "fieldName": "buttonPosition"
13292
12924
  }
13293
- ]
12925
+ ],
12926
+ "superclass": {
12927
+ "name": "Component",
12928
+ "module": "/src/models"
12929
+ },
12930
+ "tagName": "mdc-divider",
12931
+ "jsDoc": "/**\n * `mdc-divider` is a component that provides a line to separate and organize content.\n * It can also include a button or text positioned centrally, allowing users to interact with the layout.\n *\n * **Divider Orientation:**\n * - **Horizontal**: A thin, horizontal line.\n * - **Vertical**: A thin, vertical line.\n *\n * **Divider Variants:**\n * - **solid**: Solid line.\n * - **gradient**: Gradient Line.\n *\n * **Divider Types:**\n * - The type of divider is inferred based on the kind of slot present.\n * - **Primary**: A simple horizontal or vertical divider.\n * - **Text**: A horizontal divider with a text label in the center.\n * - **Grabber Button**: A horizontal or vertical divider with a styled button in the center.\n *\n * **Accessibility:**\n * - When the slot is replaced by an `mdc-button`:\n * - `aria-label` should be passed to the `mdc-button`.\n * - `aria-expanded` should be passed to the `mdc-button`.\n *\n * **Notes:**\n * - If the slot is replaced by an invalid tag name or contains multiple elements,\n * the divider defaults to the **Primary** type.\n * - To override the styles of the divider, use the provided CSS custom properties.\n *\n * @tagname mdc-divider\n *\n * @cssproperty --mdc-divider-background-color - background color of the divider\n * @cssproperty --mdc-divider-width - width of the divider\n * @cssproperty --mdc-divider-horizontal-gradient - gradient of the horizontal divider\n * @cssproperty --mdc-divider-vertical-gradient - gradient of the vertical divider\n * @cssproperty --mdc-divider-text-size - font size of label in the text divider\n * @cssproperty --mdc-divider-text-color - font color of label in the text divider\n * @cssproperty --mdc-divider-text-margin - left and right margin of label in the text divider\n * @cssproperty --mdc-divider-text-line-height - line height of label in the text divider\n * @cssproperty --mdc-divider-grabber-button-background-color-normal - background color of the grabber button\n * in rest state\n * @cssproperty --mdc-divider-grabber-button-background-color-hover - background color of the grabber button\n * in hover state\n * @cssproperty --mdc-divider-grabber-button-background-color-pressed - background color of the grabber button\n * in pressed state\n * @cssproperty --mdc-divider-grabber-button-border-color - border color of the grabber button\n * @cssproperty --mdc-divider-grabber-button-border-radius - border radius of the grabber button\n */",
12932
+ "customElement": true
13294
12933
  }
13295
12934
  ],
13296
12935
  "exports": [
@@ -13298,8 +12937,8 @@
13298
12937
  "kind": "js",
13299
12938
  "name": "default",
13300
12939
  "declaration": {
13301
- "name": "FormfieldGroup",
13302
- "module": "components/formfieldgroup/formfieldgroup.component.js"
12940
+ "name": "Divider",
12941
+ "module": "components/divider/divider.component.js"
13303
12942
  }
13304
12943
  }
13305
12944
  ]
@@ -13997,13 +13636,49 @@
13997
13636
  },
13998
13637
  {
13999
13638
  "kind": "javascript-module",
14000
- "path": "components/formfieldwrapper/formfieldwrapper.component.js",
13639
+ "path": "components/formfieldgroup/formfieldgroup.component.js",
14001
13640
  "declarations": [
14002
13641
  {
14003
13642
  "kind": "class",
14004
- "description": "formfieldwrapper is a component that contains the label and helper/validation text\n that can be configured in various ways to suit different use cases (most of the input related components).\nIt is used as an internal component and is not intended to be used directly by consumers.",
14005
- "name": "FormfieldWrapper",
13643
+ "description": "`mdc-formfieldgroup` component, groups the form field components together.\nAll passed in children will have a gap of 12px (0.75rem) each applied.\n\nThis component is specifically for creating a `checkbox` group and a `toggle` group component.\nFor the radiogroup use the RadioGroup component instead.\n\nThe header text and description text are displayed above the items with accessible labels.<br/>\nThe consumer has to provide atleast the header-text or the aria-label,\nlike one of them <b>has</b> to be passed in always, otherwise its not accessible.\n\nThe role will be set to `group`.\nThe aria-label will be set with the data-aria-label property.\nThe aria-labelledby will be set with the header id which contains the header text information.\nThe aria-describedby will be set with the description id which contains the description text information.",
13644
+ "name": "FormfieldGroup",
13645
+ "slots": [
13646
+ {
13647
+ "description": "This is a default slot for checkbox or toggle components.",
13648
+ "name": "default"
13649
+ }
13650
+ ],
14006
13651
  "members": [
13652
+ {
13653
+ "kind": "field",
13654
+ "name": "dataAriaLabel",
13655
+ "type": {
13656
+ "text": "string | null"
13657
+ },
13658
+ "default": "null",
13659
+ "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
13660
+ "attribute": "data-aria-label",
13661
+ "reflects": true,
13662
+ "inheritedFrom": {
13663
+ "name": "DataAriaLabelMixin",
13664
+ "module": "utils/mixins/DataAriaLabelMixin.js"
13665
+ }
13666
+ },
13667
+ {
13668
+ "kind": "field",
13669
+ "name": "disabled",
13670
+ "type": {
13671
+ "text": "boolean | undefined"
13672
+ },
13673
+ "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
13674
+ "default": "undefined",
13675
+ "attribute": "disabled",
13676
+ "reflects": true,
13677
+ "inheritedFrom": {
13678
+ "name": "DisabledMixin",
13679
+ "module": "utils/mixins/DisabledMixin.js"
13680
+ }
13681
+ },
14007
13682
  {
14008
13683
  "kind": "field",
14009
13684
  "name": "label",
@@ -14012,7 +13687,11 @@
14012
13687
  },
14013
13688
  "description": "The label of the input field. It is linked to the input field using the `for` attribute.",
14014
13689
  "attribute": "label",
14015
- "reflects": true
13690
+ "reflects": true,
13691
+ "inheritedFrom": {
13692
+ "name": "FormfieldWrapper",
13693
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
13694
+ }
14016
13695
  },
14017
13696
  {
14018
13697
  "kind": "field",
@@ -14023,7 +13702,11 @@
14023
13702
  "default": "false",
14024
13703
  "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
14025
13704
  "attribute": "required",
14026
- "reflects": true
13705
+ "reflects": true,
13706
+ "inheritedFrom": {
13707
+ "name": "FormfieldWrapper",
13708
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
13709
+ }
14027
13710
  },
14028
13711
  {
14029
13712
  "kind": "field",
@@ -14033,7 +13716,11 @@
14033
13716
  },
14034
13717
  "description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
14035
13718
  "attribute": "help-text-type",
14036
- "reflects": true
13719
+ "reflects": true,
13720
+ "inheritedFrom": {
13721
+ "name": "FormfieldWrapper",
13722
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
13723
+ }
14037
13724
  },
14038
13725
  {
14039
13726
  "kind": "field",
@@ -14043,7 +13730,11 @@
14043
13730
  },
14044
13731
  "description": "The help text that is displayed below the input field.",
14045
13732
  "attribute": "help-text",
14046
- "reflects": true
13733
+ "reflects": true,
13734
+ "inheritedFrom": {
13735
+ "name": "FormfieldWrapper",
13736
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
13737
+ }
14047
13738
  },
14048
13739
  {
14049
13740
  "kind": "field",
@@ -14053,7 +13744,11 @@
14053
13744
  },
14054
13745
  "description": "The toggletip text that is displayed when the label is hovered.\nIt is used to provide additional information about the label.",
14055
13746
  "attribute": "toggletip-text",
14056
- "reflects": true
13747
+ "reflects": true,
13748
+ "inheritedFrom": {
13749
+ "name": "FormfieldWrapper",
13750
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
13751
+ }
14057
13752
  },
14058
13753
  {
14059
13754
  "kind": "field",
@@ -14064,7 +13759,11 @@
14064
13759
  "description": "The placement of the toggletip that is displayed when the info icon is hovered.",
14065
13760
  "default": "'top'",
14066
13761
  "attribute": "toggletip-placement",
14067
- "reflects": true
13762
+ "reflects": true,
13763
+ "inheritedFrom": {
13764
+ "name": "FormfieldWrapper",
13765
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
13766
+ }
14068
13767
  },
14069
13768
  {
14070
13769
  "kind": "field",
@@ -14074,7 +13773,11 @@
14074
13773
  },
14075
13774
  "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.",
14076
13775
  "attribute": "info-icon-aria-label",
14077
- "reflects": true
13776
+ "reflects": true,
13777
+ "inheritedFrom": {
13778
+ "name": "FormfieldWrapper",
13779
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
13780
+ }
14078
13781
  },
14079
13782
  {
14080
13783
  "kind": "method",
@@ -14085,6 +13788,10 @@
14085
13788
  "type": {
14086
13789
  "text": ""
14087
13790
  }
13791
+ },
13792
+ "inheritedFrom": {
13793
+ "name": "FormfieldWrapper",
13794
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
14088
13795
  }
14089
13796
  },
14090
13797
  {
@@ -14096,6 +13803,10 @@
14096
13803
  "type": {
14097
13804
  "text": ""
14098
13805
  }
13806
+ },
13807
+ "inheritedFrom": {
13808
+ "name": "FormfieldWrapper",
13809
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
14099
13810
  }
14100
13811
  },
14101
13812
  {
@@ -14107,6 +13818,10 @@
14107
13818
  "type": {
14108
13819
  "text": ""
14109
13820
  }
13821
+ },
13822
+ "inheritedFrom": {
13823
+ "name": "FormfieldWrapper",
13824
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
14110
13825
  }
14111
13826
  },
14112
13827
  {
@@ -14118,6 +13833,10 @@
14118
13833
  "type": {
14119
13834
  "text": ""
14120
13835
  }
13836
+ },
13837
+ "inheritedFrom": {
13838
+ "name": "FormfieldWrapper",
13839
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
14121
13840
  }
14122
13841
  },
14123
13842
  {
@@ -14129,32 +13848,64 @@
14129
13848
  "type": {
14130
13849
  "text": ""
14131
13850
  }
13851
+ },
13852
+ "inheritedFrom": {
13853
+ "name": "FormfieldWrapper",
13854
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
13855
+ }
13856
+ }
13857
+ ],
13858
+ "mixins": [
13859
+ {
13860
+ "name": "DataAriaLabelMixin",
13861
+ "module": "/src/utils/mixins/DataAriaLabelMixin"
13862
+ }
13863
+ ],
13864
+ "superclass": {
13865
+ "name": "FormfieldWrapper",
13866
+ "module": "/src/components/formfieldwrapper/formfieldwrapper.component"
13867
+ },
13868
+ "tagName": "mdc-formfieldgroup",
13869
+ "jsDoc": "/**\n * `mdc-formfieldgroup` component, groups the form field components together.\n * All passed in children will have a gap of 12px (0.75rem) each applied.\n *\n * This component is specifically for creating a `checkbox` group and a `toggle` group component.\n * For the radiogroup use the RadioGroup component instead.\n *\n * The header text and description text are displayed above the items with accessible labels.<br/>\n * The consumer has to provide atleast the header-text or the aria-label,\n * like one of them <b>has</b> to be passed in always, otherwise its not accessible.\n *\n * The role will be set to `group`.\n * The aria-label will be set with the data-aria-label property.\n * The aria-labelledby will be set with the header id which contains the header text information.\n * The aria-describedby will be set with the description id which contains the description text information.\n *\n * @tagname mdc-formfieldgroup\n *\n * @dependency mdc-button\n * @dependency mdc-icon\n * @dependency mdc-text\n * @dependency mdc-toggletip\n *\n * @slot default - This is a default slot for checkbox or toggle components.\n */",
13870
+ "customElement": true,
13871
+ "attributes": [
13872
+ {
13873
+ "name": "data-aria-label",
13874
+ "type": {
13875
+ "text": "string | null"
13876
+ },
13877
+ "default": "null",
13878
+ "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
13879
+ "fieldName": "dataAriaLabel",
13880
+ "inheritedFrom": {
13881
+ "name": "DataAriaLabelMixin",
13882
+ "module": "src/utils/mixins/DataAriaLabelMixin.ts"
14132
13883
  }
14133
13884
  },
14134
13885
  {
14135
- "kind": "field",
14136
13886
  "name": "disabled",
14137
13887
  "type": {
14138
13888
  "text": "boolean | undefined"
14139
13889
  },
14140
13890
  "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
14141
13891
  "default": "undefined",
14142
- "attribute": "disabled",
14143
- "reflects": true,
13892
+ "fieldName": "disabled",
14144
13893
  "inheritedFrom": {
14145
13894
  "name": "DisabledMixin",
14146
- "module": "utils/mixins/DisabledMixin.js"
13895
+ "module": "src/utils/mixins/DisabledMixin.ts"
14147
13896
  }
14148
- }
14149
- ],
14150
- "attributes": [
13897
+ },
14151
13898
  {
14152
13899
  "name": "label",
14153
13900
  "type": {
14154
13901
  "text": "string | undefined"
14155
13902
  },
14156
13903
  "description": "The label of the input field. It is linked to the input field using the `for` attribute.",
14157
- "fieldName": "label"
13904
+ "fieldName": "label",
13905
+ "inheritedFrom": {
13906
+ "name": "FormfieldWrapper",
13907
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
13908
+ }
14158
13909
  },
14159
13910
  {
14160
13911
  "name": "required",
@@ -14163,7 +13914,11 @@
14163
13914
  },
14164
13915
  "default": "false",
14165
13916
  "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
14166
- "fieldName": "required"
13917
+ "fieldName": "required",
13918
+ "inheritedFrom": {
13919
+ "name": "FormfieldWrapper",
13920
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
13921
+ }
14167
13922
  },
14168
13923
  {
14169
13924
  "name": "help-text-type",
@@ -14171,7 +13926,11 @@
14171
13926
  "text": "ValidationType"
14172
13927
  },
14173
13928
  "description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
14174
- "fieldName": "helpTextType"
13929
+ "fieldName": "helpTextType",
13930
+ "inheritedFrom": {
13931
+ "name": "FormfieldWrapper",
13932
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
13933
+ }
14175
13934
  },
14176
13935
  {
14177
13936
  "name": "help-text",
@@ -14179,7 +13938,11 @@
14179
13938
  "text": "string | undefined"
14180
13939
  },
14181
13940
  "description": "The help text that is displayed below the input field.",
14182
- "fieldName": "helpText"
13941
+ "fieldName": "helpText",
13942
+ "inheritedFrom": {
13943
+ "name": "FormfieldWrapper",
13944
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
13945
+ }
14183
13946
  },
14184
13947
  {
14185
13948
  "name": "toggletip-text",
@@ -14187,7 +13950,11 @@
14187
13950
  "text": "string | undefined"
14188
13951
  },
14189
13952
  "description": "The toggletip text that is displayed when the label is hovered.\nIt is used to provide additional information about the label.",
14190
- "fieldName": "toggletipText"
13953
+ "fieldName": "toggletipText",
13954
+ "inheritedFrom": {
13955
+ "name": "FormfieldWrapper",
13956
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
13957
+ }
14191
13958
  },
14192
13959
  {
14193
13960
  "name": "toggletip-placement",
@@ -14196,7 +13963,11 @@
14196
13963
  },
14197
13964
  "description": "The placement of the toggletip that is displayed when the info icon is hovered.",
14198
13965
  "default": "'top'",
14199
- "fieldName": "toggletipPlacement"
13966
+ "fieldName": "toggletipPlacement",
13967
+ "inheritedFrom": {
13968
+ "name": "FormfieldWrapper",
13969
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
13970
+ }
14200
13971
  },
14201
13972
  {
14202
13973
  "name": "info-icon-aria-label",
@@ -14204,35 +13975,13 @@
14204
13975
  "text": "string | undefined"
14205
13976
  },
14206
13977
  "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.",
14207
- "fieldName": "infoIconAriaLabel"
14208
- },
14209
- {
14210
- "name": "disabled",
14211
- "type": {
14212
- "text": "boolean | undefined"
14213
- },
14214
- "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
14215
- "default": "undefined",
14216
- "fieldName": "disabled",
13978
+ "fieldName": "infoIconAriaLabel",
14217
13979
  "inheritedFrom": {
14218
- "name": "DisabledMixin",
14219
- "module": "src/utils/mixins/DisabledMixin.ts"
13980
+ "name": "FormfieldWrapper",
13981
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
14220
13982
  }
14221
13983
  }
14222
- ],
14223
- "mixins": [
14224
- {
14225
- "name": "DisabledMixin",
14226
- "module": "/src/utils/mixins/DisabledMixin"
14227
- }
14228
- ],
14229
- "superclass": {
14230
- "name": "Component",
14231
- "module": "/src/models"
14232
- },
14233
- "tagName": "mdc-formfieldwrapper",
14234
- "jsDoc": "/**\n * formfieldwrapper is a component that contains the label and helper/validation text\n * that can be configured in various ways to suit different use cases (most of the input related components).\n * It is used as an internal component and is not intended to be used directly by consumers.\n *\n * @tagname mdc-formfieldwrapper\n *\n * @dependency mdc-text\n * @dependency mdc-icon\n * @dependency mdc-button\n * @dependency mdc-toggletip\n *\n *\n */",
14235
- "customElement": true
13984
+ ]
14236
13985
  }
14237
13986
  ],
14238
13987
  "exports": [
@@ -14240,8 +13989,8 @@
14240
13989
  "kind": "js",
14241
13990
  "name": "default",
14242
13991
  "declaration": {
14243
- "name": "FormfieldWrapper",
14244
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
13992
+ "name": "FormfieldGroup",
13993
+ "module": "components/formfieldgroup/formfieldgroup.component.js"
14245
13994
  }
14246
13995
  }
14247
13996
  ]
@@ -14690,6 +14439,257 @@
14690
14439
  }
14691
14440
  ]
14692
14441
  },
14442
+ {
14443
+ "kind": "javascript-module",
14444
+ "path": "components/formfieldwrapper/formfieldwrapper.component.js",
14445
+ "declarations": [
14446
+ {
14447
+ "kind": "class",
14448
+ "description": "formfieldwrapper is a component that contains the label and helper/validation text\n that can be configured in various ways to suit different use cases (most of the input related components).\nIt is used as an internal component and is not intended to be used directly by consumers.",
14449
+ "name": "FormfieldWrapper",
14450
+ "members": [
14451
+ {
14452
+ "kind": "field",
14453
+ "name": "label",
14454
+ "type": {
14455
+ "text": "string | undefined"
14456
+ },
14457
+ "description": "The label of the input field. It is linked to the input field using the `for` attribute.",
14458
+ "attribute": "label",
14459
+ "reflects": true
14460
+ },
14461
+ {
14462
+ "kind": "field",
14463
+ "name": "required",
14464
+ "type": {
14465
+ "text": "boolean"
14466
+ },
14467
+ "default": "false",
14468
+ "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
14469
+ "attribute": "required",
14470
+ "reflects": true
14471
+ },
14472
+ {
14473
+ "kind": "field",
14474
+ "name": "helpTextType",
14475
+ "type": {
14476
+ "text": "ValidationType"
14477
+ },
14478
+ "description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
14479
+ "attribute": "help-text-type",
14480
+ "reflects": true
14481
+ },
14482
+ {
14483
+ "kind": "field",
14484
+ "name": "helpText",
14485
+ "type": {
14486
+ "text": "string | undefined"
14487
+ },
14488
+ "description": "The help text that is displayed below the input field.",
14489
+ "attribute": "help-text",
14490
+ "reflects": true
14491
+ },
14492
+ {
14493
+ "kind": "field",
14494
+ "name": "toggletipText",
14495
+ "type": {
14496
+ "text": "string | undefined"
14497
+ },
14498
+ "description": "The toggletip text that is displayed when the label is hovered.\nIt is used to provide additional information about the label.",
14499
+ "attribute": "toggletip-text",
14500
+ "reflects": true
14501
+ },
14502
+ {
14503
+ "kind": "field",
14504
+ "name": "toggletipPlacement",
14505
+ "type": {
14506
+ "text": "PopoverPlacement"
14507
+ },
14508
+ "description": "The placement of the toggletip that is displayed when the info icon is hovered.",
14509
+ "default": "'top'",
14510
+ "attribute": "toggletip-placement",
14511
+ "reflects": true
14512
+ },
14513
+ {
14514
+ "kind": "field",
14515
+ "name": "infoIconAriaLabel",
14516
+ "type": {
14517
+ "text": "string | undefined"
14518
+ },
14519
+ "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.",
14520
+ "attribute": "info-icon-aria-label",
14521
+ "reflects": true
14522
+ },
14523
+ {
14524
+ "kind": "method",
14525
+ "name": "renderLabelElement",
14526
+ "privacy": "protected",
14527
+ "description": "creates the label element when the label property is set.\nid is used to link the label with the input field.",
14528
+ "return": {
14529
+ "type": {
14530
+ "text": ""
14531
+ }
14532
+ }
14533
+ },
14534
+ {
14535
+ "kind": "method",
14536
+ "name": "renderHelpTextIcon",
14537
+ "privacy": "protected",
14538
+ "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.",
14539
+ "return": {
14540
+ "type": {
14541
+ "text": ""
14542
+ }
14543
+ }
14544
+ },
14545
+ {
14546
+ "kind": "method",
14547
+ "name": "renderHelpText",
14548
+ "privacy": "protected",
14549
+ "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.",
14550
+ "return": {
14551
+ "type": {
14552
+ "text": ""
14553
+ }
14554
+ }
14555
+ },
14556
+ {
14557
+ "kind": "method",
14558
+ "name": "renderLabel",
14559
+ "privacy": "protected",
14560
+ "description": "renders the mdc-label-text container that contains the label and labelInfoToggleTip.",
14561
+ "return": {
14562
+ "type": {
14563
+ "text": ""
14564
+ }
14565
+ }
14566
+ },
14567
+ {
14568
+ "kind": "method",
14569
+ "name": "renderHelperText",
14570
+ "privacy": "protected",
14571
+ "description": "renders the mdc-help-text container that contains the helpertext icon and helpertext.",
14572
+ "return": {
14573
+ "type": {
14574
+ "text": ""
14575
+ }
14576
+ }
14577
+ },
14578
+ {
14579
+ "kind": "field",
14580
+ "name": "disabled",
14581
+ "type": {
14582
+ "text": "boolean | undefined"
14583
+ },
14584
+ "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
14585
+ "default": "undefined",
14586
+ "attribute": "disabled",
14587
+ "reflects": true,
14588
+ "inheritedFrom": {
14589
+ "name": "DisabledMixin",
14590
+ "module": "utils/mixins/DisabledMixin.js"
14591
+ }
14592
+ }
14593
+ ],
14594
+ "attributes": [
14595
+ {
14596
+ "name": "label",
14597
+ "type": {
14598
+ "text": "string | undefined"
14599
+ },
14600
+ "description": "The label of the input field. It is linked to the input field using the `for` attribute.",
14601
+ "fieldName": "label"
14602
+ },
14603
+ {
14604
+ "name": "required",
14605
+ "type": {
14606
+ "text": "boolean"
14607
+ },
14608
+ "default": "false",
14609
+ "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
14610
+ "fieldName": "required"
14611
+ },
14612
+ {
14613
+ "name": "help-text-type",
14614
+ "type": {
14615
+ "text": "ValidationType"
14616
+ },
14617
+ "description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
14618
+ "fieldName": "helpTextType"
14619
+ },
14620
+ {
14621
+ "name": "help-text",
14622
+ "type": {
14623
+ "text": "string | undefined"
14624
+ },
14625
+ "description": "The help text that is displayed below the input field.",
14626
+ "fieldName": "helpText"
14627
+ },
14628
+ {
14629
+ "name": "toggletip-text",
14630
+ "type": {
14631
+ "text": "string | undefined"
14632
+ },
14633
+ "description": "The toggletip text that is displayed when the label is hovered.\nIt is used to provide additional information about the label.",
14634
+ "fieldName": "toggletipText"
14635
+ },
14636
+ {
14637
+ "name": "toggletip-placement",
14638
+ "type": {
14639
+ "text": "PopoverPlacement"
14640
+ },
14641
+ "description": "The placement of the toggletip that is displayed when the info icon is hovered.",
14642
+ "default": "'top'",
14643
+ "fieldName": "toggletipPlacement"
14644
+ },
14645
+ {
14646
+ "name": "info-icon-aria-label",
14647
+ "type": {
14648
+ "text": "string | undefined"
14649
+ },
14650
+ "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.",
14651
+ "fieldName": "infoIconAriaLabel"
14652
+ },
14653
+ {
14654
+ "name": "disabled",
14655
+ "type": {
14656
+ "text": "boolean | undefined"
14657
+ },
14658
+ "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
14659
+ "default": "undefined",
14660
+ "fieldName": "disabled",
14661
+ "inheritedFrom": {
14662
+ "name": "DisabledMixin",
14663
+ "module": "src/utils/mixins/DisabledMixin.ts"
14664
+ }
14665
+ }
14666
+ ],
14667
+ "mixins": [
14668
+ {
14669
+ "name": "DisabledMixin",
14670
+ "module": "/src/utils/mixins/DisabledMixin"
14671
+ }
14672
+ ],
14673
+ "superclass": {
14674
+ "name": "Component",
14675
+ "module": "/src/models"
14676
+ },
14677
+ "tagName": "mdc-formfieldwrapper",
14678
+ "jsDoc": "/**\n * formfieldwrapper is a component that contains the label and helper/validation text\n * that can be configured in various ways to suit different use cases (most of the input related components).\n * It is used as an internal component and is not intended to be used directly by consumers.\n *\n * @tagname mdc-formfieldwrapper\n *\n * @dependency mdc-text\n * @dependency mdc-icon\n * @dependency mdc-button\n * @dependency mdc-toggletip\n *\n *\n */",
14679
+ "customElement": true
14680
+ }
14681
+ ],
14682
+ "exports": [
14683
+ {
14684
+ "kind": "js",
14685
+ "name": "default",
14686
+ "declaration": {
14687
+ "name": "FormfieldWrapper",
14688
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
14689
+ }
14690
+ }
14691
+ ]
14692
+ },
14693
14693
  {
14694
14694
  "kind": "javascript-module",
14695
14695
  "path": "components/input/input.component.js",