@momentum-design/components 0.101.4 → 0.102.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/browser/index.js +431 -399
- package/dist/browser/index.js.map +4 -4
- package/dist/components/listitem/listitem.component.d.ts +7 -1
- package/dist/components/listitem/listitem.component.js +22 -14
- package/dist/components/listitem/listitem.styles.js +10 -5
- package/dist/components/typewriter/index.d.ts +7 -0
- package/dist/components/typewriter/index.js +4 -0
- package/dist/components/typewriter/typewriter.component.d.ts +192 -0
- package/dist/components/typewriter/typewriter.component.js +454 -0
- package/dist/components/typewriter/typewriter.constants.d.ts +20 -0
- package/dist/components/typewriter/typewriter.constants.js +22 -0
- package/dist/components/typewriter/typewriter.styles.d.ts +2 -0
- package/dist/components/typewriter/typewriter.styles.js +19 -0
- package/dist/components/typewriter/typewriter.types.d.ts +21 -0
- package/dist/components/typewriter/typewriter.types.js +1 -0
- package/dist/custom-elements.json +1543 -987
- package/dist/index.d.ts +4 -2
- package/dist/index.js +2 -1
- package/dist/react/index.d.ts +3 -2
- package/dist/react/index.js +3 -2
- package/dist/react/listitem/index.d.ts +7 -1
- package/dist/react/listitem/index.js +7 -1
- package/dist/react/typewriter/index.d.ts +51 -0
- package/dist/react/typewriter/index.js +59 -0
- package/package.json +1 -1
@@ -968,218 +968,6 @@
|
|
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
|
-
},
|
1183
971
|
{
|
1184
972
|
"kind": "javascript-module",
|
1185
973
|
"path": "components/alertchip/alertchip.component.js",
|
@@ -1775,6 +1563,218 @@
|
|
1775
1563
|
}
|
1776
1564
|
]
|
1777
1565
|
},
|
1566
|
+
{
|
1567
|
+
"kind": "javascript-module",
|
1568
|
+
"path": "components/animation/animation.component.js",
|
1569
|
+
"declarations": [
|
1570
|
+
{
|
1571
|
+
"kind": "class",
|
1572
|
+
"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.",
|
1573
|
+
"name": "Animation",
|
1574
|
+
"members": [
|
1575
|
+
{
|
1576
|
+
"kind": "field",
|
1577
|
+
"name": "name",
|
1578
|
+
"type": {
|
1579
|
+
"text": "AnimationNames | undefined"
|
1580
|
+
},
|
1581
|
+
"description": "Name of the animation (= filename)",
|
1582
|
+
"attribute": "name",
|
1583
|
+
"reflects": true
|
1584
|
+
},
|
1585
|
+
{
|
1586
|
+
"kind": "field",
|
1587
|
+
"name": "loop",
|
1588
|
+
"type": {
|
1589
|
+
"text": "LoopType | undefined"
|
1590
|
+
},
|
1591
|
+
"description": "How many times to loop the animation\n- \"true\" - infinite\n- \"false\" - no loop\n- number - number of times to loop",
|
1592
|
+
"attribute": "loop",
|
1593
|
+
"reflects": true
|
1594
|
+
},
|
1595
|
+
{
|
1596
|
+
"kind": "field",
|
1597
|
+
"name": "autoplay",
|
1598
|
+
"type": {
|
1599
|
+
"text": "boolean | undefined"
|
1600
|
+
},
|
1601
|
+
"description": "Weather start the animation automatically",
|
1602
|
+
"attribute": "autoplay",
|
1603
|
+
"reflects": true
|
1604
|
+
},
|
1605
|
+
{
|
1606
|
+
"kind": "field",
|
1607
|
+
"name": "ariaLabel",
|
1608
|
+
"type": {
|
1609
|
+
"text": "string | null"
|
1610
|
+
},
|
1611
|
+
"default": "null",
|
1612
|
+
"description": "Aria-label attribute to be set for accessibility",
|
1613
|
+
"attribute": "aria-label"
|
1614
|
+
},
|
1615
|
+
{
|
1616
|
+
"kind": "field",
|
1617
|
+
"name": "ariaLabelledBy",
|
1618
|
+
"type": {
|
1619
|
+
"text": "string | null"
|
1620
|
+
},
|
1621
|
+
"default": "null",
|
1622
|
+
"description": "Aria-labelledby attribute to be set for accessibility",
|
1623
|
+
"attribute": "aria-labelledby"
|
1624
|
+
},
|
1625
|
+
{
|
1626
|
+
"kind": "field",
|
1627
|
+
"name": "lottieInstance",
|
1628
|
+
"type": {
|
1629
|
+
"text": "AnimationItem | undefined"
|
1630
|
+
},
|
1631
|
+
"privacy": "private",
|
1632
|
+
"description": "Lottie animation instance"
|
1633
|
+
},
|
1634
|
+
{
|
1635
|
+
"kind": "field",
|
1636
|
+
"name": "containerRef",
|
1637
|
+
"type": {
|
1638
|
+
"text": "Ref<HTMLDivElement>"
|
1639
|
+
},
|
1640
|
+
"privacy": "private",
|
1641
|
+
"description": "Container for the animation"
|
1642
|
+
},
|
1643
|
+
{
|
1644
|
+
"kind": "field",
|
1645
|
+
"name": "animation",
|
1646
|
+
"description": "Exposed API of the animation library (lottie)",
|
1647
|
+
"readonly": true
|
1648
|
+
},
|
1649
|
+
{
|
1650
|
+
"kind": "method",
|
1651
|
+
"name": "getLoopValue",
|
1652
|
+
"privacy": "private"
|
1653
|
+
},
|
1654
|
+
{
|
1655
|
+
"kind": "method",
|
1656
|
+
"name": "onLoadSuccessHandler",
|
1657
|
+
"privacy": "private",
|
1658
|
+
"parameters": [
|
1659
|
+
{
|
1660
|
+
"name": "animationData",
|
1661
|
+
"type": {
|
1662
|
+
"text": "any"
|
1663
|
+
}
|
1664
|
+
}
|
1665
|
+
],
|
1666
|
+
"description": "Create new lotty instance for the loaded data"
|
1667
|
+
},
|
1668
|
+
{
|
1669
|
+
"kind": "method",
|
1670
|
+
"name": "onLoadFailHandler",
|
1671
|
+
"privacy": "private",
|
1672
|
+
"parameters": [
|
1673
|
+
{
|
1674
|
+
"name": "error",
|
1675
|
+
"type": {
|
1676
|
+
"text": "Error"
|
1677
|
+
}
|
1678
|
+
}
|
1679
|
+
],
|
1680
|
+
"description": "Error handler for animation loading"
|
1681
|
+
},
|
1682
|
+
{
|
1683
|
+
"kind": "method",
|
1684
|
+
"name": "getAnimationData",
|
1685
|
+
"privacy": "private",
|
1686
|
+
"description": "Import animation data dynamically"
|
1687
|
+
},
|
1688
|
+
{
|
1689
|
+
"kind": "field",
|
1690
|
+
"name": "onCompleteHandler",
|
1691
|
+
"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."
|
1692
|
+
}
|
1693
|
+
],
|
1694
|
+
"events": [
|
1695
|
+
{
|
1696
|
+
"name": "load",
|
1697
|
+
"type": {
|
1698
|
+
"text": "CustomEvent"
|
1699
|
+
},
|
1700
|
+
"description": "(React: onLoad) This event is dispatched when the animation is loaded",
|
1701
|
+
"reactName": "onLoad"
|
1702
|
+
},
|
1703
|
+
{
|
1704
|
+
"description": "(React: onComplete) This event is dispatched when all animation loops completed",
|
1705
|
+
"name": "complete",
|
1706
|
+
"reactName": "onComplete"
|
1707
|
+
},
|
1708
|
+
{
|
1709
|
+
"description": "(React: onError) This event is dispatched when animation loading failed",
|
1710
|
+
"name": "error",
|
1711
|
+
"reactName": "onError"
|
1712
|
+
}
|
1713
|
+
],
|
1714
|
+
"attributes": [
|
1715
|
+
{
|
1716
|
+
"name": "name",
|
1717
|
+
"type": {
|
1718
|
+
"text": "AnimationNames | undefined"
|
1719
|
+
},
|
1720
|
+
"description": "Name of the animation (= filename)",
|
1721
|
+
"fieldName": "name"
|
1722
|
+
},
|
1723
|
+
{
|
1724
|
+
"name": "loop",
|
1725
|
+
"type": {
|
1726
|
+
"text": "LoopType | undefined"
|
1727
|
+
},
|
1728
|
+
"description": "How many times to loop the animation\n- \"true\" - infinite\n- \"false\" - no loop\n- number - number of times to loop",
|
1729
|
+
"fieldName": "loop"
|
1730
|
+
},
|
1731
|
+
{
|
1732
|
+
"name": "autoplay",
|
1733
|
+
"type": {
|
1734
|
+
"text": "boolean | undefined"
|
1735
|
+
},
|
1736
|
+
"description": "Weather start the animation automatically",
|
1737
|
+
"fieldName": "autoplay"
|
1738
|
+
},
|
1739
|
+
{
|
1740
|
+
"name": "aria-label",
|
1741
|
+
"type": {
|
1742
|
+
"text": "string | null"
|
1743
|
+
},
|
1744
|
+
"default": "null",
|
1745
|
+
"description": "Aria-label attribute to be set for accessibility",
|
1746
|
+
"fieldName": "ariaLabel"
|
1747
|
+
},
|
1748
|
+
{
|
1749
|
+
"name": "aria-labelledby",
|
1750
|
+
"type": {
|
1751
|
+
"text": "string | null"
|
1752
|
+
},
|
1753
|
+
"default": "null",
|
1754
|
+
"description": "Aria-labelledby attribute to be set for accessibility",
|
1755
|
+
"fieldName": "ariaLabelledBy"
|
1756
|
+
}
|
1757
|
+
],
|
1758
|
+
"superclass": {
|
1759
|
+
"name": "Component",
|
1760
|
+
"module": "/src/models"
|
1761
|
+
},
|
1762
|
+
"tagName": "mdc-animation",
|
1763
|
+
"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 */",
|
1764
|
+
"customElement": true
|
1765
|
+
}
|
1766
|
+
],
|
1767
|
+
"exports": [
|
1768
|
+
{
|
1769
|
+
"kind": "js",
|
1770
|
+
"name": "default",
|
1771
|
+
"declaration": {
|
1772
|
+
"name": "Animation",
|
1773
|
+
"module": "components/animation/animation.component.js"
|
1774
|
+
}
|
1775
|
+
}
|
1776
|
+
]
|
1777
|
+
},
|
1778
1778
|
{
|
1779
1779
|
"kind": "javascript-module",
|
1780
1780
|
"path": "components/avatar/avatar.component.js",
|
@@ -7071,32 +7071,172 @@
|
|
7071
7071
|
},
|
7072
7072
|
{
|
7073
7073
|
"kind": "javascript-module",
|
7074
|
-
"path": "components/
|
7074
|
+
"path": "components/cardradio/cardradio.component.js",
|
7075
7075
|
"declarations": [
|
7076
7076
|
{
|
7077
7077
|
"kind": "class",
|
7078
|
-
"description": "
|
7079
|
-
"name": "
|
7078
|
+
"description": "cardradio component extends `mdc-card` and supports radio selection interaction addtionally.\n\nWhile using this component within a form or group of cards, make sure cards are in a role = \"radio-group\".\nThis card would have events for selected and unselected (similar to radio)\n\n**Note**: This is a single selection card i.e. interacting anywhere on the card would toggle the checked state.\nMake sure to pass only non-interactable elements within the slots.\n\nMake sure to pass the `card-title` mandatorily for this card.",
|
7079
|
+
"name": "CardRadio",
|
7080
7080
|
"cssProperties": [
|
7081
7081
|
{
|
7082
|
-
"description": "
|
7083
|
-
"name": "--mdc-
|
7082
|
+
"description": "The width of the card",
|
7083
|
+
"name": "--mdc-card-width",
|
7084
|
+
"inheritedFrom": {
|
7085
|
+
"name": "Card",
|
7086
|
+
"module": "src/components/card/card.component.ts"
|
7087
|
+
}
|
7088
|
+
}
|
7089
|
+
],
|
7090
|
+
"cssParts": [
|
7091
|
+
{
|
7092
|
+
"description": "The header part of the card",
|
7093
|
+
"name": "header",
|
7094
|
+
"inheritedFrom": {
|
7095
|
+
"name": "Card",
|
7096
|
+
"module": "src/components/card/card.component.ts"
|
7097
|
+
}
|
7084
7098
|
},
|
7085
7099
|
{
|
7086
|
-
"description": "
|
7087
|
-
"name": "
|
7100
|
+
"description": "The icon part of the card header",
|
7101
|
+
"name": "icon",
|
7102
|
+
"inheritedFrom": {
|
7103
|
+
"name": "Card",
|
7104
|
+
"module": "src/components/card/card.component.ts"
|
7105
|
+
}
|
7088
7106
|
},
|
7089
7107
|
{
|
7090
|
-
"description": "
|
7091
|
-
"name": "
|
7108
|
+
"description": "The body part of the card",
|
7109
|
+
"name": "body",
|
7110
|
+
"inheritedFrom": {
|
7111
|
+
"name": "Card",
|
7112
|
+
"module": "src/components/card/card.component.ts"
|
7113
|
+
}
|
7092
7114
|
},
|
7093
7115
|
{
|
7094
|
-
"description": "
|
7095
|
-
"name": "
|
7116
|
+
"description": "The image part of the card",
|
7117
|
+
"name": "image",
|
7118
|
+
"inheritedFrom": {
|
7119
|
+
"name": "Card",
|
7120
|
+
"module": "src/components/card/card.component.ts"
|
7121
|
+
}
|
7096
7122
|
},
|
7097
7123
|
{
|
7098
|
-
"description": "
|
7099
|
-
"name": "
|
7124
|
+
"description": "The footer part of the card",
|
7125
|
+
"name": "footer",
|
7126
|
+
"inheritedFrom": {
|
7127
|
+
"name": "Card",
|
7128
|
+
"module": "src/components/card/card.component.ts"
|
7129
|
+
}
|
7130
|
+
},
|
7131
|
+
{
|
7132
|
+
"description": "The link part of the card footer",
|
7133
|
+
"name": "footer-link",
|
7134
|
+
"inheritedFrom": {
|
7135
|
+
"name": "Card",
|
7136
|
+
"module": "src/components/card/card.component.ts"
|
7137
|
+
}
|
7138
|
+
},
|
7139
|
+
{
|
7140
|
+
"description": "The primary button part of the card footer",
|
7141
|
+
"name": "footer-button-primary",
|
7142
|
+
"inheritedFrom": {
|
7143
|
+
"name": "Card",
|
7144
|
+
"module": "src/components/card/card.component.ts"
|
7145
|
+
}
|
7146
|
+
},
|
7147
|
+
{
|
7148
|
+
"description": "The secondary button part of the card footer",
|
7149
|
+
"name": "footer-button-secondary",
|
7150
|
+
"inheritedFrom": {
|
7151
|
+
"name": "Card",
|
7152
|
+
"module": "src/components/card/card.component.ts"
|
7153
|
+
}
|
7154
|
+
},
|
7155
|
+
{
|
7156
|
+
"description": "The icon button part of the card header",
|
7157
|
+
"name": "icon-button",
|
7158
|
+
"inheritedFrom": {
|
7159
|
+
"name": "Card",
|
7160
|
+
"module": "src/components/card/card.component.ts"
|
7161
|
+
}
|
7162
|
+
},
|
7163
|
+
{
|
7164
|
+
"description": "The text part of the card",
|
7165
|
+
"name": "text",
|
7166
|
+
"inheritedFrom": {
|
7167
|
+
"name": "Card",
|
7168
|
+
"module": "src/components/card/card.component.ts"
|
7169
|
+
}
|
7170
|
+
},
|
7171
|
+
{
|
7172
|
+
"description": "The check part of the card",
|
7173
|
+
"name": "check"
|
7174
|
+
},
|
7175
|
+
{
|
7176
|
+
"description": "The check icon part of the card",
|
7177
|
+
"name": "check-icon"
|
7178
|
+
},
|
7179
|
+
{
|
7180
|
+
"description": "The check icon button part of the card",
|
7181
|
+
"name": "check-icon-button"
|
7182
|
+
}
|
7183
|
+
],
|
7184
|
+
"slots": [
|
7185
|
+
{
|
7186
|
+
"description": "This slot is for passing the content before the body",
|
7187
|
+
"name": "before-body",
|
7188
|
+
"inheritedFrom": {
|
7189
|
+
"name": "Card",
|
7190
|
+
"module": "src/components/card/card.component.ts"
|
7191
|
+
}
|
7192
|
+
},
|
7193
|
+
{
|
7194
|
+
"description": "This slot is for passing the text content for the card",
|
7195
|
+
"name": "body",
|
7196
|
+
"inheritedFrom": {
|
7197
|
+
"name": "Card",
|
7198
|
+
"module": "src/components/card/card.component.ts"
|
7199
|
+
}
|
7200
|
+
},
|
7201
|
+
{
|
7202
|
+
"description": "This slot is for passing the content after the body",
|
7203
|
+
"name": "after-body",
|
7204
|
+
"inheritedFrom": {
|
7205
|
+
"name": "Card",
|
7206
|
+
"module": "src/components/card/card.component.ts"
|
7207
|
+
}
|
7208
|
+
},
|
7209
|
+
{
|
7210
|
+
"description": "This slot is for passing `mdc-link` component within the footer section.",
|
7211
|
+
"name": "footer-link",
|
7212
|
+
"inheritedFrom": {
|
7213
|
+
"name": "Card",
|
7214
|
+
"module": "src/components/card/card.component.ts"
|
7215
|
+
}
|
7216
|
+
},
|
7217
|
+
{
|
7218
|
+
"description": "This slot is for passing primary variant of `mdc-button` component within the footer section.",
|
7219
|
+
"name": "footer-button-primary",
|
7220
|
+
"inheritedFrom": {
|
7221
|
+
"name": "Card",
|
7222
|
+
"module": "src/components/card/card.component.ts"
|
7223
|
+
}
|
7224
|
+
},
|
7225
|
+
{
|
7226
|
+
"description": "This slot is for passing secondary variant of `mdc-button` component within the footer section.",
|
7227
|
+
"name": "footer-button-secondary",
|
7228
|
+
"inheritedFrom": {
|
7229
|
+
"name": "Card",
|
7230
|
+
"module": "src/components/card/card.component.ts"
|
7231
|
+
}
|
7232
|
+
},
|
7233
|
+
{
|
7234
|
+
"description": " This slot is for passing custom footer content. Only use this if really needed, using the footer-link and footer-button slots is preferred.",
|
7235
|
+
"name": "footer",
|
7236
|
+
"inheritedFrom": {
|
7237
|
+
"name": "Card",
|
7238
|
+
"module": "src/components/card/card.component.ts"
|
7239
|
+
}
|
7100
7240
|
}
|
7101
7241
|
],
|
7102
7242
|
"members": [
|
@@ -7107,59 +7247,45 @@
|
|
7107
7247
|
"text": "boolean"
|
7108
7248
|
},
|
7109
7249
|
"default": "false",
|
7110
|
-
"description": "
|
7250
|
+
"description": "The checked state of the card",
|
7111
7251
|
"attribute": "checked",
|
7112
7252
|
"reflects": true
|
7113
7253
|
},
|
7114
7254
|
{
|
7115
7255
|
"kind": "field",
|
7116
|
-
"name": "
|
7117
|
-
"type": {
|
7118
|
-
"text": "boolean"
|
7119
|
-
},
|
7120
|
-
"default": "false",
|
7121
|
-
"description": "This property is used to determine the parent checkbox in a nested checkbox group.\nIf any one of the children is unselected, then the parent checkbox will be indeterminate.\nIf all children are either selected or unselected, then the parent checkbox will not be indeterminate.",
|
7122
|
-
"attribute": "indeterminate",
|
7123
|
-
"reflects": true
|
7124
|
-
},
|
7125
|
-
{
|
7126
|
-
"kind": "field",
|
7127
|
-
"name": "autofocus",
|
7256
|
+
"name": "name",
|
7128
7257
|
"type": {
|
7129
|
-
"text": "
|
7258
|
+
"text": "string"
|
7130
7259
|
},
|
7131
|
-
"default": "
|
7132
|
-
"description": "
|
7133
|
-
"attribute": "
|
7134
|
-
"reflects": true
|
7135
|
-
},
|
7136
|
-
{
|
7137
|
-
"kind": "method",
|
7138
|
-
"name": "setFormValue",
|
7139
|
-
"privacy": "private",
|
7140
|
-
"description": "Updates the form value to reflect the current state of the checkbox.\nIf checked, the value is set to either the user-provided value or 'on' if no value is provided.\nIf unchecked, the value is set to null."
|
7260
|
+
"default": "''",
|
7261
|
+
"description": "The name of the radio.",
|
7262
|
+
"attribute": "name"
|
7141
7263
|
},
|
7142
7264
|
{
|
7143
7265
|
"kind": "method",
|
7144
|
-
"name": "
|
7266
|
+
"name": "getAllCardsWithinSameGroup",
|
7145
7267
|
"privacy": "private",
|
7146
|
-
"
|
7268
|
+
"return": {
|
7269
|
+
"type": {
|
7270
|
+
"text": "CardRadio[]"
|
7271
|
+
}
|
7272
|
+
},
|
7273
|
+
"description": "Returns all cards within the same group (name)."
|
7147
7274
|
},
|
7148
7275
|
{
|
7149
7276
|
"kind": "method",
|
7150
|
-
"name": "
|
7277
|
+
"name": "toggleChecked",
|
7151
7278
|
"privacy": "private",
|
7152
7279
|
"return": {
|
7153
7280
|
"type": {
|
7154
7281
|
"text": "void"
|
7155
7282
|
}
|
7156
7283
|
},
|
7157
|
-
"description": "
|
7284
|
+
"description": "Handles the change event on the radio element.\nThis will toggle the state of the radio element.\nDispatches the change event."
|
7158
7285
|
},
|
7159
7286
|
{
|
7160
7287
|
"kind": "method",
|
7161
|
-
"name": "
|
7162
|
-
"privacy": "private",
|
7288
|
+
"name": "setDisabled",
|
7163
7289
|
"return": {
|
7164
7290
|
"type": {
|
7165
7291
|
"text": "void"
|
@@ -7167,19 +7293,17 @@
|
|
7167
7293
|
},
|
7168
7294
|
"parameters": [
|
7169
7295
|
{
|
7170
|
-
"name": "
|
7296
|
+
"name": "disabled",
|
7171
7297
|
"type": {
|
7172
|
-
"text": "
|
7173
|
-
}
|
7174
|
-
"description": "The keyboard event."
|
7298
|
+
"text": "boolean"
|
7299
|
+
}
|
7175
7300
|
}
|
7176
|
-
]
|
7177
|
-
"description": "Handles the keydown event on the checkbox.\nWhen the user presses Enter, the form is submitted."
|
7301
|
+
]
|
7178
7302
|
},
|
7179
7303
|
{
|
7180
7304
|
"kind": "method",
|
7181
|
-
"name": "
|
7182
|
-
"privacy": "
|
7305
|
+
"name": "updateCardRadio",
|
7306
|
+
"privacy": "private",
|
7183
7307
|
"return": {
|
7184
7308
|
"type": {
|
7185
7309
|
"text": "void"
|
@@ -7187,352 +7311,312 @@
|
|
7187
7311
|
},
|
7188
7312
|
"parameters": [
|
7189
7313
|
{
|
7190
|
-
"name": "
|
7314
|
+
"name": "cards",
|
7191
7315
|
"type": {
|
7192
|
-
"text": "
|
7316
|
+
"text": "CardRadio[]"
|
7317
|
+
}
|
7318
|
+
},
|
7319
|
+
{
|
7320
|
+
"name": "index",
|
7321
|
+
"type": {
|
7322
|
+
"text": "number"
|
7193
7323
|
}
|
7194
7324
|
}
|
7195
|
-
]
|
7196
|
-
"description": "Toggles the state of the checkbox element.\nand dispatch the new change event."
|
7197
|
-
},
|
7198
|
-
{
|
7199
|
-
"kind": "field",
|
7200
|
-
"name": "renderLabelAndHelperText",
|
7201
|
-
"privacy": "private"
|
7202
|
-
},
|
7203
|
-
{
|
7204
|
-
"kind": "field",
|
7205
|
-
"name": "name",
|
7206
|
-
"type": {
|
7207
|
-
"text": "string"
|
7208
|
-
},
|
7209
|
-
"default": "''",
|
7210
|
-
"description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
|
7211
|
-
"attribute": "name",
|
7212
|
-
"reflects": true,
|
7213
|
-
"inheritedFrom": {
|
7214
|
-
"name": "FormInternalsMixin",
|
7215
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
7216
|
-
}
|
7217
|
-
},
|
7218
|
-
{
|
7219
|
-
"kind": "field",
|
7220
|
-
"name": "value",
|
7221
|
-
"type": {
|
7222
|
-
"text": "string"
|
7223
|
-
},
|
7224
|
-
"default": "''",
|
7225
|
-
"description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
|
7226
|
-
"attribute": "value",
|
7227
|
-
"reflects": true,
|
7228
|
-
"inheritedFrom": {
|
7229
|
-
"name": "FormInternalsMixin",
|
7230
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
7231
|
-
}
|
7232
|
-
},
|
7233
|
-
{
|
7234
|
-
"kind": "field",
|
7235
|
-
"name": "validationMessage",
|
7236
|
-
"type": {
|
7237
|
-
"text": "string | undefined"
|
7238
|
-
},
|
7239
|
-
"description": "Custom validation message that will override the default message and displayed when the input is invalid.\n\nTo display custom validation messages, you must listen for input events (or other relevant events)\non your component and update the `validationMessage` property with the desired message string.\nUpdating this property will ensure that new validation messages are shown to the user.\n- The `validationMessage` property overrides the default browser validation message when set.\n- Consumers are responsible for updating `validationMessage` in response to input or validation state changes.",
|
7240
|
-
"attribute": "validation-message",
|
7241
|
-
"reflects": true,
|
7242
|
-
"inheritedFrom": {
|
7243
|
-
"name": "FormInternalsMixin",
|
7244
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
7245
|
-
}
|
7246
|
-
},
|
7247
|
-
{
|
7248
|
-
"kind": "field",
|
7249
|
-
"name": "validity",
|
7250
|
-
"type": {
|
7251
|
-
"text": "ValidityState"
|
7252
|
-
},
|
7253
|
-
"readonly": true,
|
7254
|
-
"inheritedFrom": {
|
7255
|
-
"name": "FormInternalsMixin",
|
7256
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
7257
|
-
}
|
7325
|
+
]
|
7258
7326
|
},
|
7259
7327
|
{
|
7260
|
-
"kind": "
|
7261
|
-
"name": "
|
7262
|
-
"
|
7263
|
-
"
|
7264
|
-
|
7265
|
-
|
7266
|
-
|
7328
|
+
"kind": "method",
|
7329
|
+
"name": "toggleOnEnter",
|
7330
|
+
"privacy": "private",
|
7331
|
+
"parameters": [
|
7332
|
+
{
|
7333
|
+
"name": "event",
|
7334
|
+
"type": {
|
7335
|
+
"text": "KeyboardEvent"
|
7336
|
+
},
|
7337
|
+
"description": "The keyboard event"
|
7338
|
+
}
|
7339
|
+
],
|
7340
|
+
"description": "Toggles the checked state when enter key is used"
|
7267
7341
|
},
|
7268
7342
|
{
|
7269
7343
|
"kind": "method",
|
7270
|
-
"name": "
|
7271
|
-
"
|
7272
|
-
"
|
7273
|
-
|
7274
|
-
"
|
7344
|
+
"name": "toggleOnSpace",
|
7345
|
+
"privacy": "private",
|
7346
|
+
"parameters": [
|
7347
|
+
{
|
7348
|
+
"name": "event",
|
7349
|
+
"type": {
|
7350
|
+
"text": "KeyboardEvent"
|
7351
|
+
},
|
7352
|
+
"description": "The keyboard event"
|
7275
7353
|
}
|
7276
|
-
|
7277
|
-
"
|
7278
|
-
"name": "FormInternalsMixin",
|
7279
|
-
"module": "utils/mixins/FormInternalsMixin.js"
|
7280
|
-
}
|
7354
|
+
],
|
7355
|
+
"description": "Toggles the checked state when space key is used"
|
7281
7356
|
},
|
7282
7357
|
{
|
7283
7358
|
"kind": "method",
|
7284
|
-
"name": "
|
7359
|
+
"name": "renderHeader",
|
7360
|
+
"privacy": "protected",
|
7361
|
+
"description": "Renders the header of the card",
|
7285
7362
|
"return": {
|
7286
7363
|
"type": {
|
7287
|
-
"text": "
|
7364
|
+
"text": ""
|
7288
7365
|
}
|
7289
7366
|
},
|
7290
7367
|
"inheritedFrom": {
|
7291
|
-
"name": "
|
7292
|
-
"module": "
|
7368
|
+
"name": "Card",
|
7369
|
+
"module": "components/card/card.component.js"
|
7293
7370
|
}
|
7294
7371
|
},
|
7295
7372
|
{
|
7296
|
-
"kind": "
|
7297
|
-
"name": "
|
7373
|
+
"kind": "field",
|
7374
|
+
"name": "disabled",
|
7375
|
+
"type": {
|
7376
|
+
"text": "boolean | undefined"
|
7377
|
+
},
|
7378
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
7379
|
+
"default": "undefined",
|
7380
|
+
"attribute": "disabled",
|
7381
|
+
"reflects": true,
|
7298
7382
|
"inheritedFrom": {
|
7299
|
-
"name": "
|
7300
|
-
"module": "utils/mixins/
|
7383
|
+
"name": "DisabledMixin",
|
7384
|
+
"module": "utils/mixins/DisabledMixin.js"
|
7301
7385
|
}
|
7302
7386
|
},
|
7303
7387
|
{
|
7304
7388
|
"kind": "field",
|
7305
|
-
"name": "
|
7389
|
+
"name": "tabIndex",
|
7306
7390
|
"type": {
|
7307
|
-
"text": "
|
7391
|
+
"text": "number"
|
7308
7392
|
},
|
7309
|
-
"default": "
|
7310
|
-
"description": "
|
7311
|
-
"attribute": "
|
7393
|
+
"default": "0",
|
7394
|
+
"description": "This property specifies the tab order of the element.",
|
7395
|
+
"attribute": "tabIndex",
|
7312
7396
|
"reflects": true,
|
7313
7397
|
"inheritedFrom": {
|
7314
|
-
"name": "
|
7315
|
-
"module": "utils/mixins/
|
7398
|
+
"name": "TabIndexMixin",
|
7399
|
+
"module": "utils/mixins/TabIndexMixin.js"
|
7316
7400
|
}
|
7317
7401
|
},
|
7318
7402
|
{
|
7319
7403
|
"kind": "field",
|
7320
|
-
"name": "
|
7404
|
+
"name": "cardTitle",
|
7321
7405
|
"type": {
|
7322
|
-
"text": "
|
7406
|
+
"text": "string"
|
7323
7407
|
},
|
7324
|
-
"
|
7325
|
-
"
|
7326
|
-
"attribute": "
|
7408
|
+
"default": "''",
|
7409
|
+
"description": "The title of the card - part of header section",
|
7410
|
+
"attribute": "card-title",
|
7327
7411
|
"reflects": true,
|
7328
7412
|
"inheritedFrom": {
|
7329
|
-
"name": "
|
7330
|
-
"module": "
|
7413
|
+
"name": "Card",
|
7414
|
+
"module": "components/card/card.component.js"
|
7331
7415
|
}
|
7332
7416
|
},
|
7333
7417
|
{
|
7334
7418
|
"kind": "field",
|
7335
|
-
"name": "
|
7419
|
+
"name": "subtitle",
|
7336
7420
|
"type": {
|
7337
|
-
"text": "string
|
7421
|
+
"text": "string"
|
7338
7422
|
},
|
7339
|
-
"
|
7340
|
-
"
|
7423
|
+
"default": "''",
|
7424
|
+
"description": "The subtitle of the card - part of header section",
|
7425
|
+
"attribute": "subtitle",
|
7341
7426
|
"reflects": true,
|
7342
7427
|
"inheritedFrom": {
|
7343
|
-
"name": "
|
7344
|
-
"module": "components/
|
7428
|
+
"name": "Card",
|
7429
|
+
"module": "components/card/card.component.js"
|
7345
7430
|
}
|
7346
7431
|
},
|
7347
7432
|
{
|
7348
7433
|
"kind": "field",
|
7349
|
-
"name": "
|
7434
|
+
"name": "imageSrc",
|
7350
7435
|
"type": {
|
7351
|
-
"text": "
|
7436
|
+
"text": "string"
|
7352
7437
|
},
|
7353
|
-
"default": "
|
7354
|
-
"description": "The
|
7355
|
-
"attribute": "
|
7438
|
+
"default": "''",
|
7439
|
+
"description": "The image source URL to render on the card",
|
7440
|
+
"attribute": "image-src",
|
7356
7441
|
"reflects": true,
|
7357
7442
|
"inheritedFrom": {
|
7358
|
-
"name": "
|
7359
|
-
"module": "components/
|
7443
|
+
"name": "Card",
|
7444
|
+
"module": "components/card/card.component.js"
|
7360
7445
|
}
|
7361
7446
|
},
|
7362
7447
|
{
|
7363
7448
|
"kind": "field",
|
7364
|
-
"name": "
|
7449
|
+
"name": "imageAlt",
|
7365
7450
|
"type": {
|
7366
7451
|
"text": "string"
|
7367
7452
|
},
|
7368
7453
|
"default": "''",
|
7369
|
-
"description": "The
|
7370
|
-
"attribute": "
|
7454
|
+
"description": "The image alt for accessibility support",
|
7455
|
+
"attribute": "image-alt",
|
7456
|
+
"reflects": true,
|
7371
7457
|
"inheritedFrom": {
|
7372
|
-
"name": "
|
7373
|
-
"module": "components/
|
7458
|
+
"name": "Card",
|
7459
|
+
"module": "components/card/card.component.js"
|
7374
7460
|
}
|
7375
7461
|
},
|
7376
7462
|
{
|
7377
7463
|
"kind": "field",
|
7378
|
-
"name": "
|
7464
|
+
"name": "variant",
|
7379
7465
|
"type": {
|
7380
|
-
"text": "
|
7466
|
+
"text": "CardVariant"
|
7381
7467
|
},
|
7382
|
-
"description": "The
|
7383
|
-
"
|
7468
|
+
"description": "The variant of the card. It can either be set to 'border' or 'ghost'",
|
7469
|
+
"default": "'border'",
|
7470
|
+
"attribute": "variant",
|
7384
7471
|
"reflects": true,
|
7385
7472
|
"inheritedFrom": {
|
7386
|
-
"name": "
|
7387
|
-
"module": "components/
|
7473
|
+
"name": "Card",
|
7474
|
+
"module": "components/card/card.component.js"
|
7388
7475
|
}
|
7389
7476
|
},
|
7390
7477
|
{
|
7391
7478
|
"kind": "field",
|
7392
|
-
"name": "
|
7479
|
+
"name": "orientation",
|
7393
7480
|
"type": {
|
7394
|
-
"text": "
|
7481
|
+
"text": "CardOrientation"
|
7395
7482
|
},
|
7396
|
-
"description": "The
|
7397
|
-
"
|
7483
|
+
"description": "The orientation of the card. It can either be set to 'vertical' or 'horizontal'",
|
7484
|
+
"default": "'vertical'",
|
7485
|
+
"attribute": "orientation",
|
7398
7486
|
"reflects": true,
|
7399
7487
|
"inheritedFrom": {
|
7400
|
-
"name": "
|
7401
|
-
"module": "components/
|
7488
|
+
"name": "Card",
|
7489
|
+
"module": "components/card/card.component.js"
|
7402
7490
|
}
|
7403
7491
|
},
|
7404
7492
|
{
|
7405
7493
|
"kind": "field",
|
7406
|
-
"name": "
|
7494
|
+
"name": "titleTagName",
|
7407
7495
|
"type": {
|
7408
|
-
"text": "
|
7496
|
+
"text": "TagNameType"
|
7409
7497
|
},
|
7410
|
-
"description": "The
|
7411
|
-
"
|
7498
|
+
"description": "The tag name for the card title. It supports all the types that `mdc-text` supports",
|
7499
|
+
"default": "'span'",
|
7500
|
+
"attribute": "title-tag-name",
|
7412
7501
|
"reflects": true,
|
7413
7502
|
"inheritedFrom": {
|
7414
|
-
"name": "
|
7415
|
-
"module": "components/
|
7503
|
+
"name": "Card",
|
7504
|
+
"module": "components/card/card.component.js"
|
7416
7505
|
}
|
7417
7506
|
},
|
7418
7507
|
{
|
7419
7508
|
"kind": "field",
|
7420
|
-
"name": "
|
7509
|
+
"name": "subtitleTagName",
|
7421
7510
|
"type": {
|
7422
|
-
"text": "
|
7511
|
+
"text": "TagNameType"
|
7423
7512
|
},
|
7424
|
-
"description": "The
|
7425
|
-
"default": "'
|
7426
|
-
"attribute": "
|
7513
|
+
"description": "The tag name for the subtitle. It supports all the types that `mdc-text` supports",
|
7514
|
+
"default": "'span'",
|
7515
|
+
"attribute": "subtitle-tag-name",
|
7427
7516
|
"reflects": true,
|
7428
7517
|
"inheritedFrom": {
|
7429
|
-
"name": "
|
7430
|
-
"module": "components/
|
7518
|
+
"name": "Card",
|
7519
|
+
"module": "components/card/card.component.js"
|
7431
7520
|
}
|
7432
7521
|
},
|
7433
7522
|
{
|
7434
7523
|
"kind": "field",
|
7435
|
-
"name": "
|
7524
|
+
"name": "iconName",
|
7436
7525
|
"type": {
|
7437
|
-
"text": "
|
7526
|
+
"text": "IconNames | undefined"
|
7438
7527
|
},
|
7439
|
-
"description": "
|
7440
|
-
"attribute": "
|
7528
|
+
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
7529
|
+
"attribute": "icon-name",
|
7441
7530
|
"reflects": true,
|
7442
7531
|
"inheritedFrom": {
|
7443
|
-
"name": "
|
7444
|
-
"module": "components/
|
7532
|
+
"name": "Card",
|
7533
|
+
"module": "components/card/card.component.js"
|
7445
7534
|
}
|
7446
7535
|
},
|
7447
7536
|
{
|
7448
7537
|
"kind": "method",
|
7449
|
-
"name": "
|
7538
|
+
"name": "renderImage",
|
7450
7539
|
"privacy": "protected",
|
7451
|
-
"description": "
|
7540
|
+
"description": "Renders the image on the card if image source is provided",
|
7452
7541
|
"return": {
|
7453
7542
|
"type": {
|
7454
7543
|
"text": ""
|
7455
7544
|
}
|
7456
7545
|
},
|
7457
7546
|
"inheritedFrom": {
|
7458
|
-
"name": "
|
7459
|
-
"module": "components/
|
7547
|
+
"name": "Card",
|
7548
|
+
"module": "components/card/card.component.js"
|
7460
7549
|
}
|
7461
7550
|
},
|
7462
7551
|
{
|
7463
7552
|
"kind": "method",
|
7464
|
-
"name": "
|
7553
|
+
"name": "renderIcon",
|
7465
7554
|
"privacy": "protected",
|
7466
|
-
"description": "
|
7555
|
+
"description": "Renders the icon on the card if icon name is provided",
|
7467
7556
|
"return": {
|
7468
7557
|
"type": {
|
7469
7558
|
"text": ""
|
7470
7559
|
}
|
7471
7560
|
},
|
7472
7561
|
"inheritedFrom": {
|
7473
|
-
"name": "
|
7474
|
-
"module": "components/
|
7475
|
-
}
|
7476
|
-
},
|
7477
|
-
{
|
7478
|
-
"kind": "method",
|
7479
|
-
"name": "renderHelpText",
|
7480
|
-
"privacy": "protected",
|
7481
|
-
"description": "creates the helper text component when the helpertext value is set.\nIt is also used to display the validation message based on the helpTextType.",
|
7482
|
-
"return": {
|
7483
|
-
"type": {
|
7484
|
-
"text": ""
|
7485
|
-
}
|
7486
|
-
},
|
7487
|
-
"inheritedFrom": {
|
7488
|
-
"name": "FormfieldWrapper",
|
7489
|
-
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
7562
|
+
"name": "Card",
|
7563
|
+
"module": "components/card/card.component.js"
|
7490
7564
|
}
|
7491
7565
|
},
|
7492
7566
|
{
|
7493
7567
|
"kind": "method",
|
7494
|
-
"name": "
|
7568
|
+
"name": "renderTitle",
|
7495
7569
|
"privacy": "protected",
|
7496
|
-
"description": "
|
7570
|
+
"description": "Renders the title and subtitle on the card",
|
7497
7571
|
"return": {
|
7498
7572
|
"type": {
|
7499
7573
|
"text": ""
|
7500
7574
|
}
|
7501
7575
|
},
|
7502
7576
|
"inheritedFrom": {
|
7503
|
-
"name": "
|
7504
|
-
"module": "components/
|
7577
|
+
"name": "Card",
|
7578
|
+
"module": "components/card/card.component.js"
|
7505
7579
|
}
|
7506
7580
|
},
|
7507
7581
|
{
|
7508
7582
|
"kind": "method",
|
7509
|
-
"name": "
|
7583
|
+
"name": "renderFooter",
|
7510
7584
|
"privacy": "protected",
|
7511
|
-
"description": "
|
7585
|
+
"description": "Renders the footer of the card if footer-link,\nfooter-button-primary, or footer-button-secondary slots are provided",
|
7512
7586
|
"return": {
|
7513
7587
|
"type": {
|
7514
7588
|
"text": ""
|
7515
7589
|
}
|
7516
7590
|
},
|
7517
7591
|
"inheritedFrom": {
|
7518
|
-
"name": "
|
7519
|
-
"module": "components/
|
7592
|
+
"name": "Card",
|
7593
|
+
"module": "components/card/card.component.js"
|
7520
7594
|
}
|
7521
7595
|
}
|
7522
7596
|
],
|
7523
7597
|
"events": [
|
7524
7598
|
{
|
7525
|
-
"
|
7526
|
-
|
7527
|
-
|
7599
|
+
"description": "(React: onClick) Event that gets dispatched when the card is clicked. It toggles the checked state.",
|
7600
|
+
"name": "click",
|
7601
|
+
"reactName": "onClick"
|
7528
7602
|
},
|
7529
7603
|
{
|
7530
|
-
"description": "(React:
|
7604
|
+
"description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the card. It toggles the checked state when enter key is used.",
|
7605
|
+
"name": "keydown",
|
7606
|
+
"reactName": "onKeyDown"
|
7607
|
+
},
|
7608
|
+
{
|
7609
|
+
"description": "(React: onKeyUp) This event is dispatched when a key is released on the card. It toggles the checked state when space key is used.",
|
7610
|
+
"name": "keyup",
|
7611
|
+
"reactName": "onKeyUp"
|
7612
|
+
},
|
7613
|
+
{
|
7614
|
+
"description": "(React: onChange) Event that gets dispatched when the card state changes.",
|
7531
7615
|
"name": "change",
|
7532
7616
|
"reactName": "onChange"
|
7533
7617
|
},
|
7534
7618
|
{
|
7535
|
-
"description": "(React: onFocus) Event that gets dispatched when the
|
7619
|
+
"description": "(React: onFocus) Event that gets dispatched when the card receives focus.",
|
7536
7620
|
"name": "focus",
|
7537
7621
|
"reactName": "onFocus"
|
7538
7622
|
}
|
@@ -7544,207 +7628,177 @@
|
|
7544
7628
|
"text": "boolean"
|
7545
7629
|
},
|
7546
7630
|
"default": "false",
|
7547
|
-
"description": "
|
7631
|
+
"description": "The checked state of the card",
|
7548
7632
|
"fieldName": "checked"
|
7549
7633
|
},
|
7550
|
-
{
|
7551
|
-
"name": "indeterminate",
|
7552
|
-
"type": {
|
7553
|
-
"text": "boolean"
|
7554
|
-
},
|
7555
|
-
"default": "false",
|
7556
|
-
"description": "This property is used to determine the parent checkbox in a nested checkbox group.\nIf any one of the children is unselected, then the parent checkbox will be indeterminate.\nIf all children are either selected or unselected, then the parent checkbox will not be indeterminate.",
|
7557
|
-
"fieldName": "indeterminate"
|
7558
|
-
},
|
7559
|
-
{
|
7560
|
-
"name": "autofocus",
|
7561
|
-
"type": {
|
7562
|
-
"text": "boolean"
|
7563
|
-
},
|
7564
|
-
"default": "false",
|
7565
|
-
"description": "Automatically focus on the element when the page loads.\n[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/autofocus)",
|
7566
|
-
"fieldName": "autofocus"
|
7567
|
-
},
|
7568
7634
|
{
|
7569
7635
|
"name": "name",
|
7570
7636
|
"type": {
|
7571
7637
|
"text": "string"
|
7572
7638
|
},
|
7573
7639
|
"default": "''",
|
7574
|
-
"description": "
|
7575
|
-
"fieldName": "name"
|
7576
|
-
"inheritedFrom": {
|
7577
|
-
"name": "FormInternalsMixin",
|
7578
|
-
"module": "src/utils/mixins/FormInternalsMixin.ts"
|
7579
|
-
}
|
7580
|
-
},
|
7581
|
-
{
|
7582
|
-
"name": "value",
|
7583
|
-
"type": {
|
7584
|
-
"text": "string"
|
7585
|
-
},
|
7586
|
-
"default": "''",
|
7587
|
-
"description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
|
7588
|
-
"fieldName": "value",
|
7589
|
-
"inheritedFrom": {
|
7590
|
-
"name": "FormInternalsMixin",
|
7591
|
-
"module": "src/utils/mixins/FormInternalsMixin.ts"
|
7592
|
-
}
|
7640
|
+
"description": "The name of the radio.",
|
7641
|
+
"fieldName": "name"
|
7593
7642
|
},
|
7594
7643
|
{
|
7595
|
-
"name": "
|
7644
|
+
"name": "disabled",
|
7596
7645
|
"type": {
|
7597
|
-
"text": "
|
7646
|
+
"text": "boolean | undefined"
|
7598
7647
|
},
|
7599
|
-
"description": "
|
7600
|
-
"
|
7648
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
7649
|
+
"default": "undefined",
|
7650
|
+
"fieldName": "disabled",
|
7601
7651
|
"inheritedFrom": {
|
7602
|
-
"name": "
|
7603
|
-
"module": "src/utils/mixins/
|
7652
|
+
"name": "DisabledMixin",
|
7653
|
+
"module": "src/utils/mixins/DisabledMixin.ts"
|
7604
7654
|
}
|
7605
7655
|
},
|
7606
7656
|
{
|
7607
|
-
"name": "
|
7657
|
+
"name": "tabIndex",
|
7608
7658
|
"type": {
|
7609
|
-
"text": "
|
7659
|
+
"text": "number"
|
7610
7660
|
},
|
7611
|
-
"default": "
|
7612
|
-
"description": "
|
7613
|
-
"fieldName": "
|
7661
|
+
"default": "0",
|
7662
|
+
"description": "This property specifies the tab order of the element.",
|
7663
|
+
"fieldName": "tabIndex",
|
7614
7664
|
"inheritedFrom": {
|
7615
|
-
"name": "
|
7616
|
-
"module": "src/utils/mixins/
|
7665
|
+
"name": "TabIndexMixin",
|
7666
|
+
"module": "src/utils/mixins/TabIndexMixin.ts"
|
7617
7667
|
}
|
7618
7668
|
},
|
7619
7669
|
{
|
7620
|
-
"name": "
|
7670
|
+
"name": "card-title",
|
7621
7671
|
"type": {
|
7622
|
-
"text": "
|
7672
|
+
"text": "string"
|
7623
7673
|
},
|
7624
|
-
"
|
7625
|
-
"
|
7626
|
-
"fieldName": "
|
7674
|
+
"default": "''",
|
7675
|
+
"description": "The title of the card - part of header section",
|
7676
|
+
"fieldName": "cardTitle",
|
7627
7677
|
"inheritedFrom": {
|
7628
|
-
"name": "
|
7629
|
-
"module": "src/
|
7678
|
+
"name": "Card",
|
7679
|
+
"module": "src/components/card/card.component.ts"
|
7630
7680
|
}
|
7631
7681
|
},
|
7632
7682
|
{
|
7633
|
-
"name": "
|
7683
|
+
"name": "subtitle",
|
7634
7684
|
"type": {
|
7635
|
-
"text": "string
|
7685
|
+
"text": "string"
|
7636
7686
|
},
|
7637
|
-
"
|
7638
|
-
"
|
7687
|
+
"default": "''",
|
7688
|
+
"description": "The subtitle of the card - part of header section",
|
7689
|
+
"fieldName": "subtitle",
|
7639
7690
|
"inheritedFrom": {
|
7640
|
-
"name": "
|
7641
|
-
"module": "src/components/
|
7691
|
+
"name": "Card",
|
7692
|
+
"module": "src/components/card/card.component.ts"
|
7642
7693
|
}
|
7643
7694
|
},
|
7644
7695
|
{
|
7645
|
-
"name": "
|
7696
|
+
"name": "image-src",
|
7646
7697
|
"type": {
|
7647
|
-
"text": "
|
7698
|
+
"text": "string"
|
7648
7699
|
},
|
7649
|
-
"default": "
|
7650
|
-
"description": "The
|
7651
|
-
"fieldName": "
|
7700
|
+
"default": "''",
|
7701
|
+
"description": "The image source URL to render on the card",
|
7702
|
+
"fieldName": "imageSrc",
|
7652
7703
|
"inheritedFrom": {
|
7653
|
-
"name": "
|
7654
|
-
"module": "src/components/
|
7704
|
+
"name": "Card",
|
7705
|
+
"module": "src/components/card/card.component.ts"
|
7655
7706
|
}
|
7656
7707
|
},
|
7657
7708
|
{
|
7658
|
-
"name": "
|
7709
|
+
"name": "image-alt",
|
7659
7710
|
"type": {
|
7660
7711
|
"text": "string"
|
7661
7712
|
},
|
7662
7713
|
"default": "''",
|
7663
|
-
"description": "The
|
7664
|
-
"fieldName": "
|
7714
|
+
"description": "The image alt for accessibility support",
|
7715
|
+
"fieldName": "imageAlt",
|
7665
7716
|
"inheritedFrom": {
|
7666
|
-
"name": "
|
7667
|
-
"module": "src/components/
|
7717
|
+
"name": "Card",
|
7718
|
+
"module": "src/components/card/card.component.ts"
|
7668
7719
|
}
|
7669
7720
|
},
|
7670
7721
|
{
|
7671
|
-
"name": "
|
7722
|
+
"name": "variant",
|
7672
7723
|
"type": {
|
7673
|
-
"text": "
|
7724
|
+
"text": "CardVariant"
|
7674
7725
|
},
|
7675
|
-
"description": "The
|
7676
|
-
"
|
7726
|
+
"description": "The variant of the card. It can either be set to 'border' or 'ghost'",
|
7727
|
+
"default": "'border'",
|
7728
|
+
"fieldName": "variant",
|
7677
7729
|
"inheritedFrom": {
|
7678
|
-
"name": "
|
7679
|
-
"module": "src/components/
|
7730
|
+
"name": "Card",
|
7731
|
+
"module": "src/components/card/card.component.ts"
|
7680
7732
|
}
|
7681
7733
|
},
|
7682
7734
|
{
|
7683
|
-
"name": "
|
7735
|
+
"name": "orientation",
|
7684
7736
|
"type": {
|
7685
|
-
"text": "
|
7737
|
+
"text": "CardOrientation"
|
7686
7738
|
},
|
7687
|
-
"description": "The
|
7688
|
-
"
|
7739
|
+
"description": "The orientation of the card. It can either be set to 'vertical' or 'horizontal'",
|
7740
|
+
"default": "'vertical'",
|
7741
|
+
"fieldName": "orientation",
|
7689
7742
|
"inheritedFrom": {
|
7690
|
-
"name": "
|
7691
|
-
"module": "src/components/
|
7743
|
+
"name": "Card",
|
7744
|
+
"module": "src/components/card/card.component.ts"
|
7692
7745
|
}
|
7693
7746
|
},
|
7694
7747
|
{
|
7695
|
-
"name": "
|
7748
|
+
"name": "title-tag-name",
|
7696
7749
|
"type": {
|
7697
|
-
"text": "
|
7750
|
+
"text": "TagNameType"
|
7698
7751
|
},
|
7699
|
-
"description": "The
|
7700
|
-
"
|
7752
|
+
"description": "The tag name for the card title. It supports all the types that `mdc-text` supports",
|
7753
|
+
"default": "'span'",
|
7754
|
+
"fieldName": "titleTagName",
|
7701
7755
|
"inheritedFrom": {
|
7702
|
-
"name": "
|
7703
|
-
"module": "src/components/
|
7756
|
+
"name": "Card",
|
7757
|
+
"module": "src/components/card/card.component.ts"
|
7704
7758
|
}
|
7705
7759
|
},
|
7706
7760
|
{
|
7707
|
-
"name": "
|
7761
|
+
"name": "subtitle-tag-name",
|
7708
7762
|
"type": {
|
7709
|
-
"text": "
|
7763
|
+
"text": "TagNameType"
|
7710
7764
|
},
|
7711
|
-
"description": "The
|
7712
|
-
"default": "'
|
7713
|
-
"fieldName": "
|
7765
|
+
"description": "The tag name for the subtitle. It supports all the types that `mdc-text` supports",
|
7766
|
+
"default": "'span'",
|
7767
|
+
"fieldName": "subtitleTagName",
|
7714
7768
|
"inheritedFrom": {
|
7715
|
-
"name": "
|
7716
|
-
"module": "src/components/
|
7769
|
+
"name": "Card",
|
7770
|
+
"module": "src/components/card/card.component.ts"
|
7717
7771
|
}
|
7718
7772
|
},
|
7719
7773
|
{
|
7720
|
-
"name": "
|
7774
|
+
"name": "icon-name",
|
7721
7775
|
"type": {
|
7722
|
-
"text": "
|
7776
|
+
"text": "IconNames | undefined"
|
7723
7777
|
},
|
7724
|
-
"description": "
|
7725
|
-
"fieldName": "
|
7778
|
+
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
7779
|
+
"fieldName": "iconName",
|
7726
7780
|
"inheritedFrom": {
|
7727
|
-
"name": "
|
7728
|
-
"module": "src/components/
|
7781
|
+
"name": "Card",
|
7782
|
+
"module": "src/components/card/card.component.ts"
|
7729
7783
|
}
|
7730
7784
|
}
|
7731
7785
|
],
|
7732
7786
|
"mixins": [
|
7733
7787
|
{
|
7734
|
-
"name": "
|
7735
|
-
"module": "/src/utils/mixins/
|
7788
|
+
"name": "DisabledMixin",
|
7789
|
+
"module": "/src/utils/mixins/DisabledMixin"
|
7736
7790
|
},
|
7737
7791
|
{
|
7738
|
-
"name": "
|
7739
|
-
"module": "/src/utils/mixins/
|
7792
|
+
"name": "TabIndexMixin",
|
7793
|
+
"module": "/src/utils/mixins/TabIndexMixin"
|
7740
7794
|
}
|
7741
7795
|
],
|
7742
7796
|
"superclass": {
|
7743
|
-
"name": "
|
7744
|
-
"module": "/src/components/
|
7797
|
+
"name": "Card",
|
7798
|
+
"module": "/src/components/card/card.component"
|
7745
7799
|
},
|
7746
|
-
"tagName": "mdc-
|
7747
|
-
"jsDoc": "/**\n *
|
7800
|
+
"tagName": "mdc-cardradio",
|
7801
|
+
"jsDoc": "/**\n * cardradio component extends `mdc-card` and supports radio selection interaction addtionally.\n *\n * While using this component within a form or group of cards, make sure cards are in a role = \"radio-group\".\n * This card would have events for selected and unselected (similar to radio)\n *\n * **Note**: This is a single selection card i.e. interacting anywhere on the card would toggle the checked state.\n * Make sure to pass only non-interactable elements within the slots.\n *\n * Make sure to pass the `card-title` mandatorily for this card.\n *\n * @tagname mdc-cardradio\n *\n * @dependency mdc-icon\n * @dependency mdc-staticradio\n * @dependency mdc-text\n *\n * @slot before-body - This slot is for passing the content before the body\n * @slot body - This slot is for passing the text content for the card\n * @slot after-body - This slot is for passing the content after the body\n * @slot footer-link - This slot is for passing `mdc-link` component within the footer section.\n * @slot footer-button-primary - This slot is for passing primary variant of `mdc-button` component within the footer section.\n *\n * @csspart header - The header part of the card\n * @csspart icon - The icon part of the card header\n * @csspart body - The body part of the card\n * @csspart image - The image part of the card\n * @csspart footer - The footer part of the card\n * @csspart footer-link - The link part of the card footer\n * @csspart footer-button-primary - The primary button part of the card footer\n * @csspart footer-button-secondary - The secondary button part of the card footer\n * @csspart icon-button - The icon button part of the card header\n * @csspart text - The text part of the card\n * @csspart check - The check part of the card\n * @csspart check-icon - The check icon part of the card\n * @csspart check-icon-button - The check icon button part of the card\n *\n * @cssproperty --mdc-card-width - The width of the card\n *\n * @event click - (React: onClick) Event that gets dispatched when the card is clicked. It toggles the checked state.\n * @event keydown - (React: onKeyDown) This event is dispatched when a key is pressed down on the card.\n * It toggles the checked state when enter key is used.\n * @event keyup - (React: onKeyUp) This event is dispatched when a key is released on the card.\n * It toggles the checked state when space key is used.\n * @event change - (React: onChange) Event that gets dispatched when the card state changes.\n * @event focus - (React: onFocus) Event that gets dispatched when the card receives focus.\n *\n */",
|
7748
7802
|
"customElement": true
|
7749
7803
|
}
|
7750
7804
|
],
|
@@ -7753,180 +7807,40 @@
|
|
7753
7807
|
"kind": "js",
|
7754
7808
|
"name": "default",
|
7755
7809
|
"declaration": {
|
7756
|
-
"name": "
|
7757
|
-
"module": "components/
|
7810
|
+
"name": "CardRadio",
|
7811
|
+
"module": "components/cardradio/cardradio.component.js"
|
7758
7812
|
}
|
7759
7813
|
}
|
7760
7814
|
]
|
7761
7815
|
},
|
7762
7816
|
{
|
7763
7817
|
"kind": "javascript-module",
|
7764
|
-
"path": "components/
|
7818
|
+
"path": "components/checkbox/checkbox.component.js",
|
7765
7819
|
"declarations": [
|
7766
7820
|
{
|
7767
7821
|
"kind": "class",
|
7768
|
-
"description": "
|
7769
|
-
"name": "
|
7822
|
+
"description": "Checkboxes allow users to select multiple options from a list or turn an item/feature on or off.\nThese are often used in forms, settings, and selections in lists.\n\nA checkbox component contains an optional label and an optional helper text.\n\nTo create a group of checkboxes, use the FormFieldGroup component.",
|
7823
|
+
"name": "Checkbox",
|
7770
7824
|
"cssProperties": [
|
7771
7825
|
{
|
7772
|
-
"description": "
|
7773
|
-
"name": "--mdc-
|
7774
|
-
"inheritedFrom": {
|
7775
|
-
"name": "Card",
|
7776
|
-
"module": "src/components/card/card.component.ts"
|
7777
|
-
}
|
7778
|
-
}
|
7779
|
-
],
|
7780
|
-
"cssParts": [
|
7781
|
-
{
|
7782
|
-
"description": "The header part of the card",
|
7783
|
-
"name": "header",
|
7784
|
-
"inheritedFrom": {
|
7785
|
-
"name": "Card",
|
7786
|
-
"module": "src/components/card/card.component.ts"
|
7787
|
-
}
|
7788
|
-
},
|
7789
|
-
{
|
7790
|
-
"description": "The icon part of the card header",
|
7791
|
-
"name": "icon",
|
7792
|
-
"inheritedFrom": {
|
7793
|
-
"name": "Card",
|
7794
|
-
"module": "src/components/card/card.component.ts"
|
7795
|
-
}
|
7796
|
-
},
|
7797
|
-
{
|
7798
|
-
"description": "The body part of the card",
|
7799
|
-
"name": "body",
|
7800
|
-
"inheritedFrom": {
|
7801
|
-
"name": "Card",
|
7802
|
-
"module": "src/components/card/card.component.ts"
|
7803
|
-
}
|
7804
|
-
},
|
7805
|
-
{
|
7806
|
-
"description": "The image part of the card",
|
7807
|
-
"name": "image",
|
7808
|
-
"inheritedFrom": {
|
7809
|
-
"name": "Card",
|
7810
|
-
"module": "src/components/card/card.component.ts"
|
7811
|
-
}
|
7812
|
-
},
|
7813
|
-
{
|
7814
|
-
"description": "The footer part of the card",
|
7815
|
-
"name": "footer",
|
7816
|
-
"inheritedFrom": {
|
7817
|
-
"name": "Card",
|
7818
|
-
"module": "src/components/card/card.component.ts"
|
7819
|
-
}
|
7820
|
-
},
|
7821
|
-
{
|
7822
|
-
"description": "The link part of the card footer",
|
7823
|
-
"name": "footer-link",
|
7824
|
-
"inheritedFrom": {
|
7825
|
-
"name": "Card",
|
7826
|
-
"module": "src/components/card/card.component.ts"
|
7827
|
-
}
|
7828
|
-
},
|
7829
|
-
{
|
7830
|
-
"description": "The primary button part of the card footer",
|
7831
|
-
"name": "footer-button-primary",
|
7832
|
-
"inheritedFrom": {
|
7833
|
-
"name": "Card",
|
7834
|
-
"module": "src/components/card/card.component.ts"
|
7835
|
-
}
|
7836
|
-
},
|
7837
|
-
{
|
7838
|
-
"description": "The secondary button part of the card footer",
|
7839
|
-
"name": "footer-button-secondary",
|
7840
|
-
"inheritedFrom": {
|
7841
|
-
"name": "Card",
|
7842
|
-
"module": "src/components/card/card.component.ts"
|
7843
|
-
}
|
7844
|
-
},
|
7845
|
-
{
|
7846
|
-
"description": "The icon button part of the card header",
|
7847
|
-
"name": "icon-button",
|
7848
|
-
"inheritedFrom": {
|
7849
|
-
"name": "Card",
|
7850
|
-
"module": "src/components/card/card.component.ts"
|
7851
|
-
}
|
7852
|
-
},
|
7853
|
-
{
|
7854
|
-
"description": "The text part of the card",
|
7855
|
-
"name": "text",
|
7856
|
-
"inheritedFrom": {
|
7857
|
-
"name": "Card",
|
7858
|
-
"module": "src/components/card/card.component.ts"
|
7859
|
-
}
|
7860
|
-
},
|
7861
|
-
{
|
7862
|
-
"description": "The check part of the card",
|
7863
|
-
"name": "check"
|
7864
|
-
},
|
7865
|
-
{
|
7866
|
-
"description": "The check icon part of the card",
|
7867
|
-
"name": "check-icon"
|
7868
|
-
},
|
7869
|
-
{
|
7870
|
-
"description": "The check icon button part of the card",
|
7871
|
-
"name": "check-icon-button"
|
7872
|
-
}
|
7873
|
-
],
|
7874
|
-
"slots": [
|
7875
|
-
{
|
7876
|
-
"description": "This slot is for passing the content before the body",
|
7877
|
-
"name": "before-body",
|
7878
|
-
"inheritedFrom": {
|
7879
|
-
"name": "Card",
|
7880
|
-
"module": "src/components/card/card.component.ts"
|
7881
|
-
}
|
7882
|
-
},
|
7883
|
-
{
|
7884
|
-
"description": "This slot is for passing the text content for the card",
|
7885
|
-
"name": "body",
|
7886
|
-
"inheritedFrom": {
|
7887
|
-
"name": "Card",
|
7888
|
-
"module": "src/components/card/card.component.ts"
|
7889
|
-
}
|
7890
|
-
},
|
7891
|
-
{
|
7892
|
-
"description": "This slot is for passing the content after the body",
|
7893
|
-
"name": "after-body",
|
7894
|
-
"inheritedFrom": {
|
7895
|
-
"name": "Card",
|
7896
|
-
"module": "src/components/card/card.component.ts"
|
7897
|
-
}
|
7826
|
+
"description": "Allows customization of the background color on hover.",
|
7827
|
+
"name": "--mdc-checkbox-background-color-hover"
|
7898
7828
|
},
|
7899
7829
|
{
|
7900
|
-
"description": "
|
7901
|
-
"name": "
|
7902
|
-
"inheritedFrom": {
|
7903
|
-
"name": "Card",
|
7904
|
-
"module": "src/components/card/card.component.ts"
|
7905
|
-
}
|
7830
|
+
"description": "Background color for a selected checkbox when hovered.",
|
7831
|
+
"name": "--mdc-checkbox-checked-background-color-hover"
|
7906
7832
|
},
|
7907
7833
|
{
|
7908
|
-
"description": "
|
7909
|
-
"name": "
|
7910
|
-
"inheritedFrom": {
|
7911
|
-
"name": "Card",
|
7912
|
-
"module": "src/components/card/card.component.ts"
|
7913
|
-
}
|
7834
|
+
"description": "Background color for a selected checkbox when pressed.",
|
7835
|
+
"name": "--mdc-checkbox-checked-pressed-icon-color"
|
7914
7836
|
},
|
7915
7837
|
{
|
7916
|
-
"description": "
|
7917
|
-
"name": "
|
7918
|
-
"inheritedFrom": {
|
7919
|
-
"name": "Card",
|
7920
|
-
"module": "src/components/card/card.component.ts"
|
7921
|
-
}
|
7838
|
+
"description": "Background color for a selected checkbox when pressed.",
|
7839
|
+
"name": "--mdc-checkbox-pressed-icon-color"
|
7922
7840
|
},
|
7923
7841
|
{
|
7924
|
-
"description": "
|
7925
|
-
"name": "
|
7926
|
-
"inheritedFrom": {
|
7927
|
-
"name": "Card",
|
7928
|
-
"module": "src/components/card/card.component.ts"
|
7929
|
-
}
|
7842
|
+
"description": "Background color for a selected checkbox when disabled.",
|
7843
|
+
"name": "--mdc-checkbox-disabled-checked-icon-color"
|
7930
7844
|
}
|
7931
7845
|
],
|
7932
7846
|
"members": [
|
@@ -7937,376 +7851,432 @@
|
|
7937
7851
|
"text": "boolean"
|
7938
7852
|
},
|
7939
7853
|
"default": "false",
|
7940
|
-
"description": "
|
7854
|
+
"description": "Determines whether the checkbox is selected or unselected.",
|
7941
7855
|
"attribute": "checked",
|
7942
7856
|
"reflects": true
|
7943
7857
|
},
|
7944
7858
|
{
|
7945
7859
|
"kind": "field",
|
7946
|
-
"name": "
|
7860
|
+
"name": "indeterminate",
|
7947
7861
|
"type": {
|
7948
|
-
"text": "
|
7862
|
+
"text": "boolean"
|
7949
7863
|
},
|
7950
|
-
"default": "
|
7951
|
-
"description": "
|
7952
|
-
"attribute": "
|
7864
|
+
"default": "false",
|
7865
|
+
"description": "This property is used to determine the parent checkbox in a nested checkbox group.\nIf any one of the children is unselected, then the parent checkbox will be indeterminate.\nIf all children are either selected or unselected, then the parent checkbox will not be indeterminate.",
|
7866
|
+
"attribute": "indeterminate",
|
7867
|
+
"reflects": true
|
7868
|
+
},
|
7869
|
+
{
|
7870
|
+
"kind": "field",
|
7871
|
+
"name": "autofocus",
|
7872
|
+
"type": {
|
7873
|
+
"text": "boolean"
|
7874
|
+
},
|
7875
|
+
"default": "false",
|
7876
|
+
"description": "Automatically focus on the element when the page loads.\n[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/autofocus)",
|
7877
|
+
"attribute": "autofocus",
|
7878
|
+
"reflects": true
|
7953
7879
|
},
|
7954
7880
|
{
|
7955
7881
|
"kind": "method",
|
7956
|
-
"name": "
|
7882
|
+
"name": "setFormValue",
|
7957
7883
|
"privacy": "private",
|
7958
|
-
"
|
7959
|
-
"type": {
|
7960
|
-
"text": "CardRadio[]"
|
7961
|
-
}
|
7962
|
-
},
|
7963
|
-
"description": "Returns all cards within the same group (name)."
|
7884
|
+
"description": "Updates the form value to reflect the current state of the checkbox.\nIf checked, the value is set to either the user-provided value or 'on' if no value is provided.\nIf unchecked, the value is set to null."
|
7964
7885
|
},
|
7965
7886
|
{
|
7966
7887
|
"kind": "method",
|
7967
|
-
"name": "
|
7888
|
+
"name": "manageRequired",
|
7968
7889
|
"privacy": "private",
|
7969
|
-
"
|
7970
|
-
"type": {
|
7971
|
-
"text": "void"
|
7972
|
-
}
|
7973
|
-
},
|
7974
|
-
"description": "Handles the change event on the radio element.\nThis will toggle the state of the radio element.\nDispatches the change event."
|
7890
|
+
"description": "Manages the required state of the checkbox.\nIf the checkbox is not checked and the required property is set, then the checkbox is invalid."
|
7975
7891
|
},
|
7976
7892
|
{
|
7977
7893
|
"kind": "method",
|
7978
|
-
"name": "
|
7894
|
+
"name": "toggleState",
|
7895
|
+
"privacy": "private",
|
7979
7896
|
"return": {
|
7980
7897
|
"type": {
|
7981
7898
|
"text": "void"
|
7982
7899
|
}
|
7983
7900
|
},
|
7984
|
-
"
|
7985
|
-
{
|
7986
|
-
"name": "disabled",
|
7987
|
-
"type": {
|
7988
|
-
"text": "boolean"
|
7989
|
-
}
|
7990
|
-
}
|
7991
|
-
]
|
7901
|
+
"description": "Toggles the state of the checkbox element.\nIf the element is not disabled, then\nthe checked property is toggled and the indeterminate property is set to false."
|
7992
7902
|
},
|
7993
7903
|
{
|
7994
7904
|
"kind": "method",
|
7995
|
-
"name": "
|
7905
|
+
"name": "handleKeyDown",
|
7996
7906
|
"privacy": "private",
|
7997
7907
|
"return": {
|
7998
7908
|
"type": {
|
7999
7909
|
"text": "void"
|
8000
7910
|
}
|
8001
7911
|
},
|
8002
|
-
"parameters": [
|
8003
|
-
{
|
8004
|
-
"name": "cards",
|
8005
|
-
"type": {
|
8006
|
-
"text": "CardRadio[]"
|
8007
|
-
}
|
8008
|
-
},
|
8009
|
-
{
|
8010
|
-
"name": "index",
|
8011
|
-
"type": {
|
8012
|
-
"text": "number"
|
8013
|
-
}
|
8014
|
-
}
|
8015
|
-
]
|
8016
|
-
},
|
8017
|
-
{
|
8018
|
-
"kind": "method",
|
8019
|
-
"name": "toggleOnEnter",
|
8020
|
-
"privacy": "private",
|
8021
7912
|
"parameters": [
|
8022
7913
|
{
|
8023
7914
|
"name": "event",
|
8024
7915
|
"type": {
|
8025
7916
|
"text": "KeyboardEvent"
|
8026
7917
|
},
|
8027
|
-
"description": "The keyboard event"
|
7918
|
+
"description": "The keyboard event."
|
8028
7919
|
}
|
8029
7920
|
],
|
8030
|
-
"description": "
|
7921
|
+
"description": "Handles the keydown event on the checkbox.\nWhen the user presses Enter, the form is submitted."
|
8031
7922
|
},
|
8032
7923
|
{
|
8033
7924
|
"kind": "method",
|
8034
|
-
"name": "
|
8035
|
-
"privacy": "
|
7925
|
+
"name": "handleChange",
|
7926
|
+
"privacy": "public",
|
7927
|
+
"return": {
|
7928
|
+
"type": {
|
7929
|
+
"text": "void"
|
7930
|
+
}
|
7931
|
+
},
|
8036
7932
|
"parameters": [
|
8037
7933
|
{
|
8038
7934
|
"name": "event",
|
8039
7935
|
"type": {
|
8040
|
-
"text": "
|
8041
|
-
}
|
8042
|
-
"description": "The keyboard event"
|
7936
|
+
"text": "Event"
|
7937
|
+
}
|
8043
7938
|
}
|
8044
7939
|
],
|
8045
|
-
"description": "Toggles the
|
7940
|
+
"description": "Toggles the state of the checkbox element.\nand dispatch the new change event."
|
7941
|
+
},
|
7942
|
+
{
|
7943
|
+
"kind": "field",
|
7944
|
+
"name": "renderLabelAndHelperText",
|
7945
|
+
"privacy": "private"
|
7946
|
+
},
|
7947
|
+
{
|
7948
|
+
"kind": "field",
|
7949
|
+
"name": "name",
|
7950
|
+
"type": {
|
7951
|
+
"text": "string"
|
7952
|
+
},
|
7953
|
+
"default": "''",
|
7954
|
+
"description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
|
7955
|
+
"attribute": "name",
|
7956
|
+
"reflects": true,
|
7957
|
+
"inheritedFrom": {
|
7958
|
+
"name": "FormInternalsMixin",
|
7959
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
7960
|
+
}
|
7961
|
+
},
|
7962
|
+
{
|
7963
|
+
"kind": "field",
|
7964
|
+
"name": "value",
|
7965
|
+
"type": {
|
7966
|
+
"text": "string"
|
7967
|
+
},
|
7968
|
+
"default": "''",
|
7969
|
+
"description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
|
7970
|
+
"attribute": "value",
|
7971
|
+
"reflects": true,
|
7972
|
+
"inheritedFrom": {
|
7973
|
+
"name": "FormInternalsMixin",
|
7974
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
7975
|
+
}
|
7976
|
+
},
|
7977
|
+
{
|
7978
|
+
"kind": "field",
|
7979
|
+
"name": "validationMessage",
|
7980
|
+
"type": {
|
7981
|
+
"text": "string | undefined"
|
7982
|
+
},
|
7983
|
+
"description": "Custom validation message that will override the default message and displayed when the input is invalid.\n\nTo display custom validation messages, you must listen for input events (or other relevant events)\non your component and update the `validationMessage` property with the desired message string.\nUpdating this property will ensure that new validation messages are shown to the user.\n- The `validationMessage` property overrides the default browser validation message when set.\n- Consumers are responsible for updating `validationMessage` in response to input or validation state changes.",
|
7984
|
+
"attribute": "validation-message",
|
7985
|
+
"reflects": true,
|
7986
|
+
"inheritedFrom": {
|
7987
|
+
"name": "FormInternalsMixin",
|
7988
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
7989
|
+
}
|
7990
|
+
},
|
7991
|
+
{
|
7992
|
+
"kind": "field",
|
7993
|
+
"name": "validity",
|
7994
|
+
"type": {
|
7995
|
+
"text": "ValidityState"
|
7996
|
+
},
|
7997
|
+
"readonly": true,
|
7998
|
+
"inheritedFrom": {
|
7999
|
+
"name": "FormInternalsMixin",
|
8000
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
8001
|
+
}
|
8002
|
+
},
|
8003
|
+
{
|
8004
|
+
"kind": "field",
|
8005
|
+
"name": "willValidate",
|
8006
|
+
"readonly": true,
|
8007
|
+
"inheritedFrom": {
|
8008
|
+
"name": "FormInternalsMixin",
|
8009
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
8010
|
+
}
|
8046
8011
|
},
|
8047
8012
|
{
|
8048
8013
|
"kind": "method",
|
8049
|
-
"name": "
|
8050
|
-
"
|
8051
|
-
"description": "Renders the header of the card",
|
8014
|
+
"name": "setValidity",
|
8015
|
+
"description": "Sets the validity of the input field based on the input field's validity.",
|
8052
8016
|
"return": {
|
8053
8017
|
"type": {
|
8054
8018
|
"text": ""
|
8055
8019
|
}
|
8056
8020
|
},
|
8057
8021
|
"inheritedFrom": {
|
8058
|
-
"name": "
|
8059
|
-
"module": "
|
8022
|
+
"name": "FormInternalsMixin",
|
8023
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
8060
8024
|
}
|
8061
8025
|
},
|
8062
8026
|
{
|
8063
|
-
"kind": "
|
8064
|
-
"name": "
|
8065
|
-
"
|
8066
|
-
"
|
8027
|
+
"kind": "method",
|
8028
|
+
"name": "checkValidity",
|
8029
|
+
"return": {
|
8030
|
+
"type": {
|
8031
|
+
"text": "boolean"
|
8032
|
+
}
|
8067
8033
|
},
|
8068
|
-
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
8069
|
-
"default": "undefined",
|
8070
|
-
"attribute": "disabled",
|
8071
|
-
"reflects": true,
|
8072
8034
|
"inheritedFrom": {
|
8073
|
-
"name": "
|
8074
|
-
"module": "utils/mixins/
|
8035
|
+
"name": "FormInternalsMixin",
|
8036
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
8037
|
+
}
|
8038
|
+
},
|
8039
|
+
{
|
8040
|
+
"kind": "method",
|
8041
|
+
"name": "reportValidity",
|
8042
|
+
"inheritedFrom": {
|
8043
|
+
"name": "FormInternalsMixin",
|
8044
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
8075
8045
|
}
|
8076
8046
|
},
|
8077
8047
|
{
|
8078
8048
|
"kind": "field",
|
8079
|
-
"name": "
|
8049
|
+
"name": "dataAriaLabel",
|
8080
8050
|
"type": {
|
8081
|
-
"text": "
|
8051
|
+
"text": "string | null"
|
8082
8052
|
},
|
8083
|
-
"default": "
|
8084
|
-
"description": "
|
8085
|
-
"attribute": "
|
8053
|
+
"default": "null",
|
8054
|
+
"description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
|
8055
|
+
"attribute": "data-aria-label",
|
8086
8056
|
"reflects": true,
|
8087
8057
|
"inheritedFrom": {
|
8088
|
-
"name": "
|
8089
|
-
"module": "utils/mixins/
|
8058
|
+
"name": "DataAriaLabelMixin",
|
8059
|
+
"module": "utils/mixins/DataAriaLabelMixin.js"
|
8090
8060
|
}
|
8091
8061
|
},
|
8092
8062
|
{
|
8093
8063
|
"kind": "field",
|
8094
|
-
"name": "
|
8064
|
+
"name": "disabled",
|
8095
8065
|
"type": {
|
8096
|
-
"text": "
|
8066
|
+
"text": "boolean | undefined"
|
8097
8067
|
},
|
8098
|
-
"
|
8099
|
-
"
|
8100
|
-
"attribute": "
|
8068
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
8069
|
+
"default": "undefined",
|
8070
|
+
"attribute": "disabled",
|
8101
8071
|
"reflects": true,
|
8102
8072
|
"inheritedFrom": {
|
8103
|
-
"name": "
|
8104
|
-
"module": "
|
8073
|
+
"name": "DisabledMixin",
|
8074
|
+
"module": "utils/mixins/DisabledMixin.js"
|
8105
8075
|
}
|
8106
8076
|
},
|
8107
8077
|
{
|
8108
8078
|
"kind": "field",
|
8109
|
-
"name": "
|
8079
|
+
"name": "label",
|
8110
8080
|
"type": {
|
8111
|
-
"text": "string"
|
8081
|
+
"text": "string | undefined"
|
8112
8082
|
},
|
8113
|
-
"
|
8114
|
-
"
|
8115
|
-
"attribute": "subtitle",
|
8083
|
+
"description": "The label of the input field. It is linked to the input field using the `for` attribute.",
|
8084
|
+
"attribute": "label",
|
8116
8085
|
"reflects": true,
|
8117
8086
|
"inheritedFrom": {
|
8118
|
-
"name": "
|
8119
|
-
"module": "components/
|
8087
|
+
"name": "FormfieldWrapper",
|
8088
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
8120
8089
|
}
|
8121
8090
|
},
|
8122
8091
|
{
|
8123
8092
|
"kind": "field",
|
8124
|
-
"name": "
|
8093
|
+
"name": "required",
|
8125
8094
|
"type": {
|
8126
|
-
"text": "
|
8095
|
+
"text": "boolean"
|
8127
8096
|
},
|
8128
|
-
"default": "
|
8129
|
-
"description": "The
|
8130
|
-
"attribute": "
|
8097
|
+
"default": "false",
|
8098
|
+
"description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
|
8099
|
+
"attribute": "required",
|
8131
8100
|
"reflects": true,
|
8132
8101
|
"inheritedFrom": {
|
8133
|
-
"name": "
|
8134
|
-
"module": "components/
|
8102
|
+
"name": "FormfieldWrapper",
|
8103
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
8135
8104
|
}
|
8136
8105
|
},
|
8137
8106
|
{
|
8138
8107
|
"kind": "field",
|
8139
|
-
"name": "
|
8108
|
+
"name": "id",
|
8140
8109
|
"type": {
|
8141
8110
|
"text": "string"
|
8142
8111
|
},
|
8143
8112
|
"default": "''",
|
8144
|
-
"description": "The
|
8145
|
-
"attribute": "
|
8146
|
-
"reflects": true,
|
8113
|
+
"description": "The unique id of the input field. It is used to link the input field with the label.",
|
8114
|
+
"attribute": "id",
|
8147
8115
|
"inheritedFrom": {
|
8148
|
-
"name": "
|
8149
|
-
"module": "components/
|
8116
|
+
"name": "FormfieldWrapper",
|
8117
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
8150
8118
|
}
|
8151
8119
|
},
|
8152
8120
|
{
|
8153
8121
|
"kind": "field",
|
8154
|
-
"name": "
|
8122
|
+
"name": "helpTextType",
|
8155
8123
|
"type": {
|
8156
|
-
"text": "
|
8124
|
+
"text": "ValidationType"
|
8157
8125
|
},
|
8158
|
-
"description": "The
|
8159
|
-
"
|
8160
|
-
"attribute": "variant",
|
8126
|
+
"description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
|
8127
|
+
"attribute": "help-text-type",
|
8161
8128
|
"reflects": true,
|
8162
8129
|
"inheritedFrom": {
|
8163
|
-
"name": "
|
8164
|
-
"module": "components/
|
8130
|
+
"name": "FormfieldWrapper",
|
8131
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
8165
8132
|
}
|
8166
8133
|
},
|
8167
8134
|
{
|
8168
8135
|
"kind": "field",
|
8169
|
-
"name": "
|
8136
|
+
"name": "helpText",
|
8170
8137
|
"type": {
|
8171
|
-
"text": "
|
8138
|
+
"text": "string | undefined"
|
8172
8139
|
},
|
8173
|
-
"description": "The
|
8174
|
-
"
|
8175
|
-
"attribute": "orientation",
|
8140
|
+
"description": "The help text that is displayed below the input field.",
|
8141
|
+
"attribute": "help-text",
|
8176
8142
|
"reflects": true,
|
8177
8143
|
"inheritedFrom": {
|
8178
|
-
"name": "
|
8179
|
-
"module": "components/
|
8144
|
+
"name": "FormfieldWrapper",
|
8145
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
8180
8146
|
}
|
8181
8147
|
},
|
8182
8148
|
{
|
8183
8149
|
"kind": "field",
|
8184
|
-
"name": "
|
8150
|
+
"name": "toggletipText",
|
8185
8151
|
"type": {
|
8186
|
-
"text": "
|
8152
|
+
"text": "string | undefined"
|
8187
8153
|
},
|
8188
|
-
"description": "The
|
8189
|
-
"
|
8190
|
-
"attribute": "title-tag-name",
|
8154
|
+
"description": "The toggletip text that is displayed when the label is hovered.\nIt is used to provide additional information about the label.",
|
8155
|
+
"attribute": "toggletip-text",
|
8191
8156
|
"reflects": true,
|
8192
8157
|
"inheritedFrom": {
|
8193
|
-
"name": "
|
8194
|
-
"module": "components/
|
8158
|
+
"name": "FormfieldWrapper",
|
8159
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
8195
8160
|
}
|
8196
8161
|
},
|
8197
8162
|
{
|
8198
8163
|
"kind": "field",
|
8199
|
-
"name": "
|
8164
|
+
"name": "toggletipPlacement",
|
8200
8165
|
"type": {
|
8201
|
-
"text": "
|
8166
|
+
"text": "PopoverPlacement"
|
8202
8167
|
},
|
8203
|
-
"description": "The
|
8204
|
-
"default": "'
|
8205
|
-
"attribute": "
|
8168
|
+
"description": "The placement of the toggletip that is displayed when the info icon is hovered.",
|
8169
|
+
"default": "'top'",
|
8170
|
+
"attribute": "toggletip-placement",
|
8206
8171
|
"reflects": true,
|
8207
8172
|
"inheritedFrom": {
|
8208
|
-
"name": "
|
8209
|
-
"module": "components/
|
8173
|
+
"name": "FormfieldWrapper",
|
8174
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
8210
8175
|
}
|
8211
8176
|
},
|
8212
8177
|
{
|
8213
8178
|
"kind": "field",
|
8214
|
-
"name": "
|
8179
|
+
"name": "infoIconAriaLabel",
|
8215
8180
|
"type": {
|
8216
|
-
"text": "
|
8181
|
+
"text": "string | undefined"
|
8217
8182
|
},
|
8218
|
-
"description": "
|
8219
|
-
"attribute": "icon-
|
8183
|
+
"description": "Aria label for the info icon that is displayed next to the label when `toggletipText` is set.\nThis is used for accessibility purposes to provide a description of the icon.",
|
8184
|
+
"attribute": "info-icon-aria-label",
|
8220
8185
|
"reflects": true,
|
8221
8186
|
"inheritedFrom": {
|
8222
|
-
"name": "
|
8223
|
-
"module": "components/
|
8187
|
+
"name": "FormfieldWrapper",
|
8188
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
8224
8189
|
}
|
8225
8190
|
},
|
8226
8191
|
{
|
8227
8192
|
"kind": "method",
|
8228
|
-
"name": "
|
8193
|
+
"name": "renderLabelElement",
|
8229
8194
|
"privacy": "protected",
|
8230
|
-
"description": "
|
8195
|
+
"description": "creates the label element when the label property is set.\nid is used to link the label with the input field.",
|
8231
8196
|
"return": {
|
8232
8197
|
"type": {
|
8233
8198
|
"text": ""
|
8234
8199
|
}
|
8235
8200
|
},
|
8236
8201
|
"inheritedFrom": {
|
8237
|
-
"name": "
|
8238
|
-
"module": "components/
|
8202
|
+
"name": "FormfieldWrapper",
|
8203
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
8239
8204
|
}
|
8240
8205
|
},
|
8241
8206
|
{
|
8242
8207
|
"kind": "method",
|
8243
|
-
"name": "
|
8208
|
+
"name": "renderHelpTextIcon",
|
8244
8209
|
"privacy": "protected",
|
8245
|
-
"description": "
|
8210
|
+
"description": "creates the helpertext icon based on the helpTextType for validation.\nIf the helpTextType is not set, it defaults to 'default' and it doesn't display any icon.",
|
8246
8211
|
"return": {
|
8247
8212
|
"type": {
|
8248
8213
|
"text": ""
|
8249
8214
|
}
|
8250
8215
|
},
|
8251
8216
|
"inheritedFrom": {
|
8252
|
-
"name": "
|
8253
|
-
"module": "components/
|
8217
|
+
"name": "FormfieldWrapper",
|
8218
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
8254
8219
|
}
|
8255
8220
|
},
|
8256
8221
|
{
|
8257
8222
|
"kind": "method",
|
8258
|
-
"name": "
|
8223
|
+
"name": "renderHelpText",
|
8259
8224
|
"privacy": "protected",
|
8260
|
-
"description": "
|
8225
|
+
"description": "creates the helper text component when the helpertext value is set.\nIt is also used to display the validation message based on the helpTextType.",
|
8261
8226
|
"return": {
|
8262
8227
|
"type": {
|
8263
8228
|
"text": ""
|
8264
8229
|
}
|
8265
8230
|
},
|
8266
8231
|
"inheritedFrom": {
|
8267
|
-
"name": "
|
8268
|
-
"module": "components/
|
8232
|
+
"name": "FormfieldWrapper",
|
8233
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
8269
8234
|
}
|
8270
8235
|
},
|
8271
8236
|
{
|
8272
8237
|
"kind": "method",
|
8273
|
-
"name": "
|
8238
|
+
"name": "renderLabel",
|
8274
8239
|
"privacy": "protected",
|
8275
|
-
"description": "
|
8240
|
+
"description": "renders the mdc-label-text container that contains the label and labelInfoToggleTip.",
|
8276
8241
|
"return": {
|
8277
8242
|
"type": {
|
8278
8243
|
"text": ""
|
8279
8244
|
}
|
8280
8245
|
},
|
8281
8246
|
"inheritedFrom": {
|
8282
|
-
"name": "
|
8283
|
-
"module": "components/
|
8247
|
+
"name": "FormfieldWrapper",
|
8248
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
8249
|
+
}
|
8250
|
+
},
|
8251
|
+
{
|
8252
|
+
"kind": "method",
|
8253
|
+
"name": "renderHelperText",
|
8254
|
+
"privacy": "protected",
|
8255
|
+
"description": "renders the mdc-help-text container that contains the helpertext icon and helpertext.",
|
8256
|
+
"return": {
|
8257
|
+
"type": {
|
8258
|
+
"text": ""
|
8259
|
+
}
|
8260
|
+
},
|
8261
|
+
"inheritedFrom": {
|
8262
|
+
"name": "FormfieldWrapper",
|
8263
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
8284
8264
|
}
|
8285
8265
|
}
|
8286
8266
|
],
|
8287
8267
|
"events": [
|
8288
8268
|
{
|
8289
|
-
"
|
8290
|
-
|
8291
|
-
|
8292
|
-
},
|
8293
|
-
{
|
8294
|
-
"description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the card. It toggles the checked state when enter key is used.",
|
8295
|
-
"name": "keydown",
|
8296
|
-
"reactName": "onKeyDown"
|
8297
|
-
},
|
8298
|
-
{
|
8299
|
-
"description": "(React: onKeyUp) This event is dispatched when a key is released on the card. It toggles the checked state when space key is used.",
|
8300
|
-
"name": "keyup",
|
8301
|
-
"reactName": "onKeyUp"
|
8269
|
+
"type": {
|
8270
|
+
"text": "EventConstructor"
|
8271
|
+
}
|
8302
8272
|
},
|
8303
8273
|
{
|
8304
|
-
"description": "(React: onChange) Event that gets dispatched when the
|
8274
|
+
"description": "(React: onChange) Event that gets dispatched when the checkbox state changes.",
|
8305
8275
|
"name": "change",
|
8306
8276
|
"reactName": "onChange"
|
8307
8277
|
},
|
8308
8278
|
{
|
8309
|
-
"description": "(React: onFocus) Event that gets dispatched when the
|
8279
|
+
"description": "(React: onFocus) Event that gets dispatched when the checkbox receives focus.",
|
8310
8280
|
"name": "focus",
|
8311
8281
|
"reactName": "onFocus"
|
8312
8282
|
}
|
@@ -8318,177 +8288,207 @@
|
|
8318
8288
|
"text": "boolean"
|
8319
8289
|
},
|
8320
8290
|
"default": "false",
|
8321
|
-
"description": "
|
8291
|
+
"description": "Determines whether the checkbox is selected or unselected.",
|
8322
8292
|
"fieldName": "checked"
|
8323
8293
|
},
|
8294
|
+
{
|
8295
|
+
"name": "indeterminate",
|
8296
|
+
"type": {
|
8297
|
+
"text": "boolean"
|
8298
|
+
},
|
8299
|
+
"default": "false",
|
8300
|
+
"description": "This property is used to determine the parent checkbox in a nested checkbox group.\nIf any one of the children is unselected, then the parent checkbox will be indeterminate.\nIf all children are either selected or unselected, then the parent checkbox will not be indeterminate.",
|
8301
|
+
"fieldName": "indeterminate"
|
8302
|
+
},
|
8303
|
+
{
|
8304
|
+
"name": "autofocus",
|
8305
|
+
"type": {
|
8306
|
+
"text": "boolean"
|
8307
|
+
},
|
8308
|
+
"default": "false",
|
8309
|
+
"description": "Automatically focus on the element when the page loads.\n[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/autofocus)",
|
8310
|
+
"fieldName": "autofocus"
|
8311
|
+
},
|
8324
8312
|
{
|
8325
8313
|
"name": "name",
|
8326
8314
|
"type": {
|
8327
8315
|
"text": "string"
|
8328
8316
|
},
|
8329
8317
|
"default": "''",
|
8330
|
-
"description": "
|
8331
|
-
"fieldName": "name"
|
8318
|
+
"description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
|
8319
|
+
"fieldName": "name",
|
8320
|
+
"inheritedFrom": {
|
8321
|
+
"name": "FormInternalsMixin",
|
8322
|
+
"module": "src/utils/mixins/FormInternalsMixin.ts"
|
8323
|
+
}
|
8332
8324
|
},
|
8333
8325
|
{
|
8334
|
-
"name": "
|
8326
|
+
"name": "value",
|
8335
8327
|
"type": {
|
8336
|
-
"text": "
|
8328
|
+
"text": "string"
|
8337
8329
|
},
|
8338
|
-
"
|
8339
|
-
"
|
8340
|
-
"fieldName": "
|
8330
|
+
"default": "''",
|
8331
|
+
"description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
|
8332
|
+
"fieldName": "value",
|
8341
8333
|
"inheritedFrom": {
|
8342
|
-
"name": "
|
8343
|
-
"module": "src/utils/mixins/
|
8334
|
+
"name": "FormInternalsMixin",
|
8335
|
+
"module": "src/utils/mixins/FormInternalsMixin.ts"
|
8344
8336
|
}
|
8345
8337
|
},
|
8346
8338
|
{
|
8347
|
-
"name": "
|
8339
|
+
"name": "validation-message",
|
8348
8340
|
"type": {
|
8349
|
-
"text": "
|
8341
|
+
"text": "string | undefined"
|
8350
8342
|
},
|
8351
|
-
"
|
8352
|
-
"
|
8353
|
-
"fieldName": "tabIndex",
|
8343
|
+
"description": "Custom validation message that will override the default message and displayed when the input is invalid.\n\nTo display custom validation messages, you must listen for input events (or other relevant events)\non your component and update the `validationMessage` property with the desired message string.\nUpdating this property will ensure that new validation messages are shown to the user.\n- The `validationMessage` property overrides the default browser validation message when set.\n- Consumers are responsible for updating `validationMessage` in response to input or validation state changes.",
|
8344
|
+
"fieldName": "validationMessage",
|
8354
8345
|
"inheritedFrom": {
|
8355
|
-
"name": "
|
8356
|
-
"module": "src/utils/mixins/
|
8346
|
+
"name": "FormInternalsMixin",
|
8347
|
+
"module": "src/utils/mixins/FormInternalsMixin.ts"
|
8357
8348
|
}
|
8358
8349
|
},
|
8359
8350
|
{
|
8360
|
-
"name": "
|
8351
|
+
"name": "data-aria-label",
|
8361
8352
|
"type": {
|
8362
|
-
"text": "string"
|
8353
|
+
"text": "string | null"
|
8363
8354
|
},
|
8364
|
-
"default": "
|
8365
|
-
"description": "
|
8366
|
-
"fieldName": "
|
8355
|
+
"default": "null",
|
8356
|
+
"description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
|
8357
|
+
"fieldName": "dataAriaLabel",
|
8367
8358
|
"inheritedFrom": {
|
8368
|
-
"name": "
|
8369
|
-
"module": "src/
|
8359
|
+
"name": "DataAriaLabelMixin",
|
8360
|
+
"module": "src/utils/mixins/DataAriaLabelMixin.ts"
|
8370
8361
|
}
|
8371
8362
|
},
|
8372
8363
|
{
|
8373
|
-
"name": "
|
8364
|
+
"name": "disabled",
|
8374
8365
|
"type": {
|
8375
|
-
"text": "
|
8366
|
+
"text": "boolean | undefined"
|
8376
8367
|
},
|
8377
|
-
"
|
8378
|
-
"
|
8379
|
-
"fieldName": "
|
8368
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
8369
|
+
"default": "undefined",
|
8370
|
+
"fieldName": "disabled",
|
8380
8371
|
"inheritedFrom": {
|
8381
|
-
"name": "
|
8382
|
-
"module": "src/
|
8372
|
+
"name": "DisabledMixin",
|
8373
|
+
"module": "src/utils/mixins/DisabledMixin.ts"
|
8383
8374
|
}
|
8384
8375
|
},
|
8385
8376
|
{
|
8386
|
-
"name": "
|
8377
|
+
"name": "label",
|
8387
8378
|
"type": {
|
8388
|
-
"text": "string"
|
8379
|
+
"text": "string | undefined"
|
8389
8380
|
},
|
8390
|
-
"
|
8391
|
-
"
|
8392
|
-
"fieldName": "imageSrc",
|
8381
|
+
"description": "The label of the input field. It is linked to the input field using the `for` attribute.",
|
8382
|
+
"fieldName": "label",
|
8393
8383
|
"inheritedFrom": {
|
8394
|
-
"name": "
|
8395
|
-
"module": "src/components/
|
8384
|
+
"name": "FormfieldWrapper",
|
8385
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
8396
8386
|
}
|
8397
8387
|
},
|
8398
8388
|
{
|
8399
|
-
"name": "
|
8389
|
+
"name": "required",
|
8390
|
+
"type": {
|
8391
|
+
"text": "boolean"
|
8392
|
+
},
|
8393
|
+
"default": "false",
|
8394
|
+
"description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
|
8395
|
+
"fieldName": "required",
|
8396
|
+
"inheritedFrom": {
|
8397
|
+
"name": "FormfieldWrapper",
|
8398
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
8399
|
+
}
|
8400
|
+
},
|
8401
|
+
{
|
8402
|
+
"name": "id",
|
8400
8403
|
"type": {
|
8401
8404
|
"text": "string"
|
8402
8405
|
},
|
8403
8406
|
"default": "''",
|
8404
|
-
"description": "The
|
8405
|
-
"fieldName": "
|
8407
|
+
"description": "The unique id of the input field. It is used to link the input field with the label.",
|
8408
|
+
"fieldName": "id",
|
8406
8409
|
"inheritedFrom": {
|
8407
|
-
"name": "
|
8408
|
-
"module": "src/components/
|
8410
|
+
"name": "FormfieldWrapper",
|
8411
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
8409
8412
|
}
|
8410
8413
|
},
|
8411
8414
|
{
|
8412
|
-
"name": "
|
8415
|
+
"name": "help-text-type",
|
8413
8416
|
"type": {
|
8414
|
-
"text": "
|
8417
|
+
"text": "ValidationType"
|
8415
8418
|
},
|
8416
|
-
"description": "The
|
8417
|
-
"
|
8418
|
-
"fieldName": "variant",
|
8419
|
+
"description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
|
8420
|
+
"fieldName": "helpTextType",
|
8419
8421
|
"inheritedFrom": {
|
8420
|
-
"name": "
|
8421
|
-
"module": "src/components/
|
8422
|
+
"name": "FormfieldWrapper",
|
8423
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
8422
8424
|
}
|
8423
8425
|
},
|
8424
8426
|
{
|
8425
|
-
"name": "
|
8427
|
+
"name": "help-text",
|
8426
8428
|
"type": {
|
8427
|
-
"text": "
|
8429
|
+
"text": "string | undefined"
|
8428
8430
|
},
|
8429
|
-
"description": "The
|
8430
|
-
"
|
8431
|
-
"fieldName": "orientation",
|
8431
|
+
"description": "The help text that is displayed below the input field.",
|
8432
|
+
"fieldName": "helpText",
|
8432
8433
|
"inheritedFrom": {
|
8433
|
-
"name": "
|
8434
|
-
"module": "src/components/
|
8434
|
+
"name": "FormfieldWrapper",
|
8435
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
8435
8436
|
}
|
8436
8437
|
},
|
8437
8438
|
{
|
8438
|
-
"name": "
|
8439
|
+
"name": "toggletip-text",
|
8439
8440
|
"type": {
|
8440
|
-
"text": "
|
8441
|
+
"text": "string | undefined"
|
8441
8442
|
},
|
8442
|
-
"description": "The
|
8443
|
-
"
|
8444
|
-
"fieldName": "titleTagName",
|
8443
|
+
"description": "The toggletip text that is displayed when the label is hovered.\nIt is used to provide additional information about the label.",
|
8444
|
+
"fieldName": "toggletipText",
|
8445
8445
|
"inheritedFrom": {
|
8446
|
-
"name": "
|
8447
|
-
"module": "src/components/
|
8446
|
+
"name": "FormfieldWrapper",
|
8447
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
8448
8448
|
}
|
8449
8449
|
},
|
8450
8450
|
{
|
8451
|
-
"name": "
|
8451
|
+
"name": "toggletip-placement",
|
8452
8452
|
"type": {
|
8453
|
-
"text": "
|
8453
|
+
"text": "PopoverPlacement"
|
8454
8454
|
},
|
8455
|
-
"description": "The
|
8456
|
-
"default": "'
|
8457
|
-
"fieldName": "
|
8455
|
+
"description": "The placement of the toggletip that is displayed when the info icon is hovered.",
|
8456
|
+
"default": "'top'",
|
8457
|
+
"fieldName": "toggletipPlacement",
|
8458
8458
|
"inheritedFrom": {
|
8459
|
-
"name": "
|
8460
|
-
"module": "src/components/
|
8459
|
+
"name": "FormfieldWrapper",
|
8460
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
8461
8461
|
}
|
8462
8462
|
},
|
8463
8463
|
{
|
8464
|
-
"name": "icon-
|
8464
|
+
"name": "info-icon-aria-label",
|
8465
8465
|
"type": {
|
8466
|
-
"text": "
|
8466
|
+
"text": "string | undefined"
|
8467
8467
|
},
|
8468
|
-
"description": "
|
8469
|
-
"fieldName": "
|
8468
|
+
"description": "Aria label for the info icon that is displayed next to the label when `toggletipText` is set.\nThis is used for accessibility purposes to provide a description of the icon.",
|
8469
|
+
"fieldName": "infoIconAriaLabel",
|
8470
8470
|
"inheritedFrom": {
|
8471
|
-
"name": "
|
8472
|
-
"module": "src/components/
|
8471
|
+
"name": "FormfieldWrapper",
|
8472
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
8473
8473
|
}
|
8474
8474
|
}
|
8475
8475
|
],
|
8476
8476
|
"mixins": [
|
8477
8477
|
{
|
8478
|
-
"name": "
|
8479
|
-
"module": "/src/utils/mixins/
|
8478
|
+
"name": "FormInternalsMixin",
|
8479
|
+
"module": "/src/utils/mixins/FormInternalsMixin"
|
8480
8480
|
},
|
8481
8481
|
{
|
8482
|
-
"name": "
|
8483
|
-
"module": "/src/utils/mixins/
|
8482
|
+
"name": "DataAriaLabelMixin",
|
8483
|
+
"module": "/src/utils/mixins/DataAriaLabelMixin"
|
8484
8484
|
}
|
8485
8485
|
],
|
8486
8486
|
"superclass": {
|
8487
|
-
"name": "
|
8488
|
-
"module": "/src/components/
|
8487
|
+
"name": "FormfieldWrapper",
|
8488
|
+
"module": "/src/components/formfieldwrapper/formfieldwrapper.component"
|
8489
8489
|
},
|
8490
|
-
"tagName": "mdc-
|
8491
|
-
"jsDoc": "/**\n *
|
8490
|
+
"tagName": "mdc-checkbox",
|
8491
|
+
"jsDoc": "/**\n * Checkboxes allow users to select multiple options from a list or turn an item/feature on or off.\n * These are often used in forms, settings, and selections in lists.\n *\n * A checkbox component contains an optional label and an optional helper text.\n *\n * To create a group of checkboxes, use the FormFieldGroup component.\n *\n * @dependency mdc-button\n * @dependency mdc-icon\n * @dependency mdc-staticcheckbox\n * @dependency mdc-text\n * @dependency mdc-toggletip\n *\n * @tagname mdc-checkbox\n *\n * @event change - (React: onChange) Event that gets dispatched when the checkbox state changes.\n * @event focus - (React: onFocus) Event that gets dispatched when the checkbox receives focus.\n *\n * @cssproperty --mdc-checkbox-background-color-hover - Allows customization of the background color on hover.\n * @cssproperty --mdc-checkbox-checked-background-color-hover - Background color for a selected checkbox when hovered.\n * @cssproperty --mdc-checkbox-checked-pressed-icon-color - Background color for a selected checkbox when pressed.\n * @cssproperty --mdc-checkbox-pressed-icon-color - Background color for a selected checkbox when pressed.\n * @cssproperty --mdc-checkbox-disabled-checked-icon-color - Background color for a selected checkbox when disabled.\n */",
|
8492
8492
|
"customElement": true
|
8493
8493
|
}
|
8494
8494
|
],
|
@@ -8497,8 +8497,8 @@
|
|
8497
8497
|
"kind": "js",
|
8498
8498
|
"name": "default",
|
8499
8499
|
"declaration": {
|
8500
|
-
"name": "
|
8501
|
-
"module": "components/
|
8500
|
+
"name": "Checkbox",
|
8501
|
+
"module": "components/checkbox/checkbox.component.js"
|
8502
8502
|
}
|
8503
8503
|
}
|
8504
8504
|
]
|
@@ -16882,7 +16882,23 @@
|
|
16882
16882
|
},
|
16883
16883
|
{
|
16884
16884
|
"description": "Allows customization of padding left and right.",
|
16885
|
-
"name": "--mdc-listitem-padding-left-
|
16885
|
+
"name": "--mdc-listitem-padding-left-right"
|
16886
|
+
},
|
16887
|
+
{
|
16888
|
+
"description": "Allows customization of padding top and bottom.",
|
16889
|
+
"name": "--mdc-listitem-padding-top-bottom"
|
16890
|
+
},
|
16891
|
+
{
|
16892
|
+
"description": "Allows customization of the cursor.",
|
16893
|
+
"name": "--mdc-listitem-cursor"
|
16894
|
+
},
|
16895
|
+
{
|
16896
|
+
"description": "Allows customization of the width of the list item.",
|
16897
|
+
"name": "--mdc-listitem-width"
|
16898
|
+
},
|
16899
|
+
{
|
16900
|
+
"description": "Allows customization of the height of the list item.",
|
16901
|
+
"name": "--mdc-listitem-height"
|
16886
16902
|
}
|
16887
16903
|
],
|
16888
16904
|
"slots": [
|
@@ -16913,6 +16929,10 @@
|
|
16913
16929
|
{
|
16914
16930
|
"description": "slot for list item controls to appear of trailing end.",
|
16915
16931
|
"name": "trailing-controls"
|
16932
|
+
},
|
16933
|
+
{
|
16934
|
+
"description": "content slot can be used to override the content completely. Be aware that this will override the default content of the list item.",
|
16935
|
+
"name": "content"
|
16916
16936
|
}
|
16917
16937
|
],
|
16918
16938
|
"members": [
|
@@ -17357,7 +17377,7 @@
|
|
17357
17377
|
"module": "/src/models"
|
17358
17378
|
},
|
17359
17379
|
"tagName": "mdc-listitem",
|
17360
|
-
"jsDoc": "/**\n * mdc-listitem component is used to display a label with different types of controls.\n * There can be three types of controls, a radio button, a checkbox on the\n * leading side and a toggle on the trailing side.\n * The list item can contain an avatar on the leading side and a badge on the trailing side.\n * Additionally, the list item can contain a side header and a subline text.\n *\n * The leading and trailing slots can be used to display controls and text. <br/>\n * Based on the leading/trailing slot, the position of the controls and text can be adjusted. <br/>\n * Please use mdc-list as a parent element even when there is only listitem for a11y purpose.\n *\n * By providing the tooltip-text attribute, a tooltip will be displayed on hover of the listitem.\n * The placement of the tooltip can be adjusted using the tooltip-placement attribute.\n * This will be helpful when the listitem text is truncated or\n * when you want to display additional information about the listitem.\n *\n * @tagname mdc-listitem\n *\n * @dependency mdc-text\n * @dependency mdc-tooltip\n *\n * @slot leading-controls - slot for list item controls to appear of leading end.\n * @slot leading-text-primary-label - slot for list item primary label.\n * @slot leading-text-secondary-label - slot for list item secondary label.\n * @slot leading-text-tertiary-label - slot for list item tertiary label.\n * @slot trailing-text-side-header - slot for list item side header text.\n * @slot trailing-text-subline - slot for list item subline text.\n * @slot trailing-controls - slot for list item controls to appear of trailing end.\n *\n * @cssproperty --mdc-listitem-default-background-color - Allows customization of the default background color.\n * @cssproperty --mdc-listitem-background-color-hover - Allows customization of the background color on hover.\n * @cssproperty --mdc-listitem-background-color-active - Allows customization of the background color when pressed.\n * @cssproperty --mdc-listitem-primary-label-color\n * - Allows customization of the primary label, side header and subline text slot color.\n * @cssproperty --mdc-listitem-secondary-label-color\n * - Allows customization of the secondary and tertiary label text slot color.\n * @cssproperty --mdc-listitem-disabled-color - Allows customization of the disabled color.\n * @cssproperty --mdc-listitem-column-gap - Allows customization of column gap.\n * @cssproperty --mdc-listitem-padding-left-
|
17380
|
+
"jsDoc": "/**\n * mdc-listitem component is used to display a label with different types of controls.\n * There can be three types of controls, a radio button, a checkbox on the\n * leading side and a toggle on the trailing side.\n * The list item can contain an avatar on the leading side and a badge on the trailing side.\n * Additionally, the list item can contain a side header and a subline text.\n *\n * The leading and trailing slots can be used to display controls and text. <br/>\n * Based on the leading/trailing slot, the position of the controls and text can be adjusted. <br/>\n * Please use mdc-list as a parent element even when there is only listitem for a11y purpose.\n *\n * By providing the tooltip-text attribute, a tooltip will be displayed on hover of the listitem.\n * The placement of the tooltip can be adjusted using the tooltip-placement attribute.\n * This will be helpful when the listitem text is truncated or\n * when you want to display additional information about the listitem.\n *\n * @tagname mdc-listitem\n *\n * @dependency mdc-text\n * @dependency mdc-tooltip\n *\n * @slot leading-controls - slot for list item controls to appear of leading end.\n * @slot leading-text-primary-label - slot for list item primary label.\n * @slot leading-text-secondary-label - slot for list item secondary label.\n * @slot leading-text-tertiary-label - slot for list item tertiary label.\n * @slot trailing-text-side-header - slot for list item side header text.\n * @slot trailing-text-subline - slot for list item subline text.\n * @slot trailing-controls - slot for list item controls to appear of trailing end.\n * @slot content - content slot can be used to override the content completely. Be aware that\n * this will override the default content of the list item.\n *\n * @cssproperty --mdc-listitem-default-background-color - Allows customization of the default background color.\n * @cssproperty --mdc-listitem-background-color-hover - Allows customization of the background color on hover.\n * @cssproperty --mdc-listitem-background-color-active - Allows customization of the background color when pressed.\n * @cssproperty --mdc-listitem-primary-label-color\n * - Allows customization of the primary label, side header and subline text slot color.\n * @cssproperty --mdc-listitem-secondary-label-color\n * - Allows customization of the secondary and tertiary label text slot color.\n * @cssproperty --mdc-listitem-disabled-color - Allows customization of the disabled color.\n * @cssproperty --mdc-listitem-column-gap - Allows customization of column gap.\n * @cssproperty --mdc-listitem-padding-left-right - Allows customization of padding left and right.\n * @cssproperty --mdc-listitem-padding-top-bottom - Allows customization of padding top and bottom.\n * @cssproperty --mdc-listitem-cursor - Allows customization of the cursor.\n * @cssproperty --mdc-listitem-width - Allows customization of the width of the list item.\n * @cssproperty --mdc-listitem-height - Allows customization of the height of the list item.\n *\n * @event click - (React: onClick) This event is dispatched when the listitem is clicked.\n * @event keydown - (React: onKeyDown) This event is dispatched when a key is pressed down on the listitem.\n * @event keyup - (React: onKeyUp) This event is dispatched when a key is released on the listitem.\n * @event focus - (React: onFocus) This event is dispatched when the listitem receives focus.\n * @event enabled - (React: onEnabled) This event is dispatched after the listitem is enabled\n * @event disabled - (React: onDisabled) This event is dispatched after the listitem is disabled\n * @event created - (React: onCreated) This event is dispatched after the listitem is created (added to the DOM)\n * @event destroyed - (React: onDestroyed) This event is dispatched after the listitem is destroyed (removed from the DOM)\n */",
|
17361
17381
|
"customElement": true
|
17362
17382
|
}
|
17363
17383
|
],
|
@@ -17865,6 +17885,14 @@
|
|
17865
17885
|
"name": "ListItem",
|
17866
17886
|
"module": "src/components/listitem/listitem.component.ts"
|
17867
17887
|
}
|
17888
|
+
},
|
17889
|
+
{
|
17890
|
+
"description": "content slot can be used to override the content completely. Be aware that this will override the default content of the list item.",
|
17891
|
+
"name": "content",
|
17892
|
+
"inheritedFrom": {
|
17893
|
+
"name": "ListItem",
|
17894
|
+
"module": "src/components/listitem/listitem.component.ts"
|
17895
|
+
}
|
17868
17896
|
}
|
17869
17897
|
],
|
17870
17898
|
"members": [
|
@@ -18600,7 +18628,39 @@
|
|
18600
18628
|
},
|
18601
18629
|
{
|
18602
18630
|
"description": "Allows customization of padding left and right.",
|
18603
|
-
"name": "--mdc-listitem-padding-left-
|
18631
|
+
"name": "--mdc-listitem-padding-left-right",
|
18632
|
+
"inheritedFrom": {
|
18633
|
+
"name": "ListItem",
|
18634
|
+
"module": "src/components/listitem/listitem.component.ts"
|
18635
|
+
}
|
18636
|
+
},
|
18637
|
+
{
|
18638
|
+
"description": "Allows customization of padding top and bottom.",
|
18639
|
+
"name": "--mdc-listitem-padding-top-bottom",
|
18640
|
+
"inheritedFrom": {
|
18641
|
+
"name": "ListItem",
|
18642
|
+
"module": "src/components/listitem/listitem.component.ts"
|
18643
|
+
}
|
18644
|
+
},
|
18645
|
+
{
|
18646
|
+
"description": "Allows customization of the cursor.",
|
18647
|
+
"name": "--mdc-listitem-cursor",
|
18648
|
+
"inheritedFrom": {
|
18649
|
+
"name": "ListItem",
|
18650
|
+
"module": "src/components/listitem/listitem.component.ts"
|
18651
|
+
}
|
18652
|
+
},
|
18653
|
+
{
|
18654
|
+
"description": "Allows customization of the width of the list item.",
|
18655
|
+
"name": "--mdc-listitem-width",
|
18656
|
+
"inheritedFrom": {
|
18657
|
+
"name": "ListItem",
|
18658
|
+
"module": "src/components/listitem/listitem.component.ts"
|
18659
|
+
}
|
18660
|
+
},
|
18661
|
+
{
|
18662
|
+
"description": "Allows customization of the height of the list item.",
|
18663
|
+
"name": "--mdc-listitem-height",
|
18604
18664
|
"inheritedFrom": {
|
18605
18665
|
"name": "ListItem",
|
18606
18666
|
"module": "src/components/listitem/listitem.component.ts"
|
@@ -18684,6 +18744,14 @@
|
|
18684
18744
|
"name": "ListItem",
|
18685
18745
|
"module": "src/components/listitem/listitem.component.ts"
|
18686
18746
|
}
|
18747
|
+
},
|
18748
|
+
{
|
18749
|
+
"description": "content slot can be used to override the content completely. Be aware that this will override the default content of the list item.",
|
18750
|
+
"name": "content",
|
18751
|
+
"inheritedFrom": {
|
18752
|
+
"name": "ListItem",
|
18753
|
+
"module": "src/components/listitem/listitem.component.ts"
|
18754
|
+
}
|
18687
18755
|
}
|
18688
18756
|
],
|
18689
18757
|
"members": [
|
@@ -19542,7 +19610,39 @@
|
|
19542
19610
|
},
|
19543
19611
|
{
|
19544
19612
|
"description": "Allows customization of padding left and right.",
|
19545
|
-
"name": "--mdc-listitem-padding-left-
|
19613
|
+
"name": "--mdc-listitem-padding-left-right",
|
19614
|
+
"inheritedFrom": {
|
19615
|
+
"name": "ListItem",
|
19616
|
+
"module": "src/components/listitem/listitem.component.ts"
|
19617
|
+
}
|
19618
|
+
},
|
19619
|
+
{
|
19620
|
+
"description": "Allows customization of padding top and bottom.",
|
19621
|
+
"name": "--mdc-listitem-padding-top-bottom",
|
19622
|
+
"inheritedFrom": {
|
19623
|
+
"name": "ListItem",
|
19624
|
+
"module": "src/components/listitem/listitem.component.ts"
|
19625
|
+
}
|
19626
|
+
},
|
19627
|
+
{
|
19628
|
+
"description": "Allows customization of the cursor.",
|
19629
|
+
"name": "--mdc-listitem-cursor",
|
19630
|
+
"inheritedFrom": {
|
19631
|
+
"name": "ListItem",
|
19632
|
+
"module": "src/components/listitem/listitem.component.ts"
|
19633
|
+
}
|
19634
|
+
},
|
19635
|
+
{
|
19636
|
+
"description": "Allows customization of the width of the list item.",
|
19637
|
+
"name": "--mdc-listitem-width",
|
19638
|
+
"inheritedFrom": {
|
19639
|
+
"name": "ListItem",
|
19640
|
+
"module": "src/components/listitem/listitem.component.ts"
|
19641
|
+
}
|
19642
|
+
},
|
19643
|
+
{
|
19644
|
+
"description": "Allows customization of the height of the list item.",
|
19645
|
+
"name": "--mdc-listitem-height",
|
19546
19646
|
"inheritedFrom": {
|
19547
19647
|
"name": "ListItem",
|
19548
19648
|
"module": "src/components/listitem/listitem.component.ts"
|
@@ -19626,6 +19726,14 @@
|
|
19626
19726
|
"name": "ListItem",
|
19627
19727
|
"module": "src/components/listitem/listitem.component.ts"
|
19628
19728
|
}
|
19729
|
+
},
|
19730
|
+
{
|
19731
|
+
"description": "content slot can be used to override the content completely. Be aware that this will override the default content of the list item.",
|
19732
|
+
"name": "content",
|
19733
|
+
"inheritedFrom": {
|
19734
|
+
"name": "ListItem",
|
19735
|
+
"module": "src/components/listitem/listitem.component.ts"
|
19736
|
+
}
|
19629
19737
|
}
|
19630
19738
|
],
|
19631
19739
|
"members": [
|
@@ -20495,7 +20603,39 @@
|
|
20495
20603
|
},
|
20496
20604
|
{
|
20497
20605
|
"description": "Allows customization of padding left and right.",
|
20498
|
-
"name": "--mdc-listitem-padding-left-
|
20606
|
+
"name": "--mdc-listitem-padding-left-right",
|
20607
|
+
"inheritedFrom": {
|
20608
|
+
"name": "ListItem",
|
20609
|
+
"module": "src/components/listitem/listitem.component.ts"
|
20610
|
+
}
|
20611
|
+
},
|
20612
|
+
{
|
20613
|
+
"description": "Allows customization of padding top and bottom.",
|
20614
|
+
"name": "--mdc-listitem-padding-top-bottom",
|
20615
|
+
"inheritedFrom": {
|
20616
|
+
"name": "ListItem",
|
20617
|
+
"module": "src/components/listitem/listitem.component.ts"
|
20618
|
+
}
|
20619
|
+
},
|
20620
|
+
{
|
20621
|
+
"description": "Allows customization of the cursor.",
|
20622
|
+
"name": "--mdc-listitem-cursor",
|
20623
|
+
"inheritedFrom": {
|
20624
|
+
"name": "ListItem",
|
20625
|
+
"module": "src/components/listitem/listitem.component.ts"
|
20626
|
+
}
|
20627
|
+
},
|
20628
|
+
{
|
20629
|
+
"description": "Allows customization of the width of the list item.",
|
20630
|
+
"name": "--mdc-listitem-width",
|
20631
|
+
"inheritedFrom": {
|
20632
|
+
"name": "ListItem",
|
20633
|
+
"module": "src/components/listitem/listitem.component.ts"
|
20634
|
+
}
|
20635
|
+
},
|
20636
|
+
{
|
20637
|
+
"description": "Allows customization of the height of the list item.",
|
20638
|
+
"name": "--mdc-listitem-height",
|
20499
20639
|
"inheritedFrom": {
|
20500
20640
|
"name": "ListItem",
|
20501
20641
|
"module": "src/components/listitem/listitem.component.ts"
|
@@ -22911,7 +23051,39 @@
|
|
22911
23051
|
},
|
22912
23052
|
{
|
22913
23053
|
"description": "Allows customization of padding left and right.",
|
22914
|
-
"name": "--mdc-listitem-padding-left-
|
23054
|
+
"name": "--mdc-listitem-padding-left-right",
|
23055
|
+
"inheritedFrom": {
|
23056
|
+
"name": "ListItem",
|
23057
|
+
"module": "src/components/listitem/listitem.component.ts"
|
23058
|
+
}
|
23059
|
+
},
|
23060
|
+
{
|
23061
|
+
"description": "Allows customization of padding top and bottom.",
|
23062
|
+
"name": "--mdc-listitem-padding-top-bottom",
|
23063
|
+
"inheritedFrom": {
|
23064
|
+
"name": "ListItem",
|
23065
|
+
"module": "src/components/listitem/listitem.component.ts"
|
23066
|
+
}
|
23067
|
+
},
|
23068
|
+
{
|
23069
|
+
"description": "Allows customization of the cursor.",
|
23070
|
+
"name": "--mdc-listitem-cursor",
|
23071
|
+
"inheritedFrom": {
|
23072
|
+
"name": "ListItem",
|
23073
|
+
"module": "src/components/listitem/listitem.component.ts"
|
23074
|
+
}
|
23075
|
+
},
|
23076
|
+
{
|
23077
|
+
"description": "Allows customization of the width of the list item.",
|
23078
|
+
"name": "--mdc-listitem-width",
|
23079
|
+
"inheritedFrom": {
|
23080
|
+
"name": "ListItem",
|
23081
|
+
"module": "src/components/listitem/listitem.component.ts"
|
23082
|
+
}
|
23083
|
+
},
|
23084
|
+
{
|
23085
|
+
"description": "Allows customization of the height of the list item.",
|
23086
|
+
"name": "--mdc-listitem-height",
|
22915
23087
|
"inheritedFrom": {
|
22916
23088
|
"name": "ListItem",
|
22917
23089
|
"module": "src/components/listitem/listitem.component.ts"
|
@@ -23913,6 +24085,14 @@
|
|
23913
24085
|
"name": "ListItem",
|
23914
24086
|
"module": "src/components/listitem/listitem.component.ts"
|
23915
24087
|
}
|
24088
|
+
},
|
24089
|
+
{
|
24090
|
+
"description": "content slot can be used to override the content completely. Be aware that this will override the default content of the list item.",
|
24091
|
+
"name": "content",
|
24092
|
+
"inheritedFrom": {
|
24093
|
+
"name": "ListItem",
|
24094
|
+
"module": "src/components/listitem/listitem.component.ts"
|
24095
|
+
}
|
23916
24096
|
}
|
23917
24097
|
]
|
23918
24098
|
}
|
@@ -24910,6 +25090,14 @@
|
|
24910
25090
|
"name": "ListItem",
|
24911
25091
|
"module": "src/components/listitem/listitem.component.ts"
|
24912
25092
|
}
|
25093
|
+
},
|
25094
|
+
{
|
25095
|
+
"description": "content slot can be used to override the content completely. Be aware that this will override the default content of the list item.",
|
25096
|
+
"name": "content",
|
25097
|
+
"inheritedFrom": {
|
25098
|
+
"name": "ListItem",
|
25099
|
+
"module": "src/components/listitem/listitem.component.ts"
|
25100
|
+
}
|
24913
25101
|
}
|
24914
25102
|
],
|
24915
25103
|
"cssProperties": [
|
@@ -24971,7 +25159,39 @@
|
|
24971
25159
|
},
|
24972
25160
|
{
|
24973
25161
|
"description": "Allows customization of padding left and right.",
|
24974
|
-
"name": "--mdc-listitem-padding-left-
|
25162
|
+
"name": "--mdc-listitem-padding-left-right",
|
25163
|
+
"inheritedFrom": {
|
25164
|
+
"name": "ListItem",
|
25165
|
+
"module": "src/components/listitem/listitem.component.ts"
|
25166
|
+
}
|
25167
|
+
},
|
25168
|
+
{
|
25169
|
+
"description": "Allows customization of padding top and bottom.",
|
25170
|
+
"name": "--mdc-listitem-padding-top-bottom",
|
25171
|
+
"inheritedFrom": {
|
25172
|
+
"name": "ListItem",
|
25173
|
+
"module": "src/components/listitem/listitem.component.ts"
|
25174
|
+
}
|
25175
|
+
},
|
25176
|
+
{
|
25177
|
+
"description": "Allows customization of the cursor.",
|
25178
|
+
"name": "--mdc-listitem-cursor",
|
25179
|
+
"inheritedFrom": {
|
25180
|
+
"name": "ListItem",
|
25181
|
+
"module": "src/components/listitem/listitem.component.ts"
|
25182
|
+
}
|
25183
|
+
},
|
25184
|
+
{
|
25185
|
+
"description": "Allows customization of the width of the list item.",
|
25186
|
+
"name": "--mdc-listitem-width",
|
25187
|
+
"inheritedFrom": {
|
25188
|
+
"name": "ListItem",
|
25189
|
+
"module": "src/components/listitem/listitem.component.ts"
|
25190
|
+
}
|
25191
|
+
},
|
25192
|
+
{
|
25193
|
+
"description": "Allows customization of the height of the list item.",
|
25194
|
+
"name": "--mdc-listitem-height",
|
24975
25195
|
"inheritedFrom": {
|
24976
25196
|
"name": "ListItem",
|
24977
25197
|
"module": "src/components/listitem/listitem.component.ts"
|
@@ -41036,6 +41256,342 @@
|
|
41036
41256
|
}
|
41037
41257
|
]
|
41038
41258
|
},
|
41259
|
+
{
|
41260
|
+
"kind": "javascript-module",
|
41261
|
+
"path": "components/typewriter/typewriter.component.js",
|
41262
|
+
"declarations": [
|
41263
|
+
{
|
41264
|
+
"kind": "class",
|
41265
|
+
"description": "Typewriter component that creates a typewriter effect on text content.\nIt uses the Text component internally, adding a progressive typing effect.\n\nThe `type` attribute allows changing the text style (passed to the internal Text component).\nThe `tagname` attribute allows changing the tag name of the text element (passed to the internal Text component).\nThe default tag name is `p`.\n\nThe `speed` attribute controls typing speed in milliseconds per character:\n- 'very-slow' = 240ms per character\n- 'slow' = 120ms per character\n- 'normal' = 60ms per character (default)\n- 'fast' = 20ms per character\n- 'very-fast' = 1ms per character\n- Or any numeric string representing milliseconds\n\nAdvanced features:\n- Dynamic speed adjustment during typing\n- Chunked text addition via addTextChunk() method\n- Instant text addition via addInstantTextChunk() method or instant parameter\n- Mixed instant and animated chunks in queue\n- Continues typing in background tabs\n- Performance optimized for large text\n- maxQueueSize to limit memory usage from excessive queuing\n- event handling for typing completion and content changes\n\nThe component includes accessibility features:\n- Screen readers announce the complete text, not character by character\n- Uses aria-live=\"polite\" for dynamic content updates\n- Sets aria-busy during typing animation",
|
41266
|
+
"name": "Typewriter",
|
41267
|
+
"cssParts": [
|
41268
|
+
{
|
41269
|
+
"description": "Container for the text element",
|
41270
|
+
"name": "container"
|
41271
|
+
},
|
41272
|
+
{
|
41273
|
+
"description": "The text element (forwarded to mdc-text)",
|
41274
|
+
"name": "text"
|
41275
|
+
}
|
41276
|
+
],
|
41277
|
+
"slots": [
|
41278
|
+
{
|
41279
|
+
"description": "Default slot for text content",
|
41280
|
+
"name": ""
|
41281
|
+
}
|
41282
|
+
],
|
41283
|
+
"members": [
|
41284
|
+
{
|
41285
|
+
"kind": "field",
|
41286
|
+
"name": "type",
|
41287
|
+
"type": {
|
41288
|
+
"text": "TextType"
|
41289
|
+
},
|
41290
|
+
"privacy": "public",
|
41291
|
+
"description": "Specifies the text style to be applied to the internal text component.\nUses the same types as the Text component.",
|
41292
|
+
"default": "body-large-regular",
|
41293
|
+
"attribute": "type",
|
41294
|
+
"reflects": true
|
41295
|
+
},
|
41296
|
+
{
|
41297
|
+
"kind": "field",
|
41298
|
+
"name": "tagname",
|
41299
|
+
"type": {
|
41300
|
+
"text": "TagName | undefined"
|
41301
|
+
},
|
41302
|
+
"privacy": "public",
|
41303
|
+
"description": "Specifies the HTML tag name for the text element. The default tag name is `p`.\nThis attribute is optional. When set, it changes the tag name of the internal text element.\n\nAcceptable values include all valid tag names from the Text component.",
|
41304
|
+
"attribute": "tagname",
|
41305
|
+
"reflects": true
|
41306
|
+
},
|
41307
|
+
{
|
41308
|
+
"kind": "field",
|
41309
|
+
"name": "speed",
|
41310
|
+
"type": {
|
41311
|
+
"text": "TypewriterSpeed"
|
41312
|
+
},
|
41313
|
+
"privacy": "public",
|
41314
|
+
"description": "Speed of the typewriter effect in milliseconds per character.\nCan be a string preset or a numeric string in milliseconds.\n- 'very-slow' = 240ms per character\n- 'slow' = 120ms per character\n- 'normal' = 60ms per character (default)\n- 'fast' = 20ms per character\n- 'very-fast' = 1ms per character\n- Or any numeric string representing milliseconds (e.g., '100')",
|
41315
|
+
"default": "'normal' (60ms per character)",
|
41316
|
+
"attribute": "speed",
|
41317
|
+
"reflects": true
|
41318
|
+
},
|
41319
|
+
{
|
41320
|
+
"kind": "field",
|
41321
|
+
"name": "maxQueueSize",
|
41322
|
+
"type": {
|
41323
|
+
"text": "number"
|
41324
|
+
},
|
41325
|
+
"privacy": "public",
|
41326
|
+
"description": "Maximum number of text chunks that can be queued before oldest chunks are dropped.\nSet to prevent memory accumulation from excessive queuing.",
|
41327
|
+
"default": "Number.MAX_SAFE_INTEGER (effectively unlimited)",
|
41328
|
+
"attribute": "max-queue-size",
|
41329
|
+
"reflects": true
|
41330
|
+
},
|
41331
|
+
{
|
41332
|
+
"kind": "method",
|
41333
|
+
"name": "createTimeout",
|
41334
|
+
"privacy": "private",
|
41335
|
+
"return": {
|
41336
|
+
"type": {
|
41337
|
+
"text": "number"
|
41338
|
+
}
|
41339
|
+
},
|
41340
|
+
"parameters": [
|
41341
|
+
{
|
41342
|
+
"name": "callback",
|
41343
|
+
"type": {
|
41344
|
+
"text": "() => void"
|
41345
|
+
}
|
41346
|
+
},
|
41347
|
+
{
|
41348
|
+
"name": "delay",
|
41349
|
+
"type": {
|
41350
|
+
"text": "number"
|
41351
|
+
}
|
41352
|
+
}
|
41353
|
+
],
|
41354
|
+
"description": "Helper to create tracked setTimeout that will be cleaned up on disconnect"
|
41355
|
+
},
|
41356
|
+
{
|
41357
|
+
"kind": "method",
|
41358
|
+
"name": "clearAllTimeouts",
|
41359
|
+
"privacy": "private",
|
41360
|
+
"return": {
|
41361
|
+
"type": {
|
41362
|
+
"text": "void"
|
41363
|
+
}
|
41364
|
+
},
|
41365
|
+
"description": "Clear all pending timeouts"
|
41366
|
+
},
|
41367
|
+
{
|
41368
|
+
"kind": "method",
|
41369
|
+
"name": "clearQueue",
|
41370
|
+
"privacy": "public",
|
41371
|
+
"return": {
|
41372
|
+
"type": {
|
41373
|
+
"text": "void"
|
41374
|
+
}
|
41375
|
+
},
|
41376
|
+
"description": "Clears the text chunk queue and stops processing\nUseful for resetting the component state"
|
41377
|
+
},
|
41378
|
+
{
|
41379
|
+
"kind": "method",
|
41380
|
+
"name": "addTextChunk",
|
41381
|
+
"privacy": "public",
|
41382
|
+
"return": {
|
41383
|
+
"type": {
|
41384
|
+
"text": "void"
|
41385
|
+
}
|
41386
|
+
},
|
41387
|
+
"parameters": [
|
41388
|
+
{
|
41389
|
+
"name": "text",
|
41390
|
+
"type": {
|
41391
|
+
"text": "string"
|
41392
|
+
},
|
41393
|
+
"description": "The text to add"
|
41394
|
+
},
|
41395
|
+
{
|
41396
|
+
"name": "speed",
|
41397
|
+
"optional": true,
|
41398
|
+
"type": {
|
41399
|
+
"text": "TypewriterSpeed"
|
41400
|
+
},
|
41401
|
+
"description": "Optional speed override for this chunk"
|
41402
|
+
},
|
41403
|
+
{
|
41404
|
+
"name": "instant",
|
41405
|
+
"optional": true,
|
41406
|
+
"type": {
|
41407
|
+
"text": "boolean"
|
41408
|
+
},
|
41409
|
+
"description": "If true, text appears instantly without animation"
|
41410
|
+
}
|
41411
|
+
],
|
41412
|
+
"description": "Adds a chunk of text to be typed out, optionally with a different speed"
|
41413
|
+
},
|
41414
|
+
{
|
41415
|
+
"kind": "method",
|
41416
|
+
"name": "addInstantTextChunk",
|
41417
|
+
"privacy": "public",
|
41418
|
+
"return": {
|
41419
|
+
"type": {
|
41420
|
+
"text": "void"
|
41421
|
+
}
|
41422
|
+
},
|
41423
|
+
"parameters": [
|
41424
|
+
{
|
41425
|
+
"name": "text",
|
41426
|
+
"type": {
|
41427
|
+
"text": "string"
|
41428
|
+
},
|
41429
|
+
"description": "The text to add instantly"
|
41430
|
+
}
|
41431
|
+
],
|
41432
|
+
"description": "Adds a chunk of text instantly without typing animation"
|
41433
|
+
},
|
41434
|
+
{
|
41435
|
+
"kind": "method",
|
41436
|
+
"name": "processChunkQueue",
|
41437
|
+
"privacy": "private",
|
41438
|
+
"return": {
|
41439
|
+
"type": {
|
41440
|
+
"text": "void"
|
41441
|
+
}
|
41442
|
+
},
|
41443
|
+
"description": "Processes all chunks in the queue"
|
41444
|
+
},
|
41445
|
+
{
|
41446
|
+
"kind": "method",
|
41447
|
+
"name": "processNextChunk",
|
41448
|
+
"privacy": "private",
|
41449
|
+
"return": {
|
41450
|
+
"type": {
|
41451
|
+
"text": "void"
|
41452
|
+
}
|
41453
|
+
},
|
41454
|
+
"description": "Processes the next chunk in the queue"
|
41455
|
+
},
|
41456
|
+
{
|
41457
|
+
"kind": "method",
|
41458
|
+
"name": "getTypingDelayMs",
|
41459
|
+
"privacy": "private",
|
41460
|
+
"return": {
|
41461
|
+
"type": {
|
41462
|
+
"text": "number"
|
41463
|
+
}
|
41464
|
+
},
|
41465
|
+
"description": "Gets the typing delay in milliseconds per character"
|
41466
|
+
},
|
41467
|
+
{
|
41468
|
+
"kind": "method",
|
41469
|
+
"name": "captureAndProcessContent",
|
41470
|
+
"privacy": "private",
|
41471
|
+
"return": {
|
41472
|
+
"type": {
|
41473
|
+
"text": "void"
|
41474
|
+
}
|
41475
|
+
},
|
41476
|
+
"description": "Captures slot content and starts typewriter animation"
|
41477
|
+
},
|
41478
|
+
{
|
41479
|
+
"kind": "method",
|
41480
|
+
"name": "startTypingAnimation",
|
41481
|
+
"privacy": "private",
|
41482
|
+
"return": {
|
41483
|
+
"type": {
|
41484
|
+
"text": "void"
|
41485
|
+
}
|
41486
|
+
},
|
41487
|
+
"parameters": [
|
41488
|
+
{
|
41489
|
+
"name": "onComplete",
|
41490
|
+
"optional": true,
|
41491
|
+
"type": {
|
41492
|
+
"text": "() => void"
|
41493
|
+
}
|
41494
|
+
}
|
41495
|
+
],
|
41496
|
+
"description": "Starts the typewriter animation"
|
41497
|
+
},
|
41498
|
+
{
|
41499
|
+
"kind": "method",
|
41500
|
+
"name": "clearTypingAnimation",
|
41501
|
+
"privacy": "private",
|
41502
|
+
"return": {
|
41503
|
+
"type": {
|
41504
|
+
"text": "void"
|
41505
|
+
}
|
41506
|
+
},
|
41507
|
+
"description": "Clears the typing animation timeout"
|
41508
|
+
},
|
41509
|
+
{
|
41510
|
+
"kind": "method",
|
41511
|
+
"name": "handleSlotChange",
|
41512
|
+
"privacy": "private",
|
41513
|
+
"return": {
|
41514
|
+
"type": {
|
41515
|
+
"text": "void"
|
41516
|
+
}
|
41517
|
+
},
|
41518
|
+
"description": "Handler for slotchange event"
|
41519
|
+
}
|
41520
|
+
],
|
41521
|
+
"events": [
|
41522
|
+
{
|
41523
|
+
"type": {
|
41524
|
+
"text": "CustomEvent"
|
41525
|
+
}
|
41526
|
+
},
|
41527
|
+
{
|
41528
|
+
"description": "(React: onTypingComplete) Fired when the typewriter finishes typing all content. Detail: \\{ finalContent: string \\}",
|
41529
|
+
"name": "typing-complete",
|
41530
|
+
"reactName": "onTypingComplete"
|
41531
|
+
},
|
41532
|
+
{
|
41533
|
+
"description": "(React: onChange) Fired when the content of the typewriter changes. Detail: \\{ content: string, isTyping: boolean \\}",
|
41534
|
+
"name": "change",
|
41535
|
+
"reactName": "onChange"
|
41536
|
+
}
|
41537
|
+
],
|
41538
|
+
"attributes": [
|
41539
|
+
{
|
41540
|
+
"name": "type",
|
41541
|
+
"type": {
|
41542
|
+
"text": "TextType"
|
41543
|
+
},
|
41544
|
+
"description": "Specifies the text style to be applied to the internal text component.\nUses the same types as the Text component.",
|
41545
|
+
"default": "body-large-regular",
|
41546
|
+
"fieldName": "type"
|
41547
|
+
},
|
41548
|
+
{
|
41549
|
+
"name": "tagname",
|
41550
|
+
"type": {
|
41551
|
+
"text": "TagName | undefined"
|
41552
|
+
},
|
41553
|
+
"description": "Specifies the HTML tag name for the text element. The default tag name is `p`.\nThis attribute is optional. When set, it changes the tag name of the internal text element.\n\nAcceptable values include all valid tag names from the Text component.",
|
41554
|
+
"fieldName": "tagname"
|
41555
|
+
},
|
41556
|
+
{
|
41557
|
+
"name": "speed",
|
41558
|
+
"type": {
|
41559
|
+
"text": "TypewriterSpeed"
|
41560
|
+
},
|
41561
|
+
"description": "Speed of the typewriter effect in milliseconds per character.\nCan be a string preset or a numeric string in milliseconds.\n- 'very-slow' = 240ms per character\n- 'slow' = 120ms per character\n- 'normal' = 60ms per character (default)\n- 'fast' = 20ms per character\n- 'very-fast' = 1ms per character\n- Or any numeric string representing milliseconds (e.g., '100')",
|
41562
|
+
"default": "'normal' (60ms per character)",
|
41563
|
+
"fieldName": "speed"
|
41564
|
+
},
|
41565
|
+
{
|
41566
|
+
"name": "max-queue-size",
|
41567
|
+
"type": {
|
41568
|
+
"text": "number"
|
41569
|
+
},
|
41570
|
+
"description": "Maximum number of text chunks that can be queued before oldest chunks are dropped.\nSet to prevent memory accumulation from excessive queuing.",
|
41571
|
+
"default": "Number.MAX_SAFE_INTEGER (effectively unlimited)",
|
41572
|
+
"fieldName": "maxQueueSize"
|
41573
|
+
}
|
41574
|
+
],
|
41575
|
+
"superclass": {
|
41576
|
+
"name": "Component",
|
41577
|
+
"module": "/src/models"
|
41578
|
+
},
|
41579
|
+
"tagName": "mdc-typewriter",
|
41580
|
+
"jsDoc": "/**\n * Typewriter component that creates a typewriter effect on text content.\n * It uses the Text component internally, adding a progressive typing effect.\n *\n * The `type` attribute allows changing the text style (passed to the internal Text component).\n * The `tagname` attribute allows changing the tag name of the text element (passed to the internal Text component).\n * The default tag name is `p`.\n *\n * The `speed` attribute controls typing speed in milliseconds per character:\n * - 'very-slow' = 240ms per character\n * - 'slow' = 120ms per character\n * - 'normal' = 60ms per character (default)\n * - 'fast' = 20ms per character\n * - 'very-fast' = 1ms per character\n * - Or any numeric string representing milliseconds\n *\n * Advanced features:\n * - Dynamic speed adjustment during typing\n * - Chunked text addition via addTextChunk() method\n * - Instant text addition via addInstantTextChunk() method or instant parameter\n * - Mixed instant and animated chunks in queue\n * - Continues typing in background tabs\n * - Performance optimized for large text\n * - maxQueueSize to limit memory usage from excessive queuing\n * - event handling for typing completion and content changes\n *\n * The component includes accessibility features:\n * - Screen readers announce the complete text, not character by character\n * - Uses aria-live=\"polite\" for dynamic content updates\n * - Sets aria-busy during typing animation\n *\n * @dependency mdc-text\n *\n * @tagname mdc-typewriter\n * @slot - Default slot for text content\n *\n * @csspart container - Container for the text element\n * @csspart text - The text element (forwarded to mdc-text)\n *\n * @event typing-complete - (React: onTypingComplete) Fired when the typewriter finishes typing all content.\n * Detail: \\{ finalContent: string \\}\n * @event change - (React: onChange) Fired when the content of the typewriter changes.\n * Detail: \\{ content: string, isTyping: boolean \\}\n */",
|
41581
|
+
"customElement": true
|
41582
|
+
}
|
41583
|
+
],
|
41584
|
+
"exports": [
|
41585
|
+
{
|
41586
|
+
"kind": "js",
|
41587
|
+
"name": "default",
|
41588
|
+
"declaration": {
|
41589
|
+
"name": "Typewriter",
|
41590
|
+
"module": "components/typewriter/typewriter.component.js"
|
41591
|
+
}
|
41592
|
+
}
|
41593
|
+
]
|
41594
|
+
},
|
41039
41595
|
{
|
41040
41596
|
"kind": "javascript-module",
|
41041
41597
|
"path": "components/virtualizedlist/virtualizedlist.component.js",
|