@momentum-design/components 0.101.3 → 0.101.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -477,157 +477,6 @@
477
477
  }
478
478
  ]
479
479
  },
480
- {
481
- "kind": "javascript-module",
482
- "path": "components/accordiongroup/accordiongroup.component.js",
483
- "declarations": [
484
- {
485
- "kind": "class",
486
- "description": "An accordion group is a vertically stacked set of interactive headings that each contain a header and body content.\nEach heading of the accordion acts as a control that enable users to expand or hide their associated body sections of content.\nAccordions are commonly used to reduce the need to scroll when presenting multiple sections of content on a single page.\n\n- Default Slot: The accordion group component only accepts, `accordion` and `accordionbutton` components as the children, rest are ignored.\n\nThere are three types of variants:\n- Stacked - Each accordion will have a gap of 1.5rem (24px).\n- Borderless - Each accordion will not have any border and the group will also not have any border.\n- Contained - Each accordion will have no gap in between them and the border of the entire accordiongroup will be continuous.\n\nThere are two types of sizes:\n- Small: Small size has a padding of 1rem (16px) for both heading and body sections.\n- Large: Large size has a padding of 1.5rem (24px) for both heading and body sections.\n\nThe variant and size will be applied to all accordions inside this accordion group.\nTo show/expand more than one accordion at any given time, then set `allow-multiple` to `true`. By default, it's `false`.\n\nIf you don't need any controls on your accordion heading, then it's advised to use `accordionbutton` component.\n\nIf the first accordion of the accordion group is expanded by default, then the screen reader might loose focus when toggling the visibilty of the first accordion.",
487
- "name": "AccordionGroup",
488
- "cssProperties": [
489
- {
490
- "description": "The border color of the entire accordiongroup",
491
- "name": "--mdc-accordiongroup-border-color"
492
- }
493
- ],
494
- "slots": [
495
- {
496
- "description": "The default slot can contain the `accordion` or `accordionbutton` components.",
497
- "name": "default"
498
- }
499
- ],
500
- "members": [
501
- {
502
- "kind": "field",
503
- "name": "size",
504
- "type": {
505
- "text": "Size"
506
- },
507
- "description": "The size of the accordion item.",
508
- "default": "'small'",
509
- "attribute": "size",
510
- "reflects": true
511
- },
512
- {
513
- "kind": "field",
514
- "name": "variant",
515
- "type": {
516
- "text": "Variant"
517
- },
518
- "description": "The variant of the accordion item. Based on the variant, the styling of the accordion gets changed.",
519
- "default": "'stacked'",
520
- "attribute": "variant",
521
- "reflects": true
522
- },
523
- {
524
- "kind": "field",
525
- "name": "allowMultiple",
526
- "type": {
527
- "text": "boolean"
528
- },
529
- "default": "false",
530
- "description": "If true, multiple accordion items can be visible at the same time.",
531
- "attribute": "allow-multiple",
532
- "reflects": true
533
- },
534
- {
535
- "kind": "method",
536
- "name": "handleAccordionExpanded",
537
- "privacy": "private",
538
- "return": {
539
- "type": {
540
- "text": "void"
541
- }
542
- },
543
- "parameters": [
544
- {
545
- "name": "event",
546
- "type": {
547
- "text": "Event"
548
- },
549
- "description": "The event object from the 'shown' event."
550
- }
551
- ],
552
- "description": "Handles the 'shown' event for accordion items.\nIf `allowMultiple` is false, ensures that only one accordion item\nremains expanded by collapsing all other expanded items when a new item is expanded."
553
- },
554
- {
555
- "kind": "method",
556
- "name": "setChildrenAccordionAttributes",
557
- "privacy": "private",
558
- "return": {
559
- "type": {
560
- "text": "void"
561
- }
562
- },
563
- "parameters": [
564
- {
565
- "name": "attributeName",
566
- "type": {
567
- "text": "string"
568
- },
569
- "description": "The name of the attribute to set."
570
- },
571
- {
572
- "name": "attributeValue",
573
- "type": {
574
- "text": "string"
575
- },
576
- "description": "The value to set the attribute to."
577
- }
578
- ],
579
- "description": "Sets the given attribute on all child accordion or accordionbutton components."
580
- }
581
- ],
582
- "attributes": [
583
- {
584
- "name": "size",
585
- "type": {
586
- "text": "Size"
587
- },
588
- "description": "The size of the accordion item.",
589
- "default": "'small'",
590
- "fieldName": "size"
591
- },
592
- {
593
- "name": "variant",
594
- "type": {
595
- "text": "Variant"
596
- },
597
- "description": "The variant of the accordion item. Based on the variant, the styling of the accordion gets changed.",
598
- "default": "'stacked'",
599
- "fieldName": "variant"
600
- },
601
- {
602
- "name": "allow-multiple",
603
- "type": {
604
- "text": "boolean"
605
- },
606
- "default": "false",
607
- "description": "If true, multiple accordion items can be visible at the same time.",
608
- "fieldName": "allowMultiple"
609
- }
610
- ],
611
- "superclass": {
612
- "name": "Component",
613
- "module": "/src/models"
614
- },
615
- "tagName": "mdc-accordiongroup",
616
- "jsDoc": "/**\n * An accordion group is a vertically stacked set of interactive headings that each contain a header and body content.\n * Each heading of the accordion acts as a control that enable users to expand or hide their associated body sections of content.\n * Accordions are commonly used to reduce the need to scroll when presenting multiple sections of content on a single page.\n *\n * - Default Slot: The accordion group component only accepts, `accordion` and `accordionbutton` components as the children, rest are ignored.\n *\n * There are three types of variants:\n * - Stacked - Each accordion will have a gap of 1.5rem (24px).\n * - Borderless - Each accordion will not have any border and the group will also not have any border.\n * - Contained - Each accordion will have no gap in between them and the border of the entire accordiongroup will be continuous.\n *\n * There are two types of sizes:\n * - Small: Small size has a padding of 1rem (16px) for both heading and body sections.\n * - Large: Large size has a padding of 1.5rem (24px) for both heading and body sections.\n *\n * The variant and size will be applied to all accordions inside this accordion group.\n * To show/expand more than one accordion at any given time, then set `allow-multiple` to `true`. By default, it's `false`.\n *\n * If you don't need any controls on your accordion heading, then it's advised to use `accordionbutton` component.\n *\n * If the first accordion of the accordion group is expanded by default, then the screen reader might loose focus when toggling the visibilty of the first accordion.\n *\n * @tagname mdc-accordiongroup\n *\n * @slot default - The default slot can contain the `accordion` or `accordionbutton` components.\n *\n * @cssproperty --mdc-accordiongroup-border-color - The border color of the entire accordiongroup\n */",
617
- "customElement": true
618
- }
619
- ],
620
- "exports": [
621
- {
622
- "kind": "js",
623
- "name": "default",
624
- "declaration": {
625
- "name": "AccordionGroup",
626
- "module": "components/accordiongroup/accordiongroup.component.js"
627
- }
628
- }
629
- ]
630
- },
631
480
  {
632
481
  "kind": "javascript-module",
633
482
  "path": "components/accordionbutton/accordionbutton.component.js",
@@ -970,737 +819,888 @@
970
819
  },
971
820
  {
972
821
  "kind": "javascript-module",
973
- "path": "components/alertchip/alertchip.component.js",
822
+ "path": "components/accordiongroup/accordiongroup.component.js",
974
823
  "declarations": [
975
824
  {
976
825
  "kind": "class",
977
- "description": "mdc-alertchip component is an interactive chip that consumers can use to represent an alert.\n\n- It supports a leading icon along with label.\n- It supports 5 variants of alerts - neutral, warning, error, success, and informational\n\nThis component is built by extending Buttonsimple.",
978
- "name": "AlertChip",
826
+ "description": "An accordion group is a vertically stacked set of interactive headings that each contain a header and body content.\nEach heading of the accordion acts as a control that enable users to expand or hide their associated body sections of content.\nAccordions are commonly used to reduce the need to scroll when presenting multiple sections of content on a single page.\n\n- Default Slot: The accordion group component only accepts, `accordion` and `accordionbutton` components as the children, rest are ignored.\n\nThere are three types of variants:\n- Stacked - Each accordion will have a gap of 1.5rem (24px).\n- Borderless - Each accordion will not have any border and the group will also not have any border.\n- Contained - Each accordion will have no gap in between them and the border of the entire accordiongroup will be continuous.\n\nThere are two types of sizes:\n- Small: Small size has a padding of 1rem (16px) for both heading and body sections.\n- Large: Large size has a padding of 1.5rem (24px) for both heading and body sections.\n\nThe variant and size will be applied to all accordions inside this accordion group.\nTo show/expand more than one accordion at any given time, then set `allow-multiple` to `true`. By default, it's `false`.\n\nIf you don't need any controls on your accordion heading, then it's advised to use `accordionbutton` component.\n\nIf the first accordion of the accordion group is expanded by default, then the screen reader might loose focus when toggling the visibilty of the first accordion.",
827
+ "name": "AccordionGroup",
979
828
  "cssProperties": [
980
829
  {
981
- "description": "The color of the label text",
982
- "name": "--mdc-chip-color"
983
- },
984
- {
985
- "description": "The color of the icon",
986
- "name": "--mdc-chip-icon-color"
987
- },
988
- {
989
- "description": "The border color of the alertchip",
990
- "name": "--mdc-chip-border-color"
991
- },
992
- {
993
- "description": "The background color of the alertchip",
994
- "name": "--mdc-chip-background-color"
830
+ "description": "The border color of the entire accordiongroup",
831
+ "name": "--mdc-accordiongroup-border-color"
995
832
  }
996
833
  ],
997
- "cssParts": [
998
- {
999
- "description": "The alert icon",
1000
- "name": "icon"
1001
- },
834
+ "slots": [
1002
835
  {
1003
- "description": "The text label of the alertchip",
1004
- "name": "label"
836
+ "description": "The default slot can contain the `accordion` or `accordionbutton` components.",
837
+ "name": "default"
1005
838
  }
1006
839
  ],
1007
840
  "members": [
1008
841
  {
1009
842
  "kind": "field",
1010
- "name": "variant",
843
+ "name": "size",
1011
844
  "type": {
1012
- "text": "VariantType"
845
+ "text": "Size"
1013
846
  },
1014
- "description": "The variant of the alertchip. It supports 5 variants\n- neutral\n- warning\n- error\n- success\n- informational",
1015
- "default": "neutral",
1016
- "attribute": "variant"
847
+ "description": "The size of the accordion item.",
848
+ "default": "'small'",
849
+ "attribute": "size",
850
+ "reflects": true
1017
851
  },
1018
852
  {
1019
853
  "kind": "field",
1020
- "name": "label",
854
+ "name": "variant",
1021
855
  "type": {
1022
- "text": "string"
856
+ "text": "Variant"
1023
857
  },
1024
- "default": "''",
1025
- "description": "The visible label text of the alertchip.\n\nWe recommend limiting the <b>maximum length of the label text to 20 characters</b>,\nincluding empty spaces to split words.",
1026
- "attribute": "label"
858
+ "description": "The variant of the accordion item. Based on the variant, the styling of the accordion gets changed.",
859
+ "default": "'stacked'",
860
+ "attribute": "variant",
861
+ "reflects": true
1027
862
  },
1028
863
  {
1029
864
  "kind": "field",
1030
- "name": "autofocus",
865
+ "name": "allowMultiple",
1031
866
  "type": {
1032
867
  "text": "boolean"
1033
868
  },
1034
869
  "default": "false",
1035
- "description": "This property indicates whether the element should receive focus automatically when it is rendered.",
1036
- "attribute": "autofocus",
1037
- "reflects": true,
1038
- "inheritedFrom": {
1039
- "name": "AutoFocusMixin",
1040
- "module": "utils/mixins/AutoFocusMixin.js"
1041
- }
870
+ "description": "If true, multiple accordion items can be visible at the same time.",
871
+ "attribute": "allow-multiple",
872
+ "reflects": true
1042
873
  },
1043
874
  {
1044
- "kind": "field",
1045
- "name": "tabIndex",
1046
- "type": {
1047
- "text": "number"
875
+ "kind": "method",
876
+ "name": "handleAccordionExpanded",
877
+ "privacy": "private",
878
+ "return": {
879
+ "type": {
880
+ "text": "void"
881
+ }
1048
882
  },
1049
- "default": "0",
1050
- "description": "This property specifies the tab order of the element.",
1051
- "attribute": "tabIndex",
1052
- "reflects": true,
1053
- "inheritedFrom": {
1054
- "name": "TabIndexMixin",
1055
- "module": "utils/mixins/TabIndexMixin.js"
1056
- }
883
+ "parameters": [
884
+ {
885
+ "name": "event",
886
+ "type": {
887
+ "text": "Event"
888
+ },
889
+ "description": "The event object from the 'shown' event."
890
+ }
891
+ ],
892
+ "description": "Handles the 'shown' event for accordion items.\nIf `allowMultiple` is false, ensures that only one accordion item\nremains expanded by collapsing all other expanded items when a new item is expanded."
1057
893
  },
1058
894
  {
1059
- "kind": "field",
1060
- "name": "disabled",
1061
- "type": {
1062
- "text": "boolean | undefined"
1063
- },
1064
- "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
1065
- "default": "undefined",
1066
- "attribute": "disabled",
1067
- "reflects": true,
1068
- "inheritedFrom": {
1069
- "name": "DisabledMixin",
1070
- "module": "utils/mixins/DisabledMixin.js"
1071
- }
895
+ "kind": "method",
896
+ "name": "setChildrenAccordionAttributes",
897
+ "privacy": "private",
898
+ "return": {
899
+ "type": {
900
+ "text": "void"
901
+ }
902
+ },
903
+ "parameters": [
904
+ {
905
+ "name": "attributeName",
906
+ "type": {
907
+ "text": "string"
908
+ },
909
+ "description": "The name of the attribute to set."
910
+ },
911
+ {
912
+ "name": "attributeValue",
913
+ "type": {
914
+ "text": "string"
915
+ },
916
+ "description": "The value to set the attribute to."
917
+ }
918
+ ],
919
+ "description": "Sets the given attribute on all child accordion or accordionbutton components."
920
+ }
921
+ ],
922
+ "attributes": [
923
+ {
924
+ "name": "size",
925
+ "type": {
926
+ "text": "Size"
927
+ },
928
+ "description": "The size of the accordion item.",
929
+ "default": "'small'",
930
+ "fieldName": "size"
931
+ },
932
+ {
933
+ "name": "variant",
934
+ "type": {
935
+ "text": "Variant"
936
+ },
937
+ "description": "The variant of the accordion item. Based on the variant, the styling of the accordion gets changed.",
938
+ "default": "'stacked'",
939
+ "fieldName": "variant"
1072
940
  },
941
+ {
942
+ "name": "allow-multiple",
943
+ "type": {
944
+ "text": "boolean"
945
+ },
946
+ "default": "false",
947
+ "description": "If true, multiple accordion items can be visible at the same time.",
948
+ "fieldName": "allowMultiple"
949
+ }
950
+ ],
951
+ "superclass": {
952
+ "name": "Component",
953
+ "module": "/src/models"
954
+ },
955
+ "tagName": "mdc-accordiongroup",
956
+ "jsDoc": "/**\n * An accordion group is a vertically stacked set of interactive headings that each contain a header and body content.\n * Each heading of the accordion acts as a control that enable users to expand or hide their associated body sections of content.\n * Accordions are commonly used to reduce the need to scroll when presenting multiple sections of content on a single page.\n *\n * - Default Slot: The accordion group component only accepts, `accordion` and `accordionbutton` components as the children, rest are ignored.\n *\n * There are three types of variants:\n * - Stacked - Each accordion will have a gap of 1.5rem (24px).\n * - Borderless - Each accordion will not have any border and the group will also not have any border.\n * - Contained - Each accordion will have no gap in between them and the border of the entire accordiongroup will be continuous.\n *\n * There are two types of sizes:\n * - Small: Small size has a padding of 1rem (16px) for both heading and body sections.\n * - Large: Large size has a padding of 1.5rem (24px) for both heading and body sections.\n *\n * The variant and size will be applied to all accordions inside this accordion group.\n * To show/expand more than one accordion at any given time, then set `allow-multiple` to `true`. By default, it's `false`.\n *\n * If you don't need any controls on your accordion heading, then it's advised to use `accordionbutton` component.\n *\n * If the first accordion of the accordion group is expanded by default, then the screen reader might loose focus when toggling the visibilty of the first accordion.\n *\n * @tagname mdc-accordiongroup\n *\n * @slot default - The default slot can contain the `accordion` or `accordionbutton` components.\n *\n * @cssproperty --mdc-accordiongroup-border-color - The border color of the entire accordiongroup\n */",
957
+ "customElement": true
958
+ }
959
+ ],
960
+ "exports": [
961
+ {
962
+ "kind": "js",
963
+ "name": "default",
964
+ "declaration": {
965
+ "name": "AccordionGroup",
966
+ "module": "components/accordiongroup/accordiongroup.component.js"
967
+ }
968
+ }
969
+ ]
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": [
1073
980
  {
1074
981
  "kind": "field",
1075
- "name": "active",
982
+ "name": "name",
1076
983
  "type": {
1077
- "text": "boolean | undefined"
984
+ "text": "AnimationNames | undefined"
1078
985
  },
1079
- "description": "The button's active state indicates whether it is currently toggled on (active) or off (inactive).\nWhen the active state is true, the button is considered to be in an active state, meaning it is toggled on.\nConversely, when the active state is false, the button is in an inactive state, indicating it is toggled off.\n\nThis attribute is used to set the provided `ariaStateKey` to true or false.",
1080
- "default": "undefined",
1081
- "attribute": "active",
1082
- "reflects": true,
1083
- "inheritedFrom": {
1084
- "name": "Buttonsimple",
1085
- "module": "components/buttonsimple/buttonsimple.component.js"
1086
- }
986
+ "description": "Name of the animation (= filename)",
987
+ "attribute": "name",
988
+ "reflects": true
1087
989
  },
1088
990
  {
1089
991
  "kind": "field",
1090
- "name": "softDisabled",
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",
1091
1003
  "type": {
1092
1004
  "text": "boolean | undefined"
1093
1005
  },
1094
- "description": "Indicates whether the button is soft disabled.\nWhen set to `true`, the button appears visually disabled but still allows\nfocus, click, and keyboard actions to be passed through.\n\n**Important:** When using soft disabled, consumers must ensure that\nthe button behaves like a disabled button, allowing only focus and\npreventing any interactions (clicks or keyboard actions) from triggering unintended actions.",
1095
- "default": "undefined",
1096
- "attribute": "soft-disabled",
1097
- "reflects": true,
1098
- "inheritedFrom": {
1099
- "name": "Buttonsimple",
1100
- "module": "components/buttonsimple/buttonsimple.component.js"
1101
- }
1006
+ "description": "Weather start the animation automatically",
1007
+ "attribute": "autoplay",
1008
+ "reflects": true
1102
1009
  },
1103
1010
  {
1104
1011
  "kind": "field",
1105
- "name": "size",
1012
+ "name": "ariaLabel",
1106
1013
  "type": {
1107
- "text": "ButtonSize"
1014
+ "text": "string | null"
1108
1015
  },
1109
- "description": "Simplebutton size is a super set of all the sizes supported by children components.",
1110
- "default": "32",
1111
- "attribute": "size",
1112
- "reflects": true,
1113
- "inheritedFrom": {
1114
- "name": "Buttonsimple",
1115
- "module": "components/buttonsimple/buttonsimple.component.js"
1116
- }
1016
+ "default": "null",
1017
+ "description": "Aria-label attribute to be set for accessibility",
1018
+ "attribute": "aria-label"
1117
1019
  },
1118
1020
  {
1119
1021
  "kind": "field",
1120
- "name": "role",
1022
+ "name": "ariaLabelledBy",
1121
1023
  "type": {
1122
- "text": "RoleType"
1024
+ "text": "string | null"
1123
1025
  },
1124
- "description": "This property defines the ARIA role for the element. By default, it is set to 'button'.\nConsumers should override this role when:\n- The element is being used in a context where a different role is more appropriate.\n- Custom behaviors are implemented that require a specific ARIA role for accessibility purposes.",
1125
- "default": "button",
1126
- "attribute": "role",
1127
- "reflects": true,
1128
- "inheritedFrom": {
1129
- "name": "Buttonsimple",
1130
- "module": "components/buttonsimple/buttonsimple.component.js"
1131
- }
1026
+ "default": "null",
1027
+ "description": "Aria-labelledby attribute to be set for accessibility",
1028
+ "attribute": "aria-labelledby"
1132
1029
  },
1133
1030
  {
1134
1031
  "kind": "field",
1135
- "name": "ariaStateKey",
1032
+ "name": "lottieInstance",
1136
1033
  "type": {
1137
- "text": "string | undefined"
1034
+ "text": "AnimationItem | undefined"
1138
1035
  },
1139
- "description": "This property defines the ARIA state key, which will be toggled when the\nButton is set to `active`.\nThe default value is 'aria-pressed', which is commonly used for toggle buttons.\n\nConsumers can override this property to use a different ARIA state key if needed.\nIn case multiple aria attributes should be toggled, they can be passed in as\na comma separated string.\nFor example: `aria-pressed,aria-expanded`",
1140
- "default": "'aria-pressed' (when)",
1141
- "attribute": "ariaStateKey",
1142
- "reflects": true,
1143
- "inheritedFrom": {
1144
- "name": "Buttonsimple",
1145
- "module": "components/buttonsimple/buttonsimple.component.js"
1146
- }
1036
+ "privacy": "private",
1037
+ "description": "Lottie animation instance"
1147
1038
  },
1148
1039
  {
1149
1040
  "kind": "field",
1150
- "name": "type",
1041
+ "name": "containerRef",
1151
1042
  "type": {
1152
- "text": "ButtonType"
1043
+ "text": "Ref<HTMLDivElement>"
1153
1044
  },
1154
- "description": "This property defines the type attribute for the button element.\nThe type attribute specifies the behavior of the button when it is clicked.\n- **submit**: The button submits the form data to the server.\n- **reset**: The button resets the form data to its initial state.\n- **button**: The button does nothing when clicked.",
1155
- "default": "button",
1156
- "attribute": "type",
1157
- "reflects": true,
1158
- "inheritedFrom": {
1159
- "name": "Buttonsimple",
1160
- "module": "components/buttonsimple/buttonsimple.component.js"
1161
- }
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
1162
1053
  },
1163
1054
  {
1164
1055
  "kind": "method",
1165
- "name": "executeAction",
1166
- "privacy": "protected",
1167
- "inheritedFrom": {
1168
- "name": "Buttonsimple",
1169
- "module": "components/buttonsimple/buttonsimple.component.js"
1170
- }
1056
+ "name": "getLoopValue",
1057
+ "privacy": "private"
1171
1058
  },
1172
1059
  {
1173
1060
  "kind": "method",
1174
- "name": "setActive",
1175
- "privacy": "protected",
1061
+ "name": "onLoadSuccessHandler",
1062
+ "privacy": "private",
1176
1063
  "parameters": [
1177
1064
  {
1178
- "name": "element",
1179
- "type": {
1180
- "text": "HTMLElement"
1181
- },
1182
- "description": "The button element"
1183
- },
1184
- {
1185
- "name": "active",
1186
- "optional": true,
1065
+ "name": "animationData",
1187
1066
  "type": {
1188
- "text": "boolean"
1189
- },
1190
- "description": "The active state of the element"
1067
+ "text": "any"
1068
+ }
1191
1069
  }
1192
1070
  ],
1193
- "description": "Sets the ariaStateKey attributes based on the active state of the button.",
1194
- "inheritedFrom": {
1195
- "name": "Buttonsimple",
1196
- "module": "components/buttonsimple/buttonsimple.component.js"
1197
- }
1071
+ "description": "Create new lotty instance for the loaded data"
1198
1072
  },
1199
1073
  {
1200
1074
  "kind": "method",
1201
- "name": "setSoftDisabled",
1075
+ "name": "onLoadFailHandler",
1202
1076
  "privacy": "private",
1203
1077
  "parameters": [
1204
1078
  {
1205
- "name": "element",
1206
- "type": {
1207
- "text": "HTMLElement"
1208
- },
1209
- "description": "The button element."
1210
- },
1211
- {
1212
- "name": "softDisabled",
1213
- "optional": true,
1079
+ "name": "error",
1214
1080
  "type": {
1215
- "text": "boolean"
1216
- },
1217
- "description": "The soft-disabled state."
1081
+ "text": "Error"
1082
+ }
1218
1083
  }
1219
1084
  ],
1220
- "description": "Sets the soft-disabled attribute for the button.\nWhen soft-disabled, the button looks to be disabled but remains focusable and clickable.\nAlso sets/removes aria-disabled attribute.",
1221
- "inheritedFrom": {
1222
- "name": "Buttonsimple",
1223
- "module": "components/buttonsimple/buttonsimple.component.js"
1224
- }
1085
+ "description": "Error handler for animation loading"
1225
1086
  },
1226
1087
  {
1227
1088
  "kind": "method",
1228
- "name": "setDisabled",
1089
+ "name": "getAnimationData",
1229
1090
  "privacy": "private",
1230
- "parameters": [
1231
- {
1232
- "name": "element",
1233
- "type": {
1234
- "text": "HTMLElement"
1235
- },
1236
- "description": "The button element."
1237
- },
1238
- {
1239
- "name": "disabled",
1240
- "type": {
1241
- "text": "boolean"
1242
- },
1243
- "description": "The disabled state."
1244
- }
1245
- ],
1246
- "description": "Sets the disabled attribute for the button.\nWhen disabled, the button is not focusable or clickable, and tabindex is set to -1.\nThe previous tabindex is stored and restored when enabled.\nAlso sets/removes aria-disabled attribute.",
1247
- "inheritedFrom": {
1248
- "name": "Buttonsimple",
1249
- "module": "components/buttonsimple/buttonsimple.component.js"
1250
- }
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
+ {
1184
+ "kind": "javascript-module",
1185
+ "path": "components/alertchip/alertchip.component.js",
1186
+ "declarations": [
1187
+ {
1188
+ "kind": "class",
1189
+ "description": "mdc-alertchip component is an interactive chip that consumers can use to represent an alert.\n\n- It supports a leading icon along with label.\n- It supports 5 variants of alerts - neutral, warning, error, success, and informational\n\nThis component is built by extending Buttonsimple.",
1190
+ "name": "AlertChip",
1191
+ "cssProperties": [
1192
+ {
1193
+ "description": "The color of the label text",
1194
+ "name": "--mdc-chip-color"
1251
1195
  },
1252
1196
  {
1253
- "kind": "method",
1254
- "name": "triggerClickEvent",
1255
- "privacy": "private",
1256
- "inheritedFrom": {
1257
- "name": "Buttonsimple",
1258
- "module": "components/buttonsimple/buttonsimple.component.js"
1259
- }
1197
+ "description": "The color of the icon",
1198
+ "name": "--mdc-chip-icon-color"
1260
1199
  },
1261
1200
  {
1262
- "kind": "method",
1263
- "name": "handleBlur",
1264
- "privacy": "private",
1265
- "description": "In case the button is pressed and the focus is lost while pressing,\nthe pressed class is removed.",
1266
- "inheritedFrom": {
1267
- "name": "Buttonsimple",
1268
- "module": "components/buttonsimple/buttonsimple.component.js"
1269
- }
1201
+ "description": "The border color of the alertchip",
1202
+ "name": "--mdc-chip-border-color"
1270
1203
  },
1271
1204
  {
1272
- "kind": "method",
1273
- "name": "handleKeyDown",
1274
- "privacy": "private",
1275
- "parameters": [
1276
- {
1277
- "name": "event",
1278
- "type": {
1279
- "text": "KeyboardEvent"
1280
- },
1281
- "description": "The keyboard event."
1282
- }
1283
- ],
1284
- "description": "Handles the keydown event on the button.\nIf the key is 'Enter' or 'Space', the button is pressed.\nIf the key is 'Enter', the button is pressed. The native HTML button works in the same way.\nIf the key is 'Space', the button's default is prevent to avoid scrolling etc in the host application.",
1285
- "inheritedFrom": {
1286
- "name": "Buttonsimple",
1287
- "module": "components/buttonsimple/buttonsimple.component.js"
1288
- }
1205
+ "description": "The background color of the alertchip",
1206
+ "name": "--mdc-chip-background-color"
1207
+ }
1208
+ ],
1209
+ "cssParts": [
1210
+ {
1211
+ "description": "The alert icon",
1212
+ "name": "icon"
1289
1213
  },
1290
1214
  {
1291
- "kind": "method",
1292
- "name": "handleKeyUp",
1293
- "privacy": "private",
1294
- "parameters": [
1295
- {
1296
- "name": "event",
1297
- "type": {
1298
- "text": "KeyboardEvent"
1299
- },
1300
- "description": "The keyboard event."
1301
- }
1302
- ],
1303
- "description": "Handles the keyup event on the button.\nIf the key is 'Enter' or 'Space', the button is clicked.\nIf the key is 'Space', the button is pressed. The native HTML button works in the same way.",
1304
- "inheritedFrom": {
1305
- "name": "Buttonsimple",
1306
- "module": "components/buttonsimple/buttonsimple.component.js"
1307
- }
1215
+ "description": "The text label of the alertchip",
1216
+ "name": "label"
1308
1217
  }
1309
1218
  ],
1310
- "attributes": [
1219
+ "members": [
1311
1220
  {
1221
+ "kind": "field",
1312
1222
  "name": "variant",
1313
1223
  "type": {
1314
1224
  "text": "VariantType"
1315
1225
  },
1316
1226
  "description": "The variant of the alertchip. It supports 5 variants\n- neutral\n- warning\n- error\n- success\n- informational",
1317
1227
  "default": "neutral",
1318
- "fieldName": "variant"
1228
+ "attribute": "variant"
1319
1229
  },
1320
1230
  {
1231
+ "kind": "field",
1321
1232
  "name": "label",
1322
1233
  "type": {
1323
1234
  "text": "string"
1324
1235
  },
1325
1236
  "default": "''",
1326
1237
  "description": "The visible label text of the alertchip.\n\nWe recommend limiting the <b>maximum length of the label text to 20 characters</b>,\nincluding empty spaces to split words.",
1327
- "fieldName": "label"
1238
+ "attribute": "label"
1328
1239
  },
1329
1240
  {
1241
+ "kind": "field",
1330
1242
  "name": "autofocus",
1331
1243
  "type": {
1332
1244
  "text": "boolean"
1333
1245
  },
1334
1246
  "default": "false",
1335
1247
  "description": "This property indicates whether the element should receive focus automatically when it is rendered.",
1336
- "fieldName": "autofocus",
1248
+ "attribute": "autofocus",
1249
+ "reflects": true,
1337
1250
  "inheritedFrom": {
1338
1251
  "name": "AutoFocusMixin",
1339
- "module": "src/utils/mixins/AutoFocusMixin.ts"
1252
+ "module": "utils/mixins/AutoFocusMixin.js"
1340
1253
  }
1341
1254
  },
1342
1255
  {
1256
+ "kind": "field",
1343
1257
  "name": "tabIndex",
1344
1258
  "type": {
1345
1259
  "text": "number"
1346
1260
  },
1347
1261
  "default": "0",
1348
1262
  "description": "This property specifies the tab order of the element.",
1349
- "fieldName": "tabIndex",
1263
+ "attribute": "tabIndex",
1264
+ "reflects": true,
1350
1265
  "inheritedFrom": {
1351
1266
  "name": "TabIndexMixin",
1352
- "module": "src/utils/mixins/TabIndexMixin.ts"
1267
+ "module": "utils/mixins/TabIndexMixin.js"
1353
1268
  }
1354
1269
  },
1355
1270
  {
1271
+ "kind": "field",
1356
1272
  "name": "disabled",
1357
1273
  "type": {
1358
1274
  "text": "boolean | undefined"
1359
1275
  },
1360
1276
  "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
1361
1277
  "default": "undefined",
1362
- "fieldName": "disabled",
1278
+ "attribute": "disabled",
1279
+ "reflects": true,
1363
1280
  "inheritedFrom": {
1364
1281
  "name": "DisabledMixin",
1365
- "module": "src/utils/mixins/DisabledMixin.ts"
1282
+ "module": "utils/mixins/DisabledMixin.js"
1366
1283
  }
1367
1284
  },
1368
1285
  {
1286
+ "kind": "field",
1369
1287
  "name": "active",
1370
1288
  "type": {
1371
1289
  "text": "boolean | undefined"
1372
1290
  },
1373
1291
  "description": "The button's active state indicates whether it is currently toggled on (active) or off (inactive).\nWhen the active state is true, the button is considered to be in an active state, meaning it is toggled on.\nConversely, when the active state is false, the button is in an inactive state, indicating it is toggled off.\n\nThis attribute is used to set the provided `ariaStateKey` to true or false.",
1374
1292
  "default": "undefined",
1375
- "fieldName": "active",
1293
+ "attribute": "active",
1294
+ "reflects": true,
1376
1295
  "inheritedFrom": {
1377
1296
  "name": "Buttonsimple",
1378
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
1297
+ "module": "components/buttonsimple/buttonsimple.component.js"
1379
1298
  }
1380
1299
  },
1381
1300
  {
1382
- "name": "soft-disabled",
1301
+ "kind": "field",
1302
+ "name": "softDisabled",
1383
1303
  "type": {
1384
1304
  "text": "boolean | undefined"
1385
1305
  },
1386
1306
  "description": "Indicates whether the button is soft disabled.\nWhen set to `true`, the button appears visually disabled but still allows\nfocus, click, and keyboard actions to be passed through.\n\n**Important:** When using soft disabled, consumers must ensure that\nthe button behaves like a disabled button, allowing only focus and\npreventing any interactions (clicks or keyboard actions) from triggering unintended actions.",
1387
1307
  "default": "undefined",
1388
- "fieldName": "softDisabled",
1308
+ "attribute": "soft-disabled",
1309
+ "reflects": true,
1389
1310
  "inheritedFrom": {
1390
1311
  "name": "Buttonsimple",
1391
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
1312
+ "module": "components/buttonsimple/buttonsimple.component.js"
1392
1313
  }
1393
1314
  },
1394
1315
  {
1316
+ "kind": "field",
1395
1317
  "name": "size",
1396
1318
  "type": {
1397
1319
  "text": "ButtonSize"
1398
1320
  },
1399
1321
  "description": "Simplebutton size is a super set of all the sizes supported by children components.",
1400
1322
  "default": "32",
1401
- "fieldName": "size",
1323
+ "attribute": "size",
1324
+ "reflects": true,
1402
1325
  "inheritedFrom": {
1403
1326
  "name": "Buttonsimple",
1404
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
1327
+ "module": "components/buttonsimple/buttonsimple.component.js"
1405
1328
  }
1406
1329
  },
1407
1330
  {
1331
+ "kind": "field",
1408
1332
  "name": "role",
1409
1333
  "type": {
1410
1334
  "text": "RoleType"
1411
1335
  },
1412
1336
  "description": "This property defines the ARIA role for the element. By default, it is set to 'button'.\nConsumers should override this role when:\n- The element is being used in a context where a different role is more appropriate.\n- Custom behaviors are implemented that require a specific ARIA role for accessibility purposes.",
1413
1337
  "default": "button",
1414
- "fieldName": "role",
1338
+ "attribute": "role",
1339
+ "reflects": true,
1415
1340
  "inheritedFrom": {
1416
1341
  "name": "Buttonsimple",
1417
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
1342
+ "module": "components/buttonsimple/buttonsimple.component.js"
1418
1343
  }
1419
1344
  },
1420
1345
  {
1346
+ "kind": "field",
1421
1347
  "name": "ariaStateKey",
1422
1348
  "type": {
1423
1349
  "text": "string | undefined"
1424
1350
  },
1425
1351
  "description": "This property defines the ARIA state key, which will be toggled when the\nButton is set to `active`.\nThe default value is 'aria-pressed', which is commonly used for toggle buttons.\n\nConsumers can override this property to use a different ARIA state key if needed.\nIn case multiple aria attributes should be toggled, they can be passed in as\na comma separated string.\nFor example: `aria-pressed,aria-expanded`",
1426
1352
  "default": "'aria-pressed' (when)",
1427
- "fieldName": "ariaStateKey",
1353
+ "attribute": "ariaStateKey",
1354
+ "reflects": true,
1428
1355
  "inheritedFrom": {
1429
1356
  "name": "Buttonsimple",
1430
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
1357
+ "module": "components/buttonsimple/buttonsimple.component.js"
1431
1358
  }
1432
1359
  },
1433
1360
  {
1361
+ "kind": "field",
1434
1362
  "name": "type",
1435
1363
  "type": {
1436
1364
  "text": "ButtonType"
1437
1365
  },
1438
1366
  "description": "This property defines the type attribute for the button element.\nThe type attribute specifies the behavior of the button when it is clicked.\n- **submit**: The button submits the form data to the server.\n- **reset**: The button resets the form data to its initial state.\n- **button**: The button does nothing when clicked.",
1439
1367
  "default": "button",
1440
- "fieldName": "type",
1441
- "inheritedFrom": {
1442
- "name": "Buttonsimple",
1443
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
1444
- }
1445
- }
1446
- ],
1447
- "superclass": {
1448
- "name": "Buttonsimple",
1449
- "module": "/src/components/buttonsimple/buttonsimple.component"
1450
- },
1451
- "tagName": "mdc-alertchip",
1452
- "jsDoc": "/**\n * mdc-alertchip component is an interactive chip that consumers can use to represent an alert.\n *\n * - It supports a leading icon along with label.\n * - It supports 5 variants of alerts - neutral, warning, error, success, and informational\n *\n * This component is built by extending Buttonsimple.\n *\n * @tagname mdc-alertchip\n *\n * @dependency mdc-icon\n * @dependency mdc-text\n *\n * @cssproperty --mdc-chip-color - The color of the label text\n * @cssproperty --mdc-chip-icon-color - The color of the icon\n * @cssproperty --mdc-chip-border-color - The border color of the alertchip\n * @cssproperty --mdc-chip-background-color - The background color of the alertchip\n *\n * @csspart icon - The alert icon\n * @csspart label - The text label of the alertchip\n */",
1453
- "customElement": true,
1454
- "events": [
1455
- {
1456
- "description": "(React: onClick) This event is dispatched when the button is clicked.",
1457
- "name": "click",
1458
- "reactName": "onClick",
1459
- "inheritedFrom": {
1460
- "name": "Buttonsimple",
1461
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
1462
- }
1463
- },
1464
- {
1465
- "description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the button.",
1466
- "name": "keydown",
1467
- "reactName": "onKeyDown",
1468
- "inheritedFrom": {
1469
- "name": "Buttonsimple",
1470
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
1471
- }
1472
- },
1473
- {
1474
- "description": "(React: onKeyUp) This event is dispatched when a key is released on the button.",
1475
- "name": "keyup",
1476
- "reactName": "onKeyUp",
1368
+ "attribute": "type",
1369
+ "reflects": true,
1477
1370
  "inheritedFrom": {
1478
1371
  "name": "Buttonsimple",
1479
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
1372
+ "module": "components/buttonsimple/buttonsimple.component.js"
1480
1373
  }
1481
1374
  },
1482
1375
  {
1483
- "description": "(React: onFocus) This event is dispatched when the button receives focus.",
1484
- "name": "focus",
1485
- "reactName": "onFocus",
1376
+ "kind": "method",
1377
+ "name": "executeAction",
1378
+ "privacy": "protected",
1486
1379
  "inheritedFrom": {
1487
1380
  "name": "Buttonsimple",
1488
- "module": "src/components/buttonsimple/buttonsimple.component.ts"
1381
+ "module": "components/buttonsimple/buttonsimple.component.js"
1489
1382
  }
1490
- }
1491
- ]
1492
- }
1493
- ],
1494
- "exports": [
1495
- {
1496
- "kind": "js",
1497
- "name": "default",
1498
- "declaration": {
1499
- "name": "AlertChip",
1500
- "module": "components/alertchip/alertchip.component.js"
1501
- }
1502
- }
1503
- ]
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
1383
  },
1554
1384
  {
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"
1385
+ "kind": "method",
1386
+ "name": "setActive",
1387
+ "privacy": "protected",
1388
+ "parameters": [
1389
+ {
1390
+ "name": "element",
1391
+ "type": {
1392
+ "text": "HTMLElement"
1393
+ },
1394
+ "description": "The button element"
1395
+ },
1396
+ {
1397
+ "name": "active",
1398
+ "optional": true,
1399
+ "type": {
1400
+ "text": "boolean"
1401
+ },
1402
+ "description": "The active state of the element"
1403
+ }
1404
+ ],
1405
+ "description": "Sets the ariaStateKey attributes based on the active state of the button.",
1406
+ "inheritedFrom": {
1407
+ "name": "Buttonsimple",
1408
+ "module": "components/buttonsimple/buttonsimple.component.js"
1409
+ }
1563
1410
  },
1564
1411
  {
1565
- "kind": "field",
1566
- "name": "lottieInstance",
1567
- "type": {
1568
- "text": "AnimationItem | undefined"
1569
- },
1412
+ "kind": "method",
1413
+ "name": "setSoftDisabled",
1570
1414
  "privacy": "private",
1571
- "description": "Lottie animation instance"
1415
+ "parameters": [
1416
+ {
1417
+ "name": "element",
1418
+ "type": {
1419
+ "text": "HTMLElement"
1420
+ },
1421
+ "description": "The button element."
1422
+ },
1423
+ {
1424
+ "name": "softDisabled",
1425
+ "optional": true,
1426
+ "type": {
1427
+ "text": "boolean"
1428
+ },
1429
+ "description": "The soft-disabled state."
1430
+ }
1431
+ ],
1432
+ "description": "Sets the soft-disabled attribute for the button.\nWhen soft-disabled, the button looks to be disabled but remains focusable and clickable.\nAlso sets/removes aria-disabled attribute.",
1433
+ "inheritedFrom": {
1434
+ "name": "Buttonsimple",
1435
+ "module": "components/buttonsimple/buttonsimple.component.js"
1436
+ }
1572
1437
  },
1573
1438
  {
1574
- "kind": "field",
1575
- "name": "containerRef",
1576
- "type": {
1577
- "text": "Ref<HTMLDivElement>"
1578
- },
1439
+ "kind": "method",
1440
+ "name": "setDisabled",
1579
1441
  "privacy": "private",
1580
- "description": "Container for the animation"
1442
+ "parameters": [
1443
+ {
1444
+ "name": "element",
1445
+ "type": {
1446
+ "text": "HTMLElement"
1447
+ },
1448
+ "description": "The button element."
1449
+ },
1450
+ {
1451
+ "name": "disabled",
1452
+ "type": {
1453
+ "text": "boolean"
1454
+ },
1455
+ "description": "The disabled state."
1456
+ }
1457
+ ],
1458
+ "description": "Sets the disabled attribute for the button.\nWhen disabled, the button is not focusable or clickable, and tabindex is set to -1.\nThe previous tabindex is stored and restored when enabled.\nAlso sets/removes aria-disabled attribute.",
1459
+ "inheritedFrom": {
1460
+ "name": "Buttonsimple",
1461
+ "module": "components/buttonsimple/buttonsimple.component.js"
1462
+ }
1581
1463
  },
1582
1464
  {
1583
- "kind": "field",
1584
- "name": "animation",
1585
- "description": "Exposed API of the animation library (lottie)",
1586
- "readonly": true
1465
+ "kind": "method",
1466
+ "name": "triggerClickEvent",
1467
+ "privacy": "private",
1468
+ "inheritedFrom": {
1469
+ "name": "Buttonsimple",
1470
+ "module": "components/buttonsimple/buttonsimple.component.js"
1471
+ }
1587
1472
  },
1588
1473
  {
1589
1474
  "kind": "method",
1590
- "name": "getLoopValue",
1591
- "privacy": "private"
1475
+ "name": "handleBlur",
1476
+ "privacy": "private",
1477
+ "description": "In case the button is pressed and the focus is lost while pressing,\nthe pressed class is removed.",
1478
+ "inheritedFrom": {
1479
+ "name": "Buttonsimple",
1480
+ "module": "components/buttonsimple/buttonsimple.component.js"
1481
+ }
1592
1482
  },
1593
1483
  {
1594
1484
  "kind": "method",
1595
- "name": "onLoadSuccessHandler",
1485
+ "name": "handleKeyDown",
1596
1486
  "privacy": "private",
1597
1487
  "parameters": [
1598
1488
  {
1599
- "name": "animationData",
1489
+ "name": "event",
1600
1490
  "type": {
1601
- "text": "any"
1602
- }
1491
+ "text": "KeyboardEvent"
1492
+ },
1493
+ "description": "The keyboard event."
1603
1494
  }
1604
1495
  ],
1605
- "description": "Create new lotty instance for the loaded data"
1496
+ "description": "Handles the keydown event on the button.\nIf the key is 'Enter' or 'Space', the button is pressed.\nIf the key is 'Enter', the button is pressed. The native HTML button works in the same way.\nIf the key is 'Space', the button's default is prevent to avoid scrolling etc in the host application.",
1497
+ "inheritedFrom": {
1498
+ "name": "Buttonsimple",
1499
+ "module": "components/buttonsimple/buttonsimple.component.js"
1500
+ }
1606
1501
  },
1607
1502
  {
1608
1503
  "kind": "method",
1609
- "name": "onLoadFailHandler",
1504
+ "name": "handleKeyUp",
1610
1505
  "privacy": "private",
1611
1506
  "parameters": [
1612
1507
  {
1613
- "name": "error",
1508
+ "name": "event",
1614
1509
  "type": {
1615
- "text": "Error"
1616
- }
1510
+ "text": "KeyboardEvent"
1511
+ },
1512
+ "description": "The keyboard event."
1617
1513
  }
1618
1514
  ],
1619
- "description": "Error handler for animation loading"
1515
+ "description": "Handles the keyup event on the button.\nIf the key is 'Enter' or 'Space', the button is clicked.\nIf the key is 'Space', the button is pressed. The native HTML button works in the same way.",
1516
+ "inheritedFrom": {
1517
+ "name": "Buttonsimple",
1518
+ "module": "components/buttonsimple/buttonsimple.component.js"
1519
+ }
1520
+ }
1521
+ ],
1522
+ "attributes": [
1523
+ {
1524
+ "name": "variant",
1525
+ "type": {
1526
+ "text": "VariantType"
1527
+ },
1528
+ "description": "The variant of the alertchip. It supports 5 variants\n- neutral\n- warning\n- error\n- success\n- informational",
1529
+ "default": "neutral",
1530
+ "fieldName": "variant"
1620
1531
  },
1621
1532
  {
1622
- "kind": "method",
1623
- "name": "getAnimationData",
1624
- "privacy": "private",
1625
- "description": "Import animation data dynamically"
1533
+ "name": "label",
1534
+ "type": {
1535
+ "text": "string"
1536
+ },
1537
+ "default": "''",
1538
+ "description": "The visible label text of the alertchip.\n\nWe recommend limiting the <b>maximum length of the label text to 20 characters</b>,\nincluding empty spaces to split words.",
1539
+ "fieldName": "label"
1626
1540
  },
1627
1541
  {
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": [
1542
+ "name": "autofocus",
1543
+ "type": {
1544
+ "text": "boolean"
1545
+ },
1546
+ "default": "false",
1547
+ "description": "This property indicates whether the element should receive focus automatically when it is rendered.",
1548
+ "fieldName": "autofocus",
1549
+ "inheritedFrom": {
1550
+ "name": "AutoFocusMixin",
1551
+ "module": "src/utils/mixins/AutoFocusMixin.ts"
1552
+ }
1553
+ },
1634
1554
  {
1635
- "name": "load",
1555
+ "name": "tabIndex",
1636
1556
  "type": {
1637
- "text": "CustomEvent"
1557
+ "text": "number"
1638
1558
  },
1639
- "description": "(React: onLoad) This event is dispatched when the animation is loaded",
1640
- "reactName": "onLoad"
1559
+ "default": "0",
1560
+ "description": "This property specifies the tab order of the element.",
1561
+ "fieldName": "tabIndex",
1562
+ "inheritedFrom": {
1563
+ "name": "TabIndexMixin",
1564
+ "module": "src/utils/mixins/TabIndexMixin.ts"
1565
+ }
1641
1566
  },
1642
1567
  {
1643
- "description": "(React: onComplete) This event is dispatched when all animation loops completed",
1644
- "name": "complete",
1645
- "reactName": "onComplete"
1568
+ "name": "disabled",
1569
+ "type": {
1570
+ "text": "boolean | undefined"
1571
+ },
1572
+ "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
1573
+ "default": "undefined",
1574
+ "fieldName": "disabled",
1575
+ "inheritedFrom": {
1576
+ "name": "DisabledMixin",
1577
+ "module": "src/utils/mixins/DisabledMixin.ts"
1578
+ }
1646
1579
  },
1647
1580
  {
1648
- "description": "(React: onError) This event is dispatched when animation loading failed",
1649
- "name": "error",
1650
- "reactName": "onError"
1651
- }
1652
- ],
1653
- "attributes": [
1581
+ "name": "active",
1582
+ "type": {
1583
+ "text": "boolean | undefined"
1584
+ },
1585
+ "description": "The button's active state indicates whether it is currently toggled on (active) or off (inactive).\nWhen the active state is true, the button is considered to be in an active state, meaning it is toggled on.\nConversely, when the active state is false, the button is in an inactive state, indicating it is toggled off.\n\nThis attribute is used to set the provided `ariaStateKey` to true or false.",
1586
+ "default": "undefined",
1587
+ "fieldName": "active",
1588
+ "inheritedFrom": {
1589
+ "name": "Buttonsimple",
1590
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
1591
+ }
1592
+ },
1654
1593
  {
1655
- "name": "name",
1594
+ "name": "soft-disabled",
1656
1595
  "type": {
1657
- "text": "AnimationNames | undefined"
1596
+ "text": "boolean | undefined"
1658
1597
  },
1659
- "description": "Name of the animation (= filename)",
1660
- "fieldName": "name"
1598
+ "description": "Indicates whether the button is soft disabled.\nWhen set to `true`, the button appears visually disabled but still allows\nfocus, click, and keyboard actions to be passed through.\n\n**Important:** When using soft disabled, consumers must ensure that\nthe button behaves like a disabled button, allowing only focus and\npreventing any interactions (clicks or keyboard actions) from triggering unintended actions.",
1599
+ "default": "undefined",
1600
+ "fieldName": "softDisabled",
1601
+ "inheritedFrom": {
1602
+ "name": "Buttonsimple",
1603
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
1604
+ }
1661
1605
  },
1662
1606
  {
1663
- "name": "loop",
1607
+ "name": "size",
1664
1608
  "type": {
1665
- "text": "LoopType | undefined"
1609
+ "text": "ButtonSize"
1666
1610
  },
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"
1611
+ "description": "Simplebutton size is a super set of all the sizes supported by children components.",
1612
+ "default": "32",
1613
+ "fieldName": "size",
1614
+ "inheritedFrom": {
1615
+ "name": "Buttonsimple",
1616
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
1617
+ }
1669
1618
  },
1670
1619
  {
1671
- "name": "autoplay",
1620
+ "name": "role",
1672
1621
  "type": {
1673
- "text": "boolean | undefined"
1622
+ "text": "RoleType"
1674
1623
  },
1675
- "description": "Weather start the animation automatically",
1676
- "fieldName": "autoplay"
1624
+ "description": "This property defines the ARIA role for the element. By default, it is set to 'button'.\nConsumers should override this role when:\n- The element is being used in a context where a different role is more appropriate.\n- Custom behaviors are implemented that require a specific ARIA role for accessibility purposes.",
1625
+ "default": "button",
1626
+ "fieldName": "role",
1627
+ "inheritedFrom": {
1628
+ "name": "Buttonsimple",
1629
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
1630
+ }
1677
1631
  },
1678
1632
  {
1679
- "name": "aria-label",
1633
+ "name": "ariaStateKey",
1680
1634
  "type": {
1681
- "text": "string | null"
1635
+ "text": "string | undefined"
1682
1636
  },
1683
- "default": "null",
1684
- "description": "Aria-label attribute to be set for accessibility",
1685
- "fieldName": "ariaLabel"
1637
+ "description": "This property defines the ARIA state key, which will be toggled when the\nButton is set to `active`.\nThe default value is 'aria-pressed', which is commonly used for toggle buttons.\n\nConsumers can override this property to use a different ARIA state key if needed.\nIn case multiple aria attributes should be toggled, they can be passed in as\na comma separated string.\nFor example: `aria-pressed,aria-expanded`",
1638
+ "default": "'aria-pressed' (when)",
1639
+ "fieldName": "ariaStateKey",
1640
+ "inheritedFrom": {
1641
+ "name": "Buttonsimple",
1642
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
1643
+ }
1686
1644
  },
1687
1645
  {
1688
- "name": "aria-labelledby",
1646
+ "name": "type",
1689
1647
  "type": {
1690
- "text": "string | null"
1648
+ "text": "ButtonType"
1691
1649
  },
1692
- "default": "null",
1693
- "description": "Aria-labelledby attribute to be set for accessibility",
1694
- "fieldName": "ariaLabelledBy"
1650
+ "description": "This property defines the type attribute for the button element.\nThe type attribute specifies the behavior of the button when it is clicked.\n- **submit**: The button submits the form data to the server.\n- **reset**: The button resets the form data to its initial state.\n- **button**: The button does nothing when clicked.",
1651
+ "default": "button",
1652
+ "fieldName": "type",
1653
+ "inheritedFrom": {
1654
+ "name": "Buttonsimple",
1655
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
1656
+ }
1695
1657
  }
1696
1658
  ],
1697
1659
  "superclass": {
1698
- "name": "Component",
1699
- "module": "/src/models"
1660
+ "name": "Buttonsimple",
1661
+ "module": "/src/components/buttonsimple/buttonsimple.component"
1700
1662
  },
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
1663
+ "tagName": "mdc-alertchip",
1664
+ "jsDoc": "/**\n * mdc-alertchip component is an interactive chip that consumers can use to represent an alert.\n *\n * - It supports a leading icon along with label.\n * - It supports 5 variants of alerts - neutral, warning, error, success, and informational\n *\n * This component is built by extending Buttonsimple.\n *\n * @tagname mdc-alertchip\n *\n * @dependency mdc-icon\n * @dependency mdc-text\n *\n * @cssproperty --mdc-chip-color - The color of the label text\n * @cssproperty --mdc-chip-icon-color - The color of the icon\n * @cssproperty --mdc-chip-border-color - The border color of the alertchip\n * @cssproperty --mdc-chip-background-color - The background color of the alertchip\n *\n * @csspart icon - The alert icon\n * @csspart label - The text label of the alertchip\n */",
1665
+ "customElement": true,
1666
+ "events": [
1667
+ {
1668
+ "description": "(React: onClick) This event is dispatched when the button is clicked.",
1669
+ "name": "click",
1670
+ "reactName": "onClick",
1671
+ "inheritedFrom": {
1672
+ "name": "Buttonsimple",
1673
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
1674
+ }
1675
+ },
1676
+ {
1677
+ "description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the button.",
1678
+ "name": "keydown",
1679
+ "reactName": "onKeyDown",
1680
+ "inheritedFrom": {
1681
+ "name": "Buttonsimple",
1682
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
1683
+ }
1684
+ },
1685
+ {
1686
+ "description": "(React: onKeyUp) This event is dispatched when a key is released on the button.",
1687
+ "name": "keyup",
1688
+ "reactName": "onKeyUp",
1689
+ "inheritedFrom": {
1690
+ "name": "Buttonsimple",
1691
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
1692
+ }
1693
+ },
1694
+ {
1695
+ "description": "(React: onFocus) This event is dispatched when the button receives focus.",
1696
+ "name": "focus",
1697
+ "reactName": "onFocus",
1698
+ "inheritedFrom": {
1699
+ "name": "Buttonsimple",
1700
+ "module": "src/components/buttonsimple/buttonsimple.component.ts"
1701
+ }
1702
+ }
1703
+ ]
1704
1704
  }
1705
1705
  ],
1706
1706
  "exports": [
@@ -1708,8 +1708,8 @@
1708
1708
  "kind": "js",
1709
1709
  "name": "default",
1710
1710
  "declaration": {
1711
- "name": "Animation",
1712
- "module": "components/animation/animation.component.js"
1711
+ "name": "AlertChip",
1712
+ "module": "components/alertchip/alertchip.component.js"
1713
1713
  }
1714
1714
  }
1715
1715
  ]
@@ -7071,778 +7071,864 @@
7071
7071
  },
7072
7072
  {
7073
7073
  "kind": "javascript-module",
7074
- "path": "components/cardradio/cardradio.component.js",
7074
+ "path": "components/checkbox/checkbox.component.js",
7075
7075
  "declarations": [
7076
7076
  {
7077
7077
  "kind": "class",
7078
- "description": "cardradio component extends `mdc-card` and supports radio selection interaction addtionally.\n\nWhile using this component within a form or group of cards, make sure cards are in a role = \"radio-group\".\nThis card would have events for selected and unselected (similar to radio)\n\n**Note**: This is a single selection card i.e. interacting anywhere on the card would toggle the checked state.\nMake sure to pass only non-interactable elements within the slots.\n\nMake sure to pass the `card-title` mandatorily for this card.",
7079
- "name": "CardRadio",
7078
+ "description": "Checkboxes allow users to select multiple options from a list or turn an item/feature on or off.\nThese are often used in forms, settings, and selections in lists.\n\nA checkbox component contains an optional label and an optional helper text.\n\nTo create a group of checkboxes, use the FormFieldGroup component.",
7079
+ "name": "Checkbox",
7080
7080
  "cssProperties": [
7081
7081
  {
7082
- "description": "The width of the card",
7083
- "name": "--mdc-card-width",
7084
- "inheritedFrom": {
7085
- "name": "Card",
7086
- "module": "src/components/card/card.component.ts"
7087
- }
7082
+ "description": "Allows customization of the background color on hover.",
7083
+ "name": "--mdc-checkbox-background-color-hover"
7084
+ },
7085
+ {
7086
+ "description": "Background color for a selected checkbox when hovered.",
7087
+ "name": "--mdc-checkbox-checked-background-color-hover"
7088
+ },
7089
+ {
7090
+ "description": "Background color for a selected checkbox when pressed.",
7091
+ "name": "--mdc-checkbox-checked-pressed-icon-color"
7092
+ },
7093
+ {
7094
+ "description": "Background color for a selected checkbox when pressed.",
7095
+ "name": "--mdc-checkbox-pressed-icon-color"
7096
+ },
7097
+ {
7098
+ "description": "Background color for a selected checkbox when disabled.",
7099
+ "name": "--mdc-checkbox-disabled-checked-icon-color"
7088
7100
  }
7089
7101
  ],
7090
- "cssParts": [
7102
+ "members": [
7091
7103
  {
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
- }
7104
+ "kind": "field",
7105
+ "name": "checked",
7106
+ "type": {
7107
+ "text": "boolean"
7108
+ },
7109
+ "default": "false",
7110
+ "description": "Determines whether the checkbox is selected or unselected.",
7111
+ "attribute": "checked",
7112
+ "reflects": true
7098
7113
  },
7099
7114
  {
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
- }
7115
+ "kind": "field",
7116
+ "name": "indeterminate",
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
7106
7124
  },
7107
7125
  {
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
- }
7126
+ "kind": "field",
7127
+ "name": "autofocus",
7128
+ "type": {
7129
+ "text": "boolean"
7130
+ },
7131
+ "default": "false",
7132
+ "description": "Automatically focus on the element when the page loads.\n[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/autofocus)",
7133
+ "attribute": "autofocus",
7134
+ "reflects": true
7114
7135
  },
7115
7136
  {
7116
- "description": "The image part of the card",
7117
- "name": "image",
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."
7141
+ },
7142
+ {
7143
+ "kind": "method",
7144
+ "name": "manageRequired",
7145
+ "privacy": "private",
7146
+ "description": "Manages the required state of the checkbox.\nIf the checkbox is not checked and the required property is set, then the checkbox is invalid."
7147
+ },
7148
+ {
7149
+ "kind": "method",
7150
+ "name": "toggleState",
7151
+ "privacy": "private",
7152
+ "return": {
7153
+ "type": {
7154
+ "text": "void"
7155
+ }
7156
+ },
7157
+ "description": "Toggles the state of the checkbox element.\nIf the element is not disabled, then\nthe checked property is toggled and the indeterminate property is set to false."
7158
+ },
7159
+ {
7160
+ "kind": "method",
7161
+ "name": "handleKeyDown",
7162
+ "privacy": "private",
7163
+ "return": {
7164
+ "type": {
7165
+ "text": "void"
7166
+ }
7167
+ },
7168
+ "parameters": [
7169
+ {
7170
+ "name": "event",
7171
+ "type": {
7172
+ "text": "KeyboardEvent"
7173
+ },
7174
+ "description": "The keyboard event."
7175
+ }
7176
+ ],
7177
+ "description": "Handles the keydown event on the checkbox.\nWhen the user presses Enter, the form is submitted."
7178
+ },
7179
+ {
7180
+ "kind": "method",
7181
+ "name": "handleChange",
7182
+ "privacy": "public",
7183
+ "return": {
7184
+ "type": {
7185
+ "text": "void"
7186
+ }
7187
+ },
7188
+ "parameters": [
7189
+ {
7190
+ "name": "event",
7191
+ "type": {
7192
+ "text": "Event"
7193
+ }
7194
+ }
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,
7118
7213
  "inheritedFrom": {
7119
- "name": "Card",
7120
- "module": "src/components/card/card.component.ts"
7214
+ "name": "FormInternalsMixin",
7215
+ "module": "utils/mixins/FormInternalsMixin.js"
7121
7216
  }
7122
7217
  },
7123
7218
  {
7124
- "description": "The footer part of the card",
7125
- "name": "footer",
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,
7126
7228
  "inheritedFrom": {
7127
- "name": "Card",
7128
- "module": "src/components/card/card.component.ts"
7229
+ "name": "FormInternalsMixin",
7230
+ "module": "utils/mixins/FormInternalsMixin.js"
7129
7231
  }
7130
7232
  },
7131
7233
  {
7132
- "description": "The link part of the card footer",
7133
- "name": "footer-link",
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,
7134
7242
  "inheritedFrom": {
7135
- "name": "Card",
7136
- "module": "src/components/card/card.component.ts"
7243
+ "name": "FormInternalsMixin",
7244
+ "module": "utils/mixins/FormInternalsMixin.js"
7137
7245
  }
7138
7246
  },
7139
7247
  {
7140
- "description": "The primary button part of the card footer",
7141
- "name": "footer-button-primary",
7248
+ "kind": "field",
7249
+ "name": "validity",
7250
+ "type": {
7251
+ "text": "ValidityState"
7252
+ },
7253
+ "readonly": true,
7142
7254
  "inheritedFrom": {
7143
- "name": "Card",
7144
- "module": "src/components/card/card.component.ts"
7255
+ "name": "FormInternalsMixin",
7256
+ "module": "utils/mixins/FormInternalsMixin.js"
7145
7257
  }
7146
7258
  },
7147
7259
  {
7148
- "description": "The secondary button part of the card footer",
7149
- "name": "footer-button-secondary",
7260
+ "kind": "field",
7261
+ "name": "willValidate",
7262
+ "readonly": true,
7150
7263
  "inheritedFrom": {
7151
- "name": "Card",
7152
- "module": "src/components/card/card.component.ts"
7264
+ "name": "FormInternalsMixin",
7265
+ "module": "utils/mixins/FormInternalsMixin.js"
7153
7266
  }
7154
7267
  },
7155
7268
  {
7156
- "description": "The icon button part of the card header",
7157
- "name": "icon-button",
7269
+ "kind": "method",
7270
+ "name": "setValidity",
7271
+ "description": "Sets the validity of the input field based on the input field's validity.",
7272
+ "return": {
7273
+ "type": {
7274
+ "text": ""
7275
+ }
7276
+ },
7158
7277
  "inheritedFrom": {
7159
- "name": "Card",
7160
- "module": "src/components/card/card.component.ts"
7278
+ "name": "FormInternalsMixin",
7279
+ "module": "utils/mixins/FormInternalsMixin.js"
7161
7280
  }
7162
7281
  },
7163
7282
  {
7164
- "description": "The text part of the card",
7165
- "name": "text",
7283
+ "kind": "method",
7284
+ "name": "checkValidity",
7285
+ "return": {
7286
+ "type": {
7287
+ "text": "boolean"
7288
+ }
7289
+ },
7166
7290
  "inheritedFrom": {
7167
- "name": "Card",
7168
- "module": "src/components/card/card.component.ts"
7291
+ "name": "FormInternalsMixin",
7292
+ "module": "utils/mixins/FormInternalsMixin.js"
7169
7293
  }
7170
7294
  },
7171
7295
  {
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",
7296
+ "kind": "method",
7297
+ "name": "reportValidity",
7188
7298
  "inheritedFrom": {
7189
- "name": "Card",
7190
- "module": "src/components/card/card.component.ts"
7299
+ "name": "FormInternalsMixin",
7300
+ "module": "utils/mixins/FormInternalsMixin.js"
7191
7301
  }
7192
7302
  },
7193
7303
  {
7194
- "description": "This slot is for passing the text content for the card",
7195
- "name": "body",
7304
+ "kind": "field",
7305
+ "name": "dataAriaLabel",
7306
+ "type": {
7307
+ "text": "string | null"
7308
+ },
7309
+ "default": "null",
7310
+ "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
7311
+ "attribute": "data-aria-label",
7312
+ "reflects": true,
7196
7313
  "inheritedFrom": {
7197
- "name": "Card",
7198
- "module": "src/components/card/card.component.ts"
7314
+ "name": "DataAriaLabelMixin",
7315
+ "module": "utils/mixins/DataAriaLabelMixin.js"
7199
7316
  }
7200
7317
  },
7201
7318
  {
7202
- "description": "This slot is for passing the content after the body",
7203
- "name": "after-body",
7319
+ "kind": "field",
7320
+ "name": "disabled",
7321
+ "type": {
7322
+ "text": "boolean | undefined"
7323
+ },
7324
+ "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
7325
+ "default": "undefined",
7326
+ "attribute": "disabled",
7327
+ "reflects": true,
7204
7328
  "inheritedFrom": {
7205
- "name": "Card",
7206
- "module": "src/components/card/card.component.ts"
7329
+ "name": "DisabledMixin",
7330
+ "module": "utils/mixins/DisabledMixin.js"
7207
7331
  }
7208
7332
  },
7209
7333
  {
7210
- "description": "This slot is for passing `mdc-link` component within the footer section.",
7211
- "name": "footer-link",
7334
+ "kind": "field",
7335
+ "name": "label",
7336
+ "type": {
7337
+ "text": "string | undefined"
7338
+ },
7339
+ "description": "The label of the input field. It is linked to the input field using the `for` attribute.",
7340
+ "attribute": "label",
7341
+ "reflects": true,
7212
7342
  "inheritedFrom": {
7213
- "name": "Card",
7214
- "module": "src/components/card/card.component.ts"
7343
+ "name": "FormfieldWrapper",
7344
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
7215
7345
  }
7216
7346
  },
7217
7347
  {
7218
- "description": "This slot is for passing primary variant of `mdc-button` component within the footer section.",
7219
- "name": "footer-button-primary",
7348
+ "kind": "field",
7349
+ "name": "required",
7350
+ "type": {
7351
+ "text": "boolean"
7352
+ },
7353
+ "default": "false",
7354
+ "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
7355
+ "attribute": "required",
7356
+ "reflects": true,
7220
7357
  "inheritedFrom": {
7221
- "name": "Card",
7222
- "module": "src/components/card/card.component.ts"
7358
+ "name": "FormfieldWrapper",
7359
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
7223
7360
  }
7224
7361
  },
7225
7362
  {
7226
- "description": "This slot is for passing secondary variant of `mdc-button` component within the footer section.",
7227
- "name": "footer-button-secondary",
7363
+ "kind": "field",
7364
+ "name": "id",
7365
+ "type": {
7366
+ "text": "string"
7367
+ },
7368
+ "default": "''",
7369
+ "description": "The unique id of the input field. It is used to link the input field with the label.",
7370
+ "attribute": "id",
7228
7371
  "inheritedFrom": {
7229
- "name": "Card",
7230
- "module": "src/components/card/card.component.ts"
7372
+ "name": "FormfieldWrapper",
7373
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
7231
7374
  }
7232
7375
  },
7233
7376
  {
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",
7377
+ "kind": "field",
7378
+ "name": "helpTextType",
7379
+ "type": {
7380
+ "text": "ValidationType"
7381
+ },
7382
+ "description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
7383
+ "attribute": "help-text-type",
7384
+ "reflects": true,
7236
7385
  "inheritedFrom": {
7237
- "name": "Card",
7238
- "module": "src/components/card/card.component.ts"
7386
+ "name": "FormfieldWrapper",
7387
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
7239
7388
  }
7240
- }
7241
- ],
7242
- "members": [
7389
+ },
7243
7390
  {
7244
7391
  "kind": "field",
7245
- "name": "checked",
7392
+ "name": "helpText",
7246
7393
  "type": {
7247
- "text": "boolean"
7394
+ "text": "string | undefined"
7248
7395
  },
7249
- "default": "false",
7250
- "description": "The checked state of the card",
7251
- "attribute": "checked",
7252
- "reflects": true
7396
+ "description": "The help text that is displayed below the input field.",
7397
+ "attribute": "help-text",
7398
+ "reflects": true,
7399
+ "inheritedFrom": {
7400
+ "name": "FormfieldWrapper",
7401
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
7402
+ }
7253
7403
  },
7254
7404
  {
7255
7405
  "kind": "field",
7256
- "name": "name",
7406
+ "name": "toggletipText",
7257
7407
  "type": {
7258
- "text": "string"
7408
+ "text": "string | undefined"
7259
7409
  },
7260
- "default": "''",
7261
- "description": "The name of the radio.",
7262
- "attribute": "name"
7410
+ "description": "The toggletip text that is displayed when the label is hovered.\nIt is used to provide additional information about the label.",
7411
+ "attribute": "toggletip-text",
7412
+ "reflects": true,
7413
+ "inheritedFrom": {
7414
+ "name": "FormfieldWrapper",
7415
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
7416
+ }
7263
7417
  },
7264
7418
  {
7265
- "kind": "method",
7266
- "name": "getAllCardsWithinSameGroup",
7267
- "privacy": "private",
7268
- "return": {
7269
- "type": {
7270
- "text": "CardRadio[]"
7271
- }
7419
+ "kind": "field",
7420
+ "name": "toggletipPlacement",
7421
+ "type": {
7422
+ "text": "PopoverPlacement"
7272
7423
  },
7273
- "description": "Returns all cards within the same group (name)."
7424
+ "description": "The placement of the toggletip that is displayed when the info icon is hovered.",
7425
+ "default": "'top'",
7426
+ "attribute": "toggletip-placement",
7427
+ "reflects": true,
7428
+ "inheritedFrom": {
7429
+ "name": "FormfieldWrapper",
7430
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
7431
+ }
7274
7432
  },
7275
7433
  {
7276
- "kind": "method",
7277
- "name": "toggleChecked",
7278
- "privacy": "private",
7279
- "return": {
7280
- "type": {
7281
- "text": "void"
7282
- }
7434
+ "kind": "field",
7435
+ "name": "infoIconAriaLabel",
7436
+ "type": {
7437
+ "text": "string | undefined"
7283
7438
  },
7284
- "description": "Handles the change event on the radio element.\nThis will toggle the state of the radio element.\nDispatches the change event."
7439
+ "description": "Aria label for the info icon that is displayed next to the label when `toggletipText` is set.\nThis is used for accessibility purposes to provide a description of the icon.",
7440
+ "attribute": "info-icon-aria-label",
7441
+ "reflects": true,
7442
+ "inheritedFrom": {
7443
+ "name": "FormfieldWrapper",
7444
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
7445
+ }
7285
7446
  },
7286
7447
  {
7287
7448
  "kind": "method",
7288
- "name": "setDisabled",
7449
+ "name": "renderLabelElement",
7450
+ "privacy": "protected",
7451
+ "description": "creates the label element when the label property is set.\nid is used to link the label with the input field.",
7289
7452
  "return": {
7290
7453
  "type": {
7291
- "text": "void"
7454
+ "text": ""
7292
7455
  }
7293
7456
  },
7294
- "parameters": [
7295
- {
7296
- "name": "disabled",
7297
- "type": {
7298
- "text": "boolean"
7299
- }
7300
- }
7301
- ]
7457
+ "inheritedFrom": {
7458
+ "name": "FormfieldWrapper",
7459
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
7460
+ }
7302
7461
  },
7303
7462
  {
7304
7463
  "kind": "method",
7305
- "name": "updateCardRadio",
7306
- "privacy": "private",
7464
+ "name": "renderHelpTextIcon",
7465
+ "privacy": "protected",
7466
+ "description": "creates the helpertext icon based on the helpTextType for validation.\nIf the helpTextType is not set, it defaults to 'default' and it doesn't display any icon.",
7307
7467
  "return": {
7308
7468
  "type": {
7309
- "text": "void"
7469
+ "text": ""
7310
7470
  }
7311
7471
  },
7312
- "parameters": [
7313
- {
7314
- "name": "cards",
7315
- "type": {
7316
- "text": "CardRadio[]"
7317
- }
7318
- },
7319
- {
7320
- "name": "index",
7321
- "type": {
7322
- "text": "number"
7323
- }
7324
- }
7325
- ]
7472
+ "inheritedFrom": {
7473
+ "name": "FormfieldWrapper",
7474
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
7475
+ }
7326
7476
  },
7327
7477
  {
7328
7478
  "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"
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": ""
7338
7485
  }
7339
- ],
7340
- "description": "Toggles the checked state when enter key is used"
7486
+ },
7487
+ "inheritedFrom": {
7488
+ "name": "FormfieldWrapper",
7489
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
7490
+ }
7341
7491
  },
7342
7492
  {
7343
7493
  "kind": "method",
7344
- "name": "toggleOnSpace",
7345
- "privacy": "private",
7346
- "parameters": [
7347
- {
7348
- "name": "event",
7349
- "type": {
7350
- "text": "KeyboardEvent"
7351
- },
7352
- "description": "The keyboard event"
7494
+ "name": "renderLabel",
7495
+ "privacy": "protected",
7496
+ "description": "renders the mdc-label-text container that contains the label and labelInfoToggleTip.",
7497
+ "return": {
7498
+ "type": {
7499
+ "text": ""
7353
7500
  }
7354
- ],
7355
- "description": "Toggles the checked state when space key is used"
7501
+ },
7502
+ "inheritedFrom": {
7503
+ "name": "FormfieldWrapper",
7504
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
7505
+ }
7356
7506
  },
7357
7507
  {
7358
7508
  "kind": "method",
7359
- "name": "renderHeader",
7509
+ "name": "renderHelperText",
7360
7510
  "privacy": "protected",
7361
- "description": "Renders the header of the card",
7511
+ "description": "renders the mdc-help-text container that contains the helpertext icon and helpertext.",
7362
7512
  "return": {
7363
7513
  "type": {
7364
7514
  "text": ""
7365
7515
  }
7366
7516
  },
7367
7517
  "inheritedFrom": {
7368
- "name": "Card",
7369
- "module": "components/card/card.component.js"
7518
+ "name": "FormfieldWrapper",
7519
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
7520
+ }
7521
+ }
7522
+ ],
7523
+ "events": [
7524
+ {
7525
+ "type": {
7526
+ "text": "EventConstructor"
7370
7527
  }
7371
7528
  },
7372
7529
  {
7373
- "kind": "field",
7374
- "name": "disabled",
7530
+ "description": "(React: onChange) Event that gets dispatched when the checkbox state changes.",
7531
+ "name": "change",
7532
+ "reactName": "onChange"
7533
+ },
7534
+ {
7535
+ "description": "(React: onFocus) Event that gets dispatched when the checkbox receives focus.",
7536
+ "name": "focus",
7537
+ "reactName": "onFocus"
7538
+ }
7539
+ ],
7540
+ "attributes": [
7541
+ {
7542
+ "name": "checked",
7375
7543
  "type": {
7376
- "text": "boolean | undefined"
7544
+ "text": "boolean"
7377
7545
  },
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,
7382
- "inheritedFrom": {
7383
- "name": "DisabledMixin",
7384
- "module": "utils/mixins/DisabledMixin.js"
7385
- }
7546
+ "default": "false",
7547
+ "description": "Determines whether the checkbox is selected or unselected.",
7548
+ "fieldName": "checked"
7386
7549
  },
7387
7550
  {
7388
- "kind": "field",
7389
- "name": "tabIndex",
7551
+ "name": "indeterminate",
7390
7552
  "type": {
7391
- "text": "number"
7553
+ "text": "boolean"
7392
7554
  },
7393
- "default": "0",
7394
- "description": "This property specifies the tab order of the element.",
7395
- "attribute": "tabIndex",
7396
- "reflects": true,
7397
- "inheritedFrom": {
7398
- "name": "TabIndexMixin",
7399
- "module": "utils/mixins/TabIndexMixin.js"
7400
- }
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"
7401
7558
  },
7402
7559
  {
7403
- "kind": "field",
7404
- "name": "cardTitle",
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
+ {
7569
+ "name": "name",
7405
7570
  "type": {
7406
7571
  "text": "string"
7407
7572
  },
7408
7573
  "default": "''",
7409
- "description": "The title of the card - part of header section",
7410
- "attribute": "card-title",
7411
- "reflects": true,
7574
+ "description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
7575
+ "fieldName": "name",
7412
7576
  "inheritedFrom": {
7413
- "name": "Card",
7414
- "module": "components/card/card.component.js"
7577
+ "name": "FormInternalsMixin",
7578
+ "module": "src/utils/mixins/FormInternalsMixin.ts"
7415
7579
  }
7416
7580
  },
7417
7581
  {
7418
- "kind": "field",
7419
- "name": "subtitle",
7582
+ "name": "value",
7420
7583
  "type": {
7421
7584
  "text": "string"
7422
7585
  },
7423
7586
  "default": "''",
7424
- "description": "The subtitle of the card - part of header section",
7425
- "attribute": "subtitle",
7426
- "reflects": true,
7587
+ "description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
7588
+ "fieldName": "value",
7427
7589
  "inheritedFrom": {
7428
- "name": "Card",
7429
- "module": "components/card/card.component.js"
7590
+ "name": "FormInternalsMixin",
7591
+ "module": "src/utils/mixins/FormInternalsMixin.ts"
7430
7592
  }
7431
7593
  },
7432
7594
  {
7433
- "kind": "field",
7434
- "name": "imageSrc",
7595
+ "name": "validation-message",
7435
7596
  "type": {
7436
- "text": "string"
7597
+ "text": "string | undefined"
7437
7598
  },
7438
- "default": "''",
7439
- "description": "The image source URL to render on the card",
7440
- "attribute": "image-src",
7441
- "reflects": true,
7599
+ "description": "Custom validation message that will override the default message and displayed when the input is invalid.\n\nTo display custom validation messages, you must listen for input events (or other relevant events)\non your component and update the `validationMessage` property with the desired message string.\nUpdating this property will ensure that new validation messages are shown to the user.\n- The `validationMessage` property overrides the default browser validation message when set.\n- Consumers are responsible for updating `validationMessage` in response to input or validation state changes.",
7600
+ "fieldName": "validationMessage",
7442
7601
  "inheritedFrom": {
7443
- "name": "Card",
7444
- "module": "components/card/card.component.js"
7602
+ "name": "FormInternalsMixin",
7603
+ "module": "src/utils/mixins/FormInternalsMixin.ts"
7445
7604
  }
7446
7605
  },
7447
7606
  {
7448
- "kind": "field",
7449
- "name": "imageAlt",
7607
+ "name": "data-aria-label",
7450
7608
  "type": {
7451
- "text": "string"
7609
+ "text": "string | null"
7452
7610
  },
7453
- "default": "''",
7454
- "description": "The image alt for accessibility support",
7455
- "attribute": "image-alt",
7456
- "reflects": true,
7611
+ "default": "null",
7612
+ "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
7613
+ "fieldName": "dataAriaLabel",
7457
7614
  "inheritedFrom": {
7458
- "name": "Card",
7459
- "module": "components/card/card.component.js"
7615
+ "name": "DataAriaLabelMixin",
7616
+ "module": "src/utils/mixins/DataAriaLabelMixin.ts"
7460
7617
  }
7461
7618
  },
7462
7619
  {
7463
- "kind": "field",
7464
- "name": "variant",
7620
+ "name": "disabled",
7465
7621
  "type": {
7466
- "text": "CardVariant"
7622
+ "text": "boolean | undefined"
7467
7623
  },
7468
- "description": "The variant of the card. It can either be set to 'border' or 'ghost'",
7469
- "default": "'border'",
7470
- "attribute": "variant",
7471
- "reflects": true,
7624
+ "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
7625
+ "default": "undefined",
7626
+ "fieldName": "disabled",
7472
7627
  "inheritedFrom": {
7473
- "name": "Card",
7474
- "module": "components/card/card.component.js"
7628
+ "name": "DisabledMixin",
7629
+ "module": "src/utils/mixins/DisabledMixin.ts"
7475
7630
  }
7476
7631
  },
7477
7632
  {
7478
- "kind": "field",
7479
- "name": "orientation",
7633
+ "name": "label",
7480
7634
  "type": {
7481
- "text": "CardOrientation"
7635
+ "text": "string | undefined"
7482
7636
  },
7483
- "description": "The orientation of the card. It can either be set to 'vertical' or 'horizontal'",
7484
- "default": "'vertical'",
7485
- "attribute": "orientation",
7486
- "reflects": true,
7637
+ "description": "The label of the input field. It is linked to the input field using the `for` attribute.",
7638
+ "fieldName": "label",
7487
7639
  "inheritedFrom": {
7488
- "name": "Card",
7489
- "module": "components/card/card.component.js"
7640
+ "name": "FormfieldWrapper",
7641
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
7490
7642
  }
7491
7643
  },
7492
7644
  {
7493
- "kind": "field",
7494
- "name": "titleTagName",
7645
+ "name": "required",
7495
7646
  "type": {
7496
- "text": "TagNameType"
7647
+ "text": "boolean"
7497
7648
  },
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",
7501
- "reflects": true,
7649
+ "default": "false",
7650
+ "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
7651
+ "fieldName": "required",
7502
7652
  "inheritedFrom": {
7503
- "name": "Card",
7504
- "module": "components/card/card.component.js"
7653
+ "name": "FormfieldWrapper",
7654
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
7505
7655
  }
7506
7656
  },
7507
7657
  {
7508
- "kind": "field",
7509
- "name": "subtitleTagName",
7658
+ "name": "id",
7510
7659
  "type": {
7511
- "text": "TagNameType"
7660
+ "text": "string"
7512
7661
  },
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",
7516
- "reflects": true,
7662
+ "default": "''",
7663
+ "description": "The unique id of the input field. It is used to link the input field with the label.",
7664
+ "fieldName": "id",
7665
+ "inheritedFrom": {
7666
+ "name": "FormfieldWrapper",
7667
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
7668
+ }
7669
+ },
7670
+ {
7671
+ "name": "help-text-type",
7672
+ "type": {
7673
+ "text": "ValidationType"
7674
+ },
7675
+ "description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
7676
+ "fieldName": "helpTextType",
7517
7677
  "inheritedFrom": {
7518
- "name": "Card",
7519
- "module": "components/card/card.component.js"
7678
+ "name": "FormfieldWrapper",
7679
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
7520
7680
  }
7521
7681
  },
7522
7682
  {
7523
- "kind": "field",
7524
- "name": "iconName",
7683
+ "name": "help-text",
7525
7684
  "type": {
7526
- "text": "IconNames | undefined"
7685
+ "text": "string | undefined"
7527
7686
  },
7528
- "description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
7529
- "attribute": "icon-name",
7530
- "reflects": true,
7687
+ "description": "The help text that is displayed below the input field.",
7688
+ "fieldName": "helpText",
7531
7689
  "inheritedFrom": {
7532
- "name": "Card",
7533
- "module": "components/card/card.component.js"
7690
+ "name": "FormfieldWrapper",
7691
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
7534
7692
  }
7535
7693
  },
7536
7694
  {
7537
- "kind": "method",
7538
- "name": "renderImage",
7539
- "privacy": "protected",
7540
- "description": "Renders the image on the card if image source is provided",
7541
- "return": {
7542
- "type": {
7543
- "text": ""
7544
- }
7695
+ "name": "toggletip-text",
7696
+ "type": {
7697
+ "text": "string | undefined"
7545
7698
  },
7699
+ "description": "The toggletip text that is displayed when the label is hovered.\nIt is used to provide additional information about the label.",
7700
+ "fieldName": "toggletipText",
7546
7701
  "inheritedFrom": {
7547
- "name": "Card",
7548
- "module": "components/card/card.component.js"
7702
+ "name": "FormfieldWrapper",
7703
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
7549
7704
  }
7550
7705
  },
7551
7706
  {
7552
- "kind": "method",
7553
- "name": "renderIcon",
7554
- "privacy": "protected",
7555
- "description": "Renders the icon on the card if icon name is provided",
7556
- "return": {
7557
- "type": {
7558
- "text": ""
7559
- }
7707
+ "name": "toggletip-placement",
7708
+ "type": {
7709
+ "text": "PopoverPlacement"
7560
7710
  },
7711
+ "description": "The placement of the toggletip that is displayed when the info icon is hovered.",
7712
+ "default": "'top'",
7713
+ "fieldName": "toggletipPlacement",
7561
7714
  "inheritedFrom": {
7562
- "name": "Card",
7563
- "module": "components/card/card.component.js"
7715
+ "name": "FormfieldWrapper",
7716
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
7564
7717
  }
7565
7718
  },
7566
7719
  {
7567
- "kind": "method",
7568
- "name": "renderTitle",
7569
- "privacy": "protected",
7570
- "description": "Renders the title and subtitle on the card",
7571
- "return": {
7572
- "type": {
7573
- "text": ""
7574
- }
7720
+ "name": "info-icon-aria-label",
7721
+ "type": {
7722
+ "text": "string | undefined"
7575
7723
  },
7724
+ "description": "Aria label for the info icon that is displayed next to the label when `toggletipText` is set.\nThis is used for accessibility purposes to provide a description of the icon.",
7725
+ "fieldName": "infoIconAriaLabel",
7576
7726
  "inheritedFrom": {
7577
- "name": "Card",
7578
- "module": "components/card/card.component.js"
7727
+ "name": "FormfieldWrapper",
7728
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
7579
7729
  }
7730
+ }
7731
+ ],
7732
+ "mixins": [
7733
+ {
7734
+ "name": "FormInternalsMixin",
7735
+ "module": "/src/utils/mixins/FormInternalsMixin"
7580
7736
  },
7581
7737
  {
7582
- "kind": "method",
7583
- "name": "renderFooter",
7584
- "privacy": "protected",
7585
- "description": "Renders the footer of the card if footer-link,\nfooter-button-primary, or footer-button-secondary slots are provided",
7586
- "return": {
7587
- "type": {
7588
- "text": ""
7589
- }
7590
- },
7738
+ "name": "DataAriaLabelMixin",
7739
+ "module": "/src/utils/mixins/DataAriaLabelMixin"
7740
+ }
7741
+ ],
7742
+ "superclass": {
7743
+ "name": "FormfieldWrapper",
7744
+ "module": "/src/components/formfieldwrapper/formfieldwrapper.component"
7745
+ },
7746
+ "tagName": "mdc-checkbox",
7747
+ "jsDoc": "/**\n * Checkboxes allow users to select multiple options from a list or turn an item/feature on or off.\n * These are often used in forms, settings, and selections in lists.\n *\n * A checkbox component contains an optional label and an optional helper text.\n *\n * To create a group of checkboxes, use the FormFieldGroup component.\n *\n * @dependency mdc-button\n * @dependency mdc-icon\n * @dependency mdc-staticcheckbox\n * @dependency mdc-text\n * @dependency mdc-toggletip\n *\n * @tagname mdc-checkbox\n *\n * @event change - (React: onChange) Event that gets dispatched when the checkbox state changes.\n * @event focus - (React: onFocus) Event that gets dispatched when the checkbox receives focus.\n *\n * @cssproperty --mdc-checkbox-background-color-hover - Allows customization of the background color on hover.\n * @cssproperty --mdc-checkbox-checked-background-color-hover - Background color for a selected checkbox when hovered.\n * @cssproperty --mdc-checkbox-checked-pressed-icon-color - Background color for a selected checkbox when pressed.\n * @cssproperty --mdc-checkbox-pressed-icon-color - Background color for a selected checkbox when pressed.\n * @cssproperty --mdc-checkbox-disabled-checked-icon-color - Background color for a selected checkbox when disabled.\n */",
7748
+ "customElement": true
7749
+ }
7750
+ ],
7751
+ "exports": [
7752
+ {
7753
+ "kind": "js",
7754
+ "name": "default",
7755
+ "declaration": {
7756
+ "name": "Checkbox",
7757
+ "module": "components/checkbox/checkbox.component.js"
7758
+ }
7759
+ }
7760
+ ]
7761
+ },
7762
+ {
7763
+ "kind": "javascript-module",
7764
+ "path": "components/cardradio/cardradio.component.js",
7765
+ "declarations": [
7766
+ {
7767
+ "kind": "class",
7768
+ "description": "cardradio component extends `mdc-card` and supports radio selection interaction addtionally.\n\nWhile using this component within a form or group of cards, make sure cards are in a role = \"radio-group\".\nThis card would have events for selected and unselected (similar to radio)\n\n**Note**: This is a single selection card i.e. interacting anywhere on the card would toggle the checked state.\nMake sure to pass only non-interactable elements within the slots.\n\nMake sure to pass the `card-title` mandatorily for this card.",
7769
+ "name": "CardRadio",
7770
+ "cssProperties": [
7771
+ {
7772
+ "description": "The width of the card",
7773
+ "name": "--mdc-card-width",
7591
7774
  "inheritedFrom": {
7592
7775
  "name": "Card",
7593
- "module": "components/card/card.component.js"
7776
+ "module": "src/components/card/card.component.ts"
7594
7777
  }
7595
7778
  }
7596
7779
  ],
7597
- "events": [
7780
+ "cssParts": [
7598
7781
  {
7599
- "description": "(React: onClick) Event that gets dispatched when the card is clicked. It toggles the checked state.",
7600
- "name": "click",
7601
- "reactName": "onClick"
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
+ }
7602
7788
  },
7603
7789
  {
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"
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
+ }
7607
7796
  },
7608
7797
  {
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"
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
+ }
7612
7804
  },
7613
7805
  {
7614
- "description": "(React: onChange) Event that gets dispatched when the card state changes.",
7615
- "name": "change",
7616
- "reactName": "onChange"
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
+ }
7617
7812
  },
7618
7813
  {
7619
- "description": "(React: onFocus) Event that gets dispatched when the card receives focus.",
7620
- "name": "focus",
7621
- "reactName": "onFocus"
7622
- }
7623
- ],
7624
- "attributes": [
7625
- {
7626
- "name": "checked",
7627
- "type": {
7628
- "text": "boolean"
7629
- },
7630
- "default": "false",
7631
- "description": "The checked state of the card",
7632
- "fieldName": "checked"
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
+ }
7633
7820
  },
7634
7821
  {
7635
- "name": "name",
7636
- "type": {
7637
- "text": "string"
7638
- },
7639
- "default": "''",
7640
- "description": "The name of the radio.",
7641
- "fieldName": "name"
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
+ }
7642
7828
  },
7643
7829
  {
7644
- "name": "disabled",
7645
- "type": {
7646
- "text": "boolean | undefined"
7647
- },
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",
7830
+ "description": "The primary button part of the card footer",
7831
+ "name": "footer-button-primary",
7651
7832
  "inheritedFrom": {
7652
- "name": "DisabledMixin",
7653
- "module": "src/utils/mixins/DisabledMixin.ts"
7833
+ "name": "Card",
7834
+ "module": "src/components/card/card.component.ts"
7654
7835
  }
7655
7836
  },
7656
7837
  {
7657
- "name": "tabIndex",
7658
- "type": {
7659
- "text": "number"
7660
- },
7661
- "default": "0",
7662
- "description": "This property specifies the tab order of the element.",
7663
- "fieldName": "tabIndex",
7838
+ "description": "The secondary button part of the card footer",
7839
+ "name": "footer-button-secondary",
7664
7840
  "inheritedFrom": {
7665
- "name": "TabIndexMixin",
7666
- "module": "src/utils/mixins/TabIndexMixin.ts"
7841
+ "name": "Card",
7842
+ "module": "src/components/card/card.component.ts"
7667
7843
  }
7668
7844
  },
7669
7845
  {
7670
- "name": "card-title",
7671
- "type": {
7672
- "text": "string"
7673
- },
7674
- "default": "''",
7675
- "description": "The title of the card - part of header section",
7676
- "fieldName": "cardTitle",
7846
+ "description": "The icon button part of the card header",
7847
+ "name": "icon-button",
7677
7848
  "inheritedFrom": {
7678
7849
  "name": "Card",
7679
7850
  "module": "src/components/card/card.component.ts"
7680
7851
  }
7681
7852
  },
7682
7853
  {
7683
- "name": "subtitle",
7684
- "type": {
7685
- "text": "string"
7686
- },
7687
- "default": "''",
7688
- "description": "The subtitle of the card - part of header section",
7689
- "fieldName": "subtitle",
7854
+ "description": "The text part of the card",
7855
+ "name": "text",
7690
7856
  "inheritedFrom": {
7691
7857
  "name": "Card",
7692
7858
  "module": "src/components/card/card.component.ts"
7693
7859
  }
7694
7860
  },
7695
7861
  {
7696
- "name": "image-src",
7697
- "type": {
7698
- "text": "string"
7699
- },
7700
- "default": "''",
7701
- "description": "The image source URL to render on the card",
7702
- "fieldName": "imageSrc",
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",
7703
7878
  "inheritedFrom": {
7704
7879
  "name": "Card",
7705
7880
  "module": "src/components/card/card.component.ts"
7706
7881
  }
7707
7882
  },
7708
7883
  {
7709
- "name": "image-alt",
7710
- "type": {
7711
- "text": "string"
7712
- },
7713
- "default": "''",
7714
- "description": "The image alt for accessibility support",
7715
- "fieldName": "imageAlt",
7884
+ "description": "This slot is for passing the text content for the card",
7885
+ "name": "body",
7716
7886
  "inheritedFrom": {
7717
7887
  "name": "Card",
7718
7888
  "module": "src/components/card/card.component.ts"
7719
7889
  }
7720
7890
  },
7721
7891
  {
7722
- "name": "variant",
7723
- "type": {
7724
- "text": "CardVariant"
7725
- },
7726
- "description": "The variant of the card. It can either be set to 'border' or 'ghost'",
7727
- "default": "'border'",
7728
- "fieldName": "variant",
7892
+ "description": "This slot is for passing the content after the body",
7893
+ "name": "after-body",
7729
7894
  "inheritedFrom": {
7730
7895
  "name": "Card",
7731
7896
  "module": "src/components/card/card.component.ts"
7732
7897
  }
7733
7898
  },
7734
7899
  {
7735
- "name": "orientation",
7736
- "type": {
7737
- "text": "CardOrientation"
7738
- },
7739
- "description": "The orientation of the card. It can either be set to 'vertical' or 'horizontal'",
7740
- "default": "'vertical'",
7741
- "fieldName": "orientation",
7900
+ "description": "This slot is for passing `mdc-link` component within the footer section.",
7901
+ "name": "footer-link",
7742
7902
  "inheritedFrom": {
7743
7903
  "name": "Card",
7744
7904
  "module": "src/components/card/card.component.ts"
7745
7905
  }
7746
7906
  },
7747
7907
  {
7748
- "name": "title-tag-name",
7749
- "type": {
7750
- "text": "TagNameType"
7751
- },
7752
- "description": "The tag name for the card title. It supports all the types that `mdc-text` supports",
7753
- "default": "'span'",
7754
- "fieldName": "titleTagName",
7908
+ "description": "This slot is for passing primary variant of `mdc-button` component within the footer section.",
7909
+ "name": "footer-button-primary",
7755
7910
  "inheritedFrom": {
7756
7911
  "name": "Card",
7757
7912
  "module": "src/components/card/card.component.ts"
7758
7913
  }
7759
7914
  },
7760
7915
  {
7761
- "name": "subtitle-tag-name",
7762
- "type": {
7763
- "text": "TagNameType"
7764
- },
7765
- "description": "The tag name for the subtitle. It supports all the types that `mdc-text` supports",
7766
- "default": "'span'",
7767
- "fieldName": "subtitleTagName",
7916
+ "description": "This slot is for passing secondary variant of `mdc-button` component within the footer section.",
7917
+ "name": "footer-button-secondary",
7768
7918
  "inheritedFrom": {
7769
7919
  "name": "Card",
7770
7920
  "module": "src/components/card/card.component.ts"
7771
7921
  }
7772
7922
  },
7773
7923
  {
7774
- "name": "icon-name",
7775
- "type": {
7776
- "text": "IconNames | undefined"
7777
- },
7778
- "description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
7779
- "fieldName": "iconName",
7924
+ "description": " This slot is for passing custom footer content. Only use this if really needed, using the footer-link and footer-button slots is preferred.",
7925
+ "name": "footer",
7780
7926
  "inheritedFrom": {
7781
7927
  "name": "Card",
7782
7928
  "module": "src/components/card/card.component.ts"
7783
7929
  }
7784
7930
  }
7785
7931
  ],
7786
- "mixins": [
7787
- {
7788
- "name": "DisabledMixin",
7789
- "module": "/src/utils/mixins/DisabledMixin"
7790
- },
7791
- {
7792
- "name": "TabIndexMixin",
7793
- "module": "/src/utils/mixins/TabIndexMixin"
7794
- }
7795
- ],
7796
- "superclass": {
7797
- "name": "Card",
7798
- "module": "/src/components/card/card.component"
7799
- },
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 */",
7802
- "customElement": true
7803
- }
7804
- ],
7805
- "exports": [
7806
- {
7807
- "kind": "js",
7808
- "name": "default",
7809
- "declaration": {
7810
- "name": "CardRadio",
7811
- "module": "components/cardradio/cardradio.component.js"
7812
- }
7813
- }
7814
- ]
7815
- },
7816
- {
7817
- "kind": "javascript-module",
7818
- "path": "components/checkbox/checkbox.component.js",
7819
- "declarations": [
7820
- {
7821
- "kind": "class",
7822
- "description": "Checkboxes allow users to select multiple options from a list or turn an item/feature on or off.\nThese are often used in forms, settings, and selections in lists.\n\nA checkbox component contains an optional label and an optional helper text.\n\nTo create a group of checkboxes, use the FormFieldGroup component.",
7823
- "name": "Checkbox",
7824
- "cssProperties": [
7825
- {
7826
- "description": "Allows customization of the background color on hover.",
7827
- "name": "--mdc-checkbox-background-color-hover"
7828
- },
7829
- {
7830
- "description": "Background color for a selected checkbox when hovered.",
7831
- "name": "--mdc-checkbox-checked-background-color-hover"
7832
- },
7833
- {
7834
- "description": "Background color for a selected checkbox when pressed.",
7835
- "name": "--mdc-checkbox-checked-pressed-icon-color"
7836
- },
7837
- {
7838
- "description": "Background color for a selected checkbox when pressed.",
7839
- "name": "--mdc-checkbox-pressed-icon-color"
7840
- },
7841
- {
7842
- "description": "Background color for a selected checkbox when disabled.",
7843
- "name": "--mdc-checkbox-disabled-checked-icon-color"
7844
- }
7845
- ],
7846
7932
  "members": [
7847
7933
  {
7848
7934
  "kind": "field",
@@ -7851,99 +7937,10 @@
7851
7937
  "text": "boolean"
7852
7938
  },
7853
7939
  "default": "false",
7854
- "description": "Determines whether the checkbox is selected or unselected.",
7940
+ "description": "The checked state of the card",
7855
7941
  "attribute": "checked",
7856
7942
  "reflects": true
7857
7943
  },
7858
- {
7859
- "kind": "field",
7860
- "name": "indeterminate",
7861
- "type": {
7862
- "text": "boolean"
7863
- },
7864
- "default": "false",
7865
- "description": "This property is used to determine the parent checkbox in a nested checkbox group.\nIf any one of the children is unselected, then the parent checkbox will be indeterminate.\nIf all children are either selected or unselected, then the parent checkbox will not be indeterminate.",
7866
- "attribute": "indeterminate",
7867
- "reflects": true
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
7879
- },
7880
- {
7881
- "kind": "method",
7882
- "name": "setFormValue",
7883
- "privacy": "private",
7884
- "description": "Updates the form value to reflect the current state of the checkbox.\nIf checked, the value is set to either the user-provided value or 'on' if no value is provided.\nIf unchecked, the value is set to null."
7885
- },
7886
- {
7887
- "kind": "method",
7888
- "name": "manageRequired",
7889
- "privacy": "private",
7890
- "description": "Manages the required state of the checkbox.\nIf the checkbox is not checked and the required property is set, then the checkbox is invalid."
7891
- },
7892
- {
7893
- "kind": "method",
7894
- "name": "toggleState",
7895
- "privacy": "private",
7896
- "return": {
7897
- "type": {
7898
- "text": "void"
7899
- }
7900
- },
7901
- "description": "Toggles the state of the checkbox element.\nIf the element is not disabled, then\nthe checked property is toggled and the indeterminate property is set to false."
7902
- },
7903
- {
7904
- "kind": "method",
7905
- "name": "handleKeyDown",
7906
- "privacy": "private",
7907
- "return": {
7908
- "type": {
7909
- "text": "void"
7910
- }
7911
- },
7912
- "parameters": [
7913
- {
7914
- "name": "event",
7915
- "type": {
7916
- "text": "KeyboardEvent"
7917
- },
7918
- "description": "The keyboard event."
7919
- }
7920
- ],
7921
- "description": "Handles the keydown event on the checkbox.\nWhen the user presses Enter, the form is submitted."
7922
- },
7923
- {
7924
- "kind": "method",
7925
- "name": "handleChange",
7926
- "privacy": "public",
7927
- "return": {
7928
- "type": {
7929
- "text": "void"
7930
- }
7931
- },
7932
- "parameters": [
7933
- {
7934
- "name": "event",
7935
- "type": {
7936
- "text": "Event"
7937
- }
7938
- }
7939
- ],
7940
- "description": "Toggles the state of the checkbox element.\nand dispatch the new change event."
7941
- },
7942
- {
7943
- "kind": "field",
7944
- "name": "renderLabelAndHelperText",
7945
- "privacy": "private"
7946
- },
7947
7944
  {
7948
7945
  "kind": "field",
7949
7946
  "name": "name",
@@ -7951,112 +7948,115 @@
7951
7948
  "text": "string"
7952
7949
  },
7953
7950
  "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
- }
7951
+ "description": "The name of the radio.",
7952
+ "attribute": "name"
7990
7953
  },
7991
7954
  {
7992
- "kind": "field",
7993
- "name": "validity",
7994
- "type": {
7995
- "text": "ValidityState"
7955
+ "kind": "method",
7956
+ "name": "getAllCardsWithinSameGroup",
7957
+ "privacy": "private",
7958
+ "return": {
7959
+ "type": {
7960
+ "text": "CardRadio[]"
7961
+ }
7996
7962
  },
7997
- "readonly": true,
7998
- "inheritedFrom": {
7999
- "name": "FormInternalsMixin",
8000
- "module": "utils/mixins/FormInternalsMixin.js"
8001
- }
7963
+ "description": "Returns all cards within the same group (name)."
8002
7964
  },
8003
7965
  {
8004
- "kind": "field",
8005
- "name": "willValidate",
8006
- "readonly": true,
8007
- "inheritedFrom": {
8008
- "name": "FormInternalsMixin",
8009
- "module": "utils/mixins/FormInternalsMixin.js"
8010
- }
7966
+ "kind": "method",
7967
+ "name": "toggleChecked",
7968
+ "privacy": "private",
7969
+ "return": {
7970
+ "type": {
7971
+ "text": "void"
7972
+ }
7973
+ },
7974
+ "description": "Handles the change event on the radio element.\nThis will toggle the state of the radio element.\nDispatches the change event."
8011
7975
  },
8012
7976
  {
8013
7977
  "kind": "method",
8014
- "name": "setValidity",
8015
- "description": "Sets the validity of the input field based on the input field's validity.",
7978
+ "name": "setDisabled",
8016
7979
  "return": {
8017
7980
  "type": {
8018
- "text": ""
7981
+ "text": "void"
8019
7982
  }
8020
7983
  },
8021
- "inheritedFrom": {
8022
- "name": "FormInternalsMixin",
8023
- "module": "utils/mixins/FormInternalsMixin.js"
8024
- }
7984
+ "parameters": [
7985
+ {
7986
+ "name": "disabled",
7987
+ "type": {
7988
+ "text": "boolean"
7989
+ }
7990
+ }
7991
+ ]
8025
7992
  },
8026
7993
  {
8027
7994
  "kind": "method",
8028
- "name": "checkValidity",
7995
+ "name": "updateCardRadio",
7996
+ "privacy": "private",
8029
7997
  "return": {
8030
7998
  "type": {
8031
- "text": "boolean"
7999
+ "text": "void"
8032
8000
  }
8033
8001
  },
8034
- "inheritedFrom": {
8035
- "name": "FormInternalsMixin",
8036
- "module": "utils/mixins/FormInternalsMixin.js"
8037
- }
8002
+ "parameters": [
8003
+ {
8004
+ "name": "cards",
8005
+ "type": {
8006
+ "text": "CardRadio[]"
8007
+ }
8008
+ },
8009
+ {
8010
+ "name": "index",
8011
+ "type": {
8012
+ "text": "number"
8013
+ }
8014
+ }
8015
+ ]
8038
8016
  },
8039
8017
  {
8040
8018
  "kind": "method",
8041
- "name": "reportValidity",
8042
- "inheritedFrom": {
8043
- "name": "FormInternalsMixin",
8044
- "module": "utils/mixins/FormInternalsMixin.js"
8045
- }
8019
+ "name": "toggleOnEnter",
8020
+ "privacy": "private",
8021
+ "parameters": [
8022
+ {
8023
+ "name": "event",
8024
+ "type": {
8025
+ "text": "KeyboardEvent"
8026
+ },
8027
+ "description": "The keyboard event"
8028
+ }
8029
+ ],
8030
+ "description": "Toggles the checked state when enter key is used"
8046
8031
  },
8047
8032
  {
8048
- "kind": "field",
8049
- "name": "dataAriaLabel",
8050
- "type": {
8051
- "text": "string | null"
8033
+ "kind": "method",
8034
+ "name": "toggleOnSpace",
8035
+ "privacy": "private",
8036
+ "parameters": [
8037
+ {
8038
+ "name": "event",
8039
+ "type": {
8040
+ "text": "KeyboardEvent"
8041
+ },
8042
+ "description": "The keyboard event"
8043
+ }
8044
+ ],
8045
+ "description": "Toggles the checked state when space key is used"
8046
+ },
8047
+ {
8048
+ "kind": "method",
8049
+ "name": "renderHeader",
8050
+ "privacy": "protected",
8051
+ "description": "Renders the header of the card",
8052
+ "return": {
8053
+ "type": {
8054
+ "text": ""
8055
+ }
8052
8056
  },
8053
- "default": "null",
8054
- "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
8055
- "attribute": "data-aria-label",
8056
- "reflects": true,
8057
8057
  "inheritedFrom": {
8058
- "name": "DataAriaLabelMixin",
8059
- "module": "utils/mixins/DataAriaLabelMixin.js"
8058
+ "name": "Card",
8059
+ "module": "components/card/card.component.js"
8060
8060
  }
8061
8061
  },
8062
8062
  {
@@ -8076,207 +8076,237 @@
8076
8076
  },
8077
8077
  {
8078
8078
  "kind": "field",
8079
- "name": "label",
8079
+ "name": "tabIndex",
8080
8080
  "type": {
8081
- "text": "string | undefined"
8081
+ "text": "number"
8082
8082
  },
8083
- "description": "The label of the input field. It is linked to the input field using the `for` attribute.",
8084
- "attribute": "label",
8083
+ "default": "0",
8084
+ "description": "This property specifies the tab order of the element.",
8085
+ "attribute": "tabIndex",
8085
8086
  "reflects": true,
8086
8087
  "inheritedFrom": {
8087
- "name": "FormfieldWrapper",
8088
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
8088
+ "name": "TabIndexMixin",
8089
+ "module": "utils/mixins/TabIndexMixin.js"
8089
8090
  }
8090
8091
  },
8091
8092
  {
8092
8093
  "kind": "field",
8093
- "name": "required",
8094
+ "name": "cardTitle",
8094
8095
  "type": {
8095
- "text": "boolean"
8096
+ "text": "string"
8096
8097
  },
8097
- "default": "false",
8098
- "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
8099
- "attribute": "required",
8098
+ "default": "''",
8099
+ "description": "The title of the card - part of header section",
8100
+ "attribute": "card-title",
8100
8101
  "reflects": true,
8101
8102
  "inheritedFrom": {
8102
- "name": "FormfieldWrapper",
8103
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
8103
+ "name": "Card",
8104
+ "module": "components/card/card.component.js"
8104
8105
  }
8105
8106
  },
8106
8107
  {
8107
8108
  "kind": "field",
8108
- "name": "id",
8109
+ "name": "subtitle",
8109
8110
  "type": {
8110
8111
  "text": "string"
8111
8112
  },
8112
8113
  "default": "''",
8113
- "description": "The unique id of the input field. It is used to link the input field with the label.",
8114
- "attribute": "id",
8114
+ "description": "The subtitle of the card - part of header section",
8115
+ "attribute": "subtitle",
8116
+ "reflects": true,
8115
8117
  "inheritedFrom": {
8116
- "name": "FormfieldWrapper",
8117
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
8118
+ "name": "Card",
8119
+ "module": "components/card/card.component.js"
8118
8120
  }
8119
8121
  },
8120
8122
  {
8121
8123
  "kind": "field",
8122
- "name": "helpTextType",
8124
+ "name": "imageSrc",
8123
8125
  "type": {
8124
- "text": "ValidationType"
8126
+ "text": "string"
8125
8127
  },
8126
- "description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
8127
- "attribute": "help-text-type",
8128
+ "default": "''",
8129
+ "description": "The image source URL to render on the card",
8130
+ "attribute": "image-src",
8128
8131
  "reflects": true,
8129
8132
  "inheritedFrom": {
8130
- "name": "FormfieldWrapper",
8131
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
8133
+ "name": "Card",
8134
+ "module": "components/card/card.component.js"
8132
8135
  }
8133
8136
  },
8134
8137
  {
8135
8138
  "kind": "field",
8136
- "name": "helpText",
8139
+ "name": "imageAlt",
8137
8140
  "type": {
8138
- "text": "string | undefined"
8141
+ "text": "string"
8139
8142
  },
8140
- "description": "The help text that is displayed below the input field.",
8141
- "attribute": "help-text",
8143
+ "default": "''",
8144
+ "description": "The image alt for accessibility support",
8145
+ "attribute": "image-alt",
8142
8146
  "reflects": true,
8143
8147
  "inheritedFrom": {
8144
- "name": "FormfieldWrapper",
8145
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
8148
+ "name": "Card",
8149
+ "module": "components/card/card.component.js"
8146
8150
  }
8147
8151
  },
8148
8152
  {
8149
8153
  "kind": "field",
8150
- "name": "toggletipText",
8154
+ "name": "variant",
8151
8155
  "type": {
8152
- "text": "string | undefined"
8156
+ "text": "CardVariant"
8153
8157
  },
8154
- "description": "The toggletip text that is displayed when the label is hovered.\nIt is used to provide additional information about the label.",
8155
- "attribute": "toggletip-text",
8158
+ "description": "The variant of the card. It can either be set to 'border' or 'ghost'",
8159
+ "default": "'border'",
8160
+ "attribute": "variant",
8156
8161
  "reflects": true,
8157
8162
  "inheritedFrom": {
8158
- "name": "FormfieldWrapper",
8159
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
8163
+ "name": "Card",
8164
+ "module": "components/card/card.component.js"
8160
8165
  }
8161
8166
  },
8162
8167
  {
8163
8168
  "kind": "field",
8164
- "name": "toggletipPlacement",
8169
+ "name": "orientation",
8165
8170
  "type": {
8166
- "text": "PopoverPlacement"
8171
+ "text": "CardOrientation"
8167
8172
  },
8168
- "description": "The placement of the toggletip that is displayed when the info icon is hovered.",
8169
- "default": "'top'",
8170
- "attribute": "toggletip-placement",
8173
+ "description": "The orientation of the card. It can either be set to 'vertical' or 'horizontal'",
8174
+ "default": "'vertical'",
8175
+ "attribute": "orientation",
8171
8176
  "reflects": true,
8172
8177
  "inheritedFrom": {
8173
- "name": "FormfieldWrapper",
8174
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
8178
+ "name": "Card",
8179
+ "module": "components/card/card.component.js"
8175
8180
  }
8176
8181
  },
8177
8182
  {
8178
8183
  "kind": "field",
8179
- "name": "infoIconAriaLabel",
8184
+ "name": "titleTagName",
8180
8185
  "type": {
8181
- "text": "string | undefined"
8186
+ "text": "TagNameType"
8182
8187
  },
8183
- "description": "Aria label for the info icon that is displayed next to the label when `toggletipText` is set.\nThis is used for accessibility purposes to provide a description of the icon.",
8184
- "attribute": "info-icon-aria-label",
8188
+ "description": "The tag name for the card title. It supports all the types that `mdc-text` supports",
8189
+ "default": "'span'",
8190
+ "attribute": "title-tag-name",
8185
8191
  "reflects": true,
8186
8192
  "inheritedFrom": {
8187
- "name": "FormfieldWrapper",
8188
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
8193
+ "name": "Card",
8194
+ "module": "components/card/card.component.js"
8189
8195
  }
8190
8196
  },
8191
8197
  {
8192
- "kind": "method",
8193
- "name": "renderLabelElement",
8194
- "privacy": "protected",
8195
- "description": "creates the label element when the label property is set.\nid is used to link the label with the input field.",
8196
- "return": {
8197
- "type": {
8198
- "text": ""
8199
- }
8198
+ "kind": "field",
8199
+ "name": "subtitleTagName",
8200
+ "type": {
8201
+ "text": "TagNameType"
8200
8202
  },
8203
+ "description": "The tag name for the subtitle. It supports all the types that `mdc-text` supports",
8204
+ "default": "'span'",
8205
+ "attribute": "subtitle-tag-name",
8206
+ "reflects": true,
8201
8207
  "inheritedFrom": {
8202
- "name": "FormfieldWrapper",
8203
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
8208
+ "name": "Card",
8209
+ "module": "components/card/card.component.js"
8210
+ }
8211
+ },
8212
+ {
8213
+ "kind": "field",
8214
+ "name": "iconName",
8215
+ "type": {
8216
+ "text": "IconNames | undefined"
8217
+ },
8218
+ "description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
8219
+ "attribute": "icon-name",
8220
+ "reflects": true,
8221
+ "inheritedFrom": {
8222
+ "name": "Card",
8223
+ "module": "components/card/card.component.js"
8204
8224
  }
8205
8225
  },
8206
8226
  {
8207
8227
  "kind": "method",
8208
- "name": "renderHelpTextIcon",
8228
+ "name": "renderImage",
8209
8229
  "privacy": "protected",
8210
- "description": "creates the helpertext icon based on the helpTextType for validation.\nIf the helpTextType is not set, it defaults to 'default' and it doesn't display any icon.",
8230
+ "description": "Renders the image on the card if image source is provided",
8211
8231
  "return": {
8212
8232
  "type": {
8213
8233
  "text": ""
8214
8234
  }
8215
8235
  },
8216
8236
  "inheritedFrom": {
8217
- "name": "FormfieldWrapper",
8218
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
8237
+ "name": "Card",
8238
+ "module": "components/card/card.component.js"
8219
8239
  }
8220
8240
  },
8221
8241
  {
8222
8242
  "kind": "method",
8223
- "name": "renderHelpText",
8243
+ "name": "renderIcon",
8224
8244
  "privacy": "protected",
8225
- "description": "creates the helper text component when the helpertext value is set.\nIt is also used to display the validation message based on the helpTextType.",
8245
+ "description": "Renders the icon on the card if icon name is provided",
8226
8246
  "return": {
8227
8247
  "type": {
8228
8248
  "text": ""
8229
8249
  }
8230
8250
  },
8231
8251
  "inheritedFrom": {
8232
- "name": "FormfieldWrapper",
8233
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
8252
+ "name": "Card",
8253
+ "module": "components/card/card.component.js"
8234
8254
  }
8235
8255
  },
8236
8256
  {
8237
8257
  "kind": "method",
8238
- "name": "renderLabel",
8258
+ "name": "renderTitle",
8239
8259
  "privacy": "protected",
8240
- "description": "renders the mdc-label-text container that contains the label and labelInfoToggleTip.",
8260
+ "description": "Renders the title and subtitle on the card",
8241
8261
  "return": {
8242
8262
  "type": {
8243
8263
  "text": ""
8244
8264
  }
8245
8265
  },
8246
8266
  "inheritedFrom": {
8247
- "name": "FormfieldWrapper",
8248
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
8267
+ "name": "Card",
8268
+ "module": "components/card/card.component.js"
8249
8269
  }
8250
8270
  },
8251
8271
  {
8252
8272
  "kind": "method",
8253
- "name": "renderHelperText",
8273
+ "name": "renderFooter",
8254
8274
  "privacy": "protected",
8255
- "description": "renders the mdc-help-text container that contains the helpertext icon and helpertext.",
8275
+ "description": "Renders the footer of the card if footer-link,\nfooter-button-primary, or footer-button-secondary slots are provided",
8256
8276
  "return": {
8257
8277
  "type": {
8258
8278
  "text": ""
8259
8279
  }
8260
8280
  },
8261
8281
  "inheritedFrom": {
8262
- "name": "FormfieldWrapper",
8263
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
8282
+ "name": "Card",
8283
+ "module": "components/card/card.component.js"
8264
8284
  }
8265
8285
  }
8266
8286
  ],
8267
8287
  "events": [
8268
8288
  {
8269
- "type": {
8270
- "text": "EventConstructor"
8271
- }
8289
+ "description": "(React: onClick) Event that gets dispatched when the card is clicked. It toggles the checked state.",
8290
+ "name": "click",
8291
+ "reactName": "onClick"
8272
8292
  },
8273
8293
  {
8274
- "description": "(React: onChange) Event that gets dispatched when the checkbox state changes.",
8294
+ "description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the card. It toggles the checked state when enter key is used.",
8295
+ "name": "keydown",
8296
+ "reactName": "onKeyDown"
8297
+ },
8298
+ {
8299
+ "description": "(React: onKeyUp) This event is dispatched when a key is released on the card. It toggles the checked state when space key is used.",
8300
+ "name": "keyup",
8301
+ "reactName": "onKeyUp"
8302
+ },
8303
+ {
8304
+ "description": "(React: onChange) Event that gets dispatched when the card state changes.",
8275
8305
  "name": "change",
8276
8306
  "reactName": "onChange"
8277
8307
  },
8278
8308
  {
8279
- "description": "(React: onFocus) Event that gets dispatched when the checkbox receives focus.",
8309
+ "description": "(React: onFocus) Event that gets dispatched when the card receives focus.",
8280
8310
  "name": "focus",
8281
8311
  "reactName": "onFocus"
8282
8312
  }
@@ -8288,207 +8318,177 @@
8288
8318
  "text": "boolean"
8289
8319
  },
8290
8320
  "default": "false",
8291
- "description": "Determines whether the checkbox is selected or unselected.",
8321
+ "description": "The checked state of the card",
8292
8322
  "fieldName": "checked"
8293
8323
  },
8294
- {
8295
- "name": "indeterminate",
8296
- "type": {
8297
- "text": "boolean"
8298
- },
8299
- "default": "false",
8300
- "description": "This property is used to determine the parent checkbox in a nested checkbox group.\nIf any one of the children is unselected, then the parent checkbox will be indeterminate.\nIf all children are either selected or unselected, then the parent checkbox will not be indeterminate.",
8301
- "fieldName": "indeterminate"
8302
- },
8303
- {
8304
- "name": "autofocus",
8305
- "type": {
8306
- "text": "boolean"
8307
- },
8308
- "default": "false",
8309
- "description": "Automatically focus on the element when the page loads.\n[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/autofocus)",
8310
- "fieldName": "autofocus"
8311
- },
8312
8324
  {
8313
8325
  "name": "name",
8314
8326
  "type": {
8315
8327
  "text": "string"
8316
8328
  },
8317
8329
  "default": "''",
8318
- "description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
8319
- "fieldName": "name",
8320
- "inheritedFrom": {
8321
- "name": "FormInternalsMixin",
8322
- "module": "src/utils/mixins/FormInternalsMixin.ts"
8323
- }
8324
- },
8325
- {
8326
- "name": "value",
8327
- "type": {
8328
- "text": "string"
8329
- },
8330
- "default": "''",
8331
- "description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
8332
- "fieldName": "value",
8333
- "inheritedFrom": {
8334
- "name": "FormInternalsMixin",
8335
- "module": "src/utils/mixins/FormInternalsMixin.ts"
8336
- }
8330
+ "description": "The name of the radio.",
8331
+ "fieldName": "name"
8337
8332
  },
8338
8333
  {
8339
- "name": "validation-message",
8334
+ "name": "disabled",
8340
8335
  "type": {
8341
- "text": "string | undefined"
8336
+ "text": "boolean | undefined"
8342
8337
  },
8343
- "description": "Custom validation message that will override the default message and displayed when the input is invalid.\n\nTo display custom validation messages, you must listen for input events (or other relevant events)\non your component and update the `validationMessage` property with the desired message string.\nUpdating this property will ensure that new validation messages are shown to the user.\n- The `validationMessage` property overrides the default browser validation message when set.\n- Consumers are responsible for updating `validationMessage` in response to input or validation state changes.",
8344
- "fieldName": "validationMessage",
8338
+ "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
8339
+ "default": "undefined",
8340
+ "fieldName": "disabled",
8345
8341
  "inheritedFrom": {
8346
- "name": "FormInternalsMixin",
8347
- "module": "src/utils/mixins/FormInternalsMixin.ts"
8342
+ "name": "DisabledMixin",
8343
+ "module": "src/utils/mixins/DisabledMixin.ts"
8348
8344
  }
8349
8345
  },
8350
8346
  {
8351
- "name": "data-aria-label",
8347
+ "name": "tabIndex",
8352
8348
  "type": {
8353
- "text": "string | null"
8349
+ "text": "number"
8354
8350
  },
8355
- "default": "null",
8356
- "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
8357
- "fieldName": "dataAriaLabel",
8351
+ "default": "0",
8352
+ "description": "This property specifies the tab order of the element.",
8353
+ "fieldName": "tabIndex",
8358
8354
  "inheritedFrom": {
8359
- "name": "DataAriaLabelMixin",
8360
- "module": "src/utils/mixins/DataAriaLabelMixin.ts"
8355
+ "name": "TabIndexMixin",
8356
+ "module": "src/utils/mixins/TabIndexMixin.ts"
8361
8357
  }
8362
8358
  },
8363
8359
  {
8364
- "name": "disabled",
8360
+ "name": "card-title",
8365
8361
  "type": {
8366
- "text": "boolean | undefined"
8362
+ "text": "string"
8367
8363
  },
8368
- "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
8369
- "default": "undefined",
8370
- "fieldName": "disabled",
8364
+ "default": "''",
8365
+ "description": "The title of the card - part of header section",
8366
+ "fieldName": "cardTitle",
8371
8367
  "inheritedFrom": {
8372
- "name": "DisabledMixin",
8373
- "module": "src/utils/mixins/DisabledMixin.ts"
8368
+ "name": "Card",
8369
+ "module": "src/components/card/card.component.ts"
8374
8370
  }
8375
8371
  },
8376
8372
  {
8377
- "name": "label",
8373
+ "name": "subtitle",
8378
8374
  "type": {
8379
- "text": "string | undefined"
8375
+ "text": "string"
8380
8376
  },
8381
- "description": "The label of the input field. It is linked to the input field using the `for` attribute.",
8382
- "fieldName": "label",
8377
+ "default": "''",
8378
+ "description": "The subtitle of the card - part of header section",
8379
+ "fieldName": "subtitle",
8383
8380
  "inheritedFrom": {
8384
- "name": "FormfieldWrapper",
8385
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
8381
+ "name": "Card",
8382
+ "module": "src/components/card/card.component.ts"
8386
8383
  }
8387
8384
  },
8388
8385
  {
8389
- "name": "required",
8386
+ "name": "image-src",
8390
8387
  "type": {
8391
- "text": "boolean"
8388
+ "text": "string"
8392
8389
  },
8393
- "default": "false",
8394
- "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
8395
- "fieldName": "required",
8390
+ "default": "''",
8391
+ "description": "The image source URL to render on the card",
8392
+ "fieldName": "imageSrc",
8396
8393
  "inheritedFrom": {
8397
- "name": "FormfieldWrapper",
8398
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
8394
+ "name": "Card",
8395
+ "module": "src/components/card/card.component.ts"
8399
8396
  }
8400
8397
  },
8401
8398
  {
8402
- "name": "id",
8399
+ "name": "image-alt",
8403
8400
  "type": {
8404
8401
  "text": "string"
8405
8402
  },
8406
8403
  "default": "''",
8407
- "description": "The unique id of the input field. It is used to link the input field with the label.",
8408
- "fieldName": "id",
8404
+ "description": "The image alt for accessibility support",
8405
+ "fieldName": "imageAlt",
8409
8406
  "inheritedFrom": {
8410
- "name": "FormfieldWrapper",
8411
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
8407
+ "name": "Card",
8408
+ "module": "src/components/card/card.component.ts"
8412
8409
  }
8413
8410
  },
8414
8411
  {
8415
- "name": "help-text-type",
8412
+ "name": "variant",
8416
8413
  "type": {
8417
- "text": "ValidationType"
8414
+ "text": "CardVariant"
8418
8415
  },
8419
- "description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
8420
- "fieldName": "helpTextType",
8416
+ "description": "The variant of the card. It can either be set to 'border' or 'ghost'",
8417
+ "default": "'border'",
8418
+ "fieldName": "variant",
8421
8419
  "inheritedFrom": {
8422
- "name": "FormfieldWrapper",
8423
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
8420
+ "name": "Card",
8421
+ "module": "src/components/card/card.component.ts"
8424
8422
  }
8425
8423
  },
8426
8424
  {
8427
- "name": "help-text",
8425
+ "name": "orientation",
8428
8426
  "type": {
8429
- "text": "string | undefined"
8427
+ "text": "CardOrientation"
8430
8428
  },
8431
- "description": "The help text that is displayed below the input field.",
8432
- "fieldName": "helpText",
8429
+ "description": "The orientation of the card. It can either be set to 'vertical' or 'horizontal'",
8430
+ "default": "'vertical'",
8431
+ "fieldName": "orientation",
8433
8432
  "inheritedFrom": {
8434
- "name": "FormfieldWrapper",
8435
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
8433
+ "name": "Card",
8434
+ "module": "src/components/card/card.component.ts"
8436
8435
  }
8437
8436
  },
8438
8437
  {
8439
- "name": "toggletip-text",
8438
+ "name": "title-tag-name",
8440
8439
  "type": {
8441
- "text": "string | undefined"
8440
+ "text": "TagNameType"
8442
8441
  },
8443
- "description": "The toggletip text that is displayed when the label is hovered.\nIt is used to provide additional information about the label.",
8444
- "fieldName": "toggletipText",
8442
+ "description": "The tag name for the card title. It supports all the types that `mdc-text` supports",
8443
+ "default": "'span'",
8444
+ "fieldName": "titleTagName",
8445
8445
  "inheritedFrom": {
8446
- "name": "FormfieldWrapper",
8447
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
8446
+ "name": "Card",
8447
+ "module": "src/components/card/card.component.ts"
8448
8448
  }
8449
8449
  },
8450
8450
  {
8451
- "name": "toggletip-placement",
8451
+ "name": "subtitle-tag-name",
8452
8452
  "type": {
8453
- "text": "PopoverPlacement"
8453
+ "text": "TagNameType"
8454
8454
  },
8455
- "description": "The placement of the toggletip that is displayed when the info icon is hovered.",
8456
- "default": "'top'",
8457
- "fieldName": "toggletipPlacement",
8455
+ "description": "The tag name for the subtitle. It supports all the types that `mdc-text` supports",
8456
+ "default": "'span'",
8457
+ "fieldName": "subtitleTagName",
8458
8458
  "inheritedFrom": {
8459
- "name": "FormfieldWrapper",
8460
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
8459
+ "name": "Card",
8460
+ "module": "src/components/card/card.component.ts"
8461
8461
  }
8462
8462
  },
8463
8463
  {
8464
- "name": "info-icon-aria-label",
8464
+ "name": "icon-name",
8465
8465
  "type": {
8466
- "text": "string | undefined"
8466
+ "text": "IconNames | undefined"
8467
8467
  },
8468
- "description": "Aria label for the info icon that is displayed next to the label when `toggletipText` is set.\nThis is used for accessibility purposes to provide a description of the icon.",
8469
- "fieldName": "infoIconAriaLabel",
8468
+ "description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
8469
+ "fieldName": "iconName",
8470
8470
  "inheritedFrom": {
8471
- "name": "FormfieldWrapper",
8472
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
8471
+ "name": "Card",
8472
+ "module": "src/components/card/card.component.ts"
8473
8473
  }
8474
8474
  }
8475
8475
  ],
8476
8476
  "mixins": [
8477
8477
  {
8478
- "name": "FormInternalsMixin",
8479
- "module": "/src/utils/mixins/FormInternalsMixin"
8478
+ "name": "DisabledMixin",
8479
+ "module": "/src/utils/mixins/DisabledMixin"
8480
8480
  },
8481
8481
  {
8482
- "name": "DataAriaLabelMixin",
8483
- "module": "/src/utils/mixins/DataAriaLabelMixin"
8482
+ "name": "TabIndexMixin",
8483
+ "module": "/src/utils/mixins/TabIndexMixin"
8484
8484
  }
8485
8485
  ],
8486
8486
  "superclass": {
8487
- "name": "FormfieldWrapper",
8488
- "module": "/src/components/formfieldwrapper/formfieldwrapper.component"
8487
+ "name": "Card",
8488
+ "module": "/src/components/card/card.component"
8489
8489
  },
8490
- "tagName": "mdc-checkbox",
8491
- "jsDoc": "/**\n * Checkboxes allow users to select multiple options from a list or turn an item/feature on or off.\n * These are often used in forms, settings, and selections in lists.\n *\n * A checkbox component contains an optional label and an optional helper text.\n *\n * To create a group of checkboxes, use the FormFieldGroup component.\n *\n * @dependency mdc-button\n * @dependency mdc-icon\n * @dependency mdc-staticcheckbox\n * @dependency mdc-text\n * @dependency mdc-toggletip\n *\n * @tagname mdc-checkbox\n *\n * @event change - (React: onChange) Event that gets dispatched when the checkbox state changes.\n * @event focus - (React: onFocus) Event that gets dispatched when the checkbox receives focus.\n *\n * @cssproperty --mdc-checkbox-background-color-hover - Allows customization of the background color on hover.\n * @cssproperty --mdc-checkbox-checked-background-color-hover - Background color for a selected checkbox when hovered.\n * @cssproperty --mdc-checkbox-checked-pressed-icon-color - Background color for a selected checkbox when pressed.\n * @cssproperty --mdc-checkbox-pressed-icon-color - Background color for a selected checkbox when pressed.\n * @cssproperty --mdc-checkbox-disabled-checked-icon-color - Background color for a selected checkbox when disabled.\n */",
8490
+ "tagName": "mdc-cardradio",
8491
+ "jsDoc": "/**\n * cardradio component extends `mdc-card` and supports radio selection interaction addtionally.\n *\n * While using this component within a form or group of cards, make sure cards are in a role = \"radio-group\".\n * This card would have events for selected and unselected (similar to radio)\n *\n * **Note**: This is a single selection card i.e. interacting anywhere on the card would toggle the checked state.\n * Make sure to pass only non-interactable elements within the slots.\n *\n * Make sure to pass the `card-title` mandatorily for this card.\n *\n * @tagname mdc-cardradio\n *\n * @dependency mdc-icon\n * @dependency mdc-staticradio\n * @dependency mdc-text\n *\n * @slot before-body - This slot is for passing the content before the body\n * @slot body - This slot is for passing the text content for the card\n * @slot after-body - This slot is for passing the content after the body\n * @slot footer-link - This slot is for passing `mdc-link` component within the footer section.\n * @slot footer-button-primary - This slot is for passing primary variant of `mdc-button` component within the footer section.\n *\n * @csspart header - The header part of the card\n * @csspart icon - The icon part of the card header\n * @csspart body - The body part of the card\n * @csspart image - The image part of the card\n * @csspart footer - The footer part of the card\n * @csspart footer-link - The link part of the card footer\n * @csspart footer-button-primary - The primary button part of the card footer\n * @csspart footer-button-secondary - The secondary button part of the card footer\n * @csspart icon-button - The icon button part of the card header\n * @csspart text - The text part of the card\n * @csspart check - The check part of the card\n * @csspart check-icon - The check icon part of the card\n * @csspart check-icon-button - The check icon button part of the card\n *\n * @cssproperty --mdc-card-width - The width of the card\n *\n * @event click - (React: onClick) Event that gets dispatched when the card is clicked. It toggles the checked state.\n * @event keydown - (React: onKeyDown) This event is dispatched when a key is pressed down on the card.\n * It toggles the checked state when enter key is used.\n * @event keyup - (React: onKeyUp) This event is dispatched when a key is released on the card.\n * It toggles the checked state when space key is used.\n * @event change - (React: onChange) Event that gets dispatched when the card state changes.\n * @event focus - (React: onFocus) Event that gets dispatched when the card receives focus.\n *\n */",
8492
8492
  "customElement": true
8493
8493
  }
8494
8494
  ],
@@ -8497,8 +8497,8 @@
8497
8497
  "kind": "js",
8498
8498
  "name": "default",
8499
8499
  "declaration": {
8500
- "name": "Checkbox",
8501
- "module": "components/checkbox/checkbox.component.js"
8500
+ "name": "CardRadio",
8501
+ "module": "components/cardradio/cardradio.component.js"
8502
8502
  }
8503
8503
  }
8504
8504
  ]