@momentum-design/components 0.112.4 → 0.112.6

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.
@@ -342,157 +342,6 @@
342
342
  }
343
343
  ]
344
344
  },
345
- {
346
- "kind": "javascript-module",
347
- "path": "components/accordiongroup/accordiongroup.component.js",
348
- "declarations": [
349
- {
350
- "kind": "class",
351
- "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.",
352
- "name": "AccordionGroup",
353
- "cssProperties": [
354
- {
355
- "description": "The border color of the entire accordiongroup",
356
- "name": "--mdc-accordiongroup-border-color"
357
- }
358
- ],
359
- "slots": [
360
- {
361
- "description": "The default slot can contain the `accordion` or `accordionbutton` components.",
362
- "name": "default"
363
- }
364
- ],
365
- "members": [
366
- {
367
- "kind": "field",
368
- "name": "size",
369
- "type": {
370
- "text": "Size"
371
- },
372
- "description": "The size of the accordion item.",
373
- "default": "'small'",
374
- "attribute": "size",
375
- "reflects": true
376
- },
377
- {
378
- "kind": "field",
379
- "name": "variant",
380
- "type": {
381
- "text": "Variant"
382
- },
383
- "description": "The variant of the accordion item. Based on the variant, the styling of the accordion gets changed.",
384
- "default": "'stacked'",
385
- "attribute": "variant",
386
- "reflects": true
387
- },
388
- {
389
- "kind": "field",
390
- "name": "allowMultiple",
391
- "type": {
392
- "text": "boolean"
393
- },
394
- "default": "false",
395
- "description": "If true, multiple accordion items can be visible at the same time.",
396
- "attribute": "allow-multiple",
397
- "reflects": true
398
- },
399
- {
400
- "kind": "method",
401
- "name": "handleAccordionExpanded",
402
- "privacy": "private",
403
- "return": {
404
- "type": {
405
- "text": "void"
406
- }
407
- },
408
- "parameters": [
409
- {
410
- "name": "event",
411
- "type": {
412
- "text": "Event"
413
- },
414
- "description": "The event object from the 'shown' event."
415
- }
416
- ],
417
- "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."
418
- },
419
- {
420
- "kind": "method",
421
- "name": "setChildrenAccordionAttributes",
422
- "privacy": "private",
423
- "return": {
424
- "type": {
425
- "text": "void"
426
- }
427
- },
428
- "parameters": [
429
- {
430
- "name": "attributeName",
431
- "type": {
432
- "text": "string"
433
- },
434
- "description": "The name of the attribute to set."
435
- },
436
- {
437
- "name": "attributeValue",
438
- "type": {
439
- "text": "string"
440
- },
441
- "description": "The value to set the attribute to."
442
- }
443
- ],
444
- "description": "Sets the given attribute on all child accordion or accordionbutton components."
445
- }
446
- ],
447
- "attributes": [
448
- {
449
- "name": "size",
450
- "type": {
451
- "text": "Size"
452
- },
453
- "description": "The size of the accordion item.",
454
- "default": "'small'",
455
- "fieldName": "size"
456
- },
457
- {
458
- "name": "variant",
459
- "type": {
460
- "text": "Variant"
461
- },
462
- "description": "The variant of the accordion item. Based on the variant, the styling of the accordion gets changed.",
463
- "default": "'stacked'",
464
- "fieldName": "variant"
465
- },
466
- {
467
- "name": "allow-multiple",
468
- "type": {
469
- "text": "boolean"
470
- },
471
- "default": "false",
472
- "description": "If true, multiple accordion items can be visible at the same time.",
473
- "fieldName": "allowMultiple"
474
- }
475
- ],
476
- "superclass": {
477
- "name": "Component",
478
- "module": "/src/models"
479
- },
480
- "tagName": "mdc-accordiongroup",
481
- "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 */",
482
- "customElement": true
483
- }
484
- ],
485
- "exports": [
486
- {
487
- "kind": "js",
488
- "name": "default",
489
- "declaration": {
490
- "name": "AccordionGroup",
491
- "module": "components/accordiongroup/accordiongroup.component.js"
492
- }
493
- }
494
- ]
495
- },
496
345
  {
497
346
  "kind": "javascript-module",
498
347
  "path": "components/accordion/accordion.component.js",
@@ -970,102 +819,253 @@
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": "autoFocusOnMount",
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 mounted.\n\nIt will not focus if the element is re-attached to the DOM after being removed.",
1036
- "attribute": "auto-focus-on-mount",
1037
- "reflects": true,
1038
- "inheritedFrom": {
1039
- "name": "AutoFocusOnMountMixin",
1040
- "module": "utils/mixins/AutoFocusOnMountMixin.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": {
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"
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/alertchip/alertchip.component.js",
974
+ "declarations": [
975
+ {
976
+ "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",
979
+ "cssProperties": [
980
+ {
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"
995
+ }
996
+ ],
997
+ "cssParts": [
998
+ {
999
+ "description": "The alert icon",
1000
+ "name": "icon"
1001
+ },
1002
+ {
1003
+ "description": "The text label of the alertchip",
1004
+ "name": "label"
1005
+ }
1006
+ ],
1007
+ "members": [
1008
+ {
1009
+ "kind": "field",
1010
+ "name": "variant",
1011
+ "type": {
1012
+ "text": "VariantType"
1013
+ },
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"
1017
+ },
1018
+ {
1019
+ "kind": "field",
1020
+ "name": "label",
1021
+ "type": {
1022
+ "text": "string"
1023
+ },
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"
1027
+ },
1028
+ {
1029
+ "kind": "field",
1030
+ "name": "autoFocusOnMount",
1031
+ "type": {
1032
+ "text": "boolean"
1033
+ },
1034
+ "default": "false",
1035
+ "description": "This property indicates whether the element should receive focus automatically when it is mounted.\n\nIt will not focus if the element is re-attached to the DOM after being removed.",
1036
+ "attribute": "auto-focus-on-mount",
1037
+ "reflects": true,
1038
+ "inheritedFrom": {
1039
+ "name": "AutoFocusOnMountMixin",
1040
+ "module": "utils/mixins/AutoFocusOnMountMixin.js"
1041
+ }
1042
+ },
1043
+ {
1044
+ "kind": "field",
1045
+ "name": "tabIndex",
1046
+ "type": {
1047
+ "text": "number"
1048
+ },
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
+ }
1057
+ },
1058
+ {
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
1069
  "name": "DisabledMixin",
1070
1070
  "module": "utils/mixins/DisabledMixin.js"
1071
1071
  }
@@ -1829,57 +1829,76 @@
1829
1829
  },
1830
1830
  {
1831
1831
  "kind": "javascript-module",
1832
- "path": "components/avatar/avatar.component.js",
1832
+ "path": "components/avatarbutton/avatarbutton.component.js",
1833
1833
  "declarations": [
1834
1834
  {
1835
1835
  "kind": "class",
1836
- "description": "The `mdc-avatar` component is used to represent a person or a space.\nAn avatar can be an icon, initials, counter and photo.\n\nTo set the photo of an avatar,\nyou need to set \"src\" attribute.\n\nWhile the avatar image is loading, as a placeholder,\nwe will show the initials text.\nIf the initials are not specified then,\nwe will show `user-regular` icon as a placeholder.\n\nBy default, if there are no attributes specified,\nthen the default avatar will be an icon with `user-regular` name.\n\nThe avatar component is non clickable and non interactive/focusable component.\nIf the avatar is typing, then the loading indicator will be displayed.\nIf the counter type avatar is set to a negative number, then we will display 0.\nThe presence indicator will be hidden when the counter property is set.",
1837
- "name": "Avatar",
1836
+ "description": "The `mdc-avatarbutton` component is an interactable version of the `mdc-avatar` component.\n\nThis component is made by extending `buttonsimple` class.\nThe button component acts as a wrapper for the avatar component.\n\nTo override styles of the avatar inside, use the specified css parts.",
1837
+ "name": "AvatarButton",
1838
1838
  "cssProperties": [
1839
1839
  {
1840
- "description": "Allows customization of the default background color.",
1841
- "name": "--mdc-avatar-default-background-color"
1842
- },
1843
- {
1844
- "description": "Allows customization of the default foreground color.",
1845
- "name": "--mdc-avatar-default-foreground-color"
1846
- },
1847
- {
1848
- "description": "Allows customization of the loading indicator background color.",
1849
- "name": "--mdc-avatar-loading-indicator-background-color"
1840
+ "description": "Background color of the overlay in rest state",
1841
+ "name": "--mdc-avatarbutton-overlay-background-color-rest"
1850
1842
  },
1851
1843
  {
1852
- "description": "Allows customization of the loading indicator foreground color.",
1853
- "name": "--mdc-avatar-loading-indicator-foreground-color"
1844
+ "description": "Background color of the overlay in hover state",
1845
+ "name": "--mdc-avatarbutton-overlay-background-color-hover"
1854
1846
  },
1855
1847
  {
1856
- "description": "Allows customization of the loading overlay background color.",
1857
- "name": "--mdc-avatar-loading-overlay-background-color"
1848
+ "description": "Background color of the overlay in active state",
1849
+ "name": "--mdc-avatarbutton-overlay-background-color-active"
1858
1850
  }
1859
1851
  ],
1860
1852
  "cssParts": [
1853
+ {
1854
+ "description": "The overlay part of the avatar button.",
1855
+ "name": "overlay"
1856
+ },
1861
1857
  {
1862
1858
  "description": "The main content of the avatar.",
1863
1859
  "name": "content"
1864
1860
  },
1865
1861
  {
1866
- "description": "The photo of the avatar.",
1862
+ "description": "The photo part of the avatar.",
1867
1863
  "name": "photo"
1868
1864
  },
1869
1865
  {
1870
- "description": "The presence indicator of the avatar.",
1866
+ "description": "The presence indicator part of the avatar.",
1871
1867
  "name": "presence"
1872
1868
  },
1873
1869
  {
1874
- "description": "The wrapper for the loading indicator.",
1870
+ "description": "The wrapper for the loading indicator of the avatar.",
1875
1871
  "name": "loading-wrapper"
1876
1872
  },
1877
1873
  {
1878
- "description": "The loading indicator of the avatar.",
1874
+ "description": "The loading indicator part of the avatar.",
1879
1875
  "name": "loader"
1880
1876
  }
1881
1877
  ],
1882
1878
  "members": [
1879
+ {
1880
+ "kind": "field",
1881
+ "name": "ariaLabel",
1882
+ "type": {
1883
+ "text": "string | null"
1884
+ },
1885
+ "default": "null",
1886
+ "description": "Aria-label attribute to be set for accessibility",
1887
+ "attribute": "aria-label"
1888
+ },
1889
+ {
1890
+ "kind": "method",
1891
+ "name": "setSize",
1892
+ "privacy": "private",
1893
+ "parameters": [
1894
+ {
1895
+ "name": "size",
1896
+ "type": {
1897
+ "text": "AvatarSize"
1898
+ }
1899
+ }
1900
+ ]
1901
+ },
1883
1902
  {
1884
1903
  "kind": "field",
1885
1904
  "name": "src",
@@ -1923,15 +1942,15 @@
1923
1942
  "kind": "field",
1924
1943
  "name": "size",
1925
1944
  "type": {
1926
- "text": "AvatarSize"
1945
+ "text": "ButtonSize"
1927
1946
  },
1928
1947
  "description": "Acceptable values include (size in px unit):\n- 24\n- 32\n- 48\n- 64\n- 72\n- 88\n- 124",
1929
1948
  "default": "32",
1930
1949
  "attribute": "size",
1931
1950
  "reflects": true,
1932
1951
  "inheritedFrom": {
1933
- "name": "AvatarComponentMixin",
1934
- "module": "utils/mixins/AvatarComponentMixin.js"
1952
+ "name": "Buttonsimple",
1953
+ "module": "components/buttonsimple/buttonsimple.component.js"
1935
1954
  }
1936
1955
  },
1937
1956
  {
@@ -1973,246 +1992,149 @@
1973
1992
  "name": "IconNameMixin",
1974
1993
  "module": "utils/mixins/IconNameMixin.js"
1975
1994
  }
1976
- }
1977
- ],
1978
- "mixins": [
1979
- {
1980
- "name": "AvatarComponentMixin",
1981
- "module": "/src/utils/mixins/AvatarComponentMixin"
1982
1995
  },
1983
1996
  {
1984
- "name": "IconNameMixin",
1985
- "module": "/src/utils/mixins/IconNameMixin"
1986
- }
1987
- ],
1988
- "superclass": {
1989
- "name": "Component",
1990
- "module": "/src/models"
1991
- },
1992
- "tagName": "mdc-avatar",
1993
- "jsDoc": "/**\n * The `mdc-avatar` component is used to represent a person or a space.\n * An avatar can be an icon, initials, counter and photo.\n *\n * To set the photo of an avatar,\n * you need to set \"src\" attribute.\n *\n * While the avatar image is loading, as a placeholder,\n * we will show the initials text.\n * If the initials are not specified then,\n * we will show `user-regular` icon as a placeholder.\n *\n * By default, if there are no attributes specified,\n * then the default avatar will be an icon with `user-regular` name.\n *\n * The avatar component is non clickable and non interactive/focusable component.\n * If the avatar is typing, then the loading indicator will be displayed.\n * If the counter type avatar is set to a negative number, then we will display 0.\n * The presence indicator will be hidden when the counter property is set.\n *\n * @dependency mdc-icon\n * @dependency mdc-presence\n * @dependency mdc-text\n *\n * @tagname mdc-avatar\n *\n * @cssproperty --mdc-avatar-default-background-color - Allows customization of the default background color.\n * @cssproperty --mdc-avatar-default-foreground-color - Allows customization of the default foreground color.\n * @cssproperty --mdc-avatar-loading-indicator-background-color -\n * Allows customization of the loading indicator background color.\n * @cssproperty --mdc-avatar-loading-indicator-foreground-color -\n * Allows customization of the loading indicator foreground color.\n * @cssproperty --mdc-avatar-loading-overlay-background-color -\n * Allows customization of the loading overlay background color.\n *\n * @csspart content - The main content of the avatar.\n * @csspart photo - The photo of the avatar.\n * @csspart presence - The presence indicator of the avatar.\n * @csspart loading-wrapper - The wrapper for the loading indicator.\n * @csspart loader - The loading indicator of the avatar.\n */",
1994
- "customElement": true,
1995
- "attributes": [
1996
- {
1997
- "name": "src",
1998
- "type": {
1999
- "text": "string | undefined"
2000
- },
2001
- "description": "The src is the url which will be used to display the avatar.\nWhen the src is loading, we will display the initials as a placeholder.",
2002
- "fieldName": "src",
2003
- "inheritedFrom": {
2004
- "name": "AvatarComponentMixin",
2005
- "module": "src/utils/mixins/AvatarComponentMixin.ts"
2006
- }
2007
- },
2008
- {
2009
- "name": "initials",
1997
+ "kind": "field",
1998
+ "name": "autoFocusOnMount",
2010
1999
  "type": {
2011
- "text": "string | undefined"
2000
+ "text": "boolean"
2012
2001
  },
2013
- "description": "The initials to be displayed for the avatar.",
2014
- "fieldName": "initials",
2002
+ "default": "false",
2003
+ "description": "This property indicates whether the element should receive focus automatically when it is mounted.\n\nIt will not focus if the element is re-attached to the DOM after being removed.",
2004
+ "attribute": "auto-focus-on-mount",
2005
+ "reflects": true,
2015
2006
  "inheritedFrom": {
2016
- "name": "AvatarComponentMixin",
2017
- "module": "src/utils/mixins/AvatarComponentMixin.ts"
2007
+ "name": "AutoFocusOnMountMixin",
2008
+ "module": "utils/mixins/AutoFocusOnMountMixin.js"
2018
2009
  }
2019
2010
  },
2020
2011
  {
2021
- "name": "presence",
2012
+ "kind": "field",
2013
+ "name": "tabIndex",
2022
2014
  "type": {
2023
- "text": "PresenceType | undefined"
2015
+ "text": "number"
2024
2016
  },
2025
- "description": "The presence is the status which can be used to display the\nactivity state of a user or a space within an avatar component.\n\nAcceptable values include:\n- `active`\n- `away`\n- `away-calling`\n- `busy`\n- `dnd`\n- `meeting`\n- `on-call`\n- `on-device`\n- `on-mobile`\n- `pause`\n- `pto`\n- `presenting`\n- `quiet`\n- `scheduled`",
2026
- "fieldName": "presence",
2017
+ "default": "0",
2018
+ "description": "This property specifies the tab order of the element.",
2019
+ "attribute": "tabIndex",
2020
+ "reflects": true,
2027
2021
  "inheritedFrom": {
2028
- "name": "AvatarComponentMixin",
2029
- "module": "src/utils/mixins/AvatarComponentMixin.ts"
2022
+ "name": "TabIndexMixin",
2023
+ "module": "utils/mixins/TabIndexMixin.js"
2030
2024
  }
2031
2025
  },
2032
2026
  {
2033
- "name": "size",
2027
+ "kind": "field",
2028
+ "name": "disabled",
2034
2029
  "type": {
2035
- "text": "AvatarSize"
2030
+ "text": "boolean | undefined"
2036
2031
  },
2037
- "description": "Acceptable values include (size in px unit):\n- 24\n- 32\n- 48\n- 64\n- 72\n- 88\n- 124",
2038
- "default": "32",
2039
- "fieldName": "size",
2032
+ "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
2033
+ "default": "undefined",
2034
+ "attribute": "disabled",
2035
+ "reflects": true,
2040
2036
  "inheritedFrom": {
2041
- "name": "AvatarComponentMixin",
2042
- "module": "src/utils/mixins/AvatarComponentMixin.ts"
2037
+ "name": "DisabledMixin",
2038
+ "module": "utils/mixins/DisabledMixin.js"
2043
2039
  }
2044
2040
  },
2045
2041
  {
2046
- "name": "counter",
2042
+ "kind": "field",
2043
+ "name": "active",
2047
2044
  "type": {
2048
- "text": "number | undefined"
2045
+ "text": "boolean | undefined"
2049
2046
  },
2050
- "description": "The counter is the number which can be displayed on the avatar.\nThe maximum number is 99 and if the given number is greater than 99,\nthen the avatar will be displayed as `99+`.\nIf the given number is a negative number,\nthen the avatar will be displayed as `0`.",
2051
- "fieldName": "counter",
2047
+ "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.",
2048
+ "default": "undefined",
2049
+ "attribute": "active",
2050
+ "reflects": true,
2052
2051
  "inheritedFrom": {
2053
- "name": "AvatarComponentMixin",
2054
- "module": "src/utils/mixins/AvatarComponentMixin.ts"
2052
+ "name": "Buttonsimple",
2053
+ "module": "components/buttonsimple/buttonsimple.component.js"
2055
2054
  }
2056
2055
  },
2057
2056
  {
2058
- "name": "is-typing",
2057
+ "kind": "field",
2058
+ "name": "softDisabled",
2059
2059
  "type": {
2060
- "text": "boolean"
2060
+ "text": "boolean | undefined"
2061
2061
  },
2062
- "default": "false",
2063
- "description": "Represents the typing indicator when the user is typing.",
2064
- "fieldName": "isTyping",
2062
+ "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.",
2063
+ "default": "undefined",
2064
+ "attribute": "soft-disabled",
2065
+ "reflects": true,
2065
2066
  "inheritedFrom": {
2066
- "name": "AvatarComponentMixin",
2067
- "module": "src/utils/mixins/AvatarComponentMixin.ts"
2067
+ "name": "Buttonsimple",
2068
+ "module": "components/buttonsimple/buttonsimple.component.js"
2068
2069
  }
2069
2070
  },
2070
2071
  {
2071
- "name": "icon-name",
2072
+ "kind": "field",
2073
+ "name": "role",
2072
2074
  "type": {
2073
- "text": "IconNames | undefined"
2075
+ "text": "RoleType"
2074
2076
  },
2075
- "description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
2076
- "fieldName": "iconName",
2077
+ "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.",
2078
+ "default": "button",
2079
+ "attribute": "role",
2080
+ "reflects": true,
2077
2081
  "inheritedFrom": {
2078
- "name": "IconNameMixin",
2079
- "module": "src/utils/mixins/IconNameMixin.ts"
2082
+ "name": "Buttonsimple",
2083
+ "module": "components/buttonsimple/buttonsimple.component.js"
2080
2084
  }
2081
- }
2082
- ]
2083
- }
2084
- ],
2085
- "exports": [
2086
- {
2087
- "kind": "js",
2088
- "name": "default",
2089
- "declaration": {
2090
- "name": "Avatar",
2091
- "module": "components/avatar/avatar.component.js"
2092
- }
2093
- }
2094
- ]
2095
- },
2096
- {
2097
- "kind": "javascript-module",
2098
- "path": "components/avatarbutton/avatarbutton.component.js",
2099
- "declarations": [
2100
- {
2101
- "kind": "class",
2102
- "description": "The `mdc-avatarbutton` component is an interactable version of the `mdc-avatar` component.\n\nThis component is made by extending `buttonsimple` class.\nThe button component acts as a wrapper for the avatar component.\n\nTo override styles of the avatar inside, use the specified css parts.",
2103
- "name": "AvatarButton",
2104
- "cssProperties": [
2105
- {
2106
- "description": "Background color of the overlay in rest state",
2107
- "name": "--mdc-avatarbutton-overlay-background-color-rest"
2108
- },
2109
- {
2110
- "description": "Background color of the overlay in hover state",
2111
- "name": "--mdc-avatarbutton-overlay-background-color-hover"
2112
- },
2113
- {
2114
- "description": "Background color of the overlay in active state",
2115
- "name": "--mdc-avatarbutton-overlay-background-color-active"
2116
- }
2117
- ],
2118
- "cssParts": [
2119
- {
2120
- "description": "The overlay part of the avatar button.",
2121
- "name": "overlay"
2122
- },
2123
- {
2124
- "description": "The main content of the avatar.",
2125
- "name": "content"
2126
- },
2127
- {
2128
- "description": "The photo part of the avatar.",
2129
- "name": "photo"
2130
- },
2131
- {
2132
- "description": "The presence indicator part of the avatar.",
2133
- "name": "presence"
2134
- },
2135
- {
2136
- "description": "The wrapper for the loading indicator of the avatar.",
2137
- "name": "loading-wrapper"
2138
- },
2139
- {
2140
- "description": "The loading indicator part of the avatar.",
2141
- "name": "loader"
2142
- }
2143
- ],
2144
- "members": [
2145
- {
2146
- "kind": "field",
2147
- "name": "ariaLabel",
2148
- "type": {
2149
- "text": "string | null"
2150
- },
2151
- "default": "null",
2152
- "description": "Aria-label attribute to be set for accessibility",
2153
- "attribute": "aria-label"
2154
- },
2155
- {
2156
- "kind": "method",
2157
- "name": "setSize",
2158
- "privacy": "private",
2159
- "parameters": [
2160
- {
2161
- "name": "size",
2162
- "type": {
2163
- "text": "AvatarSize"
2164
- }
2165
- }
2166
- ]
2167
2085
  },
2168
2086
  {
2169
2087
  "kind": "field",
2170
- "name": "src",
2088
+ "name": "ariaStateKey",
2171
2089
  "type": {
2172
2090
  "text": "string | undefined"
2173
2091
  },
2174
- "description": "The src is the url which will be used to display the avatar.\nWhen the src is loading, we will display the initials as a placeholder.",
2175
- "attribute": "src",
2092
+ "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`",
2093
+ "default": "'aria-pressed' (when)",
2094
+ "attribute": "ariaStateKey",
2095
+ "reflects": true,
2176
2096
  "inheritedFrom": {
2177
- "name": "AvatarComponentMixin",
2178
- "module": "utils/mixins/AvatarComponentMixin.js"
2097
+ "name": "Buttonsimple",
2098
+ "module": "components/buttonsimple/buttonsimple.component.js"
2179
2099
  }
2180
2100
  },
2181
2101
  {
2182
2102
  "kind": "field",
2183
- "name": "initials",
2103
+ "name": "type",
2184
2104
  "type": {
2185
- "text": "string | undefined"
2105
+ "text": "ButtonType"
2186
2106
  },
2187
- "description": "The initials to be displayed for the avatar.",
2188
- "attribute": "initials",
2107
+ "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.",
2108
+ "default": "button",
2109
+ "attribute": "type",
2110
+ "reflects": true,
2189
2111
  "inheritedFrom": {
2190
- "name": "AvatarComponentMixin",
2191
- "module": "utils/mixins/AvatarComponentMixin.js"
2112
+ "name": "Buttonsimple",
2113
+ "module": "components/buttonsimple/buttonsimple.component.js"
2192
2114
  }
2193
2115
  },
2194
2116
  {
2195
2117
  "kind": "field",
2196
- "name": "presence",
2118
+ "name": "name",
2197
2119
  "type": {
2198
- "text": "PresenceType | undefined"
2120
+ "text": "string | undefined"
2199
2121
  },
2200
- "description": "The presence is the status which can be used to display the\nactivity state of a user or a space within an avatar component.\n\nAcceptable values include:\n- `active`\n- `away`\n- `away-calling`\n- `busy`\n- `dnd`\n- `meeting`\n- `on-call`\n- `on-device`\n- `on-mobile`\n- `pause`\n- `pto`\n- `presenting`\n- `quiet`\n- `scheduled`",
2201
- "attribute": "presence",
2122
+ "description": "The name of the button, submitted as a pair with the button's value as part of the form data,\nwhen that button is used to submit the form.",
2123
+ "attribute": "name",
2124
+ "reflects": true,
2202
2125
  "inheritedFrom": {
2203
- "name": "AvatarComponentMixin",
2204
- "module": "utils/mixins/AvatarComponentMixin.js"
2126
+ "name": "Buttonsimple",
2127
+ "module": "components/buttonsimple/buttonsimple.component.js"
2205
2128
  }
2206
2129
  },
2207
2130
  {
2208
2131
  "kind": "field",
2209
- "name": "size",
2132
+ "name": "value",
2210
2133
  "type": {
2211
- "text": "ButtonSize"
2134
+ "text": "string | undefined"
2212
2135
  },
2213
- "description": "Acceptable values include (size in px unit):\n- 24\n- 32\n- 48\n- 64\n- 72\n- 88\n- 124",
2214
- "default": "32",
2215
- "attribute": "size",
2136
+ "description": "Defines the value associated with the button's name when it's submitted with the form data.\nThis value is passed to the server in params when the form is submitted using this button.",
2137
+ "attribute": "value",
2216
2138
  "reflects": true,
2217
2139
  "inheritedFrom": {
2218
2140
  "name": "Buttonsimple",
@@ -2220,200 +2142,12 @@
2220
2142
  }
2221
2143
  },
2222
2144
  {
2223
- "kind": "field",
2224
- "name": "counter",
2225
- "type": {
2226
- "text": "number | undefined"
2227
- },
2228
- "description": "The counter is the number which can be displayed on the avatar.\nThe maximum number is 99 and if the given number is greater than 99,\nthen the avatar will be displayed as `99+`.\nIf the given number is a negative number,\nthen the avatar will be displayed as `0`.",
2229
- "attribute": "counter",
2145
+ "kind": "method",
2146
+ "name": "executeAction",
2147
+ "privacy": "protected",
2230
2148
  "inheritedFrom": {
2231
- "name": "AvatarComponentMixin",
2232
- "module": "utils/mixins/AvatarComponentMixin.js"
2233
- }
2234
- },
2235
- {
2236
- "kind": "field",
2237
- "name": "isTyping",
2238
- "type": {
2239
- "text": "boolean"
2240
- },
2241
- "default": "false",
2242
- "description": "Represents the typing indicator when the user is typing.",
2243
- "attribute": "is-typing",
2244
- "inheritedFrom": {
2245
- "name": "AvatarComponentMixin",
2246
- "module": "utils/mixins/AvatarComponentMixin.js"
2247
- }
2248
- },
2249
- {
2250
- "kind": "field",
2251
- "name": "iconName",
2252
- "type": {
2253
- "text": "IconNames | undefined"
2254
- },
2255
- "description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
2256
- "attribute": "icon-name",
2257
- "inheritedFrom": {
2258
- "name": "IconNameMixin",
2259
- "module": "utils/mixins/IconNameMixin.js"
2260
- }
2261
- },
2262
- {
2263
- "kind": "field",
2264
- "name": "autoFocusOnMount",
2265
- "type": {
2266
- "text": "boolean"
2267
- },
2268
- "default": "false",
2269
- "description": "This property indicates whether the element should receive focus automatically when it is mounted.\n\nIt will not focus if the element is re-attached to the DOM after being removed.",
2270
- "attribute": "auto-focus-on-mount",
2271
- "reflects": true,
2272
- "inheritedFrom": {
2273
- "name": "AutoFocusOnMountMixin",
2274
- "module": "utils/mixins/AutoFocusOnMountMixin.js"
2275
- }
2276
- },
2277
- {
2278
- "kind": "field",
2279
- "name": "tabIndex",
2280
- "type": {
2281
- "text": "number"
2282
- },
2283
- "default": "0",
2284
- "description": "This property specifies the tab order of the element.",
2285
- "attribute": "tabIndex",
2286
- "reflects": true,
2287
- "inheritedFrom": {
2288
- "name": "TabIndexMixin",
2289
- "module": "utils/mixins/TabIndexMixin.js"
2290
- }
2291
- },
2292
- {
2293
- "kind": "field",
2294
- "name": "disabled",
2295
- "type": {
2296
- "text": "boolean | undefined"
2297
- },
2298
- "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
2299
- "default": "undefined",
2300
- "attribute": "disabled",
2301
- "reflects": true,
2302
- "inheritedFrom": {
2303
- "name": "DisabledMixin",
2304
- "module": "utils/mixins/DisabledMixin.js"
2305
- }
2306
- },
2307
- {
2308
- "kind": "field",
2309
- "name": "active",
2310
- "type": {
2311
- "text": "boolean | undefined"
2312
- },
2313
- "description": "The button's active state indicates whether it is currently toggled on (active) or off (inactive).\nWhen the active state is true, the button is considered to be in an active state, meaning it is toggled on.\nConversely, when the active state is false, the button is in an inactive state, indicating it is toggled off.\n\nThis attribute is used to set the provided `ariaStateKey` to true or false.",
2314
- "default": "undefined",
2315
- "attribute": "active",
2316
- "reflects": true,
2317
- "inheritedFrom": {
2318
- "name": "Buttonsimple",
2319
- "module": "components/buttonsimple/buttonsimple.component.js"
2320
- }
2321
- },
2322
- {
2323
- "kind": "field",
2324
- "name": "softDisabled",
2325
- "type": {
2326
- "text": "boolean | undefined"
2327
- },
2328
- "description": "Indicates whether the button is soft disabled.\nWhen set to `true`, the button appears visually disabled but still allows\nfocus, click, and keyboard actions to be passed through.\n\n**Important:** When using soft disabled, consumers must ensure that\nthe button behaves like a disabled button, allowing only focus and\npreventing any interactions (clicks or keyboard actions) from triggering unintended actions.",
2329
- "default": "undefined",
2330
- "attribute": "soft-disabled",
2331
- "reflects": true,
2332
- "inheritedFrom": {
2333
- "name": "Buttonsimple",
2334
- "module": "components/buttonsimple/buttonsimple.component.js"
2335
- }
2336
- },
2337
- {
2338
- "kind": "field",
2339
- "name": "role",
2340
- "type": {
2341
- "text": "RoleType"
2342
- },
2343
- "description": "This property defines the ARIA role for the element. By default, it is set to 'button'.\nConsumers should override this role when:\n- The element is being used in a context where a different role is more appropriate.\n- Custom behaviors are implemented that require a specific ARIA role for accessibility purposes.",
2344
- "default": "button",
2345
- "attribute": "role",
2346
- "reflects": true,
2347
- "inheritedFrom": {
2348
- "name": "Buttonsimple",
2349
- "module": "components/buttonsimple/buttonsimple.component.js"
2350
- }
2351
- },
2352
- {
2353
- "kind": "field",
2354
- "name": "ariaStateKey",
2355
- "type": {
2356
- "text": "string | undefined"
2357
- },
2358
- "description": "This property defines the ARIA state key, which will be toggled when the\nButton is set to `active`.\nThe default value is 'aria-pressed', which is commonly used for toggle buttons.\n\nConsumers can override this property to use a different ARIA state key if needed.\nIn case multiple aria attributes should be toggled, they can be passed in as\na comma separated string.\nFor example: `aria-pressed,aria-expanded`",
2359
- "default": "'aria-pressed' (when)",
2360
- "attribute": "ariaStateKey",
2361
- "reflects": true,
2362
- "inheritedFrom": {
2363
- "name": "Buttonsimple",
2364
- "module": "components/buttonsimple/buttonsimple.component.js"
2365
- }
2366
- },
2367
- {
2368
- "kind": "field",
2369
- "name": "type",
2370
- "type": {
2371
- "text": "ButtonType"
2372
- },
2373
- "description": "This property defines the type attribute for the button element.\nThe type attribute specifies the behavior of the button when it is clicked.\n- **submit**: The button submits the form data to the server.\n- **reset**: The button resets the form data to its initial state.\n- **button**: The button does nothing when clicked.",
2374
- "default": "button",
2375
- "attribute": "type",
2376
- "reflects": true,
2377
- "inheritedFrom": {
2378
- "name": "Buttonsimple",
2379
- "module": "components/buttonsimple/buttonsimple.component.js"
2380
- }
2381
- },
2382
- {
2383
- "kind": "field",
2384
- "name": "name",
2385
- "type": {
2386
- "text": "string | undefined"
2387
- },
2388
- "description": "The name of the button, submitted as a pair with the button's value as part of the form data,\nwhen that button is used to submit the form.",
2389
- "attribute": "name",
2390
- "reflects": true,
2391
- "inheritedFrom": {
2392
- "name": "Buttonsimple",
2393
- "module": "components/buttonsimple/buttonsimple.component.js"
2394
- }
2395
- },
2396
- {
2397
- "kind": "field",
2398
- "name": "value",
2399
- "type": {
2400
- "text": "string | undefined"
2401
- },
2402
- "description": "Defines the value associated with the button's name when it's submitted with the form data.\nThis value is passed to the server in params when the form is submitted using this button.",
2403
- "attribute": "value",
2404
- "reflects": true,
2405
- "inheritedFrom": {
2406
- "name": "Buttonsimple",
2407
- "module": "components/buttonsimple/buttonsimple.component.js"
2408
- }
2409
- },
2410
- {
2411
- "kind": "method",
2412
- "name": "executeAction",
2413
- "privacy": "protected",
2414
- "inheritedFrom": {
2415
- "name": "Buttonsimple",
2416
- "module": "components/buttonsimple/buttonsimple.component.js"
2149
+ "name": "Buttonsimple",
2150
+ "module": "components/buttonsimple/buttonsimple.component.js"
2417
2151
  }
2418
2152
  },
2419
2153
  {
@@ -3346,49 +3080,315 @@
3346
3080
  },
3347
3081
  {
3348
3082
  "kind": "javascript-module",
3349
- "path": "components/bullet/bullet.component.js",
3083
+ "path": "components/avatar/avatar.component.js",
3350
3084
  "declarations": [
3351
3085
  {
3352
3086
  "kind": "class",
3353
- "description": "Bullet component, which is a visual marker\nand be used to organize and present items in a list format.",
3354
- "name": "Bullet",
3087
+ "description": "The `mdc-avatar` component is used to represent a person or a space.\nAn avatar can be an icon, initials, counter and photo.\n\nTo set the photo of an avatar,\nyou need to set \"src\" attribute.\n\nWhile the avatar image is loading, as a placeholder,\nwe will show the initials text.\nIf the initials are not specified then,\nwe will show `user-regular` icon as a placeholder.\n\nBy default, if there are no attributes specified,\nthen the default avatar will be an icon with `user-regular` name.\n\nThe avatar component is non clickable and non interactive/focusable component.\nIf the avatar is typing, then the loading indicator will be displayed.\nIf the counter type avatar is set to a negative number, then we will display 0.\nThe presence indicator will be hidden when the counter property is set.",
3088
+ "name": "Avatar",
3355
3089
  "cssProperties": [
3356
3090
  {
3357
- "description": "background color of the bullet",
3358
- "name": "--mdc-bullet-background-color"
3091
+ "description": "Allows customization of the default background color.",
3092
+ "name": "--mdc-avatar-default-background-color"
3359
3093
  },
3360
3094
  {
3361
- "description": "small size value of the bullet",
3362
- "name": "--mdc-bullet-size-small"
3095
+ "description": "Allows customization of the default foreground color.",
3096
+ "name": "--mdc-avatar-default-foreground-color"
3363
3097
  },
3364
3098
  {
3365
- "description": "medium size value of the bullet",
3366
- "name": "--mdc-bullet-size-medium"
3099
+ "description": "Allows customization of the loading indicator background color.",
3100
+ "name": "--mdc-avatar-loading-indicator-background-color"
3367
3101
  },
3368
3102
  {
3369
- "description": "large size value of the bullet",
3370
- "name": "--mdc-bullet-size-large"
3103
+ "description": "Allows customization of the loading indicator foreground color.",
3104
+ "name": "--mdc-avatar-loading-indicator-foreground-color"
3105
+ },
3106
+ {
3107
+ "description": "Allows customization of the loading overlay background color.",
3108
+ "name": "--mdc-avatar-loading-overlay-background-color"
3109
+ }
3110
+ ],
3111
+ "cssParts": [
3112
+ {
3113
+ "description": "The main content of the avatar.",
3114
+ "name": "content"
3115
+ },
3116
+ {
3117
+ "description": "The photo of the avatar.",
3118
+ "name": "photo"
3119
+ },
3120
+ {
3121
+ "description": "The presence indicator of the avatar.",
3122
+ "name": "presence"
3123
+ },
3124
+ {
3125
+ "description": "The wrapper for the loading indicator.",
3126
+ "name": "loading-wrapper"
3127
+ },
3128
+ {
3129
+ "description": "The loading indicator of the avatar.",
3130
+ "name": "loader"
3371
3131
  }
3372
3132
  ],
3373
3133
  "members": [
3374
3134
  {
3375
3135
  "kind": "field",
3376
- "name": "size",
3136
+ "name": "src",
3377
3137
  "type": {
3378
- "text": "Size"
3138
+ "text": "string | undefined"
3379
3139
  },
3380
- "privacy": "public",
3381
- "description": "Size of the bullet\n\nPossible values: 'small', 'medium', 'large'",
3382
- "default": "small",
3383
- "attribute": "size",
3384
- "reflects": true
3385
- }
3386
- ],
3387
- "attributes": [
3140
+ "description": "The src is the url which will be used to display the avatar.\nWhen the src is loading, we will display the initials as a placeholder.",
3141
+ "attribute": "src",
3142
+ "inheritedFrom": {
3143
+ "name": "AvatarComponentMixin",
3144
+ "module": "utils/mixins/AvatarComponentMixin.js"
3145
+ }
3146
+ },
3388
3147
  {
3389
- "name": "size",
3148
+ "kind": "field",
3149
+ "name": "initials",
3390
3150
  "type": {
3391
- "text": "Size"
3151
+ "text": "string | undefined"
3152
+ },
3153
+ "description": "The initials to be displayed for the avatar.",
3154
+ "attribute": "initials",
3155
+ "inheritedFrom": {
3156
+ "name": "AvatarComponentMixin",
3157
+ "module": "utils/mixins/AvatarComponentMixin.js"
3158
+ }
3159
+ },
3160
+ {
3161
+ "kind": "field",
3162
+ "name": "presence",
3163
+ "type": {
3164
+ "text": "PresenceType | undefined"
3165
+ },
3166
+ "description": "The presence is the status which can be used to display the\nactivity state of a user or a space within an avatar component.\n\nAcceptable values include:\n- `active`\n- `away`\n- `away-calling`\n- `busy`\n- `dnd`\n- `meeting`\n- `on-call`\n- `on-device`\n- `on-mobile`\n- `pause`\n- `pto`\n- `presenting`\n- `quiet`\n- `scheduled`",
3167
+ "attribute": "presence",
3168
+ "inheritedFrom": {
3169
+ "name": "AvatarComponentMixin",
3170
+ "module": "utils/mixins/AvatarComponentMixin.js"
3171
+ }
3172
+ },
3173
+ {
3174
+ "kind": "field",
3175
+ "name": "size",
3176
+ "type": {
3177
+ "text": "AvatarSize"
3178
+ },
3179
+ "description": "Acceptable values include (size in px unit):\n- 24\n- 32\n- 48\n- 64\n- 72\n- 88\n- 124",
3180
+ "default": "32",
3181
+ "attribute": "size",
3182
+ "reflects": true,
3183
+ "inheritedFrom": {
3184
+ "name": "AvatarComponentMixin",
3185
+ "module": "utils/mixins/AvatarComponentMixin.js"
3186
+ }
3187
+ },
3188
+ {
3189
+ "kind": "field",
3190
+ "name": "counter",
3191
+ "type": {
3192
+ "text": "number | undefined"
3193
+ },
3194
+ "description": "The counter is the number which can be displayed on the avatar.\nThe maximum number is 99 and if the given number is greater than 99,\nthen the avatar will be displayed as `99+`.\nIf the given number is a negative number,\nthen the avatar will be displayed as `0`.",
3195
+ "attribute": "counter",
3196
+ "inheritedFrom": {
3197
+ "name": "AvatarComponentMixin",
3198
+ "module": "utils/mixins/AvatarComponentMixin.js"
3199
+ }
3200
+ },
3201
+ {
3202
+ "kind": "field",
3203
+ "name": "isTyping",
3204
+ "type": {
3205
+ "text": "boolean"
3206
+ },
3207
+ "default": "false",
3208
+ "description": "Represents the typing indicator when the user is typing.",
3209
+ "attribute": "is-typing",
3210
+ "inheritedFrom": {
3211
+ "name": "AvatarComponentMixin",
3212
+ "module": "utils/mixins/AvatarComponentMixin.js"
3213
+ }
3214
+ },
3215
+ {
3216
+ "kind": "field",
3217
+ "name": "iconName",
3218
+ "type": {
3219
+ "text": "IconNames | undefined"
3220
+ },
3221
+ "description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
3222
+ "attribute": "icon-name",
3223
+ "inheritedFrom": {
3224
+ "name": "IconNameMixin",
3225
+ "module": "utils/mixins/IconNameMixin.js"
3226
+ }
3227
+ }
3228
+ ],
3229
+ "mixins": [
3230
+ {
3231
+ "name": "AvatarComponentMixin",
3232
+ "module": "/src/utils/mixins/AvatarComponentMixin"
3233
+ },
3234
+ {
3235
+ "name": "IconNameMixin",
3236
+ "module": "/src/utils/mixins/IconNameMixin"
3237
+ }
3238
+ ],
3239
+ "superclass": {
3240
+ "name": "Component",
3241
+ "module": "/src/models"
3242
+ },
3243
+ "tagName": "mdc-avatar",
3244
+ "jsDoc": "/**\n * The `mdc-avatar` component is used to represent a person or a space.\n * An avatar can be an icon, initials, counter and photo.\n *\n * To set the photo of an avatar,\n * you need to set \"src\" attribute.\n *\n * While the avatar image is loading, as a placeholder,\n * we will show the initials text.\n * If the initials are not specified then,\n * we will show `user-regular` icon as a placeholder.\n *\n * By default, if there are no attributes specified,\n * then the default avatar will be an icon with `user-regular` name.\n *\n * The avatar component is non clickable and non interactive/focusable component.\n * If the avatar is typing, then the loading indicator will be displayed.\n * If the counter type avatar is set to a negative number, then we will display 0.\n * The presence indicator will be hidden when the counter property is set.\n *\n * @dependency mdc-icon\n * @dependency mdc-presence\n * @dependency mdc-text\n *\n * @tagname mdc-avatar\n *\n * @cssproperty --mdc-avatar-default-background-color - Allows customization of the default background color.\n * @cssproperty --mdc-avatar-default-foreground-color - Allows customization of the default foreground color.\n * @cssproperty --mdc-avatar-loading-indicator-background-color -\n * Allows customization of the loading indicator background color.\n * @cssproperty --mdc-avatar-loading-indicator-foreground-color -\n * Allows customization of the loading indicator foreground color.\n * @cssproperty --mdc-avatar-loading-overlay-background-color -\n * Allows customization of the loading overlay background color.\n *\n * @csspart content - The main content of the avatar.\n * @csspart photo - The photo of the avatar.\n * @csspart presence - The presence indicator of the avatar.\n * @csspart loading-wrapper - The wrapper for the loading indicator.\n * @csspart loader - The loading indicator of the avatar.\n */",
3245
+ "customElement": true,
3246
+ "attributes": [
3247
+ {
3248
+ "name": "src",
3249
+ "type": {
3250
+ "text": "string | undefined"
3251
+ },
3252
+ "description": "The src is the url which will be used to display the avatar.\nWhen the src is loading, we will display the initials as a placeholder.",
3253
+ "fieldName": "src",
3254
+ "inheritedFrom": {
3255
+ "name": "AvatarComponentMixin",
3256
+ "module": "src/utils/mixins/AvatarComponentMixin.ts"
3257
+ }
3258
+ },
3259
+ {
3260
+ "name": "initials",
3261
+ "type": {
3262
+ "text": "string | undefined"
3263
+ },
3264
+ "description": "The initials to be displayed for the avatar.",
3265
+ "fieldName": "initials",
3266
+ "inheritedFrom": {
3267
+ "name": "AvatarComponentMixin",
3268
+ "module": "src/utils/mixins/AvatarComponentMixin.ts"
3269
+ }
3270
+ },
3271
+ {
3272
+ "name": "presence",
3273
+ "type": {
3274
+ "text": "PresenceType | undefined"
3275
+ },
3276
+ "description": "The presence is the status which can be used to display the\nactivity state of a user or a space within an avatar component.\n\nAcceptable values include:\n- `active`\n- `away`\n- `away-calling`\n- `busy`\n- `dnd`\n- `meeting`\n- `on-call`\n- `on-device`\n- `on-mobile`\n- `pause`\n- `pto`\n- `presenting`\n- `quiet`\n- `scheduled`",
3277
+ "fieldName": "presence",
3278
+ "inheritedFrom": {
3279
+ "name": "AvatarComponentMixin",
3280
+ "module": "src/utils/mixins/AvatarComponentMixin.ts"
3281
+ }
3282
+ },
3283
+ {
3284
+ "name": "size",
3285
+ "type": {
3286
+ "text": "AvatarSize"
3287
+ },
3288
+ "description": "Acceptable values include (size in px unit):\n- 24\n- 32\n- 48\n- 64\n- 72\n- 88\n- 124",
3289
+ "default": "32",
3290
+ "fieldName": "size",
3291
+ "inheritedFrom": {
3292
+ "name": "AvatarComponentMixin",
3293
+ "module": "src/utils/mixins/AvatarComponentMixin.ts"
3294
+ }
3295
+ },
3296
+ {
3297
+ "name": "counter",
3298
+ "type": {
3299
+ "text": "number | undefined"
3300
+ },
3301
+ "description": "The counter is the number which can be displayed on the avatar.\nThe maximum number is 99 and if the given number is greater than 99,\nthen the avatar will be displayed as `99+`.\nIf the given number is a negative number,\nthen the avatar will be displayed as `0`.",
3302
+ "fieldName": "counter",
3303
+ "inheritedFrom": {
3304
+ "name": "AvatarComponentMixin",
3305
+ "module": "src/utils/mixins/AvatarComponentMixin.ts"
3306
+ }
3307
+ },
3308
+ {
3309
+ "name": "is-typing",
3310
+ "type": {
3311
+ "text": "boolean"
3312
+ },
3313
+ "default": "false",
3314
+ "description": "Represents the typing indicator when the user is typing.",
3315
+ "fieldName": "isTyping",
3316
+ "inheritedFrom": {
3317
+ "name": "AvatarComponentMixin",
3318
+ "module": "src/utils/mixins/AvatarComponentMixin.ts"
3319
+ }
3320
+ },
3321
+ {
3322
+ "name": "icon-name",
3323
+ "type": {
3324
+ "text": "IconNames | undefined"
3325
+ },
3326
+ "description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
3327
+ "fieldName": "iconName",
3328
+ "inheritedFrom": {
3329
+ "name": "IconNameMixin",
3330
+ "module": "src/utils/mixins/IconNameMixin.ts"
3331
+ }
3332
+ }
3333
+ ]
3334
+ }
3335
+ ],
3336
+ "exports": [
3337
+ {
3338
+ "kind": "js",
3339
+ "name": "default",
3340
+ "declaration": {
3341
+ "name": "Avatar",
3342
+ "module": "components/avatar/avatar.component.js"
3343
+ }
3344
+ }
3345
+ ]
3346
+ },
3347
+ {
3348
+ "kind": "javascript-module",
3349
+ "path": "components/bullet/bullet.component.js",
3350
+ "declarations": [
3351
+ {
3352
+ "kind": "class",
3353
+ "description": "Bullet component, which is a visual marker\nand be used to organize and present items in a list format.",
3354
+ "name": "Bullet",
3355
+ "cssProperties": [
3356
+ {
3357
+ "description": "background color of the bullet",
3358
+ "name": "--mdc-bullet-background-color"
3359
+ },
3360
+ {
3361
+ "description": "small size value of the bullet",
3362
+ "name": "--mdc-bullet-size-small"
3363
+ },
3364
+ {
3365
+ "description": "medium size value of the bullet",
3366
+ "name": "--mdc-bullet-size-medium"
3367
+ },
3368
+ {
3369
+ "description": "large size value of the bullet",
3370
+ "name": "--mdc-bullet-size-large"
3371
+ }
3372
+ ],
3373
+ "members": [
3374
+ {
3375
+ "kind": "field",
3376
+ "name": "size",
3377
+ "type": {
3378
+ "text": "Size"
3379
+ },
3380
+ "privacy": "public",
3381
+ "description": "Size of the bullet\n\nPossible values: 'small', 'medium', 'large'",
3382
+ "default": "small",
3383
+ "attribute": "size",
3384
+ "reflects": true
3385
+ }
3386
+ ],
3387
+ "attributes": [
3388
+ {
3389
+ "name": "size",
3390
+ "type": {
3391
+ "text": "Size"
3392
3392
  },
3393
3393
  "description": "Size of the bullet\n\nPossible values: 'small', 'medium', 'large'",
3394
3394
  "default": "small",
@@ -4392,6 +4392,11 @@
4392
4392
  ],
4393
4393
  "description": "Sets the soft-disabled attribute for the buttonlink.\nWhen soft-disabled, the buttonlink looks to be disabled but remains focusable and clickable.\nAlso sets/removes aria-disabled attribute."
4394
4394
  },
4395
+ {
4396
+ "kind": "method",
4397
+ "name": "renderAnchorContent",
4398
+ "privacy": "protected"
4399
+ },
4395
4400
  {
4396
4401
  "kind": "field",
4397
4402
  "name": "prefixIcon",
@@ -4585,9 +4590,8 @@
4585
4590
  "kind": "field",
4586
4591
  "name": "href",
4587
4592
  "type": {
4588
- "text": "string"
4593
+ "text": "string | undefined"
4589
4594
  },
4590
- "default": "'#'",
4591
4595
  "description": "Href for navigation. The URL that the hyperlink points to",
4592
4596
  "attribute": "href",
4593
4597
  "reflects": true,
@@ -4899,9 +4903,8 @@
4899
4903
  {
4900
4904
  "name": "href",
4901
4905
  "type": {
4902
- "text": "string"
4906
+ "text": "string | undefined"
4903
4907
  },
4904
- "default": "'#'",
4905
4908
  "description": "Href for navigation. The URL that the hyperlink points to",
4906
4909
  "fieldName": "href",
4907
4910
  "inheritedFrom": {
@@ -5006,7 +5009,7 @@
5006
5009
  "module": "/src/components/linksimple/linksimple.component"
5007
5010
  },
5008
5011
  "tagName": "mdc-buttonlink",
5009
- "jsDoc": "/**\n * `mdc-buttonlink` combines the functional behavior of `mdc-linksimple` with the visual and structural\n * features of `mdc-button`. This includes support for variants, sizing, and optional\n * prefix and postfix icons via slots.\n *\n * ### Features:\n * - Behaves like an link while visually resembling a button.\n * - Supports slots for `prefix-icon` and `postfix-icon`.\n * - Customizable size, color, and variant through attributes.\n * - Inherits accessibility and keyboard interaction support from `mdc-linksimple`.\n *\n * @dependency mdc-icon\n *\n * @tagname mdc-buttonlink\n *\n * @event click - (React: onClick) Fired when the user activates the buttonLink using a mouse or assistive technology.\n * @event keydown - (React: onKeyDown) Fired when the user presses a key while the buttonLink has focus.\n * @event focus - (React: onFocus) Fired when the buttonLink receives keyboard or mouse focus.\n * @event blur - (React: onBlur) Fired when the buttonLink loses keyboard or mouse focus.\n * \n * @csspart anchor - The anchor element that wraps the buttonlink content.\n * @csspart prefix-icon - The prefix icon element.\n * @csspart button-text - The slot containing the buttonlink text.\n * @csspart postfix-icon - The postfix icon element.\n *\n */",
5012
+ "jsDoc": "/**\n * `mdc-buttonlink` combines the functional behavior of `mdc-linksimple` with the visual and structural\n * features of `mdc-button`. This includes support for variants, sizing, and optional\n * prefix and postfix icons via slots.\n *\n * ### Features:\n * - Behaves like an link while visually resembling a button.\n * - Supports slots for `prefix-icon` and `postfix-icon`.\n * - Customizable size, color, and variant through attributes.\n * - Inherits accessibility and keyboard interaction support from `mdc-linksimple`.\n *\n * @dependency mdc-icon\n *\n * @tagname mdc-buttonlink\n *\n * @event click - (React: onClick) Fired when the user activates the buttonLink using a mouse or assistive technology.\n * @event keydown - (React: onKeyDown) Fired when the user presses a key while the buttonLink has focus.\n * @event focus - (React: onFocus) Fired when the buttonLink receives keyboard or mouse focus.\n * @event blur - (React: onBlur) Fired when the buttonLink loses keyboard or mouse focus.\n *\n * @csspart anchor - The anchor element that wraps the buttonlink content.\n * @csspart prefix-icon - The prefix icon element.\n * @csspart button-text - The slot containing the buttonlink text.\n * @csspart postfix-icon - The postfix icon element.\n *\n */",
5010
5013
  "customElement": true,
5011
5014
  "cssProperties": [
5012
5015
  {
@@ -15926,6 +15929,11 @@
15926
15929
  },
15927
15930
  "description": "Method to get the size of the trailing icon based on the link size."
15928
15931
  },
15932
+ {
15933
+ "kind": "method",
15934
+ "name": "renderAnchorContent",
15935
+ "privacy": "protected"
15936
+ },
15929
15937
  {
15930
15938
  "kind": "field",
15931
15939
  "name": "iconName",
@@ -16003,9 +16011,8 @@
16003
16011
  "kind": "field",
16004
16012
  "name": "href",
16005
16013
  "type": {
16006
- "text": "string"
16014
+ "text": "string | undefined"
16007
16015
  },
16008
- "default": "'#'",
16009
16016
  "description": "Href for navigation. The URL that the hyperlink points to",
16010
16017
  "attribute": "href",
16011
16018
  "reflects": true,
@@ -16270,9 +16277,8 @@
16270
16277
  {
16271
16278
  "name": "href",
16272
16279
  "type": {
16273
- "text": "string"
16280
+ "text": "string | undefined"
16274
16281
  },
16275
- "default": "'#'",
16276
16282
  "description": "Href for navigation. The URL that the hyperlink points to",
16277
16283
  "fieldName": "href",
16278
16284
  "inheritedFrom": {
@@ -16377,7 +16383,7 @@
16377
16383
  "module": "/src/components/linksimple/linksimple.component"
16378
16384
  },
16379
16385
  "tagName": "mdc-link",
16380
- "jsDoc": "/**\n * `mdc-link` component can be used to navigate to a different page\n * within the application or to an external site. It can be used to link to\n * emails or phone numbers.\n *\n * The `children` of the link component is expected to be the text content.\n *\n * For `icon`, the `mdc-icon` component is used to render the icon.\n *\n * @dependency mdc-icon\n *\n * @tagname mdc-link\n *\n * @event click - (React: onClick) Fired when the user activates the Link using a mouse or assistive technology.\n * @event keydown - (React: onKeyDown) Fired when the user presses a key while the Link has focus.\n * @event focus - (React: onFocus) Fired when the Link receives keyboard or mouse focus.\n * @event blur - (React: onBlur) Fired when the Link loses keyboard or mouse focus.\n * \n * @csspart anchor - The anchor element that wraps the link content.\n * @csspart icon - The icon element.\n */",
16386
+ "jsDoc": "/**\n * `mdc-link` component can be used to navigate to a different page\n * within the application or to an external site. It can be used to link to\n * emails or phone numbers.\n *\n * The `children` of the link component is expected to be the text content.\n *\n * For `icon`, the `mdc-icon` component is used to render the icon.\n *\n * @dependency mdc-icon\n *\n * @tagname mdc-link\n *\n * @event click - (React: onClick) Fired when the user activates the Link using a mouse or assistive technology.\n * @event keydown - (React: onKeyDown) Fired when the user presses a key while the Link has focus.\n * @event focus - (React: onFocus) Fired when the Link receives keyboard or mouse focus.\n * @event blur - (React: onBlur) Fired when the Link loses keyboard or mouse focus.\n *\n * @csspart anchor - The anchor element that wraps the link content.\n * @csspart icon - The icon element.\n */",
16381
16387
  "customElement": true,
16382
16388
  "cssProperties": [
16383
16389
  {
@@ -17195,9 +17201,8 @@
17195
17201
  "kind": "field",
17196
17202
  "name": "href",
17197
17203
  "type": {
17198
- "text": "string"
17204
+ "text": "string | undefined"
17199
17205
  },
17200
- "default": "'#'",
17201
17206
  "description": "Href for navigation. The URL that the hyperlink points to",
17202
17207
  "attribute": "href",
17203
17208
  "reflects": true
@@ -17381,9 +17386,8 @@
17381
17386
  {
17382
17387
  "name": "href",
17383
17388
  "type": {
17384
- "text": "string"
17389
+ "text": "string | undefined"
17385
17390
  },
17386
- "default": "'#'",
17387
17391
  "description": "Href for navigation. The URL that the hyperlink points to",
17388
17392
  "fieldName": "href"
17389
17393
  },
@@ -17486,7 +17490,7 @@
17486
17490
  "module": "/src/models"
17487
17491
  },
17488
17492
  "tagName": "mdc-linksimple",
17489
- "jsDoc": "/**\n * `mdc-linksimple` is a lightweight link component that can be used to navigate\n * within the application or to an external URL. It does not have any predefined default size.\n *\n * The `children` of the `mdc-linksimple` component can be customized to suit\n * different use cases, including text, icons, or other inline content. For the child to be an icon,\n * the `mdc-icon` component should be used to render.\n *\n * @tagname mdc-linksimple\n *\n * @event click - (React: onClick) Fired when the user activates the buttonLink using a mouse or assistive technology.\n * @event keydown - (React: onKeyDown) Fired when the user presses a key while the buttonLink has focus.\n * @event focus - (React: onFocus) Fired when the buttonLink receives keyboard or mouse focus.\n * @event blur - (React: onBlur) Fired when the buttonLink loses keyboard or mouse focus.\n *\n * @cssproperty --mdc-link-border-radius - Border radius of the link.\n * @cssproperty --mdc-link-color-active - Color of the link’s child content in the active state.\n * @cssproperty --mdc-link-color-disabled - Color of the link’s child content in the disabled state.\n * @cssproperty --mdc-link-color-hover - Color of the link’s child content in the hover state.\n * @cssproperty --mdc-link-color-normal - Color of the link’s child content in the normal state.\n * @cssproperty --mdc-link-inverted-color-active - Color of the inverted link’s child content in the active state.\n * @cssproperty --mdc-link-inverted-color-disabled - Color of the inverted link’s child content in the disabled state.\n * @cssproperty --mdc-link-inverted-color-hover - Color of the inverted link’s child content in the hover state.\n * @cssproperty --mdc-link-inverted-color-normal - Color of the inverted link’s child content in the normal state.\n * \n * @csspart anchor - The anchor element that wraps the linksimple content.\n */",
17493
+ "jsDoc": "/**\n * `mdc-linksimple` is a lightweight link component that can be used to navigate\n * within the application or to an external URL. It does not have any predefined default size.\n *\n * The `children` of the `mdc-linksimple` component can be customized to suit\n * different use cases, including text, icons, or other inline content. For the child to be an icon,\n * the `mdc-icon` component should be used to render.\n *\n * @tagname mdc-linksimple\n *\n * @event click - (React: onClick) Fired when the user activates the buttonLink using a mouse or assistive technology.\n * @event keydown - (React: onKeyDown) Fired when the user presses a key while the buttonLink has focus.\n * @event focus - (React: onFocus) Fired when the buttonLink receives keyboard or mouse focus.\n * @event blur - (React: onBlur) Fired when the buttonLink loses keyboard or mouse focus.\n *\n * @cssproperty --mdc-link-border-radius - Border radius of the link.\n * @cssproperty --mdc-link-color-active - Color of the link’s child content in the active state.\n * @cssproperty --mdc-link-color-disabled - Color of the link’s child content in the disabled state.\n * @cssproperty --mdc-link-color-hover - Color of the link’s child content in the hover state.\n * @cssproperty --mdc-link-color-normal - Color of the link’s child content in the normal state.\n * @cssproperty --mdc-link-inverted-color-active - Color of the inverted link’s child content in the active state.\n * @cssproperty --mdc-link-inverted-color-disabled - Color of the inverted link’s child content in the disabled state.\n * @cssproperty --mdc-link-inverted-color-hover - Color of the inverted link’s child content in the hover state.\n * @cssproperty --mdc-link-inverted-color-normal - Color of the inverted link’s child content in the normal state.\n *\n * @csspart anchor - The anchor element that wraps the linksimple content.\n */",
17490
17494
  "customElement": true
17491
17495
  }
17492
17496
  ],
@@ -30234,674 +30238,753 @@
30234
30238
  },
30235
30239
  {
30236
30240
  "kind": "javascript-module",
30237
- "path": "components/radiogroup/radiogroup.component.js",
30241
+ "path": "components/radio/radio.component.js",
30238
30242
  "declarations": [
30239
30243
  {
30240
30244
  "kind": "class",
30241
- "description": "`mdc-radiogroup` - This is the wrapper component for radio buttons which are grouped together.\nIt can have a header text and a description. It enables users to select a single option from a set of options.\nIt is often used in forms, settings, and selection in lists. It automatically group the radio buttons inside it.",
30242
- "name": "RadioGroup",
30245
+ "description": "Radio allow users to select single options from a list or turn an item/feature on or off.\nThese are often used in forms, settings, and selection in lists.\n\nA radio component contains an optional label, optional info icon and an optional helper text.",
30246
+ "name": "Radio",
30243
30247
  "cssProperties": [
30244
30248
  {
30245
- "description": "color of the description text",
30246
- "name": "--mdc-radiogroup-description-text-normal"
30249
+ "description": "color of the label when disabled",
30250
+ "name": "--mdc-radio-text-disabled-color"
30251
+ },
30252
+ {
30253
+ "description": "color of the radio button when inactive and hovered",
30254
+ "name": "--mdc-radio-control-inactive-hover"
30255
+ },
30256
+ {
30257
+ "description": "color of the radio button when inactive and pressed",
30258
+ "name": "--mdc-radio-control-inactive-pressed-color"
30259
+ },
30260
+ {
30261
+ "description": "color of the radio button when active and hovered",
30262
+ "name": "--mdc-radio-control-active-hover-color"
30263
+ },
30264
+ {
30265
+ "description": "color of the radio button when active and pressed",
30266
+ "name": "--mdc-radio-control-active-pressed-color"
30267
+ },
30268
+ {
30269
+ "description": "color of the radio button when disabled",
30270
+ "name": "--mdc-radio-disabled-border-color"
30271
+ },
30272
+ {
30273
+ "description": "color of the radio button when active and disabled",
30274
+ "name": "--mdc-radio-control-active-disabled-background"
30275
+ },
30276
+ {
30277
+ "description": "color of the radio button when inactive and disabled",
30278
+ "name": "--mdc-radio-control-inactive-disabled-background"
30247
30279
  }
30248
30280
  ],
30249
30281
  "members": [
30250
30282
  {
30251
30283
  "kind": "field",
30252
- "name": "name",
30284
+ "name": "checked",
30253
30285
  "type": {
30254
- "text": "string"
30286
+ "text": "boolean"
30255
30287
  },
30256
- "default": "''",
30257
- "description": "Name of the radio group.\nThey are used to group elements in a form together.",
30258
- "attribute": "name"
30288
+ "default": "false",
30289
+ "description": "Determines whether the radio is selected or unselected.",
30290
+ "attribute": "checked",
30291
+ "reflects": true
30259
30292
  },
30260
30293
  {
30261
30294
  "kind": "field",
30262
- "name": "dataAriaLabel",
30295
+ "name": "readonly",
30263
30296
  "type": {
30264
- "text": "string | null"
30297
+ "text": "boolean"
30265
30298
  },
30266
- "default": "null",
30267
- "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
30268
- "attribute": "data-aria-label",
30269
- "reflects": true,
30270
- "inheritedFrom": {
30271
- "name": "DataAriaLabelMixin",
30272
- "module": "utils/mixins/DataAriaLabelMixin.js"
30273
- }
30299
+ "default": "false",
30300
+ "description": "Determines whether the radio is read-only.",
30301
+ "attribute": "readonly",
30302
+ "reflects": true
30274
30303
  },
30275
30304
  {
30276
- "kind": "field",
30277
- "name": "disabled",
30278
- "type": {
30279
- "text": "boolean | undefined"
30305
+ "kind": "method",
30306
+ "name": "getAllRadiosWithinSameGroup",
30307
+ "privacy": "private",
30308
+ "return": {
30309
+ "type": {
30310
+ "text": "Radio[]"
30311
+ }
30280
30312
  },
30281
- "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
30282
- "default": "undefined",
30283
- "attribute": "disabled",
30284
- "reflects": true,
30285
- "inheritedFrom": {
30286
- "name": "FormfieldWrapper",
30287
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
30288
- }
30313
+ "description": "Returns all radios within the same group (name)."
30289
30314
  },
30290
30315
  {
30291
- "kind": "field",
30292
- "name": "label",
30293
- "type": {
30294
- "text": "string | undefined"
30316
+ "kind": "method",
30317
+ "name": "setGroupValidity",
30318
+ "privacy": "private",
30319
+ "parameters": [
30320
+ {
30321
+ "name": "radios",
30322
+ "type": {
30323
+ "text": "Radio[]"
30324
+ },
30325
+ "description": "Array of radios of the same group"
30326
+ },
30327
+ {
30328
+ "name": "isValid",
30329
+ "type": {
30330
+ "text": "boolean"
30331
+ },
30332
+ "description": "Boolean value to set the validity of the group"
30333
+ }
30334
+ ],
30335
+ "description": "Sets the validity of the group of radios."
30336
+ },
30337
+ {
30338
+ "kind": "method",
30339
+ "name": "setActualFormValue",
30340
+ "privacy": "private",
30341
+ "description": "Updates the form value to reflect the current state of the radio.\nIf checked, the value is set to the user-provided value.\nIf unchecked, the value is set to null."
30342
+ },
30343
+ {
30344
+ "kind": "method",
30345
+ "name": "handleChange",
30346
+ "privacy": "private",
30347
+ "return": {
30348
+ "type": {
30349
+ "text": "void"
30350
+ }
30295
30351
  },
30296
- "description": "The label of the input field. It is linked to the input field using the `for` attribute.",
30297
- "attribute": "label",
30298
- "reflects": true,
30299
- "inheritedFrom": {
30300
- "name": "FormfieldWrapper",
30301
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
30302
- }
30352
+ "description": "Handles the change event on the radio element.\nThis will toggle the state of the radio element.\nDispatches the change event."
30353
+ },
30354
+ {
30355
+ "kind": "method",
30356
+ "name": "updateRadio",
30357
+ "privacy": "private",
30358
+ "parameters": [
30359
+ {
30360
+ "name": "enabledRadios",
30361
+ "type": {
30362
+ "text": "Radio[]"
30363
+ },
30364
+ "description": "An array of enabled radio buttons within the same group."
30365
+ },
30366
+ {
30367
+ "name": "index",
30368
+ "type": {
30369
+ "text": "number"
30370
+ },
30371
+ "description": "The index of the radio button to be updated within the enabled radios array."
30372
+ }
30373
+ ],
30374
+ "description": "Updates the state of the radio button at the specified index within the enabled radios.\nFocuses the radio button and triggers the change event if the radio button is not read-only."
30375
+ },
30376
+ {
30377
+ "kind": "method",
30378
+ "name": "handleKeyDown",
30379
+ "privacy": "private",
30380
+ "return": {
30381
+ "type": {
30382
+ "text": "void"
30383
+ }
30384
+ },
30385
+ "parameters": [
30386
+ {
30387
+ "name": "event",
30388
+ "type": {
30389
+ "text": "KeyboardEvent"
30390
+ }
30391
+ }
30392
+ ],
30393
+ "description": "Handles the keydown event (Arrow Up/Down/Left/Right) on the radio element."
30394
+ },
30395
+ {
30396
+ "kind": "method",
30397
+ "name": "updateTabIndex",
30398
+ "privacy": "private",
30399
+ "return": {
30400
+ "type": {
30401
+ "text": "void"
30402
+ }
30403
+ },
30404
+ "description": "Update tab index for all radios in the same group (name)\nIf any radio group is checked, it will have a tab index of 0\nIf no radio group is checked, the first enabled radio will have a tab index of 0"
30303
30405
  },
30304
30406
  {
30305
30407
  "kind": "field",
30306
- "name": "required",
30408
+ "name": "renderLabelAndHelperText",
30409
+ "privacy": "private"
30410
+ },
30411
+ {
30412
+ "kind": "field",
30413
+ "name": "autoFocusOnMount",
30307
30414
  "type": {
30308
30415
  "text": "boolean"
30309
30416
  },
30310
30417
  "default": "false",
30311
- "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
30312
- "attribute": "required",
30418
+ "description": "This property indicates whether the element should receive focus automatically when it is mounted.\n\nIt will not focus if the element is re-attached to the DOM after being removed.",
30419
+ "attribute": "auto-focus-on-mount",
30313
30420
  "reflects": true,
30314
30421
  "inheritedFrom": {
30315
- "name": "FormfieldWrapper",
30316
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
30422
+ "name": "AutoFocusOnMountMixin",
30423
+ "module": "utils/mixins/AutoFocusOnMountMixin.js"
30317
30424
  }
30318
30425
  },
30319
30426
  {
30320
30427
  "kind": "field",
30321
- "name": "helpTextType",
30428
+ "name": "name",
30322
30429
  "type": {
30323
- "text": "ValidationType"
30430
+ "text": "string"
30324
30431
  },
30325
- "description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
30326
- "attribute": "help-text-type",
30432
+ "default": "''",
30433
+ "description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
30434
+ "attribute": "name",
30327
30435
  "reflects": true,
30328
30436
  "inheritedFrom": {
30329
- "name": "FormfieldWrapper",
30330
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
30437
+ "name": "FormInternalsMixin",
30438
+ "module": "utils/mixins/FormInternalsMixin.js"
30331
30439
  }
30332
30440
  },
30333
30441
  {
30334
30442
  "kind": "field",
30335
- "name": "helpText",
30443
+ "name": "value",
30336
30444
  "type": {
30337
- "text": "string | undefined"
30445
+ "text": "string"
30338
30446
  },
30339
- "description": "The help text that is displayed below the input field.",
30340
- "attribute": "help-text",
30447
+ "default": "''",
30448
+ "description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
30449
+ "attribute": "value",
30341
30450
  "reflects": true,
30342
30451
  "inheritedFrom": {
30343
- "name": "FormfieldWrapper",
30344
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
30452
+ "name": "FormInternalsMixin",
30453
+ "module": "utils/mixins/FormInternalsMixin.js"
30345
30454
  }
30346
30455
  },
30347
30456
  {
30348
30457
  "kind": "field",
30349
- "name": "toggletipText",
30458
+ "name": "validationMessage",
30350
30459
  "type": {
30351
30460
  "text": "string | undefined"
30352
30461
  },
30353
- "description": "The toggletip text that is displayed when the label is hovered.\nIt is used to provide additional information about the label.",
30354
- "attribute": "toggletip-text",
30462
+ "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.",
30463
+ "attribute": "validation-message",
30355
30464
  "reflects": true,
30356
30465
  "inheritedFrom": {
30357
- "name": "FormfieldWrapper",
30358
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
30466
+ "name": "FormInternalsMixin",
30467
+ "module": "utils/mixins/FormInternalsMixin.js"
30359
30468
  }
30360
30469
  },
30361
30470
  {
30362
30471
  "kind": "field",
30363
- "name": "toggletipPlacement",
30472
+ "name": "validity",
30364
30473
  "type": {
30365
- "text": "PopoverPlacement"
30474
+ "text": "ValidityState"
30366
30475
  },
30367
- "description": "The placement of the toggletip that is displayed when the info icon is hovered.",
30368
- "default": "'top'",
30369
- "attribute": "toggletip-placement",
30370
- "reflects": true,
30476
+ "readonly": true,
30371
30477
  "inheritedFrom": {
30372
- "name": "FormfieldWrapper",
30373
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
30478
+ "name": "FormInternalsMixin",
30479
+ "module": "utils/mixins/FormInternalsMixin.js"
30374
30480
  }
30375
30481
  },
30376
30482
  {
30377
30483
  "kind": "field",
30378
- "name": "infoIconAriaLabel",
30379
- "type": {
30380
- "text": "string | undefined"
30381
- },
30382
- "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.",
30383
- "attribute": "info-icon-aria-label",
30384
- "reflects": true,
30385
- "inheritedFrom": {
30386
- "name": "FormfieldWrapper",
30387
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
30388
- }
30389
- },
30390
- {
30391
- "kind": "method",
30392
- "name": "renderLabelElement",
30393
- "privacy": "protected",
30394
- "description": "creates the label element when the label property is set.\nid is used to link the label with the input field.",
30395
- "return": {
30396
- "type": {
30397
- "text": ""
30398
- }
30399
- },
30400
- "inheritedFrom": {
30401
- "name": "FormfieldWrapper",
30402
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
30403
- }
30404
- },
30405
- {
30406
- "kind": "method",
30407
- "name": "renderHelpTextIcon",
30408
- "privacy": "protected",
30409
- "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.",
30410
- "return": {
30411
- "type": {
30412
- "text": ""
30413
- }
30414
- },
30484
+ "name": "willValidate",
30485
+ "readonly": true,
30415
30486
  "inheritedFrom": {
30416
- "name": "FormfieldWrapper",
30417
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
30487
+ "name": "FormInternalsMixin",
30488
+ "module": "utils/mixins/FormInternalsMixin.js"
30418
30489
  }
30419
30490
  },
30420
30491
  {
30421
30492
  "kind": "method",
30422
- "name": "renderHelpText",
30423
- "privacy": "protected",
30424
- "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.",
30493
+ "name": "setValidity",
30494
+ "description": "Sets the validity of the input field based on the input field's validity.",
30425
30495
  "return": {
30426
30496
  "type": {
30427
30497
  "text": ""
30428
30498
  }
30429
30499
  },
30430
30500
  "inheritedFrom": {
30431
- "name": "FormfieldWrapper",
30432
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
30501
+ "name": "FormInternalsMixin",
30502
+ "module": "utils/mixins/FormInternalsMixin.js"
30433
30503
  }
30434
30504
  },
30435
30505
  {
30436
30506
  "kind": "method",
30437
- "name": "renderLabel",
30438
- "privacy": "protected",
30439
- "description": "renders the mdc-label-text container that contains the label and labelInfoToggleTip.",
30507
+ "name": "checkValidity",
30440
30508
  "return": {
30441
30509
  "type": {
30442
- "text": ""
30510
+ "text": "boolean"
30443
30511
  }
30444
30512
  },
30445
30513
  "inheritedFrom": {
30446
- "name": "FormfieldWrapper",
30447
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
30514
+ "name": "FormInternalsMixin",
30515
+ "module": "utils/mixins/FormInternalsMixin.js"
30448
30516
  }
30449
30517
  },
30450
30518
  {
30451
30519
  "kind": "method",
30452
- "name": "renderHelperText",
30453
- "privacy": "protected",
30454
- "description": "renders the mdc-help-text container that contains the helpertext icon and helpertext.",
30455
- "return": {
30456
- "type": {
30457
- "text": ""
30458
- }
30459
- },
30520
+ "name": "reportValidity",
30460
30521
  "inheritedFrom": {
30461
- "name": "FormfieldWrapper",
30462
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
30522
+ "name": "FormInternalsMixin",
30523
+ "module": "utils/mixins/FormInternalsMixin.js"
30463
30524
  }
30464
- }
30465
- ],
30466
- "attributes": [
30467
- {
30468
- "name": "name",
30469
- "type": {
30470
- "text": "string"
30471
- },
30472
- "default": "''",
30473
- "description": "Name of the radio group.\nThey are used to group elements in a form together.",
30474
- "fieldName": "name"
30475
30525
  },
30476
30526
  {
30477
- "name": "data-aria-label",
30527
+ "kind": "field",
30528
+ "name": "dataAriaLabel",
30478
30529
  "type": {
30479
30530
  "text": "string | null"
30480
30531
  },
30481
30532
  "default": "null",
30482
30533
  "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
30483
- "fieldName": "dataAriaLabel",
30534
+ "attribute": "data-aria-label",
30535
+ "reflects": true,
30484
30536
  "inheritedFrom": {
30485
30537
  "name": "DataAriaLabelMixin",
30486
- "module": "src/utils/mixins/DataAriaLabelMixin.ts"
30538
+ "module": "utils/mixins/DataAriaLabelMixin.js"
30487
30539
  }
30488
30540
  },
30489
30541
  {
30542
+ "kind": "field",
30490
30543
  "name": "disabled",
30491
30544
  "type": {
30492
30545
  "text": "boolean | undefined"
30493
30546
  },
30494
30547
  "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
30495
30548
  "default": "undefined",
30496
- "fieldName": "disabled",
30549
+ "attribute": "disabled",
30550
+ "reflects": true,
30497
30551
  "inheritedFrom": {
30498
30552
  "name": "FormfieldWrapper",
30499
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
30553
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
30500
30554
  }
30501
30555
  },
30502
30556
  {
30557
+ "kind": "field",
30503
30558
  "name": "label",
30504
30559
  "type": {
30505
30560
  "text": "string | undefined"
30506
30561
  },
30507
30562
  "description": "The label of the input field. It is linked to the input field using the `for` attribute.",
30508
- "fieldName": "label",
30563
+ "attribute": "label",
30564
+ "reflects": true,
30509
30565
  "inheritedFrom": {
30510
30566
  "name": "FormfieldWrapper",
30511
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
30567
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
30512
30568
  }
30513
30569
  },
30514
30570
  {
30571
+ "kind": "field",
30515
30572
  "name": "required",
30516
30573
  "type": {
30517
30574
  "text": "boolean"
30518
30575
  },
30519
30576
  "default": "false",
30520
30577
  "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
30521
- "fieldName": "required",
30578
+ "attribute": "required",
30579
+ "reflects": true,
30522
30580
  "inheritedFrom": {
30523
30581
  "name": "FormfieldWrapper",
30524
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
30582
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
30525
30583
  }
30526
30584
  },
30527
30585
  {
30528
- "name": "help-text-type",
30586
+ "kind": "field",
30587
+ "name": "helpTextType",
30529
30588
  "type": {
30530
30589
  "text": "ValidationType"
30531
30590
  },
30532
30591
  "description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
30533
- "fieldName": "helpTextType",
30592
+ "attribute": "help-text-type",
30593
+ "reflects": true,
30534
30594
  "inheritedFrom": {
30535
30595
  "name": "FormfieldWrapper",
30536
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
30596
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
30537
30597
  }
30538
30598
  },
30539
30599
  {
30540
- "name": "help-text",
30600
+ "kind": "field",
30601
+ "name": "helpText",
30541
30602
  "type": {
30542
30603
  "text": "string | undefined"
30543
30604
  },
30544
30605
  "description": "The help text that is displayed below the input field.",
30545
- "fieldName": "helpText",
30606
+ "attribute": "help-text",
30607
+ "reflects": true,
30546
30608
  "inheritedFrom": {
30547
30609
  "name": "FormfieldWrapper",
30548
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
30610
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
30549
30611
  }
30550
30612
  },
30551
30613
  {
30552
- "name": "toggletip-text",
30614
+ "kind": "field",
30615
+ "name": "toggletipText",
30553
30616
  "type": {
30554
30617
  "text": "string | undefined"
30555
30618
  },
30556
30619
  "description": "The toggletip text that is displayed when the label is hovered.\nIt is used to provide additional information about the label.",
30557
- "fieldName": "toggletipText",
30620
+ "attribute": "toggletip-text",
30621
+ "reflects": true,
30558
30622
  "inheritedFrom": {
30559
30623
  "name": "FormfieldWrapper",
30560
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
30624
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
30561
30625
  }
30562
30626
  },
30563
30627
  {
30564
- "name": "toggletip-placement",
30628
+ "kind": "field",
30629
+ "name": "toggletipPlacement",
30565
30630
  "type": {
30566
30631
  "text": "PopoverPlacement"
30567
30632
  },
30568
30633
  "description": "The placement of the toggletip that is displayed when the info icon is hovered.",
30569
30634
  "default": "'top'",
30570
- "fieldName": "toggletipPlacement",
30635
+ "attribute": "toggletip-placement",
30636
+ "reflects": true,
30571
30637
  "inheritedFrom": {
30572
30638
  "name": "FormfieldWrapper",
30573
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
30639
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
30574
30640
  }
30575
30641
  },
30576
30642
  {
30577
- "name": "info-icon-aria-label",
30643
+ "kind": "field",
30644
+ "name": "infoIconAriaLabel",
30578
30645
  "type": {
30579
30646
  "text": "string | undefined"
30580
30647
  },
30581
30648
  "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.",
30582
- "fieldName": "infoIconAriaLabel",
30649
+ "attribute": "info-icon-aria-label",
30650
+ "reflects": true,
30583
30651
  "inheritedFrom": {
30584
30652
  "name": "FormfieldWrapper",
30585
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
30586
- }
30587
- }
30588
- ],
30589
- "superclass": {
30590
- "name": "FormfieldGroup",
30591
- "module": "/src/components/formfieldgroup"
30592
- },
30593
- "tagName": "mdc-radiogroup",
30594
- "jsDoc": "/**\n * `mdc-radiogroup` - This is the wrapper component for radio buttons which are grouped together.\n * It can have a header text and a description. It enables users to select a single option from a set of options.\n * It is often used in forms, settings, and selection in lists. It automatically group the radio buttons inside it.\n *\n * @tagname mdc-radiogroup\n *\n * @cssproperty --mdc-radiogroup-description-text-normal - color of the description text\n *\n */",
30595
- "customElement": true,
30596
- "slots": [
30597
- {
30598
- "description": "This is a default slot for checkbox or toggle components.",
30599
- "name": "default",
30600
- "inheritedFrom": {
30601
- "name": "FormfieldGroup",
30602
- "module": "src/components/formfieldgroup/formfieldgroup.component.ts"
30653
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
30603
30654
  }
30604
- }
30605
- ]
30606
- }
30607
- ],
30608
- "exports": [
30609
- {
30610
- "kind": "js",
30611
- "name": "default",
30612
- "declaration": {
30613
- "name": "RadioGroup",
30614
- "module": "components/radiogroup/radiogroup.component.js"
30615
- }
30616
- }
30617
- ]
30618
- },
30619
- {
30620
- "kind": "javascript-module",
30621
- "path": "components/radio/radio.component.js",
30622
- "declarations": [
30623
- {
30624
- "kind": "class",
30625
- "description": "Radio allow users to select single options from a list or turn an item/feature on or off.\nThese are often used in forms, settings, and selection in lists.\n\nA radio component contains an optional label, optional info icon and an optional helper text.",
30626
- "name": "Radio",
30627
- "cssProperties": [
30628
- {
30629
- "description": "color of the label when disabled",
30630
- "name": "--mdc-radio-text-disabled-color"
30631
- },
30632
- {
30633
- "description": "color of the radio button when inactive and hovered",
30634
- "name": "--mdc-radio-control-inactive-hover"
30635
- },
30636
- {
30637
- "description": "color of the radio button when inactive and pressed",
30638
- "name": "--mdc-radio-control-inactive-pressed-color"
30639
- },
30640
- {
30641
- "description": "color of the radio button when active and hovered",
30642
- "name": "--mdc-radio-control-active-hover-color"
30643
- },
30644
- {
30645
- "description": "color of the radio button when active and pressed",
30646
- "name": "--mdc-radio-control-active-pressed-color"
30647
- },
30648
- {
30649
- "description": "color of the radio button when disabled",
30650
- "name": "--mdc-radio-disabled-border-color"
30651
- },
30652
- {
30653
- "description": "color of the radio button when active and disabled",
30654
- "name": "--mdc-radio-control-active-disabled-background"
30655
- },
30656
- {
30657
- "description": "color of the radio button when inactive and disabled",
30658
- "name": "--mdc-radio-control-inactive-disabled-background"
30659
- }
30660
- ],
30661
- "members": [
30662
- {
30663
- "kind": "field",
30664
- "name": "checked",
30665
- "type": {
30666
- "text": "boolean"
30667
- },
30668
- "default": "false",
30669
- "description": "Determines whether the radio is selected or unselected.",
30670
- "attribute": "checked",
30671
- "reflects": true
30672
- },
30673
- {
30674
- "kind": "field",
30675
- "name": "readonly",
30676
- "type": {
30677
- "text": "boolean"
30678
- },
30679
- "default": "false",
30680
- "description": "Determines whether the radio is read-only.",
30681
- "attribute": "readonly",
30682
- "reflects": true
30683
30655
  },
30684
30656
  {
30685
30657
  "kind": "method",
30686
- "name": "getAllRadiosWithinSameGroup",
30687
- "privacy": "private",
30658
+ "name": "renderLabelElement",
30659
+ "privacy": "protected",
30660
+ "description": "creates the label element when the label property is set.\nid is used to link the label with the input field.",
30688
30661
  "return": {
30689
30662
  "type": {
30690
- "text": "Radio[]"
30663
+ "text": ""
30691
30664
  }
30692
30665
  },
30693
- "description": "Returns all radios within the same group (name)."
30694
- },
30695
- {
30696
- "kind": "method",
30697
- "name": "setGroupValidity",
30698
- "privacy": "private",
30699
- "parameters": [
30700
- {
30701
- "name": "radios",
30702
- "type": {
30703
- "text": "Radio[]"
30704
- },
30705
- "description": "Array of radios of the same group"
30706
- },
30707
- {
30708
- "name": "isValid",
30709
- "type": {
30710
- "text": "boolean"
30711
- },
30712
- "description": "Boolean value to set the validity of the group"
30713
- }
30714
- ],
30715
- "description": "Sets the validity of the group of radios."
30716
- },
30717
- {
30718
- "kind": "method",
30719
- "name": "setActualFormValue",
30720
- "privacy": "private",
30721
- "description": "Updates the form value to reflect the current state of the radio.\nIf checked, the value is set to the user-provided value.\nIf unchecked, the value is set to null."
30666
+ "inheritedFrom": {
30667
+ "name": "FormfieldWrapper",
30668
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
30669
+ }
30722
30670
  },
30723
30671
  {
30724
30672
  "kind": "method",
30725
- "name": "handleChange",
30726
- "privacy": "private",
30673
+ "name": "renderHelpTextIcon",
30674
+ "privacy": "protected",
30675
+ "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.",
30727
30676
  "return": {
30728
30677
  "type": {
30729
- "text": "void"
30678
+ "text": ""
30730
30679
  }
30731
30680
  },
30732
- "description": "Handles the change event on the radio element.\nThis will toggle the state of the radio element.\nDispatches the change event."
30681
+ "inheritedFrom": {
30682
+ "name": "FormfieldWrapper",
30683
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
30684
+ }
30733
30685
  },
30734
30686
  {
30735
30687
  "kind": "method",
30736
- "name": "updateRadio",
30737
- "privacy": "private",
30738
- "parameters": [
30739
- {
30740
- "name": "enabledRadios",
30741
- "type": {
30742
- "text": "Radio[]"
30743
- },
30744
- "description": "An array of enabled radio buttons within the same group."
30745
- },
30746
- {
30747
- "name": "index",
30748
- "type": {
30749
- "text": "number"
30750
- },
30751
- "description": "The index of the radio button to be updated within the enabled radios array."
30688
+ "name": "renderHelpText",
30689
+ "privacy": "protected",
30690
+ "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.",
30691
+ "return": {
30692
+ "type": {
30693
+ "text": ""
30752
30694
  }
30753
- ],
30754
- "description": "Updates the state of the radio button at the specified index within the enabled radios.\nFocuses the radio button and triggers the change event if the radio button is not read-only."
30695
+ },
30696
+ "inheritedFrom": {
30697
+ "name": "FormfieldWrapper",
30698
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
30699
+ }
30755
30700
  },
30756
30701
  {
30757
30702
  "kind": "method",
30758
- "name": "handleKeyDown",
30759
- "privacy": "private",
30703
+ "name": "renderLabel",
30704
+ "privacy": "protected",
30705
+ "description": "renders the mdc-label-text container that contains the label and labelInfoToggleTip.",
30760
30706
  "return": {
30761
30707
  "type": {
30762
- "text": "void"
30708
+ "text": ""
30763
30709
  }
30764
30710
  },
30765
- "parameters": [
30766
- {
30767
- "name": "event",
30768
- "type": {
30769
- "text": "KeyboardEvent"
30770
- }
30771
- }
30772
- ],
30773
- "description": "Handles the keydown event (Arrow Up/Down/Left/Right) on the radio element."
30711
+ "inheritedFrom": {
30712
+ "name": "FormfieldWrapper",
30713
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
30714
+ }
30774
30715
  },
30775
30716
  {
30776
30717
  "kind": "method",
30777
- "name": "updateTabIndex",
30778
- "privacy": "private",
30718
+ "name": "renderHelperText",
30719
+ "privacy": "protected",
30720
+ "description": "renders the mdc-help-text container that contains the helpertext icon and helpertext.",
30779
30721
  "return": {
30780
30722
  "type": {
30781
- "text": "void"
30723
+ "text": ""
30782
30724
  }
30783
30725
  },
30784
- "description": "Update tab index for all radios in the same group (name)\nIf any radio group is checked, it will have a tab index of 0\nIf no radio group is checked, the first enabled radio will have a tab index of 0"
30726
+ "inheritedFrom": {
30727
+ "name": "FormfieldWrapper",
30728
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
30729
+ }
30730
+ }
30731
+ ],
30732
+ "events": [
30733
+ {
30734
+ "name": "change",
30735
+ "type": {
30736
+ "text": "Event"
30737
+ },
30738
+ "description": "(React: onChange) Event that gets dispatched when the radio state changes.",
30739
+ "reactName": "onChange"
30785
30740
  },
30786
30741
  {
30787
- "kind": "field",
30788
- "name": "renderLabelAndHelperText",
30789
- "privacy": "private"
30742
+ "description": "(React: onFocus) Event that gets dispatched when the radio receives focus.",
30743
+ "name": "focus",
30744
+ "reactName": "onFocus"
30745
+ }
30746
+ ],
30747
+ "attributes": [
30748
+ {
30749
+ "name": "checked",
30750
+ "type": {
30751
+ "text": "boolean"
30752
+ },
30753
+ "default": "false",
30754
+ "description": "Determines whether the radio is selected or unselected.",
30755
+ "fieldName": "checked"
30790
30756
  },
30791
30757
  {
30792
- "kind": "field",
30793
- "name": "autoFocusOnMount",
30758
+ "name": "readonly",
30759
+ "type": {
30760
+ "text": "boolean"
30761
+ },
30762
+ "default": "false",
30763
+ "description": "Determines whether the radio is read-only.",
30764
+ "fieldName": "readonly"
30765
+ },
30766
+ {
30767
+ "name": "auto-focus-on-mount",
30794
30768
  "type": {
30795
30769
  "text": "boolean"
30796
30770
  },
30797
30771
  "default": "false",
30798
30772
  "description": "This property indicates whether the element should receive focus automatically when it is mounted.\n\nIt will not focus if the element is re-attached to the DOM after being removed.",
30799
- "attribute": "auto-focus-on-mount",
30800
- "reflects": true,
30773
+ "fieldName": "autoFocusOnMount",
30801
30774
  "inheritedFrom": {
30802
30775
  "name": "AutoFocusOnMountMixin",
30803
- "module": "utils/mixins/AutoFocusOnMountMixin.js"
30776
+ "module": "src/utils/mixins/AutoFocusOnMountMixin.ts"
30804
30777
  }
30805
30778
  },
30806
30779
  {
30807
- "kind": "field",
30808
30780
  "name": "name",
30809
30781
  "type": {
30810
30782
  "text": "string"
30811
30783
  },
30812
30784
  "default": "''",
30813
30785
  "description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
30814
- "attribute": "name",
30815
- "reflects": true,
30786
+ "fieldName": "name",
30816
30787
  "inheritedFrom": {
30817
30788
  "name": "FormInternalsMixin",
30818
- "module": "utils/mixins/FormInternalsMixin.js"
30789
+ "module": "src/utils/mixins/FormInternalsMixin.ts"
30819
30790
  }
30820
30791
  },
30821
30792
  {
30822
- "kind": "field",
30823
30793
  "name": "value",
30824
30794
  "type": {
30825
30795
  "text": "string"
30826
30796
  },
30827
30797
  "default": "''",
30828
30798
  "description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
30829
- "attribute": "value",
30830
- "reflects": true,
30799
+ "fieldName": "value",
30800
+ "inheritedFrom": {
30801
+ "name": "FormInternalsMixin",
30802
+ "module": "src/utils/mixins/FormInternalsMixin.ts"
30803
+ }
30804
+ },
30805
+ {
30806
+ "name": "validation-message",
30807
+ "type": {
30808
+ "text": "string | undefined"
30809
+ },
30810
+ "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.",
30811
+ "fieldName": "validationMessage",
30812
+ "inheritedFrom": {
30813
+ "name": "FormInternalsMixin",
30814
+ "module": "src/utils/mixins/FormInternalsMixin.ts"
30815
+ }
30816
+ },
30817
+ {
30818
+ "name": "data-aria-label",
30819
+ "type": {
30820
+ "text": "string | null"
30821
+ },
30822
+ "default": "null",
30823
+ "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
30824
+ "fieldName": "dataAriaLabel",
30825
+ "inheritedFrom": {
30826
+ "name": "DataAriaLabelMixin",
30827
+ "module": "src/utils/mixins/DataAriaLabelMixin.ts"
30828
+ }
30829
+ },
30830
+ {
30831
+ "name": "disabled",
30832
+ "type": {
30833
+ "text": "boolean | undefined"
30834
+ },
30835
+ "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
30836
+ "default": "undefined",
30837
+ "fieldName": "disabled",
30838
+ "inheritedFrom": {
30839
+ "name": "FormfieldWrapper",
30840
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
30841
+ }
30842
+ },
30843
+ {
30844
+ "name": "label",
30845
+ "type": {
30846
+ "text": "string | undefined"
30847
+ },
30848
+ "description": "The label of the input field. It is linked to the input field using the `for` attribute.",
30849
+ "fieldName": "label",
30850
+ "inheritedFrom": {
30851
+ "name": "FormfieldWrapper",
30852
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
30853
+ }
30854
+ },
30855
+ {
30856
+ "name": "required",
30857
+ "type": {
30858
+ "text": "boolean"
30859
+ },
30860
+ "default": "false",
30861
+ "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
30862
+ "fieldName": "required",
30831
30863
  "inheritedFrom": {
30832
- "name": "FormInternalsMixin",
30833
- "module": "utils/mixins/FormInternalsMixin.js"
30864
+ "name": "FormfieldWrapper",
30865
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
30834
30866
  }
30835
30867
  },
30836
30868
  {
30837
- "kind": "field",
30838
- "name": "validationMessage",
30869
+ "name": "help-text-type",
30839
30870
  "type": {
30840
- "text": "string | undefined"
30871
+ "text": "ValidationType"
30841
30872
  },
30842
- "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.",
30843
- "attribute": "validation-message",
30844
- "reflects": true,
30873
+ "description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
30874
+ "fieldName": "helpTextType",
30845
30875
  "inheritedFrom": {
30846
- "name": "FormInternalsMixin",
30847
- "module": "utils/mixins/FormInternalsMixin.js"
30876
+ "name": "FormfieldWrapper",
30877
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
30848
30878
  }
30849
30879
  },
30850
30880
  {
30851
- "kind": "field",
30852
- "name": "validity",
30881
+ "name": "help-text",
30853
30882
  "type": {
30854
- "text": "ValidityState"
30883
+ "text": "string | undefined"
30855
30884
  },
30856
- "readonly": true,
30885
+ "description": "The help text that is displayed below the input field.",
30886
+ "fieldName": "helpText",
30857
30887
  "inheritedFrom": {
30858
- "name": "FormInternalsMixin",
30859
- "module": "utils/mixins/FormInternalsMixin.js"
30888
+ "name": "FormfieldWrapper",
30889
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
30860
30890
  }
30861
30891
  },
30862
30892
  {
30863
- "kind": "field",
30864
- "name": "willValidate",
30865
- "readonly": true,
30893
+ "name": "toggletip-text",
30894
+ "type": {
30895
+ "text": "string | undefined"
30896
+ },
30897
+ "description": "The toggletip text that is displayed when the label is hovered.\nIt is used to provide additional information about the label.",
30898
+ "fieldName": "toggletipText",
30866
30899
  "inheritedFrom": {
30867
- "name": "FormInternalsMixin",
30868
- "module": "utils/mixins/FormInternalsMixin.js"
30900
+ "name": "FormfieldWrapper",
30901
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
30869
30902
  }
30870
30903
  },
30871
30904
  {
30872
- "kind": "method",
30873
- "name": "setValidity",
30874
- "description": "Sets the validity of the input field based on the input field's validity.",
30875
- "return": {
30876
- "type": {
30877
- "text": ""
30878
- }
30905
+ "name": "toggletip-placement",
30906
+ "type": {
30907
+ "text": "PopoverPlacement"
30879
30908
  },
30909
+ "description": "The placement of the toggletip that is displayed when the info icon is hovered.",
30910
+ "default": "'top'",
30911
+ "fieldName": "toggletipPlacement",
30880
30912
  "inheritedFrom": {
30881
- "name": "FormInternalsMixin",
30882
- "module": "utils/mixins/FormInternalsMixin.js"
30913
+ "name": "FormfieldWrapper",
30914
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
30883
30915
  }
30884
30916
  },
30885
30917
  {
30886
- "kind": "method",
30887
- "name": "checkValidity",
30888
- "return": {
30889
- "type": {
30890
- "text": "boolean"
30891
- }
30918
+ "name": "info-icon-aria-label",
30919
+ "type": {
30920
+ "text": "string | undefined"
30892
30921
  },
30922
+ "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.",
30923
+ "fieldName": "infoIconAriaLabel",
30893
30924
  "inheritedFrom": {
30894
- "name": "FormInternalsMixin",
30895
- "module": "utils/mixins/FormInternalsMixin.js"
30925
+ "name": "FormfieldWrapper",
30926
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
30896
30927
  }
30928
+ }
30929
+ ],
30930
+ "mixins": [
30931
+ {
30932
+ "name": "AutoFocusOnMountMixin",
30933
+ "module": "/src/utils/mixins/AutoFocusOnMountMixin"
30897
30934
  },
30898
30935
  {
30899
- "kind": "method",
30900
- "name": "reportValidity",
30901
- "inheritedFrom": {
30902
- "name": "FormInternalsMixin",
30903
- "module": "utils/mixins/FormInternalsMixin.js"
30904
- }
30936
+ "name": "FormInternalsMixin",
30937
+ "module": "/src/utils/mixins/FormInternalsMixin"
30938
+ },
30939
+ {
30940
+ "name": "DataAriaLabelMixin",
30941
+ "module": "/src/utils/mixins/DataAriaLabelMixin"
30942
+ }
30943
+ ],
30944
+ "superclass": {
30945
+ "name": "FormfieldWrapper",
30946
+ "module": "/src/components/formfieldwrapper/formfieldwrapper.component"
30947
+ },
30948
+ "tagName": "mdc-radio",
30949
+ "jsDoc": "/**\n * Radio allow users to select single options from a list or turn an item/feature on or off.\n * These are often used in forms, settings, and selection in lists.\n *\n * A radio component contains an optional label, optional info icon and an optional helper text.\n *\n * @dependency mdc-button\n * @dependency mdc-icon\n * @dependency mdc-text\n * @dependency mdc-staticradio\n * @dependency mdc-toggletip\n *\n * @tagname mdc-radio\n *\n * @event change - (React: onChange) Event that gets dispatched when the radio state changes.\n * @event focus - (React: onFocus) Event that gets dispatched when the radio receives focus.\n *\n * @cssproperty --mdc-radio-text-disabled-color - color of the label when disabled\n * @cssproperty --mdc-radio-control-inactive-hover - color of the radio button when inactive and hovered\n * @cssproperty --mdc-radio-control-inactive-pressed-color - color of the radio button when inactive and pressed\n * @cssproperty --mdc-radio-control-active-hover-color - color of the radio button when active and hovered\n * @cssproperty --mdc-radio-control-active-pressed-color - color of the radio button when active and pressed\n * @cssproperty --mdc-radio-disabled-border-color - color of the radio button when disabled\n * @cssproperty --mdc-radio-control-active-disabled-background - color of the radio button when active and disabled\n * @cssproperty --mdc-radio-control-inactive-disabled-background - color of the radio button when inactive and disabled\n *\n */",
30950
+ "customElement": true
30951
+ }
30952
+ ],
30953
+ "exports": [
30954
+ {
30955
+ "kind": "js",
30956
+ "name": "default",
30957
+ "declaration": {
30958
+ "name": "Radio",
30959
+ "module": "components/radio/radio.component.js"
30960
+ }
30961
+ }
30962
+ ]
30963
+ },
30964
+ {
30965
+ "kind": "javascript-module",
30966
+ "path": "components/radiogroup/radiogroup.component.js",
30967
+ "declarations": [
30968
+ {
30969
+ "kind": "class",
30970
+ "description": "`mdc-radiogroup` - This is the wrapper component for radio buttons which are grouped together.\nIt can have a header text and a description. It enables users to select a single option from a set of options.\nIt is often used in forms, settings, and selection in lists. It automatically group the radio buttons inside it.",
30971
+ "name": "RadioGroup",
30972
+ "cssProperties": [
30973
+ {
30974
+ "description": "color of the description text",
30975
+ "name": "--mdc-radiogroup-description-text-normal"
30976
+ }
30977
+ ],
30978
+ "members": [
30979
+ {
30980
+ "kind": "field",
30981
+ "name": "name",
30982
+ "type": {
30983
+ "text": "string"
30984
+ },
30985
+ "default": "''",
30986
+ "description": "Name of the radio group.\nThey are used to group elements in a form together.",
30987
+ "attribute": "name"
30905
30988
  },
30906
30989
  {
30907
30990
  "kind": "field",
@@ -31109,90 +31192,15 @@
31109
31192
  }
31110
31193
  }
31111
31194
  ],
31112
- "events": [
31113
- {
31114
- "name": "change",
31115
- "type": {
31116
- "text": "Event"
31117
- },
31118
- "description": "(React: onChange) Event that gets dispatched when the radio state changes.",
31119
- "reactName": "onChange"
31120
- },
31121
- {
31122
- "description": "(React: onFocus) Event that gets dispatched when the radio receives focus.",
31123
- "name": "focus",
31124
- "reactName": "onFocus"
31125
- }
31126
- ],
31127
31195
  "attributes": [
31128
- {
31129
- "name": "checked",
31130
- "type": {
31131
- "text": "boolean"
31132
- },
31133
- "default": "false",
31134
- "description": "Determines whether the radio is selected or unselected.",
31135
- "fieldName": "checked"
31136
- },
31137
- {
31138
- "name": "readonly",
31139
- "type": {
31140
- "text": "boolean"
31141
- },
31142
- "default": "false",
31143
- "description": "Determines whether the radio is read-only.",
31144
- "fieldName": "readonly"
31145
- },
31146
- {
31147
- "name": "auto-focus-on-mount",
31148
- "type": {
31149
- "text": "boolean"
31150
- },
31151
- "default": "false",
31152
- "description": "This property indicates whether the element should receive focus automatically when it is mounted.\n\nIt will not focus if the element is re-attached to the DOM after being removed.",
31153
- "fieldName": "autoFocusOnMount",
31154
- "inheritedFrom": {
31155
- "name": "AutoFocusOnMountMixin",
31156
- "module": "src/utils/mixins/AutoFocusOnMountMixin.ts"
31157
- }
31158
- },
31159
31196
  {
31160
31197
  "name": "name",
31161
31198
  "type": {
31162
31199
  "text": "string"
31163
31200
  },
31164
31201
  "default": "''",
31165
- "description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
31166
- "fieldName": "name",
31167
- "inheritedFrom": {
31168
- "name": "FormInternalsMixin",
31169
- "module": "src/utils/mixins/FormInternalsMixin.ts"
31170
- }
31171
- },
31172
- {
31173
- "name": "value",
31174
- "type": {
31175
- "text": "string"
31176
- },
31177
- "default": "''",
31178
- "description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
31179
- "fieldName": "value",
31180
- "inheritedFrom": {
31181
- "name": "FormInternalsMixin",
31182
- "module": "src/utils/mixins/FormInternalsMixin.ts"
31183
- }
31184
- },
31185
- {
31186
- "name": "validation-message",
31187
- "type": {
31188
- "text": "string | undefined"
31189
- },
31190
- "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.",
31191
- "fieldName": "validationMessage",
31192
- "inheritedFrom": {
31193
- "name": "FormInternalsMixin",
31194
- "module": "src/utils/mixins/FormInternalsMixin.ts"
31195
- }
31202
+ "description": "Name of the radio group.\nThey are used to group elements in a form together.",
31203
+ "fieldName": "name"
31196
31204
  },
31197
31205
  {
31198
31206
  "name": "data-aria-label",
@@ -31307,27 +31315,23 @@
31307
31315
  }
31308
31316
  }
31309
31317
  ],
31310
- "mixins": [
31311
- {
31312
- "name": "AutoFocusOnMountMixin",
31313
- "module": "/src/utils/mixins/AutoFocusOnMountMixin"
31314
- },
31315
- {
31316
- "name": "FormInternalsMixin",
31317
- "module": "/src/utils/mixins/FormInternalsMixin"
31318
- },
31319
- {
31320
- "name": "DataAriaLabelMixin",
31321
- "module": "/src/utils/mixins/DataAriaLabelMixin"
31322
- }
31323
- ],
31324
31318
  "superclass": {
31325
- "name": "FormfieldWrapper",
31326
- "module": "/src/components/formfieldwrapper/formfieldwrapper.component"
31319
+ "name": "FormfieldGroup",
31320
+ "module": "/src/components/formfieldgroup"
31327
31321
  },
31328
- "tagName": "mdc-radio",
31329
- "jsDoc": "/**\n * Radio allow users to select single options from a list or turn an item/feature on or off.\n * These are often used in forms, settings, and selection in lists.\n *\n * A radio component contains an optional label, optional info icon and an optional helper text.\n *\n * @dependency mdc-button\n * @dependency mdc-icon\n * @dependency mdc-text\n * @dependency mdc-staticradio\n * @dependency mdc-toggletip\n *\n * @tagname mdc-radio\n *\n * @event change - (React: onChange) Event that gets dispatched when the radio state changes.\n * @event focus - (React: onFocus) Event that gets dispatched when the radio receives focus.\n *\n * @cssproperty --mdc-radio-text-disabled-color - color of the label when disabled\n * @cssproperty --mdc-radio-control-inactive-hover - color of the radio button when inactive and hovered\n * @cssproperty --mdc-radio-control-inactive-pressed-color - color of the radio button when inactive and pressed\n * @cssproperty --mdc-radio-control-active-hover-color - color of the radio button when active and hovered\n * @cssproperty --mdc-radio-control-active-pressed-color - color of the radio button when active and pressed\n * @cssproperty --mdc-radio-disabled-border-color - color of the radio button when disabled\n * @cssproperty --mdc-radio-control-active-disabled-background - color of the radio button when active and disabled\n * @cssproperty --mdc-radio-control-inactive-disabled-background - color of the radio button when inactive and disabled\n *\n */",
31330
- "customElement": true
31322
+ "tagName": "mdc-radiogroup",
31323
+ "jsDoc": "/**\n * `mdc-radiogroup` - This is the wrapper component for radio buttons which are grouped together.\n * It can have a header text and a description. It enables users to select a single option from a set of options.\n * It is often used in forms, settings, and selection in lists. It automatically group the radio buttons inside it.\n *\n * @tagname mdc-radiogroup\n *\n * @cssproperty --mdc-radiogroup-description-text-normal - color of the description text\n *\n */",
31324
+ "customElement": true,
31325
+ "slots": [
31326
+ {
31327
+ "description": "This is a default slot for checkbox or toggle components.",
31328
+ "name": "default",
31329
+ "inheritedFrom": {
31330
+ "name": "FormfieldGroup",
31331
+ "module": "src/components/formfieldgroup/formfieldgroup.component.ts"
31332
+ }
31333
+ }
31334
+ ]
31331
31335
  }
31332
31336
  ],
31333
31337
  "exports": [
@@ -31335,8 +31339,8 @@
31335
31339
  "kind": "js",
31336
31340
  "name": "default",
31337
31341
  "declaration": {
31338
- "name": "Radio",
31339
- "module": "components/radio/radio.component.js"
31342
+ "name": "RadioGroup",
31343
+ "module": "components/radiogroup/radiogroup.component.js"
31340
31344
  }
31341
31345
  }
31342
31346
  ]