@momentum-design/components 0.39.6 → 0.41.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -14933,946 +14933,877 @@
14933
14933
  },
14934
14934
  {
14935
14935
  "kind": "javascript-module",
14936
- "path": "components/tooltip/tooltip.component.js",
14936
+ "path": "components/toggle/toggle.component.js",
14937
14937
  "declarations": [
14938
14938
  {
14939
14939
  "kind": "class",
14940
- "description": "A tooltip is triggered by mouse hover or by keyboard focus\nand will disappear upon mouse exit or focus change.\n\nNote: Tooltips cannot contain content that can be focused or interacted with.",
14941
- "name": "Tooltip",
14940
+ "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.",
14941
+ "name": "Toggle",
14942
14942
  "cssProperties": [
14943
14943
  {
14944
- "description": "The maximum width of the tooltip.",
14945
- "name": "--mdc-tooltip-max-width"
14944
+ "description": "width of the toggle",
14945
+ "name": "--mdc-toggle-width"
14946
14946
  },
14947
14947
  {
14948
- "description": "The padding of the tooltip.",
14949
- "name": "--mdc-tooltip-padding"
14948
+ "description": "height of the toggle",
14949
+ "name": "--mdc-toggle-height"
14950
14950
  },
14951
14951
  {
14952
- "description": "The text color of the tooltip.",
14953
- "name": "--mdc-tooltip-text-color"
14952
+ "description": "width of the toggle when it's size is compact",
14953
+ "name": "--mdc-toggle-width-compact"
14954
14954
  },
14955
14955
  {
14956
- "description": "The text color of the tooltip when the color is contrast.",
14957
- "name": "--mdc-tooltip-text-color-contrast"
14956
+ "description": "height of the toggle when it's size is compact",
14957
+ "name": "--mdc-toggle-height-compact"
14958
14958
  },
14959
14959
  {
14960
- "description": "radius of the arrow border",
14961
- "name": "--mdc-popover-arrow-border-radius",
14962
- "inheritedFrom": {
14963
- "name": "Popover",
14964
- "module": "src/components/popover/popover.component.ts"
14965
- }
14960
+ "description": "border radius of the toggle",
14961
+ "name": "--mdc-toggle-border-radius"
14966
14962
  },
14967
14963
  {
14968
- "description": "border of the arrow",
14969
- "name": "--mdc-popover-arrow-border",
14970
- "inheritedFrom": {
14971
- "name": "Popover",
14972
- "module": "src/components/popover/popover.component.ts"
14973
- }
14964
+ "description": "border radius of the toggle when it's size is compact",
14965
+ "name": "--mdc-toggle-border-radius-compact"
14974
14966
  },
14975
14967
  {
14976
- "description": "primary background color of the popover",
14977
- "name": "--mdc-popover-primary-background-color",
14978
- "inheritedFrom": {
14979
- "name": "Popover",
14980
- "module": "src/components/popover/popover.component.ts"
14981
- }
14968
+ "description": "border of the toggle",
14969
+ "name": "--mdc-toggle-border"
14982
14970
  },
14983
14971
  {
14984
- "description": "border color of the popover",
14985
- "name": "--mdc-popover-border-color",
14986
- "inheritedFrom": {
14987
- "name": "Popover",
14988
- "module": "src/components/popover/popover.component.ts"
14989
- }
14972
+ "description": "background color of the inactive toggle in rest state",
14973
+ "name": "--mdc-toggle-inactive-rest-color"
14990
14974
  },
14991
14975
  {
14992
- "description": "inverted background color of the popover",
14993
- "name": "--mdc-popover-inverted-background-color",
14994
- "inheritedFrom": {
14995
- "name": "Popover",
14996
- "module": "src/components/popover/popover.component.ts"
14997
- }
14976
+ "description": "background color of the inactive toggle in hover state",
14977
+ "name": "--mdc-toggle-inactive-hover-color"
14998
14978
  },
14999
14979
  {
15000
- "description": "inverted border color of the popover",
15001
- "name": "--mdc-popover-inverted-border-color",
15002
- "inheritedFrom": {
15003
- "name": "Popover",
15004
- "module": "src/components/popover/popover.component.ts"
15005
- }
14980
+ "description": "background color of the inactive toggle in pressed state",
14981
+ "name": "--mdc-toggle-inactive-pressed-color"
15006
14982
  },
15007
14983
  {
15008
- "description": "inverted text color of the popover",
15009
- "name": "--mdc-popover-inverted-text-color",
15010
- "inheritedFrom": {
15011
- "name": "Popover",
15012
- "module": "src/components/popover/popover.component.ts"
15013
- }
14984
+ "description": "background color of the inactive toggle in disabled state",
14985
+ "name": "--mdc-toggle-inactive-disabled-color"
15014
14986
  },
15015
14987
  {
15016
- "description": "elevation of the popover",
15017
- "name": "--mdc-popover-elevation-3",
15018
- "inheritedFrom": {
15019
- "name": "Popover",
15020
- "module": "src/components/popover/popover.component.ts"
15021
- }
14988
+ "description": "background color of the active toggle in rest state",
14989
+ "name": "--mdc-toggle-active-rest-color"
14990
+ },
14991
+ {
14992
+ "description": "background color of the active toggle in hover state",
14993
+ "name": "--mdc-toggle-active-hover-color"
14994
+ },
14995
+ {
14996
+ "description": "background color of the active toggle in pressed state",
14997
+ "name": "--mdc-toggle-active-pressed-color"
14998
+ },
14999
+ {
15000
+ "description": "background color of the active toggle in disabled state",
15001
+ "name": "--mdc-toggle-active-disabled-color"
15002
+ },
15003
+ {
15004
+ "description": " color of the help text label",
15005
+ "name": "--mdc-toggle-help-text-color"
15006
+ },
15007
+ {
15008
+ "description": "color of the toggle label and help text in disabled state",
15009
+ "name": "--mdc-toggle-label-color-disabled"
15022
15010
  }
15023
15011
  ],
15024
15012
  "members": [
15025
15013
  {
15026
15014
  "kind": "field",
15027
- "name": "tooltipType",
15015
+ "name": "checked",
15028
15016
  "type": {
15029
- "text": "TooltipType"
15017
+ "text": "boolean"
15030
15018
  },
15031
- "description": "The type of tooltip.\n- **description** sets aria-describedby on the trigger component which refers to the tooltip id.\n- **label** sets aria-labelledby on the trigger component which refers to the tooltip id.\n- **none** no aria props set on trigger component referring to the tooltip id.",
15032
- "default": "'description'",
15033
- "attribute": "tooltip-type",
15019
+ "default": "false",
15020
+ "description": "Determines whether the toggle is active or inactive.",
15021
+ "attribute": "checked",
15034
15022
  "reflects": true
15035
15023
  },
15036
15024
  {
15037
15025
  "kind": "field",
15038
- "name": "defaultSlotNodes",
15026
+ "name": "size",
15039
15027
  "type": {
15040
- "text": "Array<Node>"
15028
+ "text": "ToggleSize"
15041
15029
  },
15042
- "privacy": "private"
15030
+ "description": "Determines toggle size in rem (height is specified here).\n- **Default**: 1.5\n- **Compact**: 1",
15031
+ "default": "default",
15032
+ "attribute": "size",
15033
+ "reflects": true
15034
+ },
15035
+ {
15036
+ "kind": "field",
15037
+ "name": "autofocus",
15038
+ "type": {
15039
+ "text": "boolean"
15040
+ },
15041
+ "default": "false",
15042
+ "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)",
15043
+ "attribute": "autofocus",
15044
+ "reflects": true
15043
15045
  },
15044
15046
  {
15045
15047
  "kind": "method",
15046
- "name": "getTooltipText",
15048
+ "name": "manageRequired",
15047
15049
  "privacy": "private",
15048
- "return": {
15049
- "type": {
15050
- "text": ""
15051
- }
15052
- }
15050
+ "description": "Manages the required state of the checkbox.\nIf the checkbox is not checked and the requiredLabel property is set, then the checkbox is invalid."
15053
15051
  },
15054
15052
  {
15055
15053
  "kind": "method",
15056
- "name": "setTooltipType",
15054
+ "name": "setFormValue",
15057
15055
  "privacy": "private",
15058
- "return": {
15059
- "type": {
15060
- "text": "void"
15061
- }
15062
- },
15063
- "parameters": [
15064
- {
15065
- "name": "type",
15066
- "type": {
15067
- "text": "TooltipType"
15068
- },
15069
- "description": "The type to set."
15070
- }
15071
- ],
15072
- "description": "Sets the type attribute for the tooltip component.\nIf the provided type is not included in the TOOLTIP_TYPES,\nit defaults to the value specified in DEFAULTS.TOOLTIP_TYPE."
15056
+ "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."
15073
15057
  },
15074
15058
  {
15075
15059
  "kind": "method",
15076
- "name": "onIdUpdated",
15060
+ "name": "toggleState",
15077
15061
  "privacy": "private",
15078
15062
  "return": {
15079
15063
  "type": {
15080
15064
  "text": "void"
15081
15065
  }
15082
15066
  },
15083
- "description": "Updates the tooltip id if it is empty."
15067
+ "description": "Toggles the state of the toggle element.\nIf the element is not disabled, then the checked property is toggled."
15084
15068
  },
15085
15069
  {
15086
15070
  "kind": "method",
15087
- "name": "onPlacementUpdated",
15071
+ "name": "handleKeyDown",
15088
15072
  "privacy": "private",
15089
15073
  "return": {
15090
15074
  "type": {
15091
15075
  "text": "void"
15092
15076
  }
15093
15077
  },
15094
- "description": "Updates the placement attribute if it is not a valid placement.\nOverriding the default from Popover"
15078
+ "parameters": [
15079
+ {
15080
+ "name": "event",
15081
+ "type": {
15082
+ "text": "KeyboardEvent"
15083
+ },
15084
+ "description": "The keyboard event."
15085
+ }
15086
+ ],
15087
+ "description": "Handles the keydown event on the toggle element.\nWhen the user presses Enter, the form is submitted."
15095
15088
  },
15096
15089
  {
15097
15090
  "kind": "method",
15098
- "name": "onTooltipTypeUpdated",
15091
+ "name": "handleChange",
15099
15092
  "privacy": "private",
15100
- "return": {
15101
- "type": {
15102
- "text": "void"
15093
+ "parameters": [
15094
+ {
15095
+ "name": "event",
15096
+ "type": {
15097
+ "text": "Event"
15098
+ }
15103
15099
  }
15104
- },
15100
+ ],
15101
+ "description": "Toggles the state of the toggle element.\nand dispatch the new change event."
15102
+ },
15103
+ {
15104
+ "kind": "method",
15105
+ "name": "setToggleSize",
15106
+ "privacy": "private",
15105
15107
  "parameters": [
15106
15108
  {
15107
- "name": "changedProperties",
15109
+ "name": "size",
15108
15110
  "type": {
15109
- "text": "PropertyValues"
15111
+ "text": "ToggleSize"
15110
15112
  },
15111
- "description": "The changed properties."
15113
+ "description": "The size to set."
15112
15114
  }
15113
15115
  ],
15114
- "description": "Updates the tooltip type attribute and sets the appropriate aria props on the trigger component."
15116
+ "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."
15115
15117
  },
15116
15118
  {
15117
15119
  "kind": "field",
15118
- "name": "enabledFocusTrap",
15120
+ "name": "name",
15119
15121
  "type": {
15120
- "text": "boolean"
15122
+ "text": "string"
15121
15123
  },
15122
- "description": "Determines whether the focus trap is enabled.\nIf true, focus will be restricted to the content within this component.",
15123
- "default": "false",
15124
- "attribute": "enabledFocusTrap",
15124
+ "default": "''",
15125
+ "description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
15126
+ "attribute": "name",
15127
+ "reflects": true,
15125
15128
  "inheritedFrom": {
15126
- "name": "Popover",
15127
- "module": "components/popover/popover.component.js"
15129
+ "name": "FormInternalsMixin",
15130
+ "module": "utils/mixins/FormInternalsMixin.js"
15128
15131
  }
15129
15132
  },
15130
15133
  {
15131
15134
  "kind": "field",
15132
- "name": "enabledPreventScroll",
15135
+ "name": "value",
15133
15136
  "type": {
15134
- "text": "boolean"
15137
+ "text": "string"
15135
15138
  },
15136
- "description": "Prevent outside scrolling when popover show.",
15137
- "default": "false",
15138
- "attribute": "enabledPreventScroll",
15139
+ "default": "''",
15140
+ "description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
15141
+ "attribute": "value",
15142
+ "reflects": true,
15139
15143
  "inheritedFrom": {
15140
- "name": "Popover",
15141
- "module": "components/popover/popover.component.js"
15144
+ "name": "FormInternalsMixin",
15145
+ "module": "utils/mixins/FormInternalsMixin.js"
15142
15146
  }
15143
15147
  },
15144
15148
  {
15145
15149
  "kind": "field",
15146
- "name": "shouldWrapFocus",
15150
+ "name": "validationMessage",
15147
15151
  "type": {
15148
- "text": "() => boolean"
15152
+ "text": "string | undefined"
15149
15153
  },
15154
+ "description": "Custom validation message that will override the default message and displayed when the input is invalid.",
15155
+ "attribute": "validation-message",
15156
+ "reflects": true,
15150
15157
  "inheritedFrom": {
15151
- "name": "Popover",
15152
- "module": "components/popover/popover.component.js"
15158
+ "name": "FormInternalsMixin",
15159
+ "module": "utils/mixins/FormInternalsMixin.js"
15153
15160
  }
15154
15161
  },
15155
15162
  {
15156
- "kind": "method",
15157
- "name": "deactivateFocusTrap",
15158
- "description": "Deactivate the focus trap.",
15163
+ "kind": "field",
15164
+ "name": "validity",
15165
+ "type": {
15166
+ "text": "ValidityState"
15167
+ },
15168
+ "readonly": true,
15159
15169
  "inheritedFrom": {
15160
- "name": "Popover",
15161
- "module": "components/popover/popover.component.js"
15170
+ "name": "FormInternalsMixin",
15171
+ "module": "utils/mixins/FormInternalsMixin.js"
15172
+ }
15173
+ },
15174
+ {
15175
+ "kind": "field",
15176
+ "name": "willValidate",
15177
+ "readonly": true,
15178
+ "inheritedFrom": {
15179
+ "name": "FormInternalsMixin",
15180
+ "module": "utils/mixins/FormInternalsMixin.js"
15162
15181
  }
15163
15182
  },
15164
15183
  {
15165
15184
  "kind": "method",
15166
- "name": "hasNoClientRects",
15167
- "privacy": "private",
15168
- "parameters": [
15169
- {
15170
- "name": "element",
15171
- "type": {
15172
- "text": "HTMLElement"
15173
- },
15174
- "description": "The element to check."
15175
- }
15176
- ],
15177
- "description": "Checks if the element has no client rectangles (not visible in the viewport).",
15185
+ "name": "setValidity",
15186
+ "description": "Sets the validity of the input field based on the input field's validity.",
15178
15187
  "return": {
15179
15188
  "type": {
15180
15189
  "text": ""
15181
15190
  }
15182
15191
  },
15183
15192
  "inheritedFrom": {
15184
- "name": "Popover",
15185
- "module": "components/popover/popover.component.js"
15193
+ "name": "FormInternalsMixin",
15194
+ "module": "utils/mixins/FormInternalsMixin.js"
15186
15195
  }
15187
15196
  },
15188
15197
  {
15189
15198
  "kind": "method",
15190
- "name": "hasZeroDimensions",
15191
- "privacy": "private",
15192
- "parameters": [
15193
- {
15194
- "name": "element",
15195
- "type": {
15196
- "text": "HTMLElement"
15197
- },
15198
- "description": "The element to check."
15199
- }
15200
- ],
15201
- "description": "Checks if the element has zero dimensions (width and height are both 0).",
15199
+ "name": "checkValidity",
15202
15200
  "return": {
15203
15201
  "type": {
15204
- "text": ""
15202
+ "text": "boolean"
15205
15203
  }
15206
15204
  },
15207
15205
  "inheritedFrom": {
15208
- "name": "Popover",
15209
- "module": "components/popover/popover.component.js"
15206
+ "name": "FormInternalsMixin",
15207
+ "module": "utils/mixins/FormInternalsMixin.js"
15210
15208
  }
15211
15209
  },
15212
15210
  {
15213
15211
  "kind": "method",
15214
- "name": "isNotVisible",
15215
- "privacy": "private",
15216
- "parameters": [
15217
- {
15218
- "name": "element",
15219
- "type": {
15220
- "text": "HTMLElement"
15221
- },
15222
- "description": "The element to check."
15223
- }
15224
- ],
15225
- "description": "Determines if the element is not visible in the DOM.",
15226
- "return": {
15227
- "type": {
15228
- "text": ""
15229
- }
15212
+ "name": "reportValidity",
15213
+ "inheritedFrom": {
15214
+ "name": "FormInternalsMixin",
15215
+ "module": "utils/mixins/FormInternalsMixin.js"
15216
+ }
15217
+ },
15218
+ {
15219
+ "kind": "field",
15220
+ "name": "id",
15221
+ "type": {
15222
+ "text": "string"
15230
15223
  },
15224
+ "default": "`mdc-input-${uuidv4()}`",
15225
+ "description": "The unique id of the input field. It is used to link the input field with the label.",
15226
+ "attribute": "id",
15231
15227
  "inheritedFrom": {
15232
- "name": "Popover",
15233
- "module": "components/popover/popover.component.js"
15228
+ "name": "FormfieldWrapper",
15229
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
15234
15230
  }
15235
15231
  },
15236
15232
  {
15237
- "kind": "method",
15238
- "name": "hasHiddenStyle",
15239
- "privacy": "private",
15240
- "parameters": [
15241
- {
15242
- "name": "element",
15243
- "type": {
15244
- "text": "HTMLElement"
15245
- },
15246
- "description": "The element to check."
15247
- }
15248
- ],
15249
- "description": "Checks if the element has inline styles that make it hidden.",
15250
- "return": {
15251
- "type": {
15252
- "text": ""
15253
- }
15233
+ "kind": "field",
15234
+ "name": "dataAriaLabel",
15235
+ "type": {
15236
+ "text": "string | null"
15254
15237
  },
15238
+ "default": "null",
15239
+ "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
15240
+ "attribute": "data-aria-label",
15241
+ "reflects": true,
15255
15242
  "inheritedFrom": {
15256
- "name": "Popover",
15257
- "module": "components/popover/popover.component.js"
15243
+ "name": "DataAriaLabelMixin",
15244
+ "module": "utils/mixins/DataAriaLabelMixin.js"
15245
+ }
15246
+ },
15247
+ {
15248
+ "kind": "field",
15249
+ "name": "disabled",
15250
+ "type": {
15251
+ "text": "boolean"
15252
+ },
15253
+ "default": "false",
15254
+ "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
15255
+ "attribute": "disabled",
15256
+ "reflects": true,
15257
+ "inheritedFrom": {
15258
+ "name": "FormfieldWrapper",
15259
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
15260
+ }
15261
+ },
15262
+ {
15263
+ "kind": "field",
15264
+ "name": "label",
15265
+ "type": {
15266
+ "text": "string | undefined"
15267
+ },
15268
+ "description": "The label of the input field. It is linked to the input field using the `for` attribute.",
15269
+ "attribute": "label",
15270
+ "reflects": true,
15271
+ "inheritedFrom": {
15272
+ "name": "FormfieldWrapper",
15273
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
15274
+ }
15275
+ },
15276
+ {
15277
+ "kind": "field",
15278
+ "name": "requiredLabel",
15279
+ "type": {
15280
+ "text": "string | undefined"
15281
+ },
15282
+ "description": "The required label of the input field.\nWhen an appropriate string value is set,\nthe input field is marked as required and the label is appended with this text.",
15283
+ "attribute": "required-label",
15284
+ "reflects": true,
15285
+ "inheritedFrom": {
15286
+ "name": "FormfieldWrapper",
15287
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
15288
+ }
15289
+ },
15290
+ {
15291
+ "kind": "field",
15292
+ "name": "helpTextType",
15293
+ "type": {
15294
+ "text": "ValidationType"
15295
+ },
15296
+ "description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
15297
+ "attribute": "help-text-type",
15298
+ "reflects": true,
15299
+ "inheritedFrom": {
15300
+ "name": "FormfieldWrapper",
15301
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
15302
+ }
15303
+ },
15304
+ {
15305
+ "kind": "field",
15306
+ "name": "helpText",
15307
+ "type": {
15308
+ "text": "string | undefined"
15309
+ },
15310
+ "description": "The help text that is displayed below the input field.",
15311
+ "attribute": "help-text",
15312
+ "reflects": true,
15313
+ "inheritedFrom": {
15314
+ "name": "FormfieldWrapper",
15315
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
15258
15316
  }
15259
15317
  },
15260
15318
  {
15261
15319
  "kind": "method",
15262
- "name": "hasComputedHidden",
15263
- "privacy": "private",
15264
- "parameters": [
15265
- {
15266
- "name": "element",
15267
- "type": {
15268
- "text": "HTMLElement"
15269
- },
15270
- "description": "The element to check."
15271
- }
15272
- ],
15273
- "description": "Checks if the element is hidden by a computed style.",
15320
+ "name": "renderLabelElement",
15321
+ "privacy": "protected",
15322
+ "description": "creates the label element when the label property is set.\nid is used to link the label with the input field.",
15274
15323
  "return": {
15275
15324
  "type": {
15276
15325
  "text": ""
15277
15326
  }
15278
15327
  },
15279
15328
  "inheritedFrom": {
15280
- "name": "Popover",
15281
- "module": "components/popover/popover.component.js"
15329
+ "name": "FormfieldWrapper",
15330
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
15282
15331
  }
15283
15332
  },
15284
15333
  {
15285
15334
  "kind": "method",
15286
- "name": "isHidden",
15287
- "privacy": "private",
15288
- "parameters": [
15289
- {
15290
- "name": "element",
15291
- "type": {
15292
- "text": "HTMLElement"
15293
- },
15294
- "description": "The element to check."
15295
- }
15296
- ],
15297
- "description": "Checks if the element is hidden from the user.",
15335
+ "name": "renderRequiredLabel",
15336
+ "privacy": "protected",
15337
+ "inheritedFrom": {
15338
+ "name": "FormfieldWrapper",
15339
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
15340
+ }
15341
+ },
15342
+ {
15343
+ "kind": "method",
15344
+ "name": "renderHelpTextIcon",
15345
+ "privacy": "protected",
15346
+ "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.",
15298
15347
  "return": {
15299
15348
  "type": {
15300
15349
  "text": ""
15301
15350
  }
15302
15351
  },
15303
15352
  "inheritedFrom": {
15304
- "name": "Popover",
15305
- "module": "components/popover/popover.component.js"
15353
+ "name": "FormfieldWrapper",
15354
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
15306
15355
  }
15307
15356
  },
15308
15357
  {
15309
15358
  "kind": "method",
15310
- "name": "isNotTabbable",
15311
- "privacy": "private",
15312
- "parameters": [
15313
- {
15314
- "name": "element",
15315
- "type": {
15316
- "text": "HTMLElement"
15317
- },
15318
- "description": "The element to check."
15319
- }
15320
- ],
15321
- "description": "Checks if the element is not tabbable.",
15359
+ "name": "renderHelpText",
15360
+ "privacy": "protected",
15361
+ "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.",
15322
15362
  "return": {
15323
15363
  "type": {
15324
15364
  "text": ""
15325
15365
  }
15326
15366
  },
15327
15367
  "inheritedFrom": {
15328
- "name": "Popover",
15329
- "module": "components/popover/popover.component.js"
15368
+ "name": "FormfieldWrapper",
15369
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
15330
15370
  }
15331
15371
  },
15332
15372
  {
15333
15373
  "kind": "method",
15334
- "name": "isInteractiveElement",
15335
- "privacy": "private",
15374
+ "name": "renderLabel",
15375
+ "privacy": "protected",
15376
+ "description": "renders the mdc-label-text container that contains the label and labelInfoToggleTip.",
15336
15377
  "return": {
15337
15378
  "type": {
15338
15379
  "text": ""
15339
15380
  }
15340
15381
  },
15341
- "parameters": [
15342
- {
15343
- "name": "element",
15344
- "type": {
15345
- "text": "HTMLElement"
15346
- },
15347
- "description": "The element to check."
15348
- }
15349
- ],
15350
- "description": "Checks if the element is interactive.",
15351
15382
  "inheritedFrom": {
15352
- "name": "Popover",
15353
- "module": "components/popover/popover.component.js"
15383
+ "name": "FormfieldWrapper",
15384
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
15354
15385
  }
15355
15386
  },
15356
15387
  {
15357
15388
  "kind": "method",
15358
- "name": "isFocusable",
15359
- "privacy": "private",
15360
- "parameters": [
15361
- {
15362
- "name": "element",
15363
- "type": {
15364
- "text": "HTMLElement"
15365
- },
15366
- "description": "The element to check."
15367
- }
15368
- ],
15369
- "description": "Checks if the element is focusable.",
15389
+ "name": "renderHelperText",
15390
+ "privacy": "protected",
15391
+ "description": "renders the mdc-help-text container that contains the helpertext icon and helpertext.",
15370
15392
  "return": {
15371
15393
  "type": {
15372
15394
  "text": ""
15373
15395
  }
15374
15396
  },
15375
15397
  "inheritedFrom": {
15376
- "name": "Popover",
15377
- "module": "components/popover/popover.component.js"
15398
+ "name": "FormfieldWrapper",
15399
+ "module": "components/formfieldwrapper/formfieldwrapper.component.js"
15400
+ }
15401
+ }
15402
+ ],
15403
+ "events": [
15404
+ {
15405
+ "type": {
15406
+ "text": "EventConstructor"
15378
15407
  }
15379
15408
  },
15380
15409
  {
15381
- "kind": "method",
15382
- "name": "findFocusable",
15383
- "privacy": "private",
15384
- "return": {
15385
- "type": {
15386
- "text": ""
15387
- }
15410
+ "description": "(React: onChange) Event that gets dispatched when the toggle state changes.",
15411
+ "name": "change",
15412
+ "reactName": "onChange",
15413
+ "eventName": "ChangeEvent"
15414
+ },
15415
+ {
15416
+ "description": "(React: onFocus) Event that gets dispatched when the toggle receives focus.",
15417
+ "name": "focus",
15418
+ "reactName": "onFocus",
15419
+ "eventName": "FocusEvent"
15420
+ }
15421
+ ],
15422
+ "attributes": [
15423
+ {
15424
+ "name": "checked",
15425
+ "type": {
15426
+ "text": "boolean"
15388
15427
  },
15389
- "parameters": [
15390
- {
15391
- "name": "root",
15392
- "type": {
15393
- "text": "ShadowRoot | HTMLElement"
15394
- },
15395
- "description": "The root element to search for focusable elements."
15396
- },
15397
- {
15398
- "name": "matches",
15399
- "default": "new Set()",
15400
- "type": {
15401
- "text": "Set<HTMLElement>"
15402
- },
15403
- "description": "The set of focusable elements."
15404
- }
15405
- ],
15406
- "description": "Recursively finds all focusable elements within the given root and its descendants.",
15407
- "inheritedFrom": {
15408
- "name": "Popover",
15409
- "module": "components/popover/popover.component.js"
15410
- }
15428
+ "default": "false",
15429
+ "description": "Determines whether the toggle is active or inactive.",
15430
+ "fieldName": "checked"
15411
15431
  },
15412
15432
  {
15413
- "kind": "method",
15414
- "name": "setFocusableElements",
15415
- "privacy": "public",
15416
- "description": "Updates the list of focusable elements within the component's shadow root.",
15417
- "inheritedFrom": {
15418
- "name": "Popover",
15419
- "module": "components/popover/popover.component.js"
15420
- }
15433
+ "name": "size",
15434
+ "type": {
15435
+ "text": "ToggleSize"
15436
+ },
15437
+ "description": "Determines toggle size in rem (height is specified here).\n- **Default**: 1.5\n- **Compact**: 1",
15438
+ "default": "default",
15439
+ "fieldName": "size"
15421
15440
  },
15422
15441
  {
15423
- "kind": "method",
15424
- "name": "setInitialFocus",
15425
- "privacy": "public",
15426
- "parameters": [
15427
- {
15428
- "name": "prefferableElement",
15429
- "default": "0",
15430
- "type": {
15431
- "text": "number"
15432
- },
15433
- "description": "The index of the prefferable element to focus."
15434
- }
15435
- ],
15436
- "description": "Sets the initial focus within the container.",
15437
- "inheritedFrom": {
15438
- "name": "Popover",
15439
- "module": "components/popover/popover.component.js"
15440
- }
15442
+ "name": "autofocus",
15443
+ "type": {
15444
+ "text": "boolean"
15445
+ },
15446
+ "default": "false",
15447
+ "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)",
15448
+ "fieldName": "autofocus"
15441
15449
  },
15442
15450
  {
15443
- "kind": "method",
15444
- "name": "calculateNextIndex",
15445
- "privacy": "private",
15446
- "parameters": [
15447
- {
15448
- "name": "currentIndex",
15449
- "type": {
15450
- "text": "number"
15451
- },
15452
- "description": "The current index."
15453
- },
15454
- {
15455
- "name": "step",
15456
- "type": {
15457
- "text": "number"
15458
- },
15459
- "description": "The step to calculate the next index."
15460
- }
15461
- ],
15462
- "description": "Calculates the next index for the focus trap.",
15463
- "return": {
15464
- "type": {
15465
- "text": ""
15466
- }
15451
+ "name": "name",
15452
+ "type": {
15453
+ "text": "string"
15467
15454
  },
15455
+ "default": "''",
15456
+ "description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
15457
+ "fieldName": "name",
15468
15458
  "inheritedFrom": {
15469
- "name": "Popover",
15470
- "module": "components/popover/popover.component.js"
15459
+ "name": "FormInternalsMixin",
15460
+ "module": "src/utils/mixins/FormInternalsMixin.ts"
15471
15461
  }
15472
15462
  },
15473
15463
  {
15474
- "kind": "method",
15475
- "name": "getDeepActiveElement",
15476
- "privacy": "private",
15477
- "description": "Returns the deepest active element in the shadow DOM.",
15478
- "return": {
15479
- "type": {
15480
- "text": ""
15481
- }
15464
+ "name": "value",
15465
+ "type": {
15466
+ "text": "string"
15482
15467
  },
15468
+ "default": "''",
15469
+ "description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
15470
+ "fieldName": "value",
15483
15471
  "inheritedFrom": {
15484
- "name": "Popover",
15485
- "module": "components/popover/popover.component.js"
15472
+ "name": "FormInternalsMixin",
15473
+ "module": "src/utils/mixins/FormInternalsMixin.ts"
15486
15474
  }
15487
15475
  },
15488
15476
  {
15489
- "kind": "method",
15490
- "name": "findElement",
15491
- "privacy": "private",
15492
- "parameters": [
15493
- {
15494
- "name": "activeElement",
15495
- "type": {
15496
- "text": "HTMLElement"
15497
- },
15498
- "description": "The active element."
15499
- }
15500
- ],
15501
- "description": "Finds the index of the active element within the focusable elements.",
15502
- "return": {
15503
- "type": {
15504
- "text": ""
15505
- }
15477
+ "name": "validation-message",
15478
+ "type": {
15479
+ "text": "string | undefined"
15506
15480
  },
15481
+ "description": "Custom validation message that will override the default message and displayed when the input is invalid.",
15482
+ "fieldName": "validationMessage",
15507
15483
  "inheritedFrom": {
15508
- "name": "Popover",
15509
- "module": "components/popover/popover.component.js"
15484
+ "name": "FormInternalsMixin",
15485
+ "module": "src/utils/mixins/FormInternalsMixin.ts"
15510
15486
  }
15511
15487
  },
15512
15488
  {
15513
- "kind": "method",
15514
- "name": "isEqualFocusNode",
15515
- "privacy": "private",
15516
- "parameters": [
15517
- {
15518
- "name": "activeElement",
15519
- "type": {
15520
- "text": "HTMLElement"
15521
- },
15522
- "description": "The active element."
15523
- },
15524
- {
15525
- "name": "element",
15526
- "type": {
15527
- "text": "HTMLElement"
15528
- },
15529
- "description": "The element to compare."
15530
- }
15531
- ],
15532
- "description": "Checks if the active element is equal to the given element.",
15533
- "return": {
15534
- "type": {
15535
- "text": ""
15536
- }
15489
+ "name": "data-aria-label",
15490
+ "type": {
15491
+ "text": "string | null"
15537
15492
  },
15493
+ "default": "null",
15494
+ "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
15495
+ "fieldName": "dataAriaLabel",
15538
15496
  "inheritedFrom": {
15539
- "name": "Popover",
15540
- "module": "components/popover/popover.component.js"
15497
+ "name": "DataAriaLabelMixin",
15498
+ "module": "src/utils/mixins/DataAriaLabelMixin.ts"
15541
15499
  }
15542
15500
  },
15543
15501
  {
15544
- "kind": "method",
15545
- "name": "trapFocus",
15546
- "privacy": "private",
15547
- "parameters": [
15548
- {
15549
- "name": "direction",
15550
- "type": {
15551
- "text": "boolean"
15552
- },
15553
- "description": "The direction of the focus trap.\nIf true, the focus will be trapped in the previous element."
15554
- }
15555
- ],
15556
- "description": "Traps focus within the container.",
15502
+ "name": "disabled",
15503
+ "type": {
15504
+ "text": "boolean"
15505
+ },
15506
+ "default": "false",
15507
+ "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
15508
+ "fieldName": "disabled",
15557
15509
  "inheritedFrom": {
15558
- "name": "Popover",
15559
- "module": "components/popover/popover.component.js"
15510
+ "name": "FormfieldWrapper",
15511
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
15560
15512
  }
15561
15513
  },
15562
15514
  {
15563
- "kind": "method",
15564
- "name": "handleKeydown",
15565
- "privacy": "private",
15566
- "parameters": [
15567
- {
15568
- "name": "event",
15569
- "type": {
15570
- "text": "KeyboardEvent"
15571
- },
15572
- "description": "The keyboard event."
15573
- }
15574
- ],
15575
- "description": "Traps focus within the container.",
15515
+ "name": "label",
15516
+ "type": {
15517
+ "text": "string | undefined"
15518
+ },
15519
+ "description": "The label of the input field. It is linked to the input field using the `for` attribute.",
15520
+ "fieldName": "label",
15576
15521
  "inheritedFrom": {
15577
- "name": "Popover",
15578
- "module": "components/popover/popover.component.js"
15522
+ "name": "FormfieldWrapper",
15523
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
15579
15524
  }
15580
15525
  },
15581
15526
  {
15582
- "kind": "field",
15583
- "name": "id",
15527
+ "name": "required-label",
15584
15528
  "type": {
15585
- "text": "string"
15529
+ "text": "string | undefined"
15586
15530
  },
15587
- "default": "''",
15588
- "description": "The unique ID of the popover.",
15589
- "attribute": "id",
15590
- "reflects": true,
15531
+ "description": "The required label of the input field.\nWhen an appropriate string value is set,\nthe input field is marked as required and the label is appended with this text.",
15532
+ "fieldName": "requiredLabel",
15591
15533
  "inheritedFrom": {
15592
- "name": "Popover",
15593
- "module": "components/popover/popover.component.js"
15534
+ "name": "FormfieldWrapper",
15535
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
15594
15536
  }
15595
15537
  },
15596
15538
  {
15597
- "kind": "field",
15598
- "name": "triggerID",
15539
+ "name": "id",
15599
15540
  "type": {
15600
15541
  "text": "string"
15601
15542
  },
15602
15543
  "default": "''",
15603
- "description": "The ID of the element that triggers the popover.\nThis attribute is required for the popover to work.",
15604
- "attribute": "triggerID",
15605
- "reflects": true,
15544
+ "description": "The unique id of the input field. It is used to link the input field with the label.",
15545
+ "fieldName": "id",
15606
15546
  "inheritedFrom": {
15607
- "name": "Popover",
15608
- "module": "components/popover/popover.component.js"
15547
+ "name": "FormfieldWrapper",
15548
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
15609
15549
  }
15610
15550
  },
15611
15551
  {
15612
- "kind": "field",
15613
- "name": "trigger",
15552
+ "name": "help-text-type",
15614
15553
  "type": {
15615
- "text": "PopoverTrigger"
15554
+ "text": "ValidationType"
15616
15555
  },
15617
- "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**",
15618
- "default": "click",
15619
- "attribute": "trigger",
15620
- "reflects": true,
15556
+ "description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
15557
+ "fieldName": "helpTextType",
15621
15558
  "inheritedFrom": {
15622
- "name": "Popover",
15623
- "module": "components/popover/popover.component.js"
15559
+ "name": "FormfieldWrapper",
15560
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
15624
15561
  }
15625
15562
  },
15626
15563
  {
15627
- "kind": "field",
15628
- "name": "placement",
15564
+ "name": "help-text",
15629
15565
  "type": {
15630
- "text": "PopoverPlacement"
15566
+ "text": "string | undefined"
15631
15567
  },
15632
- "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**",
15633
- "default": "bottom",
15634
- "attribute": "placement",
15635
- "reflects": true,
15568
+ "description": "The help text that is displayed below the input field.",
15569
+ "fieldName": "helpText",
15636
15570
  "inheritedFrom": {
15637
- "name": "Popover",
15638
- "module": "components/popover/popover.component.js"
15571
+ "name": "FormfieldWrapper",
15572
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
15639
15573
  }
15574
+ }
15575
+ ],
15576
+ "mixins": [
15577
+ {
15578
+ "name": "FormInternalsMixin",
15579
+ "module": "/src/utils/mixins/FormInternalsMixin"
15640
15580
  },
15641
15581
  {
15642
- "kind": "field",
15643
- "name": "color",
15644
- "type": {
15645
- "text": "PopoverColor"
15646
- },
15647
- "description": "Color of the popover\n- **tonal**\n- **contrast**",
15648
- "default": "tonal",
15649
- "attribute": "color",
15650
- "reflects": true,
15582
+ "name": "DataAriaLabelMixin",
15583
+ "module": "/src/utils/mixins/DataAriaLabelMixin"
15584
+ }
15585
+ ],
15586
+ "superclass": {
15587
+ "name": "FormfieldWrapper",
15588
+ "module": "/src/components/formfieldwrapper"
15589
+ },
15590
+ "tagName": "mdc-toggle",
15591
+ "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 *\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-border-radius - border radius of the toggle\n * @cssproperty --mdc-toggle-border-radius-compact - border radius of the toggle when it's size is compact\n * @cssproperty --mdc-toggle-border - border of the toggle\n * @cssproperty --mdc-toggle-inactive-rest-color - background color of the inactive toggle in rest 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 * @cssproperty --mdc-toggle-inactive-disabled-color - background color of the inactive toggle in disabled state\n * @cssproperty --mdc-toggle-active-rest-color - background color of the active toggle in rest state\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-active-disabled-color - background color of the active toggle in disabled state\n * @cssproperty --mdc-toggle-help-text-color - color of the help text label\n * @cssproperty --mdc-toggle-label-color-disabled - color of the toggle label and help text in disabled state\n *\n */",
15592
+ "customElement": true,
15593
+ "slots": [
15594
+ {
15595
+ "description": "slot to add the label info icon",
15596
+ "name": "label-info",
15651
15597
  "inheritedFrom": {
15652
- "name": "Popover",
15653
- "module": "components/popover/popover.component.js"
15598
+ "name": "FormfieldWrapper",
15599
+ "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
15654
15600
  }
15601
+ }
15602
+ ]
15603
+ }
15604
+ ],
15605
+ "exports": [
15606
+ {
15607
+ "kind": "js",
15608
+ "name": "default",
15609
+ "declaration": {
15610
+ "name": "Toggle",
15611
+ "module": "components/toggle/toggle.component.js"
15612
+ }
15613
+ }
15614
+ ]
15615
+ },
15616
+ {
15617
+ "kind": "javascript-module",
15618
+ "path": "components/tooltip/tooltip.component.js",
15619
+ "declarations": [
15620
+ {
15621
+ "kind": "class",
15622
+ "description": "A tooltip is triggered by mouse hover or by keyboard focus\nand will disappear upon mouse exit or focus change.\n\nNote: Tooltips cannot contain content that can be focused or interacted with.",
15623
+ "name": "Tooltip",
15624
+ "cssProperties": [
15625
+ {
15626
+ "description": "The maximum width of the tooltip.",
15627
+ "name": "--mdc-tooltip-max-width"
15655
15628
  },
15656
15629
  {
15657
- "kind": "field",
15658
- "name": "visible",
15659
- "type": {
15660
- "text": "boolean"
15661
- },
15662
- "description": "The visibility of the popover.",
15663
- "default": "false",
15664
- "attribute": "visible",
15665
- "reflects": true,
15630
+ "description": "The padding of the tooltip.",
15631
+ "name": "--mdc-tooltip-padding"
15632
+ },
15633
+ {
15634
+ "description": "The text color of the tooltip.",
15635
+ "name": "--mdc-tooltip-text-color"
15636
+ },
15637
+ {
15638
+ "description": "The text color of the tooltip when the color is contrast.",
15639
+ "name": "--mdc-tooltip-text-color-contrast"
15640
+ },
15641
+ {
15642
+ "description": "radius of the arrow border",
15643
+ "name": "--mdc-popover-arrow-border-radius",
15666
15644
  "inheritedFrom": {
15667
15645
  "name": "Popover",
15668
- "module": "components/popover/popover.component.js"
15646
+ "module": "src/components/popover/popover.component.ts"
15669
15647
  }
15670
15648
  },
15671
15649
  {
15672
- "kind": "field",
15673
- "name": "offset",
15674
- "type": {
15675
- "text": "number"
15676
- },
15677
- "description": "The offset of the popover.",
15678
- "default": "4",
15679
- "attribute": "offset",
15680
- "reflects": true,
15650
+ "description": "border of the arrow",
15651
+ "name": "--mdc-popover-arrow-border",
15681
15652
  "inheritedFrom": {
15682
15653
  "name": "Popover",
15683
- "module": "components/popover/popover.component.js"
15654
+ "module": "src/components/popover/popover.component.ts"
15684
15655
  }
15685
15656
  },
15686
15657
  {
15687
- "kind": "field",
15688
- "name": "focusTrap",
15689
- "type": {
15690
- "text": "boolean"
15691
- },
15692
- "description": "Determines whether the focus trap is enabled.\nIf true, focus will be restricted to the content within this component.",
15693
- "default": "false",
15694
- "attribute": "focus-trap",
15695
- "reflects": true,
15658
+ "description": "primary background color of the popover",
15659
+ "name": "--mdc-popover-primary-background-color",
15696
15660
  "inheritedFrom": {
15697
15661
  "name": "Popover",
15698
- "module": "components/popover/popover.component.js"
15662
+ "module": "src/components/popover/popover.component.ts"
15699
15663
  }
15700
15664
  },
15701
15665
  {
15702
- "kind": "field",
15703
- "name": "preventScroll",
15704
- "type": {
15705
- "text": "boolean"
15706
- },
15707
- "description": "Prevent outside scrolling when popover show.",
15708
- "default": "false",
15709
- "attribute": "prevent-scroll",
15710
- "reflects": true,
15666
+ "description": "border color of the popover",
15667
+ "name": "--mdc-popover-border-color",
15711
15668
  "inheritedFrom": {
15712
15669
  "name": "Popover",
15713
- "module": "components/popover/popover.component.js"
15670
+ "module": "src/components/popover/popover.component.ts"
15714
15671
  }
15715
15672
  },
15716
15673
  {
15717
- "kind": "field",
15718
- "name": "showArrow",
15719
- "type": {
15720
- "text": "boolean"
15721
- },
15722
- "description": "The arrow visibility of the popover.",
15723
- "default": "false",
15724
- "attribute": "show-arrow",
15725
- "reflects": true,
15674
+ "description": "inverted background color of the popover",
15675
+ "name": "--mdc-popover-inverted-background-color",
15726
15676
  "inheritedFrom": {
15727
15677
  "name": "Popover",
15728
- "module": "components/popover/popover.component.js"
15678
+ "module": "src/components/popover/popover.component.ts"
15729
15679
  }
15730
15680
  },
15731
15681
  {
15732
- "kind": "field",
15733
- "name": "closeButton",
15734
- "type": {
15735
- "text": "boolean"
15736
- },
15737
- "description": "The close button visibility of the popover.",
15738
- "default": "false",
15739
- "attribute": "close-button",
15740
- "reflects": true,
15682
+ "description": "inverted border color of the popover",
15683
+ "name": "--mdc-popover-inverted-border-color",
15741
15684
  "inheritedFrom": {
15742
15685
  "name": "Popover",
15743
- "module": "components/popover/popover.component.js"
15686
+ "module": "src/components/popover/popover.component.ts"
15744
15687
  }
15745
15688
  },
15746
15689
  {
15747
- "kind": "field",
15748
- "name": "interactive",
15749
- "type": {
15750
- "text": "boolean"
15751
- },
15752
- "description": "Determines whether the popover is interactive。",
15753
- "default": "false",
15754
- "attribute": "interactive",
15755
- "reflects": true,
15690
+ "description": "inverted text color of the popover",
15691
+ "name": "--mdc-popover-inverted-text-color",
15756
15692
  "inheritedFrom": {
15757
15693
  "name": "Popover",
15758
- "module": "components/popover/popover.component.js"
15694
+ "module": "src/components/popover/popover.component.ts"
15759
15695
  }
15760
15696
  },
15761
15697
  {
15762
- "kind": "field",
15763
- "name": "delay",
15764
- "type": {
15765
- "text": "string"
15766
- },
15767
- "description": "The delay of the show/hide popover.",
15768
- "default": "0,0",
15769
- "attribute": "delay",
15770
- "reflects": true,
15698
+ "description": "elevation of the popover",
15699
+ "name": "--mdc-popover-elevation-3",
15771
15700
  "inheritedFrom": {
15772
15701
  "name": "Popover",
15773
- "module": "components/popover/popover.component.js"
15702
+ "module": "src/components/popover/popover.component.ts"
15774
15703
  }
15775
- },
15704
+ }
15705
+ ],
15706
+ "members": [
15776
15707
  {
15777
15708
  "kind": "field",
15778
- "name": "hideOnEscape",
15709
+ "name": "tooltipType",
15779
15710
  "type": {
15780
- "text": "boolean"
15711
+ "text": "TooltipType"
15781
15712
  },
15782
- "description": "Hide popover on escape key press.",
15783
- "default": "false",
15784
- "attribute": "hide-on-escape",
15785
- "reflects": true,
15786
- "inheritedFrom": {
15787
- "name": "Popover",
15788
- "module": "components/popover/popover.component.js"
15789
- }
15713
+ "description": "The type of tooltip.\n- **description** sets aria-describedby on the trigger component which refers to the tooltip id.\n- **label** sets aria-labelledby on the trigger component which refers to the tooltip id.\n- **none** no aria props set on trigger component referring to the tooltip id.",
15714
+ "default": "'description'",
15715
+ "attribute": "tooltip-type",
15716
+ "reflects": true
15790
15717
  },
15791
15718
  {
15792
15719
  "kind": "field",
15793
- "name": "hideOnBlur",
15720
+ "name": "defaultSlotNodes",
15794
15721
  "type": {
15795
- "text": "boolean"
15722
+ "text": "Array<Node>"
15796
15723
  },
15797
- "description": "Hide popover on blur.",
15798
- "default": "false",
15799
- "attribute": "hide-on-blur",
15800
- "reflects": true,
15801
- "inheritedFrom": {
15802
- "name": "Popover",
15803
- "module": "components/popover/popover.component.js"
15724
+ "privacy": "private"
15725
+ },
15726
+ {
15727
+ "kind": "method",
15728
+ "name": "getTooltipText",
15729
+ "privacy": "private",
15730
+ "return": {
15731
+ "type": {
15732
+ "text": ""
15733
+ }
15804
15734
  }
15805
15735
  },
15806
15736
  {
15807
- "kind": "field",
15808
- "name": "hideOnOutsideClick",
15809
- "type": {
15810
- "text": "boolean"
15737
+ "kind": "method",
15738
+ "name": "setTooltipType",
15739
+ "privacy": "private",
15740
+ "return": {
15741
+ "type": {
15742
+ "text": "void"
15743
+ }
15811
15744
  },
15812
- "description": "Hide on outside click of the popover.",
15813
- "default": "false",
15814
- "attribute": "hide-on-outside-click",
15815
- "reflects": true,
15816
- "inheritedFrom": {
15817
- "name": "Popover",
15818
- "module": "components/popover/popover.component.js"
15819
- }
15745
+ "parameters": [
15746
+ {
15747
+ "name": "type",
15748
+ "type": {
15749
+ "text": "TooltipType"
15750
+ },
15751
+ "description": "The type to set."
15752
+ }
15753
+ ],
15754
+ "description": "Sets the type attribute for the tooltip component.\nIf the provided type is not included in the TOOLTIP_TYPES,\nit defaults to the value specified in DEFAULTS.TOOLTIP_TYPE."
15820
15755
  },
15821
15756
  {
15822
- "kind": "field",
15823
- "name": "focusBackToTrigger",
15824
- "type": {
15825
- "text": "boolean"
15757
+ "kind": "method",
15758
+ "name": "onIdUpdated",
15759
+ "privacy": "private",
15760
+ "return": {
15761
+ "type": {
15762
+ "text": "void"
15763
+ }
15826
15764
  },
15827
- "description": "The focus back to trigger after the popover hide.",
15828
- "default": "false",
15829
- "attribute": "focus-back-to-trigger",
15830
- "reflects": true,
15831
- "inheritedFrom": {
15832
- "name": "Popover",
15833
- "module": "components/popover/popover.component.js"
15834
- }
15765
+ "description": "Updates the tooltip id if it is empty."
15835
15766
  },
15836
15767
  {
15837
- "kind": "field",
15838
- "name": "backdrop",
15839
- "type": {
15840
- "text": "boolean"
15768
+ "kind": "method",
15769
+ "name": "onPlacementUpdated",
15770
+ "privacy": "private",
15771
+ "return": {
15772
+ "type": {
15773
+ "text": "void"
15774
+ }
15841
15775
  },
15842
- "description": "Determines whether the popover with backdrop.\nOther than popover and trigger element, the rest of the screen will be covered with a backdrop.",
15843
- "default": "false",
15844
- "attribute": "backdrop",
15845
- "reflects": true,
15846
- "inheritedFrom": {
15847
- "name": "Popover",
15848
- "module": "components/popover/popover.component.js"
15849
- }
15776
+ "description": "Updates the placement attribute if it is not a valid placement.\nOverriding the default from Popover"
15850
15777
  },
15851
15778
  {
15852
- "kind": "field",
15853
- "name": "flip",
15854
- "type": {
15855
- "text": "boolean"
15779
+ "kind": "method",
15780
+ "name": "onTooltipTypeUpdated",
15781
+ "privacy": "private",
15782
+ "return": {
15783
+ "type": {
15784
+ "text": "void"
15785
+ }
15856
15786
  },
15857
- "description": "Changes the placement of popover to keep it in view when scrolling.",
15858
- "default": "true",
15859
- "attribute": "flip",
15860
- "reflects": true,
15861
- "inheritedFrom": {
15862
- "name": "Popover",
15863
- "module": "components/popover/popover.component.js"
15864
- }
15787
+ "parameters": [
15788
+ {
15789
+ "name": "changedProperties",
15790
+ "type": {
15791
+ "text": "PropertyValues"
15792
+ },
15793
+ "description": "The changed properties."
15794
+ }
15795
+ ],
15796
+ "description": "Updates the tooltip type attribute and sets the appropriate aria props on the trigger component."
15865
15797
  },
15866
15798
  {
15867
15799
  "kind": "field",
15868
- "name": "size",
15800
+ "name": "enabledFocusTrap",
15869
15801
  "type": {
15870
15802
  "text": "boolean"
15871
15803
  },
15872
- "description": "Changes the size of popover to keep it in view when scrolling.",
15804
+ "description": "Determines whether the focus trap is enabled.\nIf true, focus will be restricted to the content within this component.",
15873
15805
  "default": "false",
15874
- "attribute": "size",
15875
- "reflects": true,
15806
+ "attribute": "enabledFocusTrap",
15876
15807
  "inheritedFrom": {
15877
15808
  "name": "Popover",
15878
15809
  "module": "components/popover/popover.component.js"
@@ -15880,14 +15811,13 @@
15880
15811
  },
15881
15812
  {
15882
15813
  "kind": "field",
15883
- "name": "zIndex",
15814
+ "name": "enabledPreventScroll",
15884
15815
  "type": {
15885
- "text": "number"
15816
+ "text": "boolean"
15886
15817
  },
15887
- "description": "The z-index of the popover.",
15888
- "default": "1000",
15889
- "attribute": "z-index",
15890
- "reflects": true,
15818
+ "description": "Prevent outside scrolling when popover show.",
15819
+ "default": "false",
15820
+ "attribute": "enabledPreventScroll",
15891
15821
  "inheritedFrom": {
15892
15822
  "name": "Popover",
15893
15823
  "module": "components/popover/popover.component.js"
@@ -15895,114 +15825,163 @@
15895
15825
  },
15896
15826
  {
15897
15827
  "kind": "field",
15898
- "name": "appendTo",
15828
+ "name": "shouldWrapFocus",
15899
15829
  "type": {
15900
- "text": "string"
15830
+ "text": "() => boolean"
15901
15831
  },
15902
- "default": "''",
15903
- "description": "Element ID that the popover append to.",
15904
- "attribute": "append-to",
15905
- "reflects": true,
15906
15832
  "inheritedFrom": {
15907
15833
  "name": "Popover",
15908
15834
  "module": "components/popover/popover.component.js"
15909
15835
  }
15910
- },
15911
- {
15912
- "kind": "field",
15913
- "name": "closeButtonAriaLabel",
15914
- "type": {
15915
- "text": "string | null"
15916
- },
15917
- "default": "null",
15918
- "description": "aria-label attribute to be set for close button accessibility.",
15919
- "attribute": "close-button-aria-label",
15836
+ },
15837
+ {
15838
+ "kind": "method",
15839
+ "name": "deactivateFocusTrap",
15840
+ "description": "Deactivate the focus trap.",
15920
15841
  "inheritedFrom": {
15921
15842
  "name": "Popover",
15922
15843
  "module": "components/popover/popover.component.js"
15923
15844
  }
15924
15845
  },
15925
15846
  {
15926
- "kind": "field",
15927
- "name": "role",
15928
- "type": {
15929
- "text": "HTMLElement['role']"
15847
+ "kind": "method",
15848
+ "name": "hasNoClientRects",
15849
+ "privacy": "private",
15850
+ "parameters": [
15851
+ {
15852
+ "name": "element",
15853
+ "type": {
15854
+ "text": "HTMLElement"
15855
+ },
15856
+ "description": "The element to check."
15857
+ }
15858
+ ],
15859
+ "description": "Checks if the element has no client rectangles (not visible in the viewport).",
15860
+ "return": {
15861
+ "type": {
15862
+ "text": ""
15863
+ }
15930
15864
  },
15931
- "description": "Role of the popover",
15932
- "default": "dialog",
15933
- "attribute": "role",
15934
- "reflects": true,
15935
15865
  "inheritedFrom": {
15936
15866
  "name": "Popover",
15937
15867
  "module": "components/popover/popover.component.js"
15938
15868
  }
15939
15869
  },
15940
15870
  {
15941
- "kind": "field",
15942
- "name": "ariaLabelledby",
15943
- "type": {
15944
- "text": "string | null"
15871
+ "kind": "method",
15872
+ "name": "hasZeroDimensions",
15873
+ "privacy": "private",
15874
+ "parameters": [
15875
+ {
15876
+ "name": "element",
15877
+ "type": {
15878
+ "text": "HTMLElement"
15879
+ },
15880
+ "description": "The element to check."
15881
+ }
15882
+ ],
15883
+ "description": "Checks if the element has zero dimensions (width and height are both 0).",
15884
+ "return": {
15885
+ "type": {
15886
+ "text": ""
15887
+ }
15945
15888
  },
15946
- "default": "null",
15947
- "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.",
15948
- "attribute": "aria-labelledby",
15949
- "reflects": true,
15950
15889
  "inheritedFrom": {
15951
15890
  "name": "Popover",
15952
15891
  "module": "components/popover/popover.component.js"
15953
15892
  }
15954
15893
  },
15955
15894
  {
15956
- "kind": "field",
15957
- "name": "ariaDescribedby",
15958
- "type": {
15959
- "text": "string | null"
15895
+ "kind": "method",
15896
+ "name": "isNotVisible",
15897
+ "privacy": "private",
15898
+ "parameters": [
15899
+ {
15900
+ "name": "element",
15901
+ "type": {
15902
+ "text": "HTMLElement"
15903
+ },
15904
+ "description": "The element to check."
15905
+ }
15906
+ ],
15907
+ "description": "Determines if the element is not visible in the DOM.",
15908
+ "return": {
15909
+ "type": {
15910
+ "text": ""
15911
+ }
15960
15912
  },
15961
- "default": "null",
15962
- "description": "aria-describedby of the popover.",
15963
- "attribute": "aria-describedby",
15964
- "reflects": true,
15965
15913
  "inheritedFrom": {
15966
15914
  "name": "Popover",
15967
15915
  "module": "components/popover/popover.component.js"
15968
15916
  }
15969
15917
  },
15970
15918
  {
15971
- "kind": "field",
15972
- "name": "disableAriaExpanded",
15973
- "type": {
15974
- "text": "boolean"
15919
+ "kind": "method",
15920
+ "name": "hasHiddenStyle",
15921
+ "privacy": "private",
15922
+ "parameters": [
15923
+ {
15924
+ "name": "element",
15925
+ "type": {
15926
+ "text": "HTMLElement"
15927
+ },
15928
+ "description": "The element to check."
15929
+ }
15930
+ ],
15931
+ "description": "Checks if the element has inline styles that make it hidden.",
15932
+ "return": {
15933
+ "type": {
15934
+ "text": ""
15935
+ }
15975
15936
  },
15976
- "description": "Disable aria-expanded attribute on trigger element.",
15977
- "default": "false",
15978
- "attribute": "disable-aria-expanded",
15979
- "reflects": true,
15980
15937
  "inheritedFrom": {
15981
15938
  "name": "Popover",
15982
15939
  "module": "components/popover/popover.component.js"
15983
15940
  }
15984
15941
  },
15985
15942
  {
15986
- "kind": "field",
15987
- "name": "arrowElement",
15988
- "type": {
15989
- "text": "HTMLElement | null"
15943
+ "kind": "method",
15944
+ "name": "hasComputedHidden",
15945
+ "privacy": "private",
15946
+ "parameters": [
15947
+ {
15948
+ "name": "element",
15949
+ "type": {
15950
+ "text": "HTMLElement"
15951
+ },
15952
+ "description": "The element to check."
15953
+ }
15954
+ ],
15955
+ "description": "Checks if the element is hidden by a computed style.",
15956
+ "return": {
15957
+ "type": {
15958
+ "text": ""
15959
+ }
15990
15960
  },
15991
- "privacy": "public",
15992
- "default": "null",
15993
15961
  "inheritedFrom": {
15994
15962
  "name": "Popover",
15995
15963
  "module": "components/popover/popover.component.js"
15996
15964
  }
15997
15965
  },
15998
15966
  {
15999
- "kind": "field",
16000
- "name": "triggerElement",
16001
- "type": {
16002
- "text": "HTMLElement | null"
15967
+ "kind": "method",
15968
+ "name": "isHidden",
15969
+ "privacy": "private",
15970
+ "parameters": [
15971
+ {
15972
+ "name": "element",
15973
+ "type": {
15974
+ "text": "HTMLElement"
15975
+ },
15976
+ "description": "The element to check."
15977
+ }
15978
+ ],
15979
+ "description": "Checks if the element is hidden from the user.",
15980
+ "return": {
15981
+ "type": {
15982
+ "text": ""
15983
+ }
16003
15984
  },
16004
- "privacy": "public",
16005
- "default": "null",
16006
15985
  "inheritedFrom": {
16007
15986
  "name": "Popover",
16008
15987
  "module": "components/popover/popover.component.js"
@@ -16010,9 +15989,23 @@
16010
15989
  },
16011
15990
  {
16012
15991
  "kind": "method",
16013
- "name": "setupTriggerListener",
15992
+ "name": "isNotTabbable",
16014
15993
  "privacy": "private",
16015
- "description": "Sets up the trigger event listeners based on the trigger type.",
15994
+ "parameters": [
15995
+ {
15996
+ "name": "element",
15997
+ "type": {
15998
+ "text": "HTMLElement"
15999
+ },
16000
+ "description": "The element to check."
16001
+ }
16002
+ ],
16003
+ "description": "Checks if the element is not tabbable.",
16004
+ "return": {
16005
+ "type": {
16006
+ "text": ""
16007
+ }
16008
+ },
16016
16009
  "inheritedFrom": {
16017
16010
  "name": "Popover",
16018
16011
  "module": "components/popover/popover.component.js"
@@ -16020,57 +16013,109 @@
16020
16013
  },
16021
16014
  {
16022
16015
  "kind": "method",
16023
- "name": "removeEventListeners",
16016
+ "name": "isInteractiveElement",
16024
16017
  "privacy": "private",
16025
- "description": "Removes the trigger event listeners.",
16018
+ "return": {
16019
+ "type": {
16020
+ "text": ""
16021
+ }
16022
+ },
16023
+ "parameters": [
16024
+ {
16025
+ "name": "element",
16026
+ "type": {
16027
+ "text": "HTMLElement"
16028
+ },
16029
+ "description": "The element to check."
16030
+ }
16031
+ ],
16032
+ "description": "Checks if the element is interactive.",
16026
16033
  "inheritedFrom": {
16027
16034
  "name": "Popover",
16028
16035
  "module": "components/popover/popover.component.js"
16029
16036
  }
16030
16037
  },
16031
16038
  {
16032
- "kind": "field",
16033
- "name": "onOutsidePopoverClick",
16039
+ "kind": "method",
16040
+ "name": "isFocusable",
16034
16041
  "privacy": "private",
16035
- "description": "Handles the outside click event to close the popover.",
16036
16042
  "parameters": [
16037
16043
  {
16038
- "description": "The mouse event.",
16039
- "name": "event"
16044
+ "name": "element",
16045
+ "type": {
16046
+ "text": "HTMLElement"
16047
+ },
16048
+ "description": "The element to check."
16040
16049
  }
16041
16050
  ],
16051
+ "description": "Checks if the element is focusable.",
16052
+ "return": {
16053
+ "type": {
16054
+ "text": ""
16055
+ }
16056
+ },
16042
16057
  "inheritedFrom": {
16043
16058
  "name": "Popover",
16044
16059
  "module": "components/popover/popover.component.js"
16045
16060
  }
16046
16061
  },
16047
16062
  {
16048
- "kind": "field",
16049
- "name": "onEscapeKeydown",
16063
+ "kind": "method",
16064
+ "name": "findFocusable",
16050
16065
  "privacy": "private",
16051
- "description": "Handles the escape keydown event to close the popover.",
16066
+ "return": {
16067
+ "type": {
16068
+ "text": ""
16069
+ }
16070
+ },
16052
16071
  "parameters": [
16053
16072
  {
16054
- "description": "The keyboard event.",
16055
- "name": "event"
16073
+ "name": "root",
16074
+ "type": {
16075
+ "text": "ShadowRoot | HTMLElement"
16076
+ },
16077
+ "description": "The root element to search for focusable elements."
16078
+ },
16079
+ {
16080
+ "name": "matches",
16081
+ "default": "new Set()",
16082
+ "type": {
16083
+ "text": "Set<HTMLElement>"
16084
+ },
16085
+ "description": "The set of focusable elements."
16056
16086
  }
16057
16087
  ],
16088
+ "description": "Recursively finds all focusable elements within the given root and its descendants.",
16058
16089
  "inheritedFrom": {
16059
16090
  "name": "Popover",
16060
16091
  "module": "components/popover/popover.component.js"
16061
16092
  }
16062
16093
  },
16063
16094
  {
16064
- "kind": "field",
16065
- "name": "onPopoverFocusOut",
16066
- "privacy": "private",
16067
- "description": "Handles the popover focus out event.",
16095
+ "kind": "method",
16096
+ "name": "setFocusableElements",
16097
+ "privacy": "public",
16098
+ "description": "Updates the list of focusable elements within the component's shadow root.",
16099
+ "inheritedFrom": {
16100
+ "name": "Popover",
16101
+ "module": "components/popover/popover.component.js"
16102
+ }
16103
+ },
16104
+ {
16105
+ "kind": "method",
16106
+ "name": "setInitialFocus",
16107
+ "privacy": "public",
16068
16108
  "parameters": [
16069
16109
  {
16070
- "description": "The focus event.",
16071
- "name": "event"
16110
+ "name": "prefferableElement",
16111
+ "default": "0",
16112
+ "type": {
16113
+ "text": "number"
16114
+ },
16115
+ "description": "The index of the prefferable element to focus."
16072
16116
  }
16073
16117
  ],
16118
+ "description": "Sets the initial focus within the container.",
16074
16119
  "inheritedFrom": {
16075
16120
  "name": "Popover",
16076
16121
  "module": "components/popover/popover.component.js"
@@ -16078,75 +16123,100 @@
16078
16123
  },
16079
16124
  {
16080
16125
  "kind": "method",
16081
- "name": "isOpenUpdated",
16126
+ "name": "calculateNextIndex",
16082
16127
  "privacy": "private",
16083
16128
  "parameters": [
16084
16129
  {
16085
- "name": "oldValue",
16130
+ "name": "currentIndex",
16086
16131
  "type": {
16087
- "text": "boolean"
16132
+ "text": "number"
16088
16133
  },
16089
- "description": "The old value of the visible property."
16134
+ "description": "The current index."
16090
16135
  },
16091
16136
  {
16092
- "name": "newValue",
16137
+ "name": "step",
16093
16138
  "type": {
16094
- "text": "boolean"
16139
+ "text": "number"
16095
16140
  },
16096
- "description": "The new value of the visible property."
16141
+ "description": "The step to calculate the next index."
16097
16142
  }
16098
16143
  ],
16099
- "description": "Handles the popover visibility change and position the popover.\nHandles the exit event to close the popover.",
16144
+ "description": "Calculates the next index for the focus trap.",
16145
+ "return": {
16146
+ "type": {
16147
+ "text": ""
16148
+ }
16149
+ },
16100
16150
  "inheritedFrom": {
16101
16151
  "name": "Popover",
16102
16152
  "module": "components/popover/popover.component.js"
16103
16153
  }
16104
16154
  },
16105
16155
  {
16106
- "kind": "field",
16107
- "name": "startCloseDelay",
16156
+ "kind": "method",
16157
+ "name": "getDeepActiveElement",
16108
16158
  "privacy": "private",
16109
- "description": "Starts the close delay timer.\nIf the popover is not interactive, it will close the popover after the delay.",
16159
+ "description": "Returns the deepest active element in the shadow DOM.",
16160
+ "return": {
16161
+ "type": {
16162
+ "text": ""
16163
+ }
16164
+ },
16110
16165
  "inheritedFrom": {
16111
16166
  "name": "Popover",
16112
16167
  "module": "components/popover/popover.component.js"
16113
16168
  }
16114
16169
  },
16115
16170
  {
16116
- "kind": "field",
16117
- "name": "cancelCloseDelay",
16171
+ "kind": "method",
16172
+ "name": "findElement",
16118
16173
  "privacy": "private",
16119
- "description": "Cancels the close delay timer.",
16120
- "inheritedFrom": {
16121
- "name": "Popover",
16122
- "module": "components/popover/popover.component.js"
16123
- }
16124
- },
16125
- {
16126
- "kind": "field",
16127
- "name": "showPopover",
16128
- "privacy": "public",
16129
- "description": "Shows the popover.",
16130
- "inheritedFrom": {
16131
- "name": "Popover",
16132
- "module": "components/popover/popover.component.js"
16133
- }
16134
- },
16135
- {
16136
- "kind": "field",
16137
- "name": "hidePopover",
16138
- "privacy": "public",
16139
- "description": "Hides the popover.",
16174
+ "parameters": [
16175
+ {
16176
+ "name": "activeElement",
16177
+ "type": {
16178
+ "text": "HTMLElement"
16179
+ },
16180
+ "description": "The active element."
16181
+ }
16182
+ ],
16183
+ "description": "Finds the index of the active element within the focusable elements.",
16184
+ "return": {
16185
+ "type": {
16186
+ "text": ""
16187
+ }
16188
+ },
16140
16189
  "inheritedFrom": {
16141
16190
  "name": "Popover",
16142
16191
  "module": "components/popover/popover.component.js"
16143
16192
  }
16144
16193
  },
16145
16194
  {
16146
- "kind": "field",
16147
- "name": "togglePopoverVisible",
16148
- "privacy": "public",
16149
- "description": "Toggles the popover visibility.",
16195
+ "kind": "method",
16196
+ "name": "isEqualFocusNode",
16197
+ "privacy": "private",
16198
+ "parameters": [
16199
+ {
16200
+ "name": "activeElement",
16201
+ "type": {
16202
+ "text": "HTMLElement"
16203
+ },
16204
+ "description": "The active element."
16205
+ },
16206
+ {
16207
+ "name": "element",
16208
+ "type": {
16209
+ "text": "HTMLElement"
16210
+ },
16211
+ "description": "The element to compare."
16212
+ }
16213
+ ],
16214
+ "description": "Checks if the active element is equal to the given element.",
16215
+ "return": {
16216
+ "type": {
16217
+ "text": ""
16218
+ }
16219
+ },
16150
16220
  "inheritedFrom": {
16151
16221
  "name": "Popover",
16152
16222
  "module": "components/popover/popover.component.js"
@@ -16154,9 +16224,18 @@
16154
16224
  },
16155
16225
  {
16156
16226
  "kind": "method",
16157
- "name": "handleCreatePopoverFirstUpdate",
16227
+ "name": "trapFocus",
16158
16228
  "privacy": "private",
16159
- "description": "Sets the focusable elements inside the popover.",
16229
+ "parameters": [
16230
+ {
16231
+ "name": "direction",
16232
+ "type": {
16233
+ "text": "boolean"
16234
+ },
16235
+ "description": "The direction of the focus trap.\nIf true, the focus will be trapped in the previous element."
16236
+ }
16237
+ ],
16238
+ "description": "Traps focus within the container.",
16160
16239
  "inheritedFrom": {
16161
16240
  "name": "Popover",
16162
16241
  "module": "components/popover/popover.component.js"
@@ -16164,9 +16243,18 @@
16164
16243
  },
16165
16244
  {
16166
16245
  "kind": "method",
16167
- "name": "positionPopover",
16246
+ "name": "handleKeydown",
16168
16247
  "privacy": "private",
16169
- "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.",
16248
+ "parameters": [
16249
+ {
16250
+ "name": "event",
16251
+ "type": {
16252
+ "text": "KeyboardEvent"
16253
+ },
16254
+ "description": "The keyboard event."
16255
+ }
16256
+ ],
16257
+ "description": "Traps focus within the container.",
16170
16258
  "inheritedFrom": {
16171
16259
  "name": "Popover",
16172
16260
  "module": "components/popover/popover.component.js"
@@ -16174,1140 +16262,1052 @@
16174
16262
  },
16175
16263
  {
16176
16264
  "kind": "field",
16177
- "name": "utils",
16178
- "default": "new PopoverUtils(this)",
16179
- "inheritedFrom": {
16180
- "name": "Popover",
16181
- "module": "components/popover/popover.component.js"
16182
- }
16183
- }
16184
- ],
16185
- "events": [
16186
- {
16187
- "description": "(React: onShown) This event is dispatched when the tooltip is shown",
16188
- "name": "shown",
16189
- "reactName": "onShown",
16190
- "eventName": "ShownEvent",
16191
- "inheritedFrom": {
16192
- "name": "Popover",
16193
- "module": "src/components/popover/popover.component.ts"
16194
- }
16195
- },
16196
- {
16197
- "description": "(React: onHidden) This event is dispatched when the tooltip is hidden",
16198
- "name": "hidden",
16199
- "reactName": "onHidden",
16200
- "eventName": "HiddenEvent",
16201
- "inheritedFrom": {
16202
- "name": "Popover",
16203
- "module": "src/components/popover/popover.component.ts"
16204
- }
16205
- },
16206
- {
16207
- "description": "(React: onCreated) This event is dispatched when the tooltip is created (added to the DOM)",
16208
- "name": "created",
16209
- "reactName": "onCreated",
16210
- "eventName": "CreatedEvent",
16211
- "inheritedFrom": {
16212
- "name": "Popover",
16213
- "module": "src/components/popover/popover.component.ts"
16214
- }
16215
- },
16216
- {
16217
- "description": "(React: onDestroyed) This event is dispatched when the tooltip is destroyed (removed from the DOM)",
16218
- "name": "destroyed",
16219
- "reactName": "onDestroyed",
16220
- "eventName": "DestroyedEvent",
16221
- "inheritedFrom": {
16222
- "name": "Popover",
16223
- "module": "src/components/popover/popover.component.ts"
16224
- }
16225
- }
16226
- ],
16227
- "attributes": [
16228
- {
16229
- "name": "tooltip-type",
16230
- "type": {
16231
- "text": "TooltipType"
16232
- },
16233
- "description": "The type of tooltip.\n- **description** sets aria-describedby on the trigger component which refers to the tooltip id.\n- **label** sets aria-labelledby on the trigger component which refers to the tooltip id.\n- **none** no aria props set on trigger component referring to the tooltip id.",
16234
- "default": "'description'",
16235
- "fieldName": "tooltipType"
16236
- },
16237
- {
16238
- "name": "enabledFocusTrap",
16239
- "type": {
16240
- "text": "boolean"
16241
- },
16242
- "description": "Determines whether the focus trap is enabled.\nIf true, focus will be restricted to the content within this component.",
16243
- "default": "false",
16244
- "fieldName": "enabledFocusTrap",
16245
- "inheritedFrom": {
16246
- "name": "Popover",
16247
- "module": "src/components/popover/popover.component.ts"
16248
- }
16249
- },
16250
- {
16251
- "name": "enabledPreventScroll",
16252
- "type": {
16253
- "text": "boolean"
16254
- },
16255
- "description": "Prevent outside scrolling when popover show.",
16256
- "default": "false",
16257
- "fieldName": "enabledPreventScroll",
16258
- "inheritedFrom": {
16259
- "name": "Popover",
16260
- "module": "src/components/popover/popover.component.ts"
16261
- }
16262
- },
16263
- {
16264
16265
  "name": "id",
16265
16266
  "type": {
16266
16267
  "text": "string"
16267
16268
  },
16268
16269
  "default": "''",
16269
16270
  "description": "The unique ID of the popover.",
16270
- "fieldName": "id",
16271
+ "attribute": "id",
16272
+ "reflects": true,
16271
16273
  "inheritedFrom": {
16272
16274
  "name": "Popover",
16273
- "module": "src/components/popover/popover.component.ts"
16275
+ "module": "components/popover/popover.component.js"
16274
16276
  }
16275
16277
  },
16276
16278
  {
16279
+ "kind": "field",
16277
16280
  "name": "triggerID",
16278
16281
  "type": {
16279
16282
  "text": "string"
16280
16283
  },
16281
16284
  "default": "''",
16282
16285
  "description": "The ID of the element that triggers the popover.\nThis attribute is required for the popover to work.",
16283
- "fieldName": "triggerID",
16286
+ "attribute": "triggerID",
16287
+ "reflects": true,
16284
16288
  "inheritedFrom": {
16285
16289
  "name": "Popover",
16286
- "module": "src/components/popover/popover.component.ts"
16290
+ "module": "components/popover/popover.component.js"
16287
16291
  }
16288
16292
  },
16289
16293
  {
16294
+ "kind": "field",
16290
16295
  "name": "trigger",
16291
16296
  "type": {
16292
16297
  "text": "PopoverTrigger"
16293
16298
  },
16294
16299
  "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**",
16295
16300
  "default": "click",
16296
- "fieldName": "trigger",
16301
+ "attribute": "trigger",
16302
+ "reflects": true,
16297
16303
  "inheritedFrom": {
16298
16304
  "name": "Popover",
16299
- "module": "src/components/popover/popover.component.ts"
16305
+ "module": "components/popover/popover.component.js"
16300
16306
  }
16301
16307
  },
16302
16308
  {
16309
+ "kind": "field",
16303
16310
  "name": "placement",
16304
16311
  "type": {
16305
16312
  "text": "PopoverPlacement"
16306
16313
  },
16307
16314
  "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**",
16308
16315
  "default": "bottom",
16309
- "fieldName": "placement",
16316
+ "attribute": "placement",
16317
+ "reflects": true,
16310
16318
  "inheritedFrom": {
16311
16319
  "name": "Popover",
16312
- "module": "src/components/popover/popover.component.ts"
16320
+ "module": "components/popover/popover.component.js"
16313
16321
  }
16314
16322
  },
16315
16323
  {
16324
+ "kind": "field",
16316
16325
  "name": "color",
16317
16326
  "type": {
16318
16327
  "text": "PopoverColor"
16319
16328
  },
16320
16329
  "description": "Color of the popover\n- **tonal**\n- **contrast**",
16321
16330
  "default": "tonal",
16322
- "fieldName": "color",
16331
+ "attribute": "color",
16332
+ "reflects": true,
16323
16333
  "inheritedFrom": {
16324
16334
  "name": "Popover",
16325
- "module": "src/components/popover/popover.component.ts"
16335
+ "module": "components/popover/popover.component.js"
16326
16336
  }
16327
16337
  },
16328
16338
  {
16339
+ "kind": "field",
16329
16340
  "name": "visible",
16330
16341
  "type": {
16331
16342
  "text": "boolean"
16332
16343
  },
16333
16344
  "description": "The visibility of the popover.",
16334
16345
  "default": "false",
16335
- "fieldName": "visible",
16346
+ "attribute": "visible",
16347
+ "reflects": true,
16336
16348
  "inheritedFrom": {
16337
16349
  "name": "Popover",
16338
- "module": "src/components/popover/popover.component.ts"
16350
+ "module": "components/popover/popover.component.js"
16339
16351
  }
16340
16352
  },
16341
16353
  {
16354
+ "kind": "field",
16342
16355
  "name": "offset",
16343
16356
  "type": {
16344
16357
  "text": "number"
16345
16358
  },
16346
16359
  "description": "The offset of the popover.",
16347
16360
  "default": "4",
16348
- "fieldName": "offset",
16361
+ "attribute": "offset",
16362
+ "reflects": true,
16349
16363
  "inheritedFrom": {
16350
16364
  "name": "Popover",
16351
- "module": "src/components/popover/popover.component.ts"
16365
+ "module": "components/popover/popover.component.js"
16352
16366
  }
16353
16367
  },
16354
16368
  {
16355
- "name": "focus-trap",
16369
+ "kind": "field",
16370
+ "name": "focusTrap",
16356
16371
  "type": {
16357
16372
  "text": "boolean"
16358
16373
  },
16359
16374
  "description": "Determines whether the focus trap is enabled.\nIf true, focus will be restricted to the content within this component.",
16360
16375
  "default": "false",
16361
- "fieldName": "focusTrap",
16376
+ "attribute": "focus-trap",
16377
+ "reflects": true,
16362
16378
  "inheritedFrom": {
16363
16379
  "name": "Popover",
16364
- "module": "src/components/popover/popover.component.ts"
16380
+ "module": "components/popover/popover.component.js"
16365
16381
  }
16366
16382
  },
16367
16383
  {
16368
- "name": "prevent-scroll",
16384
+ "kind": "field",
16385
+ "name": "preventScroll",
16369
16386
  "type": {
16370
16387
  "text": "boolean"
16371
16388
  },
16372
16389
  "description": "Prevent outside scrolling when popover show.",
16373
16390
  "default": "false",
16374
- "fieldName": "preventScroll",
16391
+ "attribute": "prevent-scroll",
16392
+ "reflects": true,
16375
16393
  "inheritedFrom": {
16376
16394
  "name": "Popover",
16377
- "module": "src/components/popover/popover.component.ts"
16395
+ "module": "components/popover/popover.component.js"
16378
16396
  }
16379
16397
  },
16380
16398
  {
16381
- "name": "show-arrow",
16399
+ "kind": "field",
16400
+ "name": "showArrow",
16382
16401
  "type": {
16383
16402
  "text": "boolean"
16384
16403
  },
16385
16404
  "description": "The arrow visibility of the popover.",
16386
16405
  "default": "false",
16387
- "fieldName": "showArrow",
16406
+ "attribute": "show-arrow",
16407
+ "reflects": true,
16388
16408
  "inheritedFrom": {
16389
16409
  "name": "Popover",
16390
- "module": "src/components/popover/popover.component.ts"
16410
+ "module": "components/popover/popover.component.js"
16391
16411
  }
16392
16412
  },
16393
16413
  {
16394
- "name": "close-button",
16414
+ "kind": "field",
16415
+ "name": "closeButton",
16395
16416
  "type": {
16396
16417
  "text": "boolean"
16397
16418
  },
16398
16419
  "description": "The close button visibility of the popover.",
16399
16420
  "default": "false",
16400
- "fieldName": "closeButton",
16421
+ "attribute": "close-button",
16422
+ "reflects": true,
16401
16423
  "inheritedFrom": {
16402
16424
  "name": "Popover",
16403
- "module": "src/components/popover/popover.component.ts"
16425
+ "module": "components/popover/popover.component.js"
16404
16426
  }
16405
16427
  },
16406
16428
  {
16429
+ "kind": "field",
16407
16430
  "name": "interactive",
16408
16431
  "type": {
16409
16432
  "text": "boolean"
16410
16433
  },
16411
16434
  "description": "Determines whether the popover is interactive。",
16412
16435
  "default": "false",
16413
- "fieldName": "interactive",
16436
+ "attribute": "interactive",
16437
+ "reflects": true,
16414
16438
  "inheritedFrom": {
16415
16439
  "name": "Popover",
16416
- "module": "src/components/popover/popover.component.ts"
16440
+ "module": "components/popover/popover.component.js"
16417
16441
  }
16418
16442
  },
16419
16443
  {
16444
+ "kind": "field",
16420
16445
  "name": "delay",
16421
16446
  "type": {
16422
16447
  "text": "string"
16423
16448
  },
16424
16449
  "description": "The delay of the show/hide popover.",
16425
16450
  "default": "0,0",
16426
- "fieldName": "delay",
16451
+ "attribute": "delay",
16452
+ "reflects": true,
16427
16453
  "inheritedFrom": {
16428
16454
  "name": "Popover",
16429
- "module": "src/components/popover/popover.component.ts"
16455
+ "module": "components/popover/popover.component.js"
16430
16456
  }
16431
16457
  },
16432
16458
  {
16433
- "name": "hide-on-escape",
16459
+ "kind": "field",
16460
+ "name": "hideOnEscape",
16434
16461
  "type": {
16435
16462
  "text": "boolean"
16436
16463
  },
16437
16464
  "description": "Hide popover on escape key press.",
16438
16465
  "default": "false",
16439
- "fieldName": "hideOnEscape",
16466
+ "attribute": "hide-on-escape",
16467
+ "reflects": true,
16440
16468
  "inheritedFrom": {
16441
16469
  "name": "Popover",
16442
- "module": "src/components/popover/popover.component.ts"
16470
+ "module": "components/popover/popover.component.js"
16443
16471
  }
16444
16472
  },
16445
16473
  {
16446
- "name": "hide-on-blur",
16474
+ "kind": "field",
16475
+ "name": "hideOnBlur",
16447
16476
  "type": {
16448
16477
  "text": "boolean"
16449
16478
  },
16450
16479
  "description": "Hide popover on blur.",
16451
16480
  "default": "false",
16452
- "fieldName": "hideOnBlur",
16481
+ "attribute": "hide-on-blur",
16482
+ "reflects": true,
16453
16483
  "inheritedFrom": {
16454
16484
  "name": "Popover",
16455
- "module": "src/components/popover/popover.component.ts"
16485
+ "module": "components/popover/popover.component.js"
16456
16486
  }
16457
16487
  },
16458
16488
  {
16459
- "name": "hide-on-outside-click",
16489
+ "kind": "field",
16490
+ "name": "hideOnOutsideClick",
16460
16491
  "type": {
16461
16492
  "text": "boolean"
16462
16493
  },
16463
16494
  "description": "Hide on outside click of the popover.",
16464
16495
  "default": "false",
16465
- "fieldName": "hideOnOutsideClick",
16496
+ "attribute": "hide-on-outside-click",
16497
+ "reflects": true,
16466
16498
  "inheritedFrom": {
16467
16499
  "name": "Popover",
16468
- "module": "src/components/popover/popover.component.ts"
16500
+ "module": "components/popover/popover.component.js"
16469
16501
  }
16470
16502
  },
16471
16503
  {
16472
- "name": "focus-back-to-trigger",
16504
+ "kind": "field",
16505
+ "name": "focusBackToTrigger",
16473
16506
  "type": {
16474
16507
  "text": "boolean"
16475
16508
  },
16476
16509
  "description": "The focus back to trigger after the popover hide.",
16477
16510
  "default": "false",
16478
- "fieldName": "focusBackToTrigger",
16511
+ "attribute": "focus-back-to-trigger",
16512
+ "reflects": true,
16479
16513
  "inheritedFrom": {
16480
16514
  "name": "Popover",
16481
- "module": "src/components/popover/popover.component.ts"
16515
+ "module": "components/popover/popover.component.js"
16482
16516
  }
16483
16517
  },
16484
16518
  {
16519
+ "kind": "field",
16485
16520
  "name": "backdrop",
16486
16521
  "type": {
16487
16522
  "text": "boolean"
16488
16523
  },
16489
16524
  "description": "Determines whether the popover with backdrop.\nOther than popover and trigger element, the rest of the screen will be covered with a backdrop.",
16490
16525
  "default": "false",
16491
- "fieldName": "backdrop",
16526
+ "attribute": "backdrop",
16527
+ "reflects": true,
16492
16528
  "inheritedFrom": {
16493
16529
  "name": "Popover",
16494
- "module": "src/components/popover/popover.component.ts"
16530
+ "module": "components/popover/popover.component.js"
16495
16531
  }
16496
16532
  },
16497
16533
  {
16534
+ "kind": "field",
16498
16535
  "name": "flip",
16499
16536
  "type": {
16500
16537
  "text": "boolean"
16501
16538
  },
16502
16539
  "description": "Changes the placement of popover to keep it in view when scrolling.",
16503
16540
  "default": "true",
16504
- "fieldName": "flip",
16541
+ "attribute": "flip",
16542
+ "reflects": true,
16505
16543
  "inheritedFrom": {
16506
16544
  "name": "Popover",
16507
- "module": "src/components/popover/popover.component.ts"
16545
+ "module": "components/popover/popover.component.js"
16508
16546
  }
16509
16547
  },
16510
16548
  {
16549
+ "kind": "field",
16511
16550
  "name": "size",
16512
16551
  "type": {
16513
16552
  "text": "boolean"
16514
16553
  },
16515
16554
  "description": "Changes the size of popover to keep it in view when scrolling.",
16516
16555
  "default": "false",
16517
- "fieldName": "size",
16556
+ "attribute": "size",
16557
+ "reflects": true,
16518
16558
  "inheritedFrom": {
16519
16559
  "name": "Popover",
16520
- "module": "src/components/popover/popover.component.ts"
16560
+ "module": "components/popover/popover.component.js"
16521
16561
  }
16522
16562
  },
16523
16563
  {
16524
- "name": "z-index",
16564
+ "kind": "field",
16565
+ "name": "zIndex",
16525
16566
  "type": {
16526
16567
  "text": "number"
16527
16568
  },
16528
16569
  "description": "The z-index of the popover.",
16529
16570
  "default": "1000",
16530
- "fieldName": "zIndex",
16571
+ "attribute": "z-index",
16572
+ "reflects": true,
16531
16573
  "inheritedFrom": {
16532
16574
  "name": "Popover",
16533
- "module": "src/components/popover/popover.component.ts"
16575
+ "module": "components/popover/popover.component.js"
16534
16576
  }
16535
16577
  },
16536
16578
  {
16537
- "name": "append-to",
16579
+ "kind": "field",
16580
+ "name": "appendTo",
16538
16581
  "type": {
16539
16582
  "text": "string"
16540
16583
  },
16541
16584
  "default": "''",
16542
16585
  "description": "Element ID that the popover append to.",
16543
- "fieldName": "appendTo",
16586
+ "attribute": "append-to",
16587
+ "reflects": true,
16544
16588
  "inheritedFrom": {
16545
16589
  "name": "Popover",
16546
- "module": "src/components/popover/popover.component.ts"
16590
+ "module": "components/popover/popover.component.js"
16547
16591
  }
16548
16592
  },
16549
16593
  {
16550
- "name": "close-button-aria-label",
16594
+ "kind": "field",
16595
+ "name": "closeButtonAriaLabel",
16551
16596
  "type": {
16552
16597
  "text": "string | null"
16553
16598
  },
16554
16599
  "default": "null",
16555
16600
  "description": "aria-label attribute to be set for close button accessibility.",
16556
- "fieldName": "closeButtonAriaLabel",
16601
+ "attribute": "close-button-aria-label",
16557
16602
  "inheritedFrom": {
16558
16603
  "name": "Popover",
16559
- "module": "src/components/popover/popover.component.ts"
16604
+ "module": "components/popover/popover.component.js"
16560
16605
  }
16561
16606
  },
16562
16607
  {
16608
+ "kind": "field",
16563
16609
  "name": "role",
16564
16610
  "type": {
16565
16611
  "text": "HTMLElement['role']"
16566
16612
  },
16567
16613
  "description": "Role of the popover",
16568
16614
  "default": "dialog",
16569
- "fieldName": "role",
16615
+ "attribute": "role",
16616
+ "reflects": true,
16570
16617
  "inheritedFrom": {
16571
16618
  "name": "Popover",
16572
- "module": "src/components/popover/popover.component.ts"
16619
+ "module": "components/popover/popover.component.js"
16573
16620
  }
16574
16621
  },
16575
16622
  {
16576
- "name": "aria-labelledby",
16623
+ "kind": "field",
16624
+ "name": "ariaLabelledby",
16577
16625
  "type": {
16578
16626
  "text": "string | null"
16579
16627
  },
16580
16628
  "default": "null",
16581
16629
  "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.",
16582
- "fieldName": "ariaLabelledby",
16630
+ "attribute": "aria-labelledby",
16631
+ "reflects": true,
16583
16632
  "inheritedFrom": {
16584
16633
  "name": "Popover",
16585
- "module": "src/components/popover/popover.component.ts"
16634
+ "module": "components/popover/popover.component.js"
16586
16635
  }
16587
16636
  },
16588
16637
  {
16589
- "name": "aria-describedby",
16638
+ "kind": "field",
16639
+ "name": "ariaDescribedby",
16590
16640
  "type": {
16591
16641
  "text": "string | null"
16592
16642
  },
16593
16643
  "default": "null",
16594
16644
  "description": "aria-describedby of the popover.",
16595
- "fieldName": "ariaDescribedby",
16596
- "inheritedFrom": {
16597
- "name": "Popover",
16598
- "module": "src/components/popover/popover.component.ts"
16599
- }
16600
- },
16601
- {
16602
- "name": "disable-aria-expanded",
16603
- "type": {
16604
- "text": "boolean"
16605
- },
16606
- "description": "Disable aria-expanded attribute on trigger element.",
16607
- "default": "false",
16608
- "fieldName": "disableAriaExpanded",
16609
- "inheritedFrom": {
16610
- "name": "Popover",
16611
- "module": "src/components/popover/popover.component.ts"
16612
- }
16613
- }
16614
- ],
16615
- "superclass": {
16616
- "name": "Popover",
16617
- "module": "/src/components/popover/popover.component"
16618
- },
16619
- "tagName": "mdc-tooltip",
16620
- "jsDoc": "/**\n * A tooltip is triggered by mouse hover or by keyboard focus\n * and will disappear upon mouse exit or focus change.\n *\n * Note: Tooltips cannot contain content that can be focused or interacted with.\n *\n * @tagname mdc-tooltip\n *\n * @event shown - (React: onShown) This event is dispatched when the tooltip is shown\n * @event hidden - (React: onHidden) This event is dispatched when the tooltip is hidden\n * @event created - (React: onCreated) This event is dispatched when the tooltip is created (added to the DOM)\n * @event destroyed - (React: onDestroyed) This event is dispatched when the tooltip is destroyed (removed from the DOM)\n *\n * @cssproperty --mdc-tooltip-max-width - The maximum width of the tooltip.\n * @cssproperty --mdc-tooltip-padding - The padding of the tooltip.\n * @cssproperty --mdc-tooltip-text-color - The text color of the tooltip.\n * @cssproperty --mdc-tooltip-text-color-contrast - The text color of the tooltip when the color is contrast.\n *\n */",
16621
- "customElement": true,
16622
- "slots": [
16623
- {
16624
- "description": "Default slot for the popover content",
16625
- "name": "",
16626
- "inheritedFrom": {
16627
- "name": "Popover",
16628
- "module": "src/components/popover/popover.component.ts"
16629
- }
16630
- }
16631
- ]
16632
- }
16633
- ],
16634
- "exports": [
16635
- {
16636
- "kind": "js",
16637
- "name": "default",
16638
- "declaration": {
16639
- "name": "Tooltip",
16640
- "module": "components/tooltip/tooltip.component.js"
16641
- }
16642
- }
16643
- ]
16644
- },
16645
- {
16646
- "kind": "javascript-module",
16647
- "path": "components/toggle/toggle.component.js",
16648
- "declarations": [
16649
- {
16650
- "kind": "class",
16651
- "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.",
16652
- "name": "Toggle",
16653
- "cssProperties": [
16654
- {
16655
- "description": "width of the toggle",
16656
- "name": "--mdc-toggle-width"
16657
- },
16658
- {
16659
- "description": "height of the toggle",
16660
- "name": "--mdc-toggle-height"
16661
- },
16662
- {
16663
- "description": "width of the toggle when it's size is compact",
16664
- "name": "--mdc-toggle-width-compact"
16665
- },
16666
- {
16667
- "description": "height of the toggle when it's size is compact",
16668
- "name": "--mdc-toggle-height-compact"
16669
- },
16670
- {
16671
- "description": "border radius of the toggle",
16672
- "name": "--mdc-toggle-border-radius"
16673
- },
16674
- {
16675
- "description": "border radius of the toggle when it's size is compact",
16676
- "name": "--mdc-toggle-border-radius-compact"
16677
- },
16678
- {
16679
- "description": "border of the toggle",
16680
- "name": "--mdc-toggle-border"
16681
- },
16682
- {
16683
- "description": "background color of the inactive toggle in rest state",
16684
- "name": "--mdc-toggle-inactive-rest-color"
16685
- },
16686
- {
16687
- "description": "background color of the inactive toggle in hover state",
16688
- "name": "--mdc-toggle-inactive-hover-color"
16689
- },
16690
- {
16691
- "description": "background color of the inactive toggle in pressed state",
16692
- "name": "--mdc-toggle-inactive-pressed-color"
16693
- },
16694
- {
16695
- "description": "background color of the inactive toggle in disabled state",
16696
- "name": "--mdc-toggle-inactive-disabled-color"
16697
- },
16698
- {
16699
- "description": "background color of the active toggle in rest state",
16700
- "name": "--mdc-toggle-active-rest-color"
16701
- },
16702
- {
16703
- "description": "background color of the active toggle in hover state",
16704
- "name": "--mdc-toggle-active-hover-color"
16705
- },
16706
- {
16707
- "description": "background color of the active toggle in pressed state",
16708
- "name": "--mdc-toggle-active-pressed-color"
16709
- },
16710
- {
16711
- "description": "background color of the active toggle in disabled state",
16712
- "name": "--mdc-toggle-active-disabled-color"
16713
- },
16714
- {
16715
- "description": " color of the help text label",
16716
- "name": "--mdc-toggle-help-text-color"
16645
+ "attribute": "aria-describedby",
16646
+ "reflects": true,
16647
+ "inheritedFrom": {
16648
+ "name": "Popover",
16649
+ "module": "components/popover/popover.component.js"
16650
+ }
16717
16651
  },
16718
- {
16719
- "description": "color of the toggle label and help text in disabled state",
16720
- "name": "--mdc-toggle-label-color-disabled"
16721
- }
16722
- ],
16723
- "members": [
16724
16652
  {
16725
16653
  "kind": "field",
16726
- "name": "checked",
16654
+ "name": "disableAriaExpanded",
16727
16655
  "type": {
16728
16656
  "text": "boolean"
16729
16657
  },
16658
+ "description": "Disable aria-expanded attribute on trigger element.",
16730
16659
  "default": "false",
16731
- "description": "Determines whether the toggle is active or inactive.",
16732
- "attribute": "checked",
16733
- "reflects": true
16660
+ "attribute": "disable-aria-expanded",
16661
+ "reflects": true,
16662
+ "inheritedFrom": {
16663
+ "name": "Popover",
16664
+ "module": "components/popover/popover.component.js"
16665
+ }
16734
16666
  },
16735
16667
  {
16736
16668
  "kind": "field",
16737
- "name": "size",
16669
+ "name": "arrowElement",
16738
16670
  "type": {
16739
- "text": "ToggleSize"
16671
+ "text": "HTMLElement | null"
16740
16672
  },
16741
- "description": "Determines toggle size in rem (height is specified here).\n- **Default**: 1.5\n- **Compact**: 1",
16742
- "default": "default",
16743
- "attribute": "size",
16744
- "reflects": true
16673
+ "privacy": "public",
16674
+ "default": "null",
16675
+ "inheritedFrom": {
16676
+ "name": "Popover",
16677
+ "module": "components/popover/popover.component.js"
16678
+ }
16745
16679
  },
16746
16680
  {
16747
16681
  "kind": "field",
16748
- "name": "autofocus",
16682
+ "name": "triggerElement",
16749
16683
  "type": {
16750
- "text": "boolean"
16684
+ "text": "HTMLElement | null"
16751
16685
  },
16752
- "default": "false",
16753
- "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)",
16754
- "attribute": "autofocus",
16755
- "reflects": true
16686
+ "privacy": "public",
16687
+ "default": "null",
16688
+ "inheritedFrom": {
16689
+ "name": "Popover",
16690
+ "module": "components/popover/popover.component.js"
16691
+ }
16756
16692
  },
16757
16693
  {
16758
16694
  "kind": "method",
16759
- "name": "manageRequired",
16695
+ "name": "setupTriggerListener",
16760
16696
  "privacy": "private",
16761
- "description": "Manages the required state of the checkbox.\nIf the checkbox is not checked and the requiredLabel property is set, then the checkbox is invalid."
16697
+ "description": "Sets up the trigger event listeners based on the trigger type.",
16698
+ "inheritedFrom": {
16699
+ "name": "Popover",
16700
+ "module": "components/popover/popover.component.js"
16701
+ }
16762
16702
  },
16763
16703
  {
16764
16704
  "kind": "method",
16765
- "name": "setFormValue",
16705
+ "name": "removeEventListeners",
16766
16706
  "privacy": "private",
16767
- "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."
16707
+ "description": "Removes the trigger event listeners.",
16708
+ "inheritedFrom": {
16709
+ "name": "Popover",
16710
+ "module": "components/popover/popover.component.js"
16711
+ }
16768
16712
  },
16769
16713
  {
16770
- "kind": "method",
16771
- "name": "toggleState",
16714
+ "kind": "field",
16715
+ "name": "onOutsidePopoverClick",
16772
16716
  "privacy": "private",
16773
- "return": {
16774
- "type": {
16775
- "text": "void"
16717
+ "description": "Handles the outside click event to close the popover.",
16718
+ "parameters": [
16719
+ {
16720
+ "description": "The mouse event.",
16721
+ "name": "event"
16776
16722
  }
16777
- },
16778
- "description": "Toggles the state of the toggle element.\nIf the element is not disabled, then the checked property is toggled."
16723
+ ],
16724
+ "inheritedFrom": {
16725
+ "name": "Popover",
16726
+ "module": "components/popover/popover.component.js"
16727
+ }
16779
16728
  },
16780
16729
  {
16781
- "kind": "method",
16782
- "name": "handleKeyDown",
16730
+ "kind": "field",
16731
+ "name": "onEscapeKeydown",
16783
16732
  "privacy": "private",
16784
- "return": {
16785
- "type": {
16786
- "text": "void"
16787
- }
16788
- },
16733
+ "description": "Handles the escape keydown event to close the popover.",
16789
16734
  "parameters": [
16790
16735
  {
16791
- "name": "event",
16792
- "type": {
16793
- "text": "KeyboardEvent"
16794
- },
16795
- "description": "The keyboard event."
16736
+ "description": "The keyboard event.",
16737
+ "name": "event"
16796
16738
  }
16797
16739
  ],
16798
- "description": "Handles the keydown event on the toggle element.\nWhen the user presses Enter, the form is submitted."
16740
+ "inheritedFrom": {
16741
+ "name": "Popover",
16742
+ "module": "components/popover/popover.component.js"
16743
+ }
16799
16744
  },
16800
16745
  {
16801
- "kind": "method",
16802
- "name": "handleChange",
16746
+ "kind": "field",
16747
+ "name": "onPopoverFocusOut",
16803
16748
  "privacy": "private",
16749
+ "description": "Handles the popover focus out event.",
16804
16750
  "parameters": [
16805
16751
  {
16806
- "name": "event",
16807
- "type": {
16808
- "text": "Event"
16809
- }
16752
+ "description": "The focus event.",
16753
+ "name": "event"
16810
16754
  }
16811
16755
  ],
16812
- "description": "Toggles the state of the toggle element.\nand dispatch the new change event."
16756
+ "inheritedFrom": {
16757
+ "name": "Popover",
16758
+ "module": "components/popover/popover.component.js"
16759
+ }
16813
16760
  },
16814
16761
  {
16815
16762
  "kind": "method",
16816
- "name": "setToggleSize",
16763
+ "name": "isOpenUpdated",
16817
16764
  "privacy": "private",
16818
16765
  "parameters": [
16819
16766
  {
16820
- "name": "size",
16767
+ "name": "oldValue",
16821
16768
  "type": {
16822
- "text": "ToggleSize"
16769
+ "text": "boolean"
16823
16770
  },
16824
- "description": "The size to set."
16771
+ "description": "The old value of the visible property."
16772
+ },
16773
+ {
16774
+ "name": "newValue",
16775
+ "type": {
16776
+ "text": "boolean"
16777
+ },
16778
+ "description": "The new value of the visible property."
16825
16779
  }
16826
16780
  ],
16827
- "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."
16781
+ "description": "Handles the popover visibility change and position the popover.\nHandles the exit event to close the popover.",
16782
+ "inheritedFrom": {
16783
+ "name": "Popover",
16784
+ "module": "components/popover/popover.component.js"
16785
+ }
16828
16786
  },
16829
16787
  {
16830
16788
  "kind": "field",
16831
- "name": "name",
16832
- "type": {
16833
- "text": "string"
16834
- },
16835
- "default": "''",
16836
- "description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
16837
- "attribute": "name",
16838
- "reflects": true,
16789
+ "name": "startCloseDelay",
16790
+ "privacy": "private",
16791
+ "description": "Starts the close delay timer.\nIf the popover is not interactive, it will close the popover after the delay.",
16839
16792
  "inheritedFrom": {
16840
- "name": "FormInternalsMixin",
16841
- "module": "utils/mixins/FormInternalsMixin.js"
16793
+ "name": "Popover",
16794
+ "module": "components/popover/popover.component.js"
16842
16795
  }
16843
16796
  },
16844
16797
  {
16845
16798
  "kind": "field",
16846
- "name": "value",
16847
- "type": {
16848
- "text": "string"
16849
- },
16850
- "default": "''",
16851
- "description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
16852
- "attribute": "value",
16853
- "reflects": true,
16799
+ "name": "cancelCloseDelay",
16800
+ "privacy": "private",
16801
+ "description": "Cancels the close delay timer.",
16854
16802
  "inheritedFrom": {
16855
- "name": "FormInternalsMixin",
16856
- "module": "utils/mixins/FormInternalsMixin.js"
16803
+ "name": "Popover",
16804
+ "module": "components/popover/popover.component.js"
16857
16805
  }
16858
16806
  },
16859
16807
  {
16860
16808
  "kind": "field",
16861
- "name": "validationMessage",
16862
- "type": {
16863
- "text": "string | undefined"
16864
- },
16865
- "description": "Custom validation message that will override the default message and displayed when the input is invalid.",
16866
- "attribute": "validation-message",
16867
- "reflects": true,
16809
+ "name": "showPopover",
16810
+ "privacy": "public",
16811
+ "description": "Shows the popover.",
16868
16812
  "inheritedFrom": {
16869
- "name": "FormInternalsMixin",
16870
- "module": "utils/mixins/FormInternalsMixin.js"
16813
+ "name": "Popover",
16814
+ "module": "components/popover/popover.component.js"
16871
16815
  }
16872
16816
  },
16873
16817
  {
16874
16818
  "kind": "field",
16875
- "name": "validity",
16876
- "type": {
16877
- "text": "ValidityState"
16878
- },
16879
- "readonly": true,
16819
+ "name": "hidePopover",
16820
+ "privacy": "public",
16821
+ "description": "Hides the popover.",
16822
+ "inheritedFrom": {
16823
+ "name": "Popover",
16824
+ "module": "components/popover/popover.component.js"
16825
+ }
16826
+ },
16827
+ {
16828
+ "kind": "field",
16829
+ "name": "togglePopoverVisible",
16830
+ "privacy": "public",
16831
+ "description": "Toggles the popover visibility.",
16832
+ "inheritedFrom": {
16833
+ "name": "Popover",
16834
+ "module": "components/popover/popover.component.js"
16835
+ }
16836
+ },
16837
+ {
16838
+ "kind": "method",
16839
+ "name": "handleCreatePopoverFirstUpdate",
16840
+ "privacy": "private",
16841
+ "description": "Sets the focusable elements inside the popover.",
16842
+ "inheritedFrom": {
16843
+ "name": "Popover",
16844
+ "module": "components/popover/popover.component.js"
16845
+ }
16846
+ },
16847
+ {
16848
+ "kind": "method",
16849
+ "name": "positionPopover",
16850
+ "privacy": "private",
16851
+ "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.",
16852
+ "inheritedFrom": {
16853
+ "name": "Popover",
16854
+ "module": "components/popover/popover.component.js"
16855
+ }
16856
+ },
16857
+ {
16858
+ "kind": "field",
16859
+ "name": "utils",
16860
+ "default": "new PopoverUtils(this)",
16861
+ "inheritedFrom": {
16862
+ "name": "Popover",
16863
+ "module": "components/popover/popover.component.js"
16864
+ }
16865
+ }
16866
+ ],
16867
+ "events": [
16868
+ {
16869
+ "description": "(React: onShown) This event is dispatched when the tooltip is shown",
16870
+ "name": "shown",
16871
+ "reactName": "onShown",
16872
+ "eventName": "ShownEvent",
16873
+ "inheritedFrom": {
16874
+ "name": "Popover",
16875
+ "module": "src/components/popover/popover.component.ts"
16876
+ }
16877
+ },
16878
+ {
16879
+ "description": "(React: onHidden) This event is dispatched when the tooltip is hidden",
16880
+ "name": "hidden",
16881
+ "reactName": "onHidden",
16882
+ "eventName": "HiddenEvent",
16880
16883
  "inheritedFrom": {
16881
- "name": "FormInternalsMixin",
16882
- "module": "utils/mixins/FormInternalsMixin.js"
16884
+ "name": "Popover",
16885
+ "module": "src/components/popover/popover.component.ts"
16883
16886
  }
16884
16887
  },
16885
16888
  {
16886
- "kind": "field",
16887
- "name": "willValidate",
16888
- "readonly": true,
16889
+ "description": "(React: onCreated) This event is dispatched when the tooltip is created (added to the DOM)",
16890
+ "name": "created",
16891
+ "reactName": "onCreated",
16892
+ "eventName": "CreatedEvent",
16889
16893
  "inheritedFrom": {
16890
- "name": "FormInternalsMixin",
16891
- "module": "utils/mixins/FormInternalsMixin.js"
16894
+ "name": "Popover",
16895
+ "module": "src/components/popover/popover.component.ts"
16892
16896
  }
16893
16897
  },
16894
16898
  {
16895
- "kind": "method",
16896
- "name": "setValidity",
16897
- "description": "Sets the validity of the input field based on the input field's validity.",
16898
- "return": {
16899
- "type": {
16900
- "text": ""
16901
- }
16902
- },
16899
+ "description": "(React: onDestroyed) This event is dispatched when the tooltip is destroyed (removed from the DOM)",
16900
+ "name": "destroyed",
16901
+ "reactName": "onDestroyed",
16902
+ "eventName": "DestroyedEvent",
16903
16903
  "inheritedFrom": {
16904
- "name": "FormInternalsMixin",
16905
- "module": "utils/mixins/FormInternalsMixin.js"
16904
+ "name": "Popover",
16905
+ "module": "src/components/popover/popover.component.ts"
16906
16906
  }
16907
+ }
16908
+ ],
16909
+ "attributes": [
16910
+ {
16911
+ "name": "tooltip-type",
16912
+ "type": {
16913
+ "text": "TooltipType"
16914
+ },
16915
+ "description": "The type of tooltip.\n- **description** sets aria-describedby on the trigger component which refers to the tooltip id.\n- **label** sets aria-labelledby on the trigger component which refers to the tooltip id.\n- **none** no aria props set on trigger component referring to the tooltip id.",
16916
+ "default": "'description'",
16917
+ "fieldName": "tooltipType"
16907
16918
  },
16908
16919
  {
16909
- "kind": "method",
16910
- "name": "checkValidity",
16911
- "return": {
16912
- "type": {
16913
- "text": "boolean"
16914
- }
16920
+ "name": "enabledFocusTrap",
16921
+ "type": {
16922
+ "text": "boolean"
16915
16923
  },
16924
+ "description": "Determines whether the focus trap is enabled.\nIf true, focus will be restricted to the content within this component.",
16925
+ "default": "false",
16926
+ "fieldName": "enabledFocusTrap",
16916
16927
  "inheritedFrom": {
16917
- "name": "FormInternalsMixin",
16918
- "module": "utils/mixins/FormInternalsMixin.js"
16928
+ "name": "Popover",
16929
+ "module": "src/components/popover/popover.component.ts"
16919
16930
  }
16920
16931
  },
16921
16932
  {
16922
- "kind": "method",
16923
- "name": "reportValidity",
16933
+ "name": "enabledPreventScroll",
16934
+ "type": {
16935
+ "text": "boolean"
16936
+ },
16937
+ "description": "Prevent outside scrolling when popover show.",
16938
+ "default": "false",
16939
+ "fieldName": "enabledPreventScroll",
16924
16940
  "inheritedFrom": {
16925
- "name": "FormInternalsMixin",
16926
- "module": "utils/mixins/FormInternalsMixin.js"
16941
+ "name": "Popover",
16942
+ "module": "src/components/popover/popover.component.ts"
16927
16943
  }
16928
16944
  },
16929
16945
  {
16930
- "kind": "field",
16931
16946
  "name": "id",
16932
16947
  "type": {
16933
16948
  "text": "string"
16934
16949
  },
16935
- "default": "`mdc-input-${uuidv4()}`",
16936
- "description": "The unique id of the input field. It is used to link the input field with the label.",
16937
- "attribute": "id",
16950
+ "default": "''",
16951
+ "description": "The unique ID of the popover.",
16952
+ "fieldName": "id",
16938
16953
  "inheritedFrom": {
16939
- "name": "FormfieldWrapper",
16940
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
16954
+ "name": "Popover",
16955
+ "module": "src/components/popover/popover.component.ts"
16941
16956
  }
16942
16957
  },
16943
16958
  {
16944
- "kind": "field",
16945
- "name": "dataAriaLabel",
16959
+ "name": "triggerID",
16946
16960
  "type": {
16947
- "text": "string | null"
16961
+ "text": "string"
16948
16962
  },
16949
- "default": "null",
16950
- "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
16951
- "attribute": "data-aria-label",
16952
- "reflects": true,
16963
+ "default": "''",
16964
+ "description": "The ID of the element that triggers the popover.\nThis attribute is required for the popover to work.",
16965
+ "fieldName": "triggerID",
16953
16966
  "inheritedFrom": {
16954
- "name": "DataAriaLabelMixin",
16955
- "module": "utils/mixins/DataAriaLabelMixin.js"
16967
+ "name": "Popover",
16968
+ "module": "src/components/popover/popover.component.ts"
16956
16969
  }
16957
16970
  },
16958
16971
  {
16959
- "kind": "field",
16960
- "name": "disabled",
16972
+ "name": "trigger",
16961
16973
  "type": {
16962
- "text": "boolean"
16974
+ "text": "PopoverTrigger"
16963
16975
  },
16964
- "default": "false",
16965
- "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
16966
- "attribute": "disabled",
16967
- "reflects": true,
16976
+ "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**",
16977
+ "default": "click",
16978
+ "fieldName": "trigger",
16968
16979
  "inheritedFrom": {
16969
- "name": "FormfieldWrapper",
16970
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
16980
+ "name": "Popover",
16981
+ "module": "src/components/popover/popover.component.ts"
16971
16982
  }
16972
16983
  },
16973
16984
  {
16974
- "kind": "field",
16975
- "name": "label",
16985
+ "name": "placement",
16976
16986
  "type": {
16977
- "text": "string | undefined"
16987
+ "text": "PopoverPlacement"
16978
16988
  },
16979
- "description": "The label of the input field. It is linked to the input field using the `for` attribute.",
16980
- "attribute": "label",
16981
- "reflects": true,
16989
+ "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**",
16990
+ "default": "bottom",
16991
+ "fieldName": "placement",
16982
16992
  "inheritedFrom": {
16983
- "name": "FormfieldWrapper",
16984
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
16993
+ "name": "Popover",
16994
+ "module": "src/components/popover/popover.component.ts"
16985
16995
  }
16986
16996
  },
16987
16997
  {
16988
- "kind": "field",
16989
- "name": "requiredLabel",
16998
+ "name": "color",
16990
16999
  "type": {
16991
- "text": "string | undefined"
17000
+ "text": "PopoverColor"
16992
17001
  },
16993
- "description": "The required label of the input field.\nWhen an appropriate string value is set,\nthe input field is marked as required and the label is appended with this text.",
16994
- "attribute": "required-label",
16995
- "reflects": true,
17002
+ "description": "Color of the popover\n- **tonal**\n- **contrast**",
17003
+ "default": "tonal",
17004
+ "fieldName": "color",
16996
17005
  "inheritedFrom": {
16997
- "name": "FormfieldWrapper",
16998
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
17006
+ "name": "Popover",
17007
+ "module": "src/components/popover/popover.component.ts"
16999
17008
  }
17000
17009
  },
17001
17010
  {
17002
- "kind": "field",
17003
- "name": "helpTextType",
17011
+ "name": "visible",
17004
17012
  "type": {
17005
- "text": "ValidationType"
17013
+ "text": "boolean"
17006
17014
  },
17007
- "description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
17008
- "attribute": "help-text-type",
17009
- "reflects": true,
17015
+ "description": "The visibility of the popover.",
17016
+ "default": "false",
17017
+ "fieldName": "visible",
17010
17018
  "inheritedFrom": {
17011
- "name": "FormfieldWrapper",
17012
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
17019
+ "name": "Popover",
17020
+ "module": "src/components/popover/popover.component.ts"
17013
17021
  }
17014
17022
  },
17015
17023
  {
17016
- "kind": "field",
17017
- "name": "helpText",
17024
+ "name": "offset",
17018
17025
  "type": {
17019
- "text": "string | undefined"
17026
+ "text": "number"
17020
17027
  },
17021
- "description": "The help text that is displayed below the input field.",
17022
- "attribute": "help-text",
17023
- "reflects": true,
17028
+ "description": "The offset of the popover.",
17029
+ "default": "4",
17030
+ "fieldName": "offset",
17024
17031
  "inheritedFrom": {
17025
- "name": "FormfieldWrapper",
17026
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
17032
+ "name": "Popover",
17033
+ "module": "src/components/popover/popover.component.ts"
17027
17034
  }
17028
17035
  },
17029
17036
  {
17030
- "kind": "method",
17031
- "name": "renderLabelElement",
17032
- "privacy": "protected",
17033
- "description": "creates the label element when the label property is set.\nid is used to link the label with the input field.",
17034
- "return": {
17035
- "type": {
17036
- "text": ""
17037
- }
17037
+ "name": "focus-trap",
17038
+ "type": {
17039
+ "text": "boolean"
17038
17040
  },
17041
+ "description": "Determines whether the focus trap is enabled.\nIf true, focus will be restricted to the content within this component.",
17042
+ "default": "false",
17043
+ "fieldName": "focusTrap",
17039
17044
  "inheritedFrom": {
17040
- "name": "FormfieldWrapper",
17041
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
17042
- }
17043
- },
17044
- {
17045
- "kind": "method",
17046
- "name": "renderRequiredLabel",
17047
- "privacy": "protected",
17048
- "inheritedFrom": {
17049
- "name": "FormfieldWrapper",
17050
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
17045
+ "name": "Popover",
17046
+ "module": "src/components/popover/popover.component.ts"
17051
17047
  }
17052
17048
  },
17053
17049
  {
17054
- "kind": "method",
17055
- "name": "renderHelpTextIcon",
17056
- "privacy": "protected",
17057
- "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.",
17058
- "return": {
17059
- "type": {
17060
- "text": ""
17061
- }
17050
+ "name": "prevent-scroll",
17051
+ "type": {
17052
+ "text": "boolean"
17062
17053
  },
17054
+ "description": "Prevent outside scrolling when popover show.",
17055
+ "default": "false",
17056
+ "fieldName": "preventScroll",
17063
17057
  "inheritedFrom": {
17064
- "name": "FormfieldWrapper",
17065
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
17058
+ "name": "Popover",
17059
+ "module": "src/components/popover/popover.component.ts"
17066
17060
  }
17067
17061
  },
17068
17062
  {
17069
- "kind": "method",
17070
- "name": "renderHelpText",
17071
- "privacy": "protected",
17072
- "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.",
17073
- "return": {
17074
- "type": {
17075
- "text": ""
17076
- }
17063
+ "name": "show-arrow",
17064
+ "type": {
17065
+ "text": "boolean"
17077
17066
  },
17067
+ "description": "The arrow visibility of the popover.",
17068
+ "default": "false",
17069
+ "fieldName": "showArrow",
17078
17070
  "inheritedFrom": {
17079
- "name": "FormfieldWrapper",
17080
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
17071
+ "name": "Popover",
17072
+ "module": "src/components/popover/popover.component.ts"
17081
17073
  }
17082
17074
  },
17083
17075
  {
17084
- "kind": "method",
17085
- "name": "renderLabel",
17086
- "privacy": "protected",
17087
- "description": "renders the mdc-label-text container that contains the label and labelInfoToggleTip.",
17088
- "return": {
17089
- "type": {
17090
- "text": ""
17091
- }
17076
+ "name": "close-button",
17077
+ "type": {
17078
+ "text": "boolean"
17092
17079
  },
17080
+ "description": "The close button visibility of the popover.",
17081
+ "default": "false",
17082
+ "fieldName": "closeButton",
17093
17083
  "inheritedFrom": {
17094
- "name": "FormfieldWrapper",
17095
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
17084
+ "name": "Popover",
17085
+ "module": "src/components/popover/popover.component.ts"
17096
17086
  }
17097
17087
  },
17098
17088
  {
17099
- "kind": "method",
17100
- "name": "renderHelperText",
17101
- "privacy": "protected",
17102
- "description": "renders the mdc-help-text container that contains the helpertext icon and helpertext.",
17103
- "return": {
17104
- "type": {
17105
- "text": ""
17106
- }
17089
+ "name": "interactive",
17090
+ "type": {
17091
+ "text": "boolean"
17107
17092
  },
17093
+ "description": "Determines whether the popover is interactive。",
17094
+ "default": "false",
17095
+ "fieldName": "interactive",
17108
17096
  "inheritedFrom": {
17109
- "name": "FormfieldWrapper",
17110
- "module": "components/formfieldwrapper/formfieldwrapper.component.js"
17097
+ "name": "Popover",
17098
+ "module": "src/components/popover/popover.component.ts"
17111
17099
  }
17112
- }
17113
- ],
17114
- "events": [
17100
+ },
17115
17101
  {
17102
+ "name": "delay",
17116
17103
  "type": {
17117
- "text": "EventConstructor"
17104
+ "text": "string"
17105
+ },
17106
+ "description": "The delay of the show/hide popover.",
17107
+ "default": "0,0",
17108
+ "fieldName": "delay",
17109
+ "inheritedFrom": {
17110
+ "name": "Popover",
17111
+ "module": "src/components/popover/popover.component.ts"
17118
17112
  }
17119
17113
  },
17120
17114
  {
17121
- "description": "(React: onChange) Event that gets dispatched when the toggle state changes.",
17122
- "name": "change",
17123
- "reactName": "onChange",
17124
- "eventName": "ChangeEvent"
17125
- },
17126
- {
17127
- "description": "(React: onFocus) Event that gets dispatched when the toggle receives focus.",
17128
- "name": "focus",
17129
- "reactName": "onFocus",
17130
- "eventName": "FocusEvent"
17131
- }
17132
- ],
17133
- "attributes": [
17134
- {
17135
- "name": "checked",
17115
+ "name": "hide-on-escape",
17136
17116
  "type": {
17137
17117
  "text": "boolean"
17138
17118
  },
17119
+ "description": "Hide popover on escape key press.",
17139
17120
  "default": "false",
17140
- "description": "Determines whether the toggle is active or inactive.",
17141
- "fieldName": "checked"
17121
+ "fieldName": "hideOnEscape",
17122
+ "inheritedFrom": {
17123
+ "name": "Popover",
17124
+ "module": "src/components/popover/popover.component.ts"
17125
+ }
17142
17126
  },
17143
17127
  {
17144
- "name": "size",
17128
+ "name": "hide-on-blur",
17145
17129
  "type": {
17146
- "text": "ToggleSize"
17130
+ "text": "boolean"
17147
17131
  },
17148
- "description": "Determines toggle size in rem (height is specified here).\n- **Default**: 1.5\n- **Compact**: 1",
17149
- "default": "default",
17150
- "fieldName": "size"
17132
+ "description": "Hide popover on blur.",
17133
+ "default": "false",
17134
+ "fieldName": "hideOnBlur",
17135
+ "inheritedFrom": {
17136
+ "name": "Popover",
17137
+ "module": "src/components/popover/popover.component.ts"
17138
+ }
17151
17139
  },
17152
17140
  {
17153
- "name": "autofocus",
17141
+ "name": "hide-on-outside-click",
17154
17142
  "type": {
17155
17143
  "text": "boolean"
17156
17144
  },
17145
+ "description": "Hide on outside click of the popover.",
17157
17146
  "default": "false",
17158
- "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)",
17159
- "fieldName": "autofocus"
17147
+ "fieldName": "hideOnOutsideClick",
17148
+ "inheritedFrom": {
17149
+ "name": "Popover",
17150
+ "module": "src/components/popover/popover.component.ts"
17151
+ }
17160
17152
  },
17161
17153
  {
17162
- "name": "name",
17154
+ "name": "focus-back-to-trigger",
17163
17155
  "type": {
17164
- "text": "string"
17156
+ "text": "boolean"
17165
17157
  },
17166
- "default": "''",
17167
- "description": "Indicates the name of the component group.\nThey are used to group elements in a form together.",
17168
- "fieldName": "name",
17158
+ "description": "The focus back to trigger after the popover hide.",
17159
+ "default": "false",
17160
+ "fieldName": "focusBackToTrigger",
17169
17161
  "inheritedFrom": {
17170
- "name": "FormInternalsMixin",
17171
- "module": "src/utils/mixins/FormInternalsMixin.ts"
17162
+ "name": "Popover",
17163
+ "module": "src/components/popover/popover.component.ts"
17172
17164
  }
17173
17165
  },
17174
17166
  {
17175
- "name": "value",
17167
+ "name": "backdrop",
17176
17168
  "type": {
17177
- "text": "string"
17169
+ "text": "boolean"
17178
17170
  },
17179
- "default": "''",
17180
- "description": "Indicates the value of the component group (ex: input, checkbox, radio, select etc...)",
17181
- "fieldName": "value",
17171
+ "description": "Determines whether the popover with backdrop.\nOther than popover and trigger element, the rest of the screen will be covered with a backdrop.",
17172
+ "default": "false",
17173
+ "fieldName": "backdrop",
17182
17174
  "inheritedFrom": {
17183
- "name": "FormInternalsMixin",
17184
- "module": "src/utils/mixins/FormInternalsMixin.ts"
17175
+ "name": "Popover",
17176
+ "module": "src/components/popover/popover.component.ts"
17185
17177
  }
17186
17178
  },
17187
17179
  {
17188
- "name": "validation-message",
17180
+ "name": "flip",
17189
17181
  "type": {
17190
- "text": "string | undefined"
17182
+ "text": "boolean"
17191
17183
  },
17192
- "description": "Custom validation message that will override the default message and displayed when the input is invalid.",
17193
- "fieldName": "validationMessage",
17184
+ "description": "Changes the placement of popover to keep it in view when scrolling.",
17185
+ "default": "true",
17186
+ "fieldName": "flip",
17194
17187
  "inheritedFrom": {
17195
- "name": "FormInternalsMixin",
17196
- "module": "src/utils/mixins/FormInternalsMixin.ts"
17188
+ "name": "Popover",
17189
+ "module": "src/components/popover/popover.component.ts"
17197
17190
  }
17198
17191
  },
17199
17192
  {
17200
- "name": "data-aria-label",
17193
+ "name": "size",
17201
17194
  "type": {
17202
- "text": "string | null"
17195
+ "text": "boolean"
17203
17196
  },
17204
- "default": "null",
17205
- "description": "Defines a string value that labels the current element.\nThe Aria-Label attribute to be set for accessibility.",
17206
- "fieldName": "dataAriaLabel",
17197
+ "description": "Changes the size of popover to keep it in view when scrolling.",
17198
+ "default": "false",
17199
+ "fieldName": "size",
17207
17200
  "inheritedFrom": {
17208
- "name": "DataAriaLabelMixin",
17209
- "module": "src/utils/mixins/DataAriaLabelMixin.ts"
17201
+ "name": "Popover",
17202
+ "module": "src/components/popover/popover.component.ts"
17210
17203
  }
17211
17204
  },
17212
17205
  {
17213
- "name": "disabled",
17206
+ "name": "z-index",
17214
17207
  "type": {
17215
- "text": "boolean"
17208
+ "text": "number"
17216
17209
  },
17217
- "default": "false",
17218
- "description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
17219
- "fieldName": "disabled",
17210
+ "description": "The z-index of the popover.",
17211
+ "default": "1000",
17212
+ "fieldName": "zIndex",
17220
17213
  "inheritedFrom": {
17221
- "name": "FormfieldWrapper",
17222
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
17214
+ "name": "Popover",
17215
+ "module": "src/components/popover/popover.component.ts"
17223
17216
  }
17224
17217
  },
17225
17218
  {
17226
- "name": "label",
17219
+ "name": "append-to",
17227
17220
  "type": {
17228
- "text": "string | undefined"
17221
+ "text": "string"
17229
17222
  },
17230
- "description": "The label of the input field. It is linked to the input field using the `for` attribute.",
17231
- "fieldName": "label",
17223
+ "default": "''",
17224
+ "description": "Element ID that the popover append to.",
17225
+ "fieldName": "appendTo",
17232
17226
  "inheritedFrom": {
17233
- "name": "FormfieldWrapper",
17234
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
17227
+ "name": "Popover",
17228
+ "module": "src/components/popover/popover.component.ts"
17235
17229
  }
17236
17230
  },
17237
17231
  {
17238
- "name": "required-label",
17232
+ "name": "close-button-aria-label",
17239
17233
  "type": {
17240
- "text": "string | undefined"
17234
+ "text": "string | null"
17241
17235
  },
17242
- "description": "The required label of the input field.\nWhen an appropriate string value is set,\nthe input field is marked as required and the label is appended with this text.",
17243
- "fieldName": "requiredLabel",
17236
+ "default": "null",
17237
+ "description": "aria-label attribute to be set for close button accessibility.",
17238
+ "fieldName": "closeButtonAriaLabel",
17244
17239
  "inheritedFrom": {
17245
- "name": "FormfieldWrapper",
17246
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
17240
+ "name": "Popover",
17241
+ "module": "src/components/popover/popover.component.ts"
17247
17242
  }
17248
17243
  },
17249
17244
  {
17250
- "name": "id",
17245
+ "name": "role",
17251
17246
  "type": {
17252
- "text": "string"
17247
+ "text": "HTMLElement['role']"
17253
17248
  },
17254
- "default": "''",
17255
- "description": "The unique id of the input field. It is used to link the input field with the label.",
17256
- "fieldName": "id",
17249
+ "description": "Role of the popover",
17250
+ "default": "dialog",
17251
+ "fieldName": "role",
17257
17252
  "inheritedFrom": {
17258
- "name": "FormfieldWrapper",
17259
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
17253
+ "name": "Popover",
17254
+ "module": "src/components/popover/popover.component.ts"
17260
17255
  }
17261
17256
  },
17262
17257
  {
17263
- "name": "help-text-type",
17258
+ "name": "aria-labelledby",
17264
17259
  "type": {
17265
- "text": "ValidationType"
17260
+ "text": "string | null"
17266
17261
  },
17267
- "description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
17268
- "fieldName": "helpTextType",
17262
+ "default": "null",
17263
+ "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.",
17264
+ "fieldName": "ariaLabelledby",
17269
17265
  "inheritedFrom": {
17270
- "name": "FormfieldWrapper",
17271
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
17266
+ "name": "Popover",
17267
+ "module": "src/components/popover/popover.component.ts"
17272
17268
  }
17273
17269
  },
17274
17270
  {
17275
- "name": "help-text",
17271
+ "name": "aria-describedby",
17276
17272
  "type": {
17277
- "text": "string | undefined"
17273
+ "text": "string | null"
17278
17274
  },
17279
- "description": "The help text that is displayed below the input field.",
17280
- "fieldName": "helpText",
17275
+ "default": "null",
17276
+ "description": "aria-describedby of the popover.",
17277
+ "fieldName": "ariaDescribedby",
17281
17278
  "inheritedFrom": {
17282
- "name": "FormfieldWrapper",
17283
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
17279
+ "name": "Popover",
17280
+ "module": "src/components/popover/popover.component.ts"
17284
17281
  }
17285
- }
17286
- ],
17287
- "mixins": [
17288
- {
17289
- "name": "FormInternalsMixin",
17290
- "module": "/src/utils/mixins/FormInternalsMixin"
17291
17282
  },
17292
17283
  {
17293
- "name": "DataAriaLabelMixin",
17294
- "module": "/src/utils/mixins/DataAriaLabelMixin"
17284
+ "name": "disable-aria-expanded",
17285
+ "type": {
17286
+ "text": "boolean"
17287
+ },
17288
+ "description": "Disable aria-expanded attribute on trigger element.",
17289
+ "default": "false",
17290
+ "fieldName": "disableAriaExpanded",
17291
+ "inheritedFrom": {
17292
+ "name": "Popover",
17293
+ "module": "src/components/popover/popover.component.ts"
17294
+ }
17295
17295
  }
17296
17296
  ],
17297
17297
  "superclass": {
17298
- "name": "FormfieldWrapper",
17299
- "module": "/src/components/formfieldwrapper"
17298
+ "name": "Popover",
17299
+ "module": "/src/components/popover/popover.component"
17300
17300
  },
17301
- "tagName": "mdc-toggle",
17302
- "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 *\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-border-radius - border radius of the toggle\n * @cssproperty --mdc-toggle-border-radius-compact - border radius of the toggle when it's size is compact\n * @cssproperty --mdc-toggle-border - border of the toggle\n * @cssproperty --mdc-toggle-inactive-rest-color - background color of the inactive toggle in rest 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 * @cssproperty --mdc-toggle-inactive-disabled-color - background color of the inactive toggle in disabled state\n * @cssproperty --mdc-toggle-active-rest-color - background color of the active toggle in rest state\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-active-disabled-color - background color of the active toggle in disabled state\n * @cssproperty --mdc-toggle-help-text-color - color of the help text label\n * @cssproperty --mdc-toggle-label-color-disabled - color of the toggle label and help text in disabled state\n *\n */",
17301
+ "tagName": "mdc-tooltip",
17302
+ "jsDoc": "/**\n * A tooltip is triggered by mouse hover or by keyboard focus\n * and will disappear upon mouse exit or focus change.\n *\n * Note: Tooltips cannot contain content that can be focused or interacted with.\n *\n * @tagname mdc-tooltip\n *\n * @event shown - (React: onShown) This event is dispatched when the tooltip is shown\n * @event hidden - (React: onHidden) This event is dispatched when the tooltip is hidden\n * @event created - (React: onCreated) This event is dispatched when the tooltip is created (added to the DOM)\n * @event destroyed - (React: onDestroyed) This event is dispatched when the tooltip is destroyed (removed from the DOM)\n *\n * @cssproperty --mdc-tooltip-max-width - The maximum width of the tooltip.\n * @cssproperty --mdc-tooltip-padding - The padding of the tooltip.\n * @cssproperty --mdc-tooltip-text-color - The text color of the tooltip.\n * @cssproperty --mdc-tooltip-text-color-contrast - The text color of the tooltip when the color is contrast.\n *\n */",
17303
17303
  "customElement": true,
17304
17304
  "slots": [
17305
17305
  {
17306
- "description": "slot to add the label info icon",
17307
- "name": "label-info",
17306
+ "description": "Default slot for the popover content",
17307
+ "name": "",
17308
17308
  "inheritedFrom": {
17309
- "name": "FormfieldWrapper",
17310
- "module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
17309
+ "name": "Popover",
17310
+ "module": "src/components/popover/popover.component.ts"
17311
17311
  }
17312
17312
  }
17313
17313
  ]
@@ -17318,8 +17318,8 @@
17318
17318
  "kind": "js",
17319
17319
  "name": "default",
17320
17320
  "declaration": {
17321
- "name": "Toggle",
17322
- "module": "components/toggle/toggle.component.js"
17321
+ "name": "Tooltip",
17322
+ "module": "components/tooltip/tooltip.component.js"
17323
17323
  }
17324
17324
  }
17325
17325
  ]