@momentum-design/components 0.76.5 → 0.76.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -28029,270 +28029,289 @@
28029
28029
  },
28030
28030
  {
28031
28031
  "kind": "javascript-module",
28032
- "path": "components/textarea/textarea.component.js",
28032
+ "path": "components/themeprovider/themeprovider.component.js",
28033
28033
  "declarations": [
28034
28034
  {
28035
28035
  "kind": "class",
28036
- "description": "mdc-textarea component, which is used to get the multi-line text input from the user.\nIt contains:\n- label: It is the title of the textarea field.\n- required: A boolean attribute depicting that the textarea field is required.\n- Textarea: It is the multi-line text input field.\n- helper-text: It is the text that provides additional information about the textarea field.\n- max-character-limit: It is the text that shows the character count of the textarea field.\n- Error, Warning, Success, Priority Help Text type: It is the text that provides additional information\n about the textarea field based on the validation state.\n- limitexceeded: It is the event that is dispatched when the character limit exceeds or restored.\n This event exposes 3 properties:\n - currentCharacterCount - the current number of characters in the textarea field,\n - maxCharacterLimit - the maximum number of characters allowed in the textarea field,\n - value - the current value of the textarea field,\n\n**Note**: Consumers must set the help-text-type with 'error' and\nhelp-text attribute with the error message using limitexceeded event.\nThe same help-text value will be used for the validation message to be displayed.",
28037
- "name": "Textarea",
28036
+ "description": "ThemeProvider component, which sets the passed in themeclass as class.\nIf the themeclass switches, the existing themeclass will be removed as a class\nand the new themeclass will be added.\n\nCSS variables defined in the themeclass will be used for the styling of child dom nodes.\n\nAvailable Momentum theme classes:\n\n`mds-theme-stable-darkWebex`, `mds-theme-stable-lightWebex`\n\n`mds-theme-stable-darkBronzeWebex`, `mds-theme-stable-lightBronzeWebex`\n\n`mds-theme-stable-darkIndigoWebex`, `mds-theme-stable-lightIndigoWebex`\n\n`mds-theme-stable-darkJadeWebex`, `mds-theme-stable-lightJadeWebex`\n\n`mds-theme-stable-darkLavenderWebex`, `mds-theme-stable-lightLavenderWebex`\n\n`mds-theme-stable-darkRoseWebex`, `mds-theme-stable-lightRoseWebex`\n\nThemeclass context can be be consumed from Lit child components\n(see providerUtils.consume for how to consume)\n\nThemeProvider also includes basic font defaults for text.",
28037
+ "name": "ThemeProvider",
28038
28038
  "cssProperties": [
28039
28039
  {
28040
- "description": "Border color for the textarea container when disabled",
28041
- "name": "--mdc-textarea-disabled-border-color"
28040
+ "description": "Option to override the default color, default: color-theme-text-primary-normal",
28041
+ "name": "--mdc-themeprovider-color-default"
28042
28042
  },
28043
28043
  {
28044
- "description": "Text color for the textarea field when disabled",
28045
- "name": "--mdc-textarea-disabled-text-color"
28044
+ "description": "Option to override the font family, default: `Momentum` (from momentum-design/fonts)",
28045
+ "name": "--mdc-themeprovider-font-family"
28046
28046
  },
28047
28047
  {
28048
- "description": "Background color for the textarea field when disabled",
28049
- "name": "--mdc-textarea-disabled-background-color"
28048
+ "description": "Option to override the font weight, default: `400`",
28049
+ "name": "--mdc-themeprovider-font-weight"
28050
28050
  },
28051
28051
  {
28052
- "description": "Text color for the textarea field",
28053
- "name": "--mdc-textarea-text-color"
28052
+ "description": "Option to override the default letter-spacing, default: `-0.25px` (this is to match the old CiscoSans)",
28053
+ "name": "--mdc-themeprovider-letter-spacing-adjustment"
28054
28054
  },
28055
28055
  {
28056
- "description": "Background color for the textarea field",
28057
- "name": "--mdc-textarea-background-color"
28056
+ "description": "Option to override the font feature settings, default: `\"ss02\" on`",
28057
+ "name": "--mdc-themeprovider-font-feature-settings"
28058
28058
  },
28059
28059
  {
28060
- "description": "Border color for the textarea field",
28061
- "name": "--mdc-textarea-border-color"
28060
+ "description": "Option to override the color of the scrollbar track.",
28061
+ "name": "--mdc-themeprovider-scrollbar-track-color"
28062
28062
  },
28063
28063
  {
28064
- "description": "Text color for the character counter",
28065
- "name": "--mdc-textarea-text-secondary-normal"
28064
+ "description": "Option to override the color of the scrollbar thumb.",
28065
+ "name": "--mdc-themeprovider-scrollbar-thumb-color"
28066
28066
  },
28067
28067
  {
28068
- "description": "Border color for the error related help text",
28069
- "name": "--mdc-textarea-error-border-color"
28068
+ "description": "Option to override the color of the scrollbar thumb on hover. Applicable only on webkit browsers.",
28069
+ "name": "--mdc-themeprovider-scrollbar-thumb-hover-color"
28070
28070
  },
28071
28071
  {
28072
- "description": "Border color for the warning related help text",
28073
- "name": "--mdc-textarea-warning-border-color"
28074
- },
28072
+ "description": "Option to override the color of the scrollbar thumb on press. Applicable only on webkit browsers.",
28073
+ "name": "--mdc-themeprovider-scrollbar-thumb-active-color"
28074
+ }
28075
+ ],
28076
+ "slots": [
28075
28077
  {
28076
- "description": "Border color for the success related help text",
28077
- "name": "--mdc-textarea-success-border-color"
28078
- },
28078
+ "description": "children",
28079
+ "name": ""
28080
+ }
28081
+ ],
28082
+ "members": [
28079
28083
  {
28080
- "description": "Border color for the priority related help text",
28081
- "name": "--mdc-textarea-primary-border-color"
28084
+ "kind": "field",
28085
+ "name": "Context",
28086
+ "privacy": "public",
28087
+ "static": true,
28088
+ "description": "Context object of the ThemeProvider, to be consumed by child components",
28089
+ "readonly": true
28082
28090
  },
28083
28091
  {
28084
- "description": "Background color for the textarea container when hover",
28085
- "name": "--mdc-textarea-hover-background-color"
28092
+ "kind": "field",
28093
+ "name": "themeclass",
28094
+ "type": {
28095
+ "text": "string"
28096
+ },
28097
+ "description": "Current theme class\n\nHas to be fully qualified, such that\nthe theme class matches the class of the respective\ntheme stylesheet\n\nDefault: 'mds-theme-stable-darkWebex'",
28098
+ "attribute": "themeclass"
28086
28099
  },
28087
28100
  {
28088
- "description": "Background color for the textarea container when focused",
28089
- "name": "--mdc-textarea-focused-background-color"
28101
+ "kind": "method",
28102
+ "name": "updateContext",
28103
+ "privacy": "protected",
28104
+ "return": {
28105
+ "type": {
28106
+ "text": "void"
28107
+ }
28108
+ },
28109
+ "description": "Update all observing components of this\nprovider to update the themeclass\n\nIs called on every re-render, see Provider class"
28090
28110
  },
28091
28111
  {
28092
- "description": "Border color for the textarea container when focused",
28093
- "name": "--mdc-textarea-focused-border-color"
28112
+ "kind": "method",
28113
+ "name": "setThemeInClassList",
28114
+ "privacy": "private",
28115
+ "description": "Function to update the active theme classnames to update the theme tokens\nas CSS variables on the web component."
28094
28116
  }
28095
28117
  ],
28096
- "members": [
28118
+ "attributes": [
28097
28119
  {
28098
- "kind": "field",
28099
- "name": "placeholder",
28120
+ "name": "themeclass",
28100
28121
  "type": {
28101
- "text": "string | undefined"
28122
+ "text": "string"
28102
28123
  },
28103
- "description": "The placeholder text that is displayed when the textarea field is empty.",
28104
- "attribute": "placeholder"
28124
+ "description": "Current theme class\n\nHas to be fully qualified, such that\nthe theme class matches the class of the respective\ntheme stylesheet\n\nDefault: 'mds-theme-stable-darkWebex'",
28125
+ "fieldName": "themeclass"
28126
+ }
28127
+ ],
28128
+ "superclass": {
28129
+ "name": "Provider",
28130
+ "module": "/src/models"
28131
+ },
28132
+ "tagName": "mdc-themeprovider",
28133
+ "jsDoc": "/**\n * ThemeProvider component, which sets the passed in themeclass as class.\n * If the themeclass switches, the existing themeclass will be removed as a class\n * and the new themeclass will be added.\n *\n * CSS variables defined in the themeclass will be used for the styling of child dom nodes.\n *\n * Available Momentum theme classes:\n *\n * `mds-theme-stable-darkWebex`, `mds-theme-stable-lightWebex`\n *\n * `mds-theme-stable-darkBronzeWebex`, `mds-theme-stable-lightBronzeWebex`\n *\n * `mds-theme-stable-darkIndigoWebex`, `mds-theme-stable-lightIndigoWebex`\n *\n * `mds-theme-stable-darkJadeWebex`, `mds-theme-stable-lightJadeWebex`\n *\n * `mds-theme-stable-darkLavenderWebex`, `mds-theme-stable-lightLavenderWebex`\n *\n * `mds-theme-stable-darkRoseWebex`, `mds-theme-stable-lightRoseWebex`\n *\n * Themeclass context can be be consumed from Lit child components\n * (see providerUtils.consume for how to consume)\n *\n * ThemeProvider also includes basic font defaults for text.\n *\n * @tagname mdc-themeprovider\n *\n * @slot - children\n *\n * @cssproperty --mdc-themeprovider-color-default - Option to override the default color,\n * default: color-theme-text-primary-normal\n * @cssproperty --mdc-themeprovider-font-family - Option to override the font family,\n * default: `Momentum` (from momentum-design/fonts)\n * @cssproperty --mdc-themeprovider-font-weight - Option to override the font weight, default: `400`\n * @cssproperty --mdc-themeprovider-letter-spacing-adjustment - Option to override the default letter-spacing,\n * default: `-0.25px` (this is to match the old CiscoSans)\n * @cssproperty --mdc-themeprovider-font-feature-settings - Option to override the font feature settings,\n * default: `\"ss02\" on`\n * @cssproperty --mdc-themeprovider-scrollbar-track-color - Option to override the color of the scrollbar track.\n * @cssproperty --mdc-themeprovider-scrollbar-thumb-color - Option to override the color of the scrollbar thumb.\n * @cssproperty --mdc-themeprovider-scrollbar-thumb-hover-color - Option to override the color of the\n * scrollbar thumb on hover. Applicable only on webkit browsers.\n * @cssproperty --mdc-themeprovider-scrollbar-thumb-active-color - Option to override the color of the\n * scrollbar thumb on press. Applicable only on webkit browsers.\n */",
28134
+ "customElement": true
28135
+ }
28136
+ ],
28137
+ "exports": [
28138
+ {
28139
+ "kind": "js",
28140
+ "name": "default",
28141
+ "declaration": {
28142
+ "name": "ThemeProvider",
28143
+ "module": "components/themeprovider/themeprovider.component.js"
28144
+ }
28145
+ }
28146
+ ]
28147
+ },
28148
+ {
28149
+ "kind": "javascript-module",
28150
+ "path": "components/toggle/toggle.component.js",
28151
+ "declarations": [
28152
+ {
28153
+ "kind": "class",
28154
+ "description": "Toggle Component is an interactive control used to switch between two mutually exclusive options,\nsuch as On/Off, Active/Inactive. These are commonly used in settings panels, forms, and preference selections\nwhere users need to enable or disable a feature.\nIt contains an optional label and an optional helper text.\n\nTo create a group of toggles, use the FormFieldGroup component.\n\nNote: It internally renders a checkbox styled as a toggle switch.",
28155
+ "name": "Toggle",
28156
+ "cssProperties": [
28157
+ {
28158
+ "description": "Width of the toggle",
28159
+ "name": "--mdc-toggle-width"
28105
28160
  },
28106
28161
  {
28107
- "kind": "field",
28108
- "name": "readonly",
28109
- "type": {
28110
- "text": "boolean"
28111
- },
28112
- "default": "false",
28113
- "description": "readonly attribute of the textarea field. If true, the textarea field is read-only.",
28114
- "attribute": "readonly"
28162
+ "description": "Height of the toggle",
28163
+ "name": "--mdc-toggle-height"
28115
28164
  },
28116
28165
  {
28117
- "kind": "field",
28118
- "name": "rows",
28119
- "description": "The rows attribute specifies the visible number of lines in a text area.",
28120
- "default": "5",
28121
- "attribute": "rows"
28166
+ "description": "Width of the toggle when it's size is compact",
28167
+ "name": "--mdc-toggle-width-compact"
28122
28168
  },
28123
28169
  {
28124
- "kind": "field",
28125
- "name": "cols",
28126
- "description": "The cols attribute specifies the visible number of lines in a text area.",
28127
- "default": "40",
28128
- "attribute": "cols"
28170
+ "description": "Height of the toggle when it's size is compact",
28171
+ "name": "--mdc-toggle-height-compact"
28129
28172
  },
28130
28173
  {
28131
- "kind": "field",
28132
- "name": "wrap",
28133
- "type": {
28134
- "text": "WrapType"
28135
- },
28136
- "description": "The wrap attribute specifies how the text in a text area is to be wrapped when submitted in a form.",
28137
- "default": "'soft'",
28138
- "attribute": "wrap"
28174
+ "description": "Line height of the toggle label",
28175
+ "name": "--mdc-toggle-label-lineheight"
28139
28176
  },
28140
28177
  {
28141
- "kind": "field",
28142
- "name": "autocapitalize",
28143
- "type": {
28144
- "text": "AutoCapitalizeType"
28145
- },
28146
- "description": "The autocapitalize attribute of the textarea field.",
28147
- "default": "'off'",
28148
- "attribute": "autocapitalize"
28178
+ "description": "Font size of the toggle label",
28179
+ "name": "--mdc-toggle-label-fontsize"
28149
28180
  },
28150
28181
  {
28151
- "kind": "field",
28152
- "name": "autocomplete",
28153
- "type": {
28154
- "text": "AutoCompleteType"
28155
- },
28156
- "description": "The autocomplete attribute of the textarea field.",
28157
- "default": "'off'",
28158
- "attribute": "autocomplete"
28182
+ "description": "Font weight of the toggle label",
28183
+ "name": "--mdc-toggle-label-fontweight"
28159
28184
  },
28160
28185
  {
28161
- "kind": "field",
28162
- "name": "autofocus",
28163
- "type": {
28164
- "text": "boolean"
28165
- },
28166
- "default": "false",
28167
- "description": "If true, the textarea field is focused when the component is rendered.",
28168
- "attribute": "autofocus"
28186
+ "description": "Color of the toggle label and help text in disabled state",
28187
+ "name": "--mdc-toggle-label-color-disabled"
28169
28188
  },
28170
28189
  {
28171
- "kind": "field",
28172
- "name": "dirname",
28173
- "type": {
28174
- "text": "string | undefined"
28175
- },
28176
- "description": "Specifies the name of the directionality of text for submission purposes (e.g., \"rtl\" for right-to-left).",
28177
- "attribute": "dirname"
28190
+ "description": "Color of the help text label",
28191
+ "name": "--mdc-toggle-help-text-color"
28178
28192
  },
28179
28193
  {
28180
- "kind": "field",
28181
- "name": "maxlength",
28182
- "type": {
28183
- "text": "number | undefined"
28184
- },
28185
- "description": "The maximum number of characters that the textarea field can accept.",
28186
- "attribute": "maxlength"
28194
+ "description": "Background color of the active toggle in hover state",
28195
+ "name": "--mdc-toggle-active-hover-color"
28187
28196
  },
28188
28197
  {
28189
- "kind": "field",
28190
- "name": "minlength",
28191
- "type": {
28192
- "text": "number | undefined"
28193
- },
28194
- "description": "The minimum number of characters that the textarea field can accept.",
28195
- "attribute": "minlength"
28198
+ "description": "Background color of the active toggle in pressed state",
28199
+ "name": "--mdc-toggle-active-pressed-color"
28196
28200
  },
28201
+ {
28202
+ "description": "Background color of the inactive toggle in hover state",
28203
+ "name": "--mdc-toggle-inactive-hover-color"
28204
+ },
28205
+ {
28206
+ "description": "Background color of the inactive toggle in pressed state",
28207
+ "name": "--mdc-toggle-inactive-pressed-color"
28208
+ }
28209
+ ],
28210
+ "members": [
28197
28211
  {
28198
28212
  "kind": "field",
28199
- "name": "maxCharacterLimit",
28213
+ "name": "checked",
28200
28214
  "type": {
28201
- "text": "number | undefined"
28215
+ "text": "boolean"
28202
28216
  },
28203
- "description": "maximum character limit for the textarea field for character counter.",
28204
- "attribute": "max-character-limit"
28217
+ "default": "false",
28218
+ "description": "Determines whether the toggle is active or inactive.",
28219
+ "attribute": "checked",
28220
+ "reflects": true
28205
28221
  },
28206
28222
  {
28207
28223
  "kind": "field",
28208
- "name": "characterLimitExceedingFired",
28224
+ "name": "size",
28209
28225
  "type": {
28210
- "text": "boolean"
28226
+ "text": "ToggleSize"
28211
28227
  },
28212
- "privacy": "private",
28213
- "default": "false"
28228
+ "description": "Determines toggle size in rem (height is specified here).\n- **Default**: 1.5\n- **Compact**: 1",
28229
+ "default": "default",
28230
+ "attribute": "size",
28231
+ "reflects": true
28214
28232
  },
28215
28233
  {
28216
28234
  "kind": "field",
28217
- "name": "textarea",
28235
+ "name": "autofocus",
28218
28236
  "type": {
28219
- "text": "HTMLTextAreaElement"
28237
+ "text": "boolean"
28220
28238
  },
28221
- "privacy": "protected",
28222
- "readonly": true
28223
- },
28224
- {
28225
- "kind": "method",
28226
- "name": "setTextareaValidity",
28227
- "privacy": "private"
28239
+ "default": "false",
28240
+ "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)",
28241
+ "attribute": "autofocus",
28242
+ "reflects": true
28228
28243
  },
28229
28244
  {
28230
28245
  "kind": "method",
28231
- "name": "handleValueChange",
28232
- "description": "Handles the value change of the textarea field.\nSets the form value and updates the validity of the textarea field.",
28233
- "return": {
28234
- "type": {
28235
- "text": ""
28236
- }
28237
- }
28246
+ "name": "manageRequired",
28247
+ "privacy": "private",
28248
+ "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.\nIf the validationMessage is set, it will be used as the custom validity message.\nIf the validationMessage is not set, it will clear the custom validity message."
28238
28249
  },
28239
28250
  {
28240
28251
  "kind": "method",
28241
- "name": "dispatchCharacterOverflowStateChangeEvent",
28252
+ "name": "setFormValue",
28242
28253
  "privacy": "private",
28243
- "description": "Dispatches the character overflow state change event.",
28244
- "return": {
28245
- "type": {
28246
- "text": ""
28247
- }
28248
- }
28254
+ "description": "Updates the form value to reflect the current state of the toggle.\nIf toggle is switched on, the value is set to either the user-provided value or 'isActive' if no value is provided.\nIf toggle is switched off, the value is set to null."
28249
28255
  },
28250
28256
  {
28251
28257
  "kind": "method",
28252
- "name": "handleCharacterOverflowStateChange",
28258
+ "name": "toggleState",
28253
28259
  "privacy": "private",
28254
- "description": "Handles the character overflow state change.\nDispatches the character overflow state change event if the character limit is exceeded or restored.",
28255
28260
  "return": {
28256
28261
  "type": {
28257
- "text": ""
28262
+ "text": "void"
28258
28263
  }
28259
- }
28264
+ },
28265
+ "description": "Toggles the state of the toggle element.\nIf the element is not disabled, then the checked property is toggled."
28260
28266
  },
28261
28267
  {
28262
28268
  "kind": "method",
28263
- "name": "updateValue",
28269
+ "name": "handleKeyDown",
28264
28270
  "privacy": "private",
28265
- "description": "Updates the value of the textarea field.\nSets the form value.",
28266
28271
  "return": {
28267
28272
  "type": {
28268
- "text": ""
28273
+ "text": "void"
28269
28274
  }
28270
- }
28275
+ },
28276
+ "parameters": [
28277
+ {
28278
+ "name": "event",
28279
+ "type": {
28280
+ "text": "KeyboardEvent"
28281
+ },
28282
+ "description": "The keyboard event."
28283
+ }
28284
+ ],
28285
+ "description": "Handles the keydown event on the toggle element.\nWhen the user presses Enter, the form is submitted."
28271
28286
  },
28272
28287
  {
28273
28288
  "kind": "method",
28274
- "name": "onChange",
28289
+ "name": "handleChange",
28275
28290
  "privacy": "private",
28276
28291
  "parameters": [
28277
28292
  {
28278
28293
  "name": "event",
28279
28294
  "type": {
28280
28295
  "text": "Event"
28281
- },
28282
- "description": "Event which contains information about the value change."
28296
+ }
28283
28297
  }
28284
28298
  ],
28285
- "description": "Handles the change event of the textarea field.\nUpdates the value and sets the validity of the textarea 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"
28286
- },
28287
- {
28288
- "kind": "method",
28289
- "name": "renderCharacterCounter",
28290
- "privacy": "protected"
28299
+ "description": "Toggles the state of the toggle element.\nand dispatch the new change event."
28291
28300
  },
28292
28301
  {
28293
28302
  "kind": "method",
28294
- "name": "renderTextareaFooter",
28295
- "privacy": "protected"
28303
+ "name": "setToggleSize",
28304
+ "privacy": "private",
28305
+ "parameters": [
28306
+ {
28307
+ "name": "size",
28308
+ "type": {
28309
+ "text": "ToggleSize"
28310
+ },
28311
+ "description": "The size to set."
28312
+ }
28313
+ ],
28314
+ "description": "Sets the size attribute for the toggle component.\nIf the provided size is not included in the TOGGLE_SIZE,\nit defaults to the value specified in DEFAULTS.SIZE."
28296
28315
  },
28297
28316
  {
28298
28317
  "kind": "field",
@@ -28572,96 +28591,40 @@
28572
28591
  }
28573
28592
  ],
28574
28593
  "events": [
28575
- {
28576
- "name": "limitexceeded",
28577
- "type": {
28578
- "text": "CustomEvent"
28579
- },
28580
- "description": "(React: onLimitExceeded) This event is dispatched once when the character limit exceeds or restored.",
28581
- "reactName": "onLimitExceeded"
28582
- },
28583
28594
  {
28584
28595
  "type": {
28585
28596
  "text": "EventConstructor"
28586
28597
  }
28587
28598
  },
28588
28599
  {
28589
- "description": "(React: onInput) This event is dispatched when the value of the textarea field changes (every press).",
28590
- "name": "input",
28591
- "reactName": "onInput"
28592
- },
28593
- {
28594
- "description": "(React: onChange) This event is dispatched when the value of the textarea field changes (on blur).",
28600
+ "description": "(React: onChange) Event that gets dispatched when the toggle state changes.",
28595
28601
  "name": "change",
28596
28602
  "reactName": "onChange"
28597
28603
  },
28598
28604
  {
28599
- "description": "(React: onFocus) This event is dispatched when the textarea receives focus.",
28605
+ "description": "(React: onFocus) Event that gets dispatched when the toggle receives focus.",
28600
28606
  "name": "focus",
28601
28607
  "reactName": "onFocus"
28602
- },
28603
- {
28604
- "description": "(React: onBlur) This event is dispatched when the textarea loses focus.",
28605
- "name": "blur",
28606
- "reactName": "onBlur"
28607
28608
  }
28608
28609
  ],
28609
28610
  "attributes": [
28610
28611
  {
28611
- "name": "placeholder",
28612
- "type": {
28613
- "text": "string | undefined"
28614
- },
28615
- "description": "The placeholder text that is displayed when the textarea field is empty.",
28616
- "fieldName": "placeholder"
28617
- },
28618
- {
28619
- "name": "readonly",
28612
+ "name": "checked",
28620
28613
  "type": {
28621
28614
  "text": "boolean"
28622
28615
  },
28623
28616
  "default": "false",
28624
- "description": "readonly attribute of the textarea field. If true, the textarea field is read-only.",
28625
- "fieldName": "readonly"
28626
- },
28627
- {
28628
- "name": "rows",
28629
- "description": "The rows attribute specifies the visible number of lines in a text area.",
28630
- "default": "5",
28631
- "fieldName": "rows"
28632
- },
28633
- {
28634
- "name": "cols",
28635
- "description": "The cols attribute specifies the visible number of lines in a text area.",
28636
- "default": "40",
28637
- "fieldName": "cols"
28638
- },
28639
- {
28640
- "name": "wrap",
28641
- "type": {
28642
- "text": "WrapType"
28643
- },
28644
- "description": "The wrap attribute specifies how the text in a text area is to be wrapped when submitted in a form.",
28645
- "default": "'soft'",
28646
- "fieldName": "wrap"
28647
- },
28648
- {
28649
- "name": "autocapitalize",
28650
- "type": {
28651
- "text": "AutoCapitalizeType"
28652
- },
28653
- "description": "The autocapitalize attribute of the textarea field.",
28654
- "default": "'off'",
28655
- "fieldName": "autocapitalize"
28617
+ "description": "Determines whether the toggle is active or inactive.",
28618
+ "fieldName": "checked"
28656
28619
  },
28657
28620
  {
28658
- "name": "autocomplete",
28621
+ "name": "size",
28659
28622
  "type": {
28660
- "text": "AutoCompleteType"
28623
+ "text": "ToggleSize"
28661
28624
  },
28662
- "description": "The autocomplete attribute of the textarea field.",
28663
- "default": "'off'",
28664
- "fieldName": "autocomplete"
28625
+ "description": "Determines toggle size in rem (height is specified here).\n- **Default**: 1.5\n- **Compact**: 1",
28626
+ "default": "default",
28627
+ "fieldName": "size"
28665
28628
  },
28666
28629
  {
28667
28630
  "name": "autofocus",
@@ -28669,41 +28632,9 @@
28669
28632
  "text": "boolean"
28670
28633
  },
28671
28634
  "default": "false",
28672
- "description": "If true, the textarea field is focused when the component is rendered.",
28635
+ "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)",
28673
28636
  "fieldName": "autofocus"
28674
28637
  },
28675
- {
28676
- "name": "dirname",
28677
- "type": {
28678
- "text": "string | undefined"
28679
- },
28680
- "description": "Specifies the name of the directionality of text for submission purposes (e.g., \"rtl\" for right-to-left).",
28681
- "fieldName": "dirname"
28682
- },
28683
- {
28684
- "name": "maxlength",
28685
- "type": {
28686
- "text": "number | undefined"
28687
- },
28688
- "description": "The maximum number of characters that the textarea field can accept.",
28689
- "fieldName": "maxlength"
28690
- },
28691
- {
28692
- "name": "minlength",
28693
- "type": {
28694
- "text": "number | undefined"
28695
- },
28696
- "description": "The minimum number of characters that the textarea field can accept.",
28697
- "fieldName": "minlength"
28698
- },
28699
- {
28700
- "name": "max-character-limit",
28701
- "type": {
28702
- "text": "number | undefined"
28703
- },
28704
- "description": "maximum character limit for the textarea field for character counter.",
28705
- "fieldName": "maxCharacterLimit"
28706
- },
28707
28638
  {
28708
28639
  "name": "name",
28709
28640
  "type": {
@@ -28845,8 +28776,8 @@
28845
28776
  "name": "FormfieldWrapper",
28846
28777
  "module": "/src/components/formfieldwrapper"
28847
28778
  },
28848
- "tagName": "mdc-textarea",
28849
- "jsDoc": "/**\n * mdc-textarea component, which is used to get the multi-line text input from the user.\n * It contains:\n * - label: It is the title of the textarea field.\n * - required: A boolean attribute depicting that the textarea field is required.\n * - Textarea: It is the multi-line text input field.\n * - helper-text: It is the text that provides additional information about the textarea field.\n * - max-character-limit: It is the text that shows the character count of the textarea field.\n * - Error, Warning, Success, Priority Help Text type: It is the text that provides additional information\n * about the textarea field based on the validation state.\n * - limitexceeded: It is the event that is dispatched when the character limit exceeds or restored.\n * This event exposes 3 properties:\n * - currentCharacterCount - the current number of characters in the textarea field,\n * - maxCharacterLimit - the maximum number of characters allowed in the textarea field,\n * - value - the current value of the textarea field,\n *\n * **Note**: Consumers must set the help-text-type with 'error' and\n * help-text attribute with the error message using limitexceeded event.\n * The same help-text value will be used for the validation message to be displayed.\n *\n * @tagname mdc-textarea\n *\n * @event input - (React: onInput) This event is dispatched when the value of the textarea field changes (every press).\n * @event change - (React: onChange) This event is dispatched when the value of the textarea field changes (on blur).\n * @event focus - (React: onFocus) This event is dispatched when the textarea receives focus.\n * @event blur - (React: onBlur) This event is dispatched when the textarea loses focus.\n * @event limitexceeded - (React: onLimitExceeded) This event is dispatched once when the character limit\n * exceeds or restored.\n *\n *\n * @dependency mdc-icon\n * @dependency mdc-text\n * @dependency mdc-button\n *\n * @cssproperty --mdc-textarea-disabled-border-color - Border color for the textarea container when disabled\n * @cssproperty --mdc-textarea-disabled-text-color - Text color for the textarea field when disabled\n * @cssproperty --mdc-textarea-disabled-background-color - Background color for the textarea field when disabled\n * @cssproperty --mdc-textarea-text-color - Text color for the textarea field\n * @cssproperty --mdc-textarea-background-color - Background color for the textarea field\n * @cssproperty --mdc-textarea-border-color - Border color for the textarea field\n * @cssproperty --mdc-textarea-text-secondary-normal - Text color for the character counter\n * @cssproperty --mdc-textarea-error-border-color - Border color for the error related help text\n * @cssproperty --mdc-textarea-warning-border-color - Border color for the warning related help text\n * @cssproperty --mdc-textarea-success-border-color - Border color for the success related help text\n * @cssproperty --mdc-textarea-primary-border-color - Border color for the priority related help text\n * @cssproperty --mdc-textarea-hover-background-color - Background color for the textarea container when hover\n * @cssproperty --mdc-textarea-focused-background-color - Background color for the textarea container when focused\n * @cssproperty --mdc-textarea-focused-border-color - Border color for the textarea container when focused\n */",
28779
+ "tagName": "mdc-toggle",
28780
+ "jsDoc": "/**\n * Toggle Component is an interactive control used to switch between two mutually exclusive options,\n * such as On/Off, Active/Inactive. These are commonly used in settings panels, forms, and preference selections\n * where users need to enable or disable a feature.\n * It contains an optional label and an optional helper text.\n *\n * To create a group of toggles, use the FormFieldGroup component.\n *\n * Note: It internally renders a checkbox styled as a toggle switch.\n *\n * @dependency mdc-icon\n * @dependency mdc-statictoggle\n *\n * @tagname mdc-toggle\n *\n * @event change - (React: onChange) Event that gets dispatched when the toggle state changes.\n * @event focus - (React: onFocus) Event that gets dispatched when the toggle receives focus.\n *\n * @cssproperty --mdc-toggle-width - Width of the toggle\n * @cssproperty --mdc-toggle-height - Height of the toggle\n * @cssproperty --mdc-toggle-width-compact - Width of the toggle when it's size is compact\n * @cssproperty --mdc-toggle-height-compact - Height of the toggle when it's size is compact\n * @cssproperty --mdc-toggle-label-lineheight - Line height of the toggle label\n * @cssproperty --mdc-toggle-label-fontsize - Font size of the toggle label\n * @cssproperty --mdc-toggle-label-fontweight - Font weight of the toggle label\n * @cssproperty --mdc-toggle-label-color-disabled - Color of the toggle label and help text in disabled state\n * @cssproperty --mdc-toggle-help-text-color - Color of the help text label\n * @cssproperty --mdc-toggle-active-hover-color - Background color of the active toggle in hover state\n * @cssproperty --mdc-toggle-active-pressed-color - Background color of the active toggle in pressed state\n * @cssproperty --mdc-toggle-inactive-hover-color - Background color of the inactive toggle in hover state\n * @cssproperty --mdc-toggle-inactive-pressed-color - Background color of the inactive toggle in pressed state\n */",
28850
28781
  "customElement": true,
28851
28782
  "slots": [
28852
28783
  {
@@ -28865,949 +28796,1171 @@
28865
28796
  "kind": "js",
28866
28797
  "name": "default",
28867
28798
  "declaration": {
28868
- "name": "Textarea",
28869
- "module": "components/textarea/textarea.component.js"
28799
+ "name": "Toggle",
28800
+ "module": "components/toggle/toggle.component.js"
28870
28801
  }
28871
28802
  }
28872
28803
  ]
28873
28804
  },
28874
28805
  {
28875
28806
  "kind": "javascript-module",
28876
- "path": "components/themeprovider/themeprovider.component.js",
28807
+ "path": "components/toggletip/toggletip.component.js",
28877
28808
  "declarations": [
28878
28809
  {
28879
28810
  "kind": "class",
28880
- "description": "ThemeProvider component, which sets the passed in themeclass as class.\nIf the themeclass switches, the existing themeclass will be removed as a class\nand the new themeclass will be added.\n\nCSS variables defined in the themeclass will be used for the styling of child dom nodes.\n\nAvailable Momentum theme classes:\n\n`mds-theme-stable-darkWebex`, `mds-theme-stable-lightWebex`\n\n`mds-theme-stable-darkBronzeWebex`, `mds-theme-stable-lightBronzeWebex`\n\n`mds-theme-stable-darkIndigoWebex`, `mds-theme-stable-lightIndigoWebex`\n\n`mds-theme-stable-darkJadeWebex`, `mds-theme-stable-lightJadeWebex`\n\n`mds-theme-stable-darkLavenderWebex`, `mds-theme-stable-lightLavenderWebex`\n\n`mds-theme-stable-darkRoseWebex`, `mds-theme-stable-lightRoseWebex`\n\nThemeclass context can be be consumed from Lit child components\n(see providerUtils.consume for how to consume)\n\nThemeProvider also includes basic font defaults for text.",
28881
- "name": "ThemeProvider",
28811
+ "description": "A toggletip is triggered by clicking a trigger element.\n\nIt can contain interactive content and can be closed by\nclicking outside the toggletip or pressing the escape key.\n\nIt can have optional close button to close the toggletip.\n\nToggletip component uses `mdc-screenreaderannouncer` internally to\nannounce the toggletip text content with screen readers when the toggletip is shown.\n\n`screenreader-announcer-identity` attribute can be used to provide ID of an element\nin DOM to which announcement elements are added. If not set, a visually hidden\ndiv element is created in DOM to which announcement elements are added.\n\nPlease refer to the `mdc-screenreaderannouncer` component for more details.",
28812
+ "name": "ToggleTip",
28882
28813
  "cssProperties": [
28883
28814
  {
28884
- "description": "Option to override the default color, default: color-theme-text-primary-normal",
28885
- "name": "--mdc-themeprovider-color-default"
28886
- },
28887
- {
28888
- "description": "Option to override the font family, default: `Momentum` (from momentum-design/fonts)",
28889
- "name": "--mdc-themeprovider-font-family"
28815
+ "description": "The maximum width of the toggletip.",
28816
+ "name": "--mdc-toggletip-max-width"
28890
28817
  },
28891
28818
  {
28892
- "description": "Option to override the font weight, default: `400`",
28893
- "name": "--mdc-themeprovider-font-weight"
28819
+ "description": "The text color of the toggletip.",
28820
+ "name": "--mdc-toggletip-text-color"
28894
28821
  },
28895
28822
  {
28896
- "description": "Option to override the default letter-spacing, default: `-0.25px` (this is to match the old CiscoSans)",
28897
- "name": "--mdc-themeprovider-letter-spacing-adjustment"
28823
+ "description": "The text color of the toggletip when the color is contrast.",
28824
+ "name": "--mdc-toggletip-text-color-contrast"
28898
28825
  },
28899
28826
  {
28900
- "description": "Option to override the font feature settings, default: `\"ss02\" on`",
28901
- "name": "--mdc-themeprovider-font-feature-settings"
28827
+ "description": "radius of the arrow border",
28828
+ "name": "--mdc-popover-arrow-border-radius",
28829
+ "inheritedFrom": {
28830
+ "name": "Popover",
28831
+ "module": "src/components/popover/popover.component.ts"
28832
+ }
28902
28833
  },
28903
28834
  {
28904
- "description": "Option to override the color of the scrollbar track.",
28905
- "name": "--mdc-themeprovider-scrollbar-track-color"
28835
+ "description": "border of the arrow",
28836
+ "name": "--mdc-popover-arrow-border",
28837
+ "inheritedFrom": {
28838
+ "name": "Popover",
28839
+ "module": "src/components/popover/popover.component.ts"
28840
+ }
28906
28841
  },
28907
28842
  {
28908
- "description": "Option to override the color of the scrollbar thumb.",
28909
- "name": "--mdc-themeprovider-scrollbar-thumb-color"
28843
+ "description": "primary background color of the popover",
28844
+ "name": "--mdc-popover-primary-background-color",
28845
+ "inheritedFrom": {
28846
+ "name": "Popover",
28847
+ "module": "src/components/popover/popover.component.ts"
28848
+ }
28910
28849
  },
28911
28850
  {
28912
- "description": "Option to override the color of the scrollbar thumb on hover. Applicable only on webkit browsers.",
28913
- "name": "--mdc-themeprovider-scrollbar-thumb-hover-color"
28851
+ "description": "border color of the popover",
28852
+ "name": "--mdc-popover-border-color",
28853
+ "inheritedFrom": {
28854
+ "name": "Popover",
28855
+ "module": "src/components/popover/popover.component.ts"
28856
+ }
28914
28857
  },
28915
28858
  {
28916
- "description": "Option to override the color of the scrollbar thumb on press. Applicable only on webkit browsers.",
28917
- "name": "--mdc-themeprovider-scrollbar-thumb-active-color"
28859
+ "description": "inverted background color of the popover",
28860
+ "name": "--mdc-popover-inverted-background-color",
28861
+ "inheritedFrom": {
28862
+ "name": "Popover",
28863
+ "module": "src/components/popover/popover.component.ts"
28864
+ }
28865
+ },
28866
+ {
28867
+ "description": "inverted border color of the popover",
28868
+ "name": "--mdc-popover-inverted-border-color",
28869
+ "inheritedFrom": {
28870
+ "name": "Popover",
28871
+ "module": "src/components/popover/popover.component.ts"
28872
+ }
28873
+ },
28874
+ {
28875
+ "description": "inverted text color of the popover",
28876
+ "name": "--mdc-popover-inverted-text-color",
28877
+ "inheritedFrom": {
28878
+ "name": "Popover",
28879
+ "module": "src/components/popover/popover.component.ts"
28880
+ }
28881
+ },
28882
+ {
28883
+ "description": "elevation of the popover",
28884
+ "name": "--mdc-popover-elevation-3",
28885
+ "inheritedFrom": {
28886
+ "name": "Popover",
28887
+ "module": "src/components/popover/popover.component.ts"
28888
+ }
28889
+ },
28890
+ {
28891
+ "description": "max width of the popover",
28892
+ "name": "--mdc-popover-max-width",
28893
+ "inheritedFrom": {
28894
+ "name": "Popover",
28895
+ "module": "src/components/popover/popover.component.ts"
28896
+ }
28897
+ },
28898
+ {
28899
+ "description": "max height of the popover",
28900
+ "name": "--mdc-popover-max-height",
28901
+ "inheritedFrom": {
28902
+ "name": "Popover",
28903
+ "module": "src/components/popover/popover.component.ts"
28904
+ }
28918
28905
  }
28919
28906
  ],
28920
28907
  "slots": [
28921
28908
  {
28922
- "description": "children",
28923
- "name": ""
28909
+ "description": "Default slot for the toggletip content",
28910
+ "name": "",
28911
+ "inheritedFrom": {
28912
+ "name": "Popover",
28913
+ "module": "src/components/popover/popover.component.ts"
28914
+ }
28924
28915
  }
28925
28916
  ],
28926
28917
  "members": [
28927
28918
  {
28928
28919
  "kind": "field",
28929
- "name": "Context",
28930
- "privacy": "public",
28931
- "static": true,
28932
- "description": "Context object of the ThemeProvider, to be consumed by child components",
28933
- "readonly": true
28920
+ "name": "defaultSlotNodes",
28921
+ "type": {
28922
+ "text": "Array<Node>"
28923
+ },
28924
+ "privacy": "private"
28934
28925
  },
28935
28926
  {
28936
28927
  "kind": "field",
28937
- "name": "themeclass",
28928
+ "name": "screenreaderAnnouncerIdentity",
28938
28929
  "type": {
28939
28930
  "text": "string"
28940
28931
  },
28941
- "description": "Current theme class\n\nHas to be fully qualified, such that\nthe theme class matches the class of the respective\ntheme stylesheet\n\nDefault: 'mds-theme-stable-darkWebex'",
28942
- "attribute": "themeclass"
28932
+ "default": "''",
28933
+ "description": "Set this attribute with the id of the element in the DOM, to which announcement\nelements will be appended.\nIf an id is provided, the announcement elements will be appended to this element.\nIf id is not provided, a visually hidden div element will be created in the DOM.\n\nPlease refer to the `mdc-screenreaderannouncer` component for more details.",
28934
+ "attribute": "screenreader-announcer-identity",
28935
+ "reflects": true
28943
28936
  },
28944
28937
  {
28945
28938
  "kind": "method",
28946
- "name": "updateContext",
28947
- "privacy": "protected",
28939
+ "name": "getToggleTipText",
28940
+ "privacy": "private",
28948
28941
  "return": {
28949
28942
  "type": {
28950
- "text": "void"
28943
+ "text": ""
28951
28944
  }
28952
- },
28953
- "description": "Update all observing components of this\nprovider to update the themeclass\n\nIs called on every re-render, see Provider class"
28945
+ }
28954
28946
  },
28955
28947
  {
28956
28948
  "kind": "method",
28957
- "name": "setThemeInClassList",
28949
+ "name": "onPlacementUpdated",
28958
28950
  "privacy": "private",
28959
- "description": "Function to update the active theme classnames to update the theme tokens\nas CSS variables on the web component."
28960
- }
28961
- ],
28962
- "attributes": [
28963
- {
28964
- "name": "themeclass",
28965
- "type": {
28966
- "text": "string"
28951
+ "return": {
28952
+ "type": {
28953
+ "text": "void"
28954
+ }
28967
28955
  },
28968
- "description": "Current theme class\n\nHas to be fully qualified, such that\nthe theme class matches the class of the respective\ntheme stylesheet\n\nDefault: 'mds-theme-stable-darkWebex'",
28969
- "fieldName": "themeclass"
28970
- }
28971
- ],
28972
- "superclass": {
28973
- "name": "Provider",
28974
- "module": "/src/models"
28975
- },
28976
- "tagName": "mdc-themeprovider",
28977
- "jsDoc": "/**\n * ThemeProvider component, which sets the passed in themeclass as class.\n * If the themeclass switches, the existing themeclass will be removed as a class\n * and the new themeclass will be added.\n *\n * CSS variables defined in the themeclass will be used for the styling of child dom nodes.\n *\n * Available Momentum theme classes:\n *\n * `mds-theme-stable-darkWebex`, `mds-theme-stable-lightWebex`\n *\n * `mds-theme-stable-darkBronzeWebex`, `mds-theme-stable-lightBronzeWebex`\n *\n * `mds-theme-stable-darkIndigoWebex`, `mds-theme-stable-lightIndigoWebex`\n *\n * `mds-theme-stable-darkJadeWebex`, `mds-theme-stable-lightJadeWebex`\n *\n * `mds-theme-stable-darkLavenderWebex`, `mds-theme-stable-lightLavenderWebex`\n *\n * `mds-theme-stable-darkRoseWebex`, `mds-theme-stable-lightRoseWebex`\n *\n * Themeclass context can be be consumed from Lit child components\n * (see providerUtils.consume for how to consume)\n *\n * ThemeProvider also includes basic font defaults for text.\n *\n * @tagname mdc-themeprovider\n *\n * @slot - children\n *\n * @cssproperty --mdc-themeprovider-color-default - Option to override the default color,\n * default: color-theme-text-primary-normal\n * @cssproperty --mdc-themeprovider-font-family - Option to override the font family,\n * default: `Momentum` (from momentum-design/fonts)\n * @cssproperty --mdc-themeprovider-font-weight - Option to override the font weight, default: `400`\n * @cssproperty --mdc-themeprovider-letter-spacing-adjustment - Option to override the default letter-spacing,\n * default: `-0.25px` (this is to match the old CiscoSans)\n * @cssproperty --mdc-themeprovider-font-feature-settings - Option to override the font feature settings,\n * default: `\"ss02\" on`\n * @cssproperty --mdc-themeprovider-scrollbar-track-color - Option to override the color of the scrollbar track.\n * @cssproperty --mdc-themeprovider-scrollbar-thumb-color - Option to override the color of the scrollbar thumb.\n * @cssproperty --mdc-themeprovider-scrollbar-thumb-hover-color - Option to override the color of the\n * scrollbar thumb on hover. Applicable only on webkit browsers.\n * @cssproperty --mdc-themeprovider-scrollbar-thumb-active-color - Option to override the color of the\n * scrollbar thumb on press. Applicable only on webkit browsers.\n */",
28978
- "customElement": true
28979
- }
28980
- ],
28981
- "exports": [
28982
- {
28983
- "kind": "js",
28984
- "name": "default",
28985
- "declaration": {
28986
- "name": "ThemeProvider",
28987
- "module": "components/themeprovider/themeprovider.component.js"
28988
- }
28989
- }
28990
- ]
28991
- },
28992
- {
28993
- "kind": "javascript-module",
28994
- "path": "components/toggle/toggle.component.js",
28995
- "declarations": [
28996
- {
28997
- "kind": "class",
28998
- "description": "Toggle Component is an interactive control used to switch between two mutually exclusive options,\nsuch as On/Off, Active/Inactive. These are commonly used in settings panels, forms, and preference selections\nwhere users need to enable or disable a feature.\nIt contains an optional label and an optional helper text.\n\nTo create a group of toggles, use the FormFieldGroup component.\n\nNote: It internally renders a checkbox styled as a toggle switch.",
28999
- "name": "Toggle",
29000
- "cssProperties": [
29001
- {
29002
- "description": "Width of the toggle",
29003
- "name": "--mdc-toggle-width"
29004
- },
29005
- {
29006
- "description": "Height of the toggle",
29007
- "name": "--mdc-toggle-height"
29008
- },
29009
- {
29010
- "description": "Width of the toggle when it's size is compact",
29011
- "name": "--mdc-toggle-width-compact"
29012
- },
29013
- {
29014
- "description": "Height of the toggle when it's size is compact",
29015
- "name": "--mdc-toggle-height-compact"
29016
- },
29017
- {
29018
- "description": "Line height of the toggle label",
29019
- "name": "--mdc-toggle-label-lineheight"
29020
- },
29021
- {
29022
- "description": "Font size of the toggle label",
29023
- "name": "--mdc-toggle-label-fontsize"
29024
- },
29025
- {
29026
- "description": "Font weight of the toggle label",
29027
- "name": "--mdc-toggle-label-fontweight"
28956
+ "description": "Updates the placement attribute if it is not a valid placement.\nDefault placement for toggle tip is top."
29028
28957
  },
29029
28958
  {
29030
- "description": "Color of the toggle label and help text in disabled state",
29031
- "name": "--mdc-toggle-label-color-disabled"
28959
+ "kind": "field",
28960
+ "name": "enabledFocusTrap",
28961
+ "type": {
28962
+ "text": "boolean"
28963
+ },
28964
+ "default": "false",
28965
+ "description": "Determines whether the focus trap is enabled.\nIf true, focus will be restricted to the content within this component.",
28966
+ "attribute": "enabledFocusTrap",
28967
+ "inheritedFrom": {
28968
+ "name": "Popover",
28969
+ "module": "components/popover/popover.component.js"
28970
+ }
29032
28971
  },
29033
28972
  {
29034
- "description": "Color of the help text label",
29035
- "name": "--mdc-toggle-help-text-color"
28973
+ "kind": "field",
28974
+ "name": "enabledPreventScroll",
28975
+ "type": {
28976
+ "text": "boolean"
28977
+ },
28978
+ "default": "false",
28979
+ "description": "Prevent outside scrolling when element is shown.",
28980
+ "attribute": "enabledPreventScroll",
28981
+ "inheritedFrom": {
28982
+ "name": "Popover",
28983
+ "module": "components/popover/popover.component.js"
28984
+ }
29036
28985
  },
29037
28986
  {
29038
- "description": "Background color of the active toggle in hover state",
29039
- "name": "--mdc-toggle-active-hover-color"
28987
+ "kind": "field",
28988
+ "name": "shouldWrapFocus",
28989
+ "type": {
28990
+ "text": "() => boolean"
28991
+ },
28992
+ "inheritedFrom": {
28993
+ "name": "Popover",
28994
+ "module": "components/popover/popover.component.js"
28995
+ }
29040
28996
  },
29041
28997
  {
29042
- "description": "Background color of the active toggle in pressed state",
29043
- "name": "--mdc-toggle-active-pressed-color"
28998
+ "kind": "method",
28999
+ "name": "deactivateFocusTrap",
29000
+ "privacy": "public",
29001
+ "description": "Deactivate the focus trap.",
29002
+ "inheritedFrom": {
29003
+ "name": "Popover",
29004
+ "module": "components/popover/popover.component.js"
29005
+ }
29044
29006
  },
29045
29007
  {
29046
- "description": "Background color of the inactive toggle in hover state",
29047
- "name": "--mdc-toggle-inactive-hover-color"
29008
+ "kind": "method",
29009
+ "name": "hasNoClientRects",
29010
+ "privacy": "private",
29011
+ "parameters": [
29012
+ {
29013
+ "name": "element",
29014
+ "type": {
29015
+ "text": "HTMLElement"
29016
+ },
29017
+ "description": "The element to check."
29018
+ }
29019
+ ],
29020
+ "description": "Checks if the element has no client rectangles (not visible in the viewport).",
29021
+ "return": {
29022
+ "type": {
29023
+ "text": ""
29024
+ }
29025
+ },
29026
+ "inheritedFrom": {
29027
+ "name": "Popover",
29028
+ "module": "components/popover/popover.component.js"
29029
+ }
29048
29030
  },
29049
29031
  {
29050
- "description": "Background color of the inactive toggle in pressed state",
29051
- "name": "--mdc-toggle-inactive-pressed-color"
29052
- }
29053
- ],
29054
- "members": [
29055
- {
29056
- "kind": "field",
29057
- "name": "checked",
29058
- "type": {
29059
- "text": "boolean"
29032
+ "kind": "method",
29033
+ "name": "hasZeroDimensions",
29034
+ "privacy": "private",
29035
+ "parameters": [
29036
+ {
29037
+ "name": "element",
29038
+ "type": {
29039
+ "text": "HTMLElement"
29040
+ },
29041
+ "description": "The element to check."
29042
+ }
29043
+ ],
29044
+ "description": "Checks if the element has zero dimensions (width and height are both 0).",
29045
+ "return": {
29046
+ "type": {
29047
+ "text": ""
29048
+ }
29060
29049
  },
29061
- "default": "false",
29062
- "description": "Determines whether the toggle is active or inactive.",
29063
- "attribute": "checked",
29064
- "reflects": true
29050
+ "inheritedFrom": {
29051
+ "name": "Popover",
29052
+ "module": "components/popover/popover.component.js"
29053
+ }
29065
29054
  },
29066
29055
  {
29067
- "kind": "field",
29068
- "name": "size",
29069
- "type": {
29070
- "text": "ToggleSize"
29071
- },
29072
- "description": "Determines toggle size in rem (height is specified here).\n- **Default**: 1.5\n- **Compact**: 1",
29073
- "default": "default",
29074
- "attribute": "size",
29075
- "reflects": true
29056
+ "kind": "method",
29057
+ "name": "isNotVisible",
29058
+ "privacy": "private",
29059
+ "parameters": [
29060
+ {
29061
+ "name": "element",
29062
+ "type": {
29063
+ "text": "HTMLElement"
29064
+ },
29065
+ "description": "The element to check."
29066
+ }
29067
+ ],
29068
+ "description": "Determines if the element is not visible in the DOM.",
29069
+ "return": {
29070
+ "type": {
29071
+ "text": ""
29072
+ }
29073
+ },
29074
+ "inheritedFrom": {
29075
+ "name": "Popover",
29076
+ "module": "components/popover/popover.component.js"
29077
+ }
29076
29078
  },
29077
29079
  {
29078
- "kind": "field",
29079
- "name": "autofocus",
29080
- "type": {
29081
- "text": "boolean"
29080
+ "kind": "method",
29081
+ "name": "hasHiddenStyle",
29082
+ "privacy": "private",
29083
+ "parameters": [
29084
+ {
29085
+ "name": "element",
29086
+ "type": {
29087
+ "text": "HTMLElement"
29088
+ },
29089
+ "description": "The element to check."
29090
+ }
29091
+ ],
29092
+ "description": "Checks if the element has inline styles that make it hidden.",
29093
+ "return": {
29094
+ "type": {
29095
+ "text": ""
29096
+ }
29082
29097
  },
29083
- "default": "false",
29084
- "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)",
29085
- "attribute": "autofocus",
29086
- "reflects": true
29098
+ "inheritedFrom": {
29099
+ "name": "Popover",
29100
+ "module": "components/popover/popover.component.js"
29101
+ }
29087
29102
  },
29088
29103
  {
29089
29104
  "kind": "method",
29090
- "name": "manageRequired",
29105
+ "name": "hasComputedHidden",
29091
29106
  "privacy": "private",
29092
- "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.\nIf the validationMessage is set, it will be used as the custom validity message.\nIf the validationMessage is not set, it will clear the custom validity message."
29107
+ "parameters": [
29108
+ {
29109
+ "name": "element",
29110
+ "type": {
29111
+ "text": "HTMLElement"
29112
+ },
29113
+ "description": "The element to check."
29114
+ }
29115
+ ],
29116
+ "description": "Checks if the element is hidden by a computed style.",
29117
+ "return": {
29118
+ "type": {
29119
+ "text": ""
29120
+ }
29121
+ },
29122
+ "inheritedFrom": {
29123
+ "name": "Popover",
29124
+ "module": "components/popover/popover.component.js"
29125
+ }
29093
29126
  },
29094
29127
  {
29095
29128
  "kind": "method",
29096
- "name": "setFormValue",
29129
+ "name": "isHidden",
29097
29130
  "privacy": "private",
29098
- "description": "Updates the form value to reflect the current state of the toggle.\nIf toggle is switched on, the value is set to either the user-provided value or 'isActive' if no value is provided.\nIf toggle is switched off, the value is set to null."
29131
+ "parameters": [
29132
+ {
29133
+ "name": "element",
29134
+ "type": {
29135
+ "text": "HTMLElement"
29136
+ },
29137
+ "description": "The element to check."
29138
+ }
29139
+ ],
29140
+ "description": "Checks if the element is hidden from the user.",
29141
+ "return": {
29142
+ "type": {
29143
+ "text": ""
29144
+ }
29145
+ },
29146
+ "inheritedFrom": {
29147
+ "name": "Popover",
29148
+ "module": "components/popover/popover.component.js"
29149
+ }
29099
29150
  },
29100
29151
  {
29101
29152
  "kind": "method",
29102
- "name": "toggleState",
29153
+ "name": "isNotTabbable",
29103
29154
  "privacy": "private",
29155
+ "parameters": [
29156
+ {
29157
+ "name": "element",
29158
+ "type": {
29159
+ "text": "HTMLElement"
29160
+ },
29161
+ "description": "The element to check."
29162
+ }
29163
+ ],
29164
+ "description": "Checks if the element is not tabbable.",
29104
29165
  "return": {
29105
29166
  "type": {
29106
- "text": "void"
29167
+ "text": ""
29107
29168
  }
29108
29169
  },
29109
- "description": "Toggles the state of the toggle element.\nIf the element is not disabled, then the checked property is toggled."
29170
+ "inheritedFrom": {
29171
+ "name": "Popover",
29172
+ "module": "components/popover/popover.component.js"
29173
+ }
29110
29174
  },
29111
29175
  {
29112
29176
  "kind": "method",
29113
- "name": "handleKeyDown",
29177
+ "name": "isInteractiveElement",
29114
29178
  "privacy": "private",
29115
29179
  "return": {
29116
29180
  "type": {
29117
- "text": "void"
29181
+ "text": ""
29118
29182
  }
29119
29183
  },
29120
29184
  "parameters": [
29121
29185
  {
29122
- "name": "event",
29186
+ "name": "element",
29123
29187
  "type": {
29124
- "text": "KeyboardEvent"
29188
+ "text": "HTMLElement"
29125
29189
  },
29126
- "description": "The keyboard event."
29190
+ "description": "The element to check."
29127
29191
  }
29128
29192
  ],
29129
- "description": "Handles the keydown event on the toggle element.\nWhen the user presses Enter, the form is submitted."
29193
+ "description": "Checks if the element is interactive.",
29194
+ "inheritedFrom": {
29195
+ "name": "Popover",
29196
+ "module": "components/popover/popover.component.js"
29197
+ }
29130
29198
  },
29131
29199
  {
29132
29200
  "kind": "method",
29133
- "name": "handleChange",
29201
+ "name": "isFocusable",
29134
29202
  "privacy": "private",
29135
29203
  "parameters": [
29136
29204
  {
29137
- "name": "event",
29205
+ "name": "element",
29138
29206
  "type": {
29139
- "text": "Event"
29140
- }
29207
+ "text": "HTMLElement"
29208
+ },
29209
+ "description": "The element to check."
29141
29210
  }
29142
29211
  ],
29143
- "description": "Toggles the state of the toggle element.\nand dispatch the new change event."
29212
+ "description": "Checks if the element is focusable.",
29213
+ "return": {
29214
+ "type": {
29215
+ "text": ""
29216
+ }
29217
+ },
29218
+ "inheritedFrom": {
29219
+ "name": "Popover",
29220
+ "module": "components/popover/popover.component.js"
29221
+ }
29144
29222
  },
29145
29223
  {
29146
29224
  "kind": "method",
29147
- "name": "setToggleSize",
29225
+ "name": "findFocusable",
29148
29226
  "privacy": "private",
29227
+ "return": {
29228
+ "type": {
29229
+ "text": ""
29230
+ }
29231
+ },
29149
29232
  "parameters": [
29150
29233
  {
29151
- "name": "size",
29234
+ "name": "root",
29152
29235
  "type": {
29153
- "text": "ToggleSize"
29236
+ "text": "ShadowRoot | HTMLElement"
29154
29237
  },
29155
- "description": "The size to set."
29238
+ "description": "The root element to search for focusable elements."
29239
+ },
29240
+ {
29241
+ "name": "matches",
29242
+ "default": "new Set()",
29243
+ "type": {
29244
+ "text": "Set<HTMLElement>"
29245
+ },
29246
+ "description": "The set of focusable elements."
29156
29247
  }
29157
29248
  ],
29158
- "description": "Sets the size attribute for the toggle component.\nIf the provided size is not included in the TOGGLE_SIZE,\nit defaults to the value specified in DEFAULTS.SIZE."
29159
- },
29160
- {
29161
- "kind": "field",
29162
- "name": "name",
29163
- "type": {
29164
- "text": "string"
29165
- },
29166
- "default": "''",
29167
- "description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
29168
- "attribute": "name",
29169
- "reflects": true,
29249
+ "description": "Recursively finds all focusable elements within the given root and its descendants.",
29170
29250
  "inheritedFrom": {
29171
- "name": "FormInternalsMixin",
29172
- "module": "utils/mixins/FormInternalsMixin.js"
29251
+ "name": "Popover",
29252
+ "module": "components/popover/popover.component.js"
29173
29253
  }
29174
29254
  },
29175
29255
  {
29176
- "kind": "field",
29177
- "name": "value",
29178
- "type": {
29179
- "text": "string"
29180
- },
29181
- "default": "''",
29182
- "description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
29183
- "attribute": "value",
29184
- "reflects": true,
29256
+ "kind": "method",
29257
+ "name": "setFocusableElements",
29258
+ "privacy": "public",
29259
+ "description": "Updates the list of focusable elements within the component's shadow root.",
29185
29260
  "inheritedFrom": {
29186
- "name": "FormInternalsMixin",
29187
- "module": "utils/mixins/FormInternalsMixin.js"
29261
+ "name": "Popover",
29262
+ "module": "components/popover/popover.component.js"
29188
29263
  }
29189
29264
  },
29190
29265
  {
29191
- "kind": "field",
29192
- "name": "validationMessage",
29193
- "type": {
29194
- "text": "string | undefined"
29195
- },
29196
- "description": "Custom validation message that will override the default message and displayed when the input is invalid.",
29197
- "attribute": "validation-message",
29198
- "reflects": true,
29266
+ "kind": "method",
29267
+ "name": "setInitialFocus",
29268
+ "privacy": "public",
29269
+ "parameters": [
29270
+ {
29271
+ "name": "prefferableElement",
29272
+ "default": "0",
29273
+ "type": {
29274
+ "text": "number"
29275
+ },
29276
+ "description": "The index of the preferable element to focus."
29277
+ }
29278
+ ],
29279
+ "description": "Sets the initial focus within the container.",
29199
29280
  "inheritedFrom": {
29200
- "name": "FormInternalsMixin",
29201
- "module": "utils/mixins/FormInternalsMixin.js"
29281
+ "name": "Popover",
29282
+ "module": "components/popover/popover.component.js"
29202
29283
  }
29203
29284
  },
29204
29285
  {
29205
- "kind": "field",
29206
- "name": "validity",
29207
- "type": {
29208
- "text": "ValidityState"
29286
+ "kind": "method",
29287
+ "name": "calculateNextIndex",
29288
+ "privacy": "private",
29289
+ "parameters": [
29290
+ {
29291
+ "name": "currentIndex",
29292
+ "type": {
29293
+ "text": "number"
29294
+ },
29295
+ "description": "The current index."
29296
+ },
29297
+ {
29298
+ "name": "step",
29299
+ "type": {
29300
+ "text": "number"
29301
+ },
29302
+ "description": "The step to calculate the next index."
29303
+ }
29304
+ ],
29305
+ "description": "Calculates the next index for the focus trap.",
29306
+ "return": {
29307
+ "type": {
29308
+ "text": ""
29309
+ }
29209
29310
  },
29210
- "readonly": true,
29211
- "inheritedFrom": {
29212
- "name": "FormInternalsMixin",
29213
- "module": "utils/mixins/FormInternalsMixin.js"
29214
- }
29215
- },
29216
- {
29217
- "kind": "field",
29218
- "name": "willValidate",
29219
- "readonly": true,
29220
29311
  "inheritedFrom": {
29221
- "name": "FormInternalsMixin",
29222
- "module": "utils/mixins/FormInternalsMixin.js"
29312
+ "name": "Popover",
29313
+ "module": "components/popover/popover.component.js"
29223
29314
  }
29224
29315
  },
29225
29316
  {
29226
29317
  "kind": "method",
29227
- "name": "setValidity",
29228
- "description": "Sets the validity of the input field based on the input field's validity.",
29318
+ "name": "getDeepActiveElement",
29319
+ "privacy": "private",
29320
+ "description": "Returns the deepest active element in the shadow DOM.",
29229
29321
  "return": {
29230
29322
  "type": {
29231
29323
  "text": ""
29232
29324
  }
29233
29325
  },
29234
29326
  "inheritedFrom": {
29235
- "name": "FormInternalsMixin",
29236
- "module": "utils/mixins/FormInternalsMixin.js"
29327
+ "name": "Popover",
29328
+ "module": "components/popover/popover.component.js"
29237
29329
  }
29238
29330
  },
29239
29331
  {
29240
29332
  "kind": "method",
29241
- "name": "checkValidity",
29333
+ "name": "findElement",
29334
+ "privacy": "private",
29335
+ "parameters": [
29336
+ {
29337
+ "name": "activeElement",
29338
+ "type": {
29339
+ "text": "HTMLElement"
29340
+ },
29341
+ "description": "The active element."
29342
+ }
29343
+ ],
29344
+ "description": "Finds the index of the active element within the focusable elements.",
29242
29345
  "return": {
29243
29346
  "type": {
29244
- "text": "boolean"
29347
+ "text": ""
29245
29348
  }
29246
29349
  },
29247
29350
  "inheritedFrom": {
29248
- "name": "FormInternalsMixin",
29249
- "module": "utils/mixins/FormInternalsMixin.js"
29351
+ "name": "Popover",
29352
+ "module": "components/popover/popover.component.js"
29250
29353
  }
29251
29354
  },
29252
29355
  {
29253
29356
  "kind": "method",
29254
- "name": "reportValidity",
29255
- "inheritedFrom": {
29256
- "name": "FormInternalsMixin",
29257
- "module": "utils/mixins/FormInternalsMixin.js"
29258
- }
29259
- },
29260
- {
29261
- "kind": "field",
29262
- "name": "dataAriaLabel",
29263
- "type": {
29264
- "text": "string | null"
29357
+ "name": "isEqualFocusNode",
29358
+ "privacy": "private",
29359
+ "parameters": [
29360
+ {
29361
+ "name": "activeElement",
29362
+ "type": {
29363
+ "text": "HTMLElement"
29364
+ },
29365
+ "description": "The active element."
29366
+ },
29367
+ {
29368
+ "name": "element",
29369
+ "type": {
29370
+ "text": "HTMLElement"
29371
+ },
29372
+ "description": "The element to compare."
29373
+ }
29374
+ ],
29375
+ "description": "Checks if the active element is equal to the given element.",
29376
+ "return": {
29377
+ "type": {
29378
+ "text": ""
29379
+ }
29265
29380
  },
29266
- "default": "null",
29267
- "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
29268
- "attribute": "data-aria-label",
29269
- "reflects": true,
29270
29381
  "inheritedFrom": {
29271
- "name": "DataAriaLabelMixin",
29272
- "module": "utils/mixins/DataAriaLabelMixin.js"
29382
+ "name": "Popover",
29383
+ "module": "components/popover/popover.component.js"
29273
29384
  }
29274
29385
  },
29275
29386
  {
29276
- "kind": "field",
29277
- "name": "disabled",
29278
- "type": {
29279
- "text": "boolean | undefined"
29280
- },
29281
- "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
29282
- "default": "undefined",
29283
- "attribute": "disabled",
29284
- "reflects": true,
29387
+ "kind": "method",
29388
+ "name": "trapFocus",
29389
+ "privacy": "private",
29390
+ "parameters": [
29391
+ {
29392
+ "name": "direction",
29393
+ "type": {
29394
+ "text": "boolean"
29395
+ },
29396
+ "description": "The direction of the focus trap.\nIf true, the focus will be trapped in the previous element."
29397
+ }
29398
+ ],
29399
+ "description": "Traps focus within the container.",
29285
29400
  "inheritedFrom": {
29286
- "name": "FormfieldWrapper",
29287
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
29401
+ "name": "Popover",
29402
+ "module": "components/popover/popover.component.js"
29288
29403
  }
29289
29404
  },
29290
29405
  {
29291
- "kind": "field",
29292
- "name": "label",
29293
- "type": {
29294
- "text": "string | undefined"
29295
- },
29296
- "description": "The label of the input field. It is linked to the input field using the `for` attribute.",
29297
- "attribute": "label",
29298
- "reflects": true,
29406
+ "kind": "method",
29407
+ "name": "handleKeydown",
29408
+ "privacy": "private",
29409
+ "parameters": [
29410
+ {
29411
+ "name": "event",
29412
+ "type": {
29413
+ "text": "KeyboardEvent"
29414
+ },
29415
+ "description": "The keyboard event."
29416
+ }
29417
+ ],
29418
+ "description": "Traps focus within the container.",
29299
29419
  "inheritedFrom": {
29300
- "name": "FormfieldWrapper",
29301
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
29420
+ "name": "Popover",
29421
+ "module": "components/popover/popover.component.js"
29302
29422
  }
29303
29423
  },
29304
29424
  {
29305
29425
  "kind": "field",
29306
- "name": "required",
29426
+ "name": "id",
29307
29427
  "type": {
29308
- "text": "boolean"
29428
+ "text": "string"
29309
29429
  },
29310
- "default": "false",
29311
- "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
29312
- "attribute": "required",
29430
+ "default": "''",
29431
+ "description": "The unique ID of the popover.",
29432
+ "attribute": "id",
29313
29433
  "reflects": true,
29314
29434
  "inheritedFrom": {
29315
- "name": "FormfieldWrapper",
29316
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
29435
+ "name": "Popover",
29436
+ "module": "components/popover/popover.component.js"
29317
29437
  }
29318
29438
  },
29319
29439
  {
29320
29440
  "kind": "field",
29321
- "name": "id",
29441
+ "name": "triggerID",
29322
29442
  "type": {
29323
29443
  "text": "string"
29324
29444
  },
29325
29445
  "default": "''",
29326
- "description": "The unique id of the input field. It is used to link the input field with the label.",
29327
- "attribute": "id",
29446
+ "description": "The ID of the element that triggers the popover.\nThis attribute is required for the popover to work.",
29447
+ "attribute": "triggerID",
29448
+ "reflects": true,
29328
29449
  "inheritedFrom": {
29329
- "name": "FormfieldWrapper",
29330
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
29450
+ "name": "Popover",
29451
+ "module": "components/popover/popover.component.js"
29331
29452
  }
29332
29453
  },
29333
29454
  {
29334
29455
  "kind": "field",
29335
- "name": "helpTextType",
29456
+ "name": "trigger",
29336
29457
  "type": {
29337
- "text": "ValidationType"
29458
+ "text": "PopoverTrigger"
29338
29459
  },
29339
- "description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
29340
- "attribute": "help-text-type",
29460
+ "description": "Determines the events that cause the Popover to show.\nMultiple event names should be separated by spaces.\nFor example to allow both click and hover, use 'click mouseenter' as the trigger.\n- **click**\n- **mouseenter**\n- **focusin**\n- **manual**",
29461
+ "default": "click",
29462
+ "attribute": "trigger",
29341
29463
  "reflects": true,
29342
29464
  "inheritedFrom": {
29343
- "name": "FormfieldWrapper",
29344
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
29465
+ "name": "Popover",
29466
+ "module": "components/popover/popover.component.js"
29345
29467
  }
29346
29468
  },
29347
29469
  {
29348
29470
  "kind": "field",
29349
- "name": "helpText",
29471
+ "name": "placement",
29350
29472
  "type": {
29351
- "text": "string | undefined"
29473
+ "text": "PopoverPlacement"
29352
29474
  },
29353
- "description": "The help text that is displayed below the input field.",
29354
- "attribute": "help-text",
29475
+ "description": "The placement of the popover.\n- **top**\n- **top-start**\n- **top-end**\n- **bottom**\n- **bottom-start**\n- **bottom-end**\n- **left**\n- **left-start**\n- **left-end**\n- **right**\n- **right-start**\n- **right-end**",
29476
+ "default": "bottom",
29477
+ "attribute": "placement",
29355
29478
  "reflects": true,
29356
29479
  "inheritedFrom": {
29357
- "name": "FormfieldWrapper",
29358
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
29359
- }
29360
- },
29361
- {
29362
- "kind": "method",
29363
- "name": "renderLabelElement",
29364
- "privacy": "protected",
29365
- "description": "creates the label element when the label property is set.\nid is used to link the label with the input field.",
29366
- "return": {
29367
- "type": {
29368
- "text": ""
29369
- }
29370
- },
29371
- "inheritedFrom": {
29372
- "name": "FormfieldWrapper",
29373
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
29374
- }
29375
- },
29376
- {
29377
- "kind": "method",
29378
- "name": "renderHelpTextIcon",
29379
- "privacy": "protected",
29380
- "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.",
29381
- "return": {
29382
- "type": {
29383
- "text": ""
29384
- }
29385
- },
29386
- "inheritedFrom": {
29387
- "name": "FormfieldWrapper",
29388
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
29389
- }
29390
- },
29391
- {
29392
- "kind": "method",
29393
- "name": "renderHelpText",
29394
- "privacy": "protected",
29395
- "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.",
29396
- "return": {
29397
- "type": {
29398
- "text": ""
29399
- }
29400
- },
29401
- "inheritedFrom": {
29402
- "name": "FormfieldWrapper",
29403
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
29404
- }
29405
- },
29406
- {
29407
- "kind": "method",
29408
- "name": "renderLabel",
29409
- "privacy": "protected",
29410
- "description": "renders the mdc-label-text container that contains the label and labelInfoToggleTip.",
29411
- "return": {
29412
- "type": {
29413
- "text": ""
29414
- }
29415
- },
29416
- "inheritedFrom": {
29417
- "name": "FormfieldWrapper",
29418
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
29480
+ "name": "Popover",
29481
+ "module": "components/popover/popover.component.js"
29419
29482
  }
29420
29483
  },
29421
29484
  {
29422
- "kind": "method",
29423
- "name": "renderHelperText",
29424
- "privacy": "protected",
29425
- "description": "renders the mdc-help-text container that contains the helpertext icon and helpertext.",
29426
- "return": {
29427
- "type": {
29428
- "text": ""
29429
- }
29430
- },
29431
- "inheritedFrom": {
29432
- "name": "FormfieldWrapper",
29433
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
29434
- }
29435
- }
29436
- ],
29437
- "events": [
29438
- {
29485
+ "kind": "field",
29486
+ "name": "color",
29439
29487
  "type": {
29440
- "text": "EventConstructor"
29488
+ "text": "PopoverColor"
29489
+ },
29490
+ "description": "Color of the popover\n- **tonal**\n- **contrast**",
29491
+ "default": "tonal",
29492
+ "attribute": "color",
29493
+ "reflects": true,
29494
+ "inheritedFrom": {
29495
+ "name": "Popover",
29496
+ "module": "components/popover/popover.component.js"
29441
29497
  }
29442
29498
  },
29443
29499
  {
29444
- "description": "(React: onChange) Event that gets dispatched when the toggle state changes.",
29445
- "name": "change",
29446
- "reactName": "onChange"
29447
- },
29448
- {
29449
- "description": "(React: onFocus) Event that gets dispatched when the toggle receives focus.",
29450
- "name": "focus",
29451
- "reactName": "onFocus"
29452
- }
29453
- ],
29454
- "attributes": [
29455
- {
29456
- "name": "checked",
29500
+ "kind": "field",
29501
+ "name": "visible",
29457
29502
  "type": {
29458
29503
  "text": "boolean"
29459
29504
  },
29505
+ "description": "The visibility of the popover.",
29460
29506
  "default": "false",
29461
- "description": "Determines whether the toggle is active or inactive.",
29462
- "fieldName": "checked"
29507
+ "attribute": "visible",
29508
+ "reflects": true,
29509
+ "inheritedFrom": {
29510
+ "name": "Popover",
29511
+ "module": "components/popover/popover.component.js"
29512
+ }
29463
29513
  },
29464
29514
  {
29465
- "name": "size",
29515
+ "kind": "field",
29516
+ "name": "offset",
29466
29517
  "type": {
29467
- "text": "ToggleSize"
29518
+ "text": "number"
29468
29519
  },
29469
- "description": "Determines toggle size in rem (height is specified here).\n- **Default**: 1.5\n- **Compact**: 1",
29470
- "default": "default",
29471
- "fieldName": "size"
29520
+ "description": "The offset of the popover.",
29521
+ "default": "4",
29522
+ "attribute": "offset",
29523
+ "reflects": true,
29524
+ "inheritedFrom": {
29525
+ "name": "Popover",
29526
+ "module": "components/popover/popover.component.js"
29527
+ }
29472
29528
  },
29473
29529
  {
29474
- "name": "autofocus",
29530
+ "kind": "field",
29531
+ "name": "focusTrap",
29475
29532
  "type": {
29476
29533
  "text": "boolean"
29477
29534
  },
29535
+ "description": "Determines whether the focus trap is enabled.\nIf true, focus will be restricted to the content within this component.",
29478
29536
  "default": "false",
29479
- "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)",
29480
- "fieldName": "autofocus"
29481
- },
29482
- {
29483
- "name": "name",
29484
- "type": {
29485
- "text": "string"
29486
- },
29487
- "default": "''",
29488
- "description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
29489
- "fieldName": "name",
29537
+ "attribute": "focus-trap",
29538
+ "reflects": true,
29490
29539
  "inheritedFrom": {
29491
- "name": "FormInternalsMixin",
29492
- "module": "src/utils/mixins/FormInternalsMixin.ts"
29540
+ "name": "Popover",
29541
+ "module": "components/popover/popover.component.js"
29493
29542
  }
29494
29543
  },
29495
29544
  {
29496
- "name": "value",
29545
+ "kind": "field",
29546
+ "name": "preventScroll",
29497
29547
  "type": {
29498
- "text": "string"
29548
+ "text": "boolean"
29499
29549
  },
29500
- "default": "''",
29501
- "description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
29502
- "fieldName": "value",
29550
+ "description": "Prevent outside scrolling when popover show.",
29551
+ "default": "false",
29552
+ "attribute": "prevent-scroll",
29553
+ "reflects": true,
29503
29554
  "inheritedFrom": {
29504
- "name": "FormInternalsMixin",
29505
- "module": "src/utils/mixins/FormInternalsMixin.ts"
29555
+ "name": "Popover",
29556
+ "module": "components/popover/popover.component.js"
29506
29557
  }
29507
29558
  },
29508
29559
  {
29509
- "name": "validation-message",
29560
+ "kind": "field",
29561
+ "name": "showArrow",
29510
29562
  "type": {
29511
- "text": "string | undefined"
29563
+ "text": "boolean"
29512
29564
  },
29513
- "description": "Custom validation message that will override the default message and displayed when the input is invalid.",
29514
- "fieldName": "validationMessage",
29565
+ "description": "The arrow visibility of the popover.",
29566
+ "default": "false",
29567
+ "attribute": "show-arrow",
29568
+ "reflects": true,
29515
29569
  "inheritedFrom": {
29516
- "name": "FormInternalsMixin",
29517
- "module": "src/utils/mixins/FormInternalsMixin.ts"
29570
+ "name": "Popover",
29571
+ "module": "components/popover/popover.component.js"
29518
29572
  }
29519
29573
  },
29520
29574
  {
29521
- "name": "data-aria-label",
29575
+ "kind": "field",
29576
+ "name": "closeButton",
29522
29577
  "type": {
29523
- "text": "string | null"
29578
+ "text": "boolean"
29524
29579
  },
29525
- "default": "null",
29526
- "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
29527
- "fieldName": "dataAriaLabel",
29580
+ "description": "The close button visibility of the popover.",
29581
+ "default": "false",
29582
+ "attribute": "close-button",
29583
+ "reflects": true,
29528
29584
  "inheritedFrom": {
29529
- "name": "DataAriaLabelMixin",
29530
- "module": "src/utils/mixins/DataAriaLabelMixin.ts"
29585
+ "name": "Popover",
29586
+ "module": "components/popover/popover.component.js"
29531
29587
  }
29532
29588
  },
29533
29589
  {
29534
- "name": "disabled",
29590
+ "kind": "field",
29591
+ "name": "interactive",
29535
29592
  "type": {
29536
- "text": "boolean | undefined"
29593
+ "text": "boolean"
29537
29594
  },
29538
- "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
29539
- "default": "undefined",
29540
- "fieldName": "disabled",
29595
+ "description": "Determines whether the popover is interactive。",
29596
+ "default": "false",
29597
+ "attribute": "interactive",
29598
+ "reflects": true,
29541
29599
  "inheritedFrom": {
29542
- "name": "FormfieldWrapper",
29543
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
29600
+ "name": "Popover",
29601
+ "module": "components/popover/popover.component.js"
29544
29602
  }
29545
29603
  },
29546
29604
  {
29547
- "name": "label",
29605
+ "kind": "field",
29606
+ "name": "delay",
29548
29607
  "type": {
29549
- "text": "string | undefined"
29608
+ "text": "string"
29550
29609
  },
29551
- "description": "The label of the input field. It is linked to the input field using the `for` attribute.",
29552
- "fieldName": "label",
29610
+ "description": "The delay of the show/hide popover.",
29611
+ "default": "0,0",
29612
+ "attribute": "delay",
29613
+ "reflects": true,
29553
29614
  "inheritedFrom": {
29554
- "name": "FormfieldWrapper",
29555
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
29615
+ "name": "Popover",
29616
+ "module": "components/popover/popover.component.js"
29556
29617
  }
29557
29618
  },
29558
29619
  {
29559
- "name": "required",
29620
+ "kind": "field",
29621
+ "name": "hideOnEscape",
29560
29622
  "type": {
29561
29623
  "text": "boolean"
29562
29624
  },
29625
+ "description": "Hide popover on escape key press.",
29563
29626
  "default": "false",
29564
- "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
29565
- "fieldName": "required",
29627
+ "attribute": "hide-on-escape",
29628
+ "reflects": true,
29566
29629
  "inheritedFrom": {
29567
- "name": "FormfieldWrapper",
29568
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
29630
+ "name": "Popover",
29631
+ "module": "components/popover/popover.component.js"
29569
29632
  }
29570
29633
  },
29571
29634
  {
29572
- "name": "id",
29635
+ "kind": "field",
29636
+ "name": "hideOnBlur",
29573
29637
  "type": {
29574
- "text": "string"
29638
+ "text": "boolean"
29575
29639
  },
29576
- "default": "''",
29577
- "description": "The unique id of the input field. It is used to link the input field with the label.",
29578
- "fieldName": "id",
29640
+ "description": "Hide popover on blur.",
29641
+ "default": "false",
29642
+ "attribute": "hide-on-blur",
29643
+ "reflects": true,
29579
29644
  "inheritedFrom": {
29580
- "name": "FormfieldWrapper",
29581
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
29645
+ "name": "Popover",
29646
+ "module": "components/popover/popover.component.js"
29582
29647
  }
29583
29648
  },
29584
29649
  {
29585
- "name": "help-text-type",
29650
+ "kind": "field",
29651
+ "name": "hideOnOutsideClick",
29586
29652
  "type": {
29587
- "text": "ValidationType"
29653
+ "text": "boolean"
29588
29654
  },
29589
- "description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
29590
- "fieldName": "helpTextType",
29655
+ "description": "Hide on outside click of the popover.",
29656
+ "default": "false",
29657
+ "attribute": "hide-on-outside-click",
29658
+ "reflects": true,
29591
29659
  "inheritedFrom": {
29592
- "name": "FormfieldWrapper",
29593
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
29660
+ "name": "Popover",
29661
+ "module": "components/popover/popover.component.js"
29594
29662
  }
29595
29663
  },
29596
29664
  {
29597
- "name": "help-text",
29665
+ "kind": "field",
29666
+ "name": "focusBackToTrigger",
29598
29667
  "type": {
29599
- "text": "string | undefined"
29668
+ "text": "boolean"
29600
29669
  },
29601
- "description": "The help text that is displayed below the input field.",
29602
- "fieldName": "helpText",
29670
+ "description": "The focus back to trigger after the popover hide.",
29671
+ "default": "false",
29672
+ "attribute": "focus-back-to-trigger",
29673
+ "reflects": true,
29603
29674
  "inheritedFrom": {
29604
- "name": "FormfieldWrapper",
29605
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
29675
+ "name": "Popover",
29676
+ "module": "components/popover/popover.component.js"
29606
29677
  }
29607
- }
29608
- ],
29609
- "mixins": [
29610
- {
29611
- "name": "FormInternalsMixin",
29612
- "module": "/src/utils/mixins/FormInternalsMixin"
29613
29678
  },
29614
29679
  {
29615
- "name": "DataAriaLabelMixin",
29616
- "module": "/src/utils/mixins/DataAriaLabelMixin"
29617
- }
29618
- ],
29619
- "superclass": {
29620
- "name": "FormfieldWrapper",
29621
- "module": "/src/components/formfieldwrapper"
29622
- },
29623
- "tagName": "mdc-toggle",
29624
- "jsDoc": "/**\n * Toggle Component is an interactive control used to switch between two mutually exclusive options,\n * such as On/Off, Active/Inactive. These are commonly used in settings panels, forms, and preference selections\n * where users need to enable or disable a feature.\n * It contains an optional label and an optional helper text.\n *\n * To create a group of toggles, use the FormFieldGroup component.\n *\n * Note: It internally renders a checkbox styled as a toggle switch.\n *\n * @dependency mdc-icon\n * @dependency mdc-statictoggle\n *\n * @tagname mdc-toggle\n *\n * @event change - (React: onChange) Event that gets dispatched when the toggle state changes.\n * @event focus - (React: onFocus) Event that gets dispatched when the toggle receives focus.\n *\n * @cssproperty --mdc-toggle-width - Width of the toggle\n * @cssproperty --mdc-toggle-height - Height of the toggle\n * @cssproperty --mdc-toggle-width-compact - Width of the toggle when it's size is compact\n * @cssproperty --mdc-toggle-height-compact - Height of the toggle when it's size is compact\n * @cssproperty --mdc-toggle-label-lineheight - Line height of the toggle label\n * @cssproperty --mdc-toggle-label-fontsize - Font size of the toggle label\n * @cssproperty --mdc-toggle-label-fontweight - Font weight of the toggle label\n * @cssproperty --mdc-toggle-label-color-disabled - Color of the toggle label and help text in disabled state\n * @cssproperty --mdc-toggle-help-text-color - Color of the help text label\n * @cssproperty --mdc-toggle-active-hover-color - Background color of the active toggle in hover state\n * @cssproperty --mdc-toggle-active-pressed-color - Background color of the active toggle in pressed state\n * @cssproperty --mdc-toggle-inactive-hover-color - Background color of the inactive toggle in hover state\n * @cssproperty --mdc-toggle-inactive-pressed-color - Background color of the inactive toggle in pressed state\n */",
29625
- "customElement": true,
29626
- "slots": [
29627
- {
29628
- "description": "slot to add the label info icon",
29629
- "name": "label-info",
29630
- "inheritedFrom": {
29631
- "name": "FormfieldWrapper",
29632
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
29633
- }
29634
- }
29635
- ]
29636
- }
29637
- ],
29638
- "exports": [
29639
- {
29640
- "kind": "js",
29641
- "name": "default",
29642
- "declaration": {
29643
- "name": "Toggle",
29644
- "module": "components/toggle/toggle.component.js"
29645
- }
29646
- }
29647
- ]
29648
- },
29649
- {
29650
- "kind": "javascript-module",
29651
- "path": "components/toggletip/toggletip.component.js",
29652
- "declarations": [
29653
- {
29654
- "kind": "class",
29655
- "description": "A toggletip is triggered by clicking a trigger element.\n\nIt can contain interactive content and can be closed by\nclicking outside the toggletip or pressing the escape key.\n\nIt can have optional close button to close the toggletip.\n\nToggletip component uses `mdc-screenreaderannouncer` internally to\nannounce the toggletip text content with screen readers when the toggletip is shown.\n\n`screenreader-announcer-identity` attribute can be used to provide ID of an element\nin DOM to which announcement elements are added. If not set, a visually hidden\ndiv element is created in DOM to which announcement elements are added.\n\nPlease refer to the `mdc-screenreaderannouncer` component for more details.",
29656
- "name": "ToggleTip",
29657
- "cssProperties": [
29680
+ "kind": "field",
29681
+ "name": "backdrop",
29682
+ "type": {
29683
+ "text": "boolean"
29684
+ },
29685
+ "description": "Determines whether the popover with backdrop.\nOther than popover and trigger element, the rest of the screen will be covered with a backdrop.",
29686
+ "default": "false",
29687
+ "attribute": "backdrop",
29688
+ "reflects": true,
29689
+ "inheritedFrom": {
29690
+ "name": "Popover",
29691
+ "module": "components/popover/popover.component.js"
29692
+ }
29693
+ },
29658
29694
  {
29659
- "description": "The maximum width of the toggletip.",
29660
- "name": "--mdc-toggletip-max-width"
29695
+ "kind": "field",
29696
+ "name": "flip",
29697
+ "type": {
29698
+ "text": "boolean"
29699
+ },
29700
+ "description": "Changes the placement of popover to keep it in view when scrolling.",
29701
+ "default": "true",
29702
+ "attribute": "flip",
29703
+ "reflects": true,
29704
+ "inheritedFrom": {
29705
+ "name": "Popover",
29706
+ "module": "components/popover/popover.component.js"
29707
+ }
29661
29708
  },
29662
29709
  {
29663
- "description": "The text color of the toggletip.",
29664
- "name": "--mdc-toggletip-text-color"
29710
+ "kind": "field",
29711
+ "name": "size",
29712
+ "type": {
29713
+ "text": "boolean"
29714
+ },
29715
+ "description": "Changes the size of popover to keep it in view when scrolling.",
29716
+ "default": "false",
29717
+ "attribute": "size",
29718
+ "reflects": true,
29719
+ "inheritedFrom": {
29720
+ "name": "Popover",
29721
+ "module": "components/popover/popover.component.js"
29722
+ }
29665
29723
  },
29666
29724
  {
29667
- "description": "The text color of the toggletip when the color is contrast.",
29668
- "name": "--mdc-toggletip-text-color-contrast"
29725
+ "kind": "field",
29726
+ "name": "zIndex",
29727
+ "type": {
29728
+ "text": "number"
29729
+ },
29730
+ "description": "The z-index of the popover.",
29731
+ "default": "1000",
29732
+ "attribute": "z-index",
29733
+ "reflects": true,
29734
+ "inheritedFrom": {
29735
+ "name": "Popover",
29736
+ "module": "components/popover/popover.component.js"
29737
+ }
29669
29738
  },
29670
29739
  {
29671
- "description": "radius of the arrow border",
29672
- "name": "--mdc-popover-arrow-border-radius",
29740
+ "kind": "field",
29741
+ "name": "appendTo",
29742
+ "type": {
29743
+ "text": "string"
29744
+ },
29745
+ "default": "''",
29746
+ "description": "Element ID that the popover append to.",
29747
+ "attribute": "append-to",
29748
+ "reflects": true,
29673
29749
  "inheritedFrom": {
29674
29750
  "name": "Popover",
29675
- "module": "src/components/popover/popover.component.ts"
29751
+ "module": "components/popover/popover.component.js"
29676
29752
  }
29677
29753
  },
29678
29754
  {
29679
- "description": "border of the arrow",
29680
- "name": "--mdc-popover-arrow-border",
29755
+ "kind": "field",
29756
+ "name": "closeButtonAriaLabel",
29757
+ "type": {
29758
+ "text": "string | null"
29759
+ },
29760
+ "default": "null",
29761
+ "description": "aria-label attribute to be set for close button accessibility.",
29762
+ "attribute": "close-button-aria-label",
29763
+ "reflects": true,
29681
29764
  "inheritedFrom": {
29682
29765
  "name": "Popover",
29683
- "module": "src/components/popover/popover.component.ts"
29766
+ "module": "components/popover/popover.component.js"
29684
29767
  }
29685
29768
  },
29686
29769
  {
29687
- "description": "primary background color of the popover",
29688
- "name": "--mdc-popover-primary-background-color",
29770
+ "kind": "field",
29771
+ "name": "role",
29772
+ "type": {
29773
+ "text": "HTMLElement['role']"
29774
+ },
29775
+ "description": "Role of the popover",
29776
+ "default": "dialog",
29777
+ "attribute": "role",
29778
+ "reflects": true,
29689
29779
  "inheritedFrom": {
29690
29780
  "name": "Popover",
29691
- "module": "src/components/popover/popover.component.ts"
29781
+ "module": "components/popover/popover.component.js"
29692
29782
  }
29693
29783
  },
29694
29784
  {
29695
- "description": "border color of the popover",
29696
- "name": "--mdc-popover-border-color",
29785
+ "kind": "field",
29786
+ "name": "ariaLabelledby",
29787
+ "type": {
29788
+ "text": "string | null"
29789
+ },
29790
+ "default": "null",
29791
+ "description": "aria-labelledby for an interactive popover only, defaults to the trigger component id.\nUsed in nested cases where the triggerComponent isn't the actual button.",
29792
+ "attribute": "aria-labelledby",
29793
+ "reflects": true,
29697
29794
  "inheritedFrom": {
29698
29795
  "name": "Popover",
29699
- "module": "src/components/popover/popover.component.ts"
29796
+ "module": "components/popover/popover.component.js"
29700
29797
  }
29701
29798
  },
29702
29799
  {
29703
- "description": "inverted background color of the popover",
29704
- "name": "--mdc-popover-inverted-background-color",
29800
+ "kind": "field",
29801
+ "name": "ariaDescribedby",
29802
+ "type": {
29803
+ "text": "string | null"
29804
+ },
29805
+ "default": "null",
29806
+ "description": "aria-describedby of the popover.",
29807
+ "attribute": "aria-describedby",
29808
+ "reflects": true,
29705
29809
  "inheritedFrom": {
29706
29810
  "name": "Popover",
29707
- "module": "src/components/popover/popover.component.ts"
29811
+ "module": "components/popover/popover.component.js"
29708
29812
  }
29709
29813
  },
29710
29814
  {
29711
- "description": "inverted border color of the popover",
29712
- "name": "--mdc-popover-inverted-border-color",
29815
+ "kind": "field",
29816
+ "name": "disableAriaExpanded",
29817
+ "type": {
29818
+ "text": "boolean"
29819
+ },
29820
+ "description": "Disable aria-expanded attribute on trigger element.\nMake sure to set this to false when the popover is interactive.",
29821
+ "default": "false",
29822
+ "attribute": "disable-aria-expanded",
29823
+ "reflects": true,
29713
29824
  "inheritedFrom": {
29714
29825
  "name": "Popover",
29715
- "module": "src/components/popover/popover.component.ts"
29826
+ "module": "components/popover/popover.component.js"
29716
29827
  }
29717
29828
  },
29718
29829
  {
29719
- "description": "inverted text color of the popover",
29720
- "name": "--mdc-popover-inverted-text-color",
29830
+ "kind": "field",
29831
+ "name": "arrowElement",
29832
+ "type": {
29833
+ "text": "HTMLElement | null"
29834
+ },
29835
+ "privacy": "public",
29836
+ "default": "null",
29721
29837
  "inheritedFrom": {
29722
29838
  "name": "Popover",
29723
- "module": "src/components/popover/popover.component.ts"
29839
+ "module": "components/popover/popover.component.js"
29724
29840
  }
29725
29841
  },
29726
29842
  {
29727
- "description": "elevation of the popover",
29728
- "name": "--mdc-popover-elevation-3",
29843
+ "kind": "field",
29844
+ "name": "triggerElement",
29845
+ "type": {
29846
+ "text": "HTMLElement | null"
29847
+ },
29848
+ "privacy": "public",
29849
+ "default": "null",
29729
29850
  "inheritedFrom": {
29730
29851
  "name": "Popover",
29731
- "module": "src/components/popover/popover.component.ts"
29852
+ "module": "components/popover/popover.component.js"
29732
29853
  }
29733
29854
  },
29734
29855
  {
29735
- "description": "max width of the popover",
29736
- "name": "--mdc-popover-max-width",
29856
+ "kind": "method",
29857
+ "name": "setupTriggerListener",
29858
+ "privacy": "private",
29859
+ "description": "Sets up the trigger event listeners based on the trigger type.",
29737
29860
  "inheritedFrom": {
29738
29861
  "name": "Popover",
29739
- "module": "src/components/popover/popover.component.ts"
29862
+ "module": "components/popover/popover.component.js"
29740
29863
  }
29741
29864
  },
29742
29865
  {
29743
- "description": "max height of the popover",
29744
- "name": "--mdc-popover-max-height",
29866
+ "kind": "method",
29867
+ "name": "removeEventListeners",
29868
+ "privacy": "private",
29869
+ "description": "Removes the trigger event listeners.",
29745
29870
  "inheritedFrom": {
29746
29871
  "name": "Popover",
29747
- "module": "src/components/popover/popover.component.ts"
29872
+ "module": "components/popover/popover.component.js"
29748
29873
  }
29749
- }
29750
- ],
29751
- "slots": [
29874
+ },
29752
29875
  {
29753
- "description": "Default slot for the toggletip content",
29754
- "name": "",
29876
+ "kind": "field",
29877
+ "name": "onOutsidePopoverClick",
29878
+ "privacy": "private",
29879
+ "description": "Handles the outside click event to close the popover.",
29880
+ "parameters": [
29881
+ {
29882
+ "description": "The mouse event.",
29883
+ "name": "event"
29884
+ }
29885
+ ],
29755
29886
  "inheritedFrom": {
29756
29887
  "name": "Popover",
29757
- "module": "src/components/popover/popover.component.ts"
29888
+ "module": "components/popover/popover.component.js"
29758
29889
  }
29759
- }
29760
- ],
29761
- "members": [
29890
+ },
29762
29891
  {
29763
29892
  "kind": "field",
29764
- "name": "defaultSlotNodes",
29765
- "type": {
29766
- "text": "Array<Node>"
29767
- },
29768
- "privacy": "private"
29893
+ "name": "onEscapeKeydown",
29894
+ "privacy": "private",
29895
+ "description": "Handles the escape keydown event to close the popover.",
29896
+ "parameters": [
29897
+ {
29898
+ "description": "The keyboard event.",
29899
+ "name": "event"
29900
+ }
29901
+ ],
29902
+ "inheritedFrom": {
29903
+ "name": "Popover",
29904
+ "module": "components/popover/popover.component.js"
29905
+ }
29769
29906
  },
29770
29907
  {
29771
29908
  "kind": "field",
29772
- "name": "screenreaderAnnouncerIdentity",
29773
- "type": {
29774
- "text": "string"
29775
- },
29776
- "default": "''",
29777
- "description": "Set this attribute with the id of the element in the DOM, to which announcement\nelements will be appended.\nIf an id is provided, the announcement elements will be appended to this element.\nIf id is not provided, a visually hidden div element will be created in the DOM.\n\nPlease refer to the `mdc-screenreaderannouncer` component for more details.",
29778
- "attribute": "screenreader-announcer-identity",
29779
- "reflects": true
29909
+ "name": "onPopoverFocusOut",
29910
+ "privacy": "private",
29911
+ "description": "Handles the popover focus out event.",
29912
+ "parameters": [
29913
+ {
29914
+ "description": "The focus event.",
29915
+ "name": "event"
29916
+ }
29917
+ ],
29918
+ "inheritedFrom": {
29919
+ "name": "Popover",
29920
+ "module": "components/popover/popover.component.js"
29921
+ }
29780
29922
  },
29781
29923
  {
29782
29924
  "kind": "method",
29783
- "name": "getToggleTipText",
29925
+ "name": "isOpenUpdated",
29784
29926
  "privacy": "private",
29785
- "return": {
29786
- "type": {
29787
- "text": ""
29927
+ "parameters": [
29928
+ {
29929
+ "name": "oldValue",
29930
+ "type": {
29931
+ "text": "boolean"
29932
+ },
29933
+ "description": "The old value of the visible property."
29934
+ },
29935
+ {
29936
+ "name": "newValue",
29937
+ "type": {
29938
+ "text": "boolean"
29939
+ },
29940
+ "description": "The new value of the visible property."
29788
29941
  }
29942
+ ],
29943
+ "description": "Handles the popover visibility change and position the popover.\nHandles the exit event to close the popover.",
29944
+ "inheritedFrom": {
29945
+ "name": "Popover",
29946
+ "module": "components/popover/popover.component.js"
29789
29947
  }
29790
29948
  },
29791
29949
  {
29792
- "kind": "method",
29793
- "name": "onPlacementUpdated",
29950
+ "kind": "field",
29951
+ "name": "startCloseDelay",
29794
29952
  "privacy": "private",
29795
- "return": {
29796
- "type": {
29797
- "text": "void"
29798
- }
29799
- },
29800
- "description": "Updates the placement attribute if it is not a valid placement.\nDefault placement for toggle tip is top."
29953
+ "description": "Starts the close delay timer.\nIf the popover is not interactive, it will close the popover after the delay.",
29954
+ "inheritedFrom": {
29955
+ "name": "Popover",
29956
+ "module": "components/popover/popover.component.js"
29957
+ }
29801
29958
  },
29802
29959
  {
29803
29960
  "kind": "field",
29804
- "name": "enabledFocusTrap",
29805
- "type": {
29806
- "text": "boolean"
29807
- },
29808
- "default": "false",
29809
- "description": "Determines whether the focus trap is enabled.\nIf true, focus will be restricted to the content within this component.",
29810
- "attribute": "enabledFocusTrap",
29961
+ "name": "cancelCloseDelay",
29962
+ "privacy": "private",
29963
+ "description": "Cancels the close delay timer.",
29811
29964
  "inheritedFrom": {
29812
29965
  "name": "Popover",
29813
29966
  "module": "components/popover/popover.component.js"
@@ -29815,13 +29968,9 @@
29815
29968
  },
29816
29969
  {
29817
29970
  "kind": "field",
29818
- "name": "enabledPreventScroll",
29819
- "type": {
29820
- "text": "boolean"
29821
- },
29822
- "default": "false",
29823
- "description": "Prevent outside scrolling when element is shown.",
29824
- "attribute": "enabledPreventScroll",
29971
+ "name": "showPopover",
29972
+ "privacy": "public",
29973
+ "description": "Shows the popover.",
29825
29974
  "inheritedFrom": {
29826
29975
  "name": "Popover",
29827
29976
  "module": "components/popover/popover.component.js"
@@ -29829,20 +29978,19 @@
29829
29978
  },
29830
29979
  {
29831
29980
  "kind": "field",
29832
- "name": "shouldWrapFocus",
29833
- "type": {
29834
- "text": "() => boolean"
29835
- },
29981
+ "name": "hidePopover",
29982
+ "privacy": "public",
29983
+ "description": "Hides the popover.",
29836
29984
  "inheritedFrom": {
29837
29985
  "name": "Popover",
29838
29986
  "module": "components/popover/popover.component.js"
29839
29987
  }
29840
29988
  },
29841
29989
  {
29842
- "kind": "method",
29843
- "name": "deactivateFocusTrap",
29990
+ "kind": "field",
29991
+ "name": "togglePopoverVisible",
29844
29992
  "privacy": "public",
29845
- "description": "Deactivate the focus trap.",
29993
+ "description": "Toggles the popover visibility.",
29846
29994
  "inheritedFrom": {
29847
29995
  "name": "Popover",
29848
29996
  "module": "components/popover/popover.component.js"
@@ -29850,23 +29998,9 @@
29850
29998
  },
29851
29999
  {
29852
30000
  "kind": "method",
29853
- "name": "hasNoClientRects",
30001
+ "name": "handleCreatePopoverFirstUpdate",
29854
30002
  "privacy": "private",
29855
- "parameters": [
29856
- {
29857
- "name": "element",
29858
- "type": {
29859
- "text": "HTMLElement"
29860
- },
29861
- "description": "The element to check."
29862
- }
29863
- ],
29864
- "description": "Checks if the element has no client rectangles (not visible in the viewport).",
29865
- "return": {
29866
- "type": {
29867
- "text": ""
29868
- }
29869
- },
30003
+ "description": "Sets the focusable elements inside the popover.",
29870
30004
  "inheritedFrom": {
29871
30005
  "name": "Popover",
29872
30006
  "module": "components/popover/popover.component.js"
@@ -29874,1435 +30008,1301 @@
29874
30008
  },
29875
30009
  {
29876
30010
  "kind": "method",
29877
- "name": "hasZeroDimensions",
30011
+ "name": "positionPopover",
29878
30012
  "privacy": "private",
29879
- "parameters": [
29880
- {
29881
- "name": "element",
29882
- "type": {
29883
- "text": "HTMLElement"
29884
- },
29885
- "description": "The element to check."
29886
- }
29887
- ],
29888
- "description": "Checks if the element has zero dimensions (width and height are both 0).",
29889
- "return": {
29890
- "type": {
29891
- "text": ""
29892
- }
29893
- },
30013
+ "description": "Positions the popover based on the trigger element.\nIt also handles the flip, size and arrow placement.\nIt uses the floating-ui/dom library to calculate the position.",
29894
30014
  "inheritedFrom": {
29895
30015
  "name": "Popover",
29896
30016
  "module": "components/popover/popover.component.js"
29897
30017
  }
29898
30018
  },
29899
30019
  {
29900
- "kind": "method",
29901
- "name": "isNotVisible",
29902
- "privacy": "private",
29903
- "parameters": [
29904
- {
29905
- "name": "element",
29906
- "type": {
29907
- "text": "HTMLElement"
29908
- },
29909
- "description": "The element to check."
29910
- }
29911
- ],
29912
- "description": "Determines if the element is not visible in the DOM.",
29913
- "return": {
29914
- "type": {
29915
- "text": ""
29916
- }
29917
- },
30020
+ "kind": "field",
30021
+ "name": "utils",
30022
+ "default": "new PopoverUtils(this)",
29918
30023
  "inheritedFrom": {
29919
30024
  "name": "Popover",
29920
30025
  "module": "components/popover/popover.component.js"
29921
30026
  }
30027
+ }
30028
+ ],
30029
+ "events": [
30030
+ {
30031
+ "description": "(React: onShown) This event is dispatched when the toggletip is shown",
30032
+ "name": "shown",
30033
+ "reactName": "onShown",
30034
+ "inheritedFrom": {
30035
+ "name": "Popover",
30036
+ "module": "src/components/popover/popover.component.ts"
30037
+ }
29922
30038
  },
29923
30039
  {
29924
- "kind": "method",
29925
- "name": "hasHiddenStyle",
29926
- "privacy": "private",
29927
- "parameters": [
29928
- {
29929
- "name": "element",
29930
- "type": {
29931
- "text": "HTMLElement"
29932
- },
29933
- "description": "The element to check."
29934
- }
29935
- ],
29936
- "description": "Checks if the element has inline styles that make it hidden.",
29937
- "return": {
29938
- "type": {
29939
- "text": ""
29940
- }
30040
+ "description": "(React: onHidden) This event is dispatched when the toggletip is hidden",
30041
+ "name": "hidden",
30042
+ "reactName": "onHidden",
30043
+ "inheritedFrom": {
30044
+ "name": "Popover",
30045
+ "module": "src/components/popover/popover.component.ts"
30046
+ }
30047
+ },
30048
+ {
30049
+ "description": "(React: onCreated) This event is dispatched when the toggletip is created (added to the DOM)",
30050
+ "name": "created",
30051
+ "reactName": "onCreated",
30052
+ "inheritedFrom": {
30053
+ "name": "Popover",
30054
+ "module": "src/components/popover/popover.component.ts"
30055
+ }
30056
+ },
30057
+ {
30058
+ "description": "(React: onDestroyed) This event is dispatched when the toggletip is destroyed (removed from the DOM)",
30059
+ "name": "destroyed",
30060
+ "reactName": "onDestroyed",
30061
+ "inheritedFrom": {
30062
+ "name": "Popover",
30063
+ "module": "src/components/popover/popover.component.ts"
30064
+ }
30065
+ }
30066
+ ],
30067
+ "attributes": [
30068
+ {
30069
+ "name": "screenreader-announcer-identity",
30070
+ "type": {
30071
+ "text": "string"
30072
+ },
30073
+ "default": "''",
30074
+ "description": "Set this attribute with the id of the element in the DOM, to which announcement\nelements will be appended.\nIf an id is provided, the announcement elements will be appended to this element.\nIf id is not provided, a visually hidden div element will be created in the DOM.\n\nPlease refer to the `mdc-screenreaderannouncer` component for more details.",
30075
+ "fieldName": "screenreaderAnnouncerIdentity"
30076
+ },
30077
+ {
30078
+ "name": "enabledFocusTrap",
30079
+ "type": {
30080
+ "text": "boolean"
29941
30081
  },
30082
+ "default": "false",
30083
+ "description": "Determines whether the focus trap is enabled.\nIf true, focus will be restricted to the content within this component.",
30084
+ "fieldName": "enabledFocusTrap",
29942
30085
  "inheritedFrom": {
29943
30086
  "name": "Popover",
29944
- "module": "components/popover/popover.component.js"
30087
+ "module": "src/components/popover/popover.component.ts"
29945
30088
  }
29946
30089
  },
29947
30090
  {
29948
- "kind": "method",
29949
- "name": "hasComputedHidden",
29950
- "privacy": "private",
29951
- "parameters": [
29952
- {
29953
- "name": "element",
29954
- "type": {
29955
- "text": "HTMLElement"
29956
- },
29957
- "description": "The element to check."
29958
- }
29959
- ],
29960
- "description": "Checks if the element is hidden by a computed style.",
29961
- "return": {
29962
- "type": {
29963
- "text": ""
29964
- }
30091
+ "name": "enabledPreventScroll",
30092
+ "type": {
30093
+ "text": "boolean"
29965
30094
  },
30095
+ "default": "false",
30096
+ "description": "Prevent outside scrolling when element is shown.",
30097
+ "fieldName": "enabledPreventScroll",
29966
30098
  "inheritedFrom": {
29967
30099
  "name": "Popover",
29968
- "module": "components/popover/popover.component.js"
30100
+ "module": "src/components/popover/popover.component.ts"
29969
30101
  }
29970
30102
  },
29971
30103
  {
29972
- "kind": "method",
29973
- "name": "isHidden",
29974
- "privacy": "private",
29975
- "parameters": [
29976
- {
29977
- "name": "element",
29978
- "type": {
29979
- "text": "HTMLElement"
29980
- },
29981
- "description": "The element to check."
29982
- }
29983
- ],
29984
- "description": "Checks if the element is hidden from the user.",
29985
- "return": {
29986
- "type": {
29987
- "text": ""
29988
- }
30104
+ "name": "id",
30105
+ "type": {
30106
+ "text": "string"
29989
30107
  },
30108
+ "default": "''",
30109
+ "description": "The unique ID of the popover.",
30110
+ "fieldName": "id",
29990
30111
  "inheritedFrom": {
29991
30112
  "name": "Popover",
29992
- "module": "components/popover/popover.component.js"
30113
+ "module": "src/components/popover/popover.component.ts"
29993
30114
  }
29994
30115
  },
29995
30116
  {
29996
- "kind": "method",
29997
- "name": "isNotTabbable",
29998
- "privacy": "private",
29999
- "parameters": [
30000
- {
30001
- "name": "element",
30002
- "type": {
30003
- "text": "HTMLElement"
30004
- },
30005
- "description": "The element to check."
30006
- }
30007
- ],
30008
- "description": "Checks if the element is not tabbable.",
30009
- "return": {
30010
- "type": {
30011
- "text": ""
30012
- }
30117
+ "name": "triggerID",
30118
+ "type": {
30119
+ "text": "string"
30120
+ },
30121
+ "default": "''",
30122
+ "description": "The ID of the element that triggers the popover.\nThis attribute is required for the popover to work.",
30123
+ "fieldName": "triggerID",
30124
+ "inheritedFrom": {
30125
+ "name": "Popover",
30126
+ "module": "src/components/popover/popover.component.ts"
30127
+ }
30128
+ },
30129
+ {
30130
+ "name": "trigger",
30131
+ "type": {
30132
+ "text": "PopoverTrigger"
30013
30133
  },
30134
+ "description": "Determines the events that cause the Popover to show.\nMultiple event names should be separated by spaces.\nFor example to allow both click and hover, use 'click mouseenter' as the trigger.\n- **click**\n- **mouseenter**\n- **focusin**\n- **manual**",
30135
+ "default": "click",
30136
+ "fieldName": "trigger",
30014
30137
  "inheritedFrom": {
30015
30138
  "name": "Popover",
30016
- "module": "components/popover/popover.component.js"
30139
+ "module": "src/components/popover/popover.component.ts"
30017
30140
  }
30018
30141
  },
30019
30142
  {
30020
- "kind": "method",
30021
- "name": "isInteractiveElement",
30022
- "privacy": "private",
30023
- "return": {
30024
- "type": {
30025
- "text": ""
30026
- }
30143
+ "name": "placement",
30144
+ "type": {
30145
+ "text": "PopoverPlacement"
30027
30146
  },
30028
- "parameters": [
30029
- {
30030
- "name": "element",
30031
- "type": {
30032
- "text": "HTMLElement"
30033
- },
30034
- "description": "The element to check."
30035
- }
30036
- ],
30037
- "description": "Checks if the element is interactive.",
30147
+ "description": "The placement of the popover.\n- **top**\n- **top-start**\n- **top-end**\n- **bottom**\n- **bottom-start**\n- **bottom-end**\n- **left**\n- **left-start**\n- **left-end**\n- **right**\n- **right-start**\n- **right-end**",
30148
+ "default": "bottom",
30149
+ "fieldName": "placement",
30038
30150
  "inheritedFrom": {
30039
30151
  "name": "Popover",
30040
- "module": "components/popover/popover.component.js"
30152
+ "module": "src/components/popover/popover.component.ts"
30041
30153
  }
30042
30154
  },
30043
30155
  {
30044
- "kind": "method",
30045
- "name": "isFocusable",
30046
- "privacy": "private",
30047
- "parameters": [
30048
- {
30049
- "name": "element",
30050
- "type": {
30051
- "text": "HTMLElement"
30052
- },
30053
- "description": "The element to check."
30054
- }
30055
- ],
30056
- "description": "Checks if the element is focusable.",
30057
- "return": {
30058
- "type": {
30059
- "text": ""
30060
- }
30156
+ "name": "color",
30157
+ "type": {
30158
+ "text": "PopoverColor"
30061
30159
  },
30160
+ "description": "Color of the popover\n- **tonal**\n- **contrast**",
30161
+ "default": "tonal",
30162
+ "fieldName": "color",
30062
30163
  "inheritedFrom": {
30063
30164
  "name": "Popover",
30064
- "module": "components/popover/popover.component.js"
30165
+ "module": "src/components/popover/popover.component.ts"
30065
30166
  }
30066
30167
  },
30067
30168
  {
30068
- "kind": "method",
30069
- "name": "findFocusable",
30070
- "privacy": "private",
30071
- "return": {
30072
- "type": {
30073
- "text": ""
30074
- }
30169
+ "name": "visible",
30170
+ "type": {
30171
+ "text": "boolean"
30075
30172
  },
30076
- "parameters": [
30077
- {
30078
- "name": "root",
30079
- "type": {
30080
- "text": "ShadowRoot | HTMLElement"
30081
- },
30082
- "description": "The root element to search for focusable elements."
30083
- },
30084
- {
30085
- "name": "matches",
30086
- "default": "new Set()",
30087
- "type": {
30088
- "text": "Set<HTMLElement>"
30089
- },
30090
- "description": "The set of focusable elements."
30091
- }
30092
- ],
30093
- "description": "Recursively finds all focusable elements within the given root and its descendants.",
30173
+ "description": "The visibility of the popover.",
30174
+ "default": "false",
30175
+ "fieldName": "visible",
30094
30176
  "inheritedFrom": {
30095
30177
  "name": "Popover",
30096
- "module": "components/popover/popover.component.js"
30178
+ "module": "src/components/popover/popover.component.ts"
30097
30179
  }
30098
30180
  },
30099
30181
  {
30100
- "kind": "method",
30101
- "name": "setFocusableElements",
30102
- "privacy": "public",
30103
- "description": "Updates the list of focusable elements within the component's shadow root.",
30182
+ "name": "offset",
30183
+ "type": {
30184
+ "text": "number"
30185
+ },
30186
+ "description": "The offset of the popover.",
30187
+ "default": "4",
30188
+ "fieldName": "offset",
30104
30189
  "inheritedFrom": {
30105
30190
  "name": "Popover",
30106
- "module": "components/popover/popover.component.js"
30191
+ "module": "src/components/popover/popover.component.ts"
30107
30192
  }
30108
30193
  },
30109
30194
  {
30110
- "kind": "method",
30111
- "name": "setInitialFocus",
30112
- "privacy": "public",
30113
- "parameters": [
30114
- {
30115
- "name": "prefferableElement",
30116
- "default": "0",
30117
- "type": {
30118
- "text": "number"
30119
- },
30120
- "description": "The index of the preferable element to focus."
30121
- }
30122
- ],
30123
- "description": "Sets the initial focus within the container.",
30195
+ "name": "focus-trap",
30196
+ "type": {
30197
+ "text": "boolean"
30198
+ },
30199
+ "description": "Determines whether the focus trap is enabled.\nIf true, focus will be restricted to the content within this component.",
30200
+ "default": "false",
30201
+ "fieldName": "focusTrap",
30124
30202
  "inheritedFrom": {
30125
30203
  "name": "Popover",
30126
- "module": "components/popover/popover.component.js"
30204
+ "module": "src/components/popover/popover.component.ts"
30127
30205
  }
30128
30206
  },
30129
30207
  {
30130
- "kind": "method",
30131
- "name": "calculateNextIndex",
30132
- "privacy": "private",
30133
- "parameters": [
30134
- {
30135
- "name": "currentIndex",
30136
- "type": {
30137
- "text": "number"
30138
- },
30139
- "description": "The current index."
30140
- },
30141
- {
30142
- "name": "step",
30143
- "type": {
30144
- "text": "number"
30145
- },
30146
- "description": "The step to calculate the next index."
30147
- }
30148
- ],
30149
- "description": "Calculates the next index for the focus trap.",
30150
- "return": {
30151
- "type": {
30152
- "text": ""
30153
- }
30208
+ "name": "prevent-scroll",
30209
+ "type": {
30210
+ "text": "boolean"
30154
30211
  },
30212
+ "description": "Prevent outside scrolling when popover show.",
30213
+ "default": "false",
30214
+ "fieldName": "preventScroll",
30155
30215
  "inheritedFrom": {
30156
30216
  "name": "Popover",
30157
- "module": "components/popover/popover.component.js"
30217
+ "module": "src/components/popover/popover.component.ts"
30158
30218
  }
30159
30219
  },
30160
30220
  {
30161
- "kind": "method",
30162
- "name": "getDeepActiveElement",
30163
- "privacy": "private",
30164
- "description": "Returns the deepest active element in the shadow DOM.",
30165
- "return": {
30166
- "type": {
30167
- "text": ""
30168
- }
30221
+ "name": "show-arrow",
30222
+ "type": {
30223
+ "text": "boolean"
30169
30224
  },
30225
+ "description": "The arrow visibility of the popover.",
30226
+ "default": "false",
30227
+ "fieldName": "showArrow",
30170
30228
  "inheritedFrom": {
30171
30229
  "name": "Popover",
30172
- "module": "components/popover/popover.component.js"
30230
+ "module": "src/components/popover/popover.component.ts"
30173
30231
  }
30174
30232
  },
30175
30233
  {
30176
- "kind": "method",
30177
- "name": "findElement",
30178
- "privacy": "private",
30179
- "parameters": [
30180
- {
30181
- "name": "activeElement",
30182
- "type": {
30183
- "text": "HTMLElement"
30184
- },
30185
- "description": "The active element."
30186
- }
30187
- ],
30188
- "description": "Finds the index of the active element within the focusable elements.",
30189
- "return": {
30190
- "type": {
30191
- "text": ""
30192
- }
30234
+ "name": "close-button",
30235
+ "type": {
30236
+ "text": "boolean"
30193
30237
  },
30238
+ "description": "The close button visibility of the popover.",
30239
+ "default": "false",
30240
+ "fieldName": "closeButton",
30194
30241
  "inheritedFrom": {
30195
30242
  "name": "Popover",
30196
- "module": "components/popover/popover.component.js"
30243
+ "module": "src/components/popover/popover.component.ts"
30197
30244
  }
30198
30245
  },
30199
30246
  {
30200
- "kind": "method",
30201
- "name": "isEqualFocusNode",
30202
- "privacy": "private",
30203
- "parameters": [
30204
- {
30205
- "name": "activeElement",
30206
- "type": {
30207
- "text": "HTMLElement"
30208
- },
30209
- "description": "The active element."
30210
- },
30211
- {
30212
- "name": "element",
30213
- "type": {
30214
- "text": "HTMLElement"
30215
- },
30216
- "description": "The element to compare."
30217
- }
30218
- ],
30219
- "description": "Checks if the active element is equal to the given element.",
30220
- "return": {
30221
- "type": {
30222
- "text": ""
30223
- }
30247
+ "name": "interactive",
30248
+ "type": {
30249
+ "text": "boolean"
30224
30250
  },
30251
+ "description": "Determines whether the popover is interactive。",
30252
+ "default": "false",
30253
+ "fieldName": "interactive",
30225
30254
  "inheritedFrom": {
30226
30255
  "name": "Popover",
30227
- "module": "components/popover/popover.component.js"
30256
+ "module": "src/components/popover/popover.component.ts"
30228
30257
  }
30229
30258
  },
30230
30259
  {
30231
- "kind": "method",
30232
- "name": "trapFocus",
30233
- "privacy": "private",
30234
- "parameters": [
30235
- {
30236
- "name": "direction",
30237
- "type": {
30238
- "text": "boolean"
30239
- },
30240
- "description": "The direction of the focus trap.\nIf true, the focus will be trapped in the previous element."
30241
- }
30242
- ],
30243
- "description": "Traps focus within the container.",
30260
+ "name": "delay",
30261
+ "type": {
30262
+ "text": "string"
30263
+ },
30264
+ "description": "The delay of the show/hide popover.",
30265
+ "default": "0,0",
30266
+ "fieldName": "delay",
30244
30267
  "inheritedFrom": {
30245
30268
  "name": "Popover",
30246
- "module": "components/popover/popover.component.js"
30269
+ "module": "src/components/popover/popover.component.ts"
30247
30270
  }
30248
30271
  },
30249
30272
  {
30250
- "kind": "method",
30251
- "name": "handleKeydown",
30252
- "privacy": "private",
30253
- "parameters": [
30254
- {
30255
- "name": "event",
30256
- "type": {
30257
- "text": "KeyboardEvent"
30258
- },
30259
- "description": "The keyboard event."
30260
- }
30261
- ],
30262
- "description": "Traps focus within the container.",
30273
+ "name": "hide-on-escape",
30274
+ "type": {
30275
+ "text": "boolean"
30276
+ },
30277
+ "description": "Hide popover on escape key press.",
30278
+ "default": "false",
30279
+ "fieldName": "hideOnEscape",
30263
30280
  "inheritedFrom": {
30264
30281
  "name": "Popover",
30265
- "module": "components/popover/popover.component.js"
30282
+ "module": "src/components/popover/popover.component.ts"
30266
30283
  }
30267
30284
  },
30268
30285
  {
30269
- "kind": "field",
30270
- "name": "id",
30286
+ "name": "hide-on-blur",
30271
30287
  "type": {
30272
- "text": "string"
30288
+ "text": "boolean"
30273
30289
  },
30274
- "default": "''",
30275
- "description": "The unique ID of the popover.",
30276
- "attribute": "id",
30277
- "reflects": true,
30290
+ "description": "Hide popover on blur.",
30291
+ "default": "false",
30292
+ "fieldName": "hideOnBlur",
30278
30293
  "inheritedFrom": {
30279
30294
  "name": "Popover",
30280
- "module": "components/popover/popover.component.js"
30295
+ "module": "src/components/popover/popover.component.ts"
30281
30296
  }
30282
30297
  },
30283
30298
  {
30284
- "kind": "field",
30285
- "name": "triggerID",
30299
+ "name": "hide-on-outside-click",
30286
30300
  "type": {
30287
- "text": "string"
30301
+ "text": "boolean"
30288
30302
  },
30289
- "default": "''",
30290
- "description": "The ID of the element that triggers the popover.\nThis attribute is required for the popover to work.",
30291
- "attribute": "triggerID",
30292
- "reflects": true,
30303
+ "description": "Hide on outside click of the popover.",
30304
+ "default": "false",
30305
+ "fieldName": "hideOnOutsideClick",
30293
30306
  "inheritedFrom": {
30294
30307
  "name": "Popover",
30295
- "module": "components/popover/popover.component.js"
30308
+ "module": "src/components/popover/popover.component.ts"
30296
30309
  }
30297
30310
  },
30298
30311
  {
30299
- "kind": "field",
30300
- "name": "trigger",
30312
+ "name": "focus-back-to-trigger",
30301
30313
  "type": {
30302
- "text": "PopoverTrigger"
30314
+ "text": "boolean"
30303
30315
  },
30304
- "description": "Determines the events that cause the Popover to show.\nMultiple event names should be separated by spaces.\nFor example to allow both click and hover, use 'click mouseenter' as the trigger.\n- **click**\n- **mouseenter**\n- **focusin**\n- **manual**",
30305
- "default": "click",
30306
- "attribute": "trigger",
30307
- "reflects": true,
30316
+ "description": "The focus back to trigger after the popover hide.",
30317
+ "default": "false",
30318
+ "fieldName": "focusBackToTrigger",
30308
30319
  "inheritedFrom": {
30309
30320
  "name": "Popover",
30310
- "module": "components/popover/popover.component.js"
30321
+ "module": "src/components/popover/popover.component.ts"
30311
30322
  }
30312
30323
  },
30313
30324
  {
30314
- "kind": "field",
30315
- "name": "placement",
30325
+ "name": "backdrop",
30316
30326
  "type": {
30317
- "text": "PopoverPlacement"
30327
+ "text": "boolean"
30318
30328
  },
30319
- "description": "The placement of the popover.\n- **top**\n- **top-start**\n- **top-end**\n- **bottom**\n- **bottom-start**\n- **bottom-end**\n- **left**\n- **left-start**\n- **left-end**\n- **right**\n- **right-start**\n- **right-end**",
30320
- "default": "bottom",
30321
- "attribute": "placement",
30322
- "reflects": true,
30329
+ "description": "Determines whether the popover with backdrop.\nOther than popover and trigger element, the rest of the screen will be covered with a backdrop.",
30330
+ "default": "false",
30331
+ "fieldName": "backdrop",
30323
30332
  "inheritedFrom": {
30324
30333
  "name": "Popover",
30325
- "module": "components/popover/popover.component.js"
30334
+ "module": "src/components/popover/popover.component.ts"
30326
30335
  }
30327
30336
  },
30328
30337
  {
30329
- "kind": "field",
30330
- "name": "color",
30338
+ "name": "flip",
30331
30339
  "type": {
30332
- "text": "PopoverColor"
30340
+ "text": "boolean"
30333
30341
  },
30334
- "description": "Color of the popover\n- **tonal**\n- **contrast**",
30335
- "default": "tonal",
30336
- "attribute": "color",
30337
- "reflects": true,
30342
+ "description": "Changes the placement of popover to keep it in view when scrolling.",
30343
+ "default": "true",
30344
+ "fieldName": "flip",
30338
30345
  "inheritedFrom": {
30339
30346
  "name": "Popover",
30340
- "module": "components/popover/popover.component.js"
30347
+ "module": "src/components/popover/popover.component.ts"
30341
30348
  }
30342
30349
  },
30343
30350
  {
30344
- "kind": "field",
30345
- "name": "visible",
30351
+ "name": "size",
30346
30352
  "type": {
30347
30353
  "text": "boolean"
30348
30354
  },
30349
- "description": "The visibility of the popover.",
30355
+ "description": "Changes the size of popover to keep it in view when scrolling.",
30350
30356
  "default": "false",
30351
- "attribute": "visible",
30352
- "reflects": true,
30357
+ "fieldName": "size",
30353
30358
  "inheritedFrom": {
30354
30359
  "name": "Popover",
30355
- "module": "components/popover/popover.component.js"
30360
+ "module": "src/components/popover/popover.component.ts"
30356
30361
  }
30357
30362
  },
30358
30363
  {
30359
- "kind": "field",
30360
- "name": "offset",
30364
+ "name": "z-index",
30361
30365
  "type": {
30362
30366
  "text": "number"
30363
30367
  },
30364
- "description": "The offset of the popover.",
30365
- "default": "4",
30366
- "attribute": "offset",
30367
- "reflects": true,
30368
+ "description": "The z-index of the popover.",
30369
+ "default": "1000",
30370
+ "fieldName": "zIndex",
30368
30371
  "inheritedFrom": {
30369
30372
  "name": "Popover",
30370
- "module": "components/popover/popover.component.js"
30373
+ "module": "src/components/popover/popover.component.ts"
30371
30374
  }
30372
30375
  },
30373
30376
  {
30374
- "kind": "field",
30375
- "name": "focusTrap",
30377
+ "name": "append-to",
30376
30378
  "type": {
30377
- "text": "boolean"
30379
+ "text": "string"
30378
30380
  },
30379
- "description": "Determines whether the focus trap is enabled.\nIf true, focus will be restricted to the content within this component.",
30380
- "default": "false",
30381
- "attribute": "focus-trap",
30382
- "reflects": true,
30381
+ "default": "''",
30382
+ "description": "Element ID that the popover append to.",
30383
+ "fieldName": "appendTo",
30383
30384
  "inheritedFrom": {
30384
30385
  "name": "Popover",
30385
- "module": "components/popover/popover.component.js"
30386
+ "module": "src/components/popover/popover.component.ts"
30386
30387
  }
30387
30388
  },
30388
30389
  {
30389
- "kind": "field",
30390
- "name": "preventScroll",
30390
+ "name": "close-button-aria-label",
30391
30391
  "type": {
30392
- "text": "boolean"
30392
+ "text": "string | null"
30393
30393
  },
30394
- "description": "Prevent outside scrolling when popover show.",
30395
- "default": "false",
30396
- "attribute": "prevent-scroll",
30397
- "reflects": true,
30394
+ "default": "null",
30395
+ "description": "aria-label attribute to be set for close button accessibility.",
30396
+ "fieldName": "closeButtonAriaLabel",
30398
30397
  "inheritedFrom": {
30399
30398
  "name": "Popover",
30400
- "module": "components/popover/popover.component.js"
30399
+ "module": "src/components/popover/popover.component.ts"
30401
30400
  }
30402
30401
  },
30403
30402
  {
30404
- "kind": "field",
30405
- "name": "showArrow",
30403
+ "name": "role",
30406
30404
  "type": {
30407
- "text": "boolean"
30405
+ "text": "HTMLElement['role']"
30408
30406
  },
30409
- "description": "The arrow visibility of the popover.",
30410
- "default": "false",
30411
- "attribute": "show-arrow",
30412
- "reflects": true,
30407
+ "description": "Role of the popover",
30408
+ "default": "dialog",
30409
+ "fieldName": "role",
30413
30410
  "inheritedFrom": {
30414
30411
  "name": "Popover",
30415
- "module": "components/popover/popover.component.js"
30412
+ "module": "src/components/popover/popover.component.ts"
30416
30413
  }
30417
30414
  },
30418
30415
  {
30419
- "kind": "field",
30420
- "name": "closeButton",
30416
+ "name": "aria-labelledby",
30421
30417
  "type": {
30422
- "text": "boolean"
30418
+ "text": "string | null"
30423
30419
  },
30424
- "description": "The close button visibility of the popover.",
30425
- "default": "false",
30426
- "attribute": "close-button",
30427
- "reflects": true,
30420
+ "default": "null",
30421
+ "description": "aria-labelledby for an interactive popover only, defaults to the trigger component id.\nUsed in nested cases where the triggerComponent isn't the actual button.",
30422
+ "fieldName": "ariaLabelledby",
30428
30423
  "inheritedFrom": {
30429
30424
  "name": "Popover",
30430
- "module": "components/popover/popover.component.js"
30425
+ "module": "src/components/popover/popover.component.ts"
30431
30426
  }
30432
30427
  },
30433
30428
  {
30434
- "kind": "field",
30435
- "name": "interactive",
30429
+ "name": "aria-describedby",
30430
+ "type": {
30431
+ "text": "string | null"
30432
+ },
30433
+ "default": "null",
30434
+ "description": "aria-describedby of the popover.",
30435
+ "fieldName": "ariaDescribedby",
30436
+ "inheritedFrom": {
30437
+ "name": "Popover",
30438
+ "module": "src/components/popover/popover.component.ts"
30439
+ }
30440
+ },
30441
+ {
30442
+ "name": "disable-aria-expanded",
30436
30443
  "type": {
30437
30444
  "text": "boolean"
30438
30445
  },
30439
- "description": "Determines whether the popover is interactive",
30446
+ "description": "Disable aria-expanded attribute on trigger element.\nMake sure to set this to false when the popover is interactive.",
30440
30447
  "default": "false",
30441
- "attribute": "interactive",
30442
- "reflects": true,
30448
+ "fieldName": "disableAriaExpanded",
30443
30449
  "inheritedFrom": {
30444
30450
  "name": "Popover",
30445
- "module": "components/popover/popover.component.js"
30451
+ "module": "src/components/popover/popover.component.ts"
30446
30452
  }
30453
+ }
30454
+ ],
30455
+ "superclass": {
30456
+ "name": "Popover",
30457
+ "module": "/src/components/popover/popover.component"
30458
+ },
30459
+ "tagName": "mdc-toggletip",
30460
+ "jsDoc": "/**\n * A toggletip is triggered by clicking a trigger element.\n *\n * It can contain interactive content and can be closed by\n * clicking outside the toggletip or pressing the escape key.\n *\n * It can have optional close button to close the toggletip.\n *\n * Toggletip component uses `mdc-screenreaderannouncer` internally to\n * announce the toggletip text content with screen readers when the toggletip is shown.\n *\n * `screenreader-announcer-identity` attribute can be used to provide ID of an element\n * in DOM to which announcement elements are added. If not set, a visually hidden\n * div element is created in DOM to which announcement elements are added.\n *\n * Please refer to the `mdc-screenreaderannouncer` component for more details.\n *\n * @dependency mdc-screenreaderannouncer\n * @dependency mdc-button\n *\n * @tagname mdc-toggletip\n *\n * @event shown - (React: onShown) This event is dispatched when the toggletip is shown\n * @event hidden - (React: onHidden) This event is dispatched when the toggletip is hidden\n * @event created - (React: onCreated) This event is dispatched when the toggletip is created (added to the DOM)\n * @event destroyed - (React: onDestroyed) This event is dispatched when the toggletip\n * is destroyed (removed from the DOM)\n *\n * @cssproperty --mdc-toggletip-max-width - The maximum width of the toggletip.\n * @cssproperty --mdc-toggletip-text-color - The text color of the toggletip.\n * @cssproperty --mdc-toggletip-text-color-contrast - The text color of the toggletip\n * when the color is contrast.\n *\n * @slot - Default slot for the toggletip content\n */",
30461
+ "customElement": true
30462
+ }
30463
+ ],
30464
+ "exports": [
30465
+ {
30466
+ "kind": "js",
30467
+ "name": "default",
30468
+ "declaration": {
30469
+ "name": "ToggleTip",
30470
+ "module": "components/toggletip/toggletip.component.js"
30471
+ }
30472
+ }
30473
+ ]
30474
+ },
30475
+ {
30476
+ "kind": "javascript-module",
30477
+ "path": "components/textarea/textarea.component.js",
30478
+ "declarations": [
30479
+ {
30480
+ "kind": "class",
30481
+ "description": "mdc-textarea component, which is used to get the multi-line text input from the user.\nIt contains:\n- label: It is the title of the textarea field.\n- required: A boolean attribute depicting that the textarea field is required.\n- Textarea: It is the multi-line text input field.\n- helper-text: It is the text that provides additional information about the textarea field.\n- max-character-limit: It is the text that shows the character count of the textarea field.\n- Error, Warning, Success, Priority Help Text type: It is the text that provides additional information\n about the textarea field based on the validation state.\n- limitexceeded: It is the event that is dispatched when the character limit exceeds or restored.\n This event exposes 3 properties:\n - currentCharacterCount - the current number of characters in the textarea field,\n - maxCharacterLimit - the maximum number of characters allowed in the textarea field,\n - value - the current value of the textarea field,\n\n**Note**: Consumers must set the help-text-type with 'error' and\nhelp-text attribute with the error message using limitexceeded event.\nThe same help-text value will be used for the validation message to be displayed.",
30482
+ "name": "Textarea",
30483
+ "cssProperties": [
30484
+ {
30485
+ "description": "Border color for the textarea container when disabled",
30486
+ "name": "--mdc-textarea-disabled-border-color"
30487
+ },
30488
+ {
30489
+ "description": "Text color for the textarea field when disabled",
30490
+ "name": "--mdc-textarea-disabled-text-color"
30491
+ },
30492
+ {
30493
+ "description": "Background color for the textarea field when disabled",
30494
+ "name": "--mdc-textarea-disabled-background-color"
30495
+ },
30496
+ {
30497
+ "description": "Text color for the textarea field",
30498
+ "name": "--mdc-textarea-text-color"
30499
+ },
30500
+ {
30501
+ "description": "Background color for the textarea field",
30502
+ "name": "--mdc-textarea-background-color"
30503
+ },
30504
+ {
30505
+ "description": "Border color for the textarea field",
30506
+ "name": "--mdc-textarea-border-color"
30507
+ },
30508
+ {
30509
+ "description": "Text color for the character counter",
30510
+ "name": "--mdc-textarea-text-secondary-normal"
30511
+ },
30512
+ {
30513
+ "description": "Border color for the error related help text",
30514
+ "name": "--mdc-textarea-error-border-color"
30447
30515
  },
30448
30516
  {
30449
- "kind": "field",
30450
- "name": "delay",
30451
- "type": {
30452
- "text": "string"
30453
- },
30454
- "description": "The delay of the show/hide popover.",
30455
- "default": "0,0",
30456
- "attribute": "delay",
30457
- "reflects": true,
30458
- "inheritedFrom": {
30459
- "name": "Popover",
30460
- "module": "components/popover/popover.component.js"
30461
- }
30517
+ "description": "Border color for the warning related help text",
30518
+ "name": "--mdc-textarea-warning-border-color"
30462
30519
  },
30463
30520
  {
30464
- "kind": "field",
30465
- "name": "hideOnEscape",
30466
- "type": {
30467
- "text": "boolean"
30468
- },
30469
- "description": "Hide popover on escape key press.",
30470
- "default": "false",
30471
- "attribute": "hide-on-escape",
30472
- "reflects": true,
30473
- "inheritedFrom": {
30474
- "name": "Popover",
30475
- "module": "components/popover/popover.component.js"
30476
- }
30521
+ "description": "Border color for the success related help text",
30522
+ "name": "--mdc-textarea-success-border-color"
30477
30523
  },
30478
30524
  {
30479
- "kind": "field",
30480
- "name": "hideOnBlur",
30481
- "type": {
30482
- "text": "boolean"
30483
- },
30484
- "description": "Hide popover on blur.",
30485
- "default": "false",
30486
- "attribute": "hide-on-blur",
30487
- "reflects": true,
30488
- "inheritedFrom": {
30489
- "name": "Popover",
30490
- "module": "components/popover/popover.component.js"
30491
- }
30525
+ "description": "Border color for the priority related help text",
30526
+ "name": "--mdc-textarea-primary-border-color"
30527
+ },
30528
+ {
30529
+ "description": "Background color for the textarea container when hover",
30530
+ "name": "--mdc-textarea-hover-background-color"
30531
+ },
30532
+ {
30533
+ "description": "Background color for the textarea container when focused",
30534
+ "name": "--mdc-textarea-focused-background-color"
30492
30535
  },
30536
+ {
30537
+ "description": "Border color for the textarea container when focused",
30538
+ "name": "--mdc-textarea-focused-border-color"
30539
+ }
30540
+ ],
30541
+ "members": [
30493
30542
  {
30494
30543
  "kind": "field",
30495
- "name": "hideOnOutsideClick",
30544
+ "name": "placeholder",
30496
30545
  "type": {
30497
- "text": "boolean"
30546
+ "text": "string | undefined"
30498
30547
  },
30499
- "description": "Hide on outside click of the popover.",
30500
- "default": "false",
30501
- "attribute": "hide-on-outside-click",
30502
- "reflects": true,
30503
- "inheritedFrom": {
30504
- "name": "Popover",
30505
- "module": "components/popover/popover.component.js"
30506
- }
30548
+ "description": "The placeholder text that is displayed when the textarea field is empty.",
30549
+ "attribute": "placeholder"
30507
30550
  },
30508
30551
  {
30509
30552
  "kind": "field",
30510
- "name": "focusBackToTrigger",
30553
+ "name": "readonly",
30511
30554
  "type": {
30512
30555
  "text": "boolean"
30513
30556
  },
30514
- "description": "The focus back to trigger after the popover hide.",
30515
30557
  "default": "false",
30516
- "attribute": "focus-back-to-trigger",
30517
- "reflects": true,
30518
- "inheritedFrom": {
30519
- "name": "Popover",
30520
- "module": "components/popover/popover.component.js"
30521
- }
30558
+ "description": "readonly attribute of the textarea field. If true, the textarea field is read-only.",
30559
+ "attribute": "readonly"
30522
30560
  },
30523
30561
  {
30524
30562
  "kind": "field",
30525
- "name": "backdrop",
30526
- "type": {
30527
- "text": "boolean"
30528
- },
30529
- "description": "Determines whether the popover with backdrop.\nOther than popover and trigger element, the rest of the screen will be covered with a backdrop.",
30530
- "default": "false",
30531
- "attribute": "backdrop",
30532
- "reflects": true,
30533
- "inheritedFrom": {
30534
- "name": "Popover",
30535
- "module": "components/popover/popover.component.js"
30536
- }
30563
+ "name": "rows",
30564
+ "description": "The rows attribute specifies the visible number of lines in a text area.",
30565
+ "default": "5",
30566
+ "attribute": "rows"
30537
30567
  },
30538
30568
  {
30539
30569
  "kind": "field",
30540
- "name": "flip",
30541
- "type": {
30542
- "text": "boolean"
30543
- },
30544
- "description": "Changes the placement of popover to keep it in view when scrolling.",
30545
- "default": "true",
30546
- "attribute": "flip",
30547
- "reflects": true,
30548
- "inheritedFrom": {
30549
- "name": "Popover",
30550
- "module": "components/popover/popover.component.js"
30551
- }
30570
+ "name": "cols",
30571
+ "description": "The cols attribute specifies the visible number of lines in a text area.",
30572
+ "default": "40",
30573
+ "attribute": "cols"
30552
30574
  },
30553
30575
  {
30554
30576
  "kind": "field",
30555
- "name": "size",
30577
+ "name": "wrap",
30556
30578
  "type": {
30557
- "text": "boolean"
30579
+ "text": "WrapType"
30558
30580
  },
30559
- "description": "Changes the size of popover to keep it in view when scrolling.",
30560
- "default": "false",
30561
- "attribute": "size",
30562
- "reflects": true,
30563
- "inheritedFrom": {
30564
- "name": "Popover",
30565
- "module": "components/popover/popover.component.js"
30566
- }
30581
+ "description": "The wrap attribute specifies how the text in a text area is to be wrapped when submitted in a form.",
30582
+ "default": "'soft'",
30583
+ "attribute": "wrap"
30567
30584
  },
30568
30585
  {
30569
30586
  "kind": "field",
30570
- "name": "zIndex",
30587
+ "name": "autocapitalize",
30571
30588
  "type": {
30572
- "text": "number"
30589
+ "text": "AutoCapitalizeType"
30573
30590
  },
30574
- "description": "The z-index of the popover.",
30575
- "default": "1000",
30576
- "attribute": "z-index",
30577
- "reflects": true,
30578
- "inheritedFrom": {
30579
- "name": "Popover",
30580
- "module": "components/popover/popover.component.js"
30581
- }
30591
+ "description": "The autocapitalize attribute of the textarea field.",
30592
+ "default": "'off'",
30593
+ "attribute": "autocapitalize"
30582
30594
  },
30583
30595
  {
30584
30596
  "kind": "field",
30585
- "name": "appendTo",
30597
+ "name": "autocomplete",
30586
30598
  "type": {
30587
- "text": "string"
30599
+ "text": "AutoCompleteType"
30588
30600
  },
30589
- "default": "''",
30590
- "description": "Element ID that the popover append to.",
30591
- "attribute": "append-to",
30592
- "reflects": true,
30593
- "inheritedFrom": {
30594
- "name": "Popover",
30595
- "module": "components/popover/popover.component.js"
30596
- }
30601
+ "description": "The autocomplete attribute of the textarea field.",
30602
+ "default": "'off'",
30603
+ "attribute": "autocomplete"
30597
30604
  },
30598
30605
  {
30599
30606
  "kind": "field",
30600
- "name": "closeButtonAriaLabel",
30607
+ "name": "autofocus",
30601
30608
  "type": {
30602
- "text": "string | null"
30609
+ "text": "boolean"
30603
30610
  },
30604
- "default": "null",
30605
- "description": "aria-label attribute to be set for close button accessibility.",
30606
- "attribute": "close-button-aria-label",
30607
- "reflects": true,
30608
- "inheritedFrom": {
30609
- "name": "Popover",
30610
- "module": "components/popover/popover.component.js"
30611
- }
30611
+ "default": "false",
30612
+ "description": "If true, the textarea field is focused when the component is rendered.",
30613
+ "attribute": "autofocus"
30612
30614
  },
30613
30615
  {
30614
30616
  "kind": "field",
30615
- "name": "role",
30617
+ "name": "dirname",
30616
30618
  "type": {
30617
- "text": "HTMLElement['role']"
30619
+ "text": "string | undefined"
30618
30620
  },
30619
- "description": "Role of the popover",
30620
- "default": "dialog",
30621
- "attribute": "role",
30622
- "reflects": true,
30623
- "inheritedFrom": {
30624
- "name": "Popover",
30625
- "module": "components/popover/popover.component.js"
30626
- }
30621
+ "description": "Specifies the name of the directionality of text for submission purposes (e.g., \"rtl\" for right-to-left).",
30622
+ "attribute": "dirname"
30627
30623
  },
30628
30624
  {
30629
30625
  "kind": "field",
30630
- "name": "ariaLabelledby",
30626
+ "name": "maxlength",
30631
30627
  "type": {
30632
- "text": "string | null"
30628
+ "text": "number | undefined"
30633
30629
  },
30634
- "default": "null",
30635
- "description": "aria-labelledby for an interactive popover only, defaults to the trigger component id.\nUsed in nested cases where the triggerComponent isn't the actual button.",
30636
- "attribute": "aria-labelledby",
30637
- "reflects": true,
30638
- "inheritedFrom": {
30639
- "name": "Popover",
30640
- "module": "components/popover/popover.component.js"
30641
- }
30630
+ "description": "The maximum number of characters that the textarea field can accept.",
30631
+ "attribute": "maxlength"
30642
30632
  },
30643
30633
  {
30644
30634
  "kind": "field",
30645
- "name": "ariaDescribedby",
30635
+ "name": "minlength",
30646
30636
  "type": {
30647
- "text": "string | null"
30637
+ "text": "number | undefined"
30648
30638
  },
30649
- "default": "null",
30650
- "description": "aria-describedby of the popover.",
30651
- "attribute": "aria-describedby",
30652
- "reflects": true,
30653
- "inheritedFrom": {
30654
- "name": "Popover",
30655
- "module": "components/popover/popover.component.js"
30656
- }
30639
+ "description": "The minimum number of characters that the textarea field can accept.",
30640
+ "attribute": "minlength"
30657
30641
  },
30658
30642
  {
30659
30643
  "kind": "field",
30660
- "name": "disableAriaExpanded",
30644
+ "name": "maxCharacterLimit",
30661
30645
  "type": {
30662
- "text": "boolean"
30646
+ "text": "number | undefined"
30663
30647
  },
30664
- "description": "Disable aria-expanded attribute on trigger element.\nMake sure to set this to false when the popover is interactive.",
30665
- "default": "false",
30666
- "attribute": "disable-aria-expanded",
30667
- "reflects": true,
30668
- "inheritedFrom": {
30669
- "name": "Popover",
30670
- "module": "components/popover/popover.component.js"
30671
- }
30648
+ "description": "maximum character limit for the textarea field for character counter.",
30649
+ "attribute": "max-character-limit"
30672
30650
  },
30673
30651
  {
30674
30652
  "kind": "field",
30675
- "name": "arrowElement",
30653
+ "name": "characterLimitExceedingFired",
30676
30654
  "type": {
30677
- "text": "HTMLElement | null"
30655
+ "text": "boolean"
30678
30656
  },
30679
- "privacy": "public",
30680
- "default": "null",
30681
- "inheritedFrom": {
30682
- "name": "Popover",
30683
- "module": "components/popover/popover.component.js"
30684
- }
30657
+ "privacy": "private",
30658
+ "default": "false"
30685
30659
  },
30686
30660
  {
30687
30661
  "kind": "field",
30688
- "name": "triggerElement",
30662
+ "name": "textarea",
30689
30663
  "type": {
30690
- "text": "HTMLElement | null"
30664
+ "text": "HTMLTextAreaElement"
30691
30665
  },
30692
- "privacy": "public",
30693
- "default": "null",
30694
- "inheritedFrom": {
30695
- "name": "Popover",
30696
- "module": "components/popover/popover.component.js"
30697
- }
30666
+ "privacy": "protected",
30667
+ "readonly": true
30698
30668
  },
30699
30669
  {
30700
30670
  "kind": "method",
30701
- "name": "setupTriggerListener",
30702
- "privacy": "private",
30703
- "description": "Sets up the trigger event listeners based on the trigger type.",
30704
- "inheritedFrom": {
30705
- "name": "Popover",
30706
- "module": "components/popover/popover.component.js"
30707
- }
30671
+ "name": "setTextareaValidity",
30672
+ "privacy": "private"
30708
30673
  },
30709
30674
  {
30710
30675
  "kind": "method",
30711
- "name": "removeEventListeners",
30712
- "privacy": "private",
30713
- "description": "Removes the trigger event listeners.",
30714
- "inheritedFrom": {
30715
- "name": "Popover",
30716
- "module": "components/popover/popover.component.js"
30676
+ "name": "handleValueChange",
30677
+ "description": "Handles the value change of the textarea field.\nSets the form value and updates the validity of the textarea field.",
30678
+ "return": {
30679
+ "type": {
30680
+ "text": ""
30681
+ }
30717
30682
  }
30718
30683
  },
30719
30684
  {
30720
- "kind": "field",
30721
- "name": "onOutsidePopoverClick",
30685
+ "kind": "method",
30686
+ "name": "dispatchCharacterOverflowStateChangeEvent",
30722
30687
  "privacy": "private",
30723
- "description": "Handles the outside click event to close the popover.",
30724
- "parameters": [
30725
- {
30726
- "description": "The mouse event.",
30727
- "name": "event"
30688
+ "description": "Dispatches the character overflow state change event.",
30689
+ "return": {
30690
+ "type": {
30691
+ "text": ""
30728
30692
  }
30729
- ],
30730
- "inheritedFrom": {
30731
- "name": "Popover",
30732
- "module": "components/popover/popover.component.js"
30733
30693
  }
30734
30694
  },
30735
30695
  {
30736
- "kind": "field",
30737
- "name": "onEscapeKeydown",
30696
+ "kind": "method",
30697
+ "name": "handleCharacterOverflowStateChange",
30738
30698
  "privacy": "private",
30739
- "description": "Handles the escape keydown event to close the popover.",
30740
- "parameters": [
30741
- {
30742
- "description": "The keyboard event.",
30743
- "name": "event"
30699
+ "description": "Handles the character overflow state change.\nDispatches the character overflow state change event if the character limit is exceeded or restored.",
30700
+ "return": {
30701
+ "type": {
30702
+ "text": ""
30744
30703
  }
30745
- ],
30746
- "inheritedFrom": {
30747
- "name": "Popover",
30748
- "module": "components/popover/popover.component.js"
30749
30704
  }
30750
30705
  },
30751
30706
  {
30752
- "kind": "field",
30753
- "name": "onPopoverFocusOut",
30707
+ "kind": "method",
30708
+ "name": "updateValue",
30754
30709
  "privacy": "private",
30755
- "description": "Handles the popover focus out event.",
30756
- "parameters": [
30757
- {
30758
- "description": "The focus event.",
30759
- "name": "event"
30710
+ "description": "Updates the value of the textarea field.\nSets the form value.",
30711
+ "return": {
30712
+ "type": {
30713
+ "text": ""
30760
30714
  }
30761
- ],
30762
- "inheritedFrom": {
30763
- "name": "Popover",
30764
- "module": "components/popover/popover.component.js"
30765
30715
  }
30766
30716
  },
30767
30717
  {
30768
30718
  "kind": "method",
30769
- "name": "isOpenUpdated",
30719
+ "name": "onChange",
30770
30720
  "privacy": "private",
30771
30721
  "parameters": [
30772
30722
  {
30773
- "name": "oldValue",
30774
- "type": {
30775
- "text": "boolean"
30776
- },
30777
- "description": "The old value of the visible property."
30778
- },
30779
- {
30780
- "name": "newValue",
30723
+ "name": "event",
30781
30724
  "type": {
30782
- "text": "boolean"
30725
+ "text": "Event"
30783
30726
  },
30784
- "description": "The new value of the visible property."
30727
+ "description": "Event which contains information about the value change."
30785
30728
  }
30786
30729
  ],
30787
- "description": "Handles the popover visibility change and position the popover.\nHandles the exit event to close the popover.",
30788
- "inheritedFrom": {
30789
- "name": "Popover",
30790
- "module": "components/popover/popover.component.js"
30791
- }
30730
+ "description": "Handles the change event of the textarea field.\nUpdates the value and sets the validity of the textarea 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"
30792
30731
  },
30793
30732
  {
30794
- "kind": "field",
30795
- "name": "startCloseDelay",
30796
- "privacy": "private",
30797
- "description": "Starts the close delay timer.\nIf the popover is not interactive, it will close the popover after the delay.",
30798
- "inheritedFrom": {
30799
- "name": "Popover",
30800
- "module": "components/popover/popover.component.js"
30801
- }
30733
+ "kind": "method",
30734
+ "name": "renderCharacterCounter",
30735
+ "privacy": "protected"
30736
+ },
30737
+ {
30738
+ "kind": "method",
30739
+ "name": "renderTextareaFooter",
30740
+ "privacy": "protected"
30802
30741
  },
30803
30742
  {
30804
30743
  "kind": "field",
30805
- "name": "cancelCloseDelay",
30806
- "privacy": "private",
30807
- "description": "Cancels the close delay timer.",
30744
+ "name": "name",
30745
+ "type": {
30746
+ "text": "string"
30747
+ },
30748
+ "default": "''",
30749
+ "description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
30750
+ "attribute": "name",
30751
+ "reflects": true,
30808
30752
  "inheritedFrom": {
30809
- "name": "Popover",
30810
- "module": "components/popover/popover.component.js"
30753
+ "name": "FormInternalsMixin",
30754
+ "module": "utils/mixins/FormInternalsMixin.js"
30811
30755
  }
30812
30756
  },
30813
30757
  {
30814
30758
  "kind": "field",
30815
- "name": "showPopover",
30816
- "privacy": "public",
30817
- "description": "Shows the popover.",
30759
+ "name": "value",
30760
+ "type": {
30761
+ "text": "string"
30762
+ },
30763
+ "default": "''",
30764
+ "description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
30765
+ "attribute": "value",
30766
+ "reflects": true,
30818
30767
  "inheritedFrom": {
30819
- "name": "Popover",
30820
- "module": "components/popover/popover.component.js"
30768
+ "name": "FormInternalsMixin",
30769
+ "module": "utils/mixins/FormInternalsMixin.js"
30821
30770
  }
30822
30771
  },
30823
30772
  {
30824
30773
  "kind": "field",
30825
- "name": "hidePopover",
30826
- "privacy": "public",
30827
- "description": "Hides the popover.",
30774
+ "name": "validationMessage",
30775
+ "type": {
30776
+ "text": "string | undefined"
30777
+ },
30778
+ "description": "Custom validation message that will override the default message and displayed when the input is invalid.",
30779
+ "attribute": "validation-message",
30780
+ "reflects": true,
30828
30781
  "inheritedFrom": {
30829
- "name": "Popover",
30830
- "module": "components/popover/popover.component.js"
30782
+ "name": "FormInternalsMixin",
30783
+ "module": "utils/mixins/FormInternalsMixin.js"
30831
30784
  }
30832
30785
  },
30833
30786
  {
30834
30787
  "kind": "field",
30835
- "name": "togglePopoverVisible",
30836
- "privacy": "public",
30837
- "description": "Toggles the popover visibility.",
30788
+ "name": "validity",
30789
+ "type": {
30790
+ "text": "ValidityState"
30791
+ },
30792
+ "readonly": true,
30838
30793
  "inheritedFrom": {
30839
- "name": "Popover",
30840
- "module": "components/popover/popover.component.js"
30794
+ "name": "FormInternalsMixin",
30795
+ "module": "utils/mixins/FormInternalsMixin.js"
30841
30796
  }
30842
30797
  },
30843
30798
  {
30844
- "kind": "method",
30845
- "name": "handleCreatePopoverFirstUpdate",
30846
- "privacy": "private",
30847
- "description": "Sets the focusable elements inside the popover.",
30799
+ "kind": "field",
30800
+ "name": "willValidate",
30801
+ "readonly": true,
30848
30802
  "inheritedFrom": {
30849
- "name": "Popover",
30850
- "module": "components/popover/popover.component.js"
30803
+ "name": "FormInternalsMixin",
30804
+ "module": "utils/mixins/FormInternalsMixin.js"
30851
30805
  }
30852
30806
  },
30853
30807
  {
30854
30808
  "kind": "method",
30855
- "name": "positionPopover",
30856
- "privacy": "private",
30857
- "description": "Positions the popover based on the trigger element.\nIt also handles the flip, size and arrow placement.\nIt uses the floating-ui/dom library to calculate the position.",
30809
+ "name": "setValidity",
30810
+ "description": "Sets the validity of the input field based on the input field's validity.",
30811
+ "return": {
30812
+ "type": {
30813
+ "text": ""
30814
+ }
30815
+ },
30858
30816
  "inheritedFrom": {
30859
- "name": "Popover",
30860
- "module": "components/popover/popover.component.js"
30817
+ "name": "FormInternalsMixin",
30818
+ "module": "utils/mixins/FormInternalsMixin.js"
30861
30819
  }
30862
30820
  },
30863
30821
  {
30864
- "kind": "field",
30865
- "name": "utils",
30866
- "default": "new PopoverUtils(this)",
30867
- "inheritedFrom": {
30868
- "name": "Popover",
30869
- "module": "components/popover/popover.component.js"
30870
- }
30871
- }
30872
- ],
30873
- "events": [
30874
- {
30875
- "description": "(React: onShown) This event is dispatched when the toggletip is shown",
30876
- "name": "shown",
30877
- "reactName": "onShown",
30822
+ "kind": "method",
30823
+ "name": "checkValidity",
30824
+ "return": {
30825
+ "type": {
30826
+ "text": "boolean"
30827
+ }
30828
+ },
30878
30829
  "inheritedFrom": {
30879
- "name": "Popover",
30880
- "module": "src/components/popover/popover.component.ts"
30830
+ "name": "FormInternalsMixin",
30831
+ "module": "utils/mixins/FormInternalsMixin.js"
30881
30832
  }
30882
30833
  },
30883
30834
  {
30884
- "description": "(React: onHidden) This event is dispatched when the toggletip is hidden",
30885
- "name": "hidden",
30886
- "reactName": "onHidden",
30835
+ "kind": "method",
30836
+ "name": "reportValidity",
30887
30837
  "inheritedFrom": {
30888
- "name": "Popover",
30889
- "module": "src/components/popover/popover.component.ts"
30838
+ "name": "FormInternalsMixin",
30839
+ "module": "utils/mixins/FormInternalsMixin.js"
30890
30840
  }
30891
30841
  },
30892
30842
  {
30893
- "description": "(React: onCreated) This event is dispatched when the toggletip is created (added to the DOM)",
30894
- "name": "created",
30895
- "reactName": "onCreated",
30843
+ "kind": "field",
30844
+ "name": "dataAriaLabel",
30845
+ "type": {
30846
+ "text": "string | null"
30847
+ },
30848
+ "default": "null",
30849
+ "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
30850
+ "attribute": "data-aria-label",
30851
+ "reflects": true,
30896
30852
  "inheritedFrom": {
30897
- "name": "Popover",
30898
- "module": "src/components/popover/popover.component.ts"
30853
+ "name": "DataAriaLabelMixin",
30854
+ "module": "utils/mixins/DataAriaLabelMixin.js"
30899
30855
  }
30900
30856
  },
30901
30857
  {
30902
- "description": "(React: onDestroyed) This event is dispatched when the toggletip is destroyed (removed from the DOM)",
30903
- "name": "destroyed",
30904
- "reactName": "onDestroyed",
30905
- "inheritedFrom": {
30906
- "name": "Popover",
30907
- "module": "src/components/popover/popover.component.ts"
30908
- }
30909
- }
30910
- ],
30911
- "attributes": [
30912
- {
30913
- "name": "screenreader-announcer-identity",
30858
+ "kind": "field",
30859
+ "name": "disabled",
30914
30860
  "type": {
30915
- "text": "string"
30861
+ "text": "boolean | undefined"
30916
30862
  },
30917
- "default": "''",
30918
- "description": "Set this attribute with the id of the element in the DOM, to which announcement\nelements will be appended.\nIf an id is provided, the announcement elements will be appended to this element.\nIf id is not provided, a visually hidden div element will be created in the DOM.\n\nPlease refer to the `mdc-screenreaderannouncer` component for more details.",
30919
- "fieldName": "screenreaderAnnouncerIdentity"
30863
+ "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
30864
+ "default": "undefined",
30865
+ "attribute": "disabled",
30866
+ "reflects": true,
30867
+ "inheritedFrom": {
30868
+ "name": "FormfieldWrapper",
30869
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
30870
+ }
30920
30871
  },
30921
30872
  {
30922
- "name": "enabledFocusTrap",
30873
+ "kind": "field",
30874
+ "name": "label",
30923
30875
  "type": {
30924
- "text": "boolean"
30876
+ "text": "string | undefined"
30925
30877
  },
30926
- "default": "false",
30927
- "description": "Determines whether the focus trap is enabled.\nIf true, focus will be restricted to the content within this component.",
30928
- "fieldName": "enabledFocusTrap",
30878
+ "description": "The label of the input field. It is linked to the input field using the `for` attribute.",
30879
+ "attribute": "label",
30880
+ "reflects": true,
30929
30881
  "inheritedFrom": {
30930
- "name": "Popover",
30931
- "module": "src/components/popover/popover.component.ts"
30882
+ "name": "FormfieldWrapper",
30883
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
30932
30884
  }
30933
30885
  },
30934
30886
  {
30935
- "name": "enabledPreventScroll",
30887
+ "kind": "field",
30888
+ "name": "required",
30936
30889
  "type": {
30937
30890
  "text": "boolean"
30938
30891
  },
30939
30892
  "default": "false",
30940
- "description": "Prevent outside scrolling when element is shown.",
30941
- "fieldName": "enabledPreventScroll",
30893
+ "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
30894
+ "attribute": "required",
30895
+ "reflects": true,
30942
30896
  "inheritedFrom": {
30943
- "name": "Popover",
30944
- "module": "src/components/popover/popover.component.ts"
30897
+ "name": "FormfieldWrapper",
30898
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
30945
30899
  }
30946
30900
  },
30947
30901
  {
30902
+ "kind": "field",
30948
30903
  "name": "id",
30949
30904
  "type": {
30950
30905
  "text": "string"
30951
30906
  },
30952
30907
  "default": "''",
30953
- "description": "The unique ID of the popover.",
30954
- "fieldName": "id",
30908
+ "description": "The unique id of the input field. It is used to link the input field with the label.",
30909
+ "attribute": "id",
30955
30910
  "inheritedFrom": {
30956
- "name": "Popover",
30957
- "module": "src/components/popover/popover.component.ts"
30911
+ "name": "FormfieldWrapper",
30912
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
30958
30913
  }
30959
30914
  },
30960
30915
  {
30961
- "name": "triggerID",
30916
+ "kind": "field",
30917
+ "name": "helpTextType",
30962
30918
  "type": {
30963
- "text": "string"
30919
+ "text": "ValidationType"
30964
30920
  },
30965
- "default": "''",
30966
- "description": "The ID of the element that triggers the popover.\nThis attribute is required for the popover to work.",
30967
- "fieldName": "triggerID",
30921
+ "description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
30922
+ "attribute": "help-text-type",
30923
+ "reflects": true,
30968
30924
  "inheritedFrom": {
30969
- "name": "Popover",
30970
- "module": "src/components/popover/popover.component.ts"
30925
+ "name": "FormfieldWrapper",
30926
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
30971
30927
  }
30972
30928
  },
30973
30929
  {
30974
- "name": "trigger",
30930
+ "kind": "field",
30931
+ "name": "helpText",
30975
30932
  "type": {
30976
- "text": "PopoverTrigger"
30933
+ "text": "string | undefined"
30977
30934
  },
30978
- "description": "Determines the events that cause the Popover to show.\nMultiple event names should be separated by spaces.\nFor example to allow both click and hover, use 'click mouseenter' as the trigger.\n- **click**\n- **mouseenter**\n- **focusin**\n- **manual**",
30979
- "default": "click",
30980
- "fieldName": "trigger",
30935
+ "description": "The help text that is displayed below the input field.",
30936
+ "attribute": "help-text",
30937
+ "reflects": true,
30981
30938
  "inheritedFrom": {
30982
- "name": "Popover",
30983
- "module": "src/components/popover/popover.component.ts"
30939
+ "name": "FormfieldWrapper",
30940
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
30984
30941
  }
30985
30942
  },
30986
30943
  {
30987
- "name": "placement",
30988
- "type": {
30989
- "text": "PopoverPlacement"
30944
+ "kind": "method",
30945
+ "name": "renderLabelElement",
30946
+ "privacy": "protected",
30947
+ "description": "creates the label element when the label property is set.\nid is used to link the label with the input field.",
30948
+ "return": {
30949
+ "type": {
30950
+ "text": ""
30951
+ }
30990
30952
  },
30991
- "description": "The placement of the popover.\n- **top**\n- **top-start**\n- **top-end**\n- **bottom**\n- **bottom-start**\n- **bottom-end**\n- **left**\n- **left-start**\n- **left-end**\n- **right**\n- **right-start**\n- **right-end**",
30992
- "default": "bottom",
30993
- "fieldName": "placement",
30994
30953
  "inheritedFrom": {
30995
- "name": "Popover",
30996
- "module": "src/components/popover/popover.component.ts"
30954
+ "name": "FormfieldWrapper",
30955
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
30997
30956
  }
30998
30957
  },
30999
30958
  {
31000
- "name": "color",
31001
- "type": {
31002
- "text": "PopoverColor"
30959
+ "kind": "method",
30960
+ "name": "renderHelpTextIcon",
30961
+ "privacy": "protected",
30962
+ "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.",
30963
+ "return": {
30964
+ "type": {
30965
+ "text": ""
30966
+ }
31003
30967
  },
31004
- "description": "Color of the popover\n- **tonal**\n- **contrast**",
31005
- "default": "tonal",
31006
- "fieldName": "color",
31007
30968
  "inheritedFrom": {
31008
- "name": "Popover",
31009
- "module": "src/components/popover/popover.component.ts"
30969
+ "name": "FormfieldWrapper",
30970
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
31010
30971
  }
31011
30972
  },
31012
30973
  {
31013
- "name": "visible",
31014
- "type": {
31015
- "text": "boolean"
30974
+ "kind": "method",
30975
+ "name": "renderHelpText",
30976
+ "privacy": "protected",
30977
+ "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.",
30978
+ "return": {
30979
+ "type": {
30980
+ "text": ""
30981
+ }
31016
30982
  },
31017
- "description": "The visibility of the popover.",
31018
- "default": "false",
31019
- "fieldName": "visible",
31020
30983
  "inheritedFrom": {
31021
- "name": "Popover",
31022
- "module": "src/components/popover/popover.component.ts"
30984
+ "name": "FormfieldWrapper",
30985
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
31023
30986
  }
31024
30987
  },
31025
30988
  {
31026
- "name": "offset",
31027
- "type": {
31028
- "text": "number"
30989
+ "kind": "method",
30990
+ "name": "renderLabel",
30991
+ "privacy": "protected",
30992
+ "description": "renders the mdc-label-text container that contains the label and labelInfoToggleTip.",
30993
+ "return": {
30994
+ "type": {
30995
+ "text": ""
30996
+ }
31029
30997
  },
31030
- "description": "The offset of the popover.",
31031
- "default": "4",
31032
- "fieldName": "offset",
31033
30998
  "inheritedFrom": {
31034
- "name": "Popover",
31035
- "module": "src/components/popover/popover.component.ts"
30999
+ "name": "FormfieldWrapper",
31000
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
31036
31001
  }
31037
31002
  },
31038
31003
  {
31039
- "name": "focus-trap",
31040
- "type": {
31041
- "text": "boolean"
31004
+ "kind": "method",
31005
+ "name": "renderHelperText",
31006
+ "privacy": "protected",
31007
+ "description": "renders the mdc-help-text container that contains the helpertext icon and helpertext.",
31008
+ "return": {
31009
+ "type": {
31010
+ "text": ""
31011
+ }
31042
31012
  },
31043
- "description": "Determines whether the focus trap is enabled.\nIf true, focus will be restricted to the content within this component.",
31044
- "default": "false",
31045
- "fieldName": "focusTrap",
31046
31013
  "inheritedFrom": {
31047
- "name": "Popover",
31048
- "module": "src/components/popover/popover.component.ts"
31014
+ "name": "FormfieldWrapper",
31015
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
31049
31016
  }
31050
- },
31017
+ }
31018
+ ],
31019
+ "events": [
31051
31020
  {
31052
- "name": "prevent-scroll",
31021
+ "name": "limitexceeded",
31053
31022
  "type": {
31054
- "text": "boolean"
31023
+ "text": "CustomEvent"
31055
31024
  },
31056
- "description": "Prevent outside scrolling when popover show.",
31057
- "default": "false",
31058
- "fieldName": "preventScroll",
31059
- "inheritedFrom": {
31060
- "name": "Popover",
31061
- "module": "src/components/popover/popover.component.ts"
31025
+ "description": "(React: onLimitExceeded) This event is dispatched once when the character limit exceeds or restored.",
31026
+ "reactName": "onLimitExceeded"
31027
+ },
31028
+ {
31029
+ "type": {
31030
+ "text": "EventConstructor"
31062
31031
  }
31063
31032
  },
31064
31033
  {
31065
- "name": "show-arrow",
31034
+ "description": "(React: onInput) This event is dispatched when the value of the textarea field changes (every press).",
31035
+ "name": "input",
31036
+ "reactName": "onInput"
31037
+ },
31038
+ {
31039
+ "description": "(React: onChange) This event is dispatched when the value of the textarea field changes (on blur).",
31040
+ "name": "change",
31041
+ "reactName": "onChange"
31042
+ },
31043
+ {
31044
+ "description": "(React: onFocus) This event is dispatched when the textarea receives focus.",
31045
+ "name": "focus",
31046
+ "reactName": "onFocus"
31047
+ },
31048
+ {
31049
+ "description": "(React: onBlur) This event is dispatched when the textarea loses focus.",
31050
+ "name": "blur",
31051
+ "reactName": "onBlur"
31052
+ }
31053
+ ],
31054
+ "attributes": [
31055
+ {
31056
+ "name": "placeholder",
31057
+ "type": {
31058
+ "text": "string | undefined"
31059
+ },
31060
+ "description": "The placeholder text that is displayed when the textarea field is empty.",
31061
+ "fieldName": "placeholder"
31062
+ },
31063
+ {
31064
+ "name": "readonly",
31066
31065
  "type": {
31067
31066
  "text": "boolean"
31068
31067
  },
31069
- "description": "The arrow visibility of the popover.",
31070
31068
  "default": "false",
31071
- "fieldName": "showArrow",
31072
- "inheritedFrom": {
31073
- "name": "Popover",
31074
- "module": "src/components/popover/popover.component.ts"
31075
- }
31069
+ "description": "readonly attribute of the textarea field. If true, the textarea field is read-only.",
31070
+ "fieldName": "readonly"
31071
+ },
31072
+ {
31073
+ "name": "rows",
31074
+ "description": "The rows attribute specifies the visible number of lines in a text area.",
31075
+ "default": "5",
31076
+ "fieldName": "rows"
31077
+ },
31078
+ {
31079
+ "name": "cols",
31080
+ "description": "The cols attribute specifies the visible number of lines in a text area.",
31081
+ "default": "40",
31082
+ "fieldName": "cols"
31083
+ },
31084
+ {
31085
+ "name": "wrap",
31086
+ "type": {
31087
+ "text": "WrapType"
31088
+ },
31089
+ "description": "The wrap attribute specifies how the text in a text area is to be wrapped when submitted in a form.",
31090
+ "default": "'soft'",
31091
+ "fieldName": "wrap"
31092
+ },
31093
+ {
31094
+ "name": "autocapitalize",
31095
+ "type": {
31096
+ "text": "AutoCapitalizeType"
31097
+ },
31098
+ "description": "The autocapitalize attribute of the textarea field.",
31099
+ "default": "'off'",
31100
+ "fieldName": "autocapitalize"
31076
31101
  },
31077
31102
  {
31078
- "name": "close-button",
31103
+ "name": "autocomplete",
31079
31104
  "type": {
31080
- "text": "boolean"
31105
+ "text": "AutoCompleteType"
31081
31106
  },
31082
- "description": "The close button visibility of the popover.",
31083
- "default": "false",
31084
- "fieldName": "closeButton",
31085
- "inheritedFrom": {
31086
- "name": "Popover",
31087
- "module": "src/components/popover/popover.component.ts"
31088
- }
31107
+ "description": "The autocomplete attribute of the textarea field.",
31108
+ "default": "'off'",
31109
+ "fieldName": "autocomplete"
31089
31110
  },
31090
31111
  {
31091
- "name": "interactive",
31112
+ "name": "autofocus",
31092
31113
  "type": {
31093
31114
  "text": "boolean"
31094
31115
  },
31095
- "description": "Determines whether the popover is interactive。",
31096
31116
  "default": "false",
31097
- "fieldName": "interactive",
31098
- "inheritedFrom": {
31099
- "name": "Popover",
31100
- "module": "src/components/popover/popover.component.ts"
31101
- }
31117
+ "description": "If true, the textarea field is focused when the component is rendered.",
31118
+ "fieldName": "autofocus"
31102
31119
  },
31103
31120
  {
31104
- "name": "delay",
31121
+ "name": "dirname",
31105
31122
  "type": {
31106
- "text": "string"
31123
+ "text": "string | undefined"
31107
31124
  },
31108
- "description": "The delay of the show/hide popover.",
31109
- "default": "0,0",
31110
- "fieldName": "delay",
31111
- "inheritedFrom": {
31112
- "name": "Popover",
31113
- "module": "src/components/popover/popover.component.ts"
31114
- }
31125
+ "description": "Specifies the name of the directionality of text for submission purposes (e.g., \"rtl\" for right-to-left).",
31126
+ "fieldName": "dirname"
31115
31127
  },
31116
31128
  {
31117
- "name": "hide-on-escape",
31129
+ "name": "maxlength",
31118
31130
  "type": {
31119
- "text": "boolean"
31131
+ "text": "number | undefined"
31120
31132
  },
31121
- "description": "Hide popover on escape key press.",
31122
- "default": "false",
31123
- "fieldName": "hideOnEscape",
31124
- "inheritedFrom": {
31125
- "name": "Popover",
31126
- "module": "src/components/popover/popover.component.ts"
31127
- }
31133
+ "description": "The maximum number of characters that the textarea field can accept.",
31134
+ "fieldName": "maxlength"
31128
31135
  },
31129
31136
  {
31130
- "name": "hide-on-blur",
31137
+ "name": "minlength",
31131
31138
  "type": {
31132
- "text": "boolean"
31139
+ "text": "number | undefined"
31133
31140
  },
31134
- "description": "Hide popover on blur.",
31135
- "default": "false",
31136
- "fieldName": "hideOnBlur",
31137
- "inheritedFrom": {
31138
- "name": "Popover",
31139
- "module": "src/components/popover/popover.component.ts"
31140
- }
31141
+ "description": "The minimum number of characters that the textarea field can accept.",
31142
+ "fieldName": "minlength"
31141
31143
  },
31142
31144
  {
31143
- "name": "hide-on-outside-click",
31145
+ "name": "max-character-limit",
31144
31146
  "type": {
31145
- "text": "boolean"
31147
+ "text": "number | undefined"
31146
31148
  },
31147
- "description": "Hide on outside click of the popover.",
31148
- "default": "false",
31149
- "fieldName": "hideOnOutsideClick",
31150
- "inheritedFrom": {
31151
- "name": "Popover",
31152
- "module": "src/components/popover/popover.component.ts"
31153
- }
31149
+ "description": "maximum character limit for the textarea field for character counter.",
31150
+ "fieldName": "maxCharacterLimit"
31154
31151
  },
31155
31152
  {
31156
- "name": "focus-back-to-trigger",
31153
+ "name": "name",
31157
31154
  "type": {
31158
- "text": "boolean"
31155
+ "text": "string"
31159
31156
  },
31160
- "description": "The focus back to trigger after the popover hide.",
31161
- "default": "false",
31162
- "fieldName": "focusBackToTrigger",
31157
+ "default": "''",
31158
+ "description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
31159
+ "fieldName": "name",
31163
31160
  "inheritedFrom": {
31164
- "name": "Popover",
31165
- "module": "src/components/popover/popover.component.ts"
31161
+ "name": "FormInternalsMixin",
31162
+ "module": "src/utils/mixins/FormInternalsMixin.ts"
31166
31163
  }
31167
31164
  },
31168
31165
  {
31169
- "name": "backdrop",
31166
+ "name": "value",
31170
31167
  "type": {
31171
- "text": "boolean"
31168
+ "text": "string"
31172
31169
  },
31173
- "description": "Determines whether the popover with backdrop.\nOther than popover and trigger element, the rest of the screen will be covered with a backdrop.",
31174
- "default": "false",
31175
- "fieldName": "backdrop",
31170
+ "default": "''",
31171
+ "description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
31172
+ "fieldName": "value",
31176
31173
  "inheritedFrom": {
31177
- "name": "Popover",
31178
- "module": "src/components/popover/popover.component.ts"
31174
+ "name": "FormInternalsMixin",
31175
+ "module": "src/utils/mixins/FormInternalsMixin.ts"
31179
31176
  }
31180
31177
  },
31181
31178
  {
31182
- "name": "flip",
31179
+ "name": "validation-message",
31183
31180
  "type": {
31184
- "text": "boolean"
31181
+ "text": "string | undefined"
31185
31182
  },
31186
- "description": "Changes the placement of popover to keep it in view when scrolling.",
31187
- "default": "true",
31188
- "fieldName": "flip",
31183
+ "description": "Custom validation message that will override the default message and displayed when the input is invalid.",
31184
+ "fieldName": "validationMessage",
31189
31185
  "inheritedFrom": {
31190
- "name": "Popover",
31191
- "module": "src/components/popover/popover.component.ts"
31186
+ "name": "FormInternalsMixin",
31187
+ "module": "src/utils/mixins/FormInternalsMixin.ts"
31192
31188
  }
31193
31189
  },
31194
31190
  {
31195
- "name": "size",
31191
+ "name": "data-aria-label",
31196
31192
  "type": {
31197
- "text": "boolean"
31193
+ "text": "string | null"
31198
31194
  },
31199
- "description": "Changes the size of popover to keep it in view when scrolling.",
31200
- "default": "false",
31201
- "fieldName": "size",
31195
+ "default": "null",
31196
+ "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
31197
+ "fieldName": "dataAriaLabel",
31202
31198
  "inheritedFrom": {
31203
- "name": "Popover",
31204
- "module": "src/components/popover/popover.component.ts"
31199
+ "name": "DataAriaLabelMixin",
31200
+ "module": "src/utils/mixins/DataAriaLabelMixin.ts"
31205
31201
  }
31206
31202
  },
31207
31203
  {
31208
- "name": "z-index",
31204
+ "name": "disabled",
31209
31205
  "type": {
31210
- "text": "number"
31206
+ "text": "boolean | undefined"
31211
31207
  },
31212
- "description": "The z-index of the popover.",
31213
- "default": "1000",
31214
- "fieldName": "zIndex",
31208
+ "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
31209
+ "default": "undefined",
31210
+ "fieldName": "disabled",
31215
31211
  "inheritedFrom": {
31216
- "name": "Popover",
31217
- "module": "src/components/popover/popover.component.ts"
31212
+ "name": "FormfieldWrapper",
31213
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
31218
31214
  }
31219
31215
  },
31220
31216
  {
31221
- "name": "append-to",
31217
+ "name": "label",
31222
31218
  "type": {
31223
- "text": "string"
31219
+ "text": "string | undefined"
31224
31220
  },
31225
- "default": "''",
31226
- "description": "Element ID that the popover append to.",
31227
- "fieldName": "appendTo",
31221
+ "description": "The label of the input field. It is linked to the input field using the `for` attribute.",
31222
+ "fieldName": "label",
31228
31223
  "inheritedFrom": {
31229
- "name": "Popover",
31230
- "module": "src/components/popover/popover.component.ts"
31224
+ "name": "FormfieldWrapper",
31225
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
31231
31226
  }
31232
31227
  },
31233
31228
  {
31234
- "name": "close-button-aria-label",
31229
+ "name": "required",
31235
31230
  "type": {
31236
- "text": "string | null"
31231
+ "text": "boolean"
31237
31232
  },
31238
- "default": "null",
31239
- "description": "aria-label attribute to be set for close button accessibility.",
31240
- "fieldName": "closeButtonAriaLabel",
31233
+ "default": "false",
31234
+ "description": "The required attribute to indicate that the input field is required.\nIt is used to append a required indicator (*) to the label.",
31235
+ "fieldName": "required",
31241
31236
  "inheritedFrom": {
31242
- "name": "Popover",
31243
- "module": "src/components/popover/popover.component.ts"
31237
+ "name": "FormfieldWrapper",
31238
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
31244
31239
  }
31245
31240
  },
31246
31241
  {
31247
- "name": "role",
31242
+ "name": "id",
31248
31243
  "type": {
31249
- "text": "HTMLElement['role']"
31244
+ "text": "string"
31250
31245
  },
31251
- "description": "Role of the popover",
31252
- "default": "dialog",
31253
- "fieldName": "role",
31246
+ "default": "''",
31247
+ "description": "The unique id of the input field. It is used to link the input field with the label.",
31248
+ "fieldName": "id",
31254
31249
  "inheritedFrom": {
31255
- "name": "Popover",
31256
- "module": "src/components/popover/popover.component.ts"
31250
+ "name": "FormfieldWrapper",
31251
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
31257
31252
  }
31258
31253
  },
31259
31254
  {
31260
- "name": "aria-labelledby",
31255
+ "name": "help-text-type",
31261
31256
  "type": {
31262
- "text": "string | null"
31257
+ "text": "ValidationType"
31263
31258
  },
31264
- "default": "null",
31265
- "description": "aria-labelledby for an interactive popover only, defaults to the trigger component id.\nUsed in nested cases where the triggerComponent isn't the actual button.",
31266
- "fieldName": "ariaLabelledby",
31259
+ "description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
31260
+ "fieldName": "helpTextType",
31267
31261
  "inheritedFrom": {
31268
- "name": "Popover",
31269
- "module": "src/components/popover/popover.component.ts"
31262
+ "name": "FormfieldWrapper",
31263
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
31270
31264
  }
31271
31265
  },
31272
31266
  {
31273
- "name": "aria-describedby",
31267
+ "name": "help-text",
31274
31268
  "type": {
31275
- "text": "string | null"
31269
+ "text": "string | undefined"
31276
31270
  },
31277
- "default": "null",
31278
- "description": "aria-describedby of the popover.",
31279
- "fieldName": "ariaDescribedby",
31271
+ "description": "The help text that is displayed below the input field.",
31272
+ "fieldName": "helpText",
31280
31273
  "inheritedFrom": {
31281
- "name": "Popover",
31282
- "module": "src/components/popover/popover.component.ts"
31274
+ "name": "FormfieldWrapper",
31275
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
31283
31276
  }
31277
+ }
31278
+ ],
31279
+ "mixins": [
31280
+ {
31281
+ "name": "FormInternalsMixin",
31282
+ "module": "/src/utils/mixins/FormInternalsMixin"
31284
31283
  },
31285
31284
  {
31286
- "name": "disable-aria-expanded",
31287
- "type": {
31288
- "text": "boolean"
31289
- },
31290
- "description": "Disable aria-expanded attribute on trigger element.\nMake sure to set this to false when the popover is interactive.",
31291
- "default": "false",
31292
- "fieldName": "disableAriaExpanded",
31293
- "inheritedFrom": {
31294
- "name": "Popover",
31295
- "module": "src/components/popover/popover.component.ts"
31296
- }
31285
+ "name": "DataAriaLabelMixin",
31286
+ "module": "/src/utils/mixins/DataAriaLabelMixin"
31297
31287
  }
31298
31288
  ],
31299
31289
  "superclass": {
31300
- "name": "Popover",
31301
- "module": "/src/components/popover/popover.component"
31290
+ "name": "FormfieldWrapper",
31291
+ "module": "/src/components/formfieldwrapper"
31302
31292
  },
31303
- "tagName": "mdc-toggletip",
31304
- "jsDoc": "/**\n * A toggletip is triggered by clicking a trigger element.\n *\n * It can contain interactive content and can be closed by\n * clicking outside the toggletip or pressing the escape key.\n *\n * It can have optional close button to close the toggletip.\n *\n * Toggletip component uses `mdc-screenreaderannouncer` internally to\n * announce the toggletip text content with screen readers when the toggletip is shown.\n *\n * `screenreader-announcer-identity` attribute can be used to provide ID of an element\n * in DOM to which announcement elements are added. If not set, a visually hidden\n * div element is created in DOM to which announcement elements are added.\n *\n * Please refer to the `mdc-screenreaderannouncer` component for more details.\n *\n * @dependency mdc-screenreaderannouncer\n * @dependency mdc-button\n *\n * @tagname mdc-toggletip\n *\n * @event shown - (React: onShown) This event is dispatched when the toggletip is shown\n * @event hidden - (React: onHidden) This event is dispatched when the toggletip is hidden\n * @event created - (React: onCreated) This event is dispatched when the toggletip is created (added to the DOM)\n * @event destroyed - (React: onDestroyed) This event is dispatched when the toggletip\n * is destroyed (removed from the DOM)\n *\n * @cssproperty --mdc-toggletip-max-width - The maximum width of the toggletip.\n * @cssproperty --mdc-toggletip-text-color - The text color of the toggletip.\n * @cssproperty --mdc-toggletip-text-color-contrast - The text color of the toggletip\n * when the color is contrast.\n *\n * @slot - Default slot for the toggletip content\n */",
31305
- "customElement": true
31293
+ "tagName": "mdc-textarea",
31294
+ "jsDoc": "/**\n * mdc-textarea component, which is used to get the multi-line text input from the user.\n * It contains:\n * - label: It is the title of the textarea field.\n * - required: A boolean attribute depicting that the textarea field is required.\n * - Textarea: It is the multi-line text input field.\n * - helper-text: It is the text that provides additional information about the textarea field.\n * - max-character-limit: It is the text that shows the character count of the textarea field.\n * - Error, Warning, Success, Priority Help Text type: It is the text that provides additional information\n * about the textarea field based on the validation state.\n * - limitexceeded: It is the event that is dispatched when the character limit exceeds or restored.\n * This event exposes 3 properties:\n * - currentCharacterCount - the current number of characters in the textarea field,\n * - maxCharacterLimit - the maximum number of characters allowed in the textarea field,\n * - value - the current value of the textarea field,\n *\n * **Note**: Consumers must set the help-text-type with 'error' and\n * help-text attribute with the error message using limitexceeded event.\n * The same help-text value will be used for the validation message to be displayed.\n *\n * @tagname mdc-textarea\n *\n * @event input - (React: onInput) This event is dispatched when the value of the textarea field changes (every press).\n * @event change - (React: onChange) This event is dispatched when the value of the textarea field changes (on blur).\n * @event focus - (React: onFocus) This event is dispatched when the textarea receives focus.\n * @event blur - (React: onBlur) This event is dispatched when the textarea loses focus.\n * @event limitexceeded - (React: onLimitExceeded) This event is dispatched once when the character limit\n * exceeds or restored.\n *\n *\n * @dependency mdc-icon\n * @dependency mdc-text\n * @dependency mdc-button\n *\n * @cssproperty --mdc-textarea-disabled-border-color - Border color for the textarea container when disabled\n * @cssproperty --mdc-textarea-disabled-text-color - Text color for the textarea field when disabled\n * @cssproperty --mdc-textarea-disabled-background-color - Background color for the textarea field when disabled\n * @cssproperty --mdc-textarea-text-color - Text color for the textarea field\n * @cssproperty --mdc-textarea-background-color - Background color for the textarea field\n * @cssproperty --mdc-textarea-border-color - Border color for the textarea field\n * @cssproperty --mdc-textarea-text-secondary-normal - Text color for the character counter\n * @cssproperty --mdc-textarea-error-border-color - Border color for the error related help text\n * @cssproperty --mdc-textarea-warning-border-color - Border color for the warning related help text\n * @cssproperty --mdc-textarea-success-border-color - Border color for the success related help text\n * @cssproperty --mdc-textarea-primary-border-color - Border color for the priority related help text\n * @cssproperty --mdc-textarea-hover-background-color - Background color for the textarea container when hover\n * @cssproperty --mdc-textarea-focused-background-color - Background color for the textarea container when focused\n * @cssproperty --mdc-textarea-focused-border-color - Border color for the textarea container when focused\n */",
31295
+ "customElement": true,
31296
+ "slots": [
31297
+ {
31298
+ "description": "slot to add the label info icon",
31299
+ "name": "label-info",
31300
+ "inheritedFrom": {
31301
+ "name": "FormfieldWrapper",
31302
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
31303
+ }
31304
+ }
31305
+ ]
31306
31306
  }
31307
31307
  ],
31308
31308
  "exports": [
@@ -31310,8 +31310,8 @@
31310
31310
  "kind": "js",
31311
31311
  "name": "default",
31312
31312
  "declaration": {
31313
- "name": "ToggleTip",
31314
- "module": "components/toggletip/toggletip.component.js"
31313
+ "name": "Textarea",
31314
+ "module": "components/textarea/textarea.component.js"
31315
31315
  }
31316
31316
  }
31317
31317
  ]