@momentum-design/components 0.58.1 → 0.60.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -491,67 +491,6 @@
491
491
  }
492
492
  ]
493
493
  },
494
- {
495
- "kind": "javascript-module",
496
- "path": "components/appheader/appheader.component.js",
497
- "declarations": [
498
- {
499
- "kind": "class",
500
- "description": "The `mdc-appheader` component provides a structured and accessible app header layout.\nIt consists of three primary sections: leading, center, and trailing.\n\n- The **leading section** typically holds a **brand logo**, **brand name** or **menu icon**.\n- The **center section** can contain a **search bar**, **icons** or action controls.\n- The **trailing section** generally includes a **profile avatar**, **additional icons** or **action controls**.",
501
- "name": "Appheader",
502
- "cssParts": [
503
- {
504
- "description": "The main container for styling the header.",
505
- "name": "container"
506
- },
507
- {
508
- "description": "The leading section of the header.",
509
- "name": "leading-section"
510
- },
511
- {
512
- "description": "The center section of the header.",
513
- "name": "center-section"
514
- },
515
- {
516
- "description": "The trailing section of the header.",
517
- "name": "trailing-section"
518
- }
519
- ],
520
- "slots": [
521
- {
522
- "description": "Slot for the leading section (e.g., brand logo, brand name).",
523
- "name": "leading"
524
- },
525
- {
526
- "description": "Slot for the center section (e.g., search bar, icons).",
527
- "name": "center"
528
- },
529
- {
530
- "description": "Slot for the trailing section (e.g., profile avatar, icons).",
531
- "name": "trailing"
532
- }
533
- ],
534
- "members": [],
535
- "superclass": {
536
- "name": "Component",
537
- "module": "/src/models"
538
- },
539
- "tagName": "mdc-appheader",
540
- "jsDoc": "/**\n * The `mdc-appheader` component provides a structured and accessible app header layout.\n * It consists of three primary sections: leading, center, and trailing.\n *\n * - The **leading section** typically holds a **brand logo**, **brand name** or **menu icon**.\n * - The **center section** can contain a **search bar**, **icons** or action controls.\n * - The **trailing section** generally includes a **profile avatar**, **additional icons** or **action controls**.\n *\n * @tagname mdc-appheader\n *\n * @slot leading - Slot for the leading section (e.g., brand logo, brand name).\n * @slot center - Slot for the center section (e.g., search bar, icons).\n * @slot trailing - Slot for the trailing section (e.g., profile avatar, icons).\n *\n * @csspart container - The main container for styling the header.\n * @csspart leading-section - The leading section of the header.\n * @csspart center-section - The center section of the header.\n * @csspart trailing-section - The trailing section of the header.\n */",
541
- "customElement": true
542
- }
543
- ],
544
- "exports": [
545
- {
546
- "kind": "js",
547
- "name": "default",
548
- "declaration": {
549
- "name": "Appheader",
550
- "module": "components/appheader/appheader.component.js"
551
- }
552
- }
553
- ]
554
- },
555
494
  {
556
495
  "kind": "javascript-module",
557
496
  "path": "components/avatar/avatar.component.js",
@@ -796,6 +735,67 @@
796
735
  }
797
736
  ]
798
737
  },
738
+ {
739
+ "kind": "javascript-module",
740
+ "path": "components/appheader/appheader.component.js",
741
+ "declarations": [
742
+ {
743
+ "kind": "class",
744
+ "description": "The `mdc-appheader` component provides a structured and accessible app header layout.\nIt consists of three primary sections: leading, center, and trailing.\n\n- The **leading section** typically holds a **brand logo**, **brand name** or **menu icon**.\n- The **center section** can contain a **search bar**, **icons** or action controls.\n- The **trailing section** generally includes a **profile avatar**, **additional icons** or **action controls**.",
745
+ "name": "Appheader",
746
+ "cssParts": [
747
+ {
748
+ "description": "The main container for styling the header.",
749
+ "name": "container"
750
+ },
751
+ {
752
+ "description": "The leading section of the header.",
753
+ "name": "leading-section"
754
+ },
755
+ {
756
+ "description": "The center section of the header.",
757
+ "name": "center-section"
758
+ },
759
+ {
760
+ "description": "The trailing section of the header.",
761
+ "name": "trailing-section"
762
+ }
763
+ ],
764
+ "slots": [
765
+ {
766
+ "description": "Slot for the leading section (e.g., brand logo, brand name).",
767
+ "name": "leading"
768
+ },
769
+ {
770
+ "description": "Slot for the center section (e.g., search bar, icons).",
771
+ "name": "center"
772
+ },
773
+ {
774
+ "description": "Slot for the trailing section (e.g., profile avatar, icons).",
775
+ "name": "trailing"
776
+ }
777
+ ],
778
+ "members": [],
779
+ "superclass": {
780
+ "name": "Component",
781
+ "module": "/src/models"
782
+ },
783
+ "tagName": "mdc-appheader",
784
+ "jsDoc": "/**\n * The `mdc-appheader` component provides a structured and accessible app header layout.\n * It consists of three primary sections: leading, center, and trailing.\n *\n * - The **leading section** typically holds a **brand logo**, **brand name** or **menu icon**.\n * - The **center section** can contain a **search bar**, **icons** or action controls.\n * - The **trailing section** generally includes a **profile avatar**, **additional icons** or **action controls**.\n *\n * @tagname mdc-appheader\n *\n * @slot leading - Slot for the leading section (e.g., brand logo, brand name).\n * @slot center - Slot for the center section (e.g., search bar, icons).\n * @slot trailing - Slot for the trailing section (e.g., profile avatar, icons).\n *\n * @csspart container - The main container for styling the header.\n * @csspart leading-section - The leading section of the header.\n * @csspart center-section - The center section of the header.\n * @csspart trailing-section - The trailing section of the header.\n */",
785
+ "customElement": true
786
+ }
787
+ ],
788
+ "exports": [
789
+ {
790
+ "kind": "js",
791
+ "name": "default",
792
+ "declaration": {
793
+ "name": "Appheader",
794
+ "module": "components/appheader/appheader.component.js"
795
+ }
796
+ }
797
+ ]
798
+ },
799
799
  {
800
800
  "kind": "javascript-module",
801
801
  "path": "components/avatarbutton/avatarbutton.component.js",
@@ -12808,277 +12808,107 @@
12808
12808
  },
12809
12809
  {
12810
12810
  "kind": "javascript-module",
12811
- "path": "components/presence/presence.component.js",
12811
+ "path": "components/progressbar/progressbar.component.js",
12812
12812
  "declarations": [
12813
12813
  {
12814
12814
  "kind": "class",
12815
- "description": "The `mdc-presence` component is a versatile UI element used to\ndisplay the presence status of a user or entity within an avatar component.\n\nThis component is ideal for use within avatar UIs where the presence status\nneeds to be visually represented.",
12816
- "name": "Presence",
12815
+ "description": "mdc-progressbar component visually represents a progress indicator, typically used to show\nthe completion state of an ongoing process (e.g., loading, file upload, etc.).\nIt contains an optional label and an optional helper text.\n\n- It supports mainly two types: Default and Inline\n- It supports three validation variants: Default, Success and Error.\n\nThis component is created by extending FormfieldWrapper.",
12816
+ "name": "Progressbar",
12817
12817
  "cssProperties": [
12818
12818
  {
12819
- "description": "The background color of the presence type active.",
12820
- "name": "--mdc-presence-active-background-color"
12821
- },
12822
- {
12823
- "description": "The background color of the presence type away.",
12824
- "name": "--mdc-presence-away-background-color"
12825
- },
12826
- {
12827
- "description": "The background color of the presence type away-calling.",
12828
- "name": "--mdc-presence-away-calling-background-color"
12829
- },
12830
- {
12831
- "description": "The background color of the presence type busy.",
12832
- "name": "--mdc-presence-busy-background-color"
12833
- },
12834
- {
12835
- "description": "The background color of the presence type dnd.",
12836
- "name": "--mdc-presence-dnd-background-color"
12819
+ "description": "Background color of the progressbar when inactive.",
12820
+ "name": "--mdc-progressbar-default-background-color"
12837
12821
  },
12838
12822
  {
12839
- "description": "The background color of the presence type meeting.",
12840
- "name": "--mdc-presence-meeting-background-color"
12823
+ "description": "Background color of the progressbar when active.",
12824
+ "name": "--mdc-progressbar-default-active-background-color"
12841
12825
  },
12842
12826
  {
12843
- "description": "The background color of the presence type on-call.",
12844
- "name": "--mdc-presence-on-call-background-color"
12827
+ "description": "Background color of the progressbar when in success state.",
12828
+ "name": "--mdc-progressbar-success-background-color"
12845
12829
  },
12846
12830
  {
12847
- "description": "The background color of the presence type on-device.",
12848
- "name": "--mdc-presence-on-device-background-color"
12831
+ "description": "Background color of the progressbar when in error state.",
12832
+ "name": "--mdc-progressbar-error-background-color"
12849
12833
  },
12850
12834
  {
12851
- "description": "The background color of the presence type on-mobile.",
12852
- "name": "--mdc-presence-on-mobile-background-color"
12835
+ "description": "The height of the progressbar.",
12836
+ "name": "--mdc-progressbar-height"
12853
12837
  },
12854
12838
  {
12855
- "description": "The background color of the presence type pause.",
12856
- "name": "--mdc-presence-pause-background-color"
12839
+ "description": "The border radius of the progressbar.",
12840
+ "name": "--mdc-progressbar-border-radius"
12857
12841
  },
12858
12842
  {
12859
- "description": "The background color of the presence type pto.",
12860
- "name": "--mdc-presence-pto-background-color"
12843
+ "description": "Color of the progressbar label text.",
12844
+ "name": "--mdc-progressbar-label-color"
12861
12845
  },
12862
12846
  {
12863
- "description": "The background color of the presence type presenting.",
12864
- "name": "--mdc-presence-presenting-background-color"
12847
+ "description": "Line height of the label text.",
12848
+ "name": "--mdc-progressbar-label-lineheight"
12865
12849
  },
12866
12850
  {
12867
- "description": "The background color of the presence type quiet.",
12868
- "name": "--mdc-presence-quiet-background-color"
12851
+ "description": "Font size of the label text.",
12852
+ "name": "--mdc-progressbar-label-fontsize"
12869
12853
  },
12870
12854
  {
12871
- "description": "The background color of the presence type scheduled.",
12872
- "name": "--mdc-presence-scheduled-background-color"
12855
+ "description": "Font weight of the label text.",
12856
+ "name": "--mdc-progressbar-label-fontweight"
12873
12857
  },
12874
12858
  {
12875
- "description": "The background color of the presence type overlay.",
12876
- "name": "--mdc-presence-overlay-background-color"
12859
+ "description": "Color of the help text.",
12860
+ "name": "--mdc-progressbar-help-text-color"
12877
12861
  }
12878
12862
  ],
12879
12863
  "members": [
12880
12864
  {
12881
12865
  "kind": "field",
12882
- "name": "type",
12866
+ "name": "variant",
12883
12867
  "type": {
12884
- "text": "PresenceType"
12868
+ "text": "Variant"
12885
12869
  },
12886
- "description": "Supported presence types:\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`",
12887
- "default": "active",
12888
- "attribute": "type",
12870
+ "description": "Types of the progressbar\n- **Default**\n- **Inline**",
12871
+ "default": "default",
12872
+ "attribute": "variant",
12889
12873
  "reflects": true
12890
12874
  },
12891
12875
  {
12892
12876
  "kind": "field",
12893
- "name": "size",
12877
+ "name": "value",
12894
12878
  "type": {
12895
- "text": "PresenceSize"
12879
+ "text": "string"
12896
12880
  },
12897
- "description": "Acceptable values include:\n- XX_SMALL\n- X_SMALL\n- SMALL\n- MIDSIZE\n- LARGE\n- X_LARGE\n- XX_LARGE\n\nPresence icons are minimum 14px in size, meaning XX_Small, X_Small and Small presence\nicons will be no smaller than 14px.",
12898
- "default": "small",
12899
- "attribute": "size",
12881
+ "default": "'0'",
12882
+ "description": "The current progress as a percentage, 0 to 100.\nThe value will be clamped between 0 and 100.",
12883
+ "attribute": "value",
12900
12884
  "reflects": true
12901
12885
  },
12902
12886
  {
12903
12887
  "kind": "field",
12904
- "name": "iconSize",
12905
- "privacy": "private",
12906
- "description": "Get the size of the presence icon based on the given size type",
12907
- "readonly": true
12908
- },
12909
- {
12910
- "kind": "field",
12911
- "name": "icon",
12912
- "privacy": "private",
12913
- "description": "Get the icon name based on the presence type",
12914
- "readonly": true
12915
- },
12916
- {
12917
- "kind": "method",
12918
- "name": "handleOnLoad",
12919
- "privacy": "private",
12920
- "return": {
12921
- "type": {
12922
- "text": "void"
12923
- }
12888
+ "name": "error",
12889
+ "type": {
12890
+ "text": "boolean"
12924
12891
  },
12925
- "description": "Handles the successful load of an icon.\nSets the `currentIconType` property to match the `type` property."
12892
+ "default": "false",
12893
+ "description": "Define error state of the progressbar\n- **true**\n- **false**",
12894
+ "attribute": "error"
12926
12895
  },
12927
12896
  {
12928
12897
  "kind": "method",
12929
- "name": "handleOnError",
12898
+ "name": "getValidationVariant",
12930
12899
  "privacy": "private",
12900
+ "description": "Determines the validation state (success, error, or default) based on progress value and error state.",
12931
12901
  "return": {
12932
12902
  "type": {
12933
- "text": "void"
12903
+ "text": ""
12934
12904
  }
12935
- },
12936
- "description": "Handles an error that occurs when loading an icon."
12937
- }
12938
- ],
12939
- "attributes": [
12905
+ }
12906
+ },
12940
12907
  {
12941
- "name": "type",
12908
+ "kind": "field",
12909
+ "name": "dataAriaLabel",
12942
12910
  "type": {
12943
- "text": "PresenceType"
12944
- },
12945
- "description": "Supported presence types:\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`",
12946
- "default": "active",
12947
- "fieldName": "type"
12948
- },
12949
- {
12950
- "name": "size",
12951
- "type": {
12952
- "text": "PresenceSize"
12953
- },
12954
- "description": "Acceptable values include:\n- XX_SMALL\n- X_SMALL\n- SMALL\n- MIDSIZE\n- LARGE\n- X_LARGE\n- XX_LARGE\n\nPresence icons are minimum 14px in size, meaning XX_Small, X_Small and Small presence\nicons will be no smaller than 14px.",
12955
- "default": "small",
12956
- "fieldName": "size"
12957
- }
12958
- ],
12959
- "superclass": {
12960
- "name": "Component",
12961
- "module": "/src/models"
12962
- },
12963
- "tagName": "mdc-presence",
12964
- "jsDoc": "/**\n * The `mdc-presence` component is a versatile UI element used to\n * display the presence status of a user or entity within an avatar component.\n *\n * This component is ideal for use within avatar UIs where the presence status\n * needs to be visually represented.\n *\n * @dependency mdc-icon\n *\n * @tagname mdc-presence\n *\n * @cssproperty --mdc-presence-active-background-color - The background color of the presence type active.\n * @cssproperty --mdc-presence-away-background-color - The background color of the presence type away.\n * @cssproperty --mdc-presence-away-calling-background-color - The background color of the presence type away-calling.\n * @cssproperty --mdc-presence-busy-background-color - The background color of the presence type busy.\n * @cssproperty --mdc-presence-dnd-background-color - The background color of the presence type dnd.\n * @cssproperty --mdc-presence-meeting-background-color - The background color of the presence type meeting.\n * @cssproperty --mdc-presence-on-call-background-color - The background color of the presence type on-call.\n * @cssproperty --mdc-presence-on-device-background-color - The background color of the presence type on-device.\n * @cssproperty --mdc-presence-on-mobile-background-color - The background color of the presence type on-mobile.\n * @cssproperty --mdc-presence-pause-background-color - The background color of the presence type pause.\n * @cssproperty --mdc-presence-pto-background-color - The background color of the presence type pto.\n * @cssproperty --mdc-presence-presenting-background-color - The background color of the presence type presenting.\n * @cssproperty --mdc-presence-quiet-background-color - The background color of the presence type quiet.\n * @cssproperty --mdc-presence-scheduled-background-color - The background color of the presence type scheduled.\n * @cssproperty --mdc-presence-overlay-background-color - The background color of the presence type overlay.\n */",
12965
- "customElement": true
12966
- }
12967
- ],
12968
- "exports": [
12969
- {
12970
- "kind": "js",
12971
- "name": "default",
12972
- "declaration": {
12973
- "name": "Presence",
12974
- "module": "components/presence/presence.component.js"
12975
- }
12976
- }
12977
- ]
12978
- },
12979
- {
12980
- "kind": "javascript-module",
12981
- "path": "components/progressbar/progressbar.component.js",
12982
- "declarations": [
12983
- {
12984
- "kind": "class",
12985
- "description": "mdc-progressbar component visually represents a progress indicator, typically used to show\nthe completion state of an ongoing process (e.g., loading, file upload, etc.).\nIt contains an optional label and an optional helper text.\n\n- It supports mainly two types: Default and Inline\n- It supports three validation variants: Default, Success and Error.\n\nThis component is created by extending FormfieldWrapper.",
12986
- "name": "Progressbar",
12987
- "cssProperties": [
12988
- {
12989
- "description": "Background color of the progressbar when inactive.",
12990
- "name": "--mdc-progressbar-default-background-color"
12991
- },
12992
- {
12993
- "description": "Background color of the progressbar when active.",
12994
- "name": "--mdc-progressbar-default-active-background-color"
12995
- },
12996
- {
12997
- "description": "Background color of the progressbar when in success state.",
12998
- "name": "--mdc-progressbar-success-background-color"
12999
- },
13000
- {
13001
- "description": "Background color of the progressbar when in error state.",
13002
- "name": "--mdc-progressbar-error-background-color"
13003
- },
13004
- {
13005
- "description": "The height of the progressbar.",
13006
- "name": "--mdc-progressbar-height"
13007
- },
13008
- {
13009
- "description": "The border radius of the progressbar.",
13010
- "name": "--mdc-progressbar-border-radius"
13011
- },
13012
- {
13013
- "description": "Color of the progressbar label text.",
13014
- "name": "--mdc-progressbar-label-color"
13015
- },
13016
- {
13017
- "description": "Line height of the label text.",
13018
- "name": "--mdc-progressbar-label-lineheight"
13019
- },
13020
- {
13021
- "description": "Font size of the label text.",
13022
- "name": "--mdc-progressbar-label-fontsize"
13023
- },
13024
- {
13025
- "description": "Font weight of the label text.",
13026
- "name": "--mdc-progressbar-label-fontweight"
13027
- },
13028
- {
13029
- "description": "Color of the help text.",
13030
- "name": "--mdc-progressbar-help-text-color"
13031
- }
13032
- ],
13033
- "members": [
13034
- {
13035
- "kind": "field",
13036
- "name": "variant",
13037
- "type": {
13038
- "text": "Variant"
13039
- },
13040
- "description": "Types of the progressbar\n- **Default**\n- **Inline**",
13041
- "default": "default",
13042
- "attribute": "variant",
13043
- "reflects": true
13044
- },
13045
- {
13046
- "kind": "field",
13047
- "name": "value",
13048
- "type": {
13049
- "text": "string"
13050
- },
13051
- "default": "'0'",
13052
- "description": "The current progress as a percentage, 0 to 100.\nThe value will be clamped between 0 and 100.",
13053
- "attribute": "value",
13054
- "reflects": true
13055
- },
13056
- {
13057
- "kind": "field",
13058
- "name": "error",
13059
- "type": {
13060
- "text": "boolean"
13061
- },
13062
- "default": "false",
13063
- "description": "Define error state of the progressbar\n- **true**\n- **false**",
13064
- "attribute": "error"
13065
- },
13066
- {
13067
- "kind": "method",
13068
- "name": "getValidationVariant",
13069
- "privacy": "private",
13070
- "description": "Determines the validation state (success, error, or default) based on progress value and error state.",
13071
- "return": {
13072
- "type": {
13073
- "text": ""
13074
- }
13075
- }
13076
- },
13077
- {
13078
- "kind": "field",
13079
- "name": "dataAriaLabel",
13080
- "type": {
13081
- "text": "string | null"
12911
+ "text": "string | null"
13082
12912
  },
13083
12913
  "default": "null",
13084
12914
  "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
@@ -13961,221 +13791,189 @@
13961
13791
  },
13962
13792
  {
13963
13793
  "kind": "javascript-module",
13964
- "path": "components/radio/radio.component.js",
13794
+ "path": "components/presence/presence.component.js",
13965
13795
  "declarations": [
13966
13796
  {
13967
13797
  "kind": "class",
13968
- "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.",
13969
- "name": "Radio",
13798
+ "description": "The `mdc-presence` component is a versatile UI element used to\ndisplay the presence status of a user or entity within an avatar component.\n\nThis component is ideal for use within avatar UIs where the presence status\nneeds to be visually represented.",
13799
+ "name": "Presence",
13970
13800
  "cssProperties": [
13971
13801
  {
13972
- "description": "color of the label when disabled",
13973
- "name": "--mdc-radio-text-disabled-color"
13802
+ "description": "The background color of the presence type active.",
13803
+ "name": "--mdc-presence-active-background-color"
13974
13804
  },
13975
13805
  {
13976
- "description": "color of the radio button when inactive and hovered",
13977
- "name": "--mdc-radio-control-inactive-hover"
13806
+ "description": "The background color of the presence type away.",
13807
+ "name": "--mdc-presence-away-background-color"
13978
13808
  },
13979
13809
  {
13980
- "description": "color of the radio button when inactive and pressed",
13981
- "name": "--mdc-radio-control-inactive-pressed-color"
13810
+ "description": "The background color of the presence type away-calling.",
13811
+ "name": "--mdc-presence-away-calling-background-color"
13982
13812
  },
13983
13813
  {
13984
- "description": "color of the radio button when active and hovered",
13985
- "name": "--mdc-radio-control-active-hover-color"
13814
+ "description": "The background color of the presence type busy.",
13815
+ "name": "--mdc-presence-busy-background-color"
13986
13816
  },
13987
13817
  {
13988
- "description": "color of the radio button when active and pressed",
13989
- "name": "--mdc-radio-control-active-pressed-color"
13818
+ "description": "The background color of the presence type dnd.",
13819
+ "name": "--mdc-presence-dnd-background-color"
13990
13820
  },
13991
13821
  {
13992
- "description": "color of the radio button when disabled",
13993
- "name": "--mdc-radio-disabled-border-color"
13822
+ "description": "The background color of the presence type meeting.",
13823
+ "name": "--mdc-presence-meeting-background-color"
13994
13824
  },
13995
13825
  {
13996
- "description": "color of the radio button when active and disabled",
13997
- "name": "--mdc-radio-control-active-disabled-background"
13826
+ "description": "The background color of the presence type on-call.",
13827
+ "name": "--mdc-presence-on-call-background-color"
13998
13828
  },
13999
13829
  {
14000
- "description": "color of the radio button when inactive and disabled",
14001
- "name": "--mdc-radio-control-inactive-disabled-background"
13830
+ "description": "The background color of the presence type on-device.",
13831
+ "name": "--mdc-presence-on-device-background-color"
13832
+ },
13833
+ {
13834
+ "description": "The background color of the presence type on-mobile.",
13835
+ "name": "--mdc-presence-on-mobile-background-color"
13836
+ },
13837
+ {
13838
+ "description": "The background color of the presence type pause.",
13839
+ "name": "--mdc-presence-pause-background-color"
13840
+ },
13841
+ {
13842
+ "description": "The background color of the presence type pto.",
13843
+ "name": "--mdc-presence-pto-background-color"
13844
+ },
13845
+ {
13846
+ "description": "The background color of the presence type presenting.",
13847
+ "name": "--mdc-presence-presenting-background-color"
13848
+ },
13849
+ {
13850
+ "description": "The background color of the presence type quiet.",
13851
+ "name": "--mdc-presence-quiet-background-color"
13852
+ },
13853
+ {
13854
+ "description": "The background color of the presence type scheduled.",
13855
+ "name": "--mdc-presence-scheduled-background-color"
13856
+ },
13857
+ {
13858
+ "description": "The background color of the presence type overlay.",
13859
+ "name": "--mdc-presence-overlay-background-color"
14002
13860
  }
14003
13861
  ],
14004
13862
  "members": [
14005
13863
  {
14006
13864
  "kind": "field",
14007
- "name": "checked",
13865
+ "name": "type",
14008
13866
  "type": {
14009
- "text": "boolean"
13867
+ "text": "PresenceType"
14010
13868
  },
14011
- "default": "false",
14012
- "description": "Determines whether the radio is selected or unselected.",
14013
- "attribute": "checked",
13869
+ "description": "Supported presence types:\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`",
13870
+ "default": "active",
13871
+ "attribute": "type",
14014
13872
  "reflects": true
14015
13873
  },
14016
13874
  {
14017
13875
  "kind": "field",
14018
- "name": "readonly",
13876
+ "name": "size",
14019
13877
  "type": {
14020
- "text": "boolean"
13878
+ "text": "PresenceSize"
14021
13879
  },
14022
- "default": "false",
14023
- "description": "Determines whether the radio is read-only.",
14024
- "attribute": "readonly",
13880
+ "description": "Acceptable values include:\n- XX_SMALL\n- X_SMALL\n- SMALL\n- MIDSIZE\n- LARGE\n- X_LARGE\n- XX_LARGE\n\nPresence icons are minimum 14px in size, meaning XX_Small, X_Small and Small presence\nicons will be no smaller than 14px.",
13881
+ "default": "small",
13882
+ "attribute": "size",
14025
13883
  "reflects": true
14026
13884
  },
14027
13885
  {
14028
13886
  "kind": "field",
14029
- "name": "autofocus",
14030
- "type": {
14031
- "text": "boolean"
14032
- },
14033
- "default": "false",
14034
- "description": "Automatically focus on the element when the page loads.\n[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/autofocus)",
14035
- "attribute": "autofocus",
14036
- "reflects": true
13887
+ "name": "iconSize",
13888
+ "privacy": "private",
13889
+ "description": "Get the size of the presence icon based on the given size type",
13890
+ "readonly": true
13891
+ },
13892
+ {
13893
+ "kind": "field",
13894
+ "name": "icon",
13895
+ "privacy": "private",
13896
+ "description": "Get the icon name based on the presence type",
13897
+ "readonly": true
14037
13898
  },
14038
13899
  {
14039
13900
  "kind": "method",
14040
- "name": "getAllRadiosWithinSameGroup",
13901
+ "name": "handleOnLoad",
14041
13902
  "privacy": "private",
14042
13903
  "return": {
14043
13904
  "type": {
14044
- "text": "Radio[]"
13905
+ "text": "void"
14045
13906
  }
14046
13907
  },
14047
- "description": "Returns all radios within the same group (name)."
13908
+ "description": "Handles the successful load of an icon.\nSets the `currentIconType` property to match the `type` property."
14048
13909
  },
14049
13910
  {
14050
13911
  "kind": "method",
14051
- "name": "dispatchChangeEvent",
13912
+ "name": "handleOnError",
14052
13913
  "privacy": "private",
14053
13914
  "return": {
14054
13915
  "type": {
14055
13916
  "text": "void"
14056
13917
  }
14057
13918
  },
14058
- "parameters": [
14059
- {
14060
- "name": "event",
14061
- "type": {
14062
- "text": "Event"
14063
- }
14064
- }
14065
- ],
14066
- "description": "The 'change' event does not bubble up through the shadow DOM as it was not composed.\nTherefore, we need to re-dispatch the same event to ensure it is propagated correctly.\nRead more: https://developer.mozilla.org/en-US/docs/Web/API/Event/composed"
14067
- },
14068
- {
14069
- "kind": "method",
14070
- "name": "setGroupValidity",
14071
- "privacy": "private",
14072
- "parameters": [
14073
- {
14074
- "name": "radios",
14075
- "type": {
14076
- "text": "Radio[]"
14077
- },
14078
- "description": "Array of radios of the same group"
14079
- },
14080
- {
14081
- "name": "isValid",
14082
- "type": {
14083
- "text": "boolean"
14084
- },
14085
- "description": "Boolean value to set the validity of the group"
14086
- }
14087
- ],
14088
- "description": "Sets the validity of the group of radios."
14089
- },
14090
- {
14091
- "kind": "method",
14092
- "name": "setActualFormValue",
14093
- "privacy": "private",
14094
- "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."
14095
- },
14096
- {
14097
- "kind": "method",
14098
- "name": "handleChange",
14099
- "privacy": "private",
14100
- "return": {
14101
- "type": {
14102
- "text": "void"
14103
- }
14104
- },
14105
- "parameters": [
14106
- {
14107
- "name": "event",
14108
- "type": {
14109
- "text": "Event"
14110
- }
14111
- }
14112
- ],
14113
- "description": "Handles the change event on the radio element.\nThis will toggle the state of the radio element.\nDispatches the change event."
14114
- },
14115
- {
14116
- "kind": "method",
14117
- "name": "updateRadio",
14118
- "privacy": "private",
14119
- "parameters": [
14120
- {
14121
- "name": "enabledRadios",
14122
- "type": {
14123
- "text": "Radio[]"
14124
- },
14125
- "description": "An array of enabled radio buttons within the same group."
14126
- },
14127
- {
14128
- "name": "index",
14129
- "type": {
14130
- "text": "number"
14131
- },
14132
- "description": "The index of the radio button to be updated within the enabled radios array."
14133
- },
14134
- {
14135
- "name": "event",
14136
- "type": {
14137
- "text": "Event"
14138
- },
14139
- "description": "The event that triggered the update."
14140
- }
14141
- ],
14142
- "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."
14143
- },
13919
+ "description": "Handles an error that occurs when loading an icon."
13920
+ }
13921
+ ],
13922
+ "attributes": [
14144
13923
  {
14145
- "kind": "method",
14146
- "name": "handleKeyDown",
14147
- "privacy": "private",
14148
- "return": {
14149
- "type": {
14150
- "text": "void"
14151
- }
13924
+ "name": "type",
13925
+ "type": {
13926
+ "text": "PresenceType"
14152
13927
  },
14153
- "parameters": [
14154
- {
14155
- "name": "event",
14156
- "type": {
14157
- "text": "KeyboardEvent"
14158
- }
14159
- }
14160
- ],
14161
- "description": "Handles the keydown event (Arrow Up/Down/Left/Right) on the radio element."
13928
+ "description": "Supported presence types:\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`",
13929
+ "default": "active",
13930
+ "fieldName": "type"
14162
13931
  },
14163
13932
  {
14164
- "kind": "method",
14165
- "name": "updateTabIndex",
14166
- "privacy": "private",
14167
- "return": {
14168
- "type": {
14169
- "text": "void"
14170
- }
13933
+ "name": "size",
13934
+ "type": {
13935
+ "text": "PresenceSize"
14171
13936
  },
14172
- "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"
14173
- },
13937
+ "description": "Acceptable values include:\n- XX_SMALL\n- X_SMALL\n- SMALL\n- MIDSIZE\n- LARGE\n- X_LARGE\n- XX_LARGE\n\nPresence icons are minimum 14px in size, meaning XX_Small, X_Small and Small presence\nicons will be no smaller than 14px.",
13938
+ "default": "small",
13939
+ "fieldName": "size"
13940
+ }
13941
+ ],
13942
+ "superclass": {
13943
+ "name": "Component",
13944
+ "module": "/src/models"
13945
+ },
13946
+ "tagName": "mdc-presence",
13947
+ "jsDoc": "/**\n * The `mdc-presence` component is a versatile UI element used to\n * display the presence status of a user or entity within an avatar component.\n *\n * This component is ideal for use within avatar UIs where the presence status\n * needs to be visually represented.\n *\n * @dependency mdc-icon\n *\n * @tagname mdc-presence\n *\n * @cssproperty --mdc-presence-active-background-color - The background color of the presence type active.\n * @cssproperty --mdc-presence-away-background-color - The background color of the presence type away.\n * @cssproperty --mdc-presence-away-calling-background-color - The background color of the presence type away-calling.\n * @cssproperty --mdc-presence-busy-background-color - The background color of the presence type busy.\n * @cssproperty --mdc-presence-dnd-background-color - The background color of the presence type dnd.\n * @cssproperty --mdc-presence-meeting-background-color - The background color of the presence type meeting.\n * @cssproperty --mdc-presence-on-call-background-color - The background color of the presence type on-call.\n * @cssproperty --mdc-presence-on-device-background-color - The background color of the presence type on-device.\n * @cssproperty --mdc-presence-on-mobile-background-color - The background color of the presence type on-mobile.\n * @cssproperty --mdc-presence-pause-background-color - The background color of the presence type pause.\n * @cssproperty --mdc-presence-pto-background-color - The background color of the presence type pto.\n * @cssproperty --mdc-presence-presenting-background-color - The background color of the presence type presenting.\n * @cssproperty --mdc-presence-quiet-background-color - The background color of the presence type quiet.\n * @cssproperty --mdc-presence-scheduled-background-color - The background color of the presence type scheduled.\n * @cssproperty --mdc-presence-overlay-background-color - The background color of the presence type overlay.\n */",
13948
+ "customElement": true
13949
+ }
13950
+ ],
13951
+ "exports": [
13952
+ {
13953
+ "kind": "js",
13954
+ "name": "default",
13955
+ "declaration": {
13956
+ "name": "Presence",
13957
+ "module": "components/presence/presence.component.js"
13958
+ }
13959
+ }
13960
+ ]
13961
+ },
13962
+ {
13963
+ "kind": "javascript-module",
13964
+ "path": "components/radiogroup/radiogroup.component.js",
13965
+ "declarations": [
13966
+ {
13967
+ "kind": "class",
13968
+ "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.",
13969
+ "name": "RadioGroup",
13970
+ "cssProperties": [
14174
13971
  {
14175
- "kind": "field",
14176
- "name": "renderLabelAndHelperText",
14177
- "privacy": "private"
14178
- },
13972
+ "description": "color of the description text",
13973
+ "name": "--mdc-radiogroup-description-text-normal"
13974
+ }
13975
+ ],
13976
+ "members": [
14179
13977
  {
14180
13978
  "kind": "field",
14181
13979
  "name": "name",
@@ -14183,98 +13981,8 @@
14183
13981
  "text": "string"
14184
13982
  },
14185
13983
  "default": "''",
14186
- "description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
14187
- "attribute": "name",
14188
- "reflects": true,
14189
- "inheritedFrom": {
14190
- "name": "FormInternalsMixin",
14191
- "module": "utils/mixins/FormInternalsMixin.js"
14192
- }
14193
- },
14194
- {
14195
- "kind": "field",
14196
- "name": "value",
14197
- "type": {
14198
- "text": "string"
14199
- },
14200
- "default": "''",
14201
- "description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
14202
- "attribute": "value",
14203
- "reflects": true,
14204
- "inheritedFrom": {
14205
- "name": "FormInternalsMixin",
14206
- "module": "utils/mixins/FormInternalsMixin.js"
14207
- }
14208
- },
14209
- {
14210
- "kind": "field",
14211
- "name": "validationMessage",
14212
- "type": {
14213
- "text": "string | undefined"
14214
- },
14215
- "description": "Custom validation message that will override the default message and displayed when the input is invalid.",
14216
- "attribute": "validation-message",
14217
- "reflects": true,
14218
- "inheritedFrom": {
14219
- "name": "FormInternalsMixin",
14220
- "module": "utils/mixins/FormInternalsMixin.js"
14221
- }
14222
- },
14223
- {
14224
- "kind": "field",
14225
- "name": "validity",
14226
- "type": {
14227
- "text": "ValidityState"
14228
- },
14229
- "readonly": true,
14230
- "inheritedFrom": {
14231
- "name": "FormInternalsMixin",
14232
- "module": "utils/mixins/FormInternalsMixin.js"
14233
- }
14234
- },
14235
- {
14236
- "kind": "field",
14237
- "name": "willValidate",
14238
- "readonly": true,
14239
- "inheritedFrom": {
14240
- "name": "FormInternalsMixin",
14241
- "module": "utils/mixins/FormInternalsMixin.js"
14242
- }
14243
- },
14244
- {
14245
- "kind": "method",
14246
- "name": "setValidity",
14247
- "description": "Sets the validity of the input field based on the input field's validity.",
14248
- "return": {
14249
- "type": {
14250
- "text": ""
14251
- }
14252
- },
14253
- "inheritedFrom": {
14254
- "name": "FormInternalsMixin",
14255
- "module": "utils/mixins/FormInternalsMixin.js"
14256
- }
14257
- },
14258
- {
14259
- "kind": "method",
14260
- "name": "checkValidity",
14261
- "return": {
14262
- "type": {
14263
- "text": "boolean"
14264
- }
14265
- },
14266
- "inheritedFrom": {
14267
- "name": "FormInternalsMixin",
14268
- "module": "utils/mixins/FormInternalsMixin.js"
14269
- }
14270
- },
14271
- {
14272
- "kind": "method",
14273
- "name": "reportValidity",
14274
- "inheritedFrom": {
14275
- "name": "FormInternalsMixin",
14276
- "module": "utils/mixins/FormInternalsMixin.js"
14277
- }
13984
+ "description": "Name of the radio group.\nThey are used to group elements in a form together.",
13985
+ "attribute": "name"
14278
13986
  },
14279
13987
  {
14280
13988
  "kind": "field",
@@ -14461,241 +14169,458 @@
14461
14169
  }
14462
14170
  }
14463
14171
  ],
14464
- "events": [
14172
+ "attributes": [
14465
14173
  {
14174
+ "name": "name",
14466
14175
  "type": {
14467
- "text": "EventConstructor"
14176
+ "text": "string"
14177
+ },
14178
+ "default": "''",
14179
+ "description": "Name of the radio group.\nThey are used to group elements in a form together.",
14180
+ "fieldName": "name"
14181
+ },
14182
+ {
14183
+ "name": "data-aria-label",
14184
+ "type": {
14185
+ "text": "string | null"
14186
+ },
14187
+ "default": "null",
14188
+ "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
14189
+ "fieldName": "dataAriaLabel",
14190
+ "inheritedFrom": {
14191
+ "name": "DataAriaLabelMixin",
14192
+ "module": "src/utils/mixins/DataAriaLabelMixin.ts"
14468
14193
  }
14469
14194
  },
14470
14195
  {
14471
- "description": "(React: onChange) Event that gets dispatched when the radio state changes.",
14472
- "name": "change",
14473
- "reactName": "onChange"
14196
+ "name": "disabled",
14197
+ "type": {
14198
+ "text": "boolean | undefined"
14199
+ },
14200
+ "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
14201
+ "default": "undefined",
14202
+ "fieldName": "disabled",
14203
+ "inheritedFrom": {
14204
+ "name": "FormfieldWrapper",
14205
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
14206
+ }
14474
14207
  },
14475
14208
  {
14476
- "description": "(React: onFocus) Event that gets dispatched when the radio receives focus.",
14477
- "name": "focus",
14478
- "reactName": "onFocus"
14209
+ "name": "label",
14210
+ "type": {
14211
+ "text": "string | undefined"
14212
+ },
14213
+ "description": "The label of the input field. It is linked to the input field using the `for` attribute.",
14214
+ "fieldName": "label",
14215
+ "inheritedFrom": {
14216
+ "name": "FormfieldWrapper",
14217
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
14218
+ }
14219
+ },
14220
+ {
14221
+ "name": "required-label",
14222
+ "type": {
14223
+ "text": "string | undefined"
14224
+ },
14225
+ "description": "The required label of the input field.\nWhen an appropriate string value is set,\nthe input field is marked as required and the label is appended with this text.",
14226
+ "fieldName": "requiredLabel",
14227
+ "inheritedFrom": {
14228
+ "name": "FormfieldWrapper",
14229
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
14230
+ }
14231
+ },
14232
+ {
14233
+ "name": "id",
14234
+ "type": {
14235
+ "text": "string"
14236
+ },
14237
+ "default": "''",
14238
+ "description": "The unique id of the input field. It is used to link the input field with the label.",
14239
+ "fieldName": "id",
14240
+ "inheritedFrom": {
14241
+ "name": "FormfieldWrapper",
14242
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
14243
+ }
14244
+ },
14245
+ {
14246
+ "name": "help-text-type",
14247
+ "type": {
14248
+ "text": "ValidationType"
14249
+ },
14250
+ "description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
14251
+ "fieldName": "helpTextType",
14252
+ "inheritedFrom": {
14253
+ "name": "FormfieldWrapper",
14254
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
14255
+ }
14256
+ },
14257
+ {
14258
+ "name": "help-text",
14259
+ "type": {
14260
+ "text": "string | undefined"
14261
+ },
14262
+ "description": "The help text that is displayed below the input field.",
14263
+ "fieldName": "helpText",
14264
+ "inheritedFrom": {
14265
+ "name": "FormfieldWrapper",
14266
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
14267
+ }
14479
14268
  }
14480
14269
  ],
14481
- "attributes": [
14270
+ "superclass": {
14271
+ "name": "FormfieldGroup",
14272
+ "module": "/src/components/formfieldgroup"
14273
+ },
14274
+ "tagName": "mdc-radiogroup",
14275
+ "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 */",
14276
+ "customElement": true,
14277
+ "slots": [
14482
14278
  {
14279
+ "description": "This is a default slot for checkbox or toggle components.",
14280
+ "name": "default",
14281
+ "inheritedFrom": {
14282
+ "name": "FormfieldGroup",
14283
+ "module": "src/components/formfieldgroup/formfieldgroup.component.ts"
14284
+ }
14285
+ },
14286
+ {
14287
+ "description": "slot to add the label info icon",
14288
+ "name": "label-info",
14289
+ "inheritedFrom": {
14290
+ "name": "FormfieldWrapper",
14291
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
14292
+ }
14293
+ }
14294
+ ]
14295
+ }
14296
+ ],
14297
+ "exports": [
14298
+ {
14299
+ "kind": "js",
14300
+ "name": "default",
14301
+ "declaration": {
14302
+ "name": "RadioGroup",
14303
+ "module": "components/radiogroup/radiogroup.component.js"
14304
+ }
14305
+ }
14306
+ ]
14307
+ },
14308
+ {
14309
+ "kind": "javascript-module",
14310
+ "path": "components/radio/radio.component.js",
14311
+ "declarations": [
14312
+ {
14313
+ "kind": "class",
14314
+ "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.",
14315
+ "name": "Radio",
14316
+ "cssProperties": [
14317
+ {
14318
+ "description": "color of the label when disabled",
14319
+ "name": "--mdc-radio-text-disabled-color"
14320
+ },
14321
+ {
14322
+ "description": "color of the radio button when inactive and hovered",
14323
+ "name": "--mdc-radio-control-inactive-hover"
14324
+ },
14325
+ {
14326
+ "description": "color of the radio button when inactive and pressed",
14327
+ "name": "--mdc-radio-control-inactive-pressed-color"
14328
+ },
14329
+ {
14330
+ "description": "color of the radio button when active and hovered",
14331
+ "name": "--mdc-radio-control-active-hover-color"
14332
+ },
14333
+ {
14334
+ "description": "color of the radio button when active and pressed",
14335
+ "name": "--mdc-radio-control-active-pressed-color"
14336
+ },
14337
+ {
14338
+ "description": "color of the radio button when disabled",
14339
+ "name": "--mdc-radio-disabled-border-color"
14340
+ },
14341
+ {
14342
+ "description": "color of the radio button when active and disabled",
14343
+ "name": "--mdc-radio-control-active-disabled-background"
14344
+ },
14345
+ {
14346
+ "description": "color of the radio button when inactive and disabled",
14347
+ "name": "--mdc-radio-control-inactive-disabled-background"
14348
+ }
14349
+ ],
14350
+ "members": [
14351
+ {
14352
+ "kind": "field",
14483
14353
  "name": "checked",
14484
14354
  "type": {
14485
14355
  "text": "boolean"
14486
14356
  },
14487
14357
  "default": "false",
14488
14358
  "description": "Determines whether the radio is selected or unselected.",
14489
- "fieldName": "checked"
14359
+ "attribute": "checked",
14360
+ "reflects": true
14490
14361
  },
14491
14362
  {
14363
+ "kind": "field",
14492
14364
  "name": "readonly",
14493
14365
  "type": {
14494
14366
  "text": "boolean"
14495
14367
  },
14496
14368
  "default": "false",
14497
14369
  "description": "Determines whether the radio is read-only.",
14498
- "fieldName": "readonly"
14370
+ "attribute": "readonly",
14371
+ "reflects": true
14499
14372
  },
14500
14373
  {
14374
+ "kind": "field",
14501
14375
  "name": "autofocus",
14502
14376
  "type": {
14503
14377
  "text": "boolean"
14504
14378
  },
14505
14379
  "default": "false",
14506
14380
  "description": "Automatically focus on the element when the page loads.\n[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/autofocus)",
14507
- "fieldName": "autofocus"
14381
+ "attribute": "autofocus",
14382
+ "reflects": true
14508
14383
  },
14509
14384
  {
14510
- "name": "name",
14511
- "type": {
14512
- "text": "string"
14385
+ "kind": "method",
14386
+ "name": "getAllRadiosWithinSameGroup",
14387
+ "privacy": "private",
14388
+ "return": {
14389
+ "type": {
14390
+ "text": "Radio[]"
14391
+ }
14513
14392
  },
14514
- "default": "''",
14515
- "description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
14516
- "fieldName": "name",
14517
- "inheritedFrom": {
14518
- "name": "FormInternalsMixin",
14519
- "module": "src/utils/mixins/FormInternalsMixin.ts"
14520
- }
14393
+ "description": "Returns all radios within the same group (name)."
14521
14394
  },
14522
14395
  {
14523
- "name": "value",
14524
- "type": {
14525
- "text": "string"
14396
+ "kind": "method",
14397
+ "name": "dispatchChangeEvent",
14398
+ "privacy": "private",
14399
+ "return": {
14400
+ "type": {
14401
+ "text": "void"
14402
+ }
14526
14403
  },
14527
- "default": "''",
14528
- "description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
14529
- "fieldName": "value",
14530
- "inheritedFrom": {
14531
- "name": "FormInternalsMixin",
14532
- "module": "src/utils/mixins/FormInternalsMixin.ts"
14533
- }
14404
+ "parameters": [
14405
+ {
14406
+ "name": "event",
14407
+ "type": {
14408
+ "text": "Event"
14409
+ }
14410
+ }
14411
+ ],
14412
+ "description": "The 'change' event does not bubble up through the shadow DOM as it was not composed.\nTherefore, we need to re-dispatch the same event to ensure it is propagated correctly.\nRead more: https://developer.mozilla.org/en-US/docs/Web/API/Event/composed"
14534
14413
  },
14535
14414
  {
14536
- "name": "validation-message",
14537
- "type": {
14538
- "text": "string | undefined"
14415
+ "kind": "method",
14416
+ "name": "setGroupValidity",
14417
+ "privacy": "private",
14418
+ "parameters": [
14419
+ {
14420
+ "name": "radios",
14421
+ "type": {
14422
+ "text": "Radio[]"
14423
+ },
14424
+ "description": "Array of radios of the same group"
14425
+ },
14426
+ {
14427
+ "name": "isValid",
14428
+ "type": {
14429
+ "text": "boolean"
14430
+ },
14431
+ "description": "Boolean value to set the validity of the group"
14432
+ }
14433
+ ],
14434
+ "description": "Sets the validity of the group of radios."
14435
+ },
14436
+ {
14437
+ "kind": "method",
14438
+ "name": "setActualFormValue",
14439
+ "privacy": "private",
14440
+ "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."
14441
+ },
14442
+ {
14443
+ "kind": "method",
14444
+ "name": "handleChange",
14445
+ "privacy": "private",
14446
+ "return": {
14447
+ "type": {
14448
+ "text": "void"
14449
+ }
14539
14450
  },
14540
- "description": "Custom validation message that will override the default message and displayed when the input is invalid.",
14541
- "fieldName": "validationMessage",
14542
- "inheritedFrom": {
14543
- "name": "FormInternalsMixin",
14544
- "module": "src/utils/mixins/FormInternalsMixin.ts"
14545
- }
14451
+ "parameters": [
14452
+ {
14453
+ "name": "event",
14454
+ "type": {
14455
+ "text": "Event"
14456
+ }
14457
+ }
14458
+ ],
14459
+ "description": "Handles the change event on the radio element.\nThis will toggle the state of the radio element.\nDispatches the change event."
14546
14460
  },
14547
14461
  {
14548
- "name": "data-aria-label",
14462
+ "kind": "method",
14463
+ "name": "updateRadio",
14464
+ "privacy": "private",
14465
+ "parameters": [
14466
+ {
14467
+ "name": "enabledRadios",
14468
+ "type": {
14469
+ "text": "Radio[]"
14470
+ },
14471
+ "description": "An array of enabled radio buttons within the same group."
14472
+ },
14473
+ {
14474
+ "name": "index",
14475
+ "type": {
14476
+ "text": "number"
14477
+ },
14478
+ "description": "The index of the radio button to be updated within the enabled radios array."
14479
+ },
14480
+ {
14481
+ "name": "event",
14482
+ "type": {
14483
+ "text": "Event"
14484
+ },
14485
+ "description": "The event that triggered the update."
14486
+ }
14487
+ ],
14488
+ "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."
14489
+ },
14490
+ {
14491
+ "kind": "method",
14492
+ "name": "handleKeyDown",
14493
+ "privacy": "private",
14494
+ "return": {
14495
+ "type": {
14496
+ "text": "void"
14497
+ }
14498
+ },
14499
+ "parameters": [
14500
+ {
14501
+ "name": "event",
14502
+ "type": {
14503
+ "text": "KeyboardEvent"
14504
+ }
14505
+ }
14506
+ ],
14507
+ "description": "Handles the keydown event (Arrow Up/Down/Left/Right) on the radio element."
14508
+ },
14509
+ {
14510
+ "kind": "method",
14511
+ "name": "updateTabIndex",
14512
+ "privacy": "private",
14513
+ "return": {
14514
+ "type": {
14515
+ "text": "void"
14516
+ }
14517
+ },
14518
+ "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"
14519
+ },
14520
+ {
14521
+ "kind": "field",
14522
+ "name": "renderLabelAndHelperText",
14523
+ "privacy": "private"
14524
+ },
14525
+ {
14526
+ "kind": "field",
14527
+ "name": "name",
14549
14528
  "type": {
14550
- "text": "string | null"
14529
+ "text": "string"
14551
14530
  },
14552
- "default": "null",
14553
- "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
14554
- "fieldName": "dataAriaLabel",
14531
+ "default": "''",
14532
+ "description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
14533
+ "attribute": "name",
14534
+ "reflects": true,
14555
14535
  "inheritedFrom": {
14556
- "name": "DataAriaLabelMixin",
14557
- "module": "src/utils/mixins/DataAriaLabelMixin.ts"
14536
+ "name": "FormInternalsMixin",
14537
+ "module": "utils/mixins/FormInternalsMixin.js"
14558
14538
  }
14559
14539
  },
14560
14540
  {
14561
- "name": "disabled",
14541
+ "kind": "field",
14542
+ "name": "value",
14562
14543
  "type": {
14563
- "text": "boolean | undefined"
14544
+ "text": "string"
14564
14545
  },
14565
- "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
14566
- "default": "undefined",
14567
- "fieldName": "disabled",
14546
+ "default": "''",
14547
+ "description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
14548
+ "attribute": "value",
14549
+ "reflects": true,
14568
14550
  "inheritedFrom": {
14569
- "name": "FormfieldWrapper",
14570
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
14551
+ "name": "FormInternalsMixin",
14552
+ "module": "utils/mixins/FormInternalsMixin.js"
14571
14553
  }
14572
14554
  },
14573
14555
  {
14574
- "name": "label",
14556
+ "kind": "field",
14557
+ "name": "validationMessage",
14575
14558
  "type": {
14576
14559
  "text": "string | undefined"
14577
14560
  },
14578
- "description": "The label of the input field. It is linked to the input field using the `for` attribute.",
14579
- "fieldName": "label",
14561
+ "description": "Custom validation message that will override the default message and displayed when the input is invalid.",
14562
+ "attribute": "validation-message",
14563
+ "reflects": true,
14580
14564
  "inheritedFrom": {
14581
- "name": "FormfieldWrapper",
14582
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
14565
+ "name": "FormInternalsMixin",
14566
+ "module": "utils/mixins/FormInternalsMixin.js"
14583
14567
  }
14584
14568
  },
14585
14569
  {
14586
- "name": "required-label",
14570
+ "kind": "field",
14571
+ "name": "validity",
14587
14572
  "type": {
14588
- "text": "string | undefined"
14573
+ "text": "ValidityState"
14589
14574
  },
14590
- "description": "The required label of the input field.\nWhen an appropriate string value is set,\nthe input field is marked as required and the label is appended with this text.",
14591
- "fieldName": "requiredLabel",
14575
+ "readonly": true,
14592
14576
  "inheritedFrom": {
14593
- "name": "FormfieldWrapper",
14594
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
14577
+ "name": "FormInternalsMixin",
14578
+ "module": "utils/mixins/FormInternalsMixin.js"
14595
14579
  }
14596
14580
  },
14597
14581
  {
14598
- "name": "id",
14599
- "type": {
14600
- "text": "string"
14601
- },
14602
- "default": "''",
14603
- "description": "The unique id of the input field. It is used to link the input field with the label.",
14604
- "fieldName": "id",
14582
+ "kind": "field",
14583
+ "name": "willValidate",
14584
+ "readonly": true,
14605
14585
  "inheritedFrom": {
14606
- "name": "FormfieldWrapper",
14607
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
14586
+ "name": "FormInternalsMixin",
14587
+ "module": "utils/mixins/FormInternalsMixin.js"
14608
14588
  }
14609
14589
  },
14610
14590
  {
14611
- "name": "help-text-type",
14612
- "type": {
14613
- "text": "ValidationType"
14591
+ "kind": "method",
14592
+ "name": "setValidity",
14593
+ "description": "Sets the validity of the input field based on the input field's validity.",
14594
+ "return": {
14595
+ "type": {
14596
+ "text": ""
14597
+ }
14614
14598
  },
14615
- "description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
14616
- "fieldName": "helpTextType",
14617
14599
  "inheritedFrom": {
14618
- "name": "FormfieldWrapper",
14619
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
14600
+ "name": "FormInternalsMixin",
14601
+ "module": "utils/mixins/FormInternalsMixin.js"
14620
14602
  }
14621
14603
  },
14622
14604
  {
14623
- "name": "help-text",
14624
- "type": {
14625
- "text": "string | undefined"
14605
+ "kind": "method",
14606
+ "name": "checkValidity",
14607
+ "return": {
14608
+ "type": {
14609
+ "text": "boolean"
14610
+ }
14626
14611
  },
14627
- "description": "The help text that is displayed below the input field.",
14628
- "fieldName": "helpText",
14629
14612
  "inheritedFrom": {
14630
- "name": "FormfieldWrapper",
14631
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
14613
+ "name": "FormInternalsMixin",
14614
+ "module": "utils/mixins/FormInternalsMixin.js"
14632
14615
  }
14633
- }
14634
- ],
14635
- "mixins": [
14636
- {
14637
- "name": "FormInternalsMixin",
14638
- "module": "/src/utils/mixins/FormInternalsMixin"
14639
14616
  },
14640
14617
  {
14641
- "name": "DataAriaLabelMixin",
14642
- "module": "/src/utils/mixins/DataAriaLabelMixin"
14643
- }
14644
- ],
14645
- "superclass": {
14646
- "name": "FormfieldWrapper",
14647
- "module": "/src/components/formfieldwrapper/formfieldwrapper.component"
14648
- },
14649
- "tagName": "mdc-radio",
14650
- "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 * @dependency mdc-formfieldwrapper\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 */",
14651
- "customElement": true,
14652
- "slots": [
14653
- {
14654
- "description": "slot to add the label info icon",
14655
- "name": "label-info",
14618
+ "kind": "method",
14619
+ "name": "reportValidity",
14656
14620
  "inheritedFrom": {
14657
- "name": "FormfieldWrapper",
14658
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
14621
+ "name": "FormInternalsMixin",
14622
+ "module": "utils/mixins/FormInternalsMixin.js"
14659
14623
  }
14660
- }
14661
- ]
14662
- }
14663
- ],
14664
- "exports": [
14665
- {
14666
- "kind": "js",
14667
- "name": "default",
14668
- "declaration": {
14669
- "name": "Radio",
14670
- "module": "components/radio/radio.component.js"
14671
- }
14672
- }
14673
- ]
14674
- },
14675
- {
14676
- "kind": "javascript-module",
14677
- "path": "components/radiogroup/radiogroup.component.js",
14678
- "declarations": [
14679
- {
14680
- "kind": "class",
14681
- "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.",
14682
- "name": "RadioGroup",
14683
- "cssProperties": [
14684
- {
14685
- "description": "color of the description text",
14686
- "name": "--mdc-radiogroup-description-text-normal"
14687
- }
14688
- ],
14689
- "members": [
14690
- {
14691
- "kind": "field",
14692
- "name": "name",
14693
- "type": {
14694
- "text": "string"
14695
- },
14696
- "default": "''",
14697
- "description": "Name of the radio group.\nThey are used to group elements in a form together.",
14698
- "attribute": "name"
14699
14624
  },
14700
14625
  {
14701
14626
  "kind": "field",
@@ -14882,15 +14807,88 @@
14882
14807
  }
14883
14808
  }
14884
14809
  ],
14810
+ "events": [
14811
+ {
14812
+ "type": {
14813
+ "text": "EventConstructor"
14814
+ }
14815
+ },
14816
+ {
14817
+ "description": "(React: onChange) Event that gets dispatched when the radio state changes.",
14818
+ "name": "change",
14819
+ "reactName": "onChange"
14820
+ },
14821
+ {
14822
+ "description": "(React: onFocus) Event that gets dispatched when the radio receives focus.",
14823
+ "name": "focus",
14824
+ "reactName": "onFocus"
14825
+ }
14826
+ ],
14885
14827
  "attributes": [
14828
+ {
14829
+ "name": "checked",
14830
+ "type": {
14831
+ "text": "boolean"
14832
+ },
14833
+ "default": "false",
14834
+ "description": "Determines whether the radio is selected or unselected.",
14835
+ "fieldName": "checked"
14836
+ },
14837
+ {
14838
+ "name": "readonly",
14839
+ "type": {
14840
+ "text": "boolean"
14841
+ },
14842
+ "default": "false",
14843
+ "description": "Determines whether the radio is read-only.",
14844
+ "fieldName": "readonly"
14845
+ },
14846
+ {
14847
+ "name": "autofocus",
14848
+ "type": {
14849
+ "text": "boolean"
14850
+ },
14851
+ "default": "false",
14852
+ "description": "Automatically focus on the element when the page loads.\n[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/autofocus)",
14853
+ "fieldName": "autofocus"
14854
+ },
14886
14855
  {
14887
14856
  "name": "name",
14888
14857
  "type": {
14889
14858
  "text": "string"
14890
14859
  },
14891
14860
  "default": "''",
14892
- "description": "Name of the radio group.\nThey are used to group elements in a form together.",
14893
- "fieldName": "name"
14861
+ "description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
14862
+ "fieldName": "name",
14863
+ "inheritedFrom": {
14864
+ "name": "FormInternalsMixin",
14865
+ "module": "src/utils/mixins/FormInternalsMixin.ts"
14866
+ }
14867
+ },
14868
+ {
14869
+ "name": "value",
14870
+ "type": {
14871
+ "text": "string"
14872
+ },
14873
+ "default": "''",
14874
+ "description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
14875
+ "fieldName": "value",
14876
+ "inheritedFrom": {
14877
+ "name": "FormInternalsMixin",
14878
+ "module": "src/utils/mixins/FormInternalsMixin.ts"
14879
+ }
14880
+ },
14881
+ {
14882
+ "name": "validation-message",
14883
+ "type": {
14884
+ "text": "string | undefined"
14885
+ },
14886
+ "description": "Custom validation message that will override the default message and displayed when the input is invalid.",
14887
+ "fieldName": "validationMessage",
14888
+ "inheritedFrom": {
14889
+ "name": "FormInternalsMixin",
14890
+ "module": "src/utils/mixins/FormInternalsMixin.ts"
14891
+ }
14894
14892
  },
14895
14893
  {
14896
14894
  "name": "data-aria-label",
@@ -14980,22 +14978,24 @@
14980
14978
  }
14981
14979
  }
14982
14980
  ],
14981
+ "mixins": [
14982
+ {
14983
+ "name": "FormInternalsMixin",
14984
+ "module": "/src/utils/mixins/FormInternalsMixin"
14985
+ },
14986
+ {
14987
+ "name": "DataAriaLabelMixin",
14988
+ "module": "/src/utils/mixins/DataAriaLabelMixin"
14989
+ }
14990
+ ],
14983
14991
  "superclass": {
14984
- "name": "FormfieldGroup",
14985
- "module": "/src/components/formfieldgroup"
14992
+ "name": "FormfieldWrapper",
14993
+ "module": "/src/components/formfieldwrapper/formfieldwrapper.component"
14986
14994
  },
14987
- "tagName": "mdc-radiogroup",
14988
- "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 */",
14995
+ "tagName": "mdc-radio",
14996
+ "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 * @dependency mdc-formfieldwrapper\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 */",
14989
14997
  "customElement": true,
14990
14998
  "slots": [
14991
- {
14992
- "description": "This is a default slot for checkbox or toggle components.",
14993
- "name": "default",
14994
- "inheritedFrom": {
14995
- "name": "FormfieldGroup",
14996
- "module": "src/components/formfieldgroup/formfieldgroup.component.ts"
14997
- }
14998
- },
14999
14999
  {
15000
15000
  "description": "slot to add the label info icon",
15001
15001
  "name": "label-info",
@@ -15012,8 +15012,8 @@
15012
15012
  "kind": "js",
15013
15013
  "name": "default",
15014
15014
  "declaration": {
15015
- "name": "RadioGroup",
15016
- "module": "components/radiogroup/radiogroup.component.js"
15015
+ "name": "Radio",
15016
+ "module": "components/radio/radio.component.js"
15017
15017
  }
15018
15018
  }
15019
15019
  ]