@momentum-design/components 0.83.1 → 0.83.2

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.
@@ -2030,94 +2030,61 @@
2030
2030
  },
2031
2031
  {
2032
2032
  "kind": "javascript-module",
2033
- "path": "components/brandvisual/brandvisual.component.js",
2033
+ "path": "components/bullet/bullet.component.js",
2034
2034
  "declarations": [
2035
2035
  {
2036
2036
  "kind": "class",
2037
- "description": "The `mdc-brandvisual` component is responsible for rendering logos dynamically & ensures they are\ndisplayed correctly within applications.\n\nFeatures:\n- Dynamically loads brandvisuals based on the `name` attribute.\n- Emits a `load` event when the brandvisual is successfully fetched.\n- Emits an `error` event when the brandvisual import fails.\n- Supports accessibility best practices.\n- Used for brand representation within the design system.",
2038
- "name": "Brandvisual",
2039
- "members": [
2040
- {
2041
- "kind": "field",
2042
- "name": "brandVisualData",
2043
- "type": {
2044
- "text": "HTMLElement | undefined"
2045
- },
2046
- "privacy": "private"
2047
- },
2037
+ "description": "Bullet component, which is a visual marker\nand be used to organize and present items in a list format.",
2038
+ "name": "Bullet",
2039
+ "cssProperties": [
2048
2040
  {
2049
- "kind": "field",
2050
- "name": "name",
2051
- "type": {
2052
- "text": "BrandVisualNames | undefined"
2053
- },
2054
- "description": "Name of the brandVisual (= filename)",
2055
- "attribute": "name",
2056
- "reflects": true
2041
+ "description": "background color of the bullet",
2042
+ "name": "--mdc-bullet-background-color"
2057
2043
  },
2058
2044
  {
2059
- "kind": "method",
2060
- "name": "getBrandVisualData",
2061
- "privacy": "private"
2045
+ "description": "small size value of the bullet",
2046
+ "name": "--mdc-bullet-size-small"
2062
2047
  },
2063
2048
  {
2064
- "kind": "method",
2065
- "name": "handleBrandVisualLoadedSuccess",
2066
- "privacy": "private",
2067
- "parameters": [
2068
- {
2069
- "name": "brandVisualHtml",
2070
- "type": {
2071
- "text": "HTMLElement"
2072
- },
2073
- "description": "The brandvisual html element which has been fetched from the brandvisual provider."
2074
- }
2075
- ],
2076
- "description": "Sets the brandVisualData state to the fetched brandvisual.\nDispatches a 'load' event on the component once the brandvisual has been successfully loaded."
2049
+ "description": "medium size value of the bullet",
2050
+ "name": "--mdc-bullet-size-medium"
2077
2051
  },
2078
2052
  {
2079
- "kind": "method",
2080
- "name": "handleBrandVisualLoadedFailure",
2081
- "privacy": "private",
2082
- "parameters": [
2083
- {
2084
- "name": "error",
2085
- "type": {
2086
- "text": "unknown"
2087
- }
2088
- }
2089
- ],
2090
- "description": "Dispatches an 'error' event on the component when the brandvisual import has failed.\nThis event bubbles and is cancelable.\nThe error detail is set to the error object."
2053
+ "description": "large size value of the bullet",
2054
+ "name": "--mdc-bullet-size-large"
2091
2055
  }
2092
2056
  ],
2093
- "events": [
2094
- {
2095
- "description": "(React: onLoad) This event is dispatched when the brandvisual has been successfully loaded.",
2096
- "name": "load",
2097
- "reactName": "onLoad"
2098
- },
2057
+ "members": [
2099
2058
  {
2100
- "description": "(React: onError) This event is dispatched when the brandvisual fetching has failed.",
2101
- "name": "error",
2102
- "reactName": "onError"
2059
+ "kind": "field",
2060
+ "name": "size",
2061
+ "type": {
2062
+ "text": "Size"
2063
+ },
2064
+ "privacy": "public",
2065
+ "description": "Size of the bullet\n\nPossible values: 'small', 'medium', 'large'",
2066
+ "default": "small",
2067
+ "attribute": "size",
2068
+ "reflects": true
2103
2069
  }
2104
2070
  ],
2105
2071
  "attributes": [
2106
2072
  {
2107
- "name": "name",
2073
+ "name": "size",
2108
2074
  "type": {
2109
- "text": "BrandVisualNames | undefined"
2075
+ "text": "Size"
2110
2076
  },
2111
- "description": "Name of the brandVisual (= filename)",
2112
- "fieldName": "name"
2077
+ "description": "Size of the bullet\n\nPossible values: 'small', 'medium', 'large'",
2078
+ "default": "small",
2079
+ "fieldName": "size"
2113
2080
  }
2114
2081
  ],
2115
2082
  "superclass": {
2116
2083
  "name": "Component",
2117
2084
  "module": "/src/models"
2118
2085
  },
2119
- "tagName": "mdc-brandvisual",
2120
- "jsDoc": "/**\n * The `mdc-brandvisual` component is responsible for rendering logos dynamically & ensures they are\n * displayed correctly within applications.\n *\n * Features:\n * - Dynamically loads brandvisuals based on the `name` attribute.\n * - Emits a `load` event when the brandvisual is successfully fetched.\n * - Emits an `error` event when the brandvisual import fails.\n * - Supports accessibility best practices.\n * - Used for brand representation within the design system.\n *\n * @tagname mdc-brandvisual\n *\n * @event load - (React: onLoad) This event is dispatched when the brandvisual has been successfully loaded.\n * @event error - (React: onError) This event is dispatched when the brandvisual fetching has failed.\n *\n */",
2086
+ "tagName": "mdc-bullet",
2087
+ "jsDoc": "/**\n * Bullet component, which is a visual marker\n * and be used to organize and present items in a list format.\n *\n * @tagname mdc-bullet\n *\n * @cssproperty --mdc-bullet-background-color - background color of the bullet\n * @cssproperty --mdc-bullet-size-small - small size value of the bullet\n * @cssproperty --mdc-bullet-size-medium - medium size value of the bullet\n * @cssproperty --mdc-bullet-size-large - large size value of the bullet\n*/",
2121
2088
  "customElement": true
2122
2089
  }
2123
2090
  ],
@@ -2126,8 +2093,8 @@
2126
2093
  "kind": "js",
2127
2094
  "name": "default",
2128
2095
  "declaration": {
2129
- "name": "Brandvisual",
2130
- "module": "components/brandvisual/brandvisual.component.js"
2096
+ "name": "Bullet",
2097
+ "module": "components/bullet/bullet.component.js"
2131
2098
  }
2132
2099
  }
2133
2100
  ]
@@ -2829,193 +2796,94 @@
2829
2796
  },
2830
2797
  {
2831
2798
  "kind": "javascript-module",
2832
- "path": "components/bullet/bullet.component.js",
2799
+ "path": "components/brandvisual/brandvisual.component.js",
2833
2800
  "declarations": [
2834
2801
  {
2835
2802
  "kind": "class",
2836
- "description": "Bullet component, which is a visual marker\nand be used to organize and present items in a list format.",
2837
- "name": "Bullet",
2838
- "cssProperties": [
2839
- {
2840
- "description": "background color of the bullet",
2841
- "name": "--mdc-bullet-background-color"
2842
- },
2843
- {
2844
- "description": "small size value of the bullet",
2845
- "name": "--mdc-bullet-size-small"
2846
- },
2847
- {
2848
- "description": "medium size value of the bullet",
2849
- "name": "--mdc-bullet-size-medium"
2850
- },
2851
- {
2852
- "description": "large size value of the bullet",
2853
- "name": "--mdc-bullet-size-large"
2854
- }
2855
- ],
2803
+ "description": "The `mdc-brandvisual` component is responsible for rendering logos dynamically & ensures they are\ndisplayed correctly within applications.\n\nFeatures:\n- Dynamically loads brandvisuals based on the `name` attribute.\n- Emits a `load` event when the brandvisual is successfully fetched.\n- Emits an `error` event when the brandvisual import fails.\n- Supports accessibility best practices.\n- Used for brand representation within the design system.",
2804
+ "name": "Brandvisual",
2856
2805
  "members": [
2857
2806
  {
2858
2807
  "kind": "field",
2859
- "name": "size",
2860
- "type": {
2861
- "text": "Size"
2862
- },
2863
- "privacy": "public",
2864
- "description": "Size of the bullet\n\nPossible values: 'small', 'medium', 'large'",
2865
- "default": "small",
2866
- "attribute": "size",
2867
- "reflects": true
2868
- }
2869
- ],
2870
- "attributes": [
2871
- {
2872
- "name": "size",
2808
+ "name": "brandVisualData",
2873
2809
  "type": {
2874
- "text": "Size"
2810
+ "text": "HTMLElement | undefined"
2875
2811
  },
2876
- "description": "Size of the bullet\n\nPossible values: 'small', 'medium', 'large'",
2877
- "default": "small",
2878
- "fieldName": "size"
2879
- }
2880
- ],
2881
- "superclass": {
2882
- "name": "Component",
2883
- "module": "/src/models"
2884
- },
2885
- "tagName": "mdc-bullet",
2886
- "jsDoc": "/**\n * Bullet component, which is a visual marker\n * and be used to organize and present items in a list format.\n *\n * @tagname mdc-bullet\n *\n * @cssproperty --mdc-bullet-background-color - background color of the bullet\n * @cssproperty --mdc-bullet-size-small - small size value of the bullet\n * @cssproperty --mdc-bullet-size-medium - medium size value of the bullet\n * @cssproperty --mdc-bullet-size-large - large size value of the bullet\n*/",
2887
- "customElement": true
2888
- }
2889
- ],
2890
- "exports": [
2891
- {
2892
- "kind": "js",
2893
- "name": "default",
2894
- "declaration": {
2895
- "name": "Bullet",
2896
- "module": "components/bullet/bullet.component.js"
2897
- }
2898
- }
2899
- ]
2900
- },
2901
- {
2902
- "kind": "javascript-module",
2903
- "path": "components/buttongroup/buttongroup.component.js",
2904
- "declarations": [
2905
- {
2906
- "kind": "class",
2907
- "description": "buttongroup component, is a styled wrapper for multiple buttons.\nIt can support icon buttons, combination of icon and pill buttons, and text buttons.\nThey are available in horizontal and vertical orientation.",
2908
- "name": "ButtonGroup",
2909
- "cssProperties": [
2910
- {
2911
- "description": "The border radius of the buttongroup",
2912
- "name": "--mdc-buttongroup-border-radius"
2913
- },
2914
- {
2915
- "description": "The border color of the buttongroup",
2916
- "name": "--mdc-buttongroup-border-color"
2812
+ "privacy": "private"
2917
2813
  },
2918
- {
2919
- "description": "The color of the divider between buttons within the buttongroup",
2920
- "name": "--mdc-buttongroup-divider-color"
2921
- }
2922
- ],
2923
- "slots": [
2924
- {
2925
- "description": "This is a default/unnamed slot, which contains the buttons",
2926
- "name": "default"
2927
- }
2928
- ],
2929
- "members": [
2930
2814
  {
2931
2815
  "kind": "field",
2932
- "name": "orientation",
2816
+ "name": "name",
2933
2817
  "type": {
2934
- "text": "ButtonGroupOrientation"
2818
+ "text": "BrandVisualNames | undefined"
2935
2819
  },
2936
- "description": "Orientation of the buttongroup.",
2937
- "default": "'horizontal'",
2938
- "attribute": "orientation",
2820
+ "description": "Name of the brandVisual (= filename)",
2821
+ "attribute": "name",
2939
2822
  "reflects": true
2940
2823
  },
2941
2824
  {
2942
- "kind": "field",
2943
- "name": "variant",
2944
- "type": {
2945
- "text": "ButtonGroupVariant"
2946
- },
2947
- "description": "Variant of the buttons within the buttongroup.",
2948
- "default": "'primary'",
2949
- "attribute": "variant",
2950
- "reflects": true
2825
+ "kind": "method",
2826
+ "name": "getBrandVisualData",
2827
+ "privacy": "private"
2951
2828
  },
2952
2829
  {
2953
- "kind": "field",
2954
- "name": "size",
2955
- "type": {
2956
- "text": "ButtonGroupSize"
2957
- },
2958
- "description": "Size of the buttons within the buttongroup.",
2959
- "default": "'28'",
2960
- "attribute": "size",
2961
- "reflects": true
2830
+ "kind": "method",
2831
+ "name": "handleBrandVisualLoadedSuccess",
2832
+ "privacy": "private",
2833
+ "parameters": [
2834
+ {
2835
+ "name": "brandVisualHtml",
2836
+ "type": {
2837
+ "text": "HTMLElement"
2838
+ },
2839
+ "description": "The brandvisual html element which has been fetched from the brandvisual provider."
2840
+ }
2841
+ ],
2842
+ "description": "Sets the brandVisualData state to the fetched brandvisual.\nDispatches a 'load' event on the component once the brandvisual has been successfully loaded."
2962
2843
  },
2963
2844
  {
2964
- "kind": "field",
2965
- "name": "compact",
2966
- "type": {
2967
- "text": "boolean"
2968
- },
2969
- "default": "false",
2970
- "description": "When this is true, the buttons within the buttongroup will be compact.\ni.e. Irrespective of the size of the buttons, they will have a height of 24px.",
2971
- "attribute": "compact",
2972
- "reflects": true
2845
+ "kind": "method",
2846
+ "name": "handleBrandVisualLoadedFailure",
2847
+ "privacy": "private",
2848
+ "parameters": [
2849
+ {
2850
+ "name": "error",
2851
+ "type": {
2852
+ "text": "unknown"
2853
+ }
2854
+ }
2855
+ ],
2856
+ "description": "Dispatches an 'error' event on the component when the brandvisual import has failed.\nThis event bubbles and is cancelable.\nThe error detail is set to the error object."
2973
2857
  }
2974
2858
  ],
2975
- "attributes": [
2976
- {
2977
- "name": "orientation",
2978
- "type": {
2979
- "text": "ButtonGroupOrientation"
2980
- },
2981
- "description": "Orientation of the buttongroup.",
2982
- "default": "'horizontal'",
2983
- "fieldName": "orientation"
2984
- },
2859
+ "events": [
2985
2860
  {
2986
- "name": "variant",
2987
- "type": {
2988
- "text": "ButtonGroupVariant"
2989
- },
2990
- "description": "Variant of the buttons within the buttongroup.",
2991
- "default": "'primary'",
2992
- "fieldName": "variant"
2861
+ "description": "(React: onLoad) This event is dispatched when the brandvisual has been successfully loaded.",
2862
+ "name": "load",
2863
+ "reactName": "onLoad"
2993
2864
  },
2994
2865
  {
2995
- "name": "size",
2996
- "type": {
2997
- "text": "ButtonGroupSize"
2998
- },
2999
- "description": "Size of the buttons within the buttongroup.",
3000
- "default": "'28'",
3001
- "fieldName": "size"
3002
- },
2866
+ "description": "(React: onError) This event is dispatched when the brandvisual fetching has failed.",
2867
+ "name": "error",
2868
+ "reactName": "onError"
2869
+ }
2870
+ ],
2871
+ "attributes": [
3003
2872
  {
3004
- "name": "compact",
2873
+ "name": "name",
3005
2874
  "type": {
3006
- "text": "boolean"
2875
+ "text": "BrandVisualNames | undefined"
3007
2876
  },
3008
- "default": "false",
3009
- "description": "When this is true, the buttons within the buttongroup will be compact.\ni.e. Irrespective of the size of the buttons, they will have a height of 24px.",
3010
- "fieldName": "compact"
2877
+ "description": "Name of the brandVisual (= filename)",
2878
+ "fieldName": "name"
3011
2879
  }
3012
2880
  ],
3013
2881
  "superclass": {
3014
2882
  "name": "Component",
3015
2883
  "module": "/src/models"
3016
2884
  },
3017
- "tagName": "mdc-buttongroup",
3018
- "jsDoc": "/**\n * buttongroup component, is a styled wrapper for multiple buttons.\n * It can support icon buttons, combination of icon and pill buttons, and text buttons.\n * They are available in horizontal and vertical orientation.\n *\n * @tagname mdc-buttongroup\n *\n * @slot default - This is a default/unnamed slot, which contains the buttons\n *\n * @cssproperty --mdc-buttongroup-border-radius - The border radius of the buttongroup\n * @cssproperty --mdc-buttongroup-border-color - The border color of the buttongroup\n * @cssproperty --mdc-buttongroup-divider-color - The color of the divider between buttons within the buttongroup\n */",
2885
+ "tagName": "mdc-brandvisual",
2886
+ "jsDoc": "/**\n * The `mdc-brandvisual` component is responsible for rendering logos dynamically & ensures they are\n * displayed correctly within applications.\n *\n * Features:\n * - Dynamically loads brandvisuals based on the `name` attribute.\n * - Emits a `load` event when the brandvisual is successfully fetched.\n * - Emits an `error` event when the brandvisual import fails.\n * - Supports accessibility best practices.\n * - Used for brand representation within the design system.\n *\n * @tagname mdc-brandvisual\n *\n * @event load - (React: onLoad) This event is dispatched when the brandvisual has been successfully loaded.\n * @event error - (React: onError) This event is dispatched when the brandvisual fetching has failed.\n *\n */",
3019
2887
  "customElement": true
3020
2888
  }
3021
2889
  ],
@@ -3024,8 +2892,8 @@
3024
2892
  "kind": "js",
3025
2893
  "name": "default",
3026
2894
  "declaration": {
3027
- "name": "ButtonGroup",
3028
- "module": "components/buttongroup/buttongroup.component.js"
2895
+ "name": "Brandvisual",
2896
+ "module": "components/brandvisual/brandvisual.component.js"
3029
2897
  }
3030
2898
  }
3031
2899
  ]
@@ -3644,6 +3512,138 @@
3644
3512
  }
3645
3513
  ]
3646
3514
  },
3515
+ {
3516
+ "kind": "javascript-module",
3517
+ "path": "components/buttongroup/buttongroup.component.js",
3518
+ "declarations": [
3519
+ {
3520
+ "kind": "class",
3521
+ "description": "buttongroup component, is a styled wrapper for multiple buttons.\nIt can support icon buttons, combination of icon and pill buttons, and text buttons.\nThey are available in horizontal and vertical orientation.",
3522
+ "name": "ButtonGroup",
3523
+ "cssProperties": [
3524
+ {
3525
+ "description": "The border radius of the buttongroup",
3526
+ "name": "--mdc-buttongroup-border-radius"
3527
+ },
3528
+ {
3529
+ "description": "The border color of the buttongroup",
3530
+ "name": "--mdc-buttongroup-border-color"
3531
+ },
3532
+ {
3533
+ "description": "The color of the divider between buttons within the buttongroup",
3534
+ "name": "--mdc-buttongroup-divider-color"
3535
+ }
3536
+ ],
3537
+ "slots": [
3538
+ {
3539
+ "description": "This is a default/unnamed slot, which contains the buttons",
3540
+ "name": "default"
3541
+ }
3542
+ ],
3543
+ "members": [
3544
+ {
3545
+ "kind": "field",
3546
+ "name": "orientation",
3547
+ "type": {
3548
+ "text": "ButtonGroupOrientation"
3549
+ },
3550
+ "description": "Orientation of the buttongroup.",
3551
+ "default": "'horizontal'",
3552
+ "attribute": "orientation",
3553
+ "reflects": true
3554
+ },
3555
+ {
3556
+ "kind": "field",
3557
+ "name": "variant",
3558
+ "type": {
3559
+ "text": "ButtonGroupVariant"
3560
+ },
3561
+ "description": "Variant of the buttons within the buttongroup.",
3562
+ "default": "'primary'",
3563
+ "attribute": "variant",
3564
+ "reflects": true
3565
+ },
3566
+ {
3567
+ "kind": "field",
3568
+ "name": "size",
3569
+ "type": {
3570
+ "text": "ButtonGroupSize"
3571
+ },
3572
+ "description": "Size of the buttons within the buttongroup.",
3573
+ "default": "'28'",
3574
+ "attribute": "size",
3575
+ "reflects": true
3576
+ },
3577
+ {
3578
+ "kind": "field",
3579
+ "name": "compact",
3580
+ "type": {
3581
+ "text": "boolean"
3582
+ },
3583
+ "default": "false",
3584
+ "description": "When this is true, the buttons within the buttongroup will be compact.\ni.e. Irrespective of the size of the buttons, they will have a height of 24px.",
3585
+ "attribute": "compact",
3586
+ "reflects": true
3587
+ }
3588
+ ],
3589
+ "attributes": [
3590
+ {
3591
+ "name": "orientation",
3592
+ "type": {
3593
+ "text": "ButtonGroupOrientation"
3594
+ },
3595
+ "description": "Orientation of the buttongroup.",
3596
+ "default": "'horizontal'",
3597
+ "fieldName": "orientation"
3598
+ },
3599
+ {
3600
+ "name": "variant",
3601
+ "type": {
3602
+ "text": "ButtonGroupVariant"
3603
+ },
3604
+ "description": "Variant of the buttons within the buttongroup.",
3605
+ "default": "'primary'",
3606
+ "fieldName": "variant"
3607
+ },
3608
+ {
3609
+ "name": "size",
3610
+ "type": {
3611
+ "text": "ButtonGroupSize"
3612
+ },
3613
+ "description": "Size of the buttons within the buttongroup.",
3614
+ "default": "'28'",
3615
+ "fieldName": "size"
3616
+ },
3617
+ {
3618
+ "name": "compact",
3619
+ "type": {
3620
+ "text": "boolean"
3621
+ },
3622
+ "default": "false",
3623
+ "description": "When this is true, the buttons within the buttongroup will be compact.\ni.e. Irrespective of the size of the buttons, they will have a height of 24px.",
3624
+ "fieldName": "compact"
3625
+ }
3626
+ ],
3627
+ "superclass": {
3628
+ "name": "Component",
3629
+ "module": "/src/models"
3630
+ },
3631
+ "tagName": "mdc-buttongroup",
3632
+ "jsDoc": "/**\n * buttongroup component, is a styled wrapper for multiple buttons.\n * It can support icon buttons, combination of icon and pill buttons, and text buttons.\n * They are available in horizontal and vertical orientation.\n *\n * @tagname mdc-buttongroup\n *\n * @slot default - This is a default/unnamed slot, which contains the buttons\n *\n * @cssproperty --mdc-buttongroup-border-radius - The border radius of the buttongroup\n * @cssproperty --mdc-buttongroup-border-color - The border color of the buttongroup\n * @cssproperty --mdc-buttongroup-divider-color - The color of the divider between buttons within the buttongroup\n */",
3633
+ "customElement": true
3634
+ }
3635
+ ],
3636
+ "exports": [
3637
+ {
3638
+ "kind": "js",
3639
+ "name": "default",
3640
+ "declaration": {
3641
+ "name": "ButtonGroup",
3642
+ "module": "components/buttongroup/buttongroup.component.js"
3643
+ }
3644
+ }
3645
+ ]
3646
+ },
3647
3647
  {
3648
3648
  "kind": "javascript-module",
3649
3649
  "path": "components/buttonsimple/buttonsimple.component.js",
@@ -5814,68 +5814,32 @@
5814
5814
  },
5815
5815
  {
5816
5816
  "kind": "javascript-module",
5817
- "path": "components/cardradio/cardradio.component.js",
5817
+ "path": "components/checkbox/checkbox.component.js",
5818
5818
  "declarations": [
5819
5819
  {
5820
5820
  "kind": "class",
5821
- "description": "cardradio component extends `mdc-card` and supports radio selection interaction addtionally.\n\nWhile using this component within a form or group of cards, make sure cards are in a role = \"radio-group\".\nThis card would have events for selected and unselected (similar to radio)\n\n**Note**: This is a single selection card i.e. interacting anywhere on the card would toggle the checked state.\nMake sure to pass only non-interactable elements within the slots.\n\nMake sure to pass the `card-title` mandatorily for this card.",
5822
- "name": "CardRadio",
5823
- "slots": [
5824
- {
5825
- "description": "This slot is for passing the content before the body",
5826
- "name": "before-body",
5827
- "inheritedFrom": {
5828
- "name": "Card",
5829
- "module": "src/components/card/card.component.ts"
5830
- }
5831
- },
5832
- {
5833
- "description": "This slot is for passing the text content for the card",
5834
- "name": "body",
5835
- "inheritedFrom": {
5836
- "name": "Card",
5837
- "module": "src/components/card/card.component.ts"
5838
- }
5839
- },
5821
+ "description": "Checkboxes allow users to select multiple options from a list or turn an item/feature on or off.\nThese are often used in forms, settings, and selections in lists.\n\nA checkbox component contains an optional label and an optional helper text.\n\nTo create a group of checkboxes, use the FormFieldGroup component.",
5822
+ "name": "Checkbox",
5823
+ "cssProperties": [
5840
5824
  {
5841
- "description": "This slot is for passing the content after the body",
5842
- "name": "after-body",
5843
- "inheritedFrom": {
5844
- "name": "Card",
5845
- "module": "src/components/card/card.component.ts"
5846
- }
5825
+ "description": "Allows customization of the background color on hover.",
5826
+ "name": "--mdc-checkbox-background-color-hover"
5847
5827
  },
5848
5828
  {
5849
- "description": "This slot is for passing `mdc-link` component within the footer section.",
5850
- "name": "footer-link",
5851
- "inheritedFrom": {
5852
- "name": "Card",
5853
- "module": "src/components/card/card.component.ts"
5854
- }
5829
+ "description": "Background color for a selected checkbox when hovered.",
5830
+ "name": "--mdc-checkbox-checked-background-color-hover"
5855
5831
  },
5856
5832
  {
5857
- "description": "This slot is for passing primary variant of `mdc-button` component within the footer section.",
5858
- "name": "footer-button-primary",
5859
- "inheritedFrom": {
5860
- "name": "Card",
5861
- "module": "src/components/card/card.component.ts"
5862
- }
5833
+ "description": "Background color for a selected checkbox when pressed.",
5834
+ "name": "--mdc-checkbox-checked-pressed-icon-color"
5863
5835
  },
5864
5836
  {
5865
- "description": "This slot is for passing secondary variant of `mdc-button` component within the footer section.",
5866
- "name": "footer-button-secondary",
5867
- "inheritedFrom": {
5868
- "name": "Card",
5869
- "module": "src/components/card/card.component.ts"
5870
- }
5837
+ "description": "Background color for a selected checkbox when pressed.",
5838
+ "name": "--mdc-checkbox-pressed-icon-color"
5871
5839
  },
5872
5840
  {
5873
- "description": " This slot is for passing custom footer content. Only use this if really needed, using the footer-link and footer-button slots is preferred.",
5874
- "name": "footer",
5875
- "inheritedFrom": {
5876
- "name": "Card",
5877
- "module": "src/components/card/card.component.ts"
5878
- }
5841
+ "description": "Background color for a selected checkbox when disabled.",
5842
+ "name": "--mdc-checkbox-disabled-checked-icon-color"
5879
5843
  }
5880
5844
  ],
5881
5845
  "members": [
@@ -5886,376 +5850,432 @@
5886
5850
  "text": "boolean"
5887
5851
  },
5888
5852
  "default": "false",
5889
- "description": "The checked state of the card",
5853
+ "description": "Determines whether the checkbox is selected or unselected.",
5890
5854
  "attribute": "checked",
5891
5855
  "reflects": true
5892
5856
  },
5893
5857
  {
5894
5858
  "kind": "field",
5895
- "name": "name",
5859
+ "name": "indeterminate",
5896
5860
  "type": {
5897
- "text": "string"
5861
+ "text": "boolean"
5898
5862
  },
5899
- "default": "''",
5900
- "description": "The name of the radio.",
5901
- "attribute": "name"
5863
+ "default": "false",
5864
+ "description": "This property is used to determine the parent checkbox in a nested checkbox group.\nIf any one of the children is unselected, then the parent checkbox will be indeterminate.\nIf all children are either selected or unselected, then the parent checkbox will not be indeterminate.",
5865
+ "attribute": "indeterminate",
5866
+ "reflects": true
5867
+ },
5868
+ {
5869
+ "kind": "field",
5870
+ "name": "autofocus",
5871
+ "type": {
5872
+ "text": "boolean"
5873
+ },
5874
+ "default": "false",
5875
+ "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)",
5876
+ "attribute": "autofocus",
5877
+ "reflects": true
5902
5878
  },
5903
5879
  {
5904
5880
  "kind": "method",
5905
- "name": "getAllCardsWithinSameGroup",
5881
+ "name": "setFormValue",
5906
5882
  "privacy": "private",
5907
- "return": {
5908
- "type": {
5909
- "text": "CardRadio[]"
5910
- }
5911
- },
5912
- "description": "Returns all cards within the same group (name)."
5883
+ "description": "Updates the form value to reflect the current state of the checkbox.\nIf checked, the value is set to either the user-provided value or 'on' if no value is provided.\nIf unchecked, the value is set to null."
5913
5884
  },
5914
5885
  {
5915
5886
  "kind": "method",
5916
- "name": "toggleChecked",
5887
+ "name": "manageRequired",
5917
5888
  "privacy": "private",
5918
- "return": {
5919
- "type": {
5920
- "text": "void"
5921
- }
5922
- },
5923
- "description": "Handles the change event on the radio element.\nThis will toggle the state of the radio element.\nDispatches the change event."
5889
+ "description": "Manages the required state of the checkbox.\nIf the checkbox is not checked and the required property is set, then the checkbox is invalid."
5924
5890
  },
5925
5891
  {
5926
5892
  "kind": "method",
5927
- "name": "setDisabled",
5893
+ "name": "toggleState",
5894
+ "privacy": "private",
5928
5895
  "return": {
5929
5896
  "type": {
5930
5897
  "text": "void"
5931
5898
  }
5932
5899
  },
5933
- "parameters": [
5934
- {
5935
- "name": "disabled",
5936
- "type": {
5937
- "text": "boolean"
5938
- }
5939
- }
5940
- ]
5900
+ "description": "Toggles the state of the checkbox element.\nIf the element is not disabled, then\nthe checked property is toggled and the indeterminate property is set to false."
5941
5901
  },
5942
5902
  {
5943
5903
  "kind": "method",
5944
- "name": "updateCardRadio",
5904
+ "name": "handleKeyDown",
5945
5905
  "privacy": "private",
5946
5906
  "return": {
5947
5907
  "type": {
5948
5908
  "text": "void"
5949
5909
  }
5950
5910
  },
5951
- "parameters": [
5952
- {
5953
- "name": "cards",
5954
- "type": {
5955
- "text": "CardRadio[]"
5956
- }
5957
- },
5958
- {
5959
- "name": "index",
5960
- "type": {
5961
- "text": "number"
5962
- }
5963
- }
5964
- ]
5965
- },
5966
- {
5967
- "kind": "method",
5968
- "name": "toggleOnEnter",
5969
- "privacy": "private",
5970
5911
  "parameters": [
5971
5912
  {
5972
5913
  "name": "event",
5973
5914
  "type": {
5974
5915
  "text": "KeyboardEvent"
5975
5916
  },
5976
- "description": "The keyboard event"
5917
+ "description": "The keyboard event."
5977
5918
  }
5978
5919
  ],
5979
- "description": "Toggles the checked state when enter key is used"
5920
+ "description": "Handles the keydown event on the checkbox.\nWhen the user presses Enter, the form is submitted."
5980
5921
  },
5981
5922
  {
5982
5923
  "kind": "method",
5983
- "name": "toggleOnSpace",
5984
- "privacy": "private",
5924
+ "name": "handleChange",
5925
+ "privacy": "public",
5926
+ "return": {
5927
+ "type": {
5928
+ "text": "void"
5929
+ }
5930
+ },
5985
5931
  "parameters": [
5986
5932
  {
5987
5933
  "name": "event",
5988
5934
  "type": {
5989
- "text": "KeyboardEvent"
5990
- },
5991
- "description": "The keyboard event"
5935
+ "text": "Event"
5936
+ }
5992
5937
  }
5993
5938
  ],
5994
- "description": "Toggles the checked state when space key is used"
5939
+ "description": "Toggles the state of the checkbox element.\nand dispatch the new change event."
5995
5940
  },
5996
5941
  {
5997
- "kind": "method",
5998
- "name": "renderHeader",
5999
- "privacy": "protected",
6000
- "description": "Renders the header of the card",
6001
- "return": {
6002
- "type": {
6003
- "text": ""
6004
- }
6005
- },
6006
- "inheritedFrom": {
6007
- "name": "Card",
6008
- "module": "components/card/card.component.js"
6009
- }
5942
+ "kind": "field",
5943
+ "name": "renderLabelAndHelperText",
5944
+ "privacy": "private"
6010
5945
  },
6011
5946
  {
6012
5947
  "kind": "field",
6013
- "name": "disabled",
5948
+ "name": "name",
6014
5949
  "type": {
6015
- "text": "boolean | undefined"
5950
+ "text": "string"
6016
5951
  },
6017
- "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
6018
- "default": "undefined",
6019
- "attribute": "disabled",
5952
+ "default": "''",
5953
+ "description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
5954
+ "attribute": "name",
6020
5955
  "reflects": true,
6021
5956
  "inheritedFrom": {
6022
- "name": "DisabledMixin",
6023
- "module": "utils/mixins/DisabledMixin.js"
5957
+ "name": "FormInternalsMixin",
5958
+ "module": "utils/mixins/FormInternalsMixin.js"
6024
5959
  }
6025
5960
  },
6026
5961
  {
6027
5962
  "kind": "field",
6028
- "name": "tabIndex",
5963
+ "name": "value",
6029
5964
  "type": {
6030
- "text": "number"
5965
+ "text": "string"
6031
5966
  },
6032
- "default": "0",
6033
- "description": "This property specifies the tab order of the element.",
6034
- "attribute": "tabIndex",
5967
+ "default": "''",
5968
+ "description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
5969
+ "attribute": "value",
6035
5970
  "reflects": true,
6036
5971
  "inheritedFrom": {
6037
- "name": "TabIndexMixin",
6038
- "module": "utils/mixins/TabIndexMixin.js"
5972
+ "name": "FormInternalsMixin",
5973
+ "module": "utils/mixins/FormInternalsMixin.js"
6039
5974
  }
6040
5975
  },
6041
5976
  {
6042
5977
  "kind": "field",
6043
- "name": "cardTitle",
5978
+ "name": "validationMessage",
6044
5979
  "type": {
6045
- "text": "string"
5980
+ "text": "string | undefined"
6046
5981
  },
6047
- "default": "''",
6048
- "description": "The title of the card - part of header section",
6049
- "attribute": "card-title",
5982
+ "description": "Custom validation message that will override the default message and displayed when the input is invalid.",
5983
+ "attribute": "validation-message",
6050
5984
  "reflects": true,
6051
5985
  "inheritedFrom": {
6052
- "name": "Card",
6053
- "module": "components/card/card.component.js"
5986
+ "name": "FormInternalsMixin",
5987
+ "module": "utils/mixins/FormInternalsMixin.js"
6054
5988
  }
6055
5989
  },
6056
5990
  {
6057
5991
  "kind": "field",
6058
- "name": "subtitle",
5992
+ "name": "validity",
6059
5993
  "type": {
6060
- "text": "string"
5994
+ "text": "ValidityState"
6061
5995
  },
6062
- "default": "''",
6063
- "description": "The subtitle of the card - part of header section",
6064
- "attribute": "subtitle",
6065
- "reflects": true,
5996
+ "readonly": true,
6066
5997
  "inheritedFrom": {
6067
- "name": "Card",
6068
- "module": "components/card/card.component.js"
5998
+ "name": "FormInternalsMixin",
5999
+ "module": "utils/mixins/FormInternalsMixin.js"
6069
6000
  }
6070
6001
  },
6071
6002
  {
6072
6003
  "kind": "field",
6073
- "name": "imageSrc",
6074
- "type": {
6075
- "text": "string"
6004
+ "name": "willValidate",
6005
+ "readonly": true,
6006
+ "inheritedFrom": {
6007
+ "name": "FormInternalsMixin",
6008
+ "module": "utils/mixins/FormInternalsMixin.js"
6009
+ }
6010
+ },
6011
+ {
6012
+ "kind": "method",
6013
+ "name": "setValidity",
6014
+ "description": "Sets the validity of the input field based on the input field's validity.",
6015
+ "return": {
6016
+ "type": {
6017
+ "text": ""
6018
+ }
6076
6019
  },
6077
- "default": "''",
6078
- "description": "The image source URL to render on the card",
6079
- "attribute": "image-src",
6080
- "reflects": true,
6081
6020
  "inheritedFrom": {
6082
- "name": "Card",
6083
- "module": "components/card/card.component.js"
6021
+ "name": "FormInternalsMixin",
6022
+ "module": "utils/mixins/FormInternalsMixin.js"
6023
+ }
6024
+ },
6025
+ {
6026
+ "kind": "method",
6027
+ "name": "checkValidity",
6028
+ "return": {
6029
+ "type": {
6030
+ "text": "boolean"
6031
+ }
6032
+ },
6033
+ "inheritedFrom": {
6034
+ "name": "FormInternalsMixin",
6035
+ "module": "utils/mixins/FormInternalsMixin.js"
6036
+ }
6037
+ },
6038
+ {
6039
+ "kind": "method",
6040
+ "name": "reportValidity",
6041
+ "inheritedFrom": {
6042
+ "name": "FormInternalsMixin",
6043
+ "module": "utils/mixins/FormInternalsMixin.js"
6084
6044
  }
6085
6045
  },
6086
6046
  {
6087
6047
  "kind": "field",
6088
- "name": "imageAlt",
6048
+ "name": "dataAriaLabel",
6089
6049
  "type": {
6090
- "text": "string"
6050
+ "text": "string | null"
6091
6051
  },
6092
- "default": "''",
6093
- "description": "The image alt for accessibility support",
6094
- "attribute": "image-alt",
6052
+ "default": "null",
6053
+ "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
6054
+ "attribute": "data-aria-label",
6095
6055
  "reflects": true,
6096
6056
  "inheritedFrom": {
6097
- "name": "Card",
6098
- "module": "components/card/card.component.js"
6057
+ "name": "DataAriaLabelMixin",
6058
+ "module": "utils/mixins/DataAriaLabelMixin.js"
6099
6059
  }
6100
6060
  },
6101
6061
  {
6102
6062
  "kind": "field",
6103
- "name": "variant",
6063
+ "name": "disabled",
6104
6064
  "type": {
6105
- "text": "CardVariant"
6065
+ "text": "boolean | undefined"
6106
6066
  },
6107
- "description": "The variant of the card. It can either be set to 'border' or 'ghost'",
6108
- "default": "'border'",
6109
- "attribute": "variant",
6067
+ "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
6068
+ "default": "undefined",
6069
+ "attribute": "disabled",
6110
6070
  "reflects": true,
6111
6071
  "inheritedFrom": {
6112
- "name": "Card",
6113
- "module": "components/card/card.component.js"
6072
+ "name": "DisabledMixin",
6073
+ "module": "utils/mixins/DisabledMixin.js"
6114
6074
  }
6115
6075
  },
6116
6076
  {
6117
6077
  "kind": "field",
6118
- "name": "orientation",
6078
+ "name": "label",
6119
6079
  "type": {
6120
- "text": "CardOrientation"
6080
+ "text": "string | undefined"
6121
6081
  },
6122
- "description": "The orientation of the card. It can either be set to 'vertical' or 'horizontal'",
6123
- "default": "'vertical'",
6124
- "attribute": "orientation",
6082
+ "description": "The label of the input field. It is linked to the input field using the `for` attribute.",
6083
+ "attribute": "label",
6125
6084
  "reflects": true,
6126
6085
  "inheritedFrom": {
6127
- "name": "Card",
6128
- "module": "components/card/card.component.js"
6086
+ "name": "FormfieldWrapper",
6087
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
6129
6088
  }
6130
6089
  },
6131
6090
  {
6132
6091
  "kind": "field",
6133
- "name": "titleTagName",
6092
+ "name": "required",
6134
6093
  "type": {
6135
- "text": "TagNameType"
6094
+ "text": "boolean"
6136
6095
  },
6137
- "description": "The tag name for the card title. It supports all the types that `msc-text` supports",
6138
- "default": "'span'",
6139
- "attribute": "title-tag-name",
6096
+ "default": "false",
6097
+ "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
6098
+ "attribute": "required",
6140
6099
  "reflects": true,
6141
6100
  "inheritedFrom": {
6142
- "name": "Card",
6143
- "module": "components/card/card.component.js"
6101
+ "name": "FormfieldWrapper",
6102
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
6144
6103
  }
6145
6104
  },
6146
6105
  {
6147
6106
  "kind": "field",
6148
- "name": "subtitleTagName",
6107
+ "name": "id",
6149
6108
  "type": {
6150
- "text": "TagNameType"
6109
+ "text": "string"
6151
6110
  },
6152
- "description": "The tag name for the subtitle. It supports all the types that `msc-text` supports",
6153
- "default": "'span'",
6154
- "attribute": "subtitle-tag-name",
6155
- "reflects": true,
6111
+ "default": "''",
6112
+ "description": "The unique id of the input field. It is used to link the input field with the label.",
6113
+ "attribute": "id",
6156
6114
  "inheritedFrom": {
6157
- "name": "Card",
6158
- "module": "components/card/card.component.js"
6115
+ "name": "FormfieldWrapper",
6116
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
6159
6117
  }
6160
6118
  },
6161
6119
  {
6162
6120
  "kind": "field",
6163
- "name": "iconName",
6121
+ "name": "helpTextType",
6164
6122
  "type": {
6165
- "text": "IconNames | undefined"
6123
+ "text": "ValidationType"
6166
6124
  },
6167
- "description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
6168
- "attribute": "icon-name",
6125
+ "description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
6126
+ "attribute": "help-text-type",
6169
6127
  "reflects": true,
6170
6128
  "inheritedFrom": {
6171
- "name": "Card",
6172
- "module": "components/card/card.component.js"
6129
+ "name": "FormfieldWrapper",
6130
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
6173
6131
  }
6174
6132
  },
6175
6133
  {
6176
- "kind": "method",
6177
- "name": "renderImage",
6178
- "privacy": "protected",
6179
- "description": "Renders the image on the card if image source is provided",
6180
- "return": {
6181
- "type": {
6182
- "text": ""
6183
- }
6134
+ "kind": "field",
6135
+ "name": "helpText",
6136
+ "type": {
6137
+ "text": "string | undefined"
6184
6138
  },
6139
+ "description": "The help text that is displayed below the input field.",
6140
+ "attribute": "help-text",
6141
+ "reflects": true,
6185
6142
  "inheritedFrom": {
6186
- "name": "Card",
6187
- "module": "components/card/card.component.js"
6143
+ "name": "FormfieldWrapper",
6144
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
6188
6145
  }
6189
6146
  },
6190
6147
  {
6191
- "kind": "method",
6192
- "name": "renderIcon",
6193
- "privacy": "protected",
6194
- "description": "Renders the icon on the card if icon name is provided",
6148
+ "kind": "field",
6149
+ "name": "toggletipText",
6150
+ "type": {
6151
+ "text": "string | undefined"
6152
+ },
6153
+ "description": "The toggletip text that is displayed when the label is hovered.\nIt is used to provide additional information about the label.",
6154
+ "attribute": "toggletip-text",
6155
+ "reflects": true,
6156
+ "inheritedFrom": {
6157
+ "name": "FormfieldWrapper",
6158
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
6159
+ }
6160
+ },
6161
+ {
6162
+ "kind": "field",
6163
+ "name": "toggletipPlacement",
6164
+ "type": {
6165
+ "text": "PopoverPlacement"
6166
+ },
6167
+ "description": "The placement of the toggletip that is displayed when the info icon is hovered.",
6168
+ "default": "'top'",
6169
+ "attribute": "toggletip-placement",
6170
+ "reflects": true,
6171
+ "inheritedFrom": {
6172
+ "name": "FormfieldWrapper",
6173
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
6174
+ }
6175
+ },
6176
+ {
6177
+ "kind": "field",
6178
+ "name": "infoIconAriaLabel",
6179
+ "type": {
6180
+ "text": "string | undefined"
6181
+ },
6182
+ "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.",
6183
+ "attribute": "info-icon-aria-label",
6184
+ "reflects": true,
6185
+ "inheritedFrom": {
6186
+ "name": "FormfieldWrapper",
6187
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
6188
+ }
6189
+ },
6190
+ {
6191
+ "kind": "method",
6192
+ "name": "renderLabelElement",
6193
+ "privacy": "protected",
6194
+ "description": "creates the label element when the label property is set.\nid is used to link the label with the input field.",
6195
6195
  "return": {
6196
6196
  "type": {
6197
6197
  "text": ""
6198
6198
  }
6199
6199
  },
6200
6200
  "inheritedFrom": {
6201
- "name": "Card",
6202
- "module": "components/card/card.component.js"
6201
+ "name": "FormfieldWrapper",
6202
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
6203
6203
  }
6204
6204
  },
6205
6205
  {
6206
6206
  "kind": "method",
6207
- "name": "renderTitle",
6207
+ "name": "renderHelpTextIcon",
6208
6208
  "privacy": "protected",
6209
- "description": "Renders the title and subtitle on the card",
6209
+ "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.",
6210
6210
  "return": {
6211
6211
  "type": {
6212
6212
  "text": ""
6213
6213
  }
6214
6214
  },
6215
6215
  "inheritedFrom": {
6216
- "name": "Card",
6217
- "module": "components/card/card.component.js"
6216
+ "name": "FormfieldWrapper",
6217
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
6218
6218
  }
6219
6219
  },
6220
6220
  {
6221
6221
  "kind": "method",
6222
- "name": "renderFooter",
6222
+ "name": "renderHelpText",
6223
6223
  "privacy": "protected",
6224
- "description": "Renders the footer of the card if footer-link,\nfooter-button-primary, or footer-button-secondary slots are provided",
6224
+ "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.",
6225
6225
  "return": {
6226
6226
  "type": {
6227
6227
  "text": ""
6228
6228
  }
6229
6229
  },
6230
6230
  "inheritedFrom": {
6231
- "name": "Card",
6232
- "module": "components/card/card.component.js"
6231
+ "name": "FormfieldWrapper",
6232
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
6233
6233
  }
6234
- }
6235
- ],
6236
- "events": [
6237
- {
6238
- "description": "(React: onClick) Event that gets dispatched when the card is clicked. It toggles the checked state.",
6239
- "name": "click",
6240
- "reactName": "onClick"
6241
6234
  },
6242
6235
  {
6243
- "description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the card. It toggles the checked state when enter key is used.",
6244
- "name": "keydown",
6245
- "reactName": "onKeyDown"
6236
+ "kind": "method",
6237
+ "name": "renderLabel",
6238
+ "privacy": "protected",
6239
+ "description": "renders the mdc-label-text container that contains the label and labelInfoToggleTip.",
6240
+ "return": {
6241
+ "type": {
6242
+ "text": ""
6243
+ }
6244
+ },
6245
+ "inheritedFrom": {
6246
+ "name": "FormfieldWrapper",
6247
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
6248
+ }
6246
6249
  },
6247
6250
  {
6248
- "description": "(React: onKeyUp) This event is dispatched when a key is released on the card. It toggles the checked state when space key is used.",
6249
- "name": "keyup",
6250
- "reactName": "onKeyUp"
6251
+ "kind": "method",
6252
+ "name": "renderHelperText",
6253
+ "privacy": "protected",
6254
+ "description": "renders the mdc-help-text container that contains the helpertext icon and helpertext.",
6255
+ "return": {
6256
+ "type": {
6257
+ "text": ""
6258
+ }
6259
+ },
6260
+ "inheritedFrom": {
6261
+ "name": "FormfieldWrapper",
6262
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
6263
+ }
6264
+ }
6265
+ ],
6266
+ "events": [
6267
+ {
6268
+ "type": {
6269
+ "text": "EventConstructor"
6270
+ }
6251
6271
  },
6252
6272
  {
6253
- "description": "(React: onChange) Event that gets dispatched when the card state changes.",
6273
+ "description": "(React: onChange) Event that gets dispatched when the checkbox state changes.",
6254
6274
  "name": "change",
6255
6275
  "reactName": "onChange"
6256
6276
  },
6257
6277
  {
6258
- "description": "(React: onFocus) Event that gets dispatched when the card receives focus.",
6278
+ "description": "(React: onFocus) Event that gets dispatched when the checkbox receives focus.",
6259
6279
  "name": "focus",
6260
6280
  "reactName": "onFocus"
6261
6281
  }
@@ -6267,177 +6287,207 @@
6267
6287
  "text": "boolean"
6268
6288
  },
6269
6289
  "default": "false",
6270
- "description": "The checked state of the card",
6290
+ "description": "Determines whether the checkbox is selected or unselected.",
6271
6291
  "fieldName": "checked"
6272
6292
  },
6293
+ {
6294
+ "name": "indeterminate",
6295
+ "type": {
6296
+ "text": "boolean"
6297
+ },
6298
+ "default": "false",
6299
+ "description": "This property is used to determine the parent checkbox in a nested checkbox group.\nIf any one of the children is unselected, then the parent checkbox will be indeterminate.\nIf all children are either selected or unselected, then the parent checkbox will not be indeterminate.",
6300
+ "fieldName": "indeterminate"
6301
+ },
6302
+ {
6303
+ "name": "autofocus",
6304
+ "type": {
6305
+ "text": "boolean"
6306
+ },
6307
+ "default": "false",
6308
+ "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)",
6309
+ "fieldName": "autofocus"
6310
+ },
6273
6311
  {
6274
6312
  "name": "name",
6275
6313
  "type": {
6276
6314
  "text": "string"
6277
6315
  },
6278
6316
  "default": "''",
6279
- "description": "The name of the radio.",
6280
- "fieldName": "name"
6317
+ "description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
6318
+ "fieldName": "name",
6319
+ "inheritedFrom": {
6320
+ "name": "FormInternalsMixin",
6321
+ "module": "src/utils/mixins/FormInternalsMixin.ts"
6322
+ }
6281
6323
  },
6282
6324
  {
6283
- "name": "disabled",
6325
+ "name": "value",
6284
6326
  "type": {
6285
- "text": "boolean | undefined"
6327
+ "text": "string"
6286
6328
  },
6287
- "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
6288
- "default": "undefined",
6289
- "fieldName": "disabled",
6329
+ "default": "''",
6330
+ "description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
6331
+ "fieldName": "value",
6290
6332
  "inheritedFrom": {
6291
- "name": "DisabledMixin",
6292
- "module": "src/utils/mixins/DisabledMixin.ts"
6333
+ "name": "FormInternalsMixin",
6334
+ "module": "src/utils/mixins/FormInternalsMixin.ts"
6293
6335
  }
6294
6336
  },
6295
6337
  {
6296
- "name": "tabIndex",
6338
+ "name": "validation-message",
6297
6339
  "type": {
6298
- "text": "number"
6340
+ "text": "string | undefined"
6299
6341
  },
6300
- "default": "0",
6301
- "description": "This property specifies the tab order of the element.",
6302
- "fieldName": "tabIndex",
6342
+ "description": "Custom validation message that will override the default message and displayed when the input is invalid.",
6343
+ "fieldName": "validationMessage",
6303
6344
  "inheritedFrom": {
6304
- "name": "TabIndexMixin",
6305
- "module": "src/utils/mixins/TabIndexMixin.ts"
6345
+ "name": "FormInternalsMixin",
6346
+ "module": "src/utils/mixins/FormInternalsMixin.ts"
6306
6347
  }
6307
6348
  },
6308
6349
  {
6309
- "name": "card-title",
6350
+ "name": "data-aria-label",
6310
6351
  "type": {
6311
- "text": "string"
6352
+ "text": "string | null"
6312
6353
  },
6313
- "default": "''",
6314
- "description": "The title of the card - part of header section",
6315
- "fieldName": "cardTitle",
6354
+ "default": "null",
6355
+ "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
6356
+ "fieldName": "dataAriaLabel",
6316
6357
  "inheritedFrom": {
6317
- "name": "Card",
6318
- "module": "src/components/card/card.component.ts"
6358
+ "name": "DataAriaLabelMixin",
6359
+ "module": "src/utils/mixins/DataAriaLabelMixin.ts"
6319
6360
  }
6320
6361
  },
6321
6362
  {
6322
- "name": "subtitle",
6363
+ "name": "disabled",
6323
6364
  "type": {
6324
- "text": "string"
6365
+ "text": "boolean | undefined"
6325
6366
  },
6326
- "default": "''",
6327
- "description": "The subtitle of the card - part of header section",
6328
- "fieldName": "subtitle",
6367
+ "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
6368
+ "default": "undefined",
6369
+ "fieldName": "disabled",
6329
6370
  "inheritedFrom": {
6330
- "name": "Card",
6331
- "module": "src/components/card/card.component.ts"
6371
+ "name": "DisabledMixin",
6372
+ "module": "src/utils/mixins/DisabledMixin.ts"
6332
6373
  }
6333
6374
  },
6334
6375
  {
6335
- "name": "image-src",
6376
+ "name": "label",
6336
6377
  "type": {
6337
- "text": "string"
6378
+ "text": "string | undefined"
6338
6379
  },
6339
- "default": "''",
6340
- "description": "The image source URL to render on the card",
6341
- "fieldName": "imageSrc",
6380
+ "description": "The label of the input field. It is linked to the input field using the `for` attribute.",
6381
+ "fieldName": "label",
6342
6382
  "inheritedFrom": {
6343
- "name": "Card",
6344
- "module": "src/components/card/card.component.ts"
6383
+ "name": "FormfieldWrapper",
6384
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
6345
6385
  }
6346
6386
  },
6347
6387
  {
6348
- "name": "image-alt",
6388
+ "name": "required",
6389
+ "type": {
6390
+ "text": "boolean"
6391
+ },
6392
+ "default": "false",
6393
+ "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
6394
+ "fieldName": "required",
6395
+ "inheritedFrom": {
6396
+ "name": "FormfieldWrapper",
6397
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
6398
+ }
6399
+ },
6400
+ {
6401
+ "name": "id",
6349
6402
  "type": {
6350
6403
  "text": "string"
6351
6404
  },
6352
6405
  "default": "''",
6353
- "description": "The image alt for accessibility support",
6354
- "fieldName": "imageAlt",
6406
+ "description": "The unique id of the input field. It is used to link the input field with the label.",
6407
+ "fieldName": "id",
6355
6408
  "inheritedFrom": {
6356
- "name": "Card",
6357
- "module": "src/components/card/card.component.ts"
6409
+ "name": "FormfieldWrapper",
6410
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
6358
6411
  }
6359
6412
  },
6360
6413
  {
6361
- "name": "variant",
6414
+ "name": "help-text-type",
6362
6415
  "type": {
6363
- "text": "CardVariant"
6416
+ "text": "ValidationType"
6364
6417
  },
6365
- "description": "The variant of the card. It can either be set to 'border' or 'ghost'",
6366
- "default": "'border'",
6367
- "fieldName": "variant",
6418
+ "description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
6419
+ "fieldName": "helpTextType",
6368
6420
  "inheritedFrom": {
6369
- "name": "Card",
6370
- "module": "src/components/card/card.component.ts"
6421
+ "name": "FormfieldWrapper",
6422
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
6371
6423
  }
6372
6424
  },
6373
6425
  {
6374
- "name": "orientation",
6426
+ "name": "help-text",
6375
6427
  "type": {
6376
- "text": "CardOrientation"
6428
+ "text": "string | undefined"
6377
6429
  },
6378
- "description": "The orientation of the card. It can either be set to 'vertical' or 'horizontal'",
6379
- "default": "'vertical'",
6380
- "fieldName": "orientation",
6430
+ "description": "The help text that is displayed below the input field.",
6431
+ "fieldName": "helpText",
6381
6432
  "inheritedFrom": {
6382
- "name": "Card",
6383
- "module": "src/components/card/card.component.ts"
6433
+ "name": "FormfieldWrapper",
6434
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
6384
6435
  }
6385
6436
  },
6386
6437
  {
6387
- "name": "title-tag-name",
6438
+ "name": "toggletip-text",
6388
6439
  "type": {
6389
- "text": "TagNameType"
6440
+ "text": "string | undefined"
6390
6441
  },
6391
- "description": "The tag name for the card title. It supports all the types that `msc-text` supports",
6392
- "default": "'span'",
6393
- "fieldName": "titleTagName",
6442
+ "description": "The toggletip text that is displayed when the label is hovered.\nIt is used to provide additional information about the label.",
6443
+ "fieldName": "toggletipText",
6394
6444
  "inheritedFrom": {
6395
- "name": "Card",
6396
- "module": "src/components/card/card.component.ts"
6445
+ "name": "FormfieldWrapper",
6446
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
6397
6447
  }
6398
6448
  },
6399
6449
  {
6400
- "name": "subtitle-tag-name",
6450
+ "name": "toggletip-placement",
6401
6451
  "type": {
6402
- "text": "TagNameType"
6452
+ "text": "PopoverPlacement"
6403
6453
  },
6404
- "description": "The tag name for the subtitle. It supports all the types that `msc-text` supports",
6405
- "default": "'span'",
6406
- "fieldName": "subtitleTagName",
6454
+ "description": "The placement of the toggletip that is displayed when the info icon is hovered.",
6455
+ "default": "'top'",
6456
+ "fieldName": "toggletipPlacement",
6407
6457
  "inheritedFrom": {
6408
- "name": "Card",
6409
- "module": "src/components/card/card.component.ts"
6458
+ "name": "FormfieldWrapper",
6459
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
6410
6460
  }
6411
6461
  },
6412
6462
  {
6413
- "name": "icon-name",
6463
+ "name": "info-icon-aria-label",
6414
6464
  "type": {
6415
- "text": "IconNames | undefined"
6465
+ "text": "string | undefined"
6416
6466
  },
6417
- "description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
6418
- "fieldName": "iconName",
6467
+ "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.",
6468
+ "fieldName": "infoIconAriaLabel",
6419
6469
  "inheritedFrom": {
6420
- "name": "Card",
6421
- "module": "src/components/card/card.component.ts"
6470
+ "name": "FormfieldWrapper",
6471
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
6422
6472
  }
6423
6473
  }
6424
6474
  ],
6425
6475
  "mixins": [
6426
6476
  {
6427
- "name": "DisabledMixin",
6428
- "module": "/src/utils/mixins/DisabledMixin"
6477
+ "name": "FormInternalsMixin",
6478
+ "module": "/src/utils/mixins/FormInternalsMixin"
6429
6479
  },
6430
6480
  {
6431
- "name": "TabIndexMixin",
6432
- "module": "/src/utils/mixins/TabIndexMixin"
6481
+ "name": "DataAriaLabelMixin",
6482
+ "module": "/src/utils/mixins/DataAriaLabelMixin"
6433
6483
  }
6434
6484
  ],
6435
6485
  "superclass": {
6436
- "name": "Card",
6437
- "module": "/src/components/card/card.component"
6486
+ "name": "FormfieldWrapper",
6487
+ "module": "/src/components/formfieldwrapper/formfieldwrapper.component"
6438
6488
  },
6439
- "tagName": "mdc-cardradio",
6440
- "jsDoc": "/**\n * cardradio component extends `mdc-card` and supports radio selection interaction addtionally.\n *\n * While using this component within a form or group of cards, make sure cards are in a role = \"radio-group\".\n * This card would have events for selected and unselected (similar to radio)\n *\n * **Note**: This is a single selection card i.e. interacting anywhere on the card would toggle the checked state.\n * Make sure to pass only non-interactable elements within the slots.\n *\n * Make sure to pass the `card-title` mandatorily for this card.\n *\n * @tagname mdc-cardradio\n *\n * @dependency mdc-icon\n * @dependency mdc-staticradio\n * @dependency mdc-text\n *\n * @slot before-body - This slot is for passing the content before the body\n * @slot body - This slot is for passing the text content for the card\n * @slot after-body - This slot is for passing the content after the body\n *\n * @event click - (React: onClick) Event that gets dispatched when the card is clicked. It toggles the checked state.\n * @event keydown - (React: onKeyDown) This event is dispatched when a key is pressed down on the card.\n * It toggles the checked state when enter key is used.\n * @event keyup - (React: onKeyUp) This event is dispatched when a key is released on the card.\n * It toggles the checked state when space key is used.\n * @event change - (React: onChange) Event that gets dispatched when the card state changes.\n * @event focus - (React: onFocus) Event that gets dispatched when the card receives focus.\n *\n */",
6489
+ "tagName": "mdc-checkbox",
6490
+ "jsDoc": "/**\n * Checkboxes allow users to select multiple options from a list or turn an item/feature on or off.\n * These are often used in forms, settings, and selections in lists.\n *\n * A checkbox component contains an optional label and an optional helper text.\n *\n * To create a group of checkboxes, use the FormFieldGroup component.\n *\n * @dependency mdc-button\n * @dependency mdc-icon\n * @dependency mdc-staticcheckbox\n * @dependency mdc-text\n * @dependency mdc-toggletip\n *\n * @tagname mdc-checkbox\n *\n * @event change - (React: onChange) Event that gets dispatched when the checkbox state changes.\n * @event focus - (React: onFocus) Event that gets dispatched when the checkbox receives focus.\n *\n * @cssproperty --mdc-checkbox-background-color-hover - Allows customization of the background color on hover.\n * @cssproperty --mdc-checkbox-checked-background-color-hover - Background color for a selected checkbox when hovered.\n * @cssproperty --mdc-checkbox-checked-pressed-icon-color - Background color for a selected checkbox when pressed.\n * @cssproperty --mdc-checkbox-pressed-icon-color - Background color for a selected checkbox when pressed.\n * @cssproperty --mdc-checkbox-disabled-checked-icon-color - Background color for a selected checkbox when disabled.\n */",
6441
6491
  "customElement": true
6442
6492
  }
6443
6493
  ],
@@ -6446,40 +6496,76 @@
6446
6496
  "kind": "js",
6447
6497
  "name": "default",
6448
6498
  "declaration": {
6449
- "name": "CardRadio",
6450
- "module": "components/cardradio/cardradio.component.js"
6499
+ "name": "Checkbox",
6500
+ "module": "components/checkbox/checkbox.component.js"
6451
6501
  }
6452
6502
  }
6453
6503
  ]
6454
6504
  },
6455
6505
  {
6456
6506
  "kind": "javascript-module",
6457
- "path": "components/checkbox/checkbox.component.js",
6507
+ "path": "components/cardradio/cardradio.component.js",
6458
6508
  "declarations": [
6459
6509
  {
6460
6510
  "kind": "class",
6461
- "description": "Checkboxes allow users to select multiple options from a list or turn an item/feature on or off.\nThese are often used in forms, settings, and selections in lists.\n\nA checkbox component contains an optional label and an optional helper text.\n\nTo create a group of checkboxes, use the FormFieldGroup component.",
6462
- "name": "Checkbox",
6463
- "cssProperties": [
6511
+ "description": "cardradio component extends `mdc-card` and supports radio selection interaction addtionally.\n\nWhile using this component within a form or group of cards, make sure cards are in a role = \"radio-group\".\nThis card would have events for selected and unselected (similar to radio)\n\n**Note**: This is a single selection card i.e. interacting anywhere on the card would toggle the checked state.\nMake sure to pass only non-interactable elements within the slots.\n\nMake sure to pass the `card-title` mandatorily for this card.",
6512
+ "name": "CardRadio",
6513
+ "slots": [
6464
6514
  {
6465
- "description": "Allows customization of the background color on hover.",
6466
- "name": "--mdc-checkbox-background-color-hover"
6515
+ "description": "This slot is for passing the content before the body",
6516
+ "name": "before-body",
6517
+ "inheritedFrom": {
6518
+ "name": "Card",
6519
+ "module": "src/components/card/card.component.ts"
6520
+ }
6467
6521
  },
6468
6522
  {
6469
- "description": "Background color for a selected checkbox when hovered.",
6470
- "name": "--mdc-checkbox-checked-background-color-hover"
6523
+ "description": "This slot is for passing the text content for the card",
6524
+ "name": "body",
6525
+ "inheritedFrom": {
6526
+ "name": "Card",
6527
+ "module": "src/components/card/card.component.ts"
6528
+ }
6471
6529
  },
6472
6530
  {
6473
- "description": "Background color for a selected checkbox when pressed.",
6474
- "name": "--mdc-checkbox-checked-pressed-icon-color"
6531
+ "description": "This slot is for passing the content after the body",
6532
+ "name": "after-body",
6533
+ "inheritedFrom": {
6534
+ "name": "Card",
6535
+ "module": "src/components/card/card.component.ts"
6536
+ }
6475
6537
  },
6476
6538
  {
6477
- "description": "Background color for a selected checkbox when pressed.",
6478
- "name": "--mdc-checkbox-pressed-icon-color"
6539
+ "description": "This slot is for passing `mdc-link` component within the footer section.",
6540
+ "name": "footer-link",
6541
+ "inheritedFrom": {
6542
+ "name": "Card",
6543
+ "module": "src/components/card/card.component.ts"
6544
+ }
6479
6545
  },
6480
6546
  {
6481
- "description": "Background color for a selected checkbox when disabled.",
6482
- "name": "--mdc-checkbox-disabled-checked-icon-color"
6547
+ "description": "This slot is for passing primary variant of `mdc-button` component within the footer section.",
6548
+ "name": "footer-button-primary",
6549
+ "inheritedFrom": {
6550
+ "name": "Card",
6551
+ "module": "src/components/card/card.component.ts"
6552
+ }
6553
+ },
6554
+ {
6555
+ "description": "This slot is for passing secondary variant of `mdc-button` component within the footer section.",
6556
+ "name": "footer-button-secondary",
6557
+ "inheritedFrom": {
6558
+ "name": "Card",
6559
+ "module": "src/components/card/card.component.ts"
6560
+ }
6561
+ },
6562
+ {
6563
+ "description": " This slot is for passing custom footer content. Only use this if really needed, using the footer-link and footer-button slots is preferred.",
6564
+ "name": "footer",
6565
+ "inheritedFrom": {
6566
+ "name": "Card",
6567
+ "module": "src/components/card/card.component.ts"
6568
+ }
6483
6569
  }
6484
6570
  ],
6485
6571
  "members": [
@@ -6490,59 +6576,45 @@
6490
6576
  "text": "boolean"
6491
6577
  },
6492
6578
  "default": "false",
6493
- "description": "Determines whether the checkbox is selected or unselected.",
6579
+ "description": "The checked state of the card",
6494
6580
  "attribute": "checked",
6495
6581
  "reflects": true
6496
6582
  },
6497
6583
  {
6498
6584
  "kind": "field",
6499
- "name": "indeterminate",
6500
- "type": {
6501
- "text": "boolean"
6502
- },
6503
- "default": "false",
6504
- "description": "This property is used to determine the parent checkbox in a nested checkbox group.\nIf any one of the children is unselected, then the parent checkbox will be indeterminate.\nIf all children are either selected or unselected, then the parent checkbox will not be indeterminate.",
6505
- "attribute": "indeterminate",
6506
- "reflects": true
6507
- },
6508
- {
6509
- "kind": "field",
6510
- "name": "autofocus",
6585
+ "name": "name",
6511
6586
  "type": {
6512
- "text": "boolean"
6587
+ "text": "string"
6513
6588
  },
6514
- "default": "false",
6515
- "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)",
6516
- "attribute": "autofocus",
6517
- "reflects": true
6518
- },
6519
- {
6520
- "kind": "method",
6521
- "name": "setFormValue",
6522
- "privacy": "private",
6523
- "description": "Updates the form value to reflect the current state of the checkbox.\nIf checked, the value is set to either the user-provided value or 'on' if no value is provided.\nIf unchecked, the value is set to null."
6589
+ "default": "''",
6590
+ "description": "The name of the radio.",
6591
+ "attribute": "name"
6524
6592
  },
6525
6593
  {
6526
6594
  "kind": "method",
6527
- "name": "manageRequired",
6595
+ "name": "getAllCardsWithinSameGroup",
6528
6596
  "privacy": "private",
6529
- "description": "Manages the required state of the checkbox.\nIf the checkbox is not checked and the required property is set, then the checkbox is invalid."
6597
+ "return": {
6598
+ "type": {
6599
+ "text": "CardRadio[]"
6600
+ }
6601
+ },
6602
+ "description": "Returns all cards within the same group (name)."
6530
6603
  },
6531
6604
  {
6532
6605
  "kind": "method",
6533
- "name": "toggleState",
6606
+ "name": "toggleChecked",
6534
6607
  "privacy": "private",
6535
6608
  "return": {
6536
6609
  "type": {
6537
6610
  "text": "void"
6538
6611
  }
6539
6612
  },
6540
- "description": "Toggles the state of the checkbox element.\nIf the element is not disabled, then\nthe checked property is toggled and the indeterminate property is set to false."
6613
+ "description": "Handles the change event on the radio element.\nThis will toggle the state of the radio element.\nDispatches the change event."
6541
6614
  },
6542
6615
  {
6543
6616
  "kind": "method",
6544
- "name": "handleKeyDown",
6545
- "privacy": "private",
6617
+ "name": "setDisabled",
6546
6618
  "return": {
6547
6619
  "type": {
6548
6620
  "text": "void"
@@ -6550,19 +6622,17 @@
6550
6622
  },
6551
6623
  "parameters": [
6552
6624
  {
6553
- "name": "event",
6625
+ "name": "disabled",
6554
6626
  "type": {
6555
- "text": "KeyboardEvent"
6556
- },
6557
- "description": "The keyboard event."
6627
+ "text": "boolean"
6628
+ }
6558
6629
  }
6559
- ],
6560
- "description": "Handles the keydown event on the checkbox.\nWhen the user presses Enter, the form is submitted."
6630
+ ]
6561
6631
  },
6562
6632
  {
6563
6633
  "kind": "method",
6564
- "name": "handleChange",
6565
- "privacy": "public",
6634
+ "name": "updateCardRadio",
6635
+ "privacy": "private",
6566
6636
  "return": {
6567
6637
  "type": {
6568
6638
  "text": "void"
@@ -6570,352 +6640,312 @@
6570
6640
  },
6571
6641
  "parameters": [
6572
6642
  {
6573
- "name": "event",
6643
+ "name": "cards",
6574
6644
  "type": {
6575
- "text": "Event"
6645
+ "text": "CardRadio[]"
6646
+ }
6647
+ },
6648
+ {
6649
+ "name": "index",
6650
+ "type": {
6651
+ "text": "number"
6576
6652
  }
6577
6653
  }
6578
- ],
6579
- "description": "Toggles the state of the checkbox element.\nand dispatch the new change event."
6580
- },
6581
- {
6582
- "kind": "field",
6583
- "name": "renderLabelAndHelperText",
6584
- "privacy": "private"
6585
- },
6586
- {
6587
- "kind": "field",
6588
- "name": "name",
6589
- "type": {
6590
- "text": "string"
6591
- },
6592
- "default": "''",
6593
- "description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
6594
- "attribute": "name",
6595
- "reflects": true,
6596
- "inheritedFrom": {
6597
- "name": "FormInternalsMixin",
6598
- "module": "utils/mixins/FormInternalsMixin.js"
6599
- }
6600
- },
6601
- {
6602
- "kind": "field",
6603
- "name": "value",
6604
- "type": {
6605
- "text": "string"
6606
- },
6607
- "default": "''",
6608
- "description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
6609
- "attribute": "value",
6610
- "reflects": true,
6611
- "inheritedFrom": {
6612
- "name": "FormInternalsMixin",
6613
- "module": "utils/mixins/FormInternalsMixin.js"
6614
- }
6615
- },
6616
- {
6617
- "kind": "field",
6618
- "name": "validationMessage",
6619
- "type": {
6620
- "text": "string | undefined"
6621
- },
6622
- "description": "Custom validation message that will override the default message and displayed when the input is invalid.",
6623
- "attribute": "validation-message",
6624
- "reflects": true,
6625
- "inheritedFrom": {
6626
- "name": "FormInternalsMixin",
6627
- "module": "utils/mixins/FormInternalsMixin.js"
6628
- }
6629
- },
6630
- {
6631
- "kind": "field",
6632
- "name": "validity",
6633
- "type": {
6634
- "text": "ValidityState"
6635
- },
6636
- "readonly": true,
6637
- "inheritedFrom": {
6638
- "name": "FormInternalsMixin",
6639
- "module": "utils/mixins/FormInternalsMixin.js"
6640
- }
6654
+ ]
6641
6655
  },
6642
6656
  {
6643
- "kind": "field",
6644
- "name": "willValidate",
6645
- "readonly": true,
6646
- "inheritedFrom": {
6647
- "name": "FormInternalsMixin",
6648
- "module": "utils/mixins/FormInternalsMixin.js"
6649
- }
6657
+ "kind": "method",
6658
+ "name": "toggleOnEnter",
6659
+ "privacy": "private",
6660
+ "parameters": [
6661
+ {
6662
+ "name": "event",
6663
+ "type": {
6664
+ "text": "KeyboardEvent"
6665
+ },
6666
+ "description": "The keyboard event"
6667
+ }
6668
+ ],
6669
+ "description": "Toggles the checked state when enter key is used"
6650
6670
  },
6651
6671
  {
6652
6672
  "kind": "method",
6653
- "name": "setValidity",
6654
- "description": "Sets the validity of the input field based on the input field's validity.",
6655
- "return": {
6656
- "type": {
6657
- "text": ""
6673
+ "name": "toggleOnSpace",
6674
+ "privacy": "private",
6675
+ "parameters": [
6676
+ {
6677
+ "name": "event",
6678
+ "type": {
6679
+ "text": "KeyboardEvent"
6680
+ },
6681
+ "description": "The keyboard event"
6658
6682
  }
6659
- },
6660
- "inheritedFrom": {
6661
- "name": "FormInternalsMixin",
6662
- "module": "utils/mixins/FormInternalsMixin.js"
6663
- }
6683
+ ],
6684
+ "description": "Toggles the checked state when space key is used"
6664
6685
  },
6665
6686
  {
6666
6687
  "kind": "method",
6667
- "name": "checkValidity",
6688
+ "name": "renderHeader",
6689
+ "privacy": "protected",
6690
+ "description": "Renders the header of the card",
6668
6691
  "return": {
6669
6692
  "type": {
6670
- "text": "boolean"
6693
+ "text": ""
6671
6694
  }
6672
6695
  },
6673
6696
  "inheritedFrom": {
6674
- "name": "FormInternalsMixin",
6675
- "module": "utils/mixins/FormInternalsMixin.js"
6697
+ "name": "Card",
6698
+ "module": "components/card/card.component.js"
6676
6699
  }
6677
6700
  },
6678
6701
  {
6679
- "kind": "method",
6680
- "name": "reportValidity",
6702
+ "kind": "field",
6703
+ "name": "disabled",
6704
+ "type": {
6705
+ "text": "boolean | undefined"
6706
+ },
6707
+ "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
6708
+ "default": "undefined",
6709
+ "attribute": "disabled",
6710
+ "reflects": true,
6681
6711
  "inheritedFrom": {
6682
- "name": "FormInternalsMixin",
6683
- "module": "utils/mixins/FormInternalsMixin.js"
6712
+ "name": "DisabledMixin",
6713
+ "module": "utils/mixins/DisabledMixin.js"
6684
6714
  }
6685
6715
  },
6686
6716
  {
6687
6717
  "kind": "field",
6688
- "name": "dataAriaLabel",
6718
+ "name": "tabIndex",
6689
6719
  "type": {
6690
- "text": "string | null"
6720
+ "text": "number"
6691
6721
  },
6692
- "default": "null",
6693
- "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
6694
- "attribute": "data-aria-label",
6722
+ "default": "0",
6723
+ "description": "This property specifies the tab order of the element.",
6724
+ "attribute": "tabIndex",
6695
6725
  "reflects": true,
6696
6726
  "inheritedFrom": {
6697
- "name": "DataAriaLabelMixin",
6698
- "module": "utils/mixins/DataAriaLabelMixin.js"
6727
+ "name": "TabIndexMixin",
6728
+ "module": "utils/mixins/TabIndexMixin.js"
6699
6729
  }
6700
6730
  },
6701
6731
  {
6702
6732
  "kind": "field",
6703
- "name": "disabled",
6733
+ "name": "cardTitle",
6704
6734
  "type": {
6705
- "text": "boolean | undefined"
6735
+ "text": "string"
6706
6736
  },
6707
- "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
6708
- "default": "undefined",
6709
- "attribute": "disabled",
6737
+ "default": "''",
6738
+ "description": "The title of the card - part of header section",
6739
+ "attribute": "card-title",
6710
6740
  "reflects": true,
6711
6741
  "inheritedFrom": {
6712
- "name": "DisabledMixin",
6713
- "module": "utils/mixins/DisabledMixin.js"
6742
+ "name": "Card",
6743
+ "module": "components/card/card.component.js"
6714
6744
  }
6715
6745
  },
6716
6746
  {
6717
6747
  "kind": "field",
6718
- "name": "label",
6748
+ "name": "subtitle",
6719
6749
  "type": {
6720
- "text": "string | undefined"
6750
+ "text": "string"
6721
6751
  },
6722
- "description": "The label of the input field. It is linked to the input field using the `for` attribute.",
6723
- "attribute": "label",
6752
+ "default": "''",
6753
+ "description": "The subtitle of the card - part of header section",
6754
+ "attribute": "subtitle",
6724
6755
  "reflects": true,
6725
6756
  "inheritedFrom": {
6726
- "name": "FormfieldWrapper",
6727
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
6757
+ "name": "Card",
6758
+ "module": "components/card/card.component.js"
6728
6759
  }
6729
6760
  },
6730
6761
  {
6731
6762
  "kind": "field",
6732
- "name": "required",
6763
+ "name": "imageSrc",
6733
6764
  "type": {
6734
- "text": "boolean"
6765
+ "text": "string"
6735
6766
  },
6736
- "default": "false",
6737
- "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
6738
- "attribute": "required",
6767
+ "default": "''",
6768
+ "description": "The image source URL to render on the card",
6769
+ "attribute": "image-src",
6739
6770
  "reflects": true,
6740
6771
  "inheritedFrom": {
6741
- "name": "FormfieldWrapper",
6742
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
6772
+ "name": "Card",
6773
+ "module": "components/card/card.component.js"
6743
6774
  }
6744
6775
  },
6745
6776
  {
6746
6777
  "kind": "field",
6747
- "name": "id",
6778
+ "name": "imageAlt",
6748
6779
  "type": {
6749
6780
  "text": "string"
6750
6781
  },
6751
6782
  "default": "''",
6752
- "description": "The unique id of the input field. It is used to link the input field with the label.",
6753
- "attribute": "id",
6783
+ "description": "The image alt for accessibility support",
6784
+ "attribute": "image-alt",
6785
+ "reflects": true,
6754
6786
  "inheritedFrom": {
6755
- "name": "FormfieldWrapper",
6756
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
6787
+ "name": "Card",
6788
+ "module": "components/card/card.component.js"
6757
6789
  }
6758
6790
  },
6759
6791
  {
6760
6792
  "kind": "field",
6761
- "name": "helpTextType",
6793
+ "name": "variant",
6762
6794
  "type": {
6763
- "text": "ValidationType"
6795
+ "text": "CardVariant"
6764
6796
  },
6765
- "description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
6766
- "attribute": "help-text-type",
6797
+ "description": "The variant of the card. It can either be set to 'border' or 'ghost'",
6798
+ "default": "'border'",
6799
+ "attribute": "variant",
6767
6800
  "reflects": true,
6768
6801
  "inheritedFrom": {
6769
- "name": "FormfieldWrapper",
6770
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
6802
+ "name": "Card",
6803
+ "module": "components/card/card.component.js"
6771
6804
  }
6772
6805
  },
6773
6806
  {
6774
6807
  "kind": "field",
6775
- "name": "helpText",
6808
+ "name": "orientation",
6776
6809
  "type": {
6777
- "text": "string | undefined"
6810
+ "text": "CardOrientation"
6778
6811
  },
6779
- "description": "The help text that is displayed below the input field.",
6780
- "attribute": "help-text",
6812
+ "description": "The orientation of the card. It can either be set to 'vertical' or 'horizontal'",
6813
+ "default": "'vertical'",
6814
+ "attribute": "orientation",
6781
6815
  "reflects": true,
6782
6816
  "inheritedFrom": {
6783
- "name": "FormfieldWrapper",
6784
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
6817
+ "name": "Card",
6818
+ "module": "components/card/card.component.js"
6785
6819
  }
6786
6820
  },
6787
6821
  {
6788
6822
  "kind": "field",
6789
- "name": "toggletipText",
6823
+ "name": "titleTagName",
6790
6824
  "type": {
6791
- "text": "string | undefined"
6825
+ "text": "TagNameType"
6792
6826
  },
6793
- "description": "The toggletip text that is displayed when the label is hovered.\nIt is used to provide additional information about the label.",
6794
- "attribute": "toggletip-text",
6827
+ "description": "The tag name for the card title. It supports all the types that `msc-text` supports",
6828
+ "default": "'span'",
6829
+ "attribute": "title-tag-name",
6795
6830
  "reflects": true,
6796
6831
  "inheritedFrom": {
6797
- "name": "FormfieldWrapper",
6798
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
6832
+ "name": "Card",
6833
+ "module": "components/card/card.component.js"
6799
6834
  }
6800
6835
  },
6801
6836
  {
6802
6837
  "kind": "field",
6803
- "name": "toggletipPlacement",
6838
+ "name": "subtitleTagName",
6804
6839
  "type": {
6805
- "text": "PopoverPlacement"
6840
+ "text": "TagNameType"
6806
6841
  },
6807
- "description": "The placement of the toggletip that is displayed when the info icon is hovered.",
6808
- "default": "'top'",
6809
- "attribute": "toggletip-placement",
6842
+ "description": "The tag name for the subtitle. It supports all the types that `msc-text` supports",
6843
+ "default": "'span'",
6844
+ "attribute": "subtitle-tag-name",
6810
6845
  "reflects": true,
6811
6846
  "inheritedFrom": {
6812
- "name": "FormfieldWrapper",
6813
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
6847
+ "name": "Card",
6848
+ "module": "components/card/card.component.js"
6814
6849
  }
6815
6850
  },
6816
6851
  {
6817
6852
  "kind": "field",
6818
- "name": "infoIconAriaLabel",
6853
+ "name": "iconName",
6819
6854
  "type": {
6820
- "text": "string | undefined"
6855
+ "text": "IconNames | undefined"
6821
6856
  },
6822
- "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.",
6823
- "attribute": "info-icon-aria-label",
6857
+ "description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
6858
+ "attribute": "icon-name",
6824
6859
  "reflects": true,
6825
6860
  "inheritedFrom": {
6826
- "name": "FormfieldWrapper",
6827
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
6828
- }
6829
- },
6830
- {
6831
- "kind": "method",
6832
- "name": "renderLabelElement",
6833
- "privacy": "protected",
6834
- "description": "creates the label element when the label property is set.\nid is used to link the label with the input field.",
6835
- "return": {
6836
- "type": {
6837
- "text": ""
6838
- }
6839
- },
6840
- "inheritedFrom": {
6841
- "name": "FormfieldWrapper",
6842
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
6861
+ "name": "Card",
6862
+ "module": "components/card/card.component.js"
6843
6863
  }
6844
6864
  },
6845
6865
  {
6846
6866
  "kind": "method",
6847
- "name": "renderHelpTextIcon",
6867
+ "name": "renderImage",
6848
6868
  "privacy": "protected",
6849
- "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.",
6869
+ "description": "Renders the image on the card if image source is provided",
6850
6870
  "return": {
6851
6871
  "type": {
6852
6872
  "text": ""
6853
6873
  }
6854
6874
  },
6855
6875
  "inheritedFrom": {
6856
- "name": "FormfieldWrapper",
6857
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
6876
+ "name": "Card",
6877
+ "module": "components/card/card.component.js"
6858
6878
  }
6859
6879
  },
6860
6880
  {
6861
6881
  "kind": "method",
6862
- "name": "renderHelpText",
6882
+ "name": "renderIcon",
6863
6883
  "privacy": "protected",
6864
- "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.",
6884
+ "description": "Renders the icon on the card if icon name is provided",
6865
6885
  "return": {
6866
6886
  "type": {
6867
6887
  "text": ""
6868
6888
  }
6869
6889
  },
6870
6890
  "inheritedFrom": {
6871
- "name": "FormfieldWrapper",
6872
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
6891
+ "name": "Card",
6892
+ "module": "components/card/card.component.js"
6873
6893
  }
6874
6894
  },
6875
6895
  {
6876
6896
  "kind": "method",
6877
- "name": "renderLabel",
6897
+ "name": "renderTitle",
6878
6898
  "privacy": "protected",
6879
- "description": "renders the mdc-label-text container that contains the label and labelInfoToggleTip.",
6899
+ "description": "Renders the title and subtitle on the card",
6880
6900
  "return": {
6881
6901
  "type": {
6882
6902
  "text": ""
6883
6903
  }
6884
6904
  },
6885
6905
  "inheritedFrom": {
6886
- "name": "FormfieldWrapper",
6887
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
6906
+ "name": "Card",
6907
+ "module": "components/card/card.component.js"
6888
6908
  }
6889
6909
  },
6890
6910
  {
6891
6911
  "kind": "method",
6892
- "name": "renderHelperText",
6912
+ "name": "renderFooter",
6893
6913
  "privacy": "protected",
6894
- "description": "renders the mdc-help-text container that contains the helpertext icon and helpertext.",
6914
+ "description": "Renders the footer of the card if footer-link,\nfooter-button-primary, or footer-button-secondary slots are provided",
6895
6915
  "return": {
6896
6916
  "type": {
6897
6917
  "text": ""
6898
6918
  }
6899
6919
  },
6900
6920
  "inheritedFrom": {
6901
- "name": "FormfieldWrapper",
6902
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
6921
+ "name": "Card",
6922
+ "module": "components/card/card.component.js"
6903
6923
  }
6904
6924
  }
6905
6925
  ],
6906
6926
  "events": [
6907
6927
  {
6908
- "type": {
6909
- "text": "EventConstructor"
6910
- }
6928
+ "description": "(React: onClick) Event that gets dispatched when the card is clicked. It toggles the checked state.",
6929
+ "name": "click",
6930
+ "reactName": "onClick"
6911
6931
  },
6912
6932
  {
6913
- "description": "(React: onChange) Event that gets dispatched when the checkbox state changes.",
6933
+ "description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the card. It toggles the checked state when enter key is used.",
6934
+ "name": "keydown",
6935
+ "reactName": "onKeyDown"
6936
+ },
6937
+ {
6938
+ "description": "(React: onKeyUp) This event is dispatched when a key is released on the card. It toggles the checked state when space key is used.",
6939
+ "name": "keyup",
6940
+ "reactName": "onKeyUp"
6941
+ },
6942
+ {
6943
+ "description": "(React: onChange) Event that gets dispatched when the card state changes.",
6914
6944
  "name": "change",
6915
6945
  "reactName": "onChange"
6916
6946
  },
6917
6947
  {
6918
- "description": "(React: onFocus) Event that gets dispatched when the checkbox receives focus.",
6948
+ "description": "(React: onFocus) Event that gets dispatched when the card receives focus.",
6919
6949
  "name": "focus",
6920
6950
  "reactName": "onFocus"
6921
6951
  }
@@ -6927,207 +6957,177 @@
6927
6957
  "text": "boolean"
6928
6958
  },
6929
6959
  "default": "false",
6930
- "description": "Determines whether the checkbox is selected or unselected.",
6960
+ "description": "The checked state of the card",
6931
6961
  "fieldName": "checked"
6932
6962
  },
6933
- {
6934
- "name": "indeterminate",
6935
- "type": {
6936
- "text": "boolean"
6937
- },
6938
- "default": "false",
6939
- "description": "This property is used to determine the parent checkbox in a nested checkbox group.\nIf any one of the children is unselected, then the parent checkbox will be indeterminate.\nIf all children are either selected or unselected, then the parent checkbox will not be indeterminate.",
6940
- "fieldName": "indeterminate"
6941
- },
6942
- {
6943
- "name": "autofocus",
6944
- "type": {
6945
- "text": "boolean"
6946
- },
6947
- "default": "false",
6948
- "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)",
6949
- "fieldName": "autofocus"
6950
- },
6951
6963
  {
6952
6964
  "name": "name",
6953
6965
  "type": {
6954
6966
  "text": "string"
6955
6967
  },
6956
6968
  "default": "''",
6957
- "description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
6958
- "fieldName": "name",
6959
- "inheritedFrom": {
6960
- "name": "FormInternalsMixin",
6961
- "module": "src/utils/mixins/FormInternalsMixin.ts"
6962
- }
6963
- },
6964
- {
6965
- "name": "value",
6966
- "type": {
6967
- "text": "string"
6968
- },
6969
- "default": "''",
6970
- "description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
6971
- "fieldName": "value",
6972
- "inheritedFrom": {
6973
- "name": "FormInternalsMixin",
6974
- "module": "src/utils/mixins/FormInternalsMixin.ts"
6975
- }
6969
+ "description": "The name of the radio.",
6970
+ "fieldName": "name"
6976
6971
  },
6977
6972
  {
6978
- "name": "validation-message",
6973
+ "name": "disabled",
6979
6974
  "type": {
6980
- "text": "string | undefined"
6975
+ "text": "boolean | undefined"
6981
6976
  },
6982
- "description": "Custom validation message that will override the default message and displayed when the input is invalid.",
6983
- "fieldName": "validationMessage",
6977
+ "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
6978
+ "default": "undefined",
6979
+ "fieldName": "disabled",
6984
6980
  "inheritedFrom": {
6985
- "name": "FormInternalsMixin",
6986
- "module": "src/utils/mixins/FormInternalsMixin.ts"
6981
+ "name": "DisabledMixin",
6982
+ "module": "src/utils/mixins/DisabledMixin.ts"
6987
6983
  }
6988
6984
  },
6989
6985
  {
6990
- "name": "data-aria-label",
6986
+ "name": "tabIndex",
6991
6987
  "type": {
6992
- "text": "string | null"
6988
+ "text": "number"
6993
6989
  },
6994
- "default": "null",
6995
- "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
6996
- "fieldName": "dataAriaLabel",
6990
+ "default": "0",
6991
+ "description": "This property specifies the tab order of the element.",
6992
+ "fieldName": "tabIndex",
6997
6993
  "inheritedFrom": {
6998
- "name": "DataAriaLabelMixin",
6999
- "module": "src/utils/mixins/DataAriaLabelMixin.ts"
6994
+ "name": "TabIndexMixin",
6995
+ "module": "src/utils/mixins/TabIndexMixin.ts"
7000
6996
  }
7001
6997
  },
7002
6998
  {
7003
- "name": "disabled",
6999
+ "name": "card-title",
7004
7000
  "type": {
7005
- "text": "boolean | undefined"
7001
+ "text": "string"
7006
7002
  },
7007
- "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
7008
- "default": "undefined",
7009
- "fieldName": "disabled",
7003
+ "default": "''",
7004
+ "description": "The title of the card - part of header section",
7005
+ "fieldName": "cardTitle",
7010
7006
  "inheritedFrom": {
7011
- "name": "DisabledMixin",
7012
- "module": "src/utils/mixins/DisabledMixin.ts"
7007
+ "name": "Card",
7008
+ "module": "src/components/card/card.component.ts"
7013
7009
  }
7014
7010
  },
7015
7011
  {
7016
- "name": "label",
7012
+ "name": "subtitle",
7017
7013
  "type": {
7018
- "text": "string | undefined"
7014
+ "text": "string"
7019
7015
  },
7020
- "description": "The label of the input field. It is linked to the input field using the `for` attribute.",
7021
- "fieldName": "label",
7016
+ "default": "''",
7017
+ "description": "The subtitle of the card - part of header section",
7018
+ "fieldName": "subtitle",
7022
7019
  "inheritedFrom": {
7023
- "name": "FormfieldWrapper",
7024
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
7020
+ "name": "Card",
7021
+ "module": "src/components/card/card.component.ts"
7025
7022
  }
7026
7023
  },
7027
7024
  {
7028
- "name": "required",
7025
+ "name": "image-src",
7029
7026
  "type": {
7030
- "text": "boolean"
7027
+ "text": "string"
7031
7028
  },
7032
- "default": "false",
7033
- "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
7034
- "fieldName": "required",
7029
+ "default": "''",
7030
+ "description": "The image source URL to render on the card",
7031
+ "fieldName": "imageSrc",
7035
7032
  "inheritedFrom": {
7036
- "name": "FormfieldWrapper",
7037
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
7033
+ "name": "Card",
7034
+ "module": "src/components/card/card.component.ts"
7038
7035
  }
7039
7036
  },
7040
7037
  {
7041
- "name": "id",
7038
+ "name": "image-alt",
7042
7039
  "type": {
7043
7040
  "text": "string"
7044
7041
  },
7045
7042
  "default": "''",
7046
- "description": "The unique id of the input field. It is used to link the input field with the label.",
7047
- "fieldName": "id",
7043
+ "description": "The image alt for accessibility support",
7044
+ "fieldName": "imageAlt",
7048
7045
  "inheritedFrom": {
7049
- "name": "FormfieldWrapper",
7050
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
7046
+ "name": "Card",
7047
+ "module": "src/components/card/card.component.ts"
7051
7048
  }
7052
7049
  },
7053
7050
  {
7054
- "name": "help-text-type",
7051
+ "name": "variant",
7055
7052
  "type": {
7056
- "text": "ValidationType"
7053
+ "text": "CardVariant"
7057
7054
  },
7058
- "description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
7059
- "fieldName": "helpTextType",
7055
+ "description": "The variant of the card. It can either be set to 'border' or 'ghost'",
7056
+ "default": "'border'",
7057
+ "fieldName": "variant",
7060
7058
  "inheritedFrom": {
7061
- "name": "FormfieldWrapper",
7062
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
7059
+ "name": "Card",
7060
+ "module": "src/components/card/card.component.ts"
7063
7061
  }
7064
7062
  },
7065
7063
  {
7066
- "name": "help-text",
7064
+ "name": "orientation",
7067
7065
  "type": {
7068
- "text": "string | undefined"
7066
+ "text": "CardOrientation"
7069
7067
  },
7070
- "description": "The help text that is displayed below the input field.",
7071
- "fieldName": "helpText",
7068
+ "description": "The orientation of the card. It can either be set to 'vertical' or 'horizontal'",
7069
+ "default": "'vertical'",
7070
+ "fieldName": "orientation",
7072
7071
  "inheritedFrom": {
7073
- "name": "FormfieldWrapper",
7074
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
7072
+ "name": "Card",
7073
+ "module": "src/components/card/card.component.ts"
7075
7074
  }
7076
7075
  },
7077
7076
  {
7078
- "name": "toggletip-text",
7077
+ "name": "title-tag-name",
7079
7078
  "type": {
7080
- "text": "string | undefined"
7079
+ "text": "TagNameType"
7081
7080
  },
7082
- "description": "The toggletip text that is displayed when the label is hovered.\nIt is used to provide additional information about the label.",
7083
- "fieldName": "toggletipText",
7081
+ "description": "The tag name for the card title. It supports all the types that `msc-text` supports",
7082
+ "default": "'span'",
7083
+ "fieldName": "titleTagName",
7084
7084
  "inheritedFrom": {
7085
- "name": "FormfieldWrapper",
7086
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
7085
+ "name": "Card",
7086
+ "module": "src/components/card/card.component.ts"
7087
7087
  }
7088
7088
  },
7089
7089
  {
7090
- "name": "toggletip-placement",
7090
+ "name": "subtitle-tag-name",
7091
7091
  "type": {
7092
- "text": "PopoverPlacement"
7092
+ "text": "TagNameType"
7093
7093
  },
7094
- "description": "The placement of the toggletip that is displayed when the info icon is hovered.",
7095
- "default": "'top'",
7096
- "fieldName": "toggletipPlacement",
7094
+ "description": "The tag name for the subtitle. It supports all the types that `msc-text` supports",
7095
+ "default": "'span'",
7096
+ "fieldName": "subtitleTagName",
7097
7097
  "inheritedFrom": {
7098
- "name": "FormfieldWrapper",
7099
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
7098
+ "name": "Card",
7099
+ "module": "src/components/card/card.component.ts"
7100
7100
  }
7101
7101
  },
7102
7102
  {
7103
- "name": "info-icon-aria-label",
7103
+ "name": "icon-name",
7104
7104
  "type": {
7105
- "text": "string | undefined"
7105
+ "text": "IconNames | undefined"
7106
7106
  },
7107
- "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.",
7108
- "fieldName": "infoIconAriaLabel",
7107
+ "description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
7108
+ "fieldName": "iconName",
7109
7109
  "inheritedFrom": {
7110
- "name": "FormfieldWrapper",
7111
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
7110
+ "name": "Card",
7111
+ "module": "src/components/card/card.component.ts"
7112
7112
  }
7113
7113
  }
7114
7114
  ],
7115
7115
  "mixins": [
7116
7116
  {
7117
- "name": "FormInternalsMixin",
7118
- "module": "/src/utils/mixins/FormInternalsMixin"
7117
+ "name": "DisabledMixin",
7118
+ "module": "/src/utils/mixins/DisabledMixin"
7119
7119
  },
7120
7120
  {
7121
- "name": "DataAriaLabelMixin",
7122
- "module": "/src/utils/mixins/DataAriaLabelMixin"
7121
+ "name": "TabIndexMixin",
7122
+ "module": "/src/utils/mixins/TabIndexMixin"
7123
7123
  }
7124
7124
  ],
7125
7125
  "superclass": {
7126
- "name": "FormfieldWrapper",
7127
- "module": "/src/components/formfieldwrapper/formfieldwrapper.component"
7126
+ "name": "Card",
7127
+ "module": "/src/components/card/card.component"
7128
7128
  },
7129
- "tagName": "mdc-checkbox",
7130
- "jsDoc": "/**\n * Checkboxes allow users to select multiple options from a list or turn an item/feature on or off.\n * These are often used in forms, settings, and selections in lists.\n *\n * A checkbox component contains an optional label and an optional helper text.\n *\n * To create a group of checkboxes, use the FormFieldGroup component.\n *\n * @dependency mdc-button\n * @dependency mdc-icon\n * @dependency mdc-staticcheckbox\n * @dependency mdc-text\n * @dependency mdc-toggletip\n *\n * @tagname mdc-checkbox\n *\n * @event change - (React: onChange) Event that gets dispatched when the checkbox state changes.\n * @event focus - (React: onFocus) Event that gets dispatched when the checkbox receives focus.\n *\n * @cssproperty --mdc-checkbox-background-color-hover - Allows customization of the background color on hover.\n * @cssproperty --mdc-checkbox-checked-background-color-hover - Background color for a selected checkbox when hovered.\n * @cssproperty --mdc-checkbox-checked-pressed-icon-color - Background color for a selected checkbox when pressed.\n * @cssproperty --mdc-checkbox-pressed-icon-color - Background color for a selected checkbox when pressed.\n * @cssproperty --mdc-checkbox-disabled-checked-icon-color - Background color for a selected checkbox when disabled.\n */",
7129
+ "tagName": "mdc-cardradio",
7130
+ "jsDoc": "/**\n * cardradio component extends `mdc-card` and supports radio selection interaction addtionally.\n *\n * While using this component within a form or group of cards, make sure cards are in a role = \"radio-group\".\n * This card would have events for selected and unselected (similar to radio)\n *\n * **Note**: This is a single selection card i.e. interacting anywhere on the card would toggle the checked state.\n * Make sure to pass only non-interactable elements within the slots.\n *\n * Make sure to pass the `card-title` mandatorily for this card.\n *\n * @tagname mdc-cardradio\n *\n * @dependency mdc-icon\n * @dependency mdc-staticradio\n * @dependency mdc-text\n *\n * @slot before-body - This slot is for passing the content before the body\n * @slot body - This slot is for passing the text content for the card\n * @slot after-body - This slot is for passing the content after the body\n *\n * @event click - (React: onClick) Event that gets dispatched when the card is clicked. It toggles the checked state.\n * @event keydown - (React: onKeyDown) This event is dispatched when a key is pressed down on the card.\n * It toggles the checked state when enter key is used.\n * @event keyup - (React: onKeyUp) This event is dispatched when a key is released on the card.\n * It toggles the checked state when space key is used.\n * @event change - (React: onChange) Event that gets dispatched when the card state changes.\n * @event focus - (React: onFocus) Event that gets dispatched when the card receives focus.\n *\n */",
7131
7131
  "customElement": true
7132
7132
  }
7133
7133
  ],
@@ -7136,8 +7136,8 @@
7136
7136
  "kind": "js",
7137
7137
  "name": "default",
7138
7138
  "declaration": {
7139
- "name": "Checkbox",
7140
- "module": "components/checkbox/checkbox.component.js"
7139
+ "name": "CardRadio",
7140
+ "module": "components/cardradio/cardradio.component.js"
7141
7141
  }
7142
7142
  }
7143
7143
  ]
@@ -7883,7 +7883,7 @@
7883
7883
  "text": "boolean"
7884
7884
  },
7885
7885
  "default": "true",
7886
- "description": "Determines whether focus should wrap around when reaching the first or last focusable element.\nIf true, focus will cycle from end to start and vice versa.\n\nThis only applies when `enabledFocusTrap` is true.",
7886
+ "description": "Determines whether focus should wrap around when reaching the first or last focusable element.\nIf true, focus will cycle from end to start and vice versa.\n\nThis only applies when `focusTrap` is true.",
7887
7887
  "attribute": "should-focus-trap-wrap",
7888
7888
  "reflects": true,
7889
7889
  "inheritedFrom": {
@@ -8167,7 +8167,7 @@
8167
8167
  "description": "The set of focusable elements."
8168
8168
  }
8169
8169
  ],
8170
- "description": "Recursively finds all focusable elements within the given root and its descendants.",
8170
+ "description": "Recursively finds all focusable elements within the given root and its descendants.\n\nMake sure this is performant, as it will be called multiple times.",
8171
8171
  "inheritedFrom": {
8172
8172
  "name": "FocusTrapMixin",
8173
8173
  "module": "utils/mixins/FocusTrapMixin.js"
@@ -8176,7 +8176,7 @@
8176
8176
  {
8177
8177
  "kind": "method",
8178
8178
  "name": "setFocusableElements",
8179
- "privacy": "public",
8179
+ "privacy": "private",
8180
8180
  "description": "Updates the list of focusable elements within the component's shadow root.",
8181
8181
  "inheritedFrom": {
8182
8182
  "name": "FocusTrapMixin",
@@ -8492,6 +8492,21 @@
8492
8492
  "module": "components/popover/popover.component.js"
8493
8493
  }
8494
8494
  },
8495
+ {
8496
+ "kind": "field",
8497
+ "name": "propagateEventOnEscape",
8498
+ "type": {
8499
+ "text": "boolean"
8500
+ },
8501
+ "description": "Propagates the event, when the escape key is pressed (only when pressed inside the popover)\nIf true, the escape key press close the popover and will propagate the keydown event.\nIf false, the escape key press will close the popover but will not propagate the keydown event.\n(set to false to prevent the event from bubbling up to the document).\n\nThis only works when `hideOnEscape` is true.",
8502
+ "default": "false",
8503
+ "attribute": "propagate-event-on-escape",
8504
+ "reflects": true,
8505
+ "inheritedFrom": {
8506
+ "name": "Popover",
8507
+ "module": "components/popover/popover.component.js"
8508
+ }
8509
+ },
8495
8510
  {
8496
8511
  "kind": "field",
8497
8512
  "name": "hideOnBlur",
@@ -8753,7 +8768,7 @@
8753
8768
  "kind": "field",
8754
8769
  "name": "onEscapeKeydown",
8755
8770
  "privacy": "private",
8756
- "description": "Handles the escape keydown event to close the popover.",
8771
+ "description": "Handles the escape keydown event to close the popover.\n\nThis method is attached to the document.",
8757
8772
  "parameters": [
8758
8773
  {
8759
8774
  "description": "The keyboard event.",
@@ -8984,7 +8999,7 @@
8984
8999
  "text": "boolean"
8985
9000
  },
8986
9001
  "default": "true",
8987
- "description": "Determines whether focus should wrap around when reaching the first or last focusable element.\nIf true, focus will cycle from end to start and vice versa.\n\nThis only applies when `enabledFocusTrap` is true.",
9002
+ "description": "Determines whether focus should wrap around when reaching the first or last focusable element.\nIf true, focus will cycle from end to start and vice versa.\n\nThis only applies when `focusTrap` is true.",
8988
9003
  "fieldName": "shouldFocusTrapWrap",
8989
9004
  "inheritedFrom": {
8990
9005
  "name": "FocusTrapMixin",
@@ -9147,6 +9162,19 @@
9147
9162
  "module": "src/components/popover/popover.component.ts"
9148
9163
  }
9149
9164
  },
9165
+ {
9166
+ "name": "propagate-event-on-escape",
9167
+ "type": {
9168
+ "text": "boolean"
9169
+ },
9170
+ "description": "Propagates the event, when the escape key is pressed (only when pressed inside the popover)\nIf true, the escape key press close the popover and will propagate the keydown event.\nIf false, the escape key press will close the popover but will not propagate the keydown event.\n(set to false to prevent the event from bubbling up to the document).\n\nThis only works when `hideOnEscape` is true.",
9171
+ "default": "false",
9172
+ "fieldName": "propagateEventOnEscape",
9173
+ "inheritedFrom": {
9174
+ "name": "Popover",
9175
+ "module": "src/components/popover/popover.component.ts"
9176
+ }
9177
+ },
9150
9178
  {
9151
9179
  "name": "hide-on-blur",
9152
9180
  "type": {
@@ -9623,7 +9651,7 @@
9623
9651
  "text": "boolean"
9624
9652
  },
9625
9653
  "default": "true",
9626
- "description": "Determines whether focus should wrap around when reaching the first or last focusable element.\nIf true, focus will cycle from end to start and vice versa.\n\nThis only applies when `enabledFocusTrap` is true.",
9654
+ "description": "Determines whether focus should wrap around when reaching the first or last focusable element.\nIf true, focus will cycle from end to start and vice versa.\n\nThis only applies when `focusTrap` is true.",
9627
9655
  "attribute": "should-focus-trap-wrap",
9628
9656
  "reflects": true,
9629
9657
  "inheritedFrom": {
@@ -9907,7 +9935,7 @@
9907
9935
  "description": "The set of focusable elements."
9908
9936
  }
9909
9937
  ],
9910
- "description": "Recursively finds all focusable elements within the given root and its descendants.",
9938
+ "description": "Recursively finds all focusable elements within the given root and its descendants.\n\nMake sure this is performant, as it will be called multiple times.",
9911
9939
  "inheritedFrom": {
9912
9940
  "name": "FocusTrapMixin",
9913
9941
  "module": "utils/mixins/FocusTrapMixin.js"
@@ -9916,7 +9944,7 @@
9916
9944
  {
9917
9945
  "kind": "method",
9918
9946
  "name": "setFocusableElements",
9919
- "privacy": "public",
9947
+ "privacy": "private",
9920
9948
  "description": "Updates the list of focusable elements within the component's shadow root.",
9921
9949
  "inheritedFrom": {
9922
9950
  "name": "FocusTrapMixin",
@@ -10276,7 +10304,7 @@
10276
10304
  "text": "boolean"
10277
10305
  },
10278
10306
  "default": "true",
10279
- "description": "Determines whether focus should wrap around when reaching the first or last focusable element.\nIf true, focus will cycle from end to start and vice versa.\n\nThis only applies when `enabledFocusTrap` is true.",
10307
+ "description": "Determines whether focus should wrap around when reaching the first or last focusable element.\nIf true, focus will cycle from end to start and vice versa.\n\nThis only applies when `focusTrap` is true.",
10280
10308
  "fieldName": "shouldFocusTrapWrap",
10281
10309
  "inheritedFrom": {
10282
10310
  "name": "FocusTrapMixin",
@@ -15641,13 +15669,135 @@
15641
15669
  },
15642
15670
  {
15643
15671
  "kind": "javascript-module",
15644
- "path": "components/menuitem/menuitem.component.js",
15672
+ "path": "components/menuitemcheckbox/menuitemcheckbox.component.js",
15645
15673
  "declarations": [
15646
15674
  {
15647
15675
  "kind": "class",
15648
- "description": "menuitem component is inherited by listitem component with the role set `menuitem`.<br/>\nA menu item can contain an icon on the leading or trailing side.\n\nThe leading and trailing slots can be used to display controls and text.<br/>\nBased on the leading/trailing slot, the position of the controls and text can be adjusted.\n\nPlease use mdc-menu as a parent element even when there is only menuitem for a11y purpose.",
15649
- "name": "MenuItem",
15676
+ "description": "A menuitemcheckbox component is a checkable menuitem.\nThere should be no focusable descendants inside this menuitemcheckbox component.\n\nThe `aria-checked` attribute indicates whether the menuitemcheckbox is checked or not.\n\nThe `indicator` attribute is used to differentiate between <b>checkbox</b>, <b>checkmark</b> and <b>toggle</b>.\nBy default the `indicator` is set to <b>checkbox</b>.<br/>\n\nThe checkbox will always be positioned on the leading side of the menuitem label and\nthe toggle and checkmark will always be positioned on the trailing side.\n\nThe checkbox will have the possible states of `true` or `false`.\nIf the indicator is set to <b>checkmark</b> and if the `aria-checked` attribute is set to `true`,\nthen the checkmark will be displayed. if not, then no indicator will be displayed.\n\nIf you want only one item in a group to be checked, consider using menuitemradio component.\n\nIf a menuitemcheckbox is disabled, then the `aria-disabled` attribute is set to `true`.",
15677
+ "name": "MenuItemCheckbox",
15678
+ "cssProperties": [
15679
+ {
15680
+ "description": "Allows customization of the checkmark indicator color",
15681
+ "name": "--mdc-checkmark-indicator-color"
15682
+ },
15683
+ {
15684
+ "description": "Allows customization of the default background color.",
15685
+ "name": "--mdc-listitem-default-background-color",
15686
+ "inheritedFrom": {
15687
+ "name": "ListItem",
15688
+ "module": "src/components/listitem/listitem.component.ts"
15689
+ }
15690
+ },
15691
+ {
15692
+ "description": "Allows customization of the background color on hover.",
15693
+ "name": "--mdc-listitem-background-color-hover",
15694
+ "inheritedFrom": {
15695
+ "name": "ListItem",
15696
+ "module": "src/components/listitem/listitem.component.ts"
15697
+ }
15698
+ },
15699
+ {
15700
+ "description": "Allows customization of the background color when pressed.",
15701
+ "name": "--mdc-listitem-background-color-active",
15702
+ "inheritedFrom": {
15703
+ "name": "ListItem",
15704
+ "module": "src/components/listitem/listitem.component.ts"
15705
+ }
15706
+ },
15707
+ {
15708
+ "description": "Allows customization of the primary label, side header and subline text slot color.",
15709
+ "name": "--mdc-listitem-primary-label-color",
15710
+ "inheritedFrom": {
15711
+ "name": "ListItem",
15712
+ "module": "src/components/listitem/listitem.component.ts"
15713
+ }
15714
+ },
15715
+ {
15716
+ "description": "Allows customization of the secondary and tertiary label text slot color.",
15717
+ "name": "--mdc-listitem-secondary-label-color",
15718
+ "inheritedFrom": {
15719
+ "name": "ListItem",
15720
+ "module": "src/components/listitem/listitem.component.ts"
15721
+ }
15722
+ },
15723
+ {
15724
+ "description": "Allows customization of the disabled color.",
15725
+ "name": "--mdc-listitem-disabled-color",
15726
+ "inheritedFrom": {
15727
+ "name": "ListItem",
15728
+ "module": "src/components/listitem/listitem.component.ts"
15729
+ }
15730
+ },
15731
+ {
15732
+ "description": "Allows customization of column gap.",
15733
+ "name": "--mdc-listitem-column-gap",
15734
+ "inheritedFrom": {
15735
+ "name": "ListItem",
15736
+ "module": "src/components/listitem/listitem.component.ts"
15737
+ }
15738
+ },
15739
+ {
15740
+ "description": "Allows customization of padding left and right.",
15741
+ "name": "--mdc-listitem-padding-left-and-right",
15742
+ "inheritedFrom": {
15743
+ "name": "ListItem",
15744
+ "module": "src/components/listitem/listitem.component.ts"
15745
+ }
15746
+ }
15747
+ ],
15650
15748
  "members": [
15749
+ {
15750
+ "kind": "field",
15751
+ "name": "ariaChecked",
15752
+ "type": {
15753
+ "text": "AriaCheckedStates"
15754
+ },
15755
+ "description": "The aria-checked attribute is used to indicate that the menuitemcheckbox is checked or not.",
15756
+ "default": "'false'",
15757
+ "attribute": "aria-checked",
15758
+ "reflects": true
15759
+ },
15760
+ {
15761
+ "kind": "field",
15762
+ "name": "indicator",
15763
+ "type": {
15764
+ "text": "Indicator"
15765
+ },
15766
+ "description": "The indicator attribute is used to differentiate between <b>checkbox</b> and <b>toggle</b>.",
15767
+ "default": "'checkbox'",
15768
+ "attribute": "indicator",
15769
+ "reflects": true
15770
+ },
15771
+ {
15772
+ "kind": "method",
15773
+ "name": "staticCheckbox",
15774
+ "privacy": "private",
15775
+ "return": {
15776
+ "type": {
15777
+ "text": "TemplateResult | typeof nothing"
15778
+ }
15779
+ }
15780
+ },
15781
+ {
15782
+ "kind": "method",
15783
+ "name": "staticToggle",
15784
+ "privacy": "private",
15785
+ "return": {
15786
+ "type": {
15787
+ "text": "TemplateResult | typeof nothing"
15788
+ }
15789
+ }
15790
+ },
15791
+ {
15792
+ "kind": "method",
15793
+ "name": "getCheckmarkIcon",
15794
+ "privacy": "private",
15795
+ "return": {
15796
+ "type": {
15797
+ "text": "TemplateResult | typeof nothing"
15798
+ }
15799
+ }
15800
+ },
15651
15801
  {
15652
15802
  "kind": "field",
15653
15803
  "name": "arrowPosition",
@@ -15656,7 +15806,11 @@
15656
15806
  },
15657
15807
  "description": "Defines where the arrow icon will appear.\n- `'leading'`: Icon appears on the leading edge (start).\n- `'trailing'`: Icon appears on the trailing edge (end).\n\nIf not set, no arrow is displayed.",
15658
15808
  "attribute": "arrow-position",
15659
- "reflects": true
15809
+ "reflects": true,
15810
+ "inheritedFrom": {
15811
+ "name": "MenuItem",
15812
+ "module": "components/menuitem/menuitem.component.js"
15813
+ }
15660
15814
  },
15661
15815
  {
15662
15816
  "kind": "field",
@@ -15666,7 +15820,11 @@
15666
15820
  },
15667
15821
  "description": "Defines the direction the arrow icon points.\n- `'positive'`: Arrow points toward the trailing side.\n- `'negative'`: Arrow points toward the leading side.",
15668
15822
  "attribute": "arrow-direction",
15669
- "reflects": true
15823
+ "reflects": true,
15824
+ "inheritedFrom": {
15825
+ "name": "MenuItem",
15826
+ "module": "components/menuitem/menuitem.component.js"
15827
+ }
15670
15828
  },
15671
15829
  {
15672
15830
  "kind": "method",
@@ -16011,7 +16169,12 @@
16011
16169
  ],
16012
16170
  "events": [
16013
16171
  {
16014
- "description": "(React: onClick) This event is dispatched when the menuitem is clicked.",
16172
+ "description": "(React: onChange) This event is dispatched when the menuitemcheckbox changes.",
16173
+ "name": "change",
16174
+ "reactName": "onChange"
16175
+ },
16176
+ {
16177
+ "description": "(React: onClick) This event is dispatched when the menuitemcheckbox is clicked.",
16015
16178
  "name": "click",
16016
16179
  "reactName": "onClick",
16017
16180
  "inheritedFrom": {
@@ -16020,27 +16183,27 @@
16020
16183
  }
16021
16184
  },
16022
16185
  {
16023
- "description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the menuitem.",
16024
- "name": "keydown",
16025
- "reactName": "onKeyDown",
16186
+ "description": "(React: onFocus) This event is dispatched when the menuitemcheckbox receives focus.",
16187
+ "name": "focus",
16188
+ "reactName": "onFocus",
16026
16189
  "inheritedFrom": {
16027
16190
  "name": "ListItem",
16028
16191
  "module": "src/components/listitem/listitem.component.ts"
16029
16192
  }
16030
16193
  },
16031
16194
  {
16032
- "description": "(React: onKeyUp) This event is dispatched when a key is released on the menuitem.",
16033
- "name": "keyup",
16034
- "reactName": "onKeyUp",
16195
+ "description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the menuitem.",
16196
+ "name": "keydown",
16197
+ "reactName": "onKeyDown",
16035
16198
  "inheritedFrom": {
16036
16199
  "name": "ListItem",
16037
16200
  "module": "src/components/listitem/listitem.component.ts"
16038
16201
  }
16039
16202
  },
16040
16203
  {
16041
- "description": "(React: onFocus) This event is dispatched when the menuitem receives focus.",
16042
- "name": "focus",
16043
- "reactName": "onFocus",
16204
+ "description": "(React: onKeyUp) This event is dispatched when a key is released on the menuitem.",
16205
+ "name": "keyup",
16206
+ "reactName": "onKeyUp",
16044
16207
  "inheritedFrom": {
16045
16208
  "name": "ListItem",
16046
16209
  "module": "src/components/listitem/listitem.component.ts"
@@ -16048,13 +16211,35 @@
16048
16211
  }
16049
16212
  ],
16050
16213
  "attributes": [
16214
+ {
16215
+ "name": "aria-checked",
16216
+ "type": {
16217
+ "text": "AriaCheckedStates"
16218
+ },
16219
+ "description": "The aria-checked attribute is used to indicate that the menuitemcheckbox is checked or not.",
16220
+ "default": "'false'",
16221
+ "fieldName": "ariaChecked"
16222
+ },
16223
+ {
16224
+ "name": "indicator",
16225
+ "type": {
16226
+ "text": "Indicator"
16227
+ },
16228
+ "description": "The indicator attribute is used to differentiate between <b>checkbox</b> and <b>toggle</b>.",
16229
+ "default": "'checkbox'",
16230
+ "fieldName": "indicator"
16231
+ },
16051
16232
  {
16052
16233
  "name": "arrow-position",
16053
16234
  "type": {
16054
16235
  "text": "ArrowPositions | undefined"
16055
16236
  },
16056
16237
  "description": "Defines where the arrow icon will appear.\n- `'leading'`: Icon appears on the leading edge (start).\n- `'trailing'`: Icon appears on the trailing edge (end).\n\nIf not set, no arrow is displayed.",
16057
- "fieldName": "arrowPosition"
16238
+ "fieldName": "arrowPosition",
16239
+ "inheritedFrom": {
16240
+ "name": "MenuItem",
16241
+ "module": "src/components/menuitem/menuitem.component.ts"
16242
+ }
16058
16243
  },
16059
16244
  {
16060
16245
  "name": "arrow-direction",
@@ -16062,7 +16247,11 @@
16062
16247
  "text": "ArrowDirections | undefined"
16063
16248
  },
16064
16249
  "description": "Defines the direction the arrow icon points.\n- `'positive'`: Arrow points toward the trailing side.\n- `'negative'`: Arrow points toward the leading side.",
16065
- "fieldName": "arrowDirection"
16250
+ "fieldName": "arrowDirection",
16251
+ "inheritedFrom": {
16252
+ "name": "MenuItem",
16253
+ "module": "src/components/menuitem/menuitem.component.ts"
16254
+ }
16066
16255
  },
16067
16256
  {
16068
16257
  "name": "disabled",
@@ -16190,11 +16379,11 @@
16190
16379
  }
16191
16380
  ],
16192
16381
  "superclass": {
16193
- "name": "ListItem",
16194
- "module": "/src/components/listitem/listitem.component"
16382
+ "name": "MenuItem",
16383
+ "module": "/src/components/menuitem/menuitem.component"
16195
16384
  },
16196
- "tagName": "mdc-menuitem",
16197
- "jsDoc": "/**\n * menuitem component is inherited by listitem component with the role set `menuitem`.<br/>\n * A menu item can contain an icon on the leading or trailing side.\n *\n * The leading and trailing slots can be used to display controls and text.<br/>\n * Based on the leading/trailing slot, the position of the controls and text can be adjusted.\n *\n * Please use mdc-menu as a parent element even when there is only menuitem for a11y purpose.\n *\n * @dependency mdc-text\n * @dependency mdc-icon\n * @dependency mdc-tooltip\n *\n * @tagname mdc-menuitem\n *\n * @event click - (React: onClick) This event is dispatched when the menuitem is clicked.\n * @event keydown - (React: onKeyDown) This event is dispatched when a key is pressed down on the menuitem.\n * @event keyup - (React: onKeyUp) This event is dispatched when a key is released on the menuitem.\n * @event focus - (React: onFocus) This event is dispatched when the menuitem receives focus.\n */",
16385
+ "tagName": "mdc-menuitemcheckbox",
16386
+ "jsDoc": "/**\n * A menuitemcheckbox component is a checkable menuitem.\n * There should be no focusable descendants inside this menuitemcheckbox component.\n *\n * The `aria-checked` attribute indicates whether the menuitemcheckbox is checked or not.\n *\n * The `indicator` attribute is used to differentiate between <b>checkbox</b>, <b>checkmark</b> and <b>toggle</b>.\n * By default the `indicator` is set to <b>checkbox</b>.<br/>\n *\n * The checkbox will always be positioned on the leading side of the menuitem label and\n * the toggle and checkmark will always be positioned on the trailing side.\n *\n * The checkbox will have the possible states of `true` or `false`.\n * If the indicator is set to <b>checkmark</b> and if the `aria-checked` attribute is set to `true`,\n * then the checkmark will be displayed. if not, then no indicator will be displayed.\n *\n * If you want only one item in a group to be checked, consider using menuitemradio component.\n *\n * If a menuitemcheckbox is disabled, then the `aria-disabled` attribute is set to `true`.\n *\n * @dependency mdc-staticcheckbox\n * @dependency mdc-statictoggle\n * @dependency mdc-icon\n *\n * @tagname mdc-menuitemcheckbox\n *\n * @cssproperty --mdc-checkmark-indicator-color - Allows customization of the checkmark indicator color\n *\n * @event change - (React: onChange) This event is dispatched when the menuitemcheckbox changes.\n * @event click - (React: onClick) This event is dispatched when the menuitemcheckbox is clicked.\n * @event focus - (React: onFocus) This event is dispatched when the menuitemcheckbox receives focus.\n */",
16198
16387
  "customElement": true,
16199
16388
  "slots": [
16200
16389
  {
@@ -16253,72 +16442,6 @@
16253
16442
  "module": "src/components/listitem/listitem.component.ts"
16254
16443
  }
16255
16444
  }
16256
- ],
16257
- "cssProperties": [
16258
- {
16259
- "description": "Allows customization of the default background color.",
16260
- "name": "--mdc-listitem-default-background-color",
16261
- "inheritedFrom": {
16262
- "name": "ListItem",
16263
- "module": "src/components/listitem/listitem.component.ts"
16264
- }
16265
- },
16266
- {
16267
- "description": "Allows customization of the background color on hover.",
16268
- "name": "--mdc-listitem-background-color-hover",
16269
- "inheritedFrom": {
16270
- "name": "ListItem",
16271
- "module": "src/components/listitem/listitem.component.ts"
16272
- }
16273
- },
16274
- {
16275
- "description": "Allows customization of the background color when pressed.",
16276
- "name": "--mdc-listitem-background-color-active",
16277
- "inheritedFrom": {
16278
- "name": "ListItem",
16279
- "module": "src/components/listitem/listitem.component.ts"
16280
- }
16281
- },
16282
- {
16283
- "description": "Allows customization of the primary label, side header and subline text slot color.",
16284
- "name": "--mdc-listitem-primary-label-color",
16285
- "inheritedFrom": {
16286
- "name": "ListItem",
16287
- "module": "src/components/listitem/listitem.component.ts"
16288
- }
16289
- },
16290
- {
16291
- "description": "Allows customization of the secondary and tertiary label text slot color.",
16292
- "name": "--mdc-listitem-secondary-label-color",
16293
- "inheritedFrom": {
16294
- "name": "ListItem",
16295
- "module": "src/components/listitem/listitem.component.ts"
16296
- }
16297
- },
16298
- {
16299
- "description": "Allows customization of the disabled color.",
16300
- "name": "--mdc-listitem-disabled-color",
16301
- "inheritedFrom": {
16302
- "name": "ListItem",
16303
- "module": "src/components/listitem/listitem.component.ts"
16304
- }
16305
- },
16306
- {
16307
- "description": "Allows customization of column gap.",
16308
- "name": "--mdc-listitem-column-gap",
16309
- "inheritedFrom": {
16310
- "name": "ListItem",
16311
- "module": "src/components/listitem/listitem.component.ts"
16312
- }
16313
- },
16314
- {
16315
- "description": "Allows customization of padding left and right.",
16316
- "name": "--mdc-listitem-padding-left-and-right",
16317
- "inheritedFrom": {
16318
- "name": "ListItem",
16319
- "module": "src/components/listitem/listitem.component.ts"
16320
- }
16321
- }
16322
16445
  ]
16323
16446
  }
16324
16447
  ],
@@ -16327,143 +16450,21 @@
16327
16450
  "kind": "js",
16328
16451
  "name": "default",
16329
16452
  "declaration": {
16330
- "name": "MenuItem",
16331
- "module": "components/menuitem/menuitem.component.js"
16453
+ "name": "MenuItemCheckbox",
16454
+ "module": "components/menuitemcheckbox/menuitemcheckbox.component.js"
16332
16455
  }
16333
16456
  }
16334
16457
  ]
16335
16458
  },
16336
16459
  {
16337
16460
  "kind": "javascript-module",
16338
- "path": "components/menuitemcheckbox/menuitemcheckbox.component.js",
16461
+ "path": "components/menuitem/menuitem.component.js",
16339
16462
  "declarations": [
16340
16463
  {
16341
16464
  "kind": "class",
16342
- "description": "A menuitemcheckbox component is a checkable menuitem.\nThere should be no focusable descendants inside this menuitemcheckbox component.\n\nThe `aria-checked` attribute indicates whether the menuitemcheckbox is checked or not.\n\nThe `indicator` attribute is used to differentiate between <b>checkbox</b>, <b>checkmark</b> and <b>toggle</b>.\nBy default the `indicator` is set to <b>checkbox</b>.<br/>\n\nThe checkbox will always be positioned on the leading side of the menuitem label and\nthe toggle and checkmark will always be positioned on the trailing side.\n\nThe checkbox will have the possible states of `true` or `false`.\nIf the indicator is set to <b>checkmark</b> and if the `aria-checked` attribute is set to `true`,\nthen the checkmark will be displayed. if not, then no indicator will be displayed.\n\nIf you want only one item in a group to be checked, consider using menuitemradio component.\n\nIf a menuitemcheckbox is disabled, then the `aria-disabled` attribute is set to `true`.",
16343
- "name": "MenuItemCheckbox",
16344
- "cssProperties": [
16345
- {
16346
- "description": "Allows customization of the checkmark indicator color",
16347
- "name": "--mdc-checkmark-indicator-color"
16348
- },
16349
- {
16350
- "description": "Allows customization of the default background color.",
16351
- "name": "--mdc-listitem-default-background-color",
16352
- "inheritedFrom": {
16353
- "name": "ListItem",
16354
- "module": "src/components/listitem/listitem.component.ts"
16355
- }
16356
- },
16357
- {
16358
- "description": "Allows customization of the background color on hover.",
16359
- "name": "--mdc-listitem-background-color-hover",
16360
- "inheritedFrom": {
16361
- "name": "ListItem",
16362
- "module": "src/components/listitem/listitem.component.ts"
16363
- }
16364
- },
16365
- {
16366
- "description": "Allows customization of the background color when pressed.",
16367
- "name": "--mdc-listitem-background-color-active",
16368
- "inheritedFrom": {
16369
- "name": "ListItem",
16370
- "module": "src/components/listitem/listitem.component.ts"
16371
- }
16372
- },
16373
- {
16374
- "description": "Allows customization of the primary label, side header and subline text slot color.",
16375
- "name": "--mdc-listitem-primary-label-color",
16376
- "inheritedFrom": {
16377
- "name": "ListItem",
16378
- "module": "src/components/listitem/listitem.component.ts"
16379
- }
16380
- },
16381
- {
16382
- "description": "Allows customization of the secondary and tertiary label text slot color.",
16383
- "name": "--mdc-listitem-secondary-label-color",
16384
- "inheritedFrom": {
16385
- "name": "ListItem",
16386
- "module": "src/components/listitem/listitem.component.ts"
16387
- }
16388
- },
16389
- {
16390
- "description": "Allows customization of the disabled color.",
16391
- "name": "--mdc-listitem-disabled-color",
16392
- "inheritedFrom": {
16393
- "name": "ListItem",
16394
- "module": "src/components/listitem/listitem.component.ts"
16395
- }
16396
- },
16397
- {
16398
- "description": "Allows customization of column gap.",
16399
- "name": "--mdc-listitem-column-gap",
16400
- "inheritedFrom": {
16401
- "name": "ListItem",
16402
- "module": "src/components/listitem/listitem.component.ts"
16403
- }
16404
- },
16405
- {
16406
- "description": "Allows customization of padding left and right.",
16407
- "name": "--mdc-listitem-padding-left-and-right",
16408
- "inheritedFrom": {
16409
- "name": "ListItem",
16410
- "module": "src/components/listitem/listitem.component.ts"
16411
- }
16412
- }
16413
- ],
16465
+ "description": "menuitem component is inherited by listitem component with the role set `menuitem`.<br/>\nA menu item can contain an icon on the leading or trailing side.\n\nThe leading and trailing slots can be used to display controls and text.<br/>\nBased on the leading/trailing slot, the position of the controls and text can be adjusted.\n\nPlease use mdc-menu as a parent element even when there is only menuitem for a11y purpose.",
16466
+ "name": "MenuItem",
16414
16467
  "members": [
16415
- {
16416
- "kind": "field",
16417
- "name": "ariaChecked",
16418
- "type": {
16419
- "text": "AriaCheckedStates"
16420
- },
16421
- "description": "The aria-checked attribute is used to indicate that the menuitemcheckbox is checked or not.",
16422
- "default": "'false'",
16423
- "attribute": "aria-checked",
16424
- "reflects": true
16425
- },
16426
- {
16427
- "kind": "field",
16428
- "name": "indicator",
16429
- "type": {
16430
- "text": "Indicator"
16431
- },
16432
- "description": "The indicator attribute is used to differentiate between <b>checkbox</b> and <b>toggle</b>.",
16433
- "default": "'checkbox'",
16434
- "attribute": "indicator",
16435
- "reflects": true
16436
- },
16437
- {
16438
- "kind": "method",
16439
- "name": "staticCheckbox",
16440
- "privacy": "private",
16441
- "return": {
16442
- "type": {
16443
- "text": "TemplateResult | typeof nothing"
16444
- }
16445
- }
16446
- },
16447
- {
16448
- "kind": "method",
16449
- "name": "staticToggle",
16450
- "privacy": "private",
16451
- "return": {
16452
- "type": {
16453
- "text": "TemplateResult | typeof nothing"
16454
- }
16455
- }
16456
- },
16457
- {
16458
- "kind": "method",
16459
- "name": "getCheckmarkIcon",
16460
- "privacy": "private",
16461
- "return": {
16462
- "type": {
16463
- "text": "TemplateResult | typeof nothing"
16464
- }
16465
- }
16466
- },
16467
16468
  {
16468
16469
  "kind": "field",
16469
16470
  "name": "arrowPosition",
@@ -16472,11 +16473,7 @@
16472
16473
  },
16473
16474
  "description": "Defines where the arrow icon will appear.\n- `'leading'`: Icon appears on the leading edge (start).\n- `'trailing'`: Icon appears on the trailing edge (end).\n\nIf not set, no arrow is displayed.",
16474
16475
  "attribute": "arrow-position",
16475
- "reflects": true,
16476
- "inheritedFrom": {
16477
- "name": "MenuItem",
16478
- "module": "components/menuitem/menuitem.component.js"
16479
- }
16476
+ "reflects": true
16480
16477
  },
16481
16478
  {
16482
16479
  "kind": "field",
@@ -16486,11 +16483,7 @@
16486
16483
  },
16487
16484
  "description": "Defines the direction the arrow icon points.\n- `'positive'`: Arrow points toward the trailing side.\n- `'negative'`: Arrow points toward the leading side.",
16488
16485
  "attribute": "arrow-direction",
16489
- "reflects": true,
16490
- "inheritedFrom": {
16491
- "name": "MenuItem",
16492
- "module": "components/menuitem/menuitem.component.js"
16493
- }
16486
+ "reflects": true
16494
16487
  },
16495
16488
  {
16496
16489
  "kind": "method",
@@ -16835,12 +16828,7 @@
16835
16828
  ],
16836
16829
  "events": [
16837
16830
  {
16838
- "description": "(React: onChange) This event is dispatched when the menuitemcheckbox changes.",
16839
- "name": "change",
16840
- "reactName": "onChange"
16841
- },
16842
- {
16843
- "description": "(React: onClick) This event is dispatched when the menuitemcheckbox is clicked.",
16831
+ "description": "(React: onClick) This event is dispatched when the menuitem is clicked.",
16844
16832
  "name": "click",
16845
16833
  "reactName": "onClick",
16846
16834
  "inheritedFrom": {
@@ -16848,15 +16836,6 @@
16848
16836
  "module": "src/components/listitem/listitem.component.ts"
16849
16837
  }
16850
16838
  },
16851
- {
16852
- "description": "(React: onFocus) This event is dispatched when the menuitemcheckbox receives focus.",
16853
- "name": "focus",
16854
- "reactName": "onFocus",
16855
- "inheritedFrom": {
16856
- "name": "ListItem",
16857
- "module": "src/components/listitem/listitem.component.ts"
16858
- }
16859
- },
16860
16839
  {
16861
16840
  "description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the menuitem.",
16862
16841
  "name": "keydown",
@@ -16874,38 +16853,25 @@
16874
16853
  "name": "ListItem",
16875
16854
  "module": "src/components/listitem/listitem.component.ts"
16876
16855
  }
16856
+ },
16857
+ {
16858
+ "description": "(React: onFocus) This event is dispatched when the menuitem receives focus.",
16859
+ "name": "focus",
16860
+ "reactName": "onFocus",
16861
+ "inheritedFrom": {
16862
+ "name": "ListItem",
16863
+ "module": "src/components/listitem/listitem.component.ts"
16864
+ }
16877
16865
  }
16878
16866
  ],
16879
16867
  "attributes": [
16880
- {
16881
- "name": "aria-checked",
16882
- "type": {
16883
- "text": "AriaCheckedStates"
16884
- },
16885
- "description": "The aria-checked attribute is used to indicate that the menuitemcheckbox is checked or not.",
16886
- "default": "'false'",
16887
- "fieldName": "ariaChecked"
16888
- },
16889
- {
16890
- "name": "indicator",
16891
- "type": {
16892
- "text": "Indicator"
16893
- },
16894
- "description": "The indicator attribute is used to differentiate between <b>checkbox</b> and <b>toggle</b>.",
16895
- "default": "'checkbox'",
16896
- "fieldName": "indicator"
16897
- },
16898
16868
  {
16899
16869
  "name": "arrow-position",
16900
16870
  "type": {
16901
16871
  "text": "ArrowPositions | undefined"
16902
16872
  },
16903
16873
  "description": "Defines where the arrow icon will appear.\n- `'leading'`: Icon appears on the leading edge (start).\n- `'trailing'`: Icon appears on the trailing edge (end).\n\nIf not set, no arrow is displayed.",
16904
- "fieldName": "arrowPosition",
16905
- "inheritedFrom": {
16906
- "name": "MenuItem",
16907
- "module": "src/components/menuitem/menuitem.component.ts"
16908
- }
16874
+ "fieldName": "arrowPosition"
16909
16875
  },
16910
16876
  {
16911
16877
  "name": "arrow-direction",
@@ -16913,11 +16879,7 @@
16913
16879
  "text": "ArrowDirections | undefined"
16914
16880
  },
16915
16881
  "description": "Defines the direction the arrow icon points.\n- `'positive'`: Arrow points toward the trailing side.\n- `'negative'`: Arrow points toward the leading side.",
16916
- "fieldName": "arrowDirection",
16917
- "inheritedFrom": {
16918
- "name": "MenuItem",
16919
- "module": "src/components/menuitem/menuitem.component.ts"
16920
- }
16882
+ "fieldName": "arrowDirection"
16921
16883
  },
16922
16884
  {
16923
16885
  "name": "disabled",
@@ -17045,11 +17007,11 @@
17045
17007
  }
17046
17008
  ],
17047
17009
  "superclass": {
17048
- "name": "MenuItem",
17049
- "module": "/src/components/menuitem/menuitem.component"
17010
+ "name": "ListItem",
17011
+ "module": "/src/components/listitem/listitem.component"
17050
17012
  },
17051
- "tagName": "mdc-menuitemcheckbox",
17052
- "jsDoc": "/**\n * A menuitemcheckbox component is a checkable menuitem.\n * There should be no focusable descendants inside this menuitemcheckbox component.\n *\n * The `aria-checked` attribute indicates whether the menuitemcheckbox is checked or not.\n *\n * The `indicator` attribute is used to differentiate between <b>checkbox</b>, <b>checkmark</b> and <b>toggle</b>.\n * By default the `indicator` is set to <b>checkbox</b>.<br/>\n *\n * The checkbox will always be positioned on the leading side of the menuitem label and\n * the toggle and checkmark will always be positioned on the trailing side.\n *\n * The checkbox will have the possible states of `true` or `false`.\n * If the indicator is set to <b>checkmark</b> and if the `aria-checked` attribute is set to `true`,\n * then the checkmark will be displayed. if not, then no indicator will be displayed.\n *\n * If you want only one item in a group to be checked, consider using menuitemradio component.\n *\n * If a menuitemcheckbox is disabled, then the `aria-disabled` attribute is set to `true`.\n *\n * @dependency mdc-staticcheckbox\n * @dependency mdc-statictoggle\n * @dependency mdc-icon\n *\n * @tagname mdc-menuitemcheckbox\n *\n * @cssproperty --mdc-checkmark-indicator-color - Allows customization of the checkmark indicator color\n *\n * @event change - (React: onChange) This event is dispatched when the menuitemcheckbox changes.\n * @event click - (React: onClick) This event is dispatched when the menuitemcheckbox is clicked.\n * @event focus - (React: onFocus) This event is dispatched when the menuitemcheckbox receives focus.\n */",
17013
+ "tagName": "mdc-menuitem",
17014
+ "jsDoc": "/**\n * menuitem component is inherited by listitem component with the role set `menuitem`.<br/>\n * A menu item can contain an icon on the leading or trailing side.\n *\n * The leading and trailing slots can be used to display controls and text.<br/>\n * Based on the leading/trailing slot, the position of the controls and text can be adjusted.\n *\n * Please use mdc-menu as a parent element even when there is only menuitem for a11y purpose.\n *\n * @dependency mdc-text\n * @dependency mdc-icon\n * @dependency mdc-tooltip\n *\n * @tagname mdc-menuitem\n *\n * @event click - (React: onClick) This event is dispatched when the menuitem is clicked.\n * @event keydown - (React: onKeyDown) This event is dispatched when a key is pressed down on the menuitem.\n * @event keyup - (React: onKeyUp) This event is dispatched when a key is released on the menuitem.\n * @event focus - (React: onFocus) This event is dispatched when the menuitem receives focus.\n */",
17053
17015
  "customElement": true,
17054
17016
  "slots": [
17055
17017
  {
@@ -17108,6 +17070,72 @@
17108
17070
  "module": "src/components/listitem/listitem.component.ts"
17109
17071
  }
17110
17072
  }
17073
+ ],
17074
+ "cssProperties": [
17075
+ {
17076
+ "description": "Allows customization of the default background color.",
17077
+ "name": "--mdc-listitem-default-background-color",
17078
+ "inheritedFrom": {
17079
+ "name": "ListItem",
17080
+ "module": "src/components/listitem/listitem.component.ts"
17081
+ }
17082
+ },
17083
+ {
17084
+ "description": "Allows customization of the background color on hover.",
17085
+ "name": "--mdc-listitem-background-color-hover",
17086
+ "inheritedFrom": {
17087
+ "name": "ListItem",
17088
+ "module": "src/components/listitem/listitem.component.ts"
17089
+ }
17090
+ },
17091
+ {
17092
+ "description": "Allows customization of the background color when pressed.",
17093
+ "name": "--mdc-listitem-background-color-active",
17094
+ "inheritedFrom": {
17095
+ "name": "ListItem",
17096
+ "module": "src/components/listitem/listitem.component.ts"
17097
+ }
17098
+ },
17099
+ {
17100
+ "description": "Allows customization of the primary label, side header and subline text slot color.",
17101
+ "name": "--mdc-listitem-primary-label-color",
17102
+ "inheritedFrom": {
17103
+ "name": "ListItem",
17104
+ "module": "src/components/listitem/listitem.component.ts"
17105
+ }
17106
+ },
17107
+ {
17108
+ "description": "Allows customization of the secondary and tertiary label text slot color.",
17109
+ "name": "--mdc-listitem-secondary-label-color",
17110
+ "inheritedFrom": {
17111
+ "name": "ListItem",
17112
+ "module": "src/components/listitem/listitem.component.ts"
17113
+ }
17114
+ },
17115
+ {
17116
+ "description": "Allows customization of the disabled color.",
17117
+ "name": "--mdc-listitem-disabled-color",
17118
+ "inheritedFrom": {
17119
+ "name": "ListItem",
17120
+ "module": "src/components/listitem/listitem.component.ts"
17121
+ }
17122
+ },
17123
+ {
17124
+ "description": "Allows customization of column gap.",
17125
+ "name": "--mdc-listitem-column-gap",
17126
+ "inheritedFrom": {
17127
+ "name": "ListItem",
17128
+ "module": "src/components/listitem/listitem.component.ts"
17129
+ }
17130
+ },
17131
+ {
17132
+ "description": "Allows customization of padding left and right.",
17133
+ "name": "--mdc-listitem-padding-left-and-right",
17134
+ "inheritedFrom": {
17135
+ "name": "ListItem",
17136
+ "module": "src/components/listitem/listitem.component.ts"
17137
+ }
17138
+ }
17111
17139
  ]
17112
17140
  }
17113
17141
  ],
@@ -17116,8 +17144,8 @@
17116
17144
  "kind": "js",
17117
17145
  "name": "default",
17118
17146
  "declaration": {
17119
- "name": "MenuItemCheckbox",
17120
- "module": "components/menuitemcheckbox/menuitemcheckbox.component.js"
17147
+ "name": "MenuItem",
17148
+ "module": "components/menuitem/menuitem.component.js"
17121
17149
  }
17122
17150
  }
17123
17151
  ]
@@ -18520,7 +18548,7 @@
18520
18548
  "text": "boolean"
18521
18549
  },
18522
18550
  "default": "true",
18523
- "description": "Determines whether focus should wrap around when reaching the first or last focusable element.\nIf true, focus will cycle from end to start and vice versa.\n\nThis only applies when `enabledFocusTrap` is true.",
18551
+ "description": "Determines whether focus should wrap around when reaching the first or last focusable element.\nIf true, focus will cycle from end to start and vice versa.\n\nThis only applies when `focusTrap` is true.",
18524
18552
  "attribute": "should-focus-trap-wrap",
18525
18553
  "reflects": true,
18526
18554
  "inheritedFrom": {
@@ -18804,7 +18832,7 @@
18804
18832
  "description": "The set of focusable elements."
18805
18833
  }
18806
18834
  ],
18807
- "description": "Recursively finds all focusable elements within the given root and its descendants.",
18835
+ "description": "Recursively finds all focusable elements within the given root and its descendants.\n\nMake sure this is performant, as it will be called multiple times.",
18808
18836
  "inheritedFrom": {
18809
18837
  "name": "FocusTrapMixin",
18810
18838
  "module": "utils/mixins/FocusTrapMixin.js"
@@ -18813,7 +18841,7 @@
18813
18841
  {
18814
18842
  "kind": "method",
18815
18843
  "name": "setFocusableElements",
18816
- "privacy": "public",
18844
+ "privacy": "private",
18817
18845
  "description": "Updates the list of focusable elements within the component's shadow root.",
18818
18846
  "inheritedFrom": {
18819
18847
  "name": "FocusTrapMixin",
@@ -19174,6 +19202,21 @@
19174
19202
  "module": "components/popover/popover.component.js"
19175
19203
  }
19176
19204
  },
19205
+ {
19206
+ "kind": "field",
19207
+ "name": "propagateEventOnEscape",
19208
+ "type": {
19209
+ "text": "boolean"
19210
+ },
19211
+ "description": "Propagates the event, when the escape key is pressed (only when pressed inside the popover)\nIf true, the escape key press close the popover and will propagate the keydown event.\nIf false, the escape key press will close the popover but will not propagate the keydown event.\n(set to false to prevent the event from bubbling up to the document).\n\nThis only works when `hideOnEscape` is true.",
19212
+ "default": "false",
19213
+ "attribute": "propagate-event-on-escape",
19214
+ "reflects": true,
19215
+ "inheritedFrom": {
19216
+ "name": "Popover",
19217
+ "module": "components/popover/popover.component.js"
19218
+ }
19219
+ },
19177
19220
  {
19178
19221
  "kind": "field",
19179
19222
  "name": "hideOnBlur",
@@ -19450,7 +19493,7 @@
19450
19493
  "kind": "field",
19451
19494
  "name": "onEscapeKeydown",
19452
19495
  "privacy": "private",
19453
- "description": "Handles the escape keydown event to close the popover.",
19496
+ "description": "Handles the escape keydown event to close the popover.\n\nThis method is attached to the document.",
19454
19497
  "parameters": [
19455
19498
  {
19456
19499
  "description": "The keyboard event.",
@@ -19617,7 +19660,7 @@
19617
19660
  "text": "boolean"
19618
19661
  },
19619
19662
  "default": "true",
19620
- "description": "Determines whether focus should wrap around when reaching the first or last focusable element.\nIf true, focus will cycle from end to start and vice versa.\n\nThis only applies when `enabledFocusTrap` is true.",
19663
+ "description": "Determines whether focus should wrap around when reaching the first or last focusable element.\nIf true, focus will cycle from end to start and vice versa.\n\nThis only applies when `focusTrap` is true.",
19621
19664
  "fieldName": "shouldFocusTrapWrap",
19622
19665
  "inheritedFrom": {
19623
19666
  "name": "FocusTrapMixin",
@@ -19819,6 +19862,19 @@
19819
19862
  "module": "src/components/popover/popover.component.ts"
19820
19863
  }
19821
19864
  },
19865
+ {
19866
+ "name": "propagate-event-on-escape",
19867
+ "type": {
19868
+ "text": "boolean"
19869
+ },
19870
+ "description": "Propagates the event, when the escape key is pressed (only when pressed inside the popover)\nIf true, the escape key press close the popover and will propagate the keydown event.\nIf false, the escape key press will close the popover but will not propagate the keydown event.\n(set to false to prevent the event from bubbling up to the document).\n\nThis only works when `hideOnEscape` is true.",
19871
+ "default": "false",
19872
+ "fieldName": "propagateEventOnEscape",
19873
+ "inheritedFrom": {
19874
+ "name": "Popover",
19875
+ "module": "src/components/popover/popover.component.ts"
19876
+ }
19877
+ },
19822
19878
  {
19823
19879
  "name": "hide-on-blur",
19824
19880
  "type": {
@@ -23084,6 +23140,17 @@
23084
23140
  "attribute": "hide-on-escape",
23085
23141
  "reflects": true
23086
23142
  },
23143
+ {
23144
+ "kind": "field",
23145
+ "name": "propagateEventOnEscape",
23146
+ "type": {
23147
+ "text": "boolean"
23148
+ },
23149
+ "description": "Propagates the event, when the escape key is pressed (only when pressed inside the popover)\nIf true, the escape key press close the popover and will propagate the keydown event.\nIf false, the escape key press will close the popover but will not propagate the keydown event.\n(set to false to prevent the event from bubbling up to the document).\n\nThis only works when `hideOnEscape` is true.",
23150
+ "default": "false",
23151
+ "attribute": "propagate-event-on-escape",
23152
+ "reflects": true
23153
+ },
23087
23154
  {
23088
23155
  "kind": "field",
23089
23156
  "name": "hideOnBlur",
@@ -23284,7 +23351,7 @@
23284
23351
  "kind": "field",
23285
23352
  "name": "onEscapeKeydown",
23286
23353
  "privacy": "private",
23287
- "description": "Handles the escape keydown event to close the popover.",
23354
+ "description": "Handles the escape keydown event to close the popover.\n\nThis method is attached to the document.",
23288
23355
  "parameters": [
23289
23356
  {
23290
23357
  "description": "The keyboard event.",
@@ -23380,7 +23447,7 @@
23380
23447
  "text": "boolean"
23381
23448
  },
23382
23449
  "default": "true",
23383
- "description": "Determines whether focus should wrap around when reaching the first or last focusable element.\nIf true, focus will cycle from end to start and vice versa.\n\nThis only applies when `enabledFocusTrap` is true.",
23450
+ "description": "Determines whether focus should wrap around when reaching the first or last focusable element.\nIf true, focus will cycle from end to start and vice versa.\n\nThis only applies when `focusTrap` is true.",
23384
23451
  "attribute": "should-focus-trap-wrap",
23385
23452
  "reflects": true,
23386
23453
  "inheritedFrom": {
@@ -23664,7 +23731,7 @@
23664
23731
  "description": "The set of focusable elements."
23665
23732
  }
23666
23733
  ],
23667
- "description": "Recursively finds all focusable elements within the given root and its descendants.",
23734
+ "description": "Recursively finds all focusable elements within the given root and its descendants.\n\nMake sure this is performant, as it will be called multiple times.",
23668
23735
  "inheritedFrom": {
23669
23736
  "name": "FocusTrapMixin",
23670
23737
  "module": "utils/mixins/FocusTrapMixin.js"
@@ -23673,7 +23740,7 @@
23673
23740
  {
23674
23741
  "kind": "method",
23675
23742
  "name": "setFocusableElements",
23676
- "privacy": "public",
23743
+ "privacy": "private",
23677
23744
  "description": "Updates the list of focusable elements within the component's shadow root.",
23678
23745
  "inheritedFrom": {
23679
23746
  "name": "FocusTrapMixin",
@@ -23989,6 +24056,15 @@
23989
24056
  "default": "false",
23990
24057
  "fieldName": "hideOnEscape"
23991
24058
  },
24059
+ {
24060
+ "name": "propagate-event-on-escape",
24061
+ "type": {
24062
+ "text": "boolean"
24063
+ },
24064
+ "description": "Propagates the event, when the escape key is pressed (only when pressed inside the popover)\nIf true, the escape key press close the popover and will propagate the keydown event.\nIf false, the escape key press will close the popover but will not propagate the keydown event.\n(set to false to prevent the event from bubbling up to the document).\n\nThis only works when `hideOnEscape` is true.",
24065
+ "default": "false",
24066
+ "fieldName": "propagateEventOnEscape"
24067
+ },
23992
24068
  {
23993
24069
  "name": "hide-on-blur",
23994
24070
  "type": {
@@ -24121,7 +24197,7 @@
24121
24197
  "text": "boolean"
24122
24198
  },
24123
24199
  "default": "true",
24124
- "description": "Determines whether focus should wrap around when reaching the first or last focusable element.\nIf true, focus will cycle from end to start and vice versa.\n\nThis only applies when `enabledFocusTrap` is true.",
24200
+ "description": "Determines whether focus should wrap around when reaching the first or last focusable element.\nIf true, focus will cycle from end to start and vice versa.\n\nThis only applies when `focusTrap` is true.",
24125
24201
  "fieldName": "shouldFocusTrapWrap",
24126
24202
  "inheritedFrom": {
24127
24203
  "name": "FocusTrapMixin",
@@ -32752,7 +32828,7 @@
32752
32828
  "text": "boolean"
32753
32829
  },
32754
32830
  "default": "true",
32755
- "description": "Determines whether focus should wrap around when reaching the first or last focusable element.\nIf true, focus will cycle from end to start and vice versa.\n\nThis only applies when `enabledFocusTrap` is true.",
32831
+ "description": "Determines whether focus should wrap around when reaching the first or last focusable element.\nIf true, focus will cycle from end to start and vice versa.\n\nThis only applies when `focusTrap` is true.",
32756
32832
  "attribute": "should-focus-trap-wrap",
32757
32833
  "reflects": true,
32758
32834
  "inheritedFrom": {
@@ -33036,7 +33112,7 @@
33036
33112
  "description": "The set of focusable elements."
33037
33113
  }
33038
33114
  ],
33039
- "description": "Recursively finds all focusable elements within the given root and its descendants.",
33115
+ "description": "Recursively finds all focusable elements within the given root and its descendants.\n\nMake sure this is performant, as it will be called multiple times.",
33040
33116
  "inheritedFrom": {
33041
33117
  "name": "Popover",
33042
33118
  "module": "components/popover/popover.component.js"
@@ -33045,7 +33121,7 @@
33045
33121
  {
33046
33122
  "kind": "method",
33047
33123
  "name": "setFocusableElements",
33048
- "privacy": "public",
33124
+ "privacy": "private",
33049
33125
  "description": "Updates the list of focusable elements within the component's shadow root.",
33050
33126
  "inheritedFrom": {
33051
33127
  "name": "Popover",
@@ -33406,6 +33482,21 @@
33406
33482
  "module": "components/popover/popover.component.js"
33407
33483
  }
33408
33484
  },
33485
+ {
33486
+ "kind": "field",
33487
+ "name": "propagateEventOnEscape",
33488
+ "type": {
33489
+ "text": "boolean"
33490
+ },
33491
+ "description": "Propagates the event, when the escape key is pressed (only when pressed inside the popover)\nIf true, the escape key press close the popover and will propagate the keydown event.\nIf false, the escape key press will close the popover but will not propagate the keydown event.\n(set to false to prevent the event from bubbling up to the document).\n\nThis only works when `hideOnEscape` is true.",
33492
+ "default": "false",
33493
+ "attribute": "propagate-event-on-escape",
33494
+ "reflects": true,
33495
+ "inheritedFrom": {
33496
+ "name": "Popover",
33497
+ "module": "components/popover/popover.component.js"
33498
+ }
33499
+ },
33409
33500
  {
33410
33501
  "kind": "field",
33411
33502
  "name": "hideOnBlur",
@@ -33682,7 +33773,7 @@
33682
33773
  "kind": "field",
33683
33774
  "name": "onEscapeKeydown",
33684
33775
  "privacy": "private",
33685
- "description": "Handles the escape keydown event to close the popover.",
33776
+ "description": "Handles the escape keydown event to close the popover.\n\nThis method is attached to the document.",
33686
33777
  "parameters": [
33687
33778
  {
33688
33779
  "description": "The keyboard event.",
@@ -33869,7 +33960,7 @@
33869
33960
  "text": "boolean"
33870
33961
  },
33871
33962
  "default": "true",
33872
- "description": "Determines whether focus should wrap around when reaching the first or last focusable element.\nIf true, focus will cycle from end to start and vice versa.\n\nThis only applies when `enabledFocusTrap` is true.",
33963
+ "description": "Determines whether focus should wrap around when reaching the first or last focusable element.\nIf true, focus will cycle from end to start and vice versa.\n\nThis only applies when `focusTrap` is true.",
33873
33964
  "fieldName": "shouldFocusTrapWrap",
33874
33965
  "inheritedFrom": {
33875
33966
  "name": "Popover",
@@ -34071,6 +34162,19 @@
34071
34162
  "module": "src/components/popover/popover.component.ts"
34072
34163
  }
34073
34164
  },
34165
+ {
34166
+ "name": "propagate-event-on-escape",
34167
+ "type": {
34168
+ "text": "boolean"
34169
+ },
34170
+ "description": "Propagates the event, when the escape key is pressed (only when pressed inside the popover)\nIf true, the escape key press close the popover and will propagate the keydown event.\nIf false, the escape key press will close the popover but will not propagate the keydown event.\n(set to false to prevent the event from bubbling up to the document).\n\nThis only works when `hideOnEscape` is true.",
34171
+ "default": "false",
34172
+ "fieldName": "propagateEventOnEscape",
34173
+ "inheritedFrom": {
34174
+ "name": "Popover",
34175
+ "module": "src/components/popover/popover.component.ts"
34176
+ }
34177
+ },
34074
34178
  {
34075
34179
  "name": "hide-on-blur",
34076
34180
  "type": {
@@ -34495,7 +34599,7 @@
34495
34599
  "text": "boolean"
34496
34600
  },
34497
34601
  "default": "true",
34498
- "description": "Determines whether focus should wrap around when reaching the first or last focusable element.\nIf true, focus will cycle from end to start and vice versa.\n\nThis only applies when `enabledFocusTrap` is true.",
34602
+ "description": "Determines whether focus should wrap around when reaching the first or last focusable element.\nIf true, focus will cycle from end to start and vice versa.\n\nThis only applies when `focusTrap` is true.",
34499
34603
  "attribute": "should-focus-trap-wrap",
34500
34604
  "reflects": true,
34501
34605
  "inheritedFrom": {
@@ -34779,7 +34883,7 @@
34779
34883
  "description": "The set of focusable elements."
34780
34884
  }
34781
34885
  ],
34782
- "description": "Recursively finds all focusable elements within the given root and its descendants.",
34886
+ "description": "Recursively finds all focusable elements within the given root and its descendants.\n\nMake sure this is performant, as it will be called multiple times.",
34783
34887
  "inheritedFrom": {
34784
34888
  "name": "Popover",
34785
34889
  "module": "components/popover/popover.component.js"
@@ -34788,7 +34892,7 @@
34788
34892
  {
34789
34893
  "kind": "method",
34790
34894
  "name": "setFocusableElements",
34791
- "privacy": "public",
34895
+ "privacy": "private",
34792
34896
  "description": "Updates the list of focusable elements within the component's shadow root.",
34793
34897
  "inheritedFrom": {
34794
34898
  "name": "Popover",
@@ -35149,6 +35253,21 @@
35149
35253
  "module": "components/popover/popover.component.js"
35150
35254
  }
35151
35255
  },
35256
+ {
35257
+ "kind": "field",
35258
+ "name": "propagateEventOnEscape",
35259
+ "type": {
35260
+ "text": "boolean"
35261
+ },
35262
+ "description": "Propagates the event, when the escape key is pressed (only when pressed inside the popover)\nIf true, the escape key press close the popover and will propagate the keydown event.\nIf false, the escape key press will close the popover but will not propagate the keydown event.\n(set to false to prevent the event from bubbling up to the document).\n\nThis only works when `hideOnEscape` is true.",
35263
+ "default": "false",
35264
+ "attribute": "propagate-event-on-escape",
35265
+ "reflects": true,
35266
+ "inheritedFrom": {
35267
+ "name": "Popover",
35268
+ "module": "components/popover/popover.component.js"
35269
+ }
35270
+ },
35152
35271
  {
35153
35272
  "kind": "field",
35154
35273
  "name": "hideOnBlur",
@@ -35425,7 +35544,7 @@
35425
35544
  "kind": "field",
35426
35545
  "name": "onEscapeKeydown",
35427
35546
  "privacy": "private",
35428
- "description": "Handles the escape keydown event to close the popover.",
35547
+ "description": "Handles the escape keydown event to close the popover.\n\nThis method is attached to the document.",
35429
35548
  "parameters": [
35430
35549
  {
35431
35550
  "description": "The keyboard event.",
@@ -35613,7 +35732,7 @@
35613
35732
  "text": "boolean"
35614
35733
  },
35615
35734
  "default": "true",
35616
- "description": "Determines whether focus should wrap around when reaching the first or last focusable element.\nIf true, focus will cycle from end to start and vice versa.\n\nThis only applies when `enabledFocusTrap` is true.",
35735
+ "description": "Determines whether focus should wrap around when reaching the first or last focusable element.\nIf true, focus will cycle from end to start and vice versa.\n\nThis only applies when `focusTrap` is true.",
35617
35736
  "fieldName": "shouldFocusTrapWrap",
35618
35737
  "inheritedFrom": {
35619
35738
  "name": "Popover",
@@ -35815,6 +35934,19 @@
35815
35934
  "module": "src/components/popover/popover.component.ts"
35816
35935
  }
35817
35936
  },
35937
+ {
35938
+ "name": "propagate-event-on-escape",
35939
+ "type": {
35940
+ "text": "boolean"
35941
+ },
35942
+ "description": "Propagates the event, when the escape key is pressed (only when pressed inside the popover)\nIf true, the escape key press close the popover and will propagate the keydown event.\nIf false, the escape key press will close the popover but will not propagate the keydown event.\n(set to false to prevent the event from bubbling up to the document).\n\nThis only works when `hideOnEscape` is true.",
35943
+ "default": "false",
35944
+ "fieldName": "propagateEventOnEscape",
35945
+ "inheritedFrom": {
35946
+ "name": "Popover",
35947
+ "module": "src/components/popover/popover.component.ts"
35948
+ }
35949
+ },
35818
35950
  {
35819
35951
  "name": "hide-on-blur",
35820
35952
  "type": {
@@ -37304,7 +37436,7 @@
37304
37436
  "text": "boolean"
37305
37437
  },
37306
37438
  "default": "true",
37307
- "description": "Determines whether focus should wrap around when reaching the first or last focusable element.\nIf true, focus will cycle from end to start and vice versa.\n\nThis only applies when `enabledFocusTrap` is true.",
37439
+ "description": "Determines whether focus should wrap around when reaching the first or last focusable element.\nIf true, focus will cycle from end to start and vice versa.\n\nThis only applies when `focusTrap` is true.",
37308
37440
  "attribute": "should-focus-trap-wrap",
37309
37441
  "reflects": true
37310
37442
  },
@@ -37536,12 +37668,12 @@
37536
37668
  "description": "The set of focusable elements."
37537
37669
  }
37538
37670
  ],
37539
- "description": "Recursively finds all focusable elements within the given root and its descendants."
37671
+ "description": "Recursively finds all focusable elements within the given root and its descendants.\n\nMake sure this is performant, as it will be called multiple times."
37540
37672
  },
37541
37673
  {
37542
37674
  "kind": "method",
37543
37675
  "name": "setFocusableElements",
37544
- "privacy": "public",
37676
+ "privacy": "private",
37545
37677
  "description": "Updates the list of focusable elements within the component's shadow root."
37546
37678
  },
37547
37679
  {
@@ -37683,7 +37815,7 @@
37683
37815
  "text": "boolean"
37684
37816
  },
37685
37817
  "default": "true",
37686
- "description": "Determines whether focus should wrap around when reaching the first or last focusable element.\nIf true, focus will cycle from end to start and vice versa.\n\nThis only applies when `enabledFocusTrap` is true.",
37818
+ "description": "Determines whether focus should wrap around when reaching the first or last focusable element.\nIf true, focus will cycle from end to start and vice versa.\n\nThis only applies when `focusTrap` is true.",
37687
37819
  "fieldName": "shouldFocusTrapWrap"
37688
37820
  },
37689
37821
  {