@momentum-design/components 0.95.6 → 0.95.7

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.
@@ -5277,12 +5277,12 @@
5277
5277
  },
5278
5278
  {
5279
5279
  "kind": "javascript-module",
5280
- "path": "components/cardcheckbox/cardcheckbox.component.js",
5280
+ "path": "components/cardradio/cardradio.component.js",
5281
5281
  "declarations": [
5282
5282
  {
5283
5283
  "kind": "class",
5284
- "description": "cardcheckbox component extends `mdc-card` and supports checkbox selection interaction addtionally.\n\nWhile using this component within a form or group of cards, make sure cards are in a role = \"checkbox-group\".\nThis card would have events for selected and unselected (similar to checkbox)\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.",
5285
- "name": "CardCheckbox",
5284
+ "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.",
5285
+ "name": "CardRadio",
5286
5286
  "slots": [
5287
5287
  {
5288
5288
  "description": "This slot is for passing the content before the body",
@@ -5355,20 +5355,76 @@
5355
5355
  },
5356
5356
  {
5357
5357
  "kind": "field",
5358
- "name": "selectionType",
5358
+ "name": "name",
5359
5359
  "type": {
5360
- "text": "SelectionType"
5360
+ "text": "string"
5361
5361
  },
5362
- "description": "The selection type of the card. It can either be set to 'check' or 'checkbox'",
5363
- "default": "'check'",
5364
- "attribute": "selection-type",
5365
- "reflects": true
5362
+ "default": "''",
5363
+ "description": "The name of the radio.",
5364
+ "attribute": "name"
5365
+ },
5366
+ {
5367
+ "kind": "method",
5368
+ "name": "getAllCardsWithinSameGroup",
5369
+ "privacy": "private",
5370
+ "return": {
5371
+ "type": {
5372
+ "text": "CardRadio[]"
5373
+ }
5374
+ },
5375
+ "description": "Returns all cards within the same group (name)."
5366
5376
  },
5367
5377
  {
5368
5378
  "kind": "method",
5369
5379
  "name": "toggleChecked",
5370
5380
  "privacy": "private",
5371
- "description": "Toggles the checked state"
5381
+ "return": {
5382
+ "type": {
5383
+ "text": "void"
5384
+ }
5385
+ },
5386
+ "description": "Handles the change event on the radio element.\nThis will toggle the state of the radio element.\nDispatches the change event."
5387
+ },
5388
+ {
5389
+ "kind": "method",
5390
+ "name": "setDisabled",
5391
+ "return": {
5392
+ "type": {
5393
+ "text": "void"
5394
+ }
5395
+ },
5396
+ "parameters": [
5397
+ {
5398
+ "name": "disabled",
5399
+ "type": {
5400
+ "text": "boolean"
5401
+ }
5402
+ }
5403
+ ]
5404
+ },
5405
+ {
5406
+ "kind": "method",
5407
+ "name": "updateCardRadio",
5408
+ "privacy": "private",
5409
+ "return": {
5410
+ "type": {
5411
+ "text": "void"
5412
+ }
5413
+ },
5414
+ "parameters": [
5415
+ {
5416
+ "name": "cards",
5417
+ "type": {
5418
+ "text": "CardRadio[]"
5419
+ }
5420
+ },
5421
+ {
5422
+ "name": "index",
5423
+ "type": {
5424
+ "text": "number"
5425
+ }
5426
+ }
5427
+ ]
5372
5428
  },
5373
5429
  {
5374
5430
  "kind": "method",
@@ -5400,17 +5456,6 @@
5400
5456
  ],
5401
5457
  "description": "Toggles the checked state when space key is used"
5402
5458
  },
5403
- {
5404
- "kind": "method",
5405
- "name": "renderSelection",
5406
- "privacy": "private",
5407
- "description": "Renders the selection icon or checkbox based on the selection type",
5408
- "return": {
5409
- "type": {
5410
- "text": ""
5411
- }
5412
- }
5413
- },
5414
5459
  {
5415
5460
  "kind": "method",
5416
5461
  "name": "renderHeader",
@@ -5689,13 +5734,13 @@
5689
5734
  "fieldName": "checked"
5690
5735
  },
5691
5736
  {
5692
- "name": "selection-type",
5737
+ "name": "name",
5693
5738
  "type": {
5694
- "text": "SelectionType"
5739
+ "text": "string"
5695
5740
  },
5696
- "description": "The selection type of the card. It can either be set to 'check' or 'checkbox'",
5697
- "default": "'check'",
5698
- "fieldName": "selectionType"
5741
+ "default": "''",
5742
+ "description": "The name of the radio.",
5743
+ "fieldName": "name"
5699
5744
  },
5700
5745
  {
5701
5746
  "name": "disabled",
@@ -5854,8 +5899,8 @@
5854
5899
  "name": "Card",
5855
5900
  "module": "/src/components/card/card.component"
5856
5901
  },
5857
- "tagName": "mdc-cardcheckbox",
5858
- "jsDoc": "/**\n * cardcheckbox component extends `mdc-card` and supports checkbox selection interaction addtionally.\n *\n * While using this component within a form or group of cards, make sure cards are in a role = \"checkbox-group\".\n * This card would have events for selected and unselected (similar to checkbox)\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-cardcheckbox\n *\n * @dependency mdc-icon\n * @dependency mdc-staticcheckbox\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 */",
5902
+ "tagName": "mdc-cardradio",
5903
+ "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 */",
5859
5904
  "customElement": true
5860
5905
  }
5861
5906
  ],
@@ -5864,76 +5909,40 @@
5864
5909
  "kind": "js",
5865
5910
  "name": "default",
5866
5911
  "declaration": {
5867
- "name": "CardCheckbox",
5868
- "module": "components/cardcheckbox/cardcheckbox.component.js"
5912
+ "name": "CardRadio",
5913
+ "module": "components/cardradio/cardradio.component.js"
5869
5914
  }
5870
5915
  }
5871
5916
  ]
5872
5917
  },
5873
5918
  {
5874
5919
  "kind": "javascript-module",
5875
- "path": "components/cardradio/cardradio.component.js",
5920
+ "path": "components/checkbox/checkbox.component.js",
5876
5921
  "declarations": [
5877
5922
  {
5878
5923
  "kind": "class",
5879
- "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.",
5880
- "name": "CardRadio",
5881
- "slots": [
5882
- {
5883
- "description": "This slot is for passing the content before the body",
5884
- "name": "before-body",
5885
- "inheritedFrom": {
5886
- "name": "Card",
5887
- "module": "src/components/card/card.component.ts"
5888
- }
5889
- },
5890
- {
5891
- "description": "This slot is for passing the text content for the card",
5892
- "name": "body",
5893
- "inheritedFrom": {
5894
- "name": "Card",
5895
- "module": "src/components/card/card.component.ts"
5896
- }
5897
- },
5924
+ "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.",
5925
+ "name": "Checkbox",
5926
+ "cssProperties": [
5898
5927
  {
5899
- "description": "This slot is for passing the content after the body",
5900
- "name": "after-body",
5901
- "inheritedFrom": {
5902
- "name": "Card",
5903
- "module": "src/components/card/card.component.ts"
5904
- }
5928
+ "description": "Allows customization of the background color on hover.",
5929
+ "name": "--mdc-checkbox-background-color-hover"
5905
5930
  },
5906
5931
  {
5907
- "description": "This slot is for passing `mdc-link` component within the footer section.",
5908
- "name": "footer-link",
5909
- "inheritedFrom": {
5910
- "name": "Card",
5911
- "module": "src/components/card/card.component.ts"
5912
- }
5932
+ "description": "Background color for a selected checkbox when hovered.",
5933
+ "name": "--mdc-checkbox-checked-background-color-hover"
5913
5934
  },
5914
5935
  {
5915
- "description": "This slot is for passing primary variant of `mdc-button` component within the footer section.",
5916
- "name": "footer-button-primary",
5917
- "inheritedFrom": {
5918
- "name": "Card",
5919
- "module": "src/components/card/card.component.ts"
5920
- }
5936
+ "description": "Background color for a selected checkbox when pressed.",
5937
+ "name": "--mdc-checkbox-checked-pressed-icon-color"
5921
5938
  },
5922
5939
  {
5923
- "description": "This slot is for passing secondary variant of `mdc-button` component within the footer section.",
5924
- "name": "footer-button-secondary",
5925
- "inheritedFrom": {
5926
- "name": "Card",
5927
- "module": "src/components/card/card.component.ts"
5928
- }
5940
+ "description": "Background color for a selected checkbox when pressed.",
5941
+ "name": "--mdc-checkbox-pressed-icon-color"
5929
5942
  },
5930
5943
  {
5931
- "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.",
5932
- "name": "footer",
5933
- "inheritedFrom": {
5934
- "name": "Card",
5935
- "module": "src/components/card/card.component.ts"
5936
- }
5944
+ "description": "Background color for a selected checkbox when disabled.",
5945
+ "name": "--mdc-checkbox-disabled-checked-icon-color"
5937
5946
  }
5938
5947
  ],
5939
5948
  "members": [
@@ -5944,45 +5953,59 @@
5944
5953
  "text": "boolean"
5945
5954
  },
5946
5955
  "default": "false",
5947
- "description": "The checked state of the card",
5956
+ "description": "Determines whether the checkbox is selected or unselected.",
5948
5957
  "attribute": "checked",
5949
5958
  "reflects": true
5950
5959
  },
5951
5960
  {
5952
5961
  "kind": "field",
5953
- "name": "name",
5962
+ "name": "indeterminate",
5954
5963
  "type": {
5955
- "text": "string"
5964
+ "text": "boolean"
5956
5965
  },
5957
- "default": "''",
5958
- "description": "The name of the radio.",
5959
- "attribute": "name"
5966
+ "default": "false",
5967
+ "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.",
5968
+ "attribute": "indeterminate",
5969
+ "reflects": true
5970
+ },
5971
+ {
5972
+ "kind": "field",
5973
+ "name": "autofocus",
5974
+ "type": {
5975
+ "text": "boolean"
5976
+ },
5977
+ "default": "false",
5978
+ "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)",
5979
+ "attribute": "autofocus",
5980
+ "reflects": true
5960
5981
  },
5961
5982
  {
5962
5983
  "kind": "method",
5963
- "name": "getAllCardsWithinSameGroup",
5984
+ "name": "setFormValue",
5964
5985
  "privacy": "private",
5965
- "return": {
5966
- "type": {
5967
- "text": "CardRadio[]"
5968
- }
5969
- },
5970
- "description": "Returns all cards within the same group (name)."
5986
+ "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."
5971
5987
  },
5972
5988
  {
5973
5989
  "kind": "method",
5974
- "name": "toggleChecked",
5990
+ "name": "manageRequired",
5991
+ "privacy": "private",
5992
+ "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."
5993
+ },
5994
+ {
5995
+ "kind": "method",
5996
+ "name": "toggleState",
5975
5997
  "privacy": "private",
5976
5998
  "return": {
5977
5999
  "type": {
5978
6000
  "text": "void"
5979
6001
  }
5980
6002
  },
5981
- "description": "Handles the change event on the radio element.\nThis will toggle the state of the radio element.\nDispatches the change event."
6003
+ "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."
5982
6004
  },
5983
6005
  {
5984
6006
  "kind": "method",
5985
- "name": "setDisabled",
6007
+ "name": "handleKeyDown",
6008
+ "privacy": "private",
5986
6009
  "return": {
5987
6010
  "type": {
5988
6011
  "text": "void"
@@ -5990,330 +6013,372 @@
5990
6013
  },
5991
6014
  "parameters": [
5992
6015
  {
5993
- "name": "disabled",
6016
+ "name": "event",
5994
6017
  "type": {
5995
- "text": "boolean"
5996
- }
6018
+ "text": "KeyboardEvent"
6019
+ },
6020
+ "description": "The keyboard event."
5997
6021
  }
5998
- ]
6022
+ ],
6023
+ "description": "Handles the keydown event on the checkbox.\nWhen the user presses Enter, the form is submitted."
5999
6024
  },
6000
6025
  {
6001
6026
  "kind": "method",
6002
- "name": "updateCardRadio",
6003
- "privacy": "private",
6027
+ "name": "handleChange",
6028
+ "privacy": "public",
6004
6029
  "return": {
6005
6030
  "type": {
6006
6031
  "text": "void"
6007
6032
  }
6008
6033
  },
6009
- "parameters": [
6010
- {
6011
- "name": "cards",
6012
- "type": {
6013
- "text": "CardRadio[]"
6014
- }
6015
- },
6016
- {
6017
- "name": "index",
6018
- "type": {
6019
- "text": "number"
6020
- }
6021
- }
6022
- ]
6023
- },
6024
- {
6025
- "kind": "method",
6026
- "name": "toggleOnEnter",
6027
- "privacy": "private",
6028
6034
  "parameters": [
6029
6035
  {
6030
6036
  "name": "event",
6031
6037
  "type": {
6032
- "text": "KeyboardEvent"
6033
- },
6034
- "description": "The keyboard event"
6038
+ "text": "Event"
6039
+ }
6035
6040
  }
6036
6041
  ],
6037
- "description": "Toggles the checked state when enter key is used"
6042
+ "description": "Toggles the state of the checkbox element.\nand dispatch the new change event."
6038
6043
  },
6039
6044
  {
6040
- "kind": "method",
6041
- "name": "toggleOnSpace",
6042
- "privacy": "private",
6043
- "parameters": [
6044
- {
6045
- "name": "event",
6046
- "type": {
6047
- "text": "KeyboardEvent"
6048
- },
6049
- "description": "The keyboard event"
6050
- }
6051
- ],
6052
- "description": "Toggles the checked state when space key is used"
6045
+ "kind": "field",
6046
+ "name": "renderLabelAndHelperText",
6047
+ "privacy": "private"
6048
+ },
6049
+ {
6050
+ "kind": "field",
6051
+ "name": "name",
6052
+ "type": {
6053
+ "text": "string"
6054
+ },
6055
+ "default": "''",
6056
+ "description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
6057
+ "attribute": "name",
6058
+ "reflects": true,
6059
+ "inheritedFrom": {
6060
+ "name": "FormInternalsMixin",
6061
+ "module": "utils/mixins/FormInternalsMixin.js"
6062
+ }
6063
+ },
6064
+ {
6065
+ "kind": "field",
6066
+ "name": "value",
6067
+ "type": {
6068
+ "text": "string"
6069
+ },
6070
+ "default": "''",
6071
+ "description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
6072
+ "attribute": "value",
6073
+ "reflects": true,
6074
+ "inheritedFrom": {
6075
+ "name": "FormInternalsMixin",
6076
+ "module": "utils/mixins/FormInternalsMixin.js"
6077
+ }
6078
+ },
6079
+ {
6080
+ "kind": "field",
6081
+ "name": "validationMessage",
6082
+ "type": {
6083
+ "text": "string | undefined"
6084
+ },
6085
+ "description": "Custom validation message that will override the default message and displayed when the input is invalid.\n\nTo display custom validation messages, you must listen for input events (or other relevant events)\non your component and update the `validationMessage` property with the desired message string.\nUpdating this property will ensure that new validation messages are shown to the user.\n- The `validationMessage` property overrides the default browser validation message when set.\n- Consumers are responsible for updating `validationMessage` in response to input or validation state changes.",
6086
+ "attribute": "validation-message",
6087
+ "reflects": true,
6088
+ "inheritedFrom": {
6089
+ "name": "FormInternalsMixin",
6090
+ "module": "utils/mixins/FormInternalsMixin.js"
6091
+ }
6092
+ },
6093
+ {
6094
+ "kind": "field",
6095
+ "name": "validity",
6096
+ "type": {
6097
+ "text": "ValidityState"
6098
+ },
6099
+ "readonly": true,
6100
+ "inheritedFrom": {
6101
+ "name": "FormInternalsMixin",
6102
+ "module": "utils/mixins/FormInternalsMixin.js"
6103
+ }
6104
+ },
6105
+ {
6106
+ "kind": "field",
6107
+ "name": "willValidate",
6108
+ "readonly": true,
6109
+ "inheritedFrom": {
6110
+ "name": "FormInternalsMixin",
6111
+ "module": "utils/mixins/FormInternalsMixin.js"
6112
+ }
6053
6113
  },
6054
6114
  {
6055
6115
  "kind": "method",
6056
- "name": "renderHeader",
6057
- "privacy": "protected",
6058
- "description": "Renders the header of the card",
6116
+ "name": "setValidity",
6117
+ "description": "Sets the validity of the input field based on the input field's validity.",
6059
6118
  "return": {
6060
6119
  "type": {
6061
6120
  "text": ""
6062
6121
  }
6063
6122
  },
6064
6123
  "inheritedFrom": {
6065
- "name": "Card",
6066
- "module": "components/card/card.component.js"
6124
+ "name": "FormInternalsMixin",
6125
+ "module": "utils/mixins/FormInternalsMixin.js"
6067
6126
  }
6068
6127
  },
6069
6128
  {
6070
- "kind": "field",
6071
- "name": "disabled",
6072
- "type": {
6073
- "text": "boolean | undefined"
6129
+ "kind": "method",
6130
+ "name": "checkValidity",
6131
+ "return": {
6132
+ "type": {
6133
+ "text": "boolean"
6134
+ }
6074
6135
  },
6075
- "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
6076
- "default": "undefined",
6077
- "attribute": "disabled",
6078
- "reflects": true,
6079
6136
  "inheritedFrom": {
6080
- "name": "DisabledMixin",
6081
- "module": "utils/mixins/DisabledMixin.js"
6137
+ "name": "FormInternalsMixin",
6138
+ "module": "utils/mixins/FormInternalsMixin.js"
6139
+ }
6140
+ },
6141
+ {
6142
+ "kind": "method",
6143
+ "name": "reportValidity",
6144
+ "inheritedFrom": {
6145
+ "name": "FormInternalsMixin",
6146
+ "module": "utils/mixins/FormInternalsMixin.js"
6082
6147
  }
6083
6148
  },
6084
6149
  {
6085
6150
  "kind": "field",
6086
- "name": "tabIndex",
6151
+ "name": "dataAriaLabel",
6087
6152
  "type": {
6088
- "text": "number"
6153
+ "text": "string | null"
6089
6154
  },
6090
- "default": "0",
6091
- "description": "This property specifies the tab order of the element.",
6092
- "attribute": "tabIndex",
6155
+ "default": "null",
6156
+ "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
6157
+ "attribute": "data-aria-label",
6093
6158
  "reflects": true,
6094
6159
  "inheritedFrom": {
6095
- "name": "TabIndexMixin",
6096
- "module": "utils/mixins/TabIndexMixin.js"
6160
+ "name": "DataAriaLabelMixin",
6161
+ "module": "utils/mixins/DataAriaLabelMixin.js"
6097
6162
  }
6098
6163
  },
6099
6164
  {
6100
6165
  "kind": "field",
6101
- "name": "cardTitle",
6166
+ "name": "disabled",
6102
6167
  "type": {
6103
- "text": "string"
6168
+ "text": "boolean | undefined"
6104
6169
  },
6105
- "default": "''",
6106
- "description": "The title of the card - part of header section",
6107
- "attribute": "card-title",
6170
+ "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
6171
+ "default": "undefined",
6172
+ "attribute": "disabled",
6108
6173
  "reflects": true,
6109
6174
  "inheritedFrom": {
6110
- "name": "Card",
6111
- "module": "components/card/card.component.js"
6175
+ "name": "DisabledMixin",
6176
+ "module": "utils/mixins/DisabledMixin.js"
6112
6177
  }
6113
6178
  },
6114
6179
  {
6115
6180
  "kind": "field",
6116
- "name": "subtitle",
6181
+ "name": "label",
6117
6182
  "type": {
6118
- "text": "string"
6183
+ "text": "string | undefined"
6119
6184
  },
6120
- "default": "''",
6121
- "description": "The subtitle of the card - part of header section",
6122
- "attribute": "subtitle",
6185
+ "description": "The label of the input field. It is linked to the input field using the `for` attribute.",
6186
+ "attribute": "label",
6123
6187
  "reflects": true,
6124
6188
  "inheritedFrom": {
6125
- "name": "Card",
6126
- "module": "components/card/card.component.js"
6189
+ "name": "FormfieldWrapper",
6190
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
6127
6191
  }
6128
6192
  },
6129
6193
  {
6130
6194
  "kind": "field",
6131
- "name": "imageSrc",
6195
+ "name": "required",
6132
6196
  "type": {
6133
- "text": "string"
6197
+ "text": "boolean"
6134
6198
  },
6135
- "default": "''",
6136
- "description": "The image source URL to render on the card",
6137
- "attribute": "image-src",
6199
+ "default": "false",
6200
+ "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
6201
+ "attribute": "required",
6138
6202
  "reflects": true,
6139
6203
  "inheritedFrom": {
6140
- "name": "Card",
6141
- "module": "components/card/card.component.js"
6204
+ "name": "FormfieldWrapper",
6205
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
6142
6206
  }
6143
6207
  },
6144
6208
  {
6145
6209
  "kind": "field",
6146
- "name": "imageAlt",
6210
+ "name": "id",
6147
6211
  "type": {
6148
6212
  "text": "string"
6149
6213
  },
6150
6214
  "default": "''",
6151
- "description": "The image alt for accessibility support",
6152
- "attribute": "image-alt",
6153
- "reflects": true,
6215
+ "description": "The unique id of the input field. It is used to link the input field with the label.",
6216
+ "attribute": "id",
6154
6217
  "inheritedFrom": {
6155
- "name": "Card",
6156
- "module": "components/card/card.component.js"
6218
+ "name": "FormfieldWrapper",
6219
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
6157
6220
  }
6158
6221
  },
6159
6222
  {
6160
6223
  "kind": "field",
6161
- "name": "variant",
6224
+ "name": "helpTextType",
6162
6225
  "type": {
6163
- "text": "CardVariant"
6226
+ "text": "ValidationType"
6164
6227
  },
6165
- "description": "The variant of the card. It can either be set to 'border' or 'ghost'",
6166
- "default": "'border'",
6167
- "attribute": "variant",
6228
+ "description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
6229
+ "attribute": "help-text-type",
6168
6230
  "reflects": true,
6169
6231
  "inheritedFrom": {
6170
- "name": "Card",
6171
- "module": "components/card/card.component.js"
6232
+ "name": "FormfieldWrapper",
6233
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
6172
6234
  }
6173
6235
  },
6174
6236
  {
6175
6237
  "kind": "field",
6176
- "name": "orientation",
6238
+ "name": "helpText",
6177
6239
  "type": {
6178
- "text": "CardOrientation"
6240
+ "text": "string | undefined"
6179
6241
  },
6180
- "description": "The orientation of the card. It can either be set to 'vertical' or 'horizontal'",
6181
- "default": "'vertical'",
6182
- "attribute": "orientation",
6242
+ "description": "The help text that is displayed below the input field.",
6243
+ "attribute": "help-text",
6183
6244
  "reflects": true,
6184
6245
  "inheritedFrom": {
6185
- "name": "Card",
6186
- "module": "components/card/card.component.js"
6246
+ "name": "FormfieldWrapper",
6247
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
6187
6248
  }
6188
6249
  },
6189
6250
  {
6190
6251
  "kind": "field",
6191
- "name": "titleTagName",
6252
+ "name": "toggletipText",
6192
6253
  "type": {
6193
- "text": "TagNameType"
6254
+ "text": "string | undefined"
6194
6255
  },
6195
- "description": "The tag name for the card title. It supports all the types that `mdc-text` supports",
6196
- "default": "'span'",
6197
- "attribute": "title-tag-name",
6256
+ "description": "The toggletip text that is displayed when the label is hovered.\nIt is used to provide additional information about the label.",
6257
+ "attribute": "toggletip-text",
6198
6258
  "reflects": true,
6199
6259
  "inheritedFrom": {
6200
- "name": "Card",
6201
- "module": "components/card/card.component.js"
6260
+ "name": "FormfieldWrapper",
6261
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
6202
6262
  }
6203
6263
  },
6204
6264
  {
6205
6265
  "kind": "field",
6206
- "name": "subtitleTagName",
6266
+ "name": "toggletipPlacement",
6207
6267
  "type": {
6208
- "text": "TagNameType"
6268
+ "text": "PopoverPlacement"
6209
6269
  },
6210
- "description": "The tag name for the subtitle. It supports all the types that `mdc-text` supports",
6211
- "default": "'span'",
6212
- "attribute": "subtitle-tag-name",
6270
+ "description": "The placement of the toggletip that is displayed when the info icon is hovered.",
6271
+ "default": "'top'",
6272
+ "attribute": "toggletip-placement",
6213
6273
  "reflects": true,
6214
6274
  "inheritedFrom": {
6215
- "name": "Card",
6216
- "module": "components/card/card.component.js"
6275
+ "name": "FormfieldWrapper",
6276
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
6217
6277
  }
6218
6278
  },
6219
6279
  {
6220
6280
  "kind": "field",
6221
- "name": "iconName",
6281
+ "name": "infoIconAriaLabel",
6222
6282
  "type": {
6223
- "text": "IconNames | undefined"
6283
+ "text": "string | undefined"
6224
6284
  },
6225
- "description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
6226
- "attribute": "icon-name",
6285
+ "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.",
6286
+ "attribute": "info-icon-aria-label",
6227
6287
  "reflects": true,
6228
6288
  "inheritedFrom": {
6229
- "name": "Card",
6230
- "module": "components/card/card.component.js"
6289
+ "name": "FormfieldWrapper",
6290
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
6231
6291
  }
6232
6292
  },
6233
6293
  {
6234
6294
  "kind": "method",
6235
- "name": "renderImage",
6295
+ "name": "renderLabelElement",
6236
6296
  "privacy": "protected",
6237
- "description": "Renders the image on the card if image source is provided",
6297
+ "description": "creates the label element when the label property is set.\nid is used to link the label with the input field.",
6238
6298
  "return": {
6239
6299
  "type": {
6240
6300
  "text": ""
6241
6301
  }
6242
6302
  },
6243
6303
  "inheritedFrom": {
6244
- "name": "Card",
6245
- "module": "components/card/card.component.js"
6304
+ "name": "FormfieldWrapper",
6305
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
6246
6306
  }
6247
6307
  },
6248
6308
  {
6249
6309
  "kind": "method",
6250
- "name": "renderIcon",
6310
+ "name": "renderHelpTextIcon",
6251
6311
  "privacy": "protected",
6252
- "description": "Renders the icon on the card if icon name is provided",
6312
+ "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.",
6253
6313
  "return": {
6254
6314
  "type": {
6255
6315
  "text": ""
6256
6316
  }
6257
6317
  },
6258
6318
  "inheritedFrom": {
6259
- "name": "Card",
6260
- "module": "components/card/card.component.js"
6319
+ "name": "FormfieldWrapper",
6320
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
6261
6321
  }
6262
6322
  },
6263
6323
  {
6264
6324
  "kind": "method",
6265
- "name": "renderTitle",
6325
+ "name": "renderHelpText",
6266
6326
  "privacy": "protected",
6267
- "description": "Renders the title and subtitle on the card",
6327
+ "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.",
6268
6328
  "return": {
6269
6329
  "type": {
6270
6330
  "text": ""
6271
6331
  }
6272
6332
  },
6273
6333
  "inheritedFrom": {
6274
- "name": "Card",
6275
- "module": "components/card/card.component.js"
6334
+ "name": "FormfieldWrapper",
6335
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
6276
6336
  }
6277
6337
  },
6278
6338
  {
6279
6339
  "kind": "method",
6280
- "name": "renderFooter",
6340
+ "name": "renderLabel",
6281
6341
  "privacy": "protected",
6282
- "description": "Renders the footer of the card if footer-link,\nfooter-button-primary, or footer-button-secondary slots are provided",
6342
+ "description": "renders the mdc-label-text container that contains the label and labelInfoToggleTip.",
6283
6343
  "return": {
6284
6344
  "type": {
6285
6345
  "text": ""
6286
6346
  }
6287
6347
  },
6288
6348
  "inheritedFrom": {
6289
- "name": "Card",
6290
- "module": "components/card/card.component.js"
6349
+ "name": "FormfieldWrapper",
6350
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
6351
+ }
6352
+ },
6353
+ {
6354
+ "kind": "method",
6355
+ "name": "renderHelperText",
6356
+ "privacy": "protected",
6357
+ "description": "renders the mdc-help-text container that contains the helpertext icon and helpertext.",
6358
+ "return": {
6359
+ "type": {
6360
+ "text": ""
6361
+ }
6362
+ },
6363
+ "inheritedFrom": {
6364
+ "name": "FormfieldWrapper",
6365
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
6291
6366
  }
6292
6367
  }
6293
6368
  ],
6294
6369
  "events": [
6295
6370
  {
6296
- "description": "(React: onClick) Event that gets dispatched when the card is clicked. It toggles the checked state.",
6297
- "name": "click",
6298
- "reactName": "onClick"
6299
- },
6300
- {
6301
- "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.",
6302
- "name": "keydown",
6303
- "reactName": "onKeyDown"
6304
- },
6305
- {
6306
- "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.",
6307
- "name": "keyup",
6308
- "reactName": "onKeyUp"
6371
+ "type": {
6372
+ "text": "EventConstructor"
6373
+ }
6309
6374
  },
6310
6375
  {
6311
- "description": "(React: onChange) Event that gets dispatched when the card state changes.",
6376
+ "description": "(React: onChange) Event that gets dispatched when the checkbox state changes.",
6312
6377
  "name": "change",
6313
6378
  "reactName": "onChange"
6314
6379
  },
6315
6380
  {
6316
- "description": "(React: onFocus) Event that gets dispatched when the card receives focus.",
6381
+ "description": "(React: onFocus) Event that gets dispatched when the checkbox receives focus.",
6317
6382
  "name": "focus",
6318
6383
  "reactName": "onFocus"
6319
6384
  }
@@ -6325,178 +6390,208 @@
6325
6390
  "text": "boolean"
6326
6391
  },
6327
6392
  "default": "false",
6328
- "description": "The checked state of the card",
6393
+ "description": "Determines whether the checkbox is selected or unselected.",
6329
6394
  "fieldName": "checked"
6330
6395
  },
6396
+ {
6397
+ "name": "indeterminate",
6398
+ "type": {
6399
+ "text": "boolean"
6400
+ },
6401
+ "default": "false",
6402
+ "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.",
6403
+ "fieldName": "indeterminate"
6404
+ },
6405
+ {
6406
+ "name": "autofocus",
6407
+ "type": {
6408
+ "text": "boolean"
6409
+ },
6410
+ "default": "false",
6411
+ "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)",
6412
+ "fieldName": "autofocus"
6413
+ },
6331
6414
  {
6332
6415
  "name": "name",
6333
6416
  "type": {
6334
6417
  "text": "string"
6335
6418
  },
6336
6419
  "default": "''",
6337
- "description": "The name of the radio.",
6338
- "fieldName": "name"
6420
+ "description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
6421
+ "fieldName": "name",
6422
+ "inheritedFrom": {
6423
+ "name": "FormInternalsMixin",
6424
+ "module": "src/utils/mixins/FormInternalsMixin.ts"
6425
+ }
6339
6426
  },
6340
6427
  {
6341
- "name": "disabled",
6428
+ "name": "value",
6342
6429
  "type": {
6343
- "text": "boolean | undefined"
6430
+ "text": "string"
6344
6431
  },
6345
- "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
6346
- "default": "undefined",
6347
- "fieldName": "disabled",
6432
+ "default": "''",
6433
+ "description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
6434
+ "fieldName": "value",
6348
6435
  "inheritedFrom": {
6349
- "name": "DisabledMixin",
6350
- "module": "src/utils/mixins/DisabledMixin.ts"
6436
+ "name": "FormInternalsMixin",
6437
+ "module": "src/utils/mixins/FormInternalsMixin.ts"
6351
6438
  }
6352
6439
  },
6353
6440
  {
6354
- "name": "tabIndex",
6441
+ "name": "validation-message",
6355
6442
  "type": {
6356
- "text": "number"
6443
+ "text": "string | undefined"
6357
6444
  },
6358
- "default": "0",
6359
- "description": "This property specifies the tab order of the element.",
6360
- "fieldName": "tabIndex",
6445
+ "description": "Custom validation message that will override the default message and displayed when the input is invalid.\n\nTo display custom validation messages, you must listen for input events (or other relevant events)\non your component and update the `validationMessage` property with the desired message string.\nUpdating this property will ensure that new validation messages are shown to the user.\n- The `validationMessage` property overrides the default browser validation message when set.\n- Consumers are responsible for updating `validationMessage` in response to input or validation state changes.",
6446
+ "fieldName": "validationMessage",
6361
6447
  "inheritedFrom": {
6362
- "name": "TabIndexMixin",
6363
- "module": "src/utils/mixins/TabIndexMixin.ts"
6448
+ "name": "FormInternalsMixin",
6449
+ "module": "src/utils/mixins/FormInternalsMixin.ts"
6364
6450
  }
6365
6451
  },
6366
6452
  {
6367
- "name": "card-title",
6453
+ "name": "data-aria-label",
6368
6454
  "type": {
6369
- "text": "string"
6455
+ "text": "string | null"
6370
6456
  },
6371
- "default": "''",
6372
- "description": "The title of the card - part of header section",
6373
- "fieldName": "cardTitle",
6457
+ "default": "null",
6458
+ "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
6459
+ "fieldName": "dataAriaLabel",
6374
6460
  "inheritedFrom": {
6375
- "name": "Card",
6376
- "module": "src/components/card/card.component.ts"
6461
+ "name": "DataAriaLabelMixin",
6462
+ "module": "src/utils/mixins/DataAriaLabelMixin.ts"
6377
6463
  }
6378
6464
  },
6379
6465
  {
6380
- "name": "subtitle",
6466
+ "name": "disabled",
6381
6467
  "type": {
6382
- "text": "string"
6468
+ "text": "boolean | undefined"
6383
6469
  },
6384
- "default": "''",
6385
- "description": "The subtitle of the card - part of header section",
6386
- "fieldName": "subtitle",
6470
+ "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
6471
+ "default": "undefined",
6472
+ "fieldName": "disabled",
6387
6473
  "inheritedFrom": {
6388
- "name": "Card",
6389
- "module": "src/components/card/card.component.ts"
6474
+ "name": "DisabledMixin",
6475
+ "module": "src/utils/mixins/DisabledMixin.ts"
6390
6476
  }
6391
6477
  },
6392
6478
  {
6393
- "name": "image-src",
6479
+ "name": "label",
6394
6480
  "type": {
6395
- "text": "string"
6481
+ "text": "string | undefined"
6396
6482
  },
6397
- "default": "''",
6398
- "description": "The image source URL to render on the card",
6399
- "fieldName": "imageSrc",
6483
+ "description": "The label of the input field. It is linked to the input field using the `for` attribute.",
6484
+ "fieldName": "label",
6400
6485
  "inheritedFrom": {
6401
- "name": "Card",
6402
- "module": "src/components/card/card.component.ts"
6486
+ "name": "FormfieldWrapper",
6487
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
6403
6488
  }
6404
6489
  },
6405
6490
  {
6406
- "name": "image-alt",
6491
+ "name": "required",
6492
+ "type": {
6493
+ "text": "boolean"
6494
+ },
6495
+ "default": "false",
6496
+ "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
6497
+ "fieldName": "required",
6498
+ "inheritedFrom": {
6499
+ "name": "FormfieldWrapper",
6500
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
6501
+ }
6502
+ },
6503
+ {
6504
+ "name": "id",
6407
6505
  "type": {
6408
6506
  "text": "string"
6409
6507
  },
6410
6508
  "default": "''",
6411
- "description": "The image alt for accessibility support",
6412
- "fieldName": "imageAlt",
6509
+ "description": "The unique id of the input field. It is used to link the input field with the label.",
6510
+ "fieldName": "id",
6413
6511
  "inheritedFrom": {
6414
- "name": "Card",
6415
- "module": "src/components/card/card.component.ts"
6512
+ "name": "FormfieldWrapper",
6513
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
6416
6514
  }
6417
6515
  },
6418
6516
  {
6419
- "name": "variant",
6517
+ "name": "help-text-type",
6420
6518
  "type": {
6421
- "text": "CardVariant"
6519
+ "text": "ValidationType"
6422
6520
  },
6423
- "description": "The variant of the card. It can either be set to 'border' or 'ghost'",
6424
- "default": "'border'",
6425
- "fieldName": "variant",
6521
+ "description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
6522
+ "fieldName": "helpTextType",
6426
6523
  "inheritedFrom": {
6427
- "name": "Card",
6428
- "module": "src/components/card/card.component.ts"
6524
+ "name": "FormfieldWrapper",
6525
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
6429
6526
  }
6430
6527
  },
6431
6528
  {
6432
- "name": "orientation",
6529
+ "name": "help-text",
6433
6530
  "type": {
6434
- "text": "CardOrientation"
6531
+ "text": "string | undefined"
6435
6532
  },
6436
- "description": "The orientation of the card. It can either be set to 'vertical' or 'horizontal'",
6437
- "default": "'vertical'",
6438
- "fieldName": "orientation",
6533
+ "description": "The help text that is displayed below the input field.",
6534
+ "fieldName": "helpText",
6439
6535
  "inheritedFrom": {
6440
- "name": "Card",
6441
- "module": "src/components/card/card.component.ts"
6536
+ "name": "FormfieldWrapper",
6537
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
6442
6538
  }
6443
6539
  },
6444
6540
  {
6445
- "name": "title-tag-name",
6541
+ "name": "toggletip-text",
6446
6542
  "type": {
6447
- "text": "TagNameType"
6543
+ "text": "string | undefined"
6448
6544
  },
6449
- "description": "The tag name for the card title. It supports all the types that `mdc-text` supports",
6450
- "default": "'span'",
6451
- "fieldName": "titleTagName",
6545
+ "description": "The toggletip text that is displayed when the label is hovered.\nIt is used to provide additional information about the label.",
6546
+ "fieldName": "toggletipText",
6452
6547
  "inheritedFrom": {
6453
- "name": "Card",
6454
- "module": "src/components/card/card.component.ts"
6548
+ "name": "FormfieldWrapper",
6549
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
6455
6550
  }
6456
6551
  },
6457
6552
  {
6458
- "name": "subtitle-tag-name",
6553
+ "name": "toggletip-placement",
6459
6554
  "type": {
6460
- "text": "TagNameType"
6555
+ "text": "PopoverPlacement"
6461
6556
  },
6462
- "description": "The tag name for the subtitle. It supports all the types that `mdc-text` supports",
6463
- "default": "'span'",
6464
- "fieldName": "subtitleTagName",
6557
+ "description": "The placement of the toggletip that is displayed when the info icon is hovered.",
6558
+ "default": "'top'",
6559
+ "fieldName": "toggletipPlacement",
6465
6560
  "inheritedFrom": {
6466
- "name": "Card",
6467
- "module": "src/components/card/card.component.ts"
6561
+ "name": "FormfieldWrapper",
6562
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
6468
6563
  }
6469
6564
  },
6470
6565
  {
6471
- "name": "icon-name",
6566
+ "name": "info-icon-aria-label",
6472
6567
  "type": {
6473
- "text": "IconNames | undefined"
6568
+ "text": "string | undefined"
6474
6569
  },
6475
- "description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
6476
- "fieldName": "iconName",
6570
+ "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.",
6571
+ "fieldName": "infoIconAriaLabel",
6477
6572
  "inheritedFrom": {
6478
- "name": "Card",
6479
- "module": "src/components/card/card.component.ts"
6573
+ "name": "FormfieldWrapper",
6574
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
6480
6575
  }
6481
6576
  }
6482
6577
  ],
6483
6578
  "mixins": [
6484
6579
  {
6485
- "name": "DisabledMixin",
6486
- "module": "/src/utils/mixins/DisabledMixin"
6580
+ "name": "FormInternalsMixin",
6581
+ "module": "/src/utils/mixins/FormInternalsMixin"
6487
6582
  },
6488
6583
  {
6489
- "name": "TabIndexMixin",
6490
- "module": "/src/utils/mixins/TabIndexMixin"
6584
+ "name": "DataAriaLabelMixin",
6585
+ "module": "/src/utils/mixins/DataAriaLabelMixin"
6491
6586
  }
6492
6587
  ],
6493
6588
  "superclass": {
6494
- "name": "Card",
6495
- "module": "/src/components/card/card.component"
6589
+ "name": "FormfieldWrapper",
6590
+ "module": "/src/components/formfieldwrapper/formfieldwrapper.component"
6496
6591
  },
6497
- "tagName": "mdc-cardradio",
6498
- "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 */",
6499
- "customElement": true
6592
+ "tagName": "mdc-checkbox",
6593
+ "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 */",
6594
+ "customElement": true
6500
6595
  }
6501
6596
  ],
6502
6597
  "exports": [
@@ -6504,40 +6599,76 @@
6504
6599
  "kind": "js",
6505
6600
  "name": "default",
6506
6601
  "declaration": {
6507
- "name": "CardRadio",
6508
- "module": "components/cardradio/cardradio.component.js"
6602
+ "name": "Checkbox",
6603
+ "module": "components/checkbox/checkbox.component.js"
6509
6604
  }
6510
6605
  }
6511
6606
  ]
6512
6607
  },
6513
6608
  {
6514
6609
  "kind": "javascript-module",
6515
- "path": "components/checkbox/checkbox.component.js",
6610
+ "path": "components/cardcheckbox/cardcheckbox.component.js",
6516
6611
  "declarations": [
6517
6612
  {
6518
6613
  "kind": "class",
6519
- "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.",
6520
- "name": "Checkbox",
6521
- "cssProperties": [
6614
+ "description": "cardcheckbox component extends `mdc-card` and supports checkbox selection interaction addtionally.\n\nWhile using this component within a form or group of cards, make sure cards are in a role = \"checkbox-group\".\nThis card would have events for selected and unselected (similar to checkbox)\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.",
6615
+ "name": "CardCheckbox",
6616
+ "slots": [
6522
6617
  {
6523
- "description": "Allows customization of the background color on hover.",
6524
- "name": "--mdc-checkbox-background-color-hover"
6618
+ "description": "This slot is for passing the content before the body",
6619
+ "name": "before-body",
6620
+ "inheritedFrom": {
6621
+ "name": "Card",
6622
+ "module": "src/components/card/card.component.ts"
6623
+ }
6525
6624
  },
6526
6625
  {
6527
- "description": "Background color for a selected checkbox when hovered.",
6528
- "name": "--mdc-checkbox-checked-background-color-hover"
6626
+ "description": "This slot is for passing the text content for the card",
6627
+ "name": "body",
6628
+ "inheritedFrom": {
6629
+ "name": "Card",
6630
+ "module": "src/components/card/card.component.ts"
6631
+ }
6529
6632
  },
6530
6633
  {
6531
- "description": "Background color for a selected checkbox when pressed.",
6532
- "name": "--mdc-checkbox-checked-pressed-icon-color"
6634
+ "description": "This slot is for passing the content after the body",
6635
+ "name": "after-body",
6636
+ "inheritedFrom": {
6637
+ "name": "Card",
6638
+ "module": "src/components/card/card.component.ts"
6639
+ }
6533
6640
  },
6534
6641
  {
6535
- "description": "Background color for a selected checkbox when pressed.",
6536
- "name": "--mdc-checkbox-pressed-icon-color"
6642
+ "description": "This slot is for passing `mdc-link` component within the footer section.",
6643
+ "name": "footer-link",
6644
+ "inheritedFrom": {
6645
+ "name": "Card",
6646
+ "module": "src/components/card/card.component.ts"
6647
+ }
6537
6648
  },
6538
6649
  {
6539
- "description": "Background color for a selected checkbox when disabled.",
6540
- "name": "--mdc-checkbox-disabled-checked-icon-color"
6650
+ "description": "This slot is for passing primary variant of `mdc-button` component within the footer section.",
6651
+ "name": "footer-button-primary",
6652
+ "inheritedFrom": {
6653
+ "name": "Card",
6654
+ "module": "src/components/card/card.component.ts"
6655
+ }
6656
+ },
6657
+ {
6658
+ "description": "This slot is for passing secondary variant of `mdc-button` component within the footer section.",
6659
+ "name": "footer-button-secondary",
6660
+ "inheritedFrom": {
6661
+ "name": "Card",
6662
+ "module": "src/components/card/card.component.ts"
6663
+ }
6664
+ },
6665
+ {
6666
+ "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.",
6667
+ "name": "footer",
6668
+ "inheritedFrom": {
6669
+ "name": "Card",
6670
+ "module": "src/components/card/card.component.ts"
6671
+ }
6541
6672
  }
6542
6673
  ],
6543
6674
  "members": [
@@ -6548,432 +6679,331 @@
6548
6679
  "text": "boolean"
6549
6680
  },
6550
6681
  "default": "false",
6551
- "description": "Determines whether the checkbox is selected or unselected.",
6682
+ "description": "The checked state of the card",
6552
6683
  "attribute": "checked",
6553
6684
  "reflects": true
6554
6685
  },
6555
6686
  {
6556
6687
  "kind": "field",
6557
- "name": "indeterminate",
6558
- "type": {
6559
- "text": "boolean"
6560
- },
6561
- "default": "false",
6562
- "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.",
6563
- "attribute": "indeterminate",
6564
- "reflects": true
6565
- },
6566
- {
6567
- "kind": "field",
6568
- "name": "autofocus",
6688
+ "name": "selectionType",
6569
6689
  "type": {
6570
- "text": "boolean"
6690
+ "text": "SelectionType"
6571
6691
  },
6572
- "default": "false",
6573
- "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)",
6574
- "attribute": "autofocus",
6692
+ "description": "The selection type of the card. It can either be set to 'check' or 'checkbox'",
6693
+ "default": "'check'",
6694
+ "attribute": "selection-type",
6575
6695
  "reflects": true
6576
6696
  },
6577
6697
  {
6578
6698
  "kind": "method",
6579
- "name": "setFormValue",
6580
- "privacy": "private",
6581
- "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."
6582
- },
6583
- {
6584
- "kind": "method",
6585
- "name": "manageRequired",
6699
+ "name": "toggleChecked",
6586
6700
  "privacy": "private",
6587
- "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."
6701
+ "description": "Toggles the checked state"
6588
6702
  },
6589
6703
  {
6590
6704
  "kind": "method",
6591
- "name": "toggleState",
6705
+ "name": "toggleOnEnter",
6592
6706
  "privacy": "private",
6593
- "return": {
6594
- "type": {
6595
- "text": "void"
6707
+ "parameters": [
6708
+ {
6709
+ "name": "event",
6710
+ "type": {
6711
+ "text": "KeyboardEvent"
6712
+ },
6713
+ "description": "The keyboard event"
6596
6714
  }
6597
- },
6598
- "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."
6715
+ ],
6716
+ "description": "Toggles the checked state when enter key is used"
6599
6717
  },
6600
6718
  {
6601
6719
  "kind": "method",
6602
- "name": "handleKeyDown",
6720
+ "name": "toggleOnSpace",
6603
6721
  "privacy": "private",
6604
- "return": {
6605
- "type": {
6606
- "text": "void"
6607
- }
6608
- },
6609
6722
  "parameters": [
6610
6723
  {
6611
6724
  "name": "event",
6612
6725
  "type": {
6613
6726
  "text": "KeyboardEvent"
6614
6727
  },
6615
- "description": "The keyboard event."
6728
+ "description": "The keyboard event"
6616
6729
  }
6617
6730
  ],
6618
- "description": "Handles the keydown event on the checkbox.\nWhen the user presses Enter, the form is submitted."
6731
+ "description": "Toggles the checked state when space key is used"
6619
6732
  },
6620
6733
  {
6621
6734
  "kind": "method",
6622
- "name": "handleChange",
6623
- "privacy": "public",
6735
+ "name": "renderSelection",
6736
+ "privacy": "private",
6737
+ "description": "Renders the selection icon or checkbox based on the selection type",
6624
6738
  "return": {
6625
6739
  "type": {
6626
- "text": "void"
6740
+ "text": ""
6627
6741
  }
6628
- },
6629
- "parameters": [
6630
- {
6631
- "name": "event",
6632
- "type": {
6633
- "text": "Event"
6634
- }
6742
+ }
6743
+ },
6744
+ {
6745
+ "kind": "method",
6746
+ "name": "renderHeader",
6747
+ "privacy": "protected",
6748
+ "description": "Renders the header of the card",
6749
+ "return": {
6750
+ "type": {
6751
+ "text": ""
6635
6752
  }
6636
- ],
6637
- "description": "Toggles the state of the checkbox element.\nand dispatch the new change event."
6753
+ },
6754
+ "inheritedFrom": {
6755
+ "name": "Card",
6756
+ "module": "components/card/card.component.js"
6757
+ }
6638
6758
  },
6639
6759
  {
6640
6760
  "kind": "field",
6641
- "name": "renderLabelAndHelperText",
6642
- "privacy": "private"
6761
+ "name": "disabled",
6762
+ "type": {
6763
+ "text": "boolean | undefined"
6764
+ },
6765
+ "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
6766
+ "default": "undefined",
6767
+ "attribute": "disabled",
6768
+ "reflects": true,
6769
+ "inheritedFrom": {
6770
+ "name": "DisabledMixin",
6771
+ "module": "utils/mixins/DisabledMixin.js"
6772
+ }
6643
6773
  },
6644
6774
  {
6645
6775
  "kind": "field",
6646
- "name": "name",
6776
+ "name": "tabIndex",
6647
6777
  "type": {
6648
- "text": "string"
6778
+ "text": "number"
6649
6779
  },
6650
- "default": "''",
6651
- "description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
6652
- "attribute": "name",
6780
+ "default": "0",
6781
+ "description": "This property specifies the tab order of the element.",
6782
+ "attribute": "tabIndex",
6653
6783
  "reflects": true,
6654
6784
  "inheritedFrom": {
6655
- "name": "FormInternalsMixin",
6656
- "module": "utils/mixins/FormInternalsMixin.js"
6785
+ "name": "TabIndexMixin",
6786
+ "module": "utils/mixins/TabIndexMixin.js"
6657
6787
  }
6658
6788
  },
6659
6789
  {
6660
6790
  "kind": "field",
6661
- "name": "value",
6791
+ "name": "cardTitle",
6662
6792
  "type": {
6663
6793
  "text": "string"
6664
6794
  },
6665
6795
  "default": "''",
6666
- "description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
6667
- "attribute": "value",
6796
+ "description": "The title of the card - part of header section",
6797
+ "attribute": "card-title",
6668
6798
  "reflects": true,
6669
6799
  "inheritedFrom": {
6670
- "name": "FormInternalsMixin",
6671
- "module": "utils/mixins/FormInternalsMixin.js"
6800
+ "name": "Card",
6801
+ "module": "components/card/card.component.js"
6672
6802
  }
6673
6803
  },
6674
6804
  {
6675
6805
  "kind": "field",
6676
- "name": "validationMessage",
6806
+ "name": "subtitle",
6677
6807
  "type": {
6678
- "text": "string | undefined"
6808
+ "text": "string"
6679
6809
  },
6680
- "description": "Custom validation message that will override the default message and displayed when the input is invalid.\n\nTo display custom validation messages, you must listen for input events (or other relevant events)\non your component and update the `validationMessage` property with the desired message string.\nUpdating this property will ensure that new validation messages are shown to the user.\n- The `validationMessage` property overrides the default browser validation message when set.\n- Consumers are responsible for updating `validationMessage` in response to input or validation state changes.",
6681
- "attribute": "validation-message",
6810
+ "default": "''",
6811
+ "description": "The subtitle of the card - part of header section",
6812
+ "attribute": "subtitle",
6682
6813
  "reflects": true,
6683
6814
  "inheritedFrom": {
6684
- "name": "FormInternalsMixin",
6685
- "module": "utils/mixins/FormInternalsMixin.js"
6815
+ "name": "Card",
6816
+ "module": "components/card/card.component.js"
6686
6817
  }
6687
6818
  },
6688
6819
  {
6689
6820
  "kind": "field",
6690
- "name": "validity",
6821
+ "name": "imageSrc",
6691
6822
  "type": {
6692
- "text": "ValidityState"
6823
+ "text": "string"
6693
6824
  },
6694
- "readonly": true,
6825
+ "default": "''",
6826
+ "description": "The image source URL to render on the card",
6827
+ "attribute": "image-src",
6828
+ "reflects": true,
6695
6829
  "inheritedFrom": {
6696
- "name": "FormInternalsMixin",
6697
- "module": "utils/mixins/FormInternalsMixin.js"
6830
+ "name": "Card",
6831
+ "module": "components/card/card.component.js"
6698
6832
  }
6699
6833
  },
6700
6834
  {
6701
6835
  "kind": "field",
6702
- "name": "willValidate",
6703
- "readonly": true,
6836
+ "name": "imageAlt",
6837
+ "type": {
6838
+ "text": "string"
6839
+ },
6840
+ "default": "''",
6841
+ "description": "The image alt for accessibility support",
6842
+ "attribute": "image-alt",
6843
+ "reflects": true,
6704
6844
  "inheritedFrom": {
6705
- "name": "FormInternalsMixin",
6706
- "module": "utils/mixins/FormInternalsMixin.js"
6845
+ "name": "Card",
6846
+ "module": "components/card/card.component.js"
6707
6847
  }
6708
6848
  },
6709
6849
  {
6710
- "kind": "method",
6711
- "name": "setValidity",
6712
- "description": "Sets the validity of the input field based on the input field's validity.",
6713
- "return": {
6714
- "type": {
6715
- "text": ""
6716
- }
6850
+ "kind": "field",
6851
+ "name": "variant",
6852
+ "type": {
6853
+ "text": "CardVariant"
6717
6854
  },
6855
+ "description": "The variant of the card. It can either be set to 'border' or 'ghost'",
6856
+ "default": "'border'",
6857
+ "attribute": "variant",
6858
+ "reflects": true,
6718
6859
  "inheritedFrom": {
6719
- "name": "FormInternalsMixin",
6720
- "module": "utils/mixins/FormInternalsMixin.js"
6721
- }
6722
- },
6723
- {
6724
- "kind": "method",
6725
- "name": "checkValidity",
6726
- "return": {
6727
- "type": {
6728
- "text": "boolean"
6729
- }
6730
- },
6731
- "inheritedFrom": {
6732
- "name": "FormInternalsMixin",
6733
- "module": "utils/mixins/FormInternalsMixin.js"
6734
- }
6735
- },
6736
- {
6737
- "kind": "method",
6738
- "name": "reportValidity",
6739
- "inheritedFrom": {
6740
- "name": "FormInternalsMixin",
6741
- "module": "utils/mixins/FormInternalsMixin.js"
6742
- }
6743
- },
6744
- {
6745
- "kind": "field",
6746
- "name": "dataAriaLabel",
6747
- "type": {
6748
- "text": "string | null"
6749
- },
6750
- "default": "null",
6751
- "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
6752
- "attribute": "data-aria-label",
6753
- "reflects": true,
6754
- "inheritedFrom": {
6755
- "name": "DataAriaLabelMixin",
6756
- "module": "utils/mixins/DataAriaLabelMixin.js"
6757
- }
6758
- },
6759
- {
6760
- "kind": "field",
6761
- "name": "disabled",
6762
- "type": {
6763
- "text": "boolean | undefined"
6764
- },
6765
- "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
6766
- "default": "undefined",
6767
- "attribute": "disabled",
6768
- "reflects": true,
6769
- "inheritedFrom": {
6770
- "name": "DisabledMixin",
6771
- "module": "utils/mixins/DisabledMixin.js"
6772
- }
6773
- },
6774
- {
6775
- "kind": "field",
6776
- "name": "label",
6777
- "type": {
6778
- "text": "string | undefined"
6779
- },
6780
- "description": "The label of the input field. It is linked to the input field using the `for` attribute.",
6781
- "attribute": "label",
6782
- "reflects": true,
6783
- "inheritedFrom": {
6784
- "name": "FormfieldWrapper",
6785
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
6786
- }
6787
- },
6788
- {
6789
- "kind": "field",
6790
- "name": "required",
6791
- "type": {
6792
- "text": "boolean"
6793
- },
6794
- "default": "false",
6795
- "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
6796
- "attribute": "required",
6797
- "reflects": true,
6798
- "inheritedFrom": {
6799
- "name": "FormfieldWrapper",
6800
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
6801
- }
6802
- },
6803
- {
6804
- "kind": "field",
6805
- "name": "id",
6806
- "type": {
6807
- "text": "string"
6808
- },
6809
- "default": "''",
6810
- "description": "The unique id of the input field. It is used to link the input field with the label.",
6811
- "attribute": "id",
6812
- "inheritedFrom": {
6813
- "name": "FormfieldWrapper",
6814
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
6815
- }
6816
- },
6817
- {
6818
- "kind": "field",
6819
- "name": "helpTextType",
6820
- "type": {
6821
- "text": "ValidationType"
6822
- },
6823
- "description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
6824
- "attribute": "help-text-type",
6825
- "reflects": true,
6826
- "inheritedFrom": {
6827
- "name": "FormfieldWrapper",
6828
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
6860
+ "name": "Card",
6861
+ "module": "components/card/card.component.js"
6829
6862
  }
6830
6863
  },
6831
6864
  {
6832
6865
  "kind": "field",
6833
- "name": "helpText",
6866
+ "name": "orientation",
6834
6867
  "type": {
6835
- "text": "string | undefined"
6868
+ "text": "CardOrientation"
6836
6869
  },
6837
- "description": "The help text that is displayed below the input field.",
6838
- "attribute": "help-text",
6870
+ "description": "The orientation of the card. It can either be set to 'vertical' or 'horizontal'",
6871
+ "default": "'vertical'",
6872
+ "attribute": "orientation",
6839
6873
  "reflects": true,
6840
6874
  "inheritedFrom": {
6841
- "name": "FormfieldWrapper",
6842
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
6875
+ "name": "Card",
6876
+ "module": "components/card/card.component.js"
6843
6877
  }
6844
6878
  },
6845
6879
  {
6846
6880
  "kind": "field",
6847
- "name": "toggletipText",
6881
+ "name": "titleTagName",
6848
6882
  "type": {
6849
- "text": "string | undefined"
6883
+ "text": "TagNameType"
6850
6884
  },
6851
- "description": "The toggletip text that is displayed when the label is hovered.\nIt is used to provide additional information about the label.",
6852
- "attribute": "toggletip-text",
6885
+ "description": "The tag name for the card title. It supports all the types that `mdc-text` supports",
6886
+ "default": "'span'",
6887
+ "attribute": "title-tag-name",
6853
6888
  "reflects": true,
6854
6889
  "inheritedFrom": {
6855
- "name": "FormfieldWrapper",
6856
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
6890
+ "name": "Card",
6891
+ "module": "components/card/card.component.js"
6857
6892
  }
6858
6893
  },
6859
6894
  {
6860
6895
  "kind": "field",
6861
- "name": "toggletipPlacement",
6896
+ "name": "subtitleTagName",
6862
6897
  "type": {
6863
- "text": "PopoverPlacement"
6898
+ "text": "TagNameType"
6864
6899
  },
6865
- "description": "The placement of the toggletip that is displayed when the info icon is hovered.",
6866
- "default": "'top'",
6867
- "attribute": "toggletip-placement",
6900
+ "description": "The tag name for the subtitle. It supports all the types that `mdc-text` supports",
6901
+ "default": "'span'",
6902
+ "attribute": "subtitle-tag-name",
6868
6903
  "reflects": true,
6869
6904
  "inheritedFrom": {
6870
- "name": "FormfieldWrapper",
6871
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
6905
+ "name": "Card",
6906
+ "module": "components/card/card.component.js"
6872
6907
  }
6873
6908
  },
6874
6909
  {
6875
6910
  "kind": "field",
6876
- "name": "infoIconAriaLabel",
6911
+ "name": "iconName",
6877
6912
  "type": {
6878
- "text": "string | undefined"
6913
+ "text": "IconNames | undefined"
6879
6914
  },
6880
- "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.",
6881
- "attribute": "info-icon-aria-label",
6915
+ "description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
6916
+ "attribute": "icon-name",
6882
6917
  "reflects": true,
6883
6918
  "inheritedFrom": {
6884
- "name": "FormfieldWrapper",
6885
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
6886
- }
6887
- },
6888
- {
6889
- "kind": "method",
6890
- "name": "renderLabelElement",
6891
- "privacy": "protected",
6892
- "description": "creates the label element when the label property is set.\nid is used to link the label with the input field.",
6893
- "return": {
6894
- "type": {
6895
- "text": ""
6896
- }
6897
- },
6898
- "inheritedFrom": {
6899
- "name": "FormfieldWrapper",
6900
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
6919
+ "name": "Card",
6920
+ "module": "components/card/card.component.js"
6901
6921
  }
6902
6922
  },
6903
6923
  {
6904
6924
  "kind": "method",
6905
- "name": "renderHelpTextIcon",
6925
+ "name": "renderImage",
6906
6926
  "privacy": "protected",
6907
- "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.",
6927
+ "description": "Renders the image on the card if image source is provided",
6908
6928
  "return": {
6909
6929
  "type": {
6910
6930
  "text": ""
6911
6931
  }
6912
6932
  },
6913
6933
  "inheritedFrom": {
6914
- "name": "FormfieldWrapper",
6915
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
6934
+ "name": "Card",
6935
+ "module": "components/card/card.component.js"
6916
6936
  }
6917
6937
  },
6918
6938
  {
6919
6939
  "kind": "method",
6920
- "name": "renderHelpText",
6940
+ "name": "renderIcon",
6921
6941
  "privacy": "protected",
6922
- "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.",
6942
+ "description": "Renders the icon on the card if icon name is provided",
6923
6943
  "return": {
6924
6944
  "type": {
6925
6945
  "text": ""
6926
6946
  }
6927
6947
  },
6928
6948
  "inheritedFrom": {
6929
- "name": "FormfieldWrapper",
6930
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
6949
+ "name": "Card",
6950
+ "module": "components/card/card.component.js"
6931
6951
  }
6932
6952
  },
6933
6953
  {
6934
6954
  "kind": "method",
6935
- "name": "renderLabel",
6955
+ "name": "renderTitle",
6936
6956
  "privacy": "protected",
6937
- "description": "renders the mdc-label-text container that contains the label and labelInfoToggleTip.",
6957
+ "description": "Renders the title and subtitle on the card",
6938
6958
  "return": {
6939
6959
  "type": {
6940
6960
  "text": ""
6941
6961
  }
6942
6962
  },
6943
6963
  "inheritedFrom": {
6944
- "name": "FormfieldWrapper",
6945
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
6964
+ "name": "Card",
6965
+ "module": "components/card/card.component.js"
6946
6966
  }
6947
6967
  },
6948
6968
  {
6949
6969
  "kind": "method",
6950
- "name": "renderHelperText",
6970
+ "name": "renderFooter",
6951
6971
  "privacy": "protected",
6952
- "description": "renders the mdc-help-text container that contains the helpertext icon and helpertext.",
6972
+ "description": "Renders the footer of the card if footer-link,\nfooter-button-primary, or footer-button-secondary slots are provided",
6953
6973
  "return": {
6954
6974
  "type": {
6955
6975
  "text": ""
6956
6976
  }
6957
6977
  },
6958
6978
  "inheritedFrom": {
6959
- "name": "FormfieldWrapper",
6960
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
6979
+ "name": "Card",
6980
+ "module": "components/card/card.component.js"
6961
6981
  }
6962
6982
  }
6963
6983
  ],
6964
6984
  "events": [
6965
6985
  {
6966
- "type": {
6967
- "text": "EventConstructor"
6968
- }
6986
+ "description": "(React: onClick) Event that gets dispatched when the card is clicked. It toggles the checked state.",
6987
+ "name": "click",
6988
+ "reactName": "onClick"
6969
6989
  },
6970
6990
  {
6971
- "description": "(React: onChange) Event that gets dispatched when the checkbox state changes.",
6991
+ "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.",
6992
+ "name": "keydown",
6993
+ "reactName": "onKeyDown"
6994
+ },
6995
+ {
6996
+ "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.",
6997
+ "name": "keyup",
6998
+ "reactName": "onKeyUp"
6999
+ },
7000
+ {
7001
+ "description": "(React: onChange) Event that gets dispatched when the card state changes.",
6972
7002
  "name": "change",
6973
7003
  "reactName": "onChange"
6974
7004
  },
6975
7005
  {
6976
- "description": "(React: onFocus) Event that gets dispatched when the checkbox receives focus.",
7006
+ "description": "(React: onFocus) Event that gets dispatched when the card receives focus.",
6977
7007
  "name": "focus",
6978
7008
  "reactName": "onFocus"
6979
7009
  }
@@ -6985,207 +7015,177 @@
6985
7015
  "text": "boolean"
6986
7016
  },
6987
7017
  "default": "false",
6988
- "description": "Determines whether the checkbox is selected or unselected.",
7018
+ "description": "The checked state of the card",
6989
7019
  "fieldName": "checked"
6990
7020
  },
6991
7021
  {
6992
- "name": "indeterminate",
7022
+ "name": "selection-type",
6993
7023
  "type": {
6994
- "text": "boolean"
7024
+ "text": "SelectionType"
6995
7025
  },
6996
- "default": "false",
6997
- "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.",
6998
- "fieldName": "indeterminate"
7026
+ "description": "The selection type of the card. It can either be set to 'check' or 'checkbox'",
7027
+ "default": "'check'",
7028
+ "fieldName": "selectionType"
6999
7029
  },
7000
7030
  {
7001
- "name": "autofocus",
7031
+ "name": "disabled",
7002
7032
  "type": {
7003
- "text": "boolean"
7033
+ "text": "boolean | undefined"
7004
7034
  },
7005
- "default": "false",
7006
- "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)",
7007
- "fieldName": "autofocus"
7035
+ "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
7036
+ "default": "undefined",
7037
+ "fieldName": "disabled",
7038
+ "inheritedFrom": {
7039
+ "name": "DisabledMixin",
7040
+ "module": "src/utils/mixins/DisabledMixin.ts"
7041
+ }
7008
7042
  },
7009
7043
  {
7010
- "name": "name",
7044
+ "name": "tabIndex",
7011
7045
  "type": {
7012
- "text": "string"
7046
+ "text": "number"
7013
7047
  },
7014
- "default": "''",
7015
- "description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
7016
- "fieldName": "name",
7048
+ "default": "0",
7049
+ "description": "This property specifies the tab order of the element.",
7050
+ "fieldName": "tabIndex",
7017
7051
  "inheritedFrom": {
7018
- "name": "FormInternalsMixin",
7019
- "module": "src/utils/mixins/FormInternalsMixin.ts"
7052
+ "name": "TabIndexMixin",
7053
+ "module": "src/utils/mixins/TabIndexMixin.ts"
7020
7054
  }
7021
7055
  },
7022
7056
  {
7023
- "name": "value",
7057
+ "name": "card-title",
7024
7058
  "type": {
7025
7059
  "text": "string"
7026
7060
  },
7027
7061
  "default": "''",
7028
- "description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
7029
- "fieldName": "value",
7030
- "inheritedFrom": {
7031
- "name": "FormInternalsMixin",
7032
- "module": "src/utils/mixins/FormInternalsMixin.ts"
7033
- }
7034
- },
7035
- {
7036
- "name": "validation-message",
7037
- "type": {
7038
- "text": "string | undefined"
7039
- },
7040
- "description": "Custom validation message that will override the default message and displayed when the input is invalid.\n\nTo display custom validation messages, you must listen for input events (or other relevant events)\non your component and update the `validationMessage` property with the desired message string.\nUpdating this property will ensure that new validation messages are shown to the user.\n- The `validationMessage` property overrides the default browser validation message when set.\n- Consumers are responsible for updating `validationMessage` in response to input or validation state changes.",
7041
- "fieldName": "validationMessage",
7042
- "inheritedFrom": {
7043
- "name": "FormInternalsMixin",
7044
- "module": "src/utils/mixins/FormInternalsMixin.ts"
7045
- }
7046
- },
7047
- {
7048
- "name": "data-aria-label",
7049
- "type": {
7050
- "text": "string | null"
7051
- },
7052
- "default": "null",
7053
- "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
7054
- "fieldName": "dataAriaLabel",
7055
- "inheritedFrom": {
7056
- "name": "DataAriaLabelMixin",
7057
- "module": "src/utils/mixins/DataAriaLabelMixin.ts"
7058
- }
7059
- },
7060
- {
7061
- "name": "disabled",
7062
- "type": {
7063
- "text": "boolean | undefined"
7064
- },
7065
- "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
7066
- "default": "undefined",
7067
- "fieldName": "disabled",
7062
+ "description": "The title of the card - part of header section",
7063
+ "fieldName": "cardTitle",
7068
7064
  "inheritedFrom": {
7069
- "name": "DisabledMixin",
7070
- "module": "src/utils/mixins/DisabledMixin.ts"
7065
+ "name": "Card",
7066
+ "module": "src/components/card/card.component.ts"
7071
7067
  }
7072
7068
  },
7073
7069
  {
7074
- "name": "label",
7070
+ "name": "subtitle",
7075
7071
  "type": {
7076
- "text": "string | undefined"
7072
+ "text": "string"
7077
7073
  },
7078
- "description": "The label of the input field. It is linked to the input field using the `for` attribute.",
7079
- "fieldName": "label",
7074
+ "default": "''",
7075
+ "description": "The subtitle of the card - part of header section",
7076
+ "fieldName": "subtitle",
7080
7077
  "inheritedFrom": {
7081
- "name": "FormfieldWrapper",
7082
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
7078
+ "name": "Card",
7079
+ "module": "src/components/card/card.component.ts"
7083
7080
  }
7084
7081
  },
7085
7082
  {
7086
- "name": "required",
7083
+ "name": "image-src",
7087
7084
  "type": {
7088
- "text": "boolean"
7085
+ "text": "string"
7089
7086
  },
7090
- "default": "false",
7091
- "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
7092
- "fieldName": "required",
7087
+ "default": "''",
7088
+ "description": "The image source URL to render on the card",
7089
+ "fieldName": "imageSrc",
7093
7090
  "inheritedFrom": {
7094
- "name": "FormfieldWrapper",
7095
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
7091
+ "name": "Card",
7092
+ "module": "src/components/card/card.component.ts"
7096
7093
  }
7097
7094
  },
7098
7095
  {
7099
- "name": "id",
7096
+ "name": "image-alt",
7100
7097
  "type": {
7101
7098
  "text": "string"
7102
7099
  },
7103
7100
  "default": "''",
7104
- "description": "The unique id of the input field. It is used to link the input field with the label.",
7105
- "fieldName": "id",
7101
+ "description": "The image alt for accessibility support",
7102
+ "fieldName": "imageAlt",
7106
7103
  "inheritedFrom": {
7107
- "name": "FormfieldWrapper",
7108
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
7104
+ "name": "Card",
7105
+ "module": "src/components/card/card.component.ts"
7109
7106
  }
7110
7107
  },
7111
7108
  {
7112
- "name": "help-text-type",
7109
+ "name": "variant",
7113
7110
  "type": {
7114
- "text": "ValidationType"
7111
+ "text": "CardVariant"
7115
7112
  },
7116
- "description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
7117
- "fieldName": "helpTextType",
7113
+ "description": "The variant of the card. It can either be set to 'border' or 'ghost'",
7114
+ "default": "'border'",
7115
+ "fieldName": "variant",
7118
7116
  "inheritedFrom": {
7119
- "name": "FormfieldWrapper",
7120
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
7117
+ "name": "Card",
7118
+ "module": "src/components/card/card.component.ts"
7121
7119
  }
7122
7120
  },
7123
7121
  {
7124
- "name": "help-text",
7122
+ "name": "orientation",
7125
7123
  "type": {
7126
- "text": "string | undefined"
7124
+ "text": "CardOrientation"
7127
7125
  },
7128
- "description": "The help text that is displayed below the input field.",
7129
- "fieldName": "helpText",
7126
+ "description": "The orientation of the card. It can either be set to 'vertical' or 'horizontal'",
7127
+ "default": "'vertical'",
7128
+ "fieldName": "orientation",
7130
7129
  "inheritedFrom": {
7131
- "name": "FormfieldWrapper",
7132
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
7130
+ "name": "Card",
7131
+ "module": "src/components/card/card.component.ts"
7133
7132
  }
7134
7133
  },
7135
7134
  {
7136
- "name": "toggletip-text",
7135
+ "name": "title-tag-name",
7137
7136
  "type": {
7138
- "text": "string | undefined"
7137
+ "text": "TagNameType"
7139
7138
  },
7140
- "description": "The toggletip text that is displayed when the label is hovered.\nIt is used to provide additional information about the label.",
7141
- "fieldName": "toggletipText",
7139
+ "description": "The tag name for the card title. It supports all the types that `mdc-text` supports",
7140
+ "default": "'span'",
7141
+ "fieldName": "titleTagName",
7142
7142
  "inheritedFrom": {
7143
- "name": "FormfieldWrapper",
7144
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
7143
+ "name": "Card",
7144
+ "module": "src/components/card/card.component.ts"
7145
7145
  }
7146
7146
  },
7147
7147
  {
7148
- "name": "toggletip-placement",
7148
+ "name": "subtitle-tag-name",
7149
7149
  "type": {
7150
- "text": "PopoverPlacement"
7150
+ "text": "TagNameType"
7151
7151
  },
7152
- "description": "The placement of the toggletip that is displayed when the info icon is hovered.",
7153
- "default": "'top'",
7154
- "fieldName": "toggletipPlacement",
7152
+ "description": "The tag name for the subtitle. It supports all the types that `mdc-text` supports",
7153
+ "default": "'span'",
7154
+ "fieldName": "subtitleTagName",
7155
7155
  "inheritedFrom": {
7156
- "name": "FormfieldWrapper",
7157
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
7156
+ "name": "Card",
7157
+ "module": "src/components/card/card.component.ts"
7158
7158
  }
7159
7159
  },
7160
7160
  {
7161
- "name": "info-icon-aria-label",
7161
+ "name": "icon-name",
7162
7162
  "type": {
7163
- "text": "string | undefined"
7163
+ "text": "IconNames | undefined"
7164
7164
  },
7165
- "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.",
7166
- "fieldName": "infoIconAriaLabel",
7165
+ "description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
7166
+ "fieldName": "iconName",
7167
7167
  "inheritedFrom": {
7168
- "name": "FormfieldWrapper",
7169
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
7168
+ "name": "Card",
7169
+ "module": "src/components/card/card.component.ts"
7170
7170
  }
7171
7171
  }
7172
7172
  ],
7173
7173
  "mixins": [
7174
7174
  {
7175
- "name": "FormInternalsMixin",
7176
- "module": "/src/utils/mixins/FormInternalsMixin"
7175
+ "name": "DisabledMixin",
7176
+ "module": "/src/utils/mixins/DisabledMixin"
7177
7177
  },
7178
7178
  {
7179
- "name": "DataAriaLabelMixin",
7180
- "module": "/src/utils/mixins/DataAriaLabelMixin"
7179
+ "name": "TabIndexMixin",
7180
+ "module": "/src/utils/mixins/TabIndexMixin"
7181
7181
  }
7182
7182
  ],
7183
7183
  "superclass": {
7184
- "name": "FormfieldWrapper",
7185
- "module": "/src/components/formfieldwrapper/formfieldwrapper.component"
7184
+ "name": "Card",
7185
+ "module": "/src/components/card/card.component"
7186
7186
  },
7187
- "tagName": "mdc-checkbox",
7188
- "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 */",
7187
+ "tagName": "mdc-cardcheckbox",
7188
+ "jsDoc": "/**\n * cardcheckbox component extends `mdc-card` and supports checkbox selection interaction addtionally.\n *\n * While using this component within a form or group of cards, make sure cards are in a role = \"checkbox-group\".\n * This card would have events for selected and unselected (similar to checkbox)\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-cardcheckbox\n *\n * @dependency mdc-icon\n * @dependency mdc-staticcheckbox\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 */",
7189
7189
  "customElement": true
7190
7190
  }
7191
7191
  ],
@@ -7194,8 +7194,8 @@
7194
7194
  "kind": "js",
7195
7195
  "name": "default",
7196
7196
  "declaration": {
7197
- "name": "Checkbox",
7198
- "module": "components/checkbox/checkbox.component.js"
7197
+ "name": "CardCheckbox",
7198
+ "module": "components/cardcheckbox/cardcheckbox.component.js"
7199
7199
  }
7200
7200
  }
7201
7201
  ]
@@ -11910,100 +11910,134 @@
11910
11910
  },
11911
11911
  {
11912
11912
  "kind": "javascript-module",
11913
- "path": "components/formfieldwrapper/formfieldwrapper.component.js",
11913
+ "path": "components/icon/icon.component.js",
11914
11914
  "declarations": [
11915
11915
  {
11916
11916
  "kind": "class",
11917
- "description": "formfieldwrapper is a component that contains the label and helper/validation text\n that can be configured in various ways to suit different use cases (most of the input related components).\nIt is used as an internal component and is not intended to be used directly by consumers.",
11918
- "name": "FormfieldWrapper",
11917
+ "description": "Icon component that dynamically displays SVG icons based on a valid name.\n\nThis component must be mounted within an `IconProvider` component.\n\nThe `IconProvider` defines the source URL from which icons are consumed.\nThe `Icon` component accepts a `name` attribute, which corresponds to\nthe file name of the icon to be loaded from the specified URL.\n\nOnce fetched, the icon will be rendered. If the fetching process is unsuccessful,\nno icon will be displayed.\n\nThe `size` attribute allows for dynamic sizing of the icon based on the provided\n`length-unit` attribute. This unit can either come from the `IconProvider`\nor can be overridden for each individual icon. For example:\nif `size = 1` and `length-unit = 'em'`, the dimensions of the icon will be\n`width: 1em; height: 1em`.\n\nRegarding accessibility, there are three types of icons: decorative, informative and informative standalone.\n\n### Decorative Icons\n- Decorative icons do not convey any essential information to the content of a page.\n- They should be hidden from screen readers (SR) to prevent confusion for users.\n- For decorative icons, an `aria-label` is not required, and the `role` will be set to null.\n\n### Informative Icons\n- Informative icons convey important information that is not adequately represented\n by surrounding text or components.\n- They provide valuable context and must be announced by assistive technologies.\n- For informative icons, an `aria-label` is required, and the `role` will be set to \"img\" automatically.\n- If an `aria-label` is provided, the role will be set to 'img'; if it is absent,\n the role will be unset.\n\n### Informative Standalone Icons\n- If an icon is informative (as mentioned above) and does not belong to a button (=standalone), it must\nhave a Tooltip that describes what it means.\n- For informative standalone icons, an `aria-label` & `tabindex=\"0\"` is required,\nand the `role` will be set to \"img\" automatically.\n- **Only use this when a Icon is standalone and is not part of a button or other interactive elements.**",
11918
+ "name": "Icon",
11919
+ "cssProperties": [
11920
+ {
11921
+ "description": "Allows customization of the default fill color.",
11922
+ "name": "--mdc-icon-fill-color"
11923
+ },
11924
+ {
11925
+ "description": "Allows customization of the icon size.",
11926
+ "name": "--mdc-icon-size"
11927
+ },
11928
+ {
11929
+ "description": "Allows customization of the icon border radius.",
11930
+ "name": "--mdc-icon-border-radius"
11931
+ }
11932
+ ],
11933
+ "cssParts": [
11934
+ {
11935
+ "description": "The svg inside the icon element.",
11936
+ "name": "icon"
11937
+ }
11938
+ ],
11919
11939
  "members": [
11920
11940
  {
11921
11941
  "kind": "field",
11922
- "name": "label",
11942
+ "name": "iconData",
11923
11943
  "type": {
11924
- "text": "string | undefined"
11944
+ "text": "HTMLElement | undefined"
11925
11945
  },
11926
- "description": "The label of the input field. It is linked to the input field using the `for` attribute.",
11927
- "attribute": "label",
11928
- "reflects": true
11946
+ "privacy": "private"
11929
11947
  },
11930
11948
  {
11931
11949
  "kind": "field",
11932
- "name": "required",
11950
+ "name": "lengthUnitFromContext",
11933
11951
  "type": {
11934
- "text": "boolean"
11952
+ "text": "string | undefined"
11935
11953
  },
11936
- "default": "false",
11937
- "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
11938
- "attribute": "required",
11939
- "reflects": true
11954
+ "privacy": "private"
11940
11955
  },
11941
11956
  {
11942
11957
  "kind": "field",
11943
- "name": "id",
11958
+ "name": "sizeFromContext",
11944
11959
  "type": {
11945
- "text": "string"
11960
+ "text": "number | undefined"
11946
11961
  },
11947
- "default": "''",
11948
- "description": "The unique id of the input field. It is used to link the input field with the label.",
11949
- "attribute": "id"
11962
+ "privacy": "private"
11950
11963
  },
11951
11964
  {
11952
11965
  "kind": "field",
11953
- "name": "helpTextType",
11966
+ "name": "name",
11954
11967
  "type": {
11955
- "text": "ValidationType"
11968
+ "text": "IconNames | undefined"
11956
11969
  },
11957
- "description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
11958
- "attribute": "help-text-type",
11970
+ "description": "Name of the icon (= filename)",
11971
+ "attribute": "name",
11959
11972
  "reflects": true
11960
11973
  },
11961
11974
  {
11962
11975
  "kind": "field",
11963
- "name": "helpText",
11976
+ "name": "size",
11964
11977
  "type": {
11965
- "text": "string | undefined"
11978
+ "text": "number | undefined"
11966
11979
  },
11967
- "description": "The help text that is displayed below the input field.",
11968
- "attribute": "help-text",
11969
- "reflects": true
11980
+ "description": "Size of the icon (works in combination with length unit)",
11981
+ "attribute": "size"
11970
11982
  },
11971
11983
  {
11972
11984
  "kind": "field",
11973
- "name": "toggletipText",
11985
+ "name": "lengthUnit",
11974
11986
  "type": {
11975
11987
  "text": "string | undefined"
11976
11988
  },
11977
- "description": "The toggletip text that is displayed when the label is hovered.\nIt is used to provide additional information about the label.",
11978
- "attribute": "toggletip-text",
11979
- "reflects": true
11989
+ "description": "Length unit attribute for overriding length-unit from `IconProvider`",
11990
+ "attribute": "length-unit"
11980
11991
  },
11981
11992
  {
11982
11993
  "kind": "field",
11983
- "name": "toggletipPlacement",
11994
+ "name": "ariaLabel",
11984
11995
  "type": {
11985
- "text": "PopoverPlacement"
11996
+ "text": "string | null"
11986
11997
  },
11987
- "description": "The placement of the toggletip that is displayed when the info icon is hovered.",
11988
- "default": "'top'",
11989
- "attribute": "toggletip-placement",
11990
- "reflects": true
11998
+ "default": "null",
11999
+ "description": "Aria-label attribute to be set for accessibility",
12000
+ "attribute": "aria-label"
11991
12001
  },
11992
12002
  {
11993
12003
  "kind": "field",
11994
- "name": "infoIconAriaLabel",
12004
+ "name": "ariaLabelledBy",
11995
12005
  "type": {
11996
- "text": "string | undefined"
12006
+ "text": "string | null"
11997
12007
  },
11998
- "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.",
11999
- "attribute": "info-icon-aria-label",
12000
- "reflects": true
12008
+ "default": "null",
12009
+ "description": "Aria-labelledby attribute to be set for accessibility",
12010
+ "attribute": "aria-labelledby"
12011
+ },
12012
+ {
12013
+ "kind": "field",
12014
+ "name": "iconProviderContext",
12015
+ "privacy": "private",
12016
+ "readonly": true
12017
+ },
12018
+ {
12019
+ "kind": "field",
12020
+ "name": "abortController",
12021
+ "type": {
12022
+ "text": "AbortController"
12023
+ },
12024
+ "privacy": "private",
12025
+ "default": "new AbortController()"
12001
12026
  },
12002
12027
  {
12003
12028
  "kind": "method",
12004
- "name": "renderLabelElement",
12005
- "privacy": "protected",
12006
- "description": "creates the label element when the label property is set.\nid is used to link the label with the input field.",
12029
+ "name": "prepareIconElement",
12030
+ "privacy": "private",
12031
+ "parameters": [
12032
+ {
12033
+ "name": "iconData",
12034
+ "type": {
12035
+ "text": "string"
12036
+ },
12037
+ "description": "The icon string to be parsed"
12038
+ }
12039
+ ],
12040
+ "description": "Parse the icon string to an html element, set the attributes and\nreturn the icon element",
12007
12041
  "return": {
12008
12042
  "type": {
12009
12043
  "text": ""
@@ -12012,158 +12046,102 @@
12012
12046
  },
12013
12047
  {
12014
12048
  "kind": "method",
12015
- "name": "renderHelpTextIcon",
12016
- "privacy": "protected",
12017
- "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.",
12018
- "return": {
12019
- "type": {
12020
- "text": ""
12021
- }
12022
- }
12049
+ "name": "getIconData",
12050
+ "privacy": "private",
12051
+ "description": "Fetches the icon (currently only svg) and sets state and attributes once fetched successfully\n\nThis method uses abortController.signal to cancel the fetch request when the component is disconnected or updated.\nIf the request is aborted after the fetch() call has been fulfilled but before the response body has been read,\nthen attempting to read the response body will reject with an AbortError exception."
12023
12052
  },
12024
12053
  {
12025
12054
  "kind": "method",
12026
- "name": "renderHelpText",
12027
- "privacy": "protected",
12028
- "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.",
12029
- "return": {
12030
- "type": {
12031
- "text": ""
12055
+ "name": "handleIconLoadedSuccess",
12056
+ "privacy": "private",
12057
+ "parameters": [
12058
+ {
12059
+ "name": "iconHtml",
12060
+ "type": {
12061
+ "text": "HTMLElement"
12062
+ },
12063
+ "description": "The icon html element which has been fetched from the icon provider."
12032
12064
  }
12033
- }
12065
+ ],
12066
+ "description": "Sets the iconData state to the fetched icon.\nDispatches a 'load' event on the component once the icon has been successfully loaded."
12034
12067
  },
12035
12068
  {
12036
12069
  "kind": "method",
12037
- "name": "renderLabel",
12038
- "privacy": "protected",
12039
- "description": "renders the mdc-label-text container that contains the label and labelInfoToggleTip.",
12040
- "return": {
12041
- "type": {
12042
- "text": ""
12070
+ "name": "handleIconLoadedFailure",
12071
+ "privacy": "private",
12072
+ "parameters": [
12073
+ {
12074
+ "name": "error",
12075
+ "type": {
12076
+ "text": "unknown"
12077
+ }
12043
12078
  }
12044
- }
12079
+ ],
12080
+ "description": "Dispatches an 'error' event on the component when the icon fetching has failed.\nThis event bubbles and is cancelable.\nThe error detail is set to the error object."
12045
12081
  },
12046
12082
  {
12047
12083
  "kind": "method",
12048
- "name": "renderHelperText",
12049
- "privacy": "protected",
12050
- "description": "renders the mdc-help-text container that contains the helpertext icon and helpertext.",
12051
- "return": {
12052
- "type": {
12053
- "text": ""
12054
- }
12055
- }
12084
+ "name": "updateSize",
12085
+ "privacy": "private",
12086
+ "description": "Updates the size by setting the width and height"
12056
12087
  },
12057
12088
  {
12058
12089
  "kind": "field",
12059
- "name": "disabled",
12060
- "type": {
12061
- "text": "boolean | undefined"
12062
- },
12063
- "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
12064
- "default": "undefined",
12065
- "attribute": "disabled",
12066
- "reflects": true,
12067
- "inheritedFrom": {
12068
- "name": "DisabledMixin",
12069
- "module": "utils/mixins/DisabledMixin.js"
12070
- }
12090
+ "name": "computedIconSize",
12091
+ "privacy": "private",
12092
+ "readonly": true
12071
12093
  }
12072
12094
  ],
12073
12095
  "attributes": [
12074
12096
  {
12075
- "name": "label",
12076
- "type": {
12077
- "text": "string | undefined"
12078
- },
12079
- "description": "The label of the input field. It is linked to the input field using the `for` attribute.",
12080
- "fieldName": "label"
12081
- },
12082
- {
12083
- "name": "required",
12084
- "type": {
12085
- "text": "boolean"
12086
- },
12087
- "default": "false",
12088
- "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
12089
- "fieldName": "required"
12090
- },
12091
- {
12092
- "name": "id",
12093
- "type": {
12094
- "text": "string"
12095
- },
12096
- "default": "''",
12097
- "description": "The unique id of the input field. It is used to link the input field with the label.",
12098
- "fieldName": "id"
12099
- },
12100
- {
12101
- "name": "help-text-type",
12097
+ "name": "name",
12102
12098
  "type": {
12103
- "text": "ValidationType"
12099
+ "text": "IconNames | undefined"
12104
12100
  },
12105
- "description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
12106
- "fieldName": "helpTextType"
12101
+ "description": "Name of the icon (= filename)",
12102
+ "fieldName": "name"
12107
12103
  },
12108
12104
  {
12109
- "name": "help-text",
12105
+ "name": "size",
12110
12106
  "type": {
12111
- "text": "string | undefined"
12107
+ "text": "number | undefined"
12112
12108
  },
12113
- "description": "The help text that is displayed below the input field.",
12114
- "fieldName": "helpText"
12109
+ "description": "Size of the icon (works in combination with length unit)",
12110
+ "fieldName": "size"
12115
12111
  },
12116
12112
  {
12117
- "name": "toggletip-text",
12113
+ "name": "length-unit",
12118
12114
  "type": {
12119
12115
  "text": "string | undefined"
12120
12116
  },
12121
- "description": "The toggletip text that is displayed when the label is hovered.\nIt is used to provide additional information about the label.",
12122
- "fieldName": "toggletipText"
12123
- },
12124
- {
12125
- "name": "toggletip-placement",
12126
- "type": {
12127
- "text": "PopoverPlacement"
12128
- },
12129
- "description": "The placement of the toggletip that is displayed when the info icon is hovered.",
12130
- "default": "'top'",
12131
- "fieldName": "toggletipPlacement"
12117
+ "description": "Length unit attribute for overriding length-unit from `IconProvider`",
12118
+ "fieldName": "lengthUnit"
12132
12119
  },
12133
12120
  {
12134
- "name": "info-icon-aria-label",
12121
+ "name": "aria-label",
12135
12122
  "type": {
12136
- "text": "string | undefined"
12123
+ "text": "string | null"
12137
12124
  },
12138
- "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.",
12139
- "fieldName": "infoIconAriaLabel"
12125
+ "default": "null",
12126
+ "description": "Aria-label attribute to be set for accessibility",
12127
+ "fieldName": "ariaLabel"
12140
12128
  },
12141
12129
  {
12142
- "name": "disabled",
12130
+ "name": "aria-labelledby",
12143
12131
  "type": {
12144
- "text": "boolean | undefined"
12132
+ "text": "string | null"
12145
12133
  },
12146
- "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
12147
- "default": "undefined",
12148
- "fieldName": "disabled",
12149
- "inheritedFrom": {
12150
- "name": "DisabledMixin",
12151
- "module": "src/utils/mixins/DisabledMixin.ts"
12152
- }
12153
- }
12154
- ],
12155
- "mixins": [
12156
- {
12157
- "name": "DisabledMixin",
12158
- "module": "/src/utils/mixins/DisabledMixin"
12134
+ "default": "null",
12135
+ "description": "Aria-labelledby attribute to be set for accessibility",
12136
+ "fieldName": "ariaLabelledBy"
12159
12137
  }
12160
12138
  ],
12161
12139
  "superclass": {
12162
12140
  "name": "Component",
12163
12141
  "module": "/src/models"
12164
12142
  },
12165
- "tagName": "mdc-formfieldwrapper",
12166
- "jsDoc": "/**\n * formfieldwrapper is a component that contains the label and helper/validation text\n * that can be configured in various ways to suit different use cases (most of the input related components).\n * It is used as an internal component and is not intended to be used directly by consumers.\n *\n * @tagname mdc-formfieldwrapper\n *\n * @dependency mdc-text\n * @dependency mdc-icon\n * @dependency mdc-button\n * @dependency mdc-toggletip\n *\n *\n */",
12143
+ "tagName": "mdc-icon",
12144
+ "jsDoc": "/**\n * Icon component that dynamically displays SVG icons based on a valid name.\n *\n * This component must be mounted within an `IconProvider` component.\n *\n * The `IconProvider` defines the source URL from which icons are consumed.\n * The `Icon` component accepts a `name` attribute, which corresponds to\n * the file name of the icon to be loaded from the specified URL.\n *\n * Once fetched, the icon will be rendered. If the fetching process is unsuccessful,\n * no icon will be displayed.\n *\n * The `size` attribute allows for dynamic sizing of the icon based on the provided\n * `length-unit` attribute. This unit can either come from the `IconProvider`\n * or can be overridden for each individual icon. For example:\n * if `size = 1` and `length-unit = 'em'`, the dimensions of the icon will be\n * `width: 1em; height: 1em`.\n *\n * Regarding accessibility, there are three types of icons: decorative, informative and informative standalone.\n *\n * ### Decorative Icons\n * - Decorative icons do not convey any essential information to the content of a page.\n * - They should be hidden from screen readers (SR) to prevent confusion for users.\n * - For decorative icons, an `aria-label` is not required, and the `role` will be set to null.\n *\n * ### Informative Icons\n * - Informative icons convey important information that is not adequately represented\n * by surrounding text or components.\n * - They provide valuable context and must be announced by assistive technologies.\n * - For informative icons, an `aria-label` is required, and the `role` will be set to \"img\" automatically.\n * - If an `aria-label` is provided, the role will be set to 'img'; if it is absent,\n * the role will be unset.\n *\n * ### Informative Standalone Icons\n * - If an icon is informative (as mentioned above) and does not belong to a button (=standalone), it must\n * have a Tooltip that describes what it means.\n * - For informative standalone icons, an `aria-label` & `tabindex=\"0\"` is required,\n * and the `role` will be set to \"img\" automatically.\n * - **Only use this when a Icon is standalone and is not part of a button or other interactive elements.**\n *\n * @tagname mdc-icon\n *\n * @cssproperty --mdc-icon-fill-color - Allows customization of the default fill color.\n * @cssproperty --mdc-icon-size - Allows customization of the icon size.\n * @cssproperty --mdc-icon-border-radius - Allows customization of the icon border radius.\n *\n * @csspart icon - The svg inside the icon element.\n */",
12167
12145
  "customElement": true
12168
12146
  }
12169
12147
  ],
@@ -12172,282 +12150,34 @@
12172
12150
  "kind": "js",
12173
12151
  "name": "default",
12174
12152
  "declaration": {
12175
- "name": "FormfieldWrapper",
12176
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
12153
+ "name": "Icon",
12154
+ "module": "components/icon/icon.component.js"
12177
12155
  }
12178
12156
  }
12179
12157
  ]
12180
12158
  },
12181
12159
  {
12182
12160
  "kind": "javascript-module",
12183
- "path": "components/icon/icon.component.js",
12161
+ "path": "components/iconprovider/iconprovider.component.js",
12184
12162
  "declarations": [
12185
12163
  {
12186
12164
  "kind": "class",
12187
- "description": "Icon component that dynamically displays SVG icons based on a valid name.\n\nThis component must be mounted within an `IconProvider` component.\n\nThe `IconProvider` defines the source URL from which icons are consumed.\nThe `Icon` component accepts a `name` attribute, which corresponds to\nthe file name of the icon to be loaded from the specified URL.\n\nOnce fetched, the icon will be rendered. If the fetching process is unsuccessful,\nno icon will be displayed.\n\nThe `size` attribute allows for dynamic sizing of the icon based on the provided\n`length-unit` attribute. This unit can either come from the `IconProvider`\nor can be overridden for each individual icon. For example:\nif `size = 1` and `length-unit = 'em'`, the dimensions of the icon will be\n`width: 1em; height: 1em`.\n\nRegarding accessibility, there are three types of icons: decorative, informative and informative standalone.\n\n### Decorative Icons\n- Decorative icons do not convey any essential information to the content of a page.\n- They should be hidden from screen readers (SR) to prevent confusion for users.\n- For decorative icons, an `aria-label` is not required, and the `role` will be set to null.\n\n### Informative Icons\n- Informative icons convey important information that is not adequately represented\n by surrounding text or components.\n- They provide valuable context and must be announced by assistive technologies.\n- For informative icons, an `aria-label` is required, and the `role` will be set to \"img\" automatically.\n- If an `aria-label` is provided, the role will be set to 'img'; if it is absent,\n the role will be unset.\n\n### Informative Standalone Icons\n- If an icon is informative (as mentioned above) and does not belong to a button (=standalone), it must\nhave a Tooltip that describes what it means.\n- For informative standalone icons, an `aria-label` & `tabindex=\"0\"` is required,\nand the `role` will be set to \"img\" automatically.\n- **Only use this when a Icon is standalone and is not part of a button or other interactive elements.**",
12188
- "name": "Icon",
12189
- "cssProperties": [
12190
- {
12191
- "description": "Allows customization of the default fill color.",
12192
- "name": "--mdc-icon-fill-color"
12193
- },
12194
- {
12195
- "description": "Allows customization of the icon size.",
12196
- "name": "--mdc-icon-size"
12197
- },
12198
- {
12199
- "description": "Allows customization of the icon border radius.",
12200
- "name": "--mdc-icon-border-radius"
12201
- }
12202
- ],
12203
- "cssParts": [
12165
+ "description": "IconProvider component, which allows to be consumed from sub components\n(see `providerUtils.consume` for how to consume)\n\nAttribute `iconSet` can be set to either `momentum-icons` or `custom-icons`.\nIf `momentum-icons` is selected, the icons will be fetched from the\nMomentum Design System icon set per a dynamic JS Import (no need to provide a URL).\nThis requires the consumer to have the `@momentum-designs` package installed and the\nbuild tooling needs to support dynamic imports.\n\nIf `custom-icons` is selected, the icons will be fetched from the provided URL.\nThis requires the consumer to provide a URL from which the icons will be fetched and\nthe consumer needs to make sure to bundle the icons in the application.\n\nIf `cacheStrategy` is provided (only works with iconSet = `custom-icons`), the\nIconProvider will cache the icons in the selected cache (either web-api-cache or in-memory-cache),\nto avoid fetching the same icon multiple times over the network.\nThis is useful when the same icon is used multiple times in the application.\nTo consider:\n- The `in-memory-cache` is not persisted and will be lost when the\nIconProvider is removed from the DOM.\n- The `web-api-cache` is persisted, but only works in https environments\n(https://developer.mozilla.org/en-US/docs/Web/API/Cache).",
12166
+ "name": "IconProvider",
12167
+ "slots": [
12204
12168
  {
12205
- "description": "The svg inside the icon element.",
12206
- "name": "icon"
12169
+ "description": "children",
12170
+ "name": ""
12207
12171
  }
12208
12172
  ],
12209
12173
  "members": [
12210
12174
  {
12211
12175
  "kind": "field",
12212
- "name": "iconData",
12213
- "type": {
12214
- "text": "HTMLElement | undefined"
12215
- },
12216
- "privacy": "private"
12217
- },
12218
- {
12219
- "kind": "field",
12220
- "name": "lengthUnitFromContext",
12221
- "type": {
12222
- "text": "string | undefined"
12223
- },
12224
- "privacy": "private"
12225
- },
12226
- {
12227
- "kind": "field",
12228
- "name": "sizeFromContext",
12229
- "type": {
12230
- "text": "number | undefined"
12231
- },
12232
- "privacy": "private"
12233
- },
12234
- {
12235
- "kind": "field",
12236
- "name": "name",
12237
- "type": {
12238
- "text": "IconNames | undefined"
12239
- },
12240
- "description": "Name of the icon (= filename)",
12241
- "attribute": "name",
12242
- "reflects": true
12243
- },
12244
- {
12245
- "kind": "field",
12246
- "name": "size",
12247
- "type": {
12248
- "text": "number | undefined"
12249
- },
12250
- "description": "Size of the icon (works in combination with length unit)",
12251
- "attribute": "size"
12252
- },
12253
- {
12254
- "kind": "field",
12255
- "name": "lengthUnit",
12256
- "type": {
12257
- "text": "string | undefined"
12258
- },
12259
- "description": "Length unit attribute for overriding length-unit from `IconProvider`",
12260
- "attribute": "length-unit"
12261
- },
12262
- {
12263
- "kind": "field",
12264
- "name": "ariaLabel",
12265
- "type": {
12266
- "text": "string | null"
12267
- },
12268
- "default": "null",
12269
- "description": "Aria-label attribute to be set for accessibility",
12270
- "attribute": "aria-label"
12271
- },
12272
- {
12273
- "kind": "field",
12274
- "name": "ariaLabelledBy",
12275
- "type": {
12276
- "text": "string | null"
12277
- },
12278
- "default": "null",
12279
- "description": "Aria-labelledby attribute to be set for accessibility",
12280
- "attribute": "aria-labelledby"
12281
- },
12282
- {
12283
- "kind": "field",
12284
- "name": "iconProviderContext",
12285
- "privacy": "private",
12286
- "readonly": true
12287
- },
12288
- {
12289
- "kind": "field",
12290
- "name": "abortController",
12291
- "type": {
12292
- "text": "AbortController"
12293
- },
12294
- "privacy": "private",
12295
- "default": "new AbortController()"
12296
- },
12297
- {
12298
- "kind": "method",
12299
- "name": "prepareIconElement",
12300
- "privacy": "private",
12301
- "parameters": [
12302
- {
12303
- "name": "iconData",
12304
- "type": {
12305
- "text": "string"
12306
- },
12307
- "description": "The icon string to be parsed"
12308
- }
12309
- ],
12310
- "description": "Parse the icon string to an html element, set the attributes and\nreturn the icon element",
12311
- "return": {
12312
- "type": {
12313
- "text": ""
12314
- }
12315
- }
12316
- },
12317
- {
12318
- "kind": "method",
12319
- "name": "getIconData",
12320
- "privacy": "private",
12321
- "description": "Fetches the icon (currently only svg) and sets state and attributes once fetched successfully\n\nThis method uses abortController.signal to cancel the fetch request when the component is disconnected or updated.\nIf the request is aborted after the fetch() call has been fulfilled but before the response body has been read,\nthen attempting to read the response body will reject with an AbortError exception."
12322
- },
12323
- {
12324
- "kind": "method",
12325
- "name": "handleIconLoadedSuccess",
12326
- "privacy": "private",
12327
- "parameters": [
12328
- {
12329
- "name": "iconHtml",
12330
- "type": {
12331
- "text": "HTMLElement"
12332
- },
12333
- "description": "The icon html element which has been fetched from the icon provider."
12334
- }
12335
- ],
12336
- "description": "Sets the iconData state to the fetched icon.\nDispatches a 'load' event on the component once the icon has been successfully loaded."
12337
- },
12338
- {
12339
- "kind": "method",
12340
- "name": "handleIconLoadedFailure",
12341
- "privacy": "private",
12342
- "parameters": [
12343
- {
12344
- "name": "error",
12345
- "type": {
12346
- "text": "unknown"
12347
- }
12348
- }
12349
- ],
12350
- "description": "Dispatches an 'error' event on the component when the icon fetching has failed.\nThis event bubbles and is cancelable.\nThe error detail is set to the error object."
12351
- },
12352
- {
12353
- "kind": "method",
12354
- "name": "updateSize",
12355
- "privacy": "private",
12356
- "description": "Updates the size by setting the width and height"
12357
- },
12358
- {
12359
- "kind": "field",
12360
- "name": "computedIconSize",
12361
- "privacy": "private",
12362
- "readonly": true
12363
- }
12364
- ],
12365
- "attributes": [
12366
- {
12367
- "name": "name",
12368
- "type": {
12369
- "text": "IconNames | undefined"
12370
- },
12371
- "description": "Name of the icon (= filename)",
12372
- "fieldName": "name"
12373
- },
12374
- {
12375
- "name": "size",
12376
- "type": {
12377
- "text": "number | undefined"
12378
- },
12379
- "description": "Size of the icon (works in combination with length unit)",
12380
- "fieldName": "size"
12381
- },
12382
- {
12383
- "name": "length-unit",
12384
- "type": {
12385
- "text": "string | undefined"
12386
- },
12387
- "description": "Length unit attribute for overriding length-unit from `IconProvider`",
12388
- "fieldName": "lengthUnit"
12389
- },
12390
- {
12391
- "name": "aria-label",
12392
- "type": {
12393
- "text": "string | null"
12394
- },
12395
- "default": "null",
12396
- "description": "Aria-label attribute to be set for accessibility",
12397
- "fieldName": "ariaLabel"
12398
- },
12399
- {
12400
- "name": "aria-labelledby",
12401
- "type": {
12402
- "text": "string | null"
12403
- },
12404
- "default": "null",
12405
- "description": "Aria-labelledby attribute to be set for accessibility",
12406
- "fieldName": "ariaLabelledBy"
12407
- }
12408
- ],
12409
- "superclass": {
12410
- "name": "Component",
12411
- "module": "/src/models"
12412
- },
12413
- "tagName": "mdc-icon",
12414
- "jsDoc": "/**\n * Icon component that dynamically displays SVG icons based on a valid name.\n *\n * This component must be mounted within an `IconProvider` component.\n *\n * The `IconProvider` defines the source URL from which icons are consumed.\n * The `Icon` component accepts a `name` attribute, which corresponds to\n * the file name of the icon to be loaded from the specified URL.\n *\n * Once fetched, the icon will be rendered. If the fetching process is unsuccessful,\n * no icon will be displayed.\n *\n * The `size` attribute allows for dynamic sizing of the icon based on the provided\n * `length-unit` attribute. This unit can either come from the `IconProvider`\n * or can be overridden for each individual icon. For example:\n * if `size = 1` and `length-unit = 'em'`, the dimensions of the icon will be\n * `width: 1em; height: 1em`.\n *\n * Regarding accessibility, there are three types of icons: decorative, informative and informative standalone.\n *\n * ### Decorative Icons\n * - Decorative icons do not convey any essential information to the content of a page.\n * - They should be hidden from screen readers (SR) to prevent confusion for users.\n * - For decorative icons, an `aria-label` is not required, and the `role` will be set to null.\n *\n * ### Informative Icons\n * - Informative icons convey important information that is not adequately represented\n * by surrounding text or components.\n * - They provide valuable context and must be announced by assistive technologies.\n * - For informative icons, an `aria-label` is required, and the `role` will be set to \"img\" automatically.\n * - If an `aria-label` is provided, the role will be set to 'img'; if it is absent,\n * the role will be unset.\n *\n * ### Informative Standalone Icons\n * - If an icon is informative (as mentioned above) and does not belong to a button (=standalone), it must\n * have a Tooltip that describes what it means.\n * - For informative standalone icons, an `aria-label` & `tabindex=\"0\"` is required,\n * and the `role` will be set to \"img\" automatically.\n * - **Only use this when a Icon is standalone and is not part of a button or other interactive elements.**\n *\n * @tagname mdc-icon\n *\n * @cssproperty --mdc-icon-fill-color - Allows customization of the default fill color.\n * @cssproperty --mdc-icon-size - Allows customization of the icon size.\n * @cssproperty --mdc-icon-border-radius - Allows customization of the icon border radius.\n *\n * @csspart icon - The svg inside the icon element.\n */",
12415
- "customElement": true
12416
- }
12417
- ],
12418
- "exports": [
12419
- {
12420
- "kind": "js",
12421
- "name": "default",
12422
- "declaration": {
12423
- "name": "Icon",
12424
- "module": "components/icon/icon.component.js"
12425
- }
12426
- }
12427
- ]
12428
- },
12429
- {
12430
- "kind": "javascript-module",
12431
- "path": "components/iconprovider/iconprovider.component.js",
12432
- "declarations": [
12433
- {
12434
- "kind": "class",
12435
- "description": "IconProvider component, which allows to be consumed from sub components\n(see `providerUtils.consume` for how to consume)\n\nAttribute `iconSet` can be set to either `momentum-icons` or `custom-icons`.\nIf `momentum-icons` is selected, the icons will be fetched from the\nMomentum Design System icon set per a dynamic JS Import (no need to provide a URL).\nThis requires the consumer to have the `@momentum-designs` package installed and the\nbuild tooling needs to support dynamic imports.\n\nIf `custom-icons` is selected, the icons will be fetched from the provided URL.\nThis requires the consumer to provide a URL from which the icons will be fetched and\nthe consumer needs to make sure to bundle the icons in the application.\n\nIf `cacheStrategy` is provided (only works with iconSet = `custom-icons`), the\nIconProvider will cache the icons in the selected cache (either web-api-cache or in-memory-cache),\nto avoid fetching the same icon multiple times over the network.\nThis is useful when the same icon is used multiple times in the application.\nTo consider:\n- The `in-memory-cache` is not persisted and will be lost when the\nIconProvider is removed from the DOM.\n- The `web-api-cache` is persisted, but only works in https environments\n(https://developer.mozilla.org/en-US/docs/Web/API/Cache).",
12436
- "name": "IconProvider",
12437
- "slots": [
12438
- {
12439
- "description": "children",
12440
- "name": ""
12441
- }
12442
- ],
12443
- "members": [
12444
- {
12445
- "kind": "field",
12446
- "name": "Context",
12447
- "privacy": "public",
12448
- "static": true,
12449
- "description": "Context object of the IconProvider, to be consumed by child components",
12450
- "readonly": true
12176
+ "name": "Context",
12177
+ "privacy": "public",
12178
+ "static": true,
12179
+ "description": "Context object of the IconProvider, to be consumed by child components",
12180
+ "readonly": true
12451
12181
  },
12452
12182
  {
12453
12183
  "kind": "field",
@@ -12692,819 +12422,1108 @@
12692
12422
  "name": "--mdc-input-success-border-color"
12693
12423
  },
12694
12424
  {
12695
- "description": "Border color for the input container when primary",
12696
- "name": "--mdc-input-primary-border-color"
12425
+ "description": "Border color for the input container when primary",
12426
+ "name": "--mdc-input-primary-border-color"
12427
+ }
12428
+ ],
12429
+ "members": [
12430
+ {
12431
+ "kind": "field",
12432
+ "name": "placeholder",
12433
+ "type": {
12434
+ "text": "string"
12435
+ },
12436
+ "default": "''",
12437
+ "description": "The placeholder text that is displayed when the input field is empty.",
12438
+ "attribute": "placeholder"
12439
+ },
12440
+ {
12441
+ "kind": "field",
12442
+ "name": "readonly",
12443
+ "type": {
12444
+ "text": "boolean"
12445
+ },
12446
+ "default": "false",
12447
+ "description": "readonly attribute of the input field. If true, the input field is read-only.",
12448
+ "attribute": "readonly"
12449
+ },
12450
+ {
12451
+ "kind": "field",
12452
+ "name": "prefixText",
12453
+ "type": {
12454
+ "text": "string | undefined"
12455
+ },
12456
+ "description": "The prefix text that is displayed before the input field. It has a max length of 10 characters.\nWhen the prefix text is set, make sure to set the 'data-aria-label'\nattribute with the appropriate value for accessibility.",
12457
+ "attribute": "prefix-text"
12458
+ },
12459
+ {
12460
+ "kind": "field",
12461
+ "name": "leadingIcon",
12462
+ "type": {
12463
+ "text": "IconNames | undefined"
12464
+ },
12465
+ "description": "The leading icon that is displayed before the input field.",
12466
+ "attribute": "leading-icon"
12467
+ },
12468
+ {
12469
+ "kind": "field",
12470
+ "name": "trailingButton",
12471
+ "type": {
12472
+ "text": "boolean"
12473
+ },
12474
+ "default": "false",
12475
+ "description": "The trailing button when set to true, shows a clear button that clears the input field.",
12476
+ "attribute": "trailing-button"
12477
+ },
12478
+ {
12479
+ "kind": "field",
12480
+ "name": "maxlength",
12481
+ "type": {
12482
+ "text": "number | undefined"
12483
+ },
12484
+ "description": "The maximum number of characters that the input field can accept.",
12485
+ "attribute": "maxlength"
12486
+ },
12487
+ {
12488
+ "kind": "field",
12489
+ "name": "minlength",
12490
+ "type": {
12491
+ "text": "number | undefined"
12492
+ },
12493
+ "description": "The minimum number of characters that the input field can accept.",
12494
+ "attribute": "minlength"
12495
+ },
12496
+ {
12497
+ "kind": "field",
12498
+ "name": "autocapitalize",
12499
+ "type": {
12500
+ "text": "AutoCapitalizeType"
12501
+ },
12502
+ "description": "The autocapitalize attribute of the input field.",
12503
+ "default": "'off'",
12504
+ "attribute": "autocapitalize"
12505
+ },
12506
+ {
12507
+ "kind": "field",
12508
+ "name": "autocomplete",
12509
+ "type": {
12510
+ "text": "AutoCompleteType"
12511
+ },
12512
+ "description": "The autocomplete attribute of the input field.",
12513
+ "default": "'off'",
12514
+ "attribute": "autocomplete"
12515
+ },
12516
+ {
12517
+ "kind": "field",
12518
+ "name": "autofocus",
12519
+ "type": {
12520
+ "text": "boolean"
12521
+ },
12522
+ "default": "false",
12523
+ "description": "If true, the input field is focused when the component is rendered.",
12524
+ "attribute": "autofocus"
12525
+ },
12526
+ {
12527
+ "kind": "field",
12528
+ "name": "dirname",
12529
+ "type": {
12530
+ "text": "string | undefined"
12531
+ },
12532
+ "description": "Specifies the name of the directionality of text for submission purposes (e.g., \"rtl\" for right-to-left).",
12533
+ "attribute": "dirname"
12534
+ },
12535
+ {
12536
+ "kind": "field",
12537
+ "name": "pattern",
12538
+ "type": {
12539
+ "text": "string | undefined"
12540
+ },
12541
+ "description": "The pattern attribute of the input field.\nSpecifies a regular expression that the input value must match for validation purposes.",
12542
+ "attribute": "pattern"
12543
+ },
12544
+ {
12545
+ "kind": "field",
12546
+ "name": "list",
12547
+ "type": {
12548
+ "text": "string | undefined"
12549
+ },
12550
+ "description": "The list attribute of the input field.\nIdentifies a list of pre-defined options to suggest to the user.",
12551
+ "attribute": "list"
12552
+ },
12553
+ {
12554
+ "kind": "field",
12555
+ "name": "size",
12556
+ "type": {
12557
+ "text": "number | undefined | undefined"
12558
+ },
12559
+ "description": "The size attribute of the input field.\nSpecifies the width of the input field.",
12560
+ "default": "undefined",
12561
+ "attribute": "size"
12562
+ },
12563
+ {
12564
+ "kind": "field",
12565
+ "name": "clearAriaLabel",
12566
+ "type": {
12567
+ "text": "string"
12568
+ },
12569
+ "default": "''",
12570
+ "description": "Aria label for the trailing button. If trailing button is set to true, this label is used for the clear button.",
12571
+ "attribute": "clear-aria-label"
12572
+ },
12573
+ {
12574
+ "kind": "method",
12575
+ "name": "setInputValidity",
12576
+ "privacy": "private"
12577
+ },
12578
+ {
12579
+ "kind": "method",
12580
+ "name": "updateValue",
12581
+ "privacy": "private",
12582
+ "description": "Updates the value of the input field.\nSets the form value.",
12583
+ "return": {
12584
+ "type": {
12585
+ "text": ""
12586
+ }
12587
+ }
12588
+ },
12589
+ {
12590
+ "kind": "method",
12591
+ "name": "onInput",
12592
+ "privacy": "private",
12593
+ "description": "Handles the input event of the input field.\nUpdates the value and sets the validity of the input field."
12594
+ },
12595
+ {
12596
+ "kind": "method",
12597
+ "name": "onChange",
12598
+ "privacy": "private",
12599
+ "parameters": [
12600
+ {
12601
+ "name": "event",
12602
+ "type": {
12603
+ "text": "Event"
12604
+ },
12605
+ "description": "Event which contains information about the value change."
12606
+ }
12607
+ ],
12608
+ "description": "Handles the change event of the input field.\nUpdates the value and sets the validity of the input field.\n\nThe 'change' event does not bubble up through the shadow DOM as it was not composed.\nTherefore, we need to re-dispatch the same event to ensure it is propagated correctly.\nRead more: https://developer.mozilla.org/en-US/docs/Web/API/Event/composed"
12609
+ },
12610
+ {
12611
+ "kind": "method",
12612
+ "name": "handleKeyDown",
12613
+ "privacy": "protected",
12614
+ "parameters": [
12615
+ {
12616
+ "name": "event",
12617
+ "type": {
12618
+ "text": "KeyboardEvent"
12619
+ },
12620
+ "description": "Keyboard event"
12621
+ }
12622
+ ],
12623
+ "description": "Handles the keydown event of the input field.\nIf the key pressed is 'Enter', it submits the form."
12624
+ },
12625
+ {
12626
+ "kind": "method",
12627
+ "name": "renderLeadingIcon",
12628
+ "privacy": "protected",
12629
+ "description": "Renders the leading icon before the input field.\nIf the leading icon is not set, it will not be displayed.",
12630
+ "return": {
12631
+ "type": {
12632
+ "text": ""
12633
+ }
12634
+ }
12635
+ },
12636
+ {
12637
+ "kind": "method",
12638
+ "name": "renderPrefixText",
12639
+ "privacy": "protected",
12640
+ "description": "Renders the prefix text before the input field.\nIf the prefix text is more than 10 characters,\n- it will not be displayed.\n- the validation messsage will be displayed.\n\n Note: We are setting aria-hidden so that the screen reader does not read the prefix text.\n The consumers should set the appropriate aria-label for the input field using 'data-aria-label' attribute.",
12641
+ "return": {
12642
+ "type": {
12643
+ "text": ""
12644
+ }
12645
+ }
12646
+ },
12647
+ {
12648
+ "kind": "method",
12649
+ "name": "clearInputText",
12650
+ "privacy": "protected",
12651
+ "description": "Clears the input field."
12652
+ },
12653
+ {
12654
+ "kind": "method",
12655
+ "name": "renderTrailingButton",
12656
+ "privacy": "protected",
12657
+ "parameters": [
12658
+ {
12659
+ "name": "show",
12660
+ "default": "false"
12661
+ }
12662
+ ],
12663
+ "description": "Renders the trailing button to clear the input field if the trailingButton is set to true.",
12664
+ "return": {
12665
+ "type": {
12666
+ "text": ""
12667
+ }
12668
+ }
12669
+ },
12670
+ {
12671
+ "kind": "method",
12672
+ "name": "renderInputElement",
12673
+ "privacy": "protected",
12674
+ "parameters": [
12675
+ {
12676
+ "name": "type",
12677
+ "type": {
12678
+ "text": "InputType"
12679
+ }
12680
+ },
12681
+ {
12682
+ "name": "hidePlaceholder",
12683
+ "default": "false"
12684
+ }
12685
+ ]
12686
+ },
12687
+ {
12688
+ "kind": "field",
12689
+ "name": "name",
12690
+ "type": {
12691
+ "text": "string"
12692
+ },
12693
+ "default": "''",
12694
+ "description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
12695
+ "attribute": "name",
12696
+ "reflects": true,
12697
+ "inheritedFrom": {
12698
+ "name": "FormInternalsMixin",
12699
+ "module": "utils/mixins/FormInternalsMixin.js"
12700
+ }
12701
+ },
12702
+ {
12703
+ "kind": "field",
12704
+ "name": "value",
12705
+ "type": {
12706
+ "text": "string"
12707
+ },
12708
+ "default": "''",
12709
+ "description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
12710
+ "attribute": "value",
12711
+ "reflects": true,
12712
+ "inheritedFrom": {
12713
+ "name": "FormInternalsMixin",
12714
+ "module": "utils/mixins/FormInternalsMixin.js"
12715
+ }
12716
+ },
12717
+ {
12718
+ "kind": "field",
12719
+ "name": "validationMessage",
12720
+ "type": {
12721
+ "text": "string | undefined"
12722
+ },
12723
+ "description": "Custom validation message that will override the default message and displayed when the input is invalid.\n\nTo display custom validation messages, you must listen for input events (or other relevant events)\non your component and update the `validationMessage` property with the desired message string.\nUpdating this property will ensure that new validation messages are shown to the user.\n- The `validationMessage` property overrides the default browser validation message when set.\n- Consumers are responsible for updating `validationMessage` in response to input or validation state changes.",
12724
+ "attribute": "validation-message",
12725
+ "reflects": true,
12726
+ "inheritedFrom": {
12727
+ "name": "FormInternalsMixin",
12728
+ "module": "utils/mixins/FormInternalsMixin.js"
12729
+ }
12730
+ },
12731
+ {
12732
+ "kind": "field",
12733
+ "name": "validity",
12734
+ "type": {
12735
+ "text": "ValidityState"
12736
+ },
12737
+ "readonly": true,
12738
+ "inheritedFrom": {
12739
+ "name": "FormInternalsMixin",
12740
+ "module": "utils/mixins/FormInternalsMixin.js"
12741
+ }
12742
+ },
12743
+ {
12744
+ "kind": "field",
12745
+ "name": "willValidate",
12746
+ "readonly": true,
12747
+ "inheritedFrom": {
12748
+ "name": "FormInternalsMixin",
12749
+ "module": "utils/mixins/FormInternalsMixin.js"
12750
+ }
12751
+ },
12752
+ {
12753
+ "kind": "method",
12754
+ "name": "setValidity",
12755
+ "description": "Sets the validity of the input field based on the input field's validity.",
12756
+ "return": {
12757
+ "type": {
12758
+ "text": ""
12759
+ }
12760
+ },
12761
+ "inheritedFrom": {
12762
+ "name": "FormInternalsMixin",
12763
+ "module": "utils/mixins/FormInternalsMixin.js"
12764
+ }
12765
+ },
12766
+ {
12767
+ "kind": "method",
12768
+ "name": "checkValidity",
12769
+ "return": {
12770
+ "type": {
12771
+ "text": "boolean"
12772
+ }
12773
+ },
12774
+ "inheritedFrom": {
12775
+ "name": "FormInternalsMixin",
12776
+ "module": "utils/mixins/FormInternalsMixin.js"
12777
+ }
12778
+ },
12779
+ {
12780
+ "kind": "method",
12781
+ "name": "reportValidity",
12782
+ "inheritedFrom": {
12783
+ "name": "FormInternalsMixin",
12784
+ "module": "utils/mixins/FormInternalsMixin.js"
12785
+ }
12786
+ },
12787
+ {
12788
+ "kind": "field",
12789
+ "name": "dataAriaLabel",
12790
+ "type": {
12791
+ "text": "string | null"
12792
+ },
12793
+ "default": "null",
12794
+ "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
12795
+ "attribute": "data-aria-label",
12796
+ "reflects": true,
12797
+ "inheritedFrom": {
12798
+ "name": "DataAriaLabelMixin",
12799
+ "module": "utils/mixins/DataAriaLabelMixin.js"
12800
+ }
12801
+ },
12802
+ {
12803
+ "kind": "field",
12804
+ "name": "disabled",
12805
+ "type": {
12806
+ "text": "boolean | undefined"
12807
+ },
12808
+ "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
12809
+ "default": "undefined",
12810
+ "attribute": "disabled",
12811
+ "reflects": true,
12812
+ "inheritedFrom": {
12813
+ "name": "DisabledMixin",
12814
+ "module": "utils/mixins/DisabledMixin.js"
12815
+ }
12816
+ },
12817
+ {
12818
+ "kind": "field",
12819
+ "name": "label",
12820
+ "type": {
12821
+ "text": "string | undefined"
12822
+ },
12823
+ "description": "The label of the input field. It is linked to the input field using the `for` attribute.",
12824
+ "attribute": "label",
12825
+ "reflects": true,
12826
+ "inheritedFrom": {
12827
+ "name": "FormfieldWrapper",
12828
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
12829
+ }
12830
+ },
12831
+ {
12832
+ "kind": "field",
12833
+ "name": "required",
12834
+ "type": {
12835
+ "text": "boolean"
12836
+ },
12837
+ "default": "false",
12838
+ "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
12839
+ "attribute": "required",
12840
+ "reflects": true,
12841
+ "inheritedFrom": {
12842
+ "name": "FormfieldWrapper",
12843
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
12844
+ }
12845
+ },
12846
+ {
12847
+ "kind": "field",
12848
+ "name": "id",
12849
+ "type": {
12850
+ "text": "string"
12851
+ },
12852
+ "default": "''",
12853
+ "description": "The unique id of the input field. It is used to link the input field with the label.",
12854
+ "attribute": "id",
12855
+ "inheritedFrom": {
12856
+ "name": "FormfieldWrapper",
12857
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
12858
+ }
12859
+ },
12860
+ {
12861
+ "kind": "field",
12862
+ "name": "helpTextType",
12863
+ "type": {
12864
+ "text": "ValidationType"
12865
+ },
12866
+ "description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
12867
+ "attribute": "help-text-type",
12868
+ "reflects": true,
12869
+ "inheritedFrom": {
12870
+ "name": "FormfieldWrapper",
12871
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
12872
+ }
12873
+ },
12874
+ {
12875
+ "kind": "field",
12876
+ "name": "helpText",
12877
+ "type": {
12878
+ "text": "string | undefined"
12879
+ },
12880
+ "description": "The help text that is displayed below the input field.",
12881
+ "attribute": "help-text",
12882
+ "reflects": true,
12883
+ "inheritedFrom": {
12884
+ "name": "FormfieldWrapper",
12885
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
12886
+ }
12887
+ },
12888
+ {
12889
+ "kind": "field",
12890
+ "name": "toggletipText",
12891
+ "type": {
12892
+ "text": "string | undefined"
12893
+ },
12894
+ "description": "The toggletip text that is displayed when the label is hovered.\nIt is used to provide additional information about the label.",
12895
+ "attribute": "toggletip-text",
12896
+ "reflects": true,
12897
+ "inheritedFrom": {
12898
+ "name": "FormfieldWrapper",
12899
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
12900
+ }
12901
+ },
12902
+ {
12903
+ "kind": "field",
12904
+ "name": "toggletipPlacement",
12905
+ "type": {
12906
+ "text": "PopoverPlacement"
12907
+ },
12908
+ "description": "The placement of the toggletip that is displayed when the info icon is hovered.",
12909
+ "default": "'top'",
12910
+ "attribute": "toggletip-placement",
12911
+ "reflects": true,
12912
+ "inheritedFrom": {
12913
+ "name": "FormfieldWrapper",
12914
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
12915
+ }
12916
+ },
12917
+ {
12918
+ "kind": "field",
12919
+ "name": "infoIconAriaLabel",
12920
+ "type": {
12921
+ "text": "string | undefined"
12922
+ },
12923
+ "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.",
12924
+ "attribute": "info-icon-aria-label",
12925
+ "reflects": true,
12926
+ "inheritedFrom": {
12927
+ "name": "FormfieldWrapper",
12928
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
12929
+ }
12930
+ },
12931
+ {
12932
+ "kind": "method",
12933
+ "name": "renderLabelElement",
12934
+ "privacy": "protected",
12935
+ "description": "creates the label element when the label property is set.\nid is used to link the label with the input field.",
12936
+ "return": {
12937
+ "type": {
12938
+ "text": ""
12939
+ }
12940
+ },
12941
+ "inheritedFrom": {
12942
+ "name": "FormfieldWrapper",
12943
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
12944
+ }
12945
+ },
12946
+ {
12947
+ "kind": "method",
12948
+ "name": "renderHelpTextIcon",
12949
+ "privacy": "protected",
12950
+ "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.",
12951
+ "return": {
12952
+ "type": {
12953
+ "text": ""
12954
+ }
12955
+ },
12956
+ "inheritedFrom": {
12957
+ "name": "FormfieldWrapper",
12958
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
12959
+ }
12960
+ },
12961
+ {
12962
+ "kind": "method",
12963
+ "name": "renderHelpText",
12964
+ "privacy": "protected",
12965
+ "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.",
12966
+ "return": {
12967
+ "type": {
12968
+ "text": ""
12969
+ }
12970
+ },
12971
+ "inheritedFrom": {
12972
+ "name": "FormfieldWrapper",
12973
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
12974
+ }
12975
+ },
12976
+ {
12977
+ "kind": "method",
12978
+ "name": "renderLabel",
12979
+ "privacy": "protected",
12980
+ "description": "renders the mdc-label-text container that contains the label and labelInfoToggleTip.",
12981
+ "return": {
12982
+ "type": {
12983
+ "text": ""
12984
+ }
12985
+ },
12986
+ "inheritedFrom": {
12987
+ "name": "FormfieldWrapper",
12988
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
12989
+ }
12990
+ },
12991
+ {
12992
+ "kind": "method",
12993
+ "name": "renderHelperText",
12994
+ "privacy": "protected",
12995
+ "description": "renders the mdc-help-text container that contains the helpertext icon and helpertext.",
12996
+ "return": {
12997
+ "type": {
12998
+ "text": ""
12999
+ }
13000
+ },
13001
+ "inheritedFrom": {
13002
+ "name": "FormfieldWrapper",
13003
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
13004
+ }
13005
+ }
13006
+ ],
13007
+ "events": [
13008
+ {
13009
+ "type": {
13010
+ "text": "EventConstructor"
13011
+ }
13012
+ },
13013
+ {
13014
+ "description": "(React: onInput) This event is dispatched when the value of the input field changes (every press).",
13015
+ "name": "input",
13016
+ "reactName": "onInput"
13017
+ },
13018
+ {
13019
+ "description": "(React: onChange) This event is dispatched when the value of the input field changes (on blur).",
13020
+ "name": "change",
13021
+ "reactName": "onChange"
13022
+ },
13023
+ {
13024
+ "description": "(React: onFocus) This event is dispatched when the input receives focus.",
13025
+ "name": "focus",
13026
+ "reactName": "onFocus"
13027
+ },
13028
+ {
13029
+ "description": "(React: onBlur) This event is dispatched when the input loses focus.",
13030
+ "name": "blur",
13031
+ "reactName": "onBlur"
12697
13032
  }
12698
13033
  ],
12699
- "members": [
13034
+ "attributes": [
12700
13035
  {
12701
- "kind": "field",
12702
13036
  "name": "placeholder",
12703
13037
  "type": {
12704
13038
  "text": "string"
12705
13039
  },
12706
13040
  "default": "''",
12707
13041
  "description": "The placeholder text that is displayed when the input field is empty.",
12708
- "attribute": "placeholder"
13042
+ "fieldName": "placeholder"
12709
13043
  },
12710
13044
  {
12711
- "kind": "field",
12712
13045
  "name": "readonly",
12713
13046
  "type": {
12714
13047
  "text": "boolean"
12715
13048
  },
12716
13049
  "default": "false",
12717
13050
  "description": "readonly attribute of the input field. If true, the input field is read-only.",
12718
- "attribute": "readonly"
13051
+ "fieldName": "readonly"
12719
13052
  },
12720
13053
  {
12721
- "kind": "field",
12722
- "name": "prefixText",
13054
+ "name": "prefix-text",
12723
13055
  "type": {
12724
13056
  "text": "string | undefined"
12725
13057
  },
12726
13058
  "description": "The prefix text that is displayed before the input field. It has a max length of 10 characters.\nWhen the prefix text is set, make sure to set the 'data-aria-label'\nattribute with the appropriate value for accessibility.",
12727
- "attribute": "prefix-text"
13059
+ "fieldName": "prefixText"
12728
13060
  },
12729
13061
  {
12730
- "kind": "field",
12731
- "name": "leadingIcon",
13062
+ "name": "leading-icon",
12732
13063
  "type": {
12733
13064
  "text": "IconNames | undefined"
12734
13065
  },
12735
13066
  "description": "The leading icon that is displayed before the input field.",
12736
- "attribute": "leading-icon"
13067
+ "fieldName": "leadingIcon"
12737
13068
  },
12738
13069
  {
12739
- "kind": "field",
12740
- "name": "trailingButton",
13070
+ "name": "trailing-button",
12741
13071
  "type": {
12742
13072
  "text": "boolean"
12743
13073
  },
12744
13074
  "default": "false",
12745
13075
  "description": "The trailing button when set to true, shows a clear button that clears the input field.",
12746
- "attribute": "trailing-button"
13076
+ "fieldName": "trailingButton"
12747
13077
  },
12748
13078
  {
12749
- "kind": "field",
12750
13079
  "name": "maxlength",
12751
13080
  "type": {
12752
13081
  "text": "number | undefined"
12753
13082
  },
12754
13083
  "description": "The maximum number of characters that the input field can accept.",
12755
- "attribute": "maxlength"
13084
+ "fieldName": "maxlength"
12756
13085
  },
12757
13086
  {
12758
- "kind": "field",
12759
13087
  "name": "minlength",
12760
13088
  "type": {
12761
13089
  "text": "number | undefined"
12762
13090
  },
12763
13091
  "description": "The minimum number of characters that the input field can accept.",
12764
- "attribute": "minlength"
13092
+ "fieldName": "minlength"
12765
13093
  },
12766
13094
  {
12767
- "kind": "field",
12768
13095
  "name": "autocapitalize",
12769
13096
  "type": {
12770
13097
  "text": "AutoCapitalizeType"
12771
13098
  },
12772
13099
  "description": "The autocapitalize attribute of the input field.",
12773
13100
  "default": "'off'",
12774
- "attribute": "autocapitalize"
13101
+ "fieldName": "autocapitalize"
12775
13102
  },
12776
13103
  {
12777
- "kind": "field",
12778
13104
  "name": "autocomplete",
12779
13105
  "type": {
12780
13106
  "text": "AutoCompleteType"
12781
13107
  },
12782
13108
  "description": "The autocomplete attribute of the input field.",
12783
13109
  "default": "'off'",
12784
- "attribute": "autocomplete"
13110
+ "fieldName": "autocomplete"
12785
13111
  },
12786
13112
  {
12787
- "kind": "field",
12788
13113
  "name": "autofocus",
12789
13114
  "type": {
12790
13115
  "text": "boolean"
12791
13116
  },
12792
13117
  "default": "false",
12793
13118
  "description": "If true, the input field is focused when the component is rendered.",
12794
- "attribute": "autofocus"
13119
+ "fieldName": "autofocus"
12795
13120
  },
12796
13121
  {
12797
- "kind": "field",
12798
13122
  "name": "dirname",
12799
13123
  "type": {
12800
13124
  "text": "string | undefined"
12801
13125
  },
12802
13126
  "description": "Specifies the name of the directionality of text for submission purposes (e.g., \"rtl\" for right-to-left).",
12803
- "attribute": "dirname"
13127
+ "fieldName": "dirname"
12804
13128
  },
12805
13129
  {
12806
- "kind": "field",
12807
13130
  "name": "pattern",
12808
13131
  "type": {
12809
13132
  "text": "string | undefined"
12810
13133
  },
12811
13134
  "description": "The pattern attribute of the input field.\nSpecifies a regular expression that the input value must match for validation purposes.",
12812
- "attribute": "pattern"
13135
+ "fieldName": "pattern"
12813
13136
  },
12814
13137
  {
12815
- "kind": "field",
12816
13138
  "name": "list",
12817
13139
  "type": {
12818
13140
  "text": "string | undefined"
12819
13141
  },
12820
13142
  "description": "The list attribute of the input field.\nIdentifies a list of pre-defined options to suggest to the user.",
12821
- "attribute": "list"
13143
+ "fieldName": "list"
12822
13144
  },
12823
13145
  {
12824
- "kind": "field",
12825
13146
  "name": "size",
12826
13147
  "type": {
12827
13148
  "text": "number | undefined | undefined"
12828
13149
  },
12829
13150
  "description": "The size attribute of the input field.\nSpecifies the width of the input field.",
12830
13151
  "default": "undefined",
12831
- "attribute": "size"
13152
+ "fieldName": "size"
12832
13153
  },
12833
13154
  {
12834
- "kind": "field",
12835
- "name": "clearAriaLabel",
13155
+ "name": "clear-aria-label",
12836
13156
  "type": {
12837
13157
  "text": "string"
12838
13158
  },
12839
13159
  "default": "''",
12840
13160
  "description": "Aria label for the trailing button. If trailing button is set to true, this label is used for the clear button.",
12841
- "attribute": "clear-aria-label"
12842
- },
12843
- {
12844
- "kind": "method",
12845
- "name": "setInputValidity",
12846
- "privacy": "private"
12847
- },
12848
- {
12849
- "kind": "method",
12850
- "name": "updateValue",
12851
- "privacy": "private",
12852
- "description": "Updates the value of the input field.\nSets the form value.",
12853
- "return": {
12854
- "type": {
12855
- "text": ""
12856
- }
12857
- }
12858
- },
12859
- {
12860
- "kind": "method",
12861
- "name": "onInput",
12862
- "privacy": "private",
12863
- "description": "Handles the input event of the input field.\nUpdates the value and sets the validity of the input field."
12864
- },
12865
- {
12866
- "kind": "method",
12867
- "name": "onChange",
12868
- "privacy": "private",
12869
- "parameters": [
12870
- {
12871
- "name": "event",
12872
- "type": {
12873
- "text": "Event"
12874
- },
12875
- "description": "Event which contains information about the value change."
12876
- }
12877
- ],
12878
- "description": "Handles the change event of the input field.\nUpdates the value and sets the validity of the input field.\n\nThe 'change' event does not bubble up through the shadow DOM as it was not composed.\nTherefore, we need to re-dispatch the same event to ensure it is propagated correctly.\nRead more: https://developer.mozilla.org/en-US/docs/Web/API/Event/composed"
12879
- },
12880
- {
12881
- "kind": "method",
12882
- "name": "handleKeyDown",
12883
- "privacy": "protected",
12884
- "parameters": [
12885
- {
12886
- "name": "event",
12887
- "type": {
12888
- "text": "KeyboardEvent"
12889
- },
12890
- "description": "Keyboard event"
12891
- }
12892
- ],
12893
- "description": "Handles the keydown event of the input field.\nIf the key pressed is 'Enter', it submits the form."
12894
- },
12895
- {
12896
- "kind": "method",
12897
- "name": "renderLeadingIcon",
12898
- "privacy": "protected",
12899
- "description": "Renders the leading icon before the input field.\nIf the leading icon is not set, it will not be displayed.",
12900
- "return": {
12901
- "type": {
12902
- "text": ""
12903
- }
12904
- }
12905
- },
12906
- {
12907
- "kind": "method",
12908
- "name": "renderPrefixText",
12909
- "privacy": "protected",
12910
- "description": "Renders the prefix text before the input field.\nIf the prefix text is more than 10 characters,\n- it will not be displayed.\n- the validation messsage will be displayed.\n\n Note: We are setting aria-hidden so that the screen reader does not read the prefix text.\n The consumers should set the appropriate aria-label for the input field using 'data-aria-label' attribute.",
12911
- "return": {
12912
- "type": {
12913
- "text": ""
12914
- }
12915
- }
12916
- },
12917
- {
12918
- "kind": "method",
12919
- "name": "clearInputText",
12920
- "privacy": "protected",
12921
- "description": "Clears the input field."
12922
- },
12923
- {
12924
- "kind": "method",
12925
- "name": "renderTrailingButton",
12926
- "privacy": "protected",
12927
- "parameters": [
12928
- {
12929
- "name": "show",
12930
- "default": "false"
12931
- }
12932
- ],
12933
- "description": "Renders the trailing button to clear the input field if the trailingButton is set to true.",
12934
- "return": {
12935
- "type": {
12936
- "text": ""
12937
- }
12938
- }
12939
- },
12940
- {
12941
- "kind": "method",
12942
- "name": "renderInputElement",
12943
- "privacy": "protected",
12944
- "parameters": [
12945
- {
12946
- "name": "type",
12947
- "type": {
12948
- "text": "InputType"
12949
- }
12950
- },
12951
- {
12952
- "name": "hidePlaceholder",
12953
- "default": "false"
12954
- }
12955
- ]
13161
+ "fieldName": "clearAriaLabel"
12956
13162
  },
12957
13163
  {
12958
- "kind": "field",
12959
13164
  "name": "name",
12960
13165
  "type": {
12961
13166
  "text": "string"
12962
13167
  },
12963
13168
  "default": "''",
12964
13169
  "description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
12965
- "attribute": "name",
12966
- "reflects": true,
13170
+ "fieldName": "name",
12967
13171
  "inheritedFrom": {
12968
13172
  "name": "FormInternalsMixin",
12969
- "module": "utils/mixins/FormInternalsMixin.js"
13173
+ "module": "src/utils/mixins/FormInternalsMixin.ts"
12970
13174
  }
12971
13175
  },
12972
13176
  {
12973
- "kind": "field",
12974
13177
  "name": "value",
12975
13178
  "type": {
12976
13179
  "text": "string"
12977
13180
  },
12978
13181
  "default": "''",
12979
13182
  "description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
12980
- "attribute": "value",
12981
- "reflects": true,
13183
+ "fieldName": "value",
12982
13184
  "inheritedFrom": {
12983
13185
  "name": "FormInternalsMixin",
12984
- "module": "utils/mixins/FormInternalsMixin.js"
13186
+ "module": "src/utils/mixins/FormInternalsMixin.ts"
12985
13187
  }
12986
13188
  },
12987
13189
  {
12988
- "kind": "field",
12989
- "name": "validationMessage",
13190
+ "name": "validation-message",
12990
13191
  "type": {
12991
13192
  "text": "string | undefined"
12992
13193
  },
12993
13194
  "description": "Custom validation message that will override the default message and displayed when the input is invalid.\n\nTo display custom validation messages, you must listen for input events (or other relevant events)\non your component and update the `validationMessage` property with the desired message string.\nUpdating this property will ensure that new validation messages are shown to the user.\n- The `validationMessage` property overrides the default browser validation message when set.\n- Consumers are responsible for updating `validationMessage` in response to input or validation state changes.",
12994
- "attribute": "validation-message",
12995
- "reflects": true,
12996
- "inheritedFrom": {
12997
- "name": "FormInternalsMixin",
12998
- "module": "utils/mixins/FormInternalsMixin.js"
12999
- }
13000
- },
13001
- {
13002
- "kind": "field",
13003
- "name": "validity",
13004
- "type": {
13005
- "text": "ValidityState"
13006
- },
13007
- "readonly": true,
13008
- "inheritedFrom": {
13009
- "name": "FormInternalsMixin",
13010
- "module": "utils/mixins/FormInternalsMixin.js"
13011
- }
13012
- },
13013
- {
13014
- "kind": "field",
13015
- "name": "willValidate",
13016
- "readonly": true,
13017
- "inheritedFrom": {
13018
- "name": "FormInternalsMixin",
13019
- "module": "utils/mixins/FormInternalsMixin.js"
13020
- }
13021
- },
13022
- {
13023
- "kind": "method",
13024
- "name": "setValidity",
13025
- "description": "Sets the validity of the input field based on the input field's validity.",
13026
- "return": {
13027
- "type": {
13028
- "text": ""
13029
- }
13030
- },
13031
- "inheritedFrom": {
13032
- "name": "FormInternalsMixin",
13033
- "module": "utils/mixins/FormInternalsMixin.js"
13034
- }
13035
- },
13036
- {
13037
- "kind": "method",
13038
- "name": "checkValidity",
13039
- "return": {
13040
- "type": {
13041
- "text": "boolean"
13042
- }
13043
- },
13044
- "inheritedFrom": {
13045
- "name": "FormInternalsMixin",
13046
- "module": "utils/mixins/FormInternalsMixin.js"
13047
- }
13048
- },
13049
- {
13050
- "kind": "method",
13051
- "name": "reportValidity",
13195
+ "fieldName": "validationMessage",
13052
13196
  "inheritedFrom": {
13053
13197
  "name": "FormInternalsMixin",
13054
- "module": "utils/mixins/FormInternalsMixin.js"
13198
+ "module": "src/utils/mixins/FormInternalsMixin.ts"
13055
13199
  }
13056
13200
  },
13057
13201
  {
13058
- "kind": "field",
13059
- "name": "dataAriaLabel",
13202
+ "name": "data-aria-label",
13060
13203
  "type": {
13061
13204
  "text": "string | null"
13062
13205
  },
13063
13206
  "default": "null",
13064
13207
  "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
13065
- "attribute": "data-aria-label",
13066
- "reflects": true,
13208
+ "fieldName": "dataAriaLabel",
13067
13209
  "inheritedFrom": {
13068
13210
  "name": "DataAriaLabelMixin",
13069
- "module": "utils/mixins/DataAriaLabelMixin.js"
13211
+ "module": "src/utils/mixins/DataAriaLabelMixin.ts"
13070
13212
  }
13071
13213
  },
13072
13214
  {
13073
- "kind": "field",
13074
13215
  "name": "disabled",
13075
13216
  "type": {
13076
13217
  "text": "boolean | undefined"
13077
13218
  },
13078
13219
  "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
13079
13220
  "default": "undefined",
13080
- "attribute": "disabled",
13081
- "reflects": true,
13221
+ "fieldName": "disabled",
13082
13222
  "inheritedFrom": {
13083
- "name": "FormfieldWrapper",
13084
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
13223
+ "name": "DisabledMixin",
13224
+ "module": "src/utils/mixins/DisabledMixin.ts"
13085
13225
  }
13086
13226
  },
13087
13227
  {
13088
- "kind": "field",
13089
13228
  "name": "label",
13090
13229
  "type": {
13091
13230
  "text": "string | undefined"
13092
13231
  },
13093
13232
  "description": "The label of the input field. It is linked to the input field using the `for` attribute.",
13094
- "attribute": "label",
13095
- "reflects": true,
13233
+ "fieldName": "label",
13096
13234
  "inheritedFrom": {
13097
13235
  "name": "FormfieldWrapper",
13098
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
13236
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
13099
13237
  }
13100
13238
  },
13101
13239
  {
13102
- "kind": "field",
13103
13240
  "name": "required",
13104
13241
  "type": {
13105
13242
  "text": "boolean"
13106
13243
  },
13107
13244
  "default": "false",
13108
13245
  "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
13109
- "attribute": "required",
13110
- "reflects": true,
13246
+ "fieldName": "required",
13111
13247
  "inheritedFrom": {
13112
13248
  "name": "FormfieldWrapper",
13113
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
13249
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
13114
13250
  }
13115
13251
  },
13116
13252
  {
13117
- "kind": "field",
13118
13253
  "name": "id",
13119
13254
  "type": {
13120
13255
  "text": "string"
13121
13256
  },
13122
13257
  "default": "''",
13123
13258
  "description": "The unique id of the input field. It is used to link the input field with the label.",
13124
- "attribute": "id",
13259
+ "fieldName": "id",
13125
13260
  "inheritedFrom": {
13126
13261
  "name": "FormfieldWrapper",
13127
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
13262
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
13128
13263
  }
13129
13264
  },
13130
13265
  {
13131
- "kind": "field",
13132
- "name": "helpTextType",
13266
+ "name": "help-text-type",
13133
13267
  "type": {
13134
13268
  "text": "ValidationType"
13135
13269
  },
13136
13270
  "description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
13137
- "attribute": "help-text-type",
13138
- "reflects": true,
13271
+ "fieldName": "helpTextType",
13139
13272
  "inheritedFrom": {
13140
13273
  "name": "FormfieldWrapper",
13141
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
13274
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
13142
13275
  }
13143
13276
  },
13144
13277
  {
13145
- "kind": "field",
13146
- "name": "helpText",
13278
+ "name": "help-text",
13147
13279
  "type": {
13148
13280
  "text": "string | undefined"
13149
13281
  },
13150
13282
  "description": "The help text that is displayed below the input field.",
13151
- "attribute": "help-text",
13152
- "reflects": true,
13283
+ "fieldName": "helpText",
13153
13284
  "inheritedFrom": {
13154
13285
  "name": "FormfieldWrapper",
13155
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
13286
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
13156
13287
  }
13157
13288
  },
13158
13289
  {
13159
- "kind": "field",
13160
- "name": "toggletipText",
13290
+ "name": "toggletip-text",
13161
13291
  "type": {
13162
13292
  "text": "string | undefined"
13163
13293
  },
13164
13294
  "description": "The toggletip text that is displayed when the label is hovered.\nIt is used to provide additional information about the label.",
13165
- "attribute": "toggletip-text",
13166
- "reflects": true,
13295
+ "fieldName": "toggletipText",
13167
13296
  "inheritedFrom": {
13168
13297
  "name": "FormfieldWrapper",
13169
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
13298
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
13170
13299
  }
13171
13300
  },
13172
13301
  {
13173
- "kind": "field",
13174
- "name": "toggletipPlacement",
13302
+ "name": "toggletip-placement",
13175
13303
  "type": {
13176
13304
  "text": "PopoverPlacement"
13177
13305
  },
13178
13306
  "description": "The placement of the toggletip that is displayed when the info icon is hovered.",
13179
13307
  "default": "'top'",
13180
- "attribute": "toggletip-placement",
13181
- "reflects": true,
13308
+ "fieldName": "toggletipPlacement",
13182
13309
  "inheritedFrom": {
13183
13310
  "name": "FormfieldWrapper",
13184
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
13311
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
13185
13312
  }
13186
13313
  },
13187
13314
  {
13188
- "kind": "field",
13189
- "name": "infoIconAriaLabel",
13315
+ "name": "info-icon-aria-label",
13190
13316
  "type": {
13191
13317
  "text": "string | undefined"
13192
13318
  },
13193
13319
  "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.",
13194
- "attribute": "info-icon-aria-label",
13195
- "reflects": true,
13196
- "inheritedFrom": {
13197
- "name": "FormfieldWrapper",
13198
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
13199
- }
13200
- },
13201
- {
13202
- "kind": "method",
13203
- "name": "renderLabelElement",
13204
- "privacy": "protected",
13205
- "description": "creates the label element when the label property is set.\nid is used to link the label with the input field.",
13206
- "return": {
13207
- "type": {
13208
- "text": ""
13209
- }
13210
- },
13211
- "inheritedFrom": {
13212
- "name": "FormfieldWrapper",
13213
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
13214
- }
13215
- },
13216
- {
13217
- "kind": "method",
13218
- "name": "renderHelpTextIcon",
13219
- "privacy": "protected",
13220
- "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.",
13221
- "return": {
13222
- "type": {
13223
- "text": ""
13224
- }
13225
- },
13226
- "inheritedFrom": {
13227
- "name": "FormfieldWrapper",
13228
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
13229
- }
13230
- },
13231
- {
13232
- "kind": "method",
13233
- "name": "renderHelpText",
13234
- "privacy": "protected",
13235
- "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.",
13236
- "return": {
13237
- "type": {
13238
- "text": ""
13239
- }
13240
- },
13241
- "inheritedFrom": {
13242
- "name": "FormfieldWrapper",
13243
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
13244
- }
13245
- },
13246
- {
13247
- "kind": "method",
13248
- "name": "renderLabel",
13249
- "privacy": "protected",
13250
- "description": "renders the mdc-label-text container that contains the label and labelInfoToggleTip.",
13251
- "return": {
13252
- "type": {
13253
- "text": ""
13254
- }
13255
- },
13256
- "inheritedFrom": {
13257
- "name": "FormfieldWrapper",
13258
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
13259
- }
13260
- },
13261
- {
13262
- "kind": "method",
13263
- "name": "renderHelperText",
13264
- "privacy": "protected",
13265
- "description": "renders the mdc-help-text container that contains the helpertext icon and helpertext.",
13266
- "return": {
13267
- "type": {
13268
- "text": ""
13269
- }
13270
- },
13320
+ "fieldName": "infoIconAriaLabel",
13271
13321
  "inheritedFrom": {
13272
13322
  "name": "FormfieldWrapper",
13273
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
13323
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
13274
13324
  }
13275
13325
  }
13276
13326
  ],
13277
- "events": [
13278
- {
13279
- "type": {
13280
- "text": "EventConstructor"
13281
- }
13282
- },
13283
- {
13284
- "description": "(React: onInput) This event is dispatched when the value of the input field changes (every press).",
13285
- "name": "input",
13286
- "reactName": "onInput"
13287
- },
13288
- {
13289
- "description": "(React: onChange) This event is dispatched when the value of the input field changes (on blur).",
13290
- "name": "change",
13291
- "reactName": "onChange"
13292
- },
13327
+ "mixins": [
13293
13328
  {
13294
- "description": "(React: onFocus) This event is dispatched when the input receives focus.",
13295
- "name": "focus",
13296
- "reactName": "onFocus"
13329
+ "name": "FormInternalsMixin",
13330
+ "module": "/src/utils/mixins/FormInternalsMixin"
13297
13331
  },
13298
13332
  {
13299
- "description": "(React: onBlur) This event is dispatched when the input loses focus.",
13300
- "name": "blur",
13301
- "reactName": "onBlur"
13333
+ "name": "DataAriaLabelMixin",
13334
+ "module": "/src/utils/mixins/DataAriaLabelMixin"
13302
13335
  }
13303
13336
  ],
13304
- "attributes": [
13305
- {
13306
- "name": "placeholder",
13307
- "type": {
13308
- "text": "string"
13309
- },
13310
- "default": "''",
13311
- "description": "The placeholder text that is displayed when the input field is empty.",
13312
- "fieldName": "placeholder"
13313
- },
13314
- {
13315
- "name": "readonly",
13316
- "type": {
13317
- "text": "boolean"
13318
- },
13319
- "default": "false",
13320
- "description": "readonly attribute of the input field. If true, the input field is read-only.",
13321
- "fieldName": "readonly"
13322
- },
13323
- {
13324
- "name": "prefix-text",
13325
- "type": {
13326
- "text": "string | undefined"
13327
- },
13328
- "description": "The prefix text that is displayed before the input field. It has a max length of 10 characters.\nWhen the prefix text is set, make sure to set the 'data-aria-label'\nattribute with the appropriate value for accessibility.",
13329
- "fieldName": "prefixText"
13330
- },
13331
- {
13332
- "name": "leading-icon",
13333
- "type": {
13334
- "text": "IconNames | undefined"
13335
- },
13336
- "description": "The leading icon that is displayed before the input field.",
13337
- "fieldName": "leadingIcon"
13338
- },
13339
- {
13340
- "name": "trailing-button",
13341
- "type": {
13342
- "text": "boolean"
13343
- },
13344
- "default": "false",
13345
- "description": "The trailing button when set to true, shows a clear button that clears the input field.",
13346
- "fieldName": "trailingButton"
13347
- },
13348
- {
13349
- "name": "maxlength",
13350
- "type": {
13351
- "text": "number | undefined"
13352
- },
13353
- "description": "The maximum number of characters that the input field can accept.",
13354
- "fieldName": "maxlength"
13355
- },
13337
+ "superclass": {
13338
+ "name": "FormfieldWrapper",
13339
+ "module": "/src/components/formfieldwrapper"
13340
+ },
13341
+ "tagName": "mdc-input",
13342
+ "jsDoc": "/**\n * mdc-input is a component that allows users to input text.\n * It contains:\n * - label field - describe the input field.\n * - input field - contains the value\n * - help text or validation message - displayed below the input field.\n * - trailing button - it displays a clear the input field.\n * - prefix text - displayed before the input field.\n * - leading icon - displayed before the input field.\n * - clear-aria-label - aria label for the trailing button.\n * - all the attributes of the input field.\n *\n * @tagname mdc-input\n *\n * @event input - (React: onInput) This event is dispatched when the value of the input field changes (every press).\n * @event change - (React: onChange) This event is dispatched when the value of the input field changes (on blur).\n * @event focus - (React: onFocus) This event is dispatched when the input receives focus.\n * @event blur - (React: onBlur) This event is dispatched when the input loses focus.\n *\n * @dependency mdc-icon\n * @dependency mdc-text\n * @dependency mdc-button\n * @dependency mdc-toggletip\n *\n * @cssproperty --mdc-input-disabled-border-color - Border color for the input container when disabled\n * @cssproperty --mdc-input-disabled-text-color - Text color for the input field when disabled\n * @cssproperty --mdc-input-disabled-background-color - Background color for the input field when disabled\n * @cssproperty --mdc-input-border-color - Border color for the input container\n * @cssproperty --mdc-input-text-color - Text color for the input field\n * @cssproperty --mdc-input-background-color - Background color for the input field\n * @cssproperty --mdc-input-selection-background-color - Background color for the selected text\n * @cssproperty --mdc-input-selection-text-color - Text color for the selected text\n * @cssproperty --mdc-input-support-text-color - Text color for the help text\n * @cssproperty --mdc-input-hover-background-color - Background color for the input field when hovered\n * @cssproperty --mdc-input-focused-background-color - Background color for the input field when focused\n * @cssproperty --mdc-input-focused-border-color - Border color for the input container when focused\n * @cssproperty --mdc-input-error-border-color - Border color for the input container when error\n * @cssproperty --mdc-input-warning-border-color - Border color for the input container when warning\n * @cssproperty --mdc-input-success-border-color - Border color for the input container when success\n * @cssproperty --mdc-input-primary-border-color - Border color for the input container when primary\n *\n */",
13343
+ "customElement": true
13344
+ }
13345
+ ],
13346
+ "exports": [
13347
+ {
13348
+ "kind": "js",
13349
+ "name": "default",
13350
+ "declaration": {
13351
+ "name": "Input",
13352
+ "module": "components/input/input.component.js"
13353
+ }
13354
+ }
13355
+ ]
13356
+ },
13357
+ {
13358
+ "kind": "javascript-module",
13359
+ "path": "components/formfieldwrapper/formfieldwrapper.component.js",
13360
+ "declarations": [
13361
+ {
13362
+ "kind": "class",
13363
+ "description": "formfieldwrapper is a component that contains the label and helper/validation text\n that can be configured in various ways to suit different use cases (most of the input related components).\nIt is used as an internal component and is not intended to be used directly by consumers.",
13364
+ "name": "FormfieldWrapper",
13365
+ "members": [
13356
13366
  {
13357
- "name": "minlength",
13367
+ "kind": "field",
13368
+ "name": "label",
13358
13369
  "type": {
13359
- "text": "number | undefined"
13370
+ "text": "string | undefined"
13360
13371
  },
13361
- "description": "The minimum number of characters that the input field can accept.",
13362
- "fieldName": "minlength"
13372
+ "description": "The label of the input field. It is linked to the input field using the `for` attribute.",
13373
+ "attribute": "label",
13374
+ "reflects": true
13363
13375
  },
13364
13376
  {
13365
- "name": "autocapitalize",
13377
+ "kind": "field",
13378
+ "name": "required",
13366
13379
  "type": {
13367
- "text": "AutoCapitalizeType"
13380
+ "text": "boolean"
13368
13381
  },
13369
- "description": "The autocapitalize attribute of the input field.",
13370
- "default": "'off'",
13371
- "fieldName": "autocapitalize"
13382
+ "default": "false",
13383
+ "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
13384
+ "attribute": "required",
13385
+ "reflects": true
13372
13386
  },
13373
13387
  {
13374
- "name": "autocomplete",
13388
+ "kind": "field",
13389
+ "name": "id",
13375
13390
  "type": {
13376
- "text": "AutoCompleteType"
13391
+ "text": "string"
13377
13392
  },
13378
- "description": "The autocomplete attribute of the input field.",
13379
- "default": "'off'",
13380
- "fieldName": "autocomplete"
13393
+ "default": "''",
13394
+ "description": "The unique id of the input field. It is used to link the input field with the label.",
13395
+ "attribute": "id"
13381
13396
  },
13382
13397
  {
13383
- "name": "autofocus",
13398
+ "kind": "field",
13399
+ "name": "helpTextType",
13384
13400
  "type": {
13385
- "text": "boolean"
13401
+ "text": "ValidationType"
13386
13402
  },
13387
- "default": "false",
13388
- "description": "If true, the input field is focused when the component is rendered.",
13389
- "fieldName": "autofocus"
13403
+ "description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
13404
+ "attribute": "help-text-type",
13405
+ "reflects": true
13390
13406
  },
13391
13407
  {
13392
- "name": "dirname",
13408
+ "kind": "field",
13409
+ "name": "helpText",
13393
13410
  "type": {
13394
13411
  "text": "string | undefined"
13395
13412
  },
13396
- "description": "Specifies the name of the directionality of text for submission purposes (e.g., \"rtl\" for right-to-left).",
13397
- "fieldName": "dirname"
13413
+ "description": "The help text that is displayed below the input field.",
13414
+ "attribute": "help-text",
13415
+ "reflects": true
13398
13416
  },
13399
13417
  {
13400
- "name": "pattern",
13418
+ "kind": "field",
13419
+ "name": "toggletipText",
13401
13420
  "type": {
13402
13421
  "text": "string | undefined"
13403
13422
  },
13404
- "description": "The pattern attribute of the input field.\nSpecifies a regular expression that the input value must match for validation purposes.",
13405
- "fieldName": "pattern"
13423
+ "description": "The toggletip text that is displayed when the label is hovered.\nIt is used to provide additional information about the label.",
13424
+ "attribute": "toggletip-text",
13425
+ "reflects": true
13406
13426
  },
13407
13427
  {
13408
- "name": "list",
13428
+ "kind": "field",
13429
+ "name": "toggletipPlacement",
13409
13430
  "type": {
13410
- "text": "string | undefined"
13431
+ "text": "PopoverPlacement"
13411
13432
  },
13412
- "description": "The list attribute of the input field.\nIdentifies a list of pre-defined options to suggest to the user.",
13413
- "fieldName": "list"
13433
+ "description": "The placement of the toggletip that is displayed when the info icon is hovered.",
13434
+ "default": "'top'",
13435
+ "attribute": "toggletip-placement",
13436
+ "reflects": true
13414
13437
  },
13415
13438
  {
13416
- "name": "size",
13439
+ "kind": "field",
13440
+ "name": "infoIconAriaLabel",
13417
13441
  "type": {
13418
- "text": "number | undefined | undefined"
13442
+ "text": "string | undefined"
13419
13443
  },
13420
- "description": "The size attribute of the input field.\nSpecifies the width of the input field.",
13421
- "default": "undefined",
13422
- "fieldName": "size"
13444
+ "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.",
13445
+ "attribute": "info-icon-aria-label",
13446
+ "reflects": true
13423
13447
  },
13424
13448
  {
13425
- "name": "clear-aria-label",
13426
- "type": {
13427
- "text": "string"
13428
- },
13429
- "default": "''",
13430
- "description": "Aria label for the trailing button. If trailing button is set to true, this label is used for the clear button.",
13431
- "fieldName": "clearAriaLabel"
13449
+ "kind": "method",
13450
+ "name": "renderLabelElement",
13451
+ "privacy": "protected",
13452
+ "description": "creates the label element when the label property is set.\nid is used to link the label with the input field.",
13453
+ "return": {
13454
+ "type": {
13455
+ "text": ""
13456
+ }
13457
+ }
13432
13458
  },
13433
13459
  {
13434
- "name": "name",
13435
- "type": {
13436
- "text": "string"
13437
- },
13438
- "default": "''",
13439
- "description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
13440
- "fieldName": "name",
13441
- "inheritedFrom": {
13442
- "name": "FormInternalsMixin",
13443
- "module": "src/utils/mixins/FormInternalsMixin.ts"
13460
+ "kind": "method",
13461
+ "name": "renderHelpTextIcon",
13462
+ "privacy": "protected",
13463
+ "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.",
13464
+ "return": {
13465
+ "type": {
13466
+ "text": ""
13467
+ }
13444
13468
  }
13445
13469
  },
13446
13470
  {
13447
- "name": "value",
13448
- "type": {
13449
- "text": "string"
13450
- },
13451
- "default": "''",
13452
- "description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
13453
- "fieldName": "value",
13454
- "inheritedFrom": {
13455
- "name": "FormInternalsMixin",
13456
- "module": "src/utils/mixins/FormInternalsMixin.ts"
13471
+ "kind": "method",
13472
+ "name": "renderHelpText",
13473
+ "privacy": "protected",
13474
+ "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.",
13475
+ "return": {
13476
+ "type": {
13477
+ "text": ""
13478
+ }
13457
13479
  }
13458
13480
  },
13459
13481
  {
13460
- "name": "validation-message",
13461
- "type": {
13462
- "text": "string | undefined"
13463
- },
13464
- "description": "Custom validation message that will override the default message and displayed when the input is invalid.\n\nTo display custom validation messages, you must listen for input events (or other relevant events)\non your component and update the `validationMessage` property with the desired message string.\nUpdating this property will ensure that new validation messages are shown to the user.\n- The `validationMessage` property overrides the default browser validation message when set.\n- Consumers are responsible for updating `validationMessage` in response to input or validation state changes.",
13465
- "fieldName": "validationMessage",
13466
- "inheritedFrom": {
13467
- "name": "FormInternalsMixin",
13468
- "module": "src/utils/mixins/FormInternalsMixin.ts"
13482
+ "kind": "method",
13483
+ "name": "renderLabel",
13484
+ "privacy": "protected",
13485
+ "description": "renders the mdc-label-text container that contains the label and labelInfoToggleTip.",
13486
+ "return": {
13487
+ "type": {
13488
+ "text": ""
13489
+ }
13469
13490
  }
13470
13491
  },
13471
13492
  {
13472
- "name": "data-aria-label",
13473
- "type": {
13474
- "text": "string | null"
13475
- },
13476
- "default": "null",
13477
- "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
13478
- "fieldName": "dataAriaLabel",
13479
- "inheritedFrom": {
13480
- "name": "DataAriaLabelMixin",
13481
- "module": "src/utils/mixins/DataAriaLabelMixin.ts"
13493
+ "kind": "method",
13494
+ "name": "renderHelperText",
13495
+ "privacy": "protected",
13496
+ "description": "renders the mdc-help-text container that contains the helpertext icon and helpertext.",
13497
+ "return": {
13498
+ "type": {
13499
+ "text": ""
13500
+ }
13482
13501
  }
13483
13502
  },
13484
13503
  {
13504
+ "kind": "field",
13485
13505
  "name": "disabled",
13486
13506
  "type": {
13487
13507
  "text": "boolean | undefined"
13488
13508
  },
13489
13509
  "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
13490
13510
  "default": "undefined",
13491
- "fieldName": "disabled",
13511
+ "attribute": "disabled",
13512
+ "reflects": true,
13492
13513
  "inheritedFrom": {
13493
- "name": "FormfieldWrapper",
13494
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
13514
+ "name": "DisabledMixin",
13515
+ "module": "utils/mixins/DisabledMixin.js"
13495
13516
  }
13496
- },
13517
+ }
13518
+ ],
13519
+ "attributes": [
13497
13520
  {
13498
13521
  "name": "label",
13499
13522
  "type": {
13500
13523
  "text": "string | undefined"
13501
13524
  },
13502
13525
  "description": "The label of the input field. It is linked to the input field using the `for` attribute.",
13503
- "fieldName": "label",
13504
- "inheritedFrom": {
13505
- "name": "FormfieldWrapper",
13506
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
13507
- }
13526
+ "fieldName": "label"
13508
13527
  },
13509
13528
  {
13510
13529
  "name": "required",
@@ -13513,11 +13532,7 @@
13513
13532
  },
13514
13533
  "default": "false",
13515
13534
  "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
13516
- "fieldName": "required",
13517
- "inheritedFrom": {
13518
- "name": "FormfieldWrapper",
13519
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
13520
- }
13535
+ "fieldName": "required"
13521
13536
  },
13522
13537
  {
13523
13538
  "name": "id",
@@ -13526,11 +13541,7 @@
13526
13541
  },
13527
13542
  "default": "''",
13528
13543
  "description": "The unique id of the input field. It is used to link the input field with the label.",
13529
- "fieldName": "id",
13530
- "inheritedFrom": {
13531
- "name": "FormfieldWrapper",
13532
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
13533
- }
13544
+ "fieldName": "id"
13534
13545
  },
13535
13546
  {
13536
13547
  "name": "help-text-type",
@@ -13538,11 +13549,7 @@
13538
13549
  "text": "ValidationType"
13539
13550
  },
13540
13551
  "description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
13541
- "fieldName": "helpTextType",
13542
- "inheritedFrom": {
13543
- "name": "FormfieldWrapper",
13544
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
13545
- }
13552
+ "fieldName": "helpTextType"
13546
13553
  },
13547
13554
  {
13548
13555
  "name": "help-text",
@@ -13550,11 +13557,7 @@
13550
13557
  "text": "string | undefined"
13551
13558
  },
13552
13559
  "description": "The help text that is displayed below the input field.",
13553
- "fieldName": "helpText",
13554
- "inheritedFrom": {
13555
- "name": "FormfieldWrapper",
13556
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
13557
- }
13560
+ "fieldName": "helpText"
13558
13561
  },
13559
13562
  {
13560
13563
  "name": "toggletip-text",
@@ -13562,11 +13565,7 @@
13562
13565
  "text": "string | undefined"
13563
13566
  },
13564
13567
  "description": "The toggletip text that is displayed when the label is hovered.\nIt is used to provide additional information about the label.",
13565
- "fieldName": "toggletipText",
13566
- "inheritedFrom": {
13567
- "name": "FormfieldWrapper",
13568
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
13569
- }
13568
+ "fieldName": "toggletipText"
13570
13569
  },
13571
13570
  {
13572
13571
  "name": "toggletip-placement",
@@ -13575,11 +13574,7 @@
13575
13574
  },
13576
13575
  "description": "The placement of the toggletip that is displayed when the info icon is hovered.",
13577
13576
  "default": "'top'",
13578
- "fieldName": "toggletipPlacement",
13579
- "inheritedFrom": {
13580
- "name": "FormfieldWrapper",
13581
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
13582
- }
13577
+ "fieldName": "toggletipPlacement"
13583
13578
  },
13584
13579
  {
13585
13580
  "name": "info-icon-aria-label",
@@ -13587,29 +13582,34 @@
13587
13582
  "text": "string | undefined"
13588
13583
  },
13589
13584
  "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.",
13590
- "fieldName": "infoIconAriaLabel",
13585
+ "fieldName": "infoIconAriaLabel"
13586
+ },
13587
+ {
13588
+ "name": "disabled",
13589
+ "type": {
13590
+ "text": "boolean | undefined"
13591
+ },
13592
+ "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
13593
+ "default": "undefined",
13594
+ "fieldName": "disabled",
13591
13595
  "inheritedFrom": {
13592
- "name": "FormfieldWrapper",
13593
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
13596
+ "name": "DisabledMixin",
13597
+ "module": "src/utils/mixins/DisabledMixin.ts"
13594
13598
  }
13595
13599
  }
13596
13600
  ],
13597
13601
  "mixins": [
13598
13602
  {
13599
- "name": "FormInternalsMixin",
13600
- "module": "/src/utils/mixins/FormInternalsMixin"
13601
- },
13602
- {
13603
- "name": "DataAriaLabelMixin",
13604
- "module": "/src/utils/mixins/DataAriaLabelMixin"
13603
+ "name": "DisabledMixin",
13604
+ "module": "/src/utils/mixins/DisabledMixin"
13605
13605
  }
13606
13606
  ],
13607
13607
  "superclass": {
13608
- "name": "FormfieldWrapper",
13609
- "module": "/src/components/formfieldwrapper"
13608
+ "name": "Component",
13609
+ "module": "/src/models"
13610
13610
  },
13611
- "tagName": "mdc-input",
13612
- "jsDoc": "/**\n * mdc-input is a component that allows users to input text.\n * It contains:\n * - label field - describe the input field.\n * - input field - contains the value\n * - help text or validation message - displayed below the input field.\n * - trailing button - it displays a clear the input field.\n * - prefix text - displayed before the input field.\n * - leading icon - displayed before the input field.\n * - clear-aria-label - aria label for the trailing button.\n * - all the attributes of the input field.\n *\n * @tagname mdc-input\n *\n * @event input - (React: onInput) This event is dispatched when the value of the input field changes (every press).\n * @event change - (React: onChange) This event is dispatched when the value of the input field changes (on blur).\n * @event focus - (React: onFocus) This event is dispatched when the input receives focus.\n * @event blur - (React: onBlur) This event is dispatched when the input loses focus.\n *\n * @dependency mdc-icon\n * @dependency mdc-text\n * @dependency mdc-button\n * @dependency mdc-toggletip\n *\n * @cssproperty --mdc-input-disabled-border-color - Border color for the input container when disabled\n * @cssproperty --mdc-input-disabled-text-color - Text color for the input field when disabled\n * @cssproperty --mdc-input-disabled-background-color - Background color for the input field when disabled\n * @cssproperty --mdc-input-border-color - Border color for the input container\n * @cssproperty --mdc-input-text-color - Text color for the input field\n * @cssproperty --mdc-input-background-color - Background color for the input field\n * @cssproperty --mdc-input-selection-background-color - Background color for the selected text\n * @cssproperty --mdc-input-selection-text-color - Text color for the selected text\n * @cssproperty --mdc-input-support-text-color - Text color for the help text\n * @cssproperty --mdc-input-hover-background-color - Background color for the input field when hovered\n * @cssproperty --mdc-input-focused-background-color - Background color for the input field when focused\n * @cssproperty --mdc-input-focused-border-color - Border color for the input container when focused\n * @cssproperty --mdc-input-error-border-color - Border color for the input container when error\n * @cssproperty --mdc-input-warning-border-color - Border color for the input container when warning\n * @cssproperty --mdc-input-success-border-color - Border color for the input container when success\n * @cssproperty --mdc-input-primary-border-color - Border color for the input container when primary\n *\n */",
13611
+ "tagName": "mdc-formfieldwrapper",
13612
+ "jsDoc": "/**\n * formfieldwrapper is a component that contains the label and helper/validation text\n * that can be configured in various ways to suit different use cases (most of the input related components).\n * It is used as an internal component and is not intended to be used directly by consumers.\n *\n * @tagname mdc-formfieldwrapper\n *\n * @dependency mdc-text\n * @dependency mdc-icon\n * @dependency mdc-button\n * @dependency mdc-toggletip\n *\n *\n */",
13613
13613
  "customElement": true
13614
13614
  }
13615
13615
  ],
@@ -13618,8 +13618,8 @@
13618
13618
  "kind": "js",
13619
13619
  "name": "default",
13620
13620
  "declaration": {
13621
- "name": "Input",
13622
- "module": "components/input/input.component.js"
13621
+ "name": "FormfieldWrapper",
13622
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
13623
13623
  }
13624
13624
  }
13625
13625
  ]