@momentum-design/components 0.101.4 → 0.102.0
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 +406 -381
- package/dist/browser/index.js.map +4 -4
- 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 +1824 -1488
- package/dist/index.d.ts +4 -2
- package/dist/index.js +2 -1
- package/dist/react/index.d.ts +6 -5
- package/dist/react/index.js +6 -5
- 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",
|
@@ -1714,6 +1502,218 @@
|
|
1714
1502
|
}
|
1715
1503
|
]
|
1716
1504
|
},
|
1505
|
+
{
|
1506
|
+
"kind": "javascript-module",
|
1507
|
+
"path": "components/animation/animation.component.js",
|
1508
|
+
"declarations": [
|
1509
|
+
{
|
1510
|
+
"kind": "class",
|
1511
|
+
"description": "The `mdc-animation` component is a wrapper around the Lottie animation library.\nIt fetches the animation data dynamically based on the provided name and renders it.\nThis is a display only component that does not have any interactive functionality.\nFrom accessibility perspective, (by default) it is a decorative image component.",
|
1512
|
+
"name": "Animation",
|
1513
|
+
"members": [
|
1514
|
+
{
|
1515
|
+
"kind": "field",
|
1516
|
+
"name": "name",
|
1517
|
+
"type": {
|
1518
|
+
"text": "AnimationNames | undefined"
|
1519
|
+
},
|
1520
|
+
"description": "Name of the animation (= filename)",
|
1521
|
+
"attribute": "name",
|
1522
|
+
"reflects": true
|
1523
|
+
},
|
1524
|
+
{
|
1525
|
+
"kind": "field",
|
1526
|
+
"name": "loop",
|
1527
|
+
"type": {
|
1528
|
+
"text": "LoopType | undefined"
|
1529
|
+
},
|
1530
|
+
"description": "How many times to loop the animation\n- \"true\" - infinite\n- \"false\" - no loop\n- number - number of times to loop",
|
1531
|
+
"attribute": "loop",
|
1532
|
+
"reflects": true
|
1533
|
+
},
|
1534
|
+
{
|
1535
|
+
"kind": "field",
|
1536
|
+
"name": "autoplay",
|
1537
|
+
"type": {
|
1538
|
+
"text": "boolean | undefined"
|
1539
|
+
},
|
1540
|
+
"description": "Weather start the animation automatically",
|
1541
|
+
"attribute": "autoplay",
|
1542
|
+
"reflects": true
|
1543
|
+
},
|
1544
|
+
{
|
1545
|
+
"kind": "field",
|
1546
|
+
"name": "ariaLabel",
|
1547
|
+
"type": {
|
1548
|
+
"text": "string | null"
|
1549
|
+
},
|
1550
|
+
"default": "null",
|
1551
|
+
"description": "Aria-label attribute to be set for accessibility",
|
1552
|
+
"attribute": "aria-label"
|
1553
|
+
},
|
1554
|
+
{
|
1555
|
+
"kind": "field",
|
1556
|
+
"name": "ariaLabelledBy",
|
1557
|
+
"type": {
|
1558
|
+
"text": "string | null"
|
1559
|
+
},
|
1560
|
+
"default": "null",
|
1561
|
+
"description": "Aria-labelledby attribute to be set for accessibility",
|
1562
|
+
"attribute": "aria-labelledby"
|
1563
|
+
},
|
1564
|
+
{
|
1565
|
+
"kind": "field",
|
1566
|
+
"name": "lottieInstance",
|
1567
|
+
"type": {
|
1568
|
+
"text": "AnimationItem | undefined"
|
1569
|
+
},
|
1570
|
+
"privacy": "private",
|
1571
|
+
"description": "Lottie animation instance"
|
1572
|
+
},
|
1573
|
+
{
|
1574
|
+
"kind": "field",
|
1575
|
+
"name": "containerRef",
|
1576
|
+
"type": {
|
1577
|
+
"text": "Ref<HTMLDivElement>"
|
1578
|
+
},
|
1579
|
+
"privacy": "private",
|
1580
|
+
"description": "Container for the animation"
|
1581
|
+
},
|
1582
|
+
{
|
1583
|
+
"kind": "field",
|
1584
|
+
"name": "animation",
|
1585
|
+
"description": "Exposed API of the animation library (lottie)",
|
1586
|
+
"readonly": true
|
1587
|
+
},
|
1588
|
+
{
|
1589
|
+
"kind": "method",
|
1590
|
+
"name": "getLoopValue",
|
1591
|
+
"privacy": "private"
|
1592
|
+
},
|
1593
|
+
{
|
1594
|
+
"kind": "method",
|
1595
|
+
"name": "onLoadSuccessHandler",
|
1596
|
+
"privacy": "private",
|
1597
|
+
"parameters": [
|
1598
|
+
{
|
1599
|
+
"name": "animationData",
|
1600
|
+
"type": {
|
1601
|
+
"text": "any"
|
1602
|
+
}
|
1603
|
+
}
|
1604
|
+
],
|
1605
|
+
"description": "Create new lotty instance for the loaded data"
|
1606
|
+
},
|
1607
|
+
{
|
1608
|
+
"kind": "method",
|
1609
|
+
"name": "onLoadFailHandler",
|
1610
|
+
"privacy": "private",
|
1611
|
+
"parameters": [
|
1612
|
+
{
|
1613
|
+
"name": "error",
|
1614
|
+
"type": {
|
1615
|
+
"text": "Error"
|
1616
|
+
}
|
1617
|
+
}
|
1618
|
+
],
|
1619
|
+
"description": "Error handler for animation loading"
|
1620
|
+
},
|
1621
|
+
{
|
1622
|
+
"kind": "method",
|
1623
|
+
"name": "getAnimationData",
|
1624
|
+
"privacy": "private",
|
1625
|
+
"description": "Import animation data dynamically"
|
1626
|
+
},
|
1627
|
+
{
|
1628
|
+
"kind": "field",
|
1629
|
+
"name": "onCompleteHandler",
|
1630
|
+
"description": "Re-dispatch the complete event from the animation library\n\nThis handler called with the animation instance instead of the component instance\nso we need to bind it to the component instance. The arrow function just does that."
|
1631
|
+
}
|
1632
|
+
],
|
1633
|
+
"events": [
|
1634
|
+
{
|
1635
|
+
"name": "load",
|
1636
|
+
"type": {
|
1637
|
+
"text": "CustomEvent"
|
1638
|
+
},
|
1639
|
+
"description": "(React: onLoad) This event is dispatched when the animation is loaded",
|
1640
|
+
"reactName": "onLoad"
|
1641
|
+
},
|
1642
|
+
{
|
1643
|
+
"description": "(React: onComplete) This event is dispatched when all animation loops completed",
|
1644
|
+
"name": "complete",
|
1645
|
+
"reactName": "onComplete"
|
1646
|
+
},
|
1647
|
+
{
|
1648
|
+
"description": "(React: onError) This event is dispatched when animation loading failed",
|
1649
|
+
"name": "error",
|
1650
|
+
"reactName": "onError"
|
1651
|
+
}
|
1652
|
+
],
|
1653
|
+
"attributes": [
|
1654
|
+
{
|
1655
|
+
"name": "name",
|
1656
|
+
"type": {
|
1657
|
+
"text": "AnimationNames | undefined"
|
1658
|
+
},
|
1659
|
+
"description": "Name of the animation (= filename)",
|
1660
|
+
"fieldName": "name"
|
1661
|
+
},
|
1662
|
+
{
|
1663
|
+
"name": "loop",
|
1664
|
+
"type": {
|
1665
|
+
"text": "LoopType | undefined"
|
1666
|
+
},
|
1667
|
+
"description": "How many times to loop the animation\n- \"true\" - infinite\n- \"false\" - no loop\n- number - number of times to loop",
|
1668
|
+
"fieldName": "loop"
|
1669
|
+
},
|
1670
|
+
{
|
1671
|
+
"name": "autoplay",
|
1672
|
+
"type": {
|
1673
|
+
"text": "boolean | undefined"
|
1674
|
+
},
|
1675
|
+
"description": "Weather start the animation automatically",
|
1676
|
+
"fieldName": "autoplay"
|
1677
|
+
},
|
1678
|
+
{
|
1679
|
+
"name": "aria-label",
|
1680
|
+
"type": {
|
1681
|
+
"text": "string | null"
|
1682
|
+
},
|
1683
|
+
"default": "null",
|
1684
|
+
"description": "Aria-label attribute to be set for accessibility",
|
1685
|
+
"fieldName": "ariaLabel"
|
1686
|
+
},
|
1687
|
+
{
|
1688
|
+
"name": "aria-labelledby",
|
1689
|
+
"type": {
|
1690
|
+
"text": "string | null"
|
1691
|
+
},
|
1692
|
+
"default": "null",
|
1693
|
+
"description": "Aria-labelledby attribute to be set for accessibility",
|
1694
|
+
"fieldName": "ariaLabelledBy"
|
1695
|
+
}
|
1696
|
+
],
|
1697
|
+
"superclass": {
|
1698
|
+
"name": "Component",
|
1699
|
+
"module": "/src/models"
|
1700
|
+
},
|
1701
|
+
"tagName": "mdc-animation",
|
1702
|
+
"jsDoc": "/**\n * The `mdc-animation` component is a wrapper around the Lottie animation library.\n * It fetches the animation data dynamically based on the provided name and renders it.\n * This is a display only component that does not have any interactive functionality.\n * From accessibility perspective, (by default) it is a decorative image component.\n *\n * @tagname mdc-animation\n *\n * @event load - (React: onLoad) This event is dispatched when the animation is loaded\n * @event complete - (React: onComplete) This event is dispatched when all animation loops completed\n * @event error - (React: onError) This event is dispatched when animation loading failed\n */",
|
1703
|
+
"customElement": true
|
1704
|
+
}
|
1705
|
+
],
|
1706
|
+
"exports": [
|
1707
|
+
{
|
1708
|
+
"kind": "js",
|
1709
|
+
"name": "default",
|
1710
|
+
"declaration": {
|
1711
|
+
"name": "Animation",
|
1712
|
+
"module": "components/animation/animation.component.js"
|
1713
|
+
}
|
1714
|
+
}
|
1715
|
+
]
|
1716
|
+
},
|
1717
1717
|
{
|
1718
1718
|
"kind": "javascript-module",
|
1719
1719
|
"path": "components/appheader/appheader.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,45 +7851,59 @@
|
|
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",
|
7889
|
+
"privacy": "private",
|
7890
|
+
"description": "Manages the required state of the checkbox.\nIf the checkbox is not checked and the required property is set, then the checkbox is invalid."
|
7891
|
+
},
|
7892
|
+
{
|
7893
|
+
"kind": "method",
|
7894
|
+
"name": "toggleState",
|
7968
7895
|
"privacy": "private",
|
7969
7896
|
"return": {
|
7970
7897
|
"type": {
|
7971
7898
|
"text": "void"
|
7972
7899
|
}
|
7973
7900
|
},
|
7974
|
-
"description": "
|
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."
|
7975
7902
|
},
|
7976
7903
|
{
|
7977
7904
|
"kind": "method",
|
7978
|
-
"name": "
|
7905
|
+
"name": "handleKeyDown",
|
7906
|
+
"privacy": "private",
|
7979
7907
|
"return": {
|
7980
7908
|
"type": {
|
7981
7909
|
"text": "void"
|
@@ -7983,17 +7911,19 @@
|
|
7983
7911
|
},
|
7984
7912
|
"parameters": [
|
7985
7913
|
{
|
7986
|
-
"name": "
|
7914
|
+
"name": "event",
|
7987
7915
|
"type": {
|
7988
|
-
"text": "
|
7989
|
-
}
|
7916
|
+
"text": "KeyboardEvent"
|
7917
|
+
},
|
7918
|
+
"description": "The keyboard event."
|
7990
7919
|
}
|
7991
|
-
]
|
7920
|
+
],
|
7921
|
+
"description": "Handles the keydown event on the checkbox.\nWhen the user presses Enter, the form is submitted."
|
7992
7922
|
},
|
7993
7923
|
{
|
7994
7924
|
"kind": "method",
|
7995
|
-
"name": "
|
7996
|
-
"privacy": "
|
7925
|
+
"name": "handleChange",
|
7926
|
+
"privacy": "public",
|
7997
7927
|
"return": {
|
7998
7928
|
"type": {
|
7999
7929
|
"text": "void"
|
@@ -8001,62 +7931,132 @@
|
|
8001
7931
|
},
|
8002
7932
|
"parameters": [
|
8003
7933
|
{
|
8004
|
-
"name": "
|
8005
|
-
"type": {
|
8006
|
-
"text": "CardRadio[]"
|
8007
|
-
}
|
8008
|
-
},
|
8009
|
-
{
|
8010
|
-
"name": "index",
|
7934
|
+
"name": "event",
|
8011
7935
|
"type": {
|
8012
|
-
"text": "
|
7936
|
+
"text": "Event"
|
8013
7937
|
}
|
8014
7938
|
}
|
8015
|
-
]
|
7939
|
+
],
|
7940
|
+
"description": "Toggles the state of the checkbox element.\nand dispatch the new change event."
|
8016
7941
|
},
|
8017
7942
|
{
|
8018
|
-
"kind": "
|
8019
|
-
"name": "
|
8020
|
-
"privacy": "private"
|
8021
|
-
|
8022
|
-
|
8023
|
-
|
8024
|
-
|
8025
|
-
|
8026
|
-
|
8027
|
-
|
8028
|
-
|
8029
|
-
|
8030
|
-
"
|
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
|
+
}
|
8031
8011
|
},
|
8032
8012
|
{
|
8033
8013
|
"kind": "method",
|
8034
|
-
"name": "
|
8035
|
-
"
|
8036
|
-
"
|
8037
|
-
{
|
8038
|
-
"
|
8039
|
-
"type": {
|
8040
|
-
"text": "KeyboardEvent"
|
8041
|
-
},
|
8042
|
-
"description": "The keyboard event"
|
8014
|
+
"name": "setValidity",
|
8015
|
+
"description": "Sets the validity of the input field based on the input field's validity.",
|
8016
|
+
"return": {
|
8017
|
+
"type": {
|
8018
|
+
"text": ""
|
8043
8019
|
}
|
8044
|
-
|
8045
|
-
"
|
8020
|
+
},
|
8021
|
+
"inheritedFrom": {
|
8022
|
+
"name": "FormInternalsMixin",
|
8023
|
+
"module": "utils/mixins/FormInternalsMixin.js"
|
8024
|
+
}
|
8046
8025
|
},
|
8047
8026
|
{
|
8048
8027
|
"kind": "method",
|
8049
|
-
"name": "
|
8050
|
-
"privacy": "protected",
|
8051
|
-
"description": "Renders the header of the card",
|
8028
|
+
"name": "checkValidity",
|
8052
8029
|
"return": {
|
8053
8030
|
"type": {
|
8054
|
-
"text": ""
|
8031
|
+
"text": "boolean"
|
8055
8032
|
}
|
8056
8033
|
},
|
8057
8034
|
"inheritedFrom": {
|
8058
|
-
"name": "
|
8059
|
-
"module": "
|
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"
|
8045
|
+
}
|
8046
|
+
},
|
8047
|
+
{
|
8048
|
+
"kind": "field",
|
8049
|
+
"name": "dataAriaLabel",
|
8050
|
+
"type": {
|
8051
|
+
"text": "string | null"
|
8052
|
+
},
|
8053
|
+
"default": "null",
|
8054
|
+
"description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
|
8055
|
+
"attribute": "data-aria-label",
|
8056
|
+
"reflects": true,
|
8057
|
+
"inheritedFrom": {
|
8058
|
+
"name": "DataAriaLabelMixin",
|
8059
|
+
"module": "utils/mixins/DataAriaLabelMixin.js"
|
8060
8060
|
}
|
8061
8061
|
},
|
8062
8062
|
{
|
@@ -8076,237 +8076,207 @@
|
|
8076
8076
|
},
|
8077
8077
|
{
|
8078
8078
|
"kind": "field",
|
8079
|
-
"name": "
|
8080
|
-
"type": {
|
8081
|
-
"text": "number"
|
8082
|
-
},
|
8083
|
-
"default": "0",
|
8084
|
-
"description": "This property specifies the tab order of the element.",
|
8085
|
-
"attribute": "tabIndex",
|
8086
|
-
"reflects": true,
|
8087
|
-
"inheritedFrom": {
|
8088
|
-
"name": "TabIndexMixin",
|
8089
|
-
"module": "utils/mixins/TabIndexMixin.js"
|
8090
|
-
}
|
8091
|
-
},
|
8092
|
-
{
|
8093
|
-
"kind": "field",
|
8094
|
-
"name": "cardTitle",
|
8079
|
+
"name": "label",
|
8095
8080
|
"type": {
|
8096
|
-
"text": "string"
|
8081
|
+
"text": "string | undefined"
|
8097
8082
|
},
|
8098
|
-
"
|
8099
|
-
"
|
8100
|
-
"attribute": "card-title",
|
8083
|
+
"description": "The label of the input field. It is linked to the input field using the `for` attribute.",
|
8084
|
+
"attribute": "label",
|
8101
8085
|
"reflects": true,
|
8102
8086
|
"inheritedFrom": {
|
8103
|
-
"name": "
|
8104
|
-
"module": "components/
|
8087
|
+
"name": "FormfieldWrapper",
|
8088
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
8105
8089
|
}
|
8106
8090
|
},
|
8107
8091
|
{
|
8108
8092
|
"kind": "field",
|
8109
|
-
"name": "
|
8093
|
+
"name": "required",
|
8110
8094
|
"type": {
|
8111
|
-
"text": "
|
8095
|
+
"text": "boolean"
|
8112
8096
|
},
|
8113
|
-
"default": "
|
8114
|
-
"description": "The
|
8115
|
-
"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",
|
8116
8100
|
"reflects": true,
|
8117
8101
|
"inheritedFrom": {
|
8118
|
-
"name": "
|
8119
|
-
"module": "components/
|
8102
|
+
"name": "FormfieldWrapper",
|
8103
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
8120
8104
|
}
|
8121
8105
|
},
|
8122
8106
|
{
|
8123
8107
|
"kind": "field",
|
8124
|
-
"name": "
|
8108
|
+
"name": "id",
|
8125
8109
|
"type": {
|
8126
8110
|
"text": "string"
|
8127
8111
|
},
|
8128
8112
|
"default": "''",
|
8129
|
-
"description": "The
|
8130
|
-
"attribute": "
|
8131
|
-
"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",
|
8132
8115
|
"inheritedFrom": {
|
8133
|
-
"name": "
|
8134
|
-
"module": "components/
|
8116
|
+
"name": "FormfieldWrapper",
|
8117
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
8135
8118
|
}
|
8136
8119
|
},
|
8137
8120
|
{
|
8138
8121
|
"kind": "field",
|
8139
|
-
"name": "
|
8122
|
+
"name": "helpTextType",
|
8140
8123
|
"type": {
|
8141
|
-
"text": "
|
8124
|
+
"text": "ValidationType"
|
8142
8125
|
},
|
8143
|
-
"
|
8144
|
-
"
|
8145
|
-
"attribute": "image-alt",
|
8126
|
+
"description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
|
8127
|
+
"attribute": "help-text-type",
|
8146
8128
|
"reflects": true,
|
8147
8129
|
"inheritedFrom": {
|
8148
|
-
"name": "
|
8149
|
-
"module": "components/
|
8130
|
+
"name": "FormfieldWrapper",
|
8131
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
8150
8132
|
}
|
8151
8133
|
},
|
8152
8134
|
{
|
8153
8135
|
"kind": "field",
|
8154
|
-
"name": "
|
8136
|
+
"name": "helpText",
|
8155
8137
|
"type": {
|
8156
|
-
"text": "
|
8138
|
+
"text": "string | undefined"
|
8157
8139
|
},
|
8158
|
-
"description": "The
|
8159
|
-
"
|
8160
|
-
"attribute": "variant",
|
8140
|
+
"description": "The help text that is displayed below the input field.",
|
8141
|
+
"attribute": "help-text",
|
8161
8142
|
"reflects": true,
|
8162
8143
|
"inheritedFrom": {
|
8163
|
-
"name": "
|
8164
|
-
"module": "components/
|
8144
|
+
"name": "FormfieldWrapper",
|
8145
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
8165
8146
|
}
|
8166
8147
|
},
|
8167
8148
|
{
|
8168
8149
|
"kind": "field",
|
8169
|
-
"name": "
|
8150
|
+
"name": "toggletipText",
|
8170
8151
|
"type": {
|
8171
|
-
"text": "
|
8152
|
+
"text": "string | undefined"
|
8172
8153
|
},
|
8173
|
-
"description": "The
|
8174
|
-
"
|
8175
|
-
"attribute": "orientation",
|
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",
|
8176
8156
|
"reflects": true,
|
8177
8157
|
"inheritedFrom": {
|
8178
|
-
"name": "
|
8179
|
-
"module": "components/
|
8158
|
+
"name": "FormfieldWrapper",
|
8159
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
8180
8160
|
}
|
8181
8161
|
},
|
8182
8162
|
{
|
8183
8163
|
"kind": "field",
|
8184
|
-
"name": "
|
8164
|
+
"name": "toggletipPlacement",
|
8185
8165
|
"type": {
|
8186
|
-
"text": "
|
8166
|
+
"text": "PopoverPlacement"
|
8187
8167
|
},
|
8188
|
-
"description": "The
|
8189
|
-
"default": "'
|
8190
|
-
"attribute": "
|
8168
|
+
"description": "The placement of the toggletip that is displayed when the info icon is hovered.",
|
8169
|
+
"default": "'top'",
|
8170
|
+
"attribute": "toggletip-placement",
|
8191
8171
|
"reflects": true,
|
8192
8172
|
"inheritedFrom": {
|
8193
|
-
"name": "
|
8194
|
-
"module": "components/
|
8173
|
+
"name": "FormfieldWrapper",
|
8174
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
8195
8175
|
}
|
8196
8176
|
},
|
8197
8177
|
{
|
8198
8178
|
"kind": "field",
|
8199
|
-
"name": "
|
8179
|
+
"name": "infoIconAriaLabel",
|
8200
8180
|
"type": {
|
8201
|
-
"text": "
|
8181
|
+
"text": "string | undefined"
|
8202
8182
|
},
|
8203
|
-
"description": "
|
8204
|
-
"
|
8205
|
-
"attribute": "subtitle-tag-name",
|
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",
|
8206
8185
|
"reflects": true,
|
8207
8186
|
"inheritedFrom": {
|
8208
|
-
"name": "
|
8209
|
-
"module": "components/
|
8187
|
+
"name": "FormfieldWrapper",
|
8188
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
8210
8189
|
}
|
8211
8190
|
},
|
8212
8191
|
{
|
8213
|
-
"kind": "
|
8214
|
-
"name": "
|
8215
|
-
"
|
8216
|
-
|
8192
|
+
"kind": "method",
|
8193
|
+
"name": "renderLabelElement",
|
8194
|
+
"privacy": "protected",
|
8195
|
+
"description": "creates the label element when the label property is set.\nid is used to link the label with the input field.",
|
8196
|
+
"return": {
|
8197
|
+
"type": {
|
8198
|
+
"text": ""
|
8199
|
+
}
|
8217
8200
|
},
|
8218
|
-
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
8219
|
-
"attribute": "icon-name",
|
8220
|
-
"reflects": true,
|
8221
8201
|
"inheritedFrom": {
|
8222
|
-
"name": "
|
8223
|
-
"module": "components/
|
8202
|
+
"name": "FormfieldWrapper",
|
8203
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
8224
8204
|
}
|
8225
8205
|
},
|
8226
8206
|
{
|
8227
8207
|
"kind": "method",
|
8228
|
-
"name": "
|
8208
|
+
"name": "renderHelpTextIcon",
|
8229
8209
|
"privacy": "protected",
|
8230
|
-
"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.",
|
8231
8211
|
"return": {
|
8232
8212
|
"type": {
|
8233
8213
|
"text": ""
|
8234
8214
|
}
|
8235
8215
|
},
|
8236
8216
|
"inheritedFrom": {
|
8237
|
-
"name": "
|
8238
|
-
"module": "components/
|
8217
|
+
"name": "FormfieldWrapper",
|
8218
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
8239
8219
|
}
|
8240
8220
|
},
|
8241
8221
|
{
|
8242
8222
|
"kind": "method",
|
8243
|
-
"name": "
|
8223
|
+
"name": "renderHelpText",
|
8244
8224
|
"privacy": "protected",
|
8245
|
-
"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.",
|
8246
8226
|
"return": {
|
8247
8227
|
"type": {
|
8248
8228
|
"text": ""
|
8249
8229
|
}
|
8250
8230
|
},
|
8251
8231
|
"inheritedFrom": {
|
8252
|
-
"name": "
|
8253
|
-
"module": "components/
|
8232
|
+
"name": "FormfieldWrapper",
|
8233
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
8254
8234
|
}
|
8255
8235
|
},
|
8256
8236
|
{
|
8257
8237
|
"kind": "method",
|
8258
|
-
"name": "
|
8238
|
+
"name": "renderLabel",
|
8259
8239
|
"privacy": "protected",
|
8260
|
-
"description": "
|
8240
|
+
"description": "renders the mdc-label-text container that contains the label and labelInfoToggleTip.",
|
8261
8241
|
"return": {
|
8262
8242
|
"type": {
|
8263
8243
|
"text": ""
|
8264
8244
|
}
|
8265
8245
|
},
|
8266
8246
|
"inheritedFrom": {
|
8267
|
-
"name": "
|
8268
|
-
"module": "components/
|
8247
|
+
"name": "FormfieldWrapper",
|
8248
|
+
"module": "components/formfieldwrapper/formfieldwrapper.component.js"
|
8269
8249
|
}
|
8270
8250
|
},
|
8271
8251
|
{
|
8272
8252
|
"kind": "method",
|
8273
|
-
"name": "
|
8253
|
+
"name": "renderHelperText",
|
8274
8254
|
"privacy": "protected",
|
8275
|
-
"description": "
|
8255
|
+
"description": "renders the mdc-help-text container that contains the helpertext icon and helpertext.",
|
8276
8256
|
"return": {
|
8277
8257
|
"type": {
|
8278
8258
|
"text": ""
|
8279
8259
|
}
|
8280
8260
|
},
|
8281
8261
|
"inheritedFrom": {
|
8282
|
-
"name": "
|
8283
|
-
"module": "components/
|
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
|
]
|
@@ -17803,15 +17803,15 @@
|
|
17803
17803
|
},
|
17804
17804
|
{
|
17805
17805
|
"kind": "javascript-module",
|
17806
|
-
"path": "components/
|
17806
|
+
"path": "components/menuitemcheckbox/menuitemcheckbox.component.js",
|
17807
17807
|
"declarations": [
|
17808
17808
|
{
|
17809
17809
|
"kind": "class",
|
17810
|
-
"description": "
|
17811
|
-
"name": "
|
17810
|
+
"description": "A menuitemcheckbox component is a checkable menuitem.\nThere should be no focusable descendants inside this menuitemcheckbox component.\n\nThe `checked` attribute indicates whether the menuitemcheckbox is checked or not.\n\nMenu item checkbox has `name` and `value` attribute that can be used to identify the menu item when it is selected.\n\nThe `indicator` attribute is used to differentiate between <b>checkbox</b>, <b>checkmark</b>, <b>toggle</b> and <b>none</b>.\nBy default, the `indicator` is set to <b>checkbox</b>.<br/>\n\nThe checkbox will always be positioned on the leading side of the menuitem label and\nthe toggle and checkmark will always be positioned on the trailing side.\n\nThe checkbox will have the possible states of `true` or `false`.\nIf the indicator is set to <b>checkmark</b> and if the `checked` attribute is set to `true`,\nthen the checkmark will be displayed. if not, then no indicator will be displayed.\n\nThe forth options for the `indicator` is <b>none</b>, which will not display any indicator at all.\nIt is intended to be used for customised menu items where the indicator is implemented differently.\nFor example, you can use a custom icon or a different visual element to indicate the state of the menu item.\nMake sure the new indicator is accessible.\n\nIf you want only one item in a group to be checked, consider using menuitemradio component.",
|
17811
|
+
"name": "MenuItemCheckbox",
|
17812
17812
|
"slots": [
|
17813
17813
|
{
|
17814
|
-
"description": "slot for menu item controls to appear of leading end.",
|
17814
|
+
"description": "slot for menu item checkbox controls to appear of leading end.",
|
17815
17815
|
"name": "leading-controls",
|
17816
17816
|
"inheritedFrom": {
|
17817
17817
|
"name": "ListItem",
|
@@ -17819,7 +17819,7 @@
|
|
17819
17819
|
}
|
17820
17820
|
},
|
17821
17821
|
{
|
17822
|
-
"description": "slot for menu item primary label.",
|
17822
|
+
"description": "slot for menu item checkbox primary label.",
|
17823
17823
|
"name": "leading-text-primary-label",
|
17824
17824
|
"inheritedFrom": {
|
17825
17825
|
"name": "ListItem",
|
@@ -17827,7 +17827,7 @@
|
|
17827
17827
|
}
|
17828
17828
|
},
|
17829
17829
|
{
|
17830
|
-
"description": "slot for menu item secondary label.",
|
17830
|
+
"description": "slot for menu item checkbox secondary label.",
|
17831
17831
|
"name": "leading-text-secondary-label",
|
17832
17832
|
"inheritedFrom": {
|
17833
17833
|
"name": "ListItem",
|
@@ -17835,7 +17835,7 @@
|
|
17835
17835
|
}
|
17836
17836
|
},
|
17837
17837
|
{
|
17838
|
-
"description": "slot for menu item tertiary label.",
|
17838
|
+
"description": "slot for menu item checkbox tertiary label.",
|
17839
17839
|
"name": "leading-text-tertiary-label",
|
17840
17840
|
"inheritedFrom": {
|
17841
17841
|
"name": "ListItem",
|
@@ -17843,7 +17843,7 @@
|
|
17843
17843
|
}
|
17844
17844
|
},
|
17845
17845
|
{
|
17846
|
-
"description": "slot for menu item side header text.",
|
17846
|
+
"description": "slot for menu item checkbox side header text.",
|
17847
17847
|
"name": "trailing-text-side-header",
|
17848
17848
|
"inheritedFrom": {
|
17849
17849
|
"name": "ListItem",
|
@@ -17851,7 +17851,7 @@
|
|
17851
17851
|
}
|
17852
17852
|
},
|
17853
17853
|
{
|
17854
|
-
"description": "slot for menu item subline text.",
|
17854
|
+
"description": "slot for menu item checkbox subline text.",
|
17855
17855
|
"name": "trailing-text-subline",
|
17856
17856
|
"inheritedFrom": {
|
17857
17857
|
"name": "ListItem",
|
@@ -17859,7 +17859,7 @@
|
|
17859
17859
|
}
|
17860
17860
|
},
|
17861
17861
|
{
|
17862
|
-
"description": "slot for menu item controls to appear of trailing end.",
|
17862
|
+
"description": "slot for menu item checkbox controls to appear of trailing end.",
|
17863
17863
|
"name": "trailing-controls",
|
17864
17864
|
"inheritedFrom": {
|
17865
17865
|
"name": "ListItem",
|
@@ -17868,6 +17868,67 @@
|
|
17868
17868
|
}
|
17869
17869
|
],
|
17870
17870
|
"members": [
|
17871
|
+
{
|
17872
|
+
"kind": "field",
|
17873
|
+
"name": "checked",
|
17874
|
+
"type": {
|
17875
|
+
"text": "boolean"
|
17876
|
+
},
|
17877
|
+
"default": "false",
|
17878
|
+
"description": "The checked attribute is used to indicate that the menuitemcheckbox is checked or not.",
|
17879
|
+
"attribute": "checked",
|
17880
|
+
"reflects": true
|
17881
|
+
},
|
17882
|
+
{
|
17883
|
+
"kind": "field",
|
17884
|
+
"name": "indicator",
|
17885
|
+
"type": {
|
17886
|
+
"text": "Indicator"
|
17887
|
+
},
|
17888
|
+
"description": "The indicator attribute is used to differentiate between <b>checkbox</b> and <b>toggle</b>.",
|
17889
|
+
"default": "'checkbox'",
|
17890
|
+
"attribute": "indicator",
|
17891
|
+
"reflects": true
|
17892
|
+
},
|
17893
|
+
{
|
17894
|
+
"kind": "method",
|
17895
|
+
"name": "handleMouseClick",
|
17896
|
+
"privacy": "private",
|
17897
|
+
"description": "Handles click events to toggle checked state\nIf the menuitemcheckbox is disabled, it does nothing.\nIf the menuitemcheckbox is not disabled, it toggles the `checked` state between `true` and `false`."
|
17898
|
+
},
|
17899
|
+
{
|
17900
|
+
"kind": "method",
|
17901
|
+
"name": "staticCheckbox",
|
17902
|
+
"privacy": "private",
|
17903
|
+
"return": {
|
17904
|
+
"type": {
|
17905
|
+
"text": ""
|
17906
|
+
}
|
17907
|
+
},
|
17908
|
+
"description": "Returns a static checkbox element if the indicator is set to checkbox.\nIf the indicator is not set to checkbox, it returns nothing."
|
17909
|
+
},
|
17910
|
+
{
|
17911
|
+
"kind": "method",
|
17912
|
+
"name": "staticToggle",
|
17913
|
+
"privacy": "private",
|
17914
|
+
"return": {
|
17915
|
+
"type": {
|
17916
|
+
"text": ""
|
17917
|
+
}
|
17918
|
+
},
|
17919
|
+
"description": "Returns a static toggle element if the indicator is set to toggle.\nIf the indicator is not set to toggle, it returns nothing.\n\nThe toggle will always be positioned on the trailing side of the menuitem label."
|
17920
|
+
},
|
17921
|
+
{
|
17922
|
+
"kind": "method",
|
17923
|
+
"name": "getCheckmarkIcon",
|
17924
|
+
"privacy": "private",
|
17925
|
+
"return": {
|
17926
|
+
"type": {
|
17927
|
+
"text": ""
|
17928
|
+
}
|
17929
|
+
},
|
17930
|
+
"description": "Returns a checkmark icon if the indicator is set to checkmark and the checked state is true.\nIf the indicator is not set to checkmark or the checked state is false, it returns nothing.\n\nThe checkmark icon will always be positioned on the trailing side of the menuitem label."
|
17931
|
+
},
|
17871
17932
|
{
|
17872
17933
|
"kind": "field",
|
17873
17934
|
"name": "arrowPosition",
|
@@ -17876,7 +17937,11 @@
|
|
17876
17937
|
},
|
17877
17938
|
"description": "Defines where the arrow icon will appear.\n- `'leading'`: Icon appears on the leading edge (start).\n- `'trailing'`: Icon appears on the trailing edge (end).\n\nIf not set, no arrow is displayed.",
|
17878
17939
|
"attribute": "arrow-position",
|
17879
|
-
"reflects": true
|
17940
|
+
"reflects": true,
|
17941
|
+
"inheritedFrom": {
|
17942
|
+
"name": "MenuItem",
|
17943
|
+
"module": "components/menuitem/menuitem.component.js"
|
17944
|
+
}
|
17880
17945
|
},
|
17881
17946
|
{
|
17882
17947
|
"kind": "field",
|
@@ -17886,7 +17951,11 @@
|
|
17886
17951
|
},
|
17887
17952
|
"description": "Defines the direction the arrow icon points.\n- `'positive'`: Arrow points toward the trailing side.\n- `'negative'`: Arrow points toward the leading side.",
|
17888
17953
|
"attribute": "arrow-direction",
|
17889
|
-
"reflects": true
|
17954
|
+
"reflects": true,
|
17955
|
+
"inheritedFrom": {
|
17956
|
+
"name": "MenuItem",
|
17957
|
+
"module": "components/menuitem/menuitem.component.js"
|
17958
|
+
}
|
17890
17959
|
},
|
17891
17960
|
{
|
17892
17961
|
"kind": "field",
|
@@ -17897,7 +17966,11 @@
|
|
17897
17966
|
"default": "undefined",
|
17898
17967
|
"description": "The name attribute is used to identify the menu item when it is selected.",
|
17899
17968
|
"attribute": "name",
|
17900
|
-
"reflects": true
|
17969
|
+
"reflects": true,
|
17970
|
+
"inheritedFrom": {
|
17971
|
+
"name": "MenuItem",
|
17972
|
+
"module": "components/menuitem/menuitem.component.js"
|
17973
|
+
}
|
17901
17974
|
},
|
17902
17975
|
{
|
17903
17976
|
"kind": "field",
|
@@ -17908,7 +17981,11 @@
|
|
17908
17981
|
"default": "undefined",
|
17909
17982
|
"description": "The value attribute is used to represent a value when the menu item is selected.\nIt is typically used with checkbox and radio menu items, but can be handy for any menu item.",
|
17910
17983
|
"attribute": "value",
|
17911
|
-
"reflects": true
|
17984
|
+
"reflects": true,
|
17985
|
+
"inheritedFrom": {
|
17986
|
+
"name": "MenuItem",
|
17987
|
+
"module": "components/menuitem/menuitem.component.js"
|
17988
|
+
}
|
17912
17989
|
},
|
17913
17990
|
{
|
17914
17991
|
"kind": "method",
|
@@ -17952,7 +18029,11 @@
|
|
17952
18029
|
"description": "The keyboard event that triggered the action."
|
17953
18030
|
}
|
17954
18031
|
],
|
17955
|
-
"description": "Handles the keyup event for the menu item.\nIf the Space key is released, it triggers a click event on the menu item.\nThis allows keyboard users to activate the menu item using the Space key.\nIt also prevents the default action of the Space key to avoid scrolling the page.\n\nThis follows the native behaviour, actionable element can be triggered by Space\nkey on the keyup event.\n\nNote: Action triggered by Enter on the keydown event."
|
18032
|
+
"description": "Handles the keyup event for the menu item.\nIf the Space key is released, it triggers a click event on the menu item.\nThis allows keyboard users to activate the menu item using the Space key.\nIt also prevents the default action of the Space key to avoid scrolling the page.\n\nThis follows the native behaviour, actionable element can be triggered by Space\nkey on the keyup event.\n\nNote: Action triggered by Enter on the keydown event.",
|
18033
|
+
"inheritedFrom": {
|
18034
|
+
"name": "MenuItem",
|
18035
|
+
"module": "components/menuitem/menuitem.component.js"
|
18036
|
+
}
|
17956
18037
|
},
|
17957
18038
|
{
|
17958
18039
|
"kind": "method",
|
@@ -18289,7 +18370,15 @@
|
|
18289
18370
|
],
|
18290
18371
|
"events": [
|
18291
18372
|
{
|
18292
|
-
"
|
18373
|
+
"name": "change",
|
18374
|
+
"type": {
|
18375
|
+
"text": "Event"
|
18376
|
+
},
|
18377
|
+
"description": "(React: onChange) This event is dispatched when the menuitemcheckbox changes.",
|
18378
|
+
"reactName": "onChange"
|
18379
|
+
},
|
18380
|
+
{
|
18381
|
+
"description": "(React: onClick) This event is dispatched when the menuitemcheckbox is clicked.",
|
18293
18382
|
"name": "click",
|
18294
18383
|
"reactName": "onClick",
|
18295
18384
|
"inheritedFrom": {
|
@@ -18298,27 +18387,27 @@
|
|
18298
18387
|
}
|
18299
18388
|
},
|
18300
18389
|
{
|
18301
|
-
"description": "(React:
|
18302
|
-
"name": "
|
18303
|
-
"reactName": "
|
18390
|
+
"description": "(React: onFocus) This event is dispatched when the menuitemcheckbox receives focus.",
|
18391
|
+
"name": "focus",
|
18392
|
+
"reactName": "onFocus",
|
18304
18393
|
"inheritedFrom": {
|
18305
18394
|
"name": "ListItem",
|
18306
18395
|
"module": "src/components/listitem/listitem.component.ts"
|
18307
18396
|
}
|
18308
18397
|
},
|
18309
18398
|
{
|
18310
|
-
"description": "(React:
|
18311
|
-
"name": "
|
18312
|
-
"reactName": "
|
18399
|
+
"description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the menuitem.",
|
18400
|
+
"name": "keydown",
|
18401
|
+
"reactName": "onKeyDown",
|
18313
18402
|
"inheritedFrom": {
|
18314
18403
|
"name": "ListItem",
|
18315
18404
|
"module": "src/components/listitem/listitem.component.ts"
|
18316
18405
|
}
|
18317
18406
|
},
|
18318
18407
|
{
|
18319
|
-
"description": "(React:
|
18320
|
-
"name": "
|
18321
|
-
"reactName": "
|
18408
|
+
"description": "(React: onKeyUp) This event is dispatched when a key is released on the menuitem.",
|
18409
|
+
"name": "keyup",
|
18410
|
+
"reactName": "onKeyUp",
|
18322
18411
|
"inheritedFrom": {
|
18323
18412
|
"name": "ListItem",
|
18324
18413
|
"module": "src/components/listitem/listitem.component.ts"
|
@@ -18362,13 +18451,35 @@
|
|
18362
18451
|
}
|
18363
18452
|
],
|
18364
18453
|
"attributes": [
|
18454
|
+
{
|
18455
|
+
"name": "checked",
|
18456
|
+
"type": {
|
18457
|
+
"text": "boolean"
|
18458
|
+
},
|
18459
|
+
"default": "false",
|
18460
|
+
"description": "The checked attribute is used to indicate that the menuitemcheckbox is checked or not.",
|
18461
|
+
"fieldName": "checked"
|
18462
|
+
},
|
18463
|
+
{
|
18464
|
+
"name": "indicator",
|
18465
|
+
"type": {
|
18466
|
+
"text": "Indicator"
|
18467
|
+
},
|
18468
|
+
"description": "The indicator attribute is used to differentiate between <b>checkbox</b> and <b>toggle</b>.",
|
18469
|
+
"default": "'checkbox'",
|
18470
|
+
"fieldName": "indicator"
|
18471
|
+
},
|
18365
18472
|
{
|
18366
18473
|
"name": "arrow-position",
|
18367
18474
|
"type": {
|
18368
18475
|
"text": "ArrowPositions | undefined"
|
18369
18476
|
},
|
18370
18477
|
"description": "Defines where the arrow icon will appear.\n- `'leading'`: Icon appears on the leading edge (start).\n- `'trailing'`: Icon appears on the trailing edge (end).\n\nIf not set, no arrow is displayed.",
|
18371
|
-
"fieldName": "arrowPosition"
|
18478
|
+
"fieldName": "arrowPosition",
|
18479
|
+
"inheritedFrom": {
|
18480
|
+
"name": "MenuItem",
|
18481
|
+
"module": "src/components/menuitem/menuitem.component.ts"
|
18482
|
+
}
|
18372
18483
|
},
|
18373
18484
|
{
|
18374
18485
|
"name": "arrow-direction",
|
@@ -18376,7 +18487,11 @@
|
|
18376
18487
|
"text": "ArrowDirections | undefined"
|
18377
18488
|
},
|
18378
18489
|
"description": "Defines the direction the arrow icon points.\n- `'positive'`: Arrow points toward the trailing side.\n- `'negative'`: Arrow points toward the leading side.",
|
18379
|
-
"fieldName": "arrowDirection"
|
18490
|
+
"fieldName": "arrowDirection",
|
18491
|
+
"inheritedFrom": {
|
18492
|
+
"name": "MenuItem",
|
18493
|
+
"module": "src/components/menuitem/menuitem.component.ts"
|
18494
|
+
}
|
18380
18495
|
},
|
18381
18496
|
{
|
18382
18497
|
"name": "name",
|
@@ -18385,7 +18500,11 @@
|
|
18385
18500
|
},
|
18386
18501
|
"default": "undefined",
|
18387
18502
|
"description": "The name attribute is used to identify the menu item when it is selected.",
|
18388
|
-
"fieldName": "name"
|
18503
|
+
"fieldName": "name",
|
18504
|
+
"inheritedFrom": {
|
18505
|
+
"name": "MenuItem",
|
18506
|
+
"module": "src/components/menuitem/menuitem.component.ts"
|
18507
|
+
}
|
18389
18508
|
},
|
18390
18509
|
{
|
18391
18510
|
"name": "value",
|
@@ -18394,7 +18513,11 @@
|
|
18394
18513
|
},
|
18395
18514
|
"default": "undefined",
|
18396
18515
|
"description": "The value attribute is used to represent a value when the menu item is selected.\nIt is typically used with checkbox and radio menu items, but can be handy for any menu item.",
|
18397
|
-
"fieldName": "value"
|
18516
|
+
"fieldName": "value",
|
18517
|
+
"inheritedFrom": {
|
18518
|
+
"name": "MenuItem",
|
18519
|
+
"module": "src/components/menuitem/menuitem.component.ts"
|
18520
|
+
}
|
18398
18521
|
},
|
18399
18522
|
{
|
18400
18523
|
"name": "disabled",
|
@@ -18535,11 +18658,11 @@
|
|
18535
18658
|
}
|
18536
18659
|
],
|
18537
18660
|
"superclass": {
|
18538
|
-
"name": "
|
18539
|
-
"module": "/src/components/
|
18661
|
+
"name": "MenuItem",
|
18662
|
+
"module": "/src/components/menuitem/menuitem.component"
|
18540
18663
|
},
|
18541
|
-
"tagName": "mdc-
|
18542
|
-
"jsDoc": "/**\n *
|
18664
|
+
"tagName": "mdc-menuitemcheckbox",
|
18665
|
+
"jsDoc": "/**\n * A menuitemcheckbox component is a checkable menuitem.\n * There should be no focusable descendants inside this menuitemcheckbox component.\n *\n * The `checked` attribute indicates whether the menuitemcheckbox is checked or not.\n *\n * Menu item checkbox has `name` and `value` attribute that can be used to identify the menu item when it is selected.\n *\n * The `indicator` attribute is used to differentiate between <b>checkbox</b>, <b>checkmark</b>, <b>toggle</b> and <b>none</b>.\n * By default, the `indicator` is set to <b>checkbox</b>.<br/>\n *\n * The checkbox will always be positioned on the leading side of the menuitem label and\n * the toggle and checkmark will always be positioned on the trailing side.\n *\n * The checkbox will have the possible states of `true` or `false`.\n * If the indicator is set to <b>checkmark</b> and if the `checked` attribute is set to `true`,\n * then the checkmark will be displayed. if not, then no indicator will be displayed.\n *\n * The forth options for the `indicator` is <b>none</b>, which will not display any indicator at all.\n * It is intended to be used for customised menu items where the indicator is implemented differently.\n * For example, you can use a custom icon or a different visual element to indicate the state of the menu item.\n * Make sure the new indicator is accessible.\n *\n * If you want only one item in a group to be checked, consider using menuitemradio component.\n *\n * @dependency mdc-staticcheckbox\n * @dependency mdc-statictoggle\n * @dependency mdc-icon\n *\n * @tagname mdc-menuitemcheckbox\n *\n * @slot leading-controls - slot for menu item checkbox controls to appear of leading end.\n * @slot leading-text-primary-label - slot for menu item checkbox primary label.\n * @slot leading-text-secondary-label - slot for menu item checkbox secondary label.\n * @slot leading-text-tertiary-label - slot for menu item checkbox tertiary label.\n * @slot trailing-text-side-header - slot for menu item checkbox side header text.\n * @slot trailing-text-subline - slot for menu item checkbox subline text.\n * @slot trailing-controls - slot for menu item checkbox controls to appear of trailing end.\n *\n * @event change - (React: onChange) This event is dispatched when the menuitemcheckbox changes.\n * @event click - (React: onClick) This event is dispatched when the menuitemcheckbox is clicked.\n * @event focus - (React: onFocus) This event is dispatched when the menuitemcheckbox receives focus.\n */",
|
18543
18666
|
"customElement": true,
|
18544
18667
|
"cssProperties": [
|
18545
18668
|
{
|
@@ -18614,23 +18737,23 @@
|
|
18614
18737
|
"kind": "js",
|
18615
18738
|
"name": "default",
|
18616
18739
|
"declaration": {
|
18617
|
-
"name": "
|
18618
|
-
"module": "components/
|
18740
|
+
"name": "MenuItemCheckbox",
|
18741
|
+
"module": "components/menuitemcheckbox/menuitemcheckbox.component.js"
|
18619
18742
|
}
|
18620
18743
|
}
|
18621
18744
|
]
|
18622
18745
|
},
|
18623
18746
|
{
|
18624
18747
|
"kind": "javascript-module",
|
18625
|
-
"path": "components/
|
18748
|
+
"path": "components/menuitem/menuitem.component.js",
|
18626
18749
|
"declarations": [
|
18627
18750
|
{
|
18628
18751
|
"kind": "class",
|
18629
|
-
"description": "
|
18630
|
-
"name": "
|
18752
|
+
"description": "menuitem component is inherited by listitem component with the role set `menuitem`.<br/>\nA menu item can contain an icon on the leading or trailing side.\n\nThe leading and trailing slots can be used to display controls and text.<br/>\nBased on the leading/trailing slot, the position of the controls and text can be adjusted.\n\nPlease use element with role=menu as a parent element even when there is only menuitem for a11y purpose.\nFor example mdc-menupopover or mdc-menubar.\n\nMenu item has `name` and `value` attribute that can be used to identify the menu item when it is selected.",
|
18753
|
+
"name": "MenuItem",
|
18631
18754
|
"slots": [
|
18632
18755
|
{
|
18633
|
-
"description": "slot for menu item
|
18756
|
+
"description": "slot for menu item controls to appear of leading end.",
|
18634
18757
|
"name": "leading-controls",
|
18635
18758
|
"inheritedFrom": {
|
18636
18759
|
"name": "ListItem",
|
@@ -18638,7 +18761,7 @@
|
|
18638
18761
|
}
|
18639
18762
|
},
|
18640
18763
|
{
|
18641
|
-
"description": "slot for menu item
|
18764
|
+
"description": "slot for menu item primary label.",
|
18642
18765
|
"name": "leading-text-primary-label",
|
18643
18766
|
"inheritedFrom": {
|
18644
18767
|
"name": "ListItem",
|
@@ -18646,7 +18769,7 @@
|
|
18646
18769
|
}
|
18647
18770
|
},
|
18648
18771
|
{
|
18649
|
-
"description": "slot for menu item
|
18772
|
+
"description": "slot for menu item secondary label.",
|
18650
18773
|
"name": "leading-text-secondary-label",
|
18651
18774
|
"inheritedFrom": {
|
18652
18775
|
"name": "ListItem",
|
@@ -18654,7 +18777,7 @@
|
|
18654
18777
|
}
|
18655
18778
|
},
|
18656
18779
|
{
|
18657
|
-
"description": "slot for menu item
|
18780
|
+
"description": "slot for menu item tertiary label.",
|
18658
18781
|
"name": "leading-text-tertiary-label",
|
18659
18782
|
"inheritedFrom": {
|
18660
18783
|
"name": "ListItem",
|
@@ -18662,7 +18785,7 @@
|
|
18662
18785
|
}
|
18663
18786
|
},
|
18664
18787
|
{
|
18665
|
-
"description": "slot for menu item
|
18788
|
+
"description": "slot for menu item side header text.",
|
18666
18789
|
"name": "trailing-text-side-header",
|
18667
18790
|
"inheritedFrom": {
|
18668
18791
|
"name": "ListItem",
|
@@ -18670,7 +18793,7 @@
|
|
18670
18793
|
}
|
18671
18794
|
},
|
18672
18795
|
{
|
18673
|
-
"description": "slot for menu item
|
18796
|
+
"description": "slot for menu item subline text.",
|
18674
18797
|
"name": "trailing-text-subline",
|
18675
18798
|
"inheritedFrom": {
|
18676
18799
|
"name": "ListItem",
|
@@ -18678,7 +18801,7 @@
|
|
18678
18801
|
}
|
18679
18802
|
},
|
18680
18803
|
{
|
18681
|
-
"description": "slot for menu item
|
18804
|
+
"description": "slot for menu item controls to appear of trailing end.",
|
18682
18805
|
"name": "trailing-controls",
|
18683
18806
|
"inheritedFrom": {
|
18684
18807
|
"name": "ListItem",
|
@@ -18687,67 +18810,6 @@
|
|
18687
18810
|
}
|
18688
18811
|
],
|
18689
18812
|
"members": [
|
18690
|
-
{
|
18691
|
-
"kind": "field",
|
18692
|
-
"name": "checked",
|
18693
|
-
"type": {
|
18694
|
-
"text": "boolean"
|
18695
|
-
},
|
18696
|
-
"default": "false",
|
18697
|
-
"description": "The checked attribute is used to indicate that the menuitemcheckbox is checked or not.",
|
18698
|
-
"attribute": "checked",
|
18699
|
-
"reflects": true
|
18700
|
-
},
|
18701
|
-
{
|
18702
|
-
"kind": "field",
|
18703
|
-
"name": "indicator",
|
18704
|
-
"type": {
|
18705
|
-
"text": "Indicator"
|
18706
|
-
},
|
18707
|
-
"description": "The indicator attribute is used to differentiate between <b>checkbox</b> and <b>toggle</b>.",
|
18708
|
-
"default": "'checkbox'",
|
18709
|
-
"attribute": "indicator",
|
18710
|
-
"reflects": true
|
18711
|
-
},
|
18712
|
-
{
|
18713
|
-
"kind": "method",
|
18714
|
-
"name": "handleMouseClick",
|
18715
|
-
"privacy": "private",
|
18716
|
-
"description": "Handles click events to toggle checked state\nIf the menuitemcheckbox is disabled, it does nothing.\nIf the menuitemcheckbox is not disabled, it toggles the `checked` state between `true` and `false`."
|
18717
|
-
},
|
18718
|
-
{
|
18719
|
-
"kind": "method",
|
18720
|
-
"name": "staticCheckbox",
|
18721
|
-
"privacy": "private",
|
18722
|
-
"return": {
|
18723
|
-
"type": {
|
18724
|
-
"text": ""
|
18725
|
-
}
|
18726
|
-
},
|
18727
|
-
"description": "Returns a static checkbox element if the indicator is set to checkbox.\nIf the indicator is not set to checkbox, it returns nothing."
|
18728
|
-
},
|
18729
|
-
{
|
18730
|
-
"kind": "method",
|
18731
|
-
"name": "staticToggle",
|
18732
|
-
"privacy": "private",
|
18733
|
-
"return": {
|
18734
|
-
"type": {
|
18735
|
-
"text": ""
|
18736
|
-
}
|
18737
|
-
},
|
18738
|
-
"description": "Returns a static toggle element if the indicator is set to toggle.\nIf the indicator is not set to toggle, it returns nothing.\n\nThe toggle will always be positioned on the trailing side of the menuitem label."
|
18739
|
-
},
|
18740
|
-
{
|
18741
|
-
"kind": "method",
|
18742
|
-
"name": "getCheckmarkIcon",
|
18743
|
-
"privacy": "private",
|
18744
|
-
"return": {
|
18745
|
-
"type": {
|
18746
|
-
"text": ""
|
18747
|
-
}
|
18748
|
-
},
|
18749
|
-
"description": "Returns a checkmark icon if the indicator is set to checkmark and the checked state is true.\nIf the indicator is not set to checkmark or the checked state is false, it returns nothing.\n\nThe checkmark icon will always be positioned on the trailing side of the menuitem label."
|
18750
|
-
},
|
18751
18813
|
{
|
18752
18814
|
"kind": "field",
|
18753
18815
|
"name": "arrowPosition",
|
@@ -18756,11 +18818,7 @@
|
|
18756
18818
|
},
|
18757
18819
|
"description": "Defines where the arrow icon will appear.\n- `'leading'`: Icon appears on the leading edge (start).\n- `'trailing'`: Icon appears on the trailing edge (end).\n\nIf not set, no arrow is displayed.",
|
18758
18820
|
"attribute": "arrow-position",
|
18759
|
-
"reflects": true
|
18760
|
-
"inheritedFrom": {
|
18761
|
-
"name": "MenuItem",
|
18762
|
-
"module": "components/menuitem/menuitem.component.js"
|
18763
|
-
}
|
18821
|
+
"reflects": true
|
18764
18822
|
},
|
18765
18823
|
{
|
18766
18824
|
"kind": "field",
|
@@ -18770,11 +18828,7 @@
|
|
18770
18828
|
},
|
18771
18829
|
"description": "Defines the direction the arrow icon points.\n- `'positive'`: Arrow points toward the trailing side.\n- `'negative'`: Arrow points toward the leading side.",
|
18772
18830
|
"attribute": "arrow-direction",
|
18773
|
-
"reflects": true
|
18774
|
-
"inheritedFrom": {
|
18775
|
-
"name": "MenuItem",
|
18776
|
-
"module": "components/menuitem/menuitem.component.js"
|
18777
|
-
}
|
18831
|
+
"reflects": true
|
18778
18832
|
},
|
18779
18833
|
{
|
18780
18834
|
"kind": "field",
|
@@ -18785,11 +18839,7 @@
|
|
18785
18839
|
"default": "undefined",
|
18786
18840
|
"description": "The name attribute is used to identify the menu item when it is selected.",
|
18787
18841
|
"attribute": "name",
|
18788
|
-
"reflects": true
|
18789
|
-
"inheritedFrom": {
|
18790
|
-
"name": "MenuItem",
|
18791
|
-
"module": "components/menuitem/menuitem.component.js"
|
18792
|
-
}
|
18842
|
+
"reflects": true
|
18793
18843
|
},
|
18794
18844
|
{
|
18795
18845
|
"kind": "field",
|
@@ -18800,11 +18850,7 @@
|
|
18800
18850
|
"default": "undefined",
|
18801
18851
|
"description": "The value attribute is used to represent a value when the menu item is selected.\nIt is typically used with checkbox and radio menu items, but can be handy for any menu item.",
|
18802
18852
|
"attribute": "value",
|
18803
|
-
"reflects": true
|
18804
|
-
"inheritedFrom": {
|
18805
|
-
"name": "MenuItem",
|
18806
|
-
"module": "components/menuitem/menuitem.component.js"
|
18807
|
-
}
|
18853
|
+
"reflects": true
|
18808
18854
|
},
|
18809
18855
|
{
|
18810
18856
|
"kind": "method",
|
@@ -18848,11 +18894,7 @@
|
|
18848
18894
|
"description": "The keyboard event that triggered the action."
|
18849
18895
|
}
|
18850
18896
|
],
|
18851
|
-
"description": "Handles the keyup event for the menu item.\nIf the Space key is released, it triggers a click event on the menu item.\nThis allows keyboard users to activate the menu item using the Space key.\nIt also prevents the default action of the Space key to avoid scrolling the page.\n\nThis follows the native behaviour, actionable element can be triggered by Space\nkey on the keyup event.\n\nNote: Action triggered by Enter on the keydown event."
|
18852
|
-
"inheritedFrom": {
|
18853
|
-
"name": "MenuItem",
|
18854
|
-
"module": "components/menuitem/menuitem.component.js"
|
18855
|
-
}
|
18897
|
+
"description": "Handles the keyup event for the menu item.\nIf the Space key is released, it triggers a click event on the menu item.\nThis allows keyboard users to activate the menu item using the Space key.\nIt also prevents the default action of the Space key to avoid scrolling the page.\n\nThis follows the native behaviour, actionable element can be triggered by Space\nkey on the keyup event.\n\nNote: Action triggered by Enter on the keydown event."
|
18856
18898
|
},
|
18857
18899
|
{
|
18858
18900
|
"kind": "method",
|
@@ -19189,15 +19231,7 @@
|
|
19189
19231
|
],
|
19190
19232
|
"events": [
|
19191
19233
|
{
|
19192
|
-
"
|
19193
|
-
"type": {
|
19194
|
-
"text": "Event"
|
19195
|
-
},
|
19196
|
-
"description": "(React: onChange) This event is dispatched when the menuitemcheckbox changes.",
|
19197
|
-
"reactName": "onChange"
|
19198
|
-
},
|
19199
|
-
{
|
19200
|
-
"description": "(React: onClick) This event is dispatched when the menuitemcheckbox is clicked.",
|
19234
|
+
"description": "(React: onClick) This event is dispatched when the menuitem is clicked.",
|
19201
19235
|
"name": "click",
|
19202
19236
|
"reactName": "onClick",
|
19203
19237
|
"inheritedFrom": {
|
@@ -19205,15 +19239,6 @@
|
|
19205
19239
|
"module": "src/components/listitem/listitem.component.ts"
|
19206
19240
|
}
|
19207
19241
|
},
|
19208
|
-
{
|
19209
|
-
"description": "(React: onFocus) This event is dispatched when the menuitemcheckbox receives focus.",
|
19210
|
-
"name": "focus",
|
19211
|
-
"reactName": "onFocus",
|
19212
|
-
"inheritedFrom": {
|
19213
|
-
"name": "ListItem",
|
19214
|
-
"module": "src/components/listitem/listitem.component.ts"
|
19215
|
-
}
|
19216
|
-
},
|
19217
19242
|
{
|
19218
19243
|
"description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the menuitem.",
|
19219
19244
|
"name": "keydown",
|
@@ -19232,6 +19257,15 @@
|
|
19232
19257
|
"module": "src/components/listitem/listitem.component.ts"
|
19233
19258
|
}
|
19234
19259
|
},
|
19260
|
+
{
|
19261
|
+
"description": "(React: onFocus) This event is dispatched when the menuitem receives focus.",
|
19262
|
+
"name": "focus",
|
19263
|
+
"reactName": "onFocus",
|
19264
|
+
"inheritedFrom": {
|
19265
|
+
"name": "ListItem",
|
19266
|
+
"module": "src/components/listitem/listitem.component.ts"
|
19267
|
+
}
|
19268
|
+
},
|
19235
19269
|
{
|
19236
19270
|
"description": "(React: onEnabled) This event is dispatched after the listitem is enabled",
|
19237
19271
|
"name": "enabled",
|
@@ -19270,35 +19304,13 @@
|
|
19270
19304
|
}
|
19271
19305
|
],
|
19272
19306
|
"attributes": [
|
19273
|
-
{
|
19274
|
-
"name": "checked",
|
19275
|
-
"type": {
|
19276
|
-
"text": "boolean"
|
19277
|
-
},
|
19278
|
-
"default": "false",
|
19279
|
-
"description": "The checked attribute is used to indicate that the menuitemcheckbox is checked or not.",
|
19280
|
-
"fieldName": "checked"
|
19281
|
-
},
|
19282
|
-
{
|
19283
|
-
"name": "indicator",
|
19284
|
-
"type": {
|
19285
|
-
"text": "Indicator"
|
19286
|
-
},
|
19287
|
-
"description": "The indicator attribute is used to differentiate between <b>checkbox</b> and <b>toggle</b>.",
|
19288
|
-
"default": "'checkbox'",
|
19289
|
-
"fieldName": "indicator"
|
19290
|
-
},
|
19291
19307
|
{
|
19292
19308
|
"name": "arrow-position",
|
19293
19309
|
"type": {
|
19294
19310
|
"text": "ArrowPositions | undefined"
|
19295
19311
|
},
|
19296
19312
|
"description": "Defines where the arrow icon will appear.\n- `'leading'`: Icon appears on the leading edge (start).\n- `'trailing'`: Icon appears on the trailing edge (end).\n\nIf not set, no arrow is displayed.",
|
19297
|
-
"fieldName": "arrowPosition"
|
19298
|
-
"inheritedFrom": {
|
19299
|
-
"name": "MenuItem",
|
19300
|
-
"module": "src/components/menuitem/menuitem.component.ts"
|
19301
|
-
}
|
19313
|
+
"fieldName": "arrowPosition"
|
19302
19314
|
},
|
19303
19315
|
{
|
19304
19316
|
"name": "arrow-direction",
|
@@ -19306,11 +19318,7 @@
|
|
19306
19318
|
"text": "ArrowDirections | undefined"
|
19307
19319
|
},
|
19308
19320
|
"description": "Defines the direction the arrow icon points.\n- `'positive'`: Arrow points toward the trailing side.\n- `'negative'`: Arrow points toward the leading side.",
|
19309
|
-
"fieldName": "arrowDirection"
|
19310
|
-
"inheritedFrom": {
|
19311
|
-
"name": "MenuItem",
|
19312
|
-
"module": "src/components/menuitem/menuitem.component.ts"
|
19313
|
-
}
|
19321
|
+
"fieldName": "arrowDirection"
|
19314
19322
|
},
|
19315
19323
|
{
|
19316
19324
|
"name": "name",
|
@@ -19319,11 +19327,7 @@
|
|
19319
19327
|
},
|
19320
19328
|
"default": "undefined",
|
19321
19329
|
"description": "The name attribute is used to identify the menu item when it is selected.",
|
19322
|
-
"fieldName": "name"
|
19323
|
-
"inheritedFrom": {
|
19324
|
-
"name": "MenuItem",
|
19325
|
-
"module": "src/components/menuitem/menuitem.component.ts"
|
19326
|
-
}
|
19330
|
+
"fieldName": "name"
|
19327
19331
|
},
|
19328
19332
|
{
|
19329
19333
|
"name": "value",
|
@@ -19332,11 +19336,7 @@
|
|
19332
19336
|
},
|
19333
19337
|
"default": "undefined",
|
19334
19338
|
"description": "The value attribute is used to represent a value when the menu item is selected.\nIt is typically used with checkbox and radio menu items, but can be handy for any menu item.",
|
19335
|
-
"fieldName": "value"
|
19336
|
-
"inheritedFrom": {
|
19337
|
-
"name": "MenuItem",
|
19338
|
-
"module": "src/components/menuitem/menuitem.component.ts"
|
19339
|
-
}
|
19339
|
+
"fieldName": "value"
|
19340
19340
|
},
|
19341
19341
|
{
|
19342
19342
|
"name": "disabled",
|
@@ -19477,11 +19477,11 @@
|
|
19477
19477
|
}
|
19478
19478
|
],
|
19479
19479
|
"superclass": {
|
19480
|
-
"name": "
|
19481
|
-
"module": "/src/components/
|
19480
|
+
"name": "ListItem",
|
19481
|
+
"module": "/src/components/listitem/listitem.component"
|
19482
19482
|
},
|
19483
|
-
"tagName": "mdc-
|
19484
|
-
"jsDoc": "/**\n *
|
19483
|
+
"tagName": "mdc-menuitem",
|
19484
|
+
"jsDoc": "/**\n * menuitem component is inherited by listitem component with the role set `menuitem`.<br/>\n * A menu item can contain an icon on the leading or trailing side.\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.\n *\n * Please use element with role=menu as a parent element even when there is only menuitem for a11y purpose.\n * For example mdc-menupopover or mdc-menubar.\n *\n * Menu item has `name` and `value` attribute that can be used to identify the menu item when it is selected.\n *\n * @dependency mdc-text\n * @dependency mdc-icon\n * @dependency mdc-tooltip\n *\n * @tagname mdc-menuitem\n *\n * @slot leading-controls - slot for menu item controls to appear of leading end.\n * @slot leading-text-primary-label - slot for menu item primary label.\n * @slot leading-text-secondary-label - slot for menu item secondary label.\n * @slot leading-text-tertiary-label - slot for menu item tertiary label.\n * @slot trailing-text-side-header - slot for menu item side header text.\n * @slot trailing-text-subline - slot for menu item subline text.\n * @slot trailing-controls - slot for menu item controls to appear of trailing end.\n *\n * @event click - (React: onClick) This event is dispatched when the menuitem is clicked.\n * @event keydown - (React: onKeyDown) This event is dispatched when a key is pressed down on the menuitem.\n * @event keyup - (React: onKeyUp) This event is dispatched when a key is released on the menuitem.\n * @event focus - (React: onFocus) This event is dispatched when the menuitem receives focus.\n */",
|
19485
19485
|
"customElement": true,
|
19486
19486
|
"cssProperties": [
|
19487
19487
|
{
|
@@ -19556,8 +19556,8 @@
|
|
19556
19556
|
"kind": "js",
|
19557
19557
|
"name": "default",
|
19558
19558
|
"declaration": {
|
19559
|
-
"name": "
|
19560
|
-
"module": "components/
|
19559
|
+
"name": "MenuItem",
|
19560
|
+
"module": "components/menuitem/menuitem.component.js"
|
19561
19561
|
}
|
19562
19562
|
}
|
19563
19563
|
]
|
@@ -20515,6 +20515,147 @@
|
|
20515
20515
|
}
|
20516
20516
|
]
|
20517
20517
|
},
|
20518
|
+
{
|
20519
|
+
"kind": "javascript-module",
|
20520
|
+
"path": "components/menusection/menusection.component.js",
|
20521
|
+
"declarations": [
|
20522
|
+
{
|
20523
|
+
"kind": "class",
|
20524
|
+
"description": "`mdc-menusection` is a container element used to group a set of menu items.\n\nThis component supports a mix of `menuitem`, `menuitemcheckbox`, and `menuitemradio` components.\n\n- If multiple `menuitemradio` components are slotted into the section, the group enforces a single-selection rule:\n only one radio item can be selected at a time.\n- If `menuitemcheckbox` components are included, their checked state can be toggled independently.",
|
20525
|
+
"name": "MenuSection",
|
20526
|
+
"slots": [
|
20527
|
+
{
|
20528
|
+
"description": "Default slot for inserting `menuitem`, `menuitemcheckbox`, or `menuitemradio`",
|
20529
|
+
"name": ""
|
20530
|
+
}
|
20531
|
+
],
|
20532
|
+
"members": [
|
20533
|
+
{
|
20534
|
+
"kind": "field",
|
20535
|
+
"name": "ariaLabel",
|
20536
|
+
"type": {
|
20537
|
+
"text": "string | null"
|
20538
|
+
},
|
20539
|
+
"default": "null",
|
20540
|
+
"description": "The aria-label for the section.\nThis is used for accessibility purposes to describe the section.\nIf not provided, it defaults to the `headerText`.",
|
20541
|
+
"attribute": "aria-label",
|
20542
|
+
"reflects": true
|
20543
|
+
},
|
20544
|
+
{
|
20545
|
+
"kind": "field",
|
20546
|
+
"name": "headerText",
|
20547
|
+
"type": {
|
20548
|
+
"text": "string | null"
|
20549
|
+
},
|
20550
|
+
"default": "null",
|
20551
|
+
"description": "The primary headerText of the list item.\nThis appears on the leading side of the list item.",
|
20552
|
+
"attribute": "header-text",
|
20553
|
+
"reflects": true
|
20554
|
+
},
|
20555
|
+
{
|
20556
|
+
"kind": "field",
|
20557
|
+
"name": "prefixIcon",
|
20558
|
+
"type": {
|
20559
|
+
"text": "IconNames | undefined"
|
20560
|
+
},
|
20561
|
+
"description": "Name of the icon rendered before the text\n\nIf not provided, no icon will be rendered and text will be aligned to the start.",
|
20562
|
+
"attribute": "prefix-icon"
|
20563
|
+
},
|
20564
|
+
{
|
20565
|
+
"kind": "field",
|
20566
|
+
"name": "showDivider",
|
20567
|
+
"type": {
|
20568
|
+
"text": "boolean"
|
20569
|
+
},
|
20570
|
+
"default": "false",
|
20571
|
+
"description": "Whether to show a divider below the section header.\nThis is useful for visually separating sections in the menu.",
|
20572
|
+
"attribute": "show-divider",
|
20573
|
+
"reflects": true
|
20574
|
+
},
|
20575
|
+
{
|
20576
|
+
"kind": "field",
|
20577
|
+
"name": "dividerVariant",
|
20578
|
+
"description": "The variant of the divider.\nCan be set to 'solid' or 'gradient'.\n\nKeep 'solid' if used in MenuPopovers, as it is the default style.",
|
20579
|
+
"default": "'solid'",
|
20580
|
+
"attribute": "divider-variant",
|
20581
|
+
"reflects": true
|
20582
|
+
},
|
20583
|
+
{
|
20584
|
+
"kind": "method",
|
20585
|
+
"name": "renderHeader",
|
20586
|
+
"privacy": "private"
|
20587
|
+
}
|
20588
|
+
],
|
20589
|
+
"events": [
|
20590
|
+
{
|
20591
|
+
"description": "(React: onChange) This event is dispatched when a `menuitemcheckbox`, or `menuitemradio` changes.",
|
20592
|
+
"name": "change",
|
20593
|
+
"reactName": "onChange"
|
20594
|
+
}
|
20595
|
+
],
|
20596
|
+
"attributes": [
|
20597
|
+
{
|
20598
|
+
"name": "aria-label",
|
20599
|
+
"type": {
|
20600
|
+
"text": "string | null"
|
20601
|
+
},
|
20602
|
+
"default": "null",
|
20603
|
+
"description": "The aria-label for the section.\nThis is used for accessibility purposes to describe the section.\nIf not provided, it defaults to the `headerText`.",
|
20604
|
+
"fieldName": "ariaLabel"
|
20605
|
+
},
|
20606
|
+
{
|
20607
|
+
"name": "header-text",
|
20608
|
+
"type": {
|
20609
|
+
"text": "string | null"
|
20610
|
+
},
|
20611
|
+
"default": "null",
|
20612
|
+
"description": "The primary headerText of the list item.\nThis appears on the leading side of the list item.",
|
20613
|
+
"fieldName": "headerText"
|
20614
|
+
},
|
20615
|
+
{
|
20616
|
+
"name": "prefix-icon",
|
20617
|
+
"type": {
|
20618
|
+
"text": "IconNames | undefined"
|
20619
|
+
},
|
20620
|
+
"description": "Name of the icon rendered before the text\n\nIf not provided, no icon will be rendered and text will be aligned to the start.",
|
20621
|
+
"fieldName": "prefixIcon"
|
20622
|
+
},
|
20623
|
+
{
|
20624
|
+
"name": "show-divider",
|
20625
|
+
"type": {
|
20626
|
+
"text": "boolean"
|
20627
|
+
},
|
20628
|
+
"default": "false",
|
20629
|
+
"description": "Whether to show a divider below the section header.\nThis is useful for visually separating sections in the menu.",
|
20630
|
+
"fieldName": "showDivider"
|
20631
|
+
},
|
20632
|
+
{
|
20633
|
+
"name": "divider-variant",
|
20634
|
+
"description": "The variant of the divider.\nCan be set to 'solid' or 'gradient'.\n\nKeep 'solid' if used in MenuPopovers, as it is the default style.",
|
20635
|
+
"default": "'solid'",
|
20636
|
+
"fieldName": "dividerVariant"
|
20637
|
+
}
|
20638
|
+
],
|
20639
|
+
"superclass": {
|
20640
|
+
"name": "Component",
|
20641
|
+
"module": "/src/models"
|
20642
|
+
},
|
20643
|
+
"tagName": "mdc-menusection",
|
20644
|
+
"jsDoc": "/**\n * `mdc-menusection` is a container element used to group a set of menu items.\n *\n * This component supports a mix of `menuitem`, `menuitemcheckbox`, and `menuitemradio` components.\n *\n * - If multiple `menuitemradio` components are slotted into the section, the group enforces a single-selection rule:\n * only one radio item can be selected at a time.\n * - If `menuitemcheckbox` components are included, their checked state can be toggled independently.\n *\n * @tagname mdc-menusection\n *\n * @slot - Default slot for inserting `menuitem`, `menuitemcheckbox`, or `menuitemradio`\n *\n * @event change - (React: onChange) This event is dispatched when a `menuitemcheckbox`, or `menuitemradio` changes.\n */",
|
20645
|
+
"customElement": true
|
20646
|
+
}
|
20647
|
+
],
|
20648
|
+
"exports": [
|
20649
|
+
{
|
20650
|
+
"kind": "js",
|
20651
|
+
"name": "default",
|
20652
|
+
"declaration": {
|
20653
|
+
"name": "MenuSection",
|
20654
|
+
"module": "components/menusection/menusection.component.js"
|
20655
|
+
}
|
20656
|
+
}
|
20657
|
+
]
|
20658
|
+
},
|
20518
20659
|
{
|
20519
20660
|
"kind": "javascript-module",
|
20520
20661
|
"path": "components/menupopover/menupopover.component.js",
|
@@ -22659,147 +22800,6 @@
|
|
22659
22800
|
}
|
22660
22801
|
]
|
22661
22802
|
},
|
22662
|
-
{
|
22663
|
-
"kind": "javascript-module",
|
22664
|
-
"path": "components/menusection/menusection.component.js",
|
22665
|
-
"declarations": [
|
22666
|
-
{
|
22667
|
-
"kind": "class",
|
22668
|
-
"description": "`mdc-menusection` is a container element used to group a set of menu items.\n\nThis component supports a mix of `menuitem`, `menuitemcheckbox`, and `menuitemradio` components.\n\n- If multiple `menuitemradio` components are slotted into the section, the group enforces a single-selection rule:\n only one radio item can be selected at a time.\n- If `menuitemcheckbox` components are included, their checked state can be toggled independently.",
|
22669
|
-
"name": "MenuSection",
|
22670
|
-
"slots": [
|
22671
|
-
{
|
22672
|
-
"description": "Default slot for inserting `menuitem`, `menuitemcheckbox`, or `menuitemradio`",
|
22673
|
-
"name": ""
|
22674
|
-
}
|
22675
|
-
],
|
22676
|
-
"members": [
|
22677
|
-
{
|
22678
|
-
"kind": "field",
|
22679
|
-
"name": "ariaLabel",
|
22680
|
-
"type": {
|
22681
|
-
"text": "string | null"
|
22682
|
-
},
|
22683
|
-
"default": "null",
|
22684
|
-
"description": "The aria-label for the section.\nThis is used for accessibility purposes to describe the section.\nIf not provided, it defaults to the `headerText`.",
|
22685
|
-
"attribute": "aria-label",
|
22686
|
-
"reflects": true
|
22687
|
-
},
|
22688
|
-
{
|
22689
|
-
"kind": "field",
|
22690
|
-
"name": "headerText",
|
22691
|
-
"type": {
|
22692
|
-
"text": "string | null"
|
22693
|
-
},
|
22694
|
-
"default": "null",
|
22695
|
-
"description": "The primary headerText of the list item.\nThis appears on the leading side of the list item.",
|
22696
|
-
"attribute": "header-text",
|
22697
|
-
"reflects": true
|
22698
|
-
},
|
22699
|
-
{
|
22700
|
-
"kind": "field",
|
22701
|
-
"name": "prefixIcon",
|
22702
|
-
"type": {
|
22703
|
-
"text": "IconNames | undefined"
|
22704
|
-
},
|
22705
|
-
"description": "Name of the icon rendered before the text\n\nIf not provided, no icon will be rendered and text will be aligned to the start.",
|
22706
|
-
"attribute": "prefix-icon"
|
22707
|
-
},
|
22708
|
-
{
|
22709
|
-
"kind": "field",
|
22710
|
-
"name": "showDivider",
|
22711
|
-
"type": {
|
22712
|
-
"text": "boolean"
|
22713
|
-
},
|
22714
|
-
"default": "false",
|
22715
|
-
"description": "Whether to show a divider below the section header.\nThis is useful for visually separating sections in the menu.",
|
22716
|
-
"attribute": "show-divider",
|
22717
|
-
"reflects": true
|
22718
|
-
},
|
22719
|
-
{
|
22720
|
-
"kind": "field",
|
22721
|
-
"name": "dividerVariant",
|
22722
|
-
"description": "The variant of the divider.\nCan be set to 'solid' or 'gradient'.\n\nKeep 'solid' if used in MenuPopovers, as it is the default style.",
|
22723
|
-
"default": "'solid'",
|
22724
|
-
"attribute": "divider-variant",
|
22725
|
-
"reflects": true
|
22726
|
-
},
|
22727
|
-
{
|
22728
|
-
"kind": "method",
|
22729
|
-
"name": "renderHeader",
|
22730
|
-
"privacy": "private"
|
22731
|
-
}
|
22732
|
-
],
|
22733
|
-
"events": [
|
22734
|
-
{
|
22735
|
-
"description": "(React: onChange) This event is dispatched when a `menuitemcheckbox`, or `menuitemradio` changes.",
|
22736
|
-
"name": "change",
|
22737
|
-
"reactName": "onChange"
|
22738
|
-
}
|
22739
|
-
],
|
22740
|
-
"attributes": [
|
22741
|
-
{
|
22742
|
-
"name": "aria-label",
|
22743
|
-
"type": {
|
22744
|
-
"text": "string | null"
|
22745
|
-
},
|
22746
|
-
"default": "null",
|
22747
|
-
"description": "The aria-label for the section.\nThis is used for accessibility purposes to describe the section.\nIf not provided, it defaults to the `headerText`.",
|
22748
|
-
"fieldName": "ariaLabel"
|
22749
|
-
},
|
22750
|
-
{
|
22751
|
-
"name": "header-text",
|
22752
|
-
"type": {
|
22753
|
-
"text": "string | null"
|
22754
|
-
},
|
22755
|
-
"default": "null",
|
22756
|
-
"description": "The primary headerText of the list item.\nThis appears on the leading side of the list item.",
|
22757
|
-
"fieldName": "headerText"
|
22758
|
-
},
|
22759
|
-
{
|
22760
|
-
"name": "prefix-icon",
|
22761
|
-
"type": {
|
22762
|
-
"text": "IconNames | undefined"
|
22763
|
-
},
|
22764
|
-
"description": "Name of the icon rendered before the text\n\nIf not provided, no icon will be rendered and text will be aligned to the start.",
|
22765
|
-
"fieldName": "prefixIcon"
|
22766
|
-
},
|
22767
|
-
{
|
22768
|
-
"name": "show-divider",
|
22769
|
-
"type": {
|
22770
|
-
"text": "boolean"
|
22771
|
-
},
|
22772
|
-
"default": "false",
|
22773
|
-
"description": "Whether to show a divider below the section header.\nThis is useful for visually separating sections in the menu.",
|
22774
|
-
"fieldName": "showDivider"
|
22775
|
-
},
|
22776
|
-
{
|
22777
|
-
"name": "divider-variant",
|
22778
|
-
"description": "The variant of the divider.\nCan be set to 'solid' or 'gradient'.\n\nKeep 'solid' if used in MenuPopovers, as it is the default style.",
|
22779
|
-
"default": "'solid'",
|
22780
|
-
"fieldName": "dividerVariant"
|
22781
|
-
}
|
22782
|
-
],
|
22783
|
-
"superclass": {
|
22784
|
-
"name": "Component",
|
22785
|
-
"module": "/src/models"
|
22786
|
-
},
|
22787
|
-
"tagName": "mdc-menusection",
|
22788
|
-
"jsDoc": "/**\n * `mdc-menusection` is a container element used to group a set of menu items.\n *\n * This component supports a mix of `menuitem`, `menuitemcheckbox`, and `menuitemradio` components.\n *\n * - If multiple `menuitemradio` components are slotted into the section, the group enforces a single-selection rule:\n * only one radio item can be selected at a time.\n * - If `menuitemcheckbox` components are included, their checked state can be toggled independently.\n *\n * @tagname mdc-menusection\n *\n * @slot - Default slot for inserting `menuitem`, `menuitemcheckbox`, or `menuitemradio`\n *\n * @event change - (React: onChange) This event is dispatched when a `menuitemcheckbox`, or `menuitemradio` changes.\n */",
|
22789
|
-
"customElement": true
|
22790
|
-
}
|
22791
|
-
],
|
22792
|
-
"exports": [
|
22793
|
-
{
|
22794
|
-
"kind": "js",
|
22795
|
-
"name": "default",
|
22796
|
-
"declaration": {
|
22797
|
-
"name": "MenuSection",
|
22798
|
-
"module": "components/menusection/menusection.component.js"
|
22799
|
-
}
|
22800
|
-
}
|
22801
|
-
]
|
22802
|
-
},
|
22803
22803
|
{
|
22804
22804
|
"kind": "javascript-module",
|
22805
22805
|
"path": "components/navmenuitem/navmenuitem.component.js",
|
@@ -33293,180 +33293,6 @@
|
|
33293
33293
|
}
|
33294
33294
|
]
|
33295
33295
|
},
|
33296
|
-
{
|
33297
|
-
"kind": "javascript-module",
|
33298
|
-
"path": "components/statictoggle/statictoggle.component.js",
|
33299
|
-
"declarations": [
|
33300
|
-
{
|
33301
|
-
"kind": "class",
|
33302
|
-
"description": "This is a decorative component that is styled to look as a toggle. <br/>\nIt has 3 properties - checked, size and disabled. <br/>\nWe are using the same styling that has been created for the `mdc-toggle` component.",
|
33303
|
-
"name": "StaticToggle",
|
33304
|
-
"cssProperties": [
|
33305
|
-
{
|
33306
|
-
"description": "Width of the toggle",
|
33307
|
-
"name": "--mdc-statictoggle-width"
|
33308
|
-
},
|
33309
|
-
{
|
33310
|
-
"description": "Height of the toggle",
|
33311
|
-
"name": "--mdc-statictoggle-height"
|
33312
|
-
},
|
33313
|
-
{
|
33314
|
-
"description": "Width of the toggle when it's size is compact",
|
33315
|
-
"name": "--mdc-statictoggle-width-compact"
|
33316
|
-
},
|
33317
|
-
{
|
33318
|
-
"description": "Height of the toggle when it's size is compact",
|
33319
|
-
"name": "--mdc-statictoggle-height-compact"
|
33320
|
-
},
|
33321
|
-
{
|
33322
|
-
"description": "Border radius of the toggle",
|
33323
|
-
"name": "--mdc-statictoggle-border-radius"
|
33324
|
-
},
|
33325
|
-
{
|
33326
|
-
"description": "Border radius of the toggle when it's size is compact",
|
33327
|
-
"name": "--mdc-statictoggle-border-radius-compact"
|
33328
|
-
},
|
33329
|
-
{
|
33330
|
-
"description": "Border of the toggle",
|
33331
|
-
"name": "--mdc-statictoggle-border"
|
33332
|
-
},
|
33333
|
-
{
|
33334
|
-
"description": "Background color of the inactive toggle in rest state",
|
33335
|
-
"name": "--mdc-statictoggle-inactive-rest-color"
|
33336
|
-
},
|
33337
|
-
{
|
33338
|
-
"description": "Background color of the inactive toggle in disabled state",
|
33339
|
-
"name": "--mdc-statictoggle-inactive-disabled-color"
|
33340
|
-
},
|
33341
|
-
{
|
33342
|
-
"description": "Background color of the active toggle in rest state",
|
33343
|
-
"name": "--mdc-statictoggle-active-rest-color"
|
33344
|
-
},
|
33345
|
-
{
|
33346
|
-
"description": "Background color of the active toggle in disabled state",
|
33347
|
-
"name": "--mdc-statictoggle-active-disabled-color"
|
33348
|
-
},
|
33349
|
-
{
|
33350
|
-
"description": "Color of the icon in normal state",
|
33351
|
-
"name": "--mdc-statictoggle-icon-color-normal"
|
33352
|
-
},
|
33353
|
-
{
|
33354
|
-
"description": "Color of the icon in disabled state",
|
33355
|
-
"name": "--mdc-statictoggle-icon-color-disabled"
|
33356
|
-
},
|
33357
|
-
{
|
33358
|
-
"description": "Background color of the icon in normal state",
|
33359
|
-
"name": "--mdc-statictoggle-icon-background-color-normal"
|
33360
|
-
},
|
33361
|
-
{
|
33362
|
-
"description": "Background color of the icon in disabled state",
|
33363
|
-
"name": "--mdc-statictoggle-icon-background-color-disabled"
|
33364
|
-
}
|
33365
|
-
],
|
33366
|
-
"slots": [
|
33367
|
-
{
|
33368
|
-
"description": "This is a default/unnamed slot",
|
33369
|
-
"name": "default"
|
33370
|
-
}
|
33371
|
-
],
|
33372
|
-
"members": [
|
33373
|
-
{
|
33374
|
-
"kind": "field",
|
33375
|
-
"name": "checked",
|
33376
|
-
"type": {
|
33377
|
-
"text": "boolean"
|
33378
|
-
},
|
33379
|
-
"default": "false",
|
33380
|
-
"description": "Determines whether the toggle is active or inactive.",
|
33381
|
-
"attribute": "checked",
|
33382
|
-
"reflects": true
|
33383
|
-
},
|
33384
|
-
{
|
33385
|
-
"kind": "field",
|
33386
|
-
"name": "size",
|
33387
|
-
"type": {
|
33388
|
-
"text": "ToggleSize"
|
33389
|
-
},
|
33390
|
-
"description": "Determines toggle size in rem (height is specified here).\n- **Default**: 1.5\n- **Compact**: 1",
|
33391
|
-
"default": "default",
|
33392
|
-
"attribute": "size",
|
33393
|
-
"reflects": true
|
33394
|
-
},
|
33395
|
-
{
|
33396
|
-
"kind": "field",
|
33397
|
-
"name": "disabled",
|
33398
|
-
"type": {
|
33399
|
-
"text": "boolean | undefined"
|
33400
|
-
},
|
33401
|
-
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
33402
|
-
"default": "undefined",
|
33403
|
-
"attribute": "disabled",
|
33404
|
-
"reflects": true,
|
33405
|
-
"inheritedFrom": {
|
33406
|
-
"name": "DisabledMixin",
|
33407
|
-
"module": "utils/mixins/DisabledMixin.js"
|
33408
|
-
}
|
33409
|
-
}
|
33410
|
-
],
|
33411
|
-
"attributes": [
|
33412
|
-
{
|
33413
|
-
"name": "checked",
|
33414
|
-
"type": {
|
33415
|
-
"text": "boolean"
|
33416
|
-
},
|
33417
|
-
"default": "false",
|
33418
|
-
"description": "Determines whether the toggle is active or inactive.",
|
33419
|
-
"fieldName": "checked"
|
33420
|
-
},
|
33421
|
-
{
|
33422
|
-
"name": "size",
|
33423
|
-
"type": {
|
33424
|
-
"text": "ToggleSize"
|
33425
|
-
},
|
33426
|
-
"description": "Determines toggle size in rem (height is specified here).\n- **Default**: 1.5\n- **Compact**: 1",
|
33427
|
-
"default": "default",
|
33428
|
-
"fieldName": "size"
|
33429
|
-
},
|
33430
|
-
{
|
33431
|
-
"name": "disabled",
|
33432
|
-
"type": {
|
33433
|
-
"text": "boolean | undefined"
|
33434
|
-
},
|
33435
|
-
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
33436
|
-
"default": "undefined",
|
33437
|
-
"fieldName": "disabled",
|
33438
|
-
"inheritedFrom": {
|
33439
|
-
"name": "DisabledMixin",
|
33440
|
-
"module": "src/utils/mixins/DisabledMixin.ts"
|
33441
|
-
}
|
33442
|
-
}
|
33443
|
-
],
|
33444
|
-
"mixins": [
|
33445
|
-
{
|
33446
|
-
"name": "DisabledMixin",
|
33447
|
-
"module": "/src/utils/mixins/DisabledMixin"
|
33448
|
-
}
|
33449
|
-
],
|
33450
|
-
"superclass": {
|
33451
|
-
"name": "Component",
|
33452
|
-
"module": "/src/models"
|
33453
|
-
},
|
33454
|
-
"tagName": "mdc-statictoggle",
|
33455
|
-
"jsDoc": "/**\n * This is a decorative component that is styled to look as a toggle. <br/>\n * It has 3 properties - checked, size and disabled. <br/>\n * We are using the same styling that has been created for the `mdc-toggle` component.\n *\n * @dependency mdc-icon\n *\n * @tagname mdc-statictoggle\n *\n * @slot default - This is a default/unnamed slot\n *\n * @cssproperty --mdc-statictoggle-width - Width of the toggle\n * @cssproperty --mdc-statictoggle-height - Height of the toggle\n * @cssproperty --mdc-statictoggle-width-compact - Width of the toggle when it's size is compact\n * @cssproperty --mdc-statictoggle-height-compact - Height of the toggle when it's size is compact\n * @cssproperty --mdc-statictoggle-border-radius - Border radius of the toggle\n * @cssproperty --mdc-statictoggle-border-radius-compact - Border radius of the toggle when it's size is compact\n * @cssproperty --mdc-statictoggle-border - Border of the toggle\n * @cssproperty --mdc-statictoggle-inactive-rest-color - Background color of the inactive toggle in rest state\n * @cssproperty --mdc-statictoggle-inactive-disabled-color - Background color of the inactive toggle in disabled state\n * @cssproperty --mdc-statictoggle-active-rest-color - Background color of the active toggle in rest state\n * @cssproperty --mdc-statictoggle-active-disabled-color - Background color of the active toggle in disabled state\n * @cssproperty --mdc-statictoggle-icon-color-normal - Color of the icon in normal state\n * @cssproperty --mdc-statictoggle-icon-color-disabled - Color of the icon in disabled state\n * @cssproperty --mdc-statictoggle-icon-background-color-normal - Background color of the icon in normal state\n * @cssproperty --mdc-statictoggle-icon-background-color-disabled - Background color of the icon in disabled state\n */",
|
33456
|
-
"customElement": true
|
33457
|
-
}
|
33458
|
-
],
|
33459
|
-
"exports": [
|
33460
|
-
{
|
33461
|
-
"kind": "js",
|
33462
|
-
"name": "default",
|
33463
|
-
"declaration": {
|
33464
|
-
"name": "StaticToggle",
|
33465
|
-
"module": "components/statictoggle/statictoggle.component.js"
|
33466
|
-
}
|
33467
|
-
}
|
33468
|
-
]
|
33469
|
-
},
|
33470
33296
|
{
|
33471
33297
|
"kind": "javascript-module",
|
33472
33298
|
"path": "components/stepper/stepper.component.js",
|
@@ -33652,6 +33478,180 @@
|
|
33652
33478
|
}
|
33653
33479
|
]
|
33654
33480
|
},
|
33481
|
+
{
|
33482
|
+
"kind": "javascript-module",
|
33483
|
+
"path": "components/statictoggle/statictoggle.component.js",
|
33484
|
+
"declarations": [
|
33485
|
+
{
|
33486
|
+
"kind": "class",
|
33487
|
+
"description": "This is a decorative component that is styled to look as a toggle. <br/>\nIt has 3 properties - checked, size and disabled. <br/>\nWe are using the same styling that has been created for the `mdc-toggle` component.",
|
33488
|
+
"name": "StaticToggle",
|
33489
|
+
"cssProperties": [
|
33490
|
+
{
|
33491
|
+
"description": "Width of the toggle",
|
33492
|
+
"name": "--mdc-statictoggle-width"
|
33493
|
+
},
|
33494
|
+
{
|
33495
|
+
"description": "Height of the toggle",
|
33496
|
+
"name": "--mdc-statictoggle-height"
|
33497
|
+
},
|
33498
|
+
{
|
33499
|
+
"description": "Width of the toggle when it's size is compact",
|
33500
|
+
"name": "--mdc-statictoggle-width-compact"
|
33501
|
+
},
|
33502
|
+
{
|
33503
|
+
"description": "Height of the toggle when it's size is compact",
|
33504
|
+
"name": "--mdc-statictoggle-height-compact"
|
33505
|
+
},
|
33506
|
+
{
|
33507
|
+
"description": "Border radius of the toggle",
|
33508
|
+
"name": "--mdc-statictoggle-border-radius"
|
33509
|
+
},
|
33510
|
+
{
|
33511
|
+
"description": "Border radius of the toggle when it's size is compact",
|
33512
|
+
"name": "--mdc-statictoggle-border-radius-compact"
|
33513
|
+
},
|
33514
|
+
{
|
33515
|
+
"description": "Border of the toggle",
|
33516
|
+
"name": "--mdc-statictoggle-border"
|
33517
|
+
},
|
33518
|
+
{
|
33519
|
+
"description": "Background color of the inactive toggle in rest state",
|
33520
|
+
"name": "--mdc-statictoggle-inactive-rest-color"
|
33521
|
+
},
|
33522
|
+
{
|
33523
|
+
"description": "Background color of the inactive toggle in disabled state",
|
33524
|
+
"name": "--mdc-statictoggle-inactive-disabled-color"
|
33525
|
+
},
|
33526
|
+
{
|
33527
|
+
"description": "Background color of the active toggle in rest state",
|
33528
|
+
"name": "--mdc-statictoggle-active-rest-color"
|
33529
|
+
},
|
33530
|
+
{
|
33531
|
+
"description": "Background color of the active toggle in disabled state",
|
33532
|
+
"name": "--mdc-statictoggle-active-disabled-color"
|
33533
|
+
},
|
33534
|
+
{
|
33535
|
+
"description": "Color of the icon in normal state",
|
33536
|
+
"name": "--mdc-statictoggle-icon-color-normal"
|
33537
|
+
},
|
33538
|
+
{
|
33539
|
+
"description": "Color of the icon in disabled state",
|
33540
|
+
"name": "--mdc-statictoggle-icon-color-disabled"
|
33541
|
+
},
|
33542
|
+
{
|
33543
|
+
"description": "Background color of the icon in normal state",
|
33544
|
+
"name": "--mdc-statictoggle-icon-background-color-normal"
|
33545
|
+
},
|
33546
|
+
{
|
33547
|
+
"description": "Background color of the icon in disabled state",
|
33548
|
+
"name": "--mdc-statictoggle-icon-background-color-disabled"
|
33549
|
+
}
|
33550
|
+
],
|
33551
|
+
"slots": [
|
33552
|
+
{
|
33553
|
+
"description": "This is a default/unnamed slot",
|
33554
|
+
"name": "default"
|
33555
|
+
}
|
33556
|
+
],
|
33557
|
+
"members": [
|
33558
|
+
{
|
33559
|
+
"kind": "field",
|
33560
|
+
"name": "checked",
|
33561
|
+
"type": {
|
33562
|
+
"text": "boolean"
|
33563
|
+
},
|
33564
|
+
"default": "false",
|
33565
|
+
"description": "Determines whether the toggle is active or inactive.",
|
33566
|
+
"attribute": "checked",
|
33567
|
+
"reflects": true
|
33568
|
+
},
|
33569
|
+
{
|
33570
|
+
"kind": "field",
|
33571
|
+
"name": "size",
|
33572
|
+
"type": {
|
33573
|
+
"text": "ToggleSize"
|
33574
|
+
},
|
33575
|
+
"description": "Determines toggle size in rem (height is specified here).\n- **Default**: 1.5\n- **Compact**: 1",
|
33576
|
+
"default": "default",
|
33577
|
+
"attribute": "size",
|
33578
|
+
"reflects": true
|
33579
|
+
},
|
33580
|
+
{
|
33581
|
+
"kind": "field",
|
33582
|
+
"name": "disabled",
|
33583
|
+
"type": {
|
33584
|
+
"text": "boolean | undefined"
|
33585
|
+
},
|
33586
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
33587
|
+
"default": "undefined",
|
33588
|
+
"attribute": "disabled",
|
33589
|
+
"reflects": true,
|
33590
|
+
"inheritedFrom": {
|
33591
|
+
"name": "DisabledMixin",
|
33592
|
+
"module": "utils/mixins/DisabledMixin.js"
|
33593
|
+
}
|
33594
|
+
}
|
33595
|
+
],
|
33596
|
+
"attributes": [
|
33597
|
+
{
|
33598
|
+
"name": "checked",
|
33599
|
+
"type": {
|
33600
|
+
"text": "boolean"
|
33601
|
+
},
|
33602
|
+
"default": "false",
|
33603
|
+
"description": "Determines whether the toggle is active or inactive.",
|
33604
|
+
"fieldName": "checked"
|
33605
|
+
},
|
33606
|
+
{
|
33607
|
+
"name": "size",
|
33608
|
+
"type": {
|
33609
|
+
"text": "ToggleSize"
|
33610
|
+
},
|
33611
|
+
"description": "Determines toggle size in rem (height is specified here).\n- **Default**: 1.5\n- **Compact**: 1",
|
33612
|
+
"default": "default",
|
33613
|
+
"fieldName": "size"
|
33614
|
+
},
|
33615
|
+
{
|
33616
|
+
"name": "disabled",
|
33617
|
+
"type": {
|
33618
|
+
"text": "boolean | undefined"
|
33619
|
+
},
|
33620
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
33621
|
+
"default": "undefined",
|
33622
|
+
"fieldName": "disabled",
|
33623
|
+
"inheritedFrom": {
|
33624
|
+
"name": "DisabledMixin",
|
33625
|
+
"module": "src/utils/mixins/DisabledMixin.ts"
|
33626
|
+
}
|
33627
|
+
}
|
33628
|
+
],
|
33629
|
+
"mixins": [
|
33630
|
+
{
|
33631
|
+
"name": "DisabledMixin",
|
33632
|
+
"module": "/src/utils/mixins/DisabledMixin"
|
33633
|
+
}
|
33634
|
+
],
|
33635
|
+
"superclass": {
|
33636
|
+
"name": "Component",
|
33637
|
+
"module": "/src/models"
|
33638
|
+
},
|
33639
|
+
"tagName": "mdc-statictoggle",
|
33640
|
+
"jsDoc": "/**\n * This is a decorative component that is styled to look as a toggle. <br/>\n * It has 3 properties - checked, size and disabled. <br/>\n * We are using the same styling that has been created for the `mdc-toggle` component.\n *\n * @dependency mdc-icon\n *\n * @tagname mdc-statictoggle\n *\n * @slot default - This is a default/unnamed slot\n *\n * @cssproperty --mdc-statictoggle-width - Width of the toggle\n * @cssproperty --mdc-statictoggle-height - Height of the toggle\n * @cssproperty --mdc-statictoggle-width-compact - Width of the toggle when it's size is compact\n * @cssproperty --mdc-statictoggle-height-compact - Height of the toggle when it's size is compact\n * @cssproperty --mdc-statictoggle-border-radius - Border radius of the toggle\n * @cssproperty --mdc-statictoggle-border-radius-compact - Border radius of the toggle when it's size is compact\n * @cssproperty --mdc-statictoggle-border - Border of the toggle\n * @cssproperty --mdc-statictoggle-inactive-rest-color - Background color of the inactive toggle in rest state\n * @cssproperty --mdc-statictoggle-inactive-disabled-color - Background color of the inactive toggle in disabled state\n * @cssproperty --mdc-statictoggle-active-rest-color - Background color of the active toggle in rest state\n * @cssproperty --mdc-statictoggle-active-disabled-color - Background color of the active toggle in disabled state\n * @cssproperty --mdc-statictoggle-icon-color-normal - Color of the icon in normal state\n * @cssproperty --mdc-statictoggle-icon-color-disabled - Color of the icon in disabled state\n * @cssproperty --mdc-statictoggle-icon-background-color-normal - Background color of the icon in normal state\n * @cssproperty --mdc-statictoggle-icon-background-color-disabled - Background color of the icon in disabled state\n */",
|
33641
|
+
"customElement": true
|
33642
|
+
}
|
33643
|
+
],
|
33644
|
+
"exports": [
|
33645
|
+
{
|
33646
|
+
"kind": "js",
|
33647
|
+
"name": "default",
|
33648
|
+
"declaration": {
|
33649
|
+
"name": "StaticToggle",
|
33650
|
+
"module": "components/statictoggle/statictoggle.component.js"
|
33651
|
+
}
|
33652
|
+
}
|
33653
|
+
]
|
33654
|
+
},
|
33655
33655
|
{
|
33656
33656
|
"kind": "javascript-module",
|
33657
33657
|
"path": "components/stepperitem/stepperitem.component.js",
|
@@ -41036,6 +41036,342 @@
|
|
41036
41036
|
}
|
41037
41037
|
]
|
41038
41038
|
},
|
41039
|
+
{
|
41040
|
+
"kind": "javascript-module",
|
41041
|
+
"path": "components/typewriter/typewriter.component.js",
|
41042
|
+
"declarations": [
|
41043
|
+
{
|
41044
|
+
"kind": "class",
|
41045
|
+
"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",
|
41046
|
+
"name": "Typewriter",
|
41047
|
+
"cssParts": [
|
41048
|
+
{
|
41049
|
+
"description": "Container for the text element",
|
41050
|
+
"name": "container"
|
41051
|
+
},
|
41052
|
+
{
|
41053
|
+
"description": "The text element (forwarded to mdc-text)",
|
41054
|
+
"name": "text"
|
41055
|
+
}
|
41056
|
+
],
|
41057
|
+
"slots": [
|
41058
|
+
{
|
41059
|
+
"description": "Default slot for text content",
|
41060
|
+
"name": ""
|
41061
|
+
}
|
41062
|
+
],
|
41063
|
+
"members": [
|
41064
|
+
{
|
41065
|
+
"kind": "field",
|
41066
|
+
"name": "type",
|
41067
|
+
"type": {
|
41068
|
+
"text": "TextType"
|
41069
|
+
},
|
41070
|
+
"privacy": "public",
|
41071
|
+
"description": "Specifies the text style to be applied to the internal text component.\nUses the same types as the Text component.",
|
41072
|
+
"default": "body-large-regular",
|
41073
|
+
"attribute": "type",
|
41074
|
+
"reflects": true
|
41075
|
+
},
|
41076
|
+
{
|
41077
|
+
"kind": "field",
|
41078
|
+
"name": "tagname",
|
41079
|
+
"type": {
|
41080
|
+
"text": "TagName | undefined"
|
41081
|
+
},
|
41082
|
+
"privacy": "public",
|
41083
|
+
"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.",
|
41084
|
+
"attribute": "tagname",
|
41085
|
+
"reflects": true
|
41086
|
+
},
|
41087
|
+
{
|
41088
|
+
"kind": "field",
|
41089
|
+
"name": "speed",
|
41090
|
+
"type": {
|
41091
|
+
"text": "TypewriterSpeed"
|
41092
|
+
},
|
41093
|
+
"privacy": "public",
|
41094
|
+
"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')",
|
41095
|
+
"default": "'normal' (60ms per character)",
|
41096
|
+
"attribute": "speed",
|
41097
|
+
"reflects": true
|
41098
|
+
},
|
41099
|
+
{
|
41100
|
+
"kind": "field",
|
41101
|
+
"name": "maxQueueSize",
|
41102
|
+
"type": {
|
41103
|
+
"text": "number"
|
41104
|
+
},
|
41105
|
+
"privacy": "public",
|
41106
|
+
"description": "Maximum number of text chunks that can be queued before oldest chunks are dropped.\nSet to prevent memory accumulation from excessive queuing.",
|
41107
|
+
"default": "Number.MAX_SAFE_INTEGER (effectively unlimited)",
|
41108
|
+
"attribute": "max-queue-size",
|
41109
|
+
"reflects": true
|
41110
|
+
},
|
41111
|
+
{
|
41112
|
+
"kind": "method",
|
41113
|
+
"name": "createTimeout",
|
41114
|
+
"privacy": "private",
|
41115
|
+
"return": {
|
41116
|
+
"type": {
|
41117
|
+
"text": "number"
|
41118
|
+
}
|
41119
|
+
},
|
41120
|
+
"parameters": [
|
41121
|
+
{
|
41122
|
+
"name": "callback",
|
41123
|
+
"type": {
|
41124
|
+
"text": "() => void"
|
41125
|
+
}
|
41126
|
+
},
|
41127
|
+
{
|
41128
|
+
"name": "delay",
|
41129
|
+
"type": {
|
41130
|
+
"text": "number"
|
41131
|
+
}
|
41132
|
+
}
|
41133
|
+
],
|
41134
|
+
"description": "Helper to create tracked setTimeout that will be cleaned up on disconnect"
|
41135
|
+
},
|
41136
|
+
{
|
41137
|
+
"kind": "method",
|
41138
|
+
"name": "clearAllTimeouts",
|
41139
|
+
"privacy": "private",
|
41140
|
+
"return": {
|
41141
|
+
"type": {
|
41142
|
+
"text": "void"
|
41143
|
+
}
|
41144
|
+
},
|
41145
|
+
"description": "Clear all pending timeouts"
|
41146
|
+
},
|
41147
|
+
{
|
41148
|
+
"kind": "method",
|
41149
|
+
"name": "clearQueue",
|
41150
|
+
"privacy": "public",
|
41151
|
+
"return": {
|
41152
|
+
"type": {
|
41153
|
+
"text": "void"
|
41154
|
+
}
|
41155
|
+
},
|
41156
|
+
"description": "Clears the text chunk queue and stops processing\nUseful for resetting the component state"
|
41157
|
+
},
|
41158
|
+
{
|
41159
|
+
"kind": "method",
|
41160
|
+
"name": "addTextChunk",
|
41161
|
+
"privacy": "public",
|
41162
|
+
"return": {
|
41163
|
+
"type": {
|
41164
|
+
"text": "void"
|
41165
|
+
}
|
41166
|
+
},
|
41167
|
+
"parameters": [
|
41168
|
+
{
|
41169
|
+
"name": "text",
|
41170
|
+
"type": {
|
41171
|
+
"text": "string"
|
41172
|
+
},
|
41173
|
+
"description": "The text to add"
|
41174
|
+
},
|
41175
|
+
{
|
41176
|
+
"name": "speed",
|
41177
|
+
"optional": true,
|
41178
|
+
"type": {
|
41179
|
+
"text": "TypewriterSpeed"
|
41180
|
+
},
|
41181
|
+
"description": "Optional speed override for this chunk"
|
41182
|
+
},
|
41183
|
+
{
|
41184
|
+
"name": "instant",
|
41185
|
+
"optional": true,
|
41186
|
+
"type": {
|
41187
|
+
"text": "boolean"
|
41188
|
+
},
|
41189
|
+
"description": "If true, text appears instantly without animation"
|
41190
|
+
}
|
41191
|
+
],
|
41192
|
+
"description": "Adds a chunk of text to be typed out, optionally with a different speed"
|
41193
|
+
},
|
41194
|
+
{
|
41195
|
+
"kind": "method",
|
41196
|
+
"name": "addInstantTextChunk",
|
41197
|
+
"privacy": "public",
|
41198
|
+
"return": {
|
41199
|
+
"type": {
|
41200
|
+
"text": "void"
|
41201
|
+
}
|
41202
|
+
},
|
41203
|
+
"parameters": [
|
41204
|
+
{
|
41205
|
+
"name": "text",
|
41206
|
+
"type": {
|
41207
|
+
"text": "string"
|
41208
|
+
},
|
41209
|
+
"description": "The text to add instantly"
|
41210
|
+
}
|
41211
|
+
],
|
41212
|
+
"description": "Adds a chunk of text instantly without typing animation"
|
41213
|
+
},
|
41214
|
+
{
|
41215
|
+
"kind": "method",
|
41216
|
+
"name": "processChunkQueue",
|
41217
|
+
"privacy": "private",
|
41218
|
+
"return": {
|
41219
|
+
"type": {
|
41220
|
+
"text": "void"
|
41221
|
+
}
|
41222
|
+
},
|
41223
|
+
"description": "Processes all chunks in the queue"
|
41224
|
+
},
|
41225
|
+
{
|
41226
|
+
"kind": "method",
|
41227
|
+
"name": "processNextChunk",
|
41228
|
+
"privacy": "private",
|
41229
|
+
"return": {
|
41230
|
+
"type": {
|
41231
|
+
"text": "void"
|
41232
|
+
}
|
41233
|
+
},
|
41234
|
+
"description": "Processes the next chunk in the queue"
|
41235
|
+
},
|
41236
|
+
{
|
41237
|
+
"kind": "method",
|
41238
|
+
"name": "getTypingDelayMs",
|
41239
|
+
"privacy": "private",
|
41240
|
+
"return": {
|
41241
|
+
"type": {
|
41242
|
+
"text": "number"
|
41243
|
+
}
|
41244
|
+
},
|
41245
|
+
"description": "Gets the typing delay in milliseconds per character"
|
41246
|
+
},
|
41247
|
+
{
|
41248
|
+
"kind": "method",
|
41249
|
+
"name": "captureAndProcessContent",
|
41250
|
+
"privacy": "private",
|
41251
|
+
"return": {
|
41252
|
+
"type": {
|
41253
|
+
"text": "void"
|
41254
|
+
}
|
41255
|
+
},
|
41256
|
+
"description": "Captures slot content and starts typewriter animation"
|
41257
|
+
},
|
41258
|
+
{
|
41259
|
+
"kind": "method",
|
41260
|
+
"name": "startTypingAnimation",
|
41261
|
+
"privacy": "private",
|
41262
|
+
"return": {
|
41263
|
+
"type": {
|
41264
|
+
"text": "void"
|
41265
|
+
}
|
41266
|
+
},
|
41267
|
+
"parameters": [
|
41268
|
+
{
|
41269
|
+
"name": "onComplete",
|
41270
|
+
"optional": true,
|
41271
|
+
"type": {
|
41272
|
+
"text": "() => void"
|
41273
|
+
}
|
41274
|
+
}
|
41275
|
+
],
|
41276
|
+
"description": "Starts the typewriter animation"
|
41277
|
+
},
|
41278
|
+
{
|
41279
|
+
"kind": "method",
|
41280
|
+
"name": "clearTypingAnimation",
|
41281
|
+
"privacy": "private",
|
41282
|
+
"return": {
|
41283
|
+
"type": {
|
41284
|
+
"text": "void"
|
41285
|
+
}
|
41286
|
+
},
|
41287
|
+
"description": "Clears the typing animation timeout"
|
41288
|
+
},
|
41289
|
+
{
|
41290
|
+
"kind": "method",
|
41291
|
+
"name": "handleSlotChange",
|
41292
|
+
"privacy": "private",
|
41293
|
+
"return": {
|
41294
|
+
"type": {
|
41295
|
+
"text": "void"
|
41296
|
+
}
|
41297
|
+
},
|
41298
|
+
"description": "Handler for slotchange event"
|
41299
|
+
}
|
41300
|
+
],
|
41301
|
+
"events": [
|
41302
|
+
{
|
41303
|
+
"type": {
|
41304
|
+
"text": "CustomEvent"
|
41305
|
+
}
|
41306
|
+
},
|
41307
|
+
{
|
41308
|
+
"description": "(React: onTypingComplete) Fired when the typewriter finishes typing all content. Detail: \\{ finalContent: string \\}",
|
41309
|
+
"name": "typing-complete",
|
41310
|
+
"reactName": "onTypingComplete"
|
41311
|
+
},
|
41312
|
+
{
|
41313
|
+
"description": "(React: onChange) Fired when the content of the typewriter changes. Detail: \\{ content: string, isTyping: boolean \\}",
|
41314
|
+
"name": "change",
|
41315
|
+
"reactName": "onChange"
|
41316
|
+
}
|
41317
|
+
],
|
41318
|
+
"attributes": [
|
41319
|
+
{
|
41320
|
+
"name": "type",
|
41321
|
+
"type": {
|
41322
|
+
"text": "TextType"
|
41323
|
+
},
|
41324
|
+
"description": "Specifies the text style to be applied to the internal text component.\nUses the same types as the Text component.",
|
41325
|
+
"default": "body-large-regular",
|
41326
|
+
"fieldName": "type"
|
41327
|
+
},
|
41328
|
+
{
|
41329
|
+
"name": "tagname",
|
41330
|
+
"type": {
|
41331
|
+
"text": "TagName | undefined"
|
41332
|
+
},
|
41333
|
+
"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.",
|
41334
|
+
"fieldName": "tagname"
|
41335
|
+
},
|
41336
|
+
{
|
41337
|
+
"name": "speed",
|
41338
|
+
"type": {
|
41339
|
+
"text": "TypewriterSpeed"
|
41340
|
+
},
|
41341
|
+
"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')",
|
41342
|
+
"default": "'normal' (60ms per character)",
|
41343
|
+
"fieldName": "speed"
|
41344
|
+
},
|
41345
|
+
{
|
41346
|
+
"name": "max-queue-size",
|
41347
|
+
"type": {
|
41348
|
+
"text": "number"
|
41349
|
+
},
|
41350
|
+
"description": "Maximum number of text chunks that can be queued before oldest chunks are dropped.\nSet to prevent memory accumulation from excessive queuing.",
|
41351
|
+
"default": "Number.MAX_SAFE_INTEGER (effectively unlimited)",
|
41352
|
+
"fieldName": "maxQueueSize"
|
41353
|
+
}
|
41354
|
+
],
|
41355
|
+
"superclass": {
|
41356
|
+
"name": "Component",
|
41357
|
+
"module": "/src/models"
|
41358
|
+
},
|
41359
|
+
"tagName": "mdc-typewriter",
|
41360
|
+
"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 */",
|
41361
|
+
"customElement": true
|
41362
|
+
}
|
41363
|
+
],
|
41364
|
+
"exports": [
|
41365
|
+
{
|
41366
|
+
"kind": "js",
|
41367
|
+
"name": "default",
|
41368
|
+
"declaration": {
|
41369
|
+
"name": "Typewriter",
|
41370
|
+
"module": "components/typewriter/typewriter.component.js"
|
41371
|
+
}
|
41372
|
+
}
|
41373
|
+
]
|
41374
|
+
},
|
41039
41375
|
{
|
41040
41376
|
"kind": "javascript-module",
|
41041
41377
|
"path": "components/virtualizedlist/virtualizedlist.component.js",
|