@spectrum-web-components/overlay 1.0.2 → 1.0.3

package/custom-elements.json

@@ -1764,7 +1764,8 @@
               "type": {
                 "text": "boolean"
               },
-              "description": "An Overlay that is `delayed` will wait until a warm-up period of 1000ms\nhas completed before opening. Once the warmup period has completed, all\nsubsequent Overlays will open immediately. When no Overlays are opened,\na cooldown period of 1000ms will begin. Once the cooldown has completed,\nthe next Overlay to be opened will be subject to the warm-up period if\nprovided that option.",
+              "description": "An Overlay that is `delayed` will wait until a warm-up period of 1000ms\nhas completed before opening. Once the warm-up period has completed, all\nsubsequent Overlays will open immediately. When no Overlays are opened,\na cool-down period of 1000ms will begin. Once the cool-down has completed,\nthe next Overlay to be opened will be subject to the warm-up period if\nprovided that option.\n\nThis behavior helps to manage the performance and user experience by\npreventing multiple overlays from opening simultaneously and ensuring\na smooth transition between opening and closing overlays.",
+              "default": "false",
               "attribute": "delayed"
             },
             {
@@ -1781,7 +1782,8 @@
               "name": "dialogEl",
               "type": {
                 "text": "HTMLDialogElement & {\n        showPopover(): void;\n        hidePopover(): void;\n    }"
-              }
+              },
+              "description": "A reference to the dialog element within the overlay.\nThis element is expected to have `showPopover` and `hidePopover` methods."
             },
             {
               "kind": "field",
@@ -1789,7 +1791,8 @@
               "type": {
                 "text": "boolean"
               },
-              "description": "Whether the overlay is currently functional or not",
+              "description": "Indicates whether the overlay is currently functional or not.\n\nWhen set to `true`, the overlay is disabled, and any active strategy is aborted.\nThe overlay will also close if it is currently open. When set to `false`, the\noverlay will re-bind events and re-open if it was previously open.",
+              "default": "false",
               "attribute": "disabled"
             },
             {
@@ -1806,7 +1809,8 @@
               "name": "elements",
               "type": {
                 "text": "OpenableElement[]"
-              }
+              },
+              "description": "A query to gather all elements slotted into the default slot, excluding elements\nwith the slot name \"longpress-describedby-descriptor\"."
             },
             {
               "kind": "field",
@@ -1814,7 +1818,8 @@
               "type": {
                 "text": "Overlay | undefined"
               },
-              "privacy": "public"
+              "privacy": "public",
+              "description": "A reference to the parent overlay that should be force-closed, if any."
             },
             {
               "kind": "field",
@@ -1823,6 +1828,12 @@
                 "text": "boolean"
               },
               "privacy": "private",
+              "description": "Determines if the overlay has a non-virtual trigger element.",
+              "return": {
+                "type": {
+                  "text": "boolean"
+                }
+              },
               "readonly": true
             },
             {
@@ -1832,7 +1843,7 @@
                 "text": "number | [number, number]"
               },
               "default": "0",
-              "description": "The `offset` property accepts either a single number, to\ndefine the offset of the Overlay along the main axis from\nthe trigger, or 2-tuple, to define the offset along the\nmain axis and the cross axis. This option has no effect\nwhen there is no trigger element.",
+              "description": "The `offset` property accepts either a single number to define the offset of the\nOverlay along the main axis from the trigger, or a 2-tuple to define the offset\nalong both the main axis and the cross axis. This option has no effect when there\nis no trigger element.",
               "attribute": "offset"
             },
             {
@@ -1842,6 +1853,12 @@
                 "text": "PlacementController"
               },
               "privacy": "protected",
+              "description": "Provides an instance of the `PlacementController` for managing the positioning\nof the overlay relative to its trigger element.\n\nIf the `PlacementController` instance does not already exist, it is created and\nassigned to the `_placementController` property.",
+              "return": {
+                "type": {
+                  "text": "PlacementController"
+                }
+              },
               "readonly": true
             },
             {
@@ -1850,7 +1867,8 @@
               "type": {
                 "text": "boolean"
               },
-              "description": "Whether the Overlay is projected onto the \"top layer\" or not.",
+              "description": "Indicates whether the Overlay is projected onto the \"top layer\" or not.\n\nWhen set to `true`, the overlay is open and visible. When set to `false`, the overlay is closed and hidden.",
+              "default": "false",
               "attribute": "open",
               "reflects": true
             },
@@ -1870,7 +1888,8 @@
                 "text": "number"
               },
               "static": true,
-              "default": "1"
+              "default": "1",
+              "description": "Tracks the number of overlays that have been opened.\n\nThis static property is used to manage the stacking context of multiple overlays."
             },
             {
               "kind": "field",
@@ -1878,7 +1897,7 @@
               "type": {
                 "text": "\"top\" | \"top-start\" | \"top-end\" | \"right\" | \"right-start\" | \"right-end\" | \"bottom\" | \"bottom-start\" | \"bottom-end\" | \"left\" | \"left-start\" | \"left-end\""
               },
-              "description": "Instruct the Overlay where to place itself in\nrelationship to the trigger element.",
+              "description": "Instruct the Overlay where to place itself in relationship to the trigger element.",
               "attribute": "placement"
             },
             {
@@ -1889,7 +1908,7 @@
               },
               "privacy": "private",
               "default": "false",
-              "description": "The state in which the last `request-slottable` event was dispatched.\nDo not allow overlays from dispatching the same state twice in a row."
+              "description": "The state in which the last `request-slottable` event was dispatched.\n\nThis property ensures that overlays do not dispatch the same state twice in a row."
             },
             {
               "kind": "field",
@@ -1906,14 +1925,17 @@
               "name": "slotEl",
               "type": {
                 "text": "HTMLSlotElement"
-              }
+              },
+              "description": "A reference to the slot element within the overlay.\n\nThis element is used to manage the content slotted into the overlay."
             },
             {
               "kind": "field",
               "name": "state",
               "type": {
                 "text": "OverlayState"
-              }
+              },
+              "description": "The current state of the overlay.\n\nThis property reflects the current state of the overlay, such as 'opened' or 'closed'.\nWhen the state changes, it triggers the appropriate actions and updates the component.",
+              "default": "'closed'"
             },
             {
               "kind": "field",
@@ -1929,23 +1951,25 @@
               "type": {
                 "text": "ClickController | HoverController | LongpressController | undefined"
               },
-              "privacy": "public"
+              "privacy": "public",
+              "description": "The interaction strategy for opening the overlay.\nThis can be a ClickController, HoverController, or LongpressController."
             },
             {
               "kind": "field",
               "name": "tipPadding",
               "type": {
-                "text": "number | undefined"
+                "text": "number"
               },
+              "description": "The padding around the tip of the overlay.\nThis property defines the padding around the tip of the overlay, which can be used to adjust its positioning.",
               "attribute": "tip-padding"
             },
             {
               "kind": "field",
               "name": "trigger",
               "type": {
-                "text": "string | undefined"
+                "text": "string"
               },
-              "description": "An optional ID reference for the trigger element combined with the optional\ninteraction (click | hover | longpress) by which the overlay shold open\nthe overlay with an `@`: e.g. `trigger@click` opens the overlay when an\nelement with the ID \"trigger\" is clicked.",
+              "description": "An optional ID reference for the trigger element combined with the optional\ninteraction (click | hover | longpress) by which the overlay should open.\nThe format is `trigger@interaction`, e.g., `trigger@click` opens the overlay\nwhen an element with the ID \"trigger\" is clicked.",
               "attribute": "trigger"
             },
             {
@@ -1955,15 +1979,15 @@
                 "text": "HTMLElement | VirtualTrigger | null"
               },
               "default": "null",
-              "description": "An element reference for the trigger element that the overlay should relate to."
+              "description": "An element reference for the trigger element that the overlay should relate to.\nThis property is not reflected as an attribute."
             },
             {
               "kind": "field",
               "name": "triggerInteraction",
               "type": {
-                "text": "TriggerInteraction | undefined"
+                "text": "TriggerInteraction"
               },
-              "description": "The specific interaction to listen for on the `triggerElement` to open the overlay."
+              "description": "The specific interaction to listen for on the `triggerElement` to open the overlay.\nThis property is not reflected as an attribute."
             },
             {
               "kind": "field",
@@ -1982,7 +2006,8 @@
                 "text": "boolean"
               },
               "privacy": "protected",
-              "default": "false"
+              "default": "false",
+              "description": "Tracks whether the overlay was previously open.\nThis is used to restore the open state when re-enabling the overlay."
             },
             {
               "kind": "field",
@@ -1991,6 +2016,12 @@
                 "text": "ElementResolutionController"
               },
               "privacy": "protected",
+              "description": "Provides an instance of the `ElementResolutionController` for managing the element\nthat the overlay should be associated with. If the instance does not already exist,\nit is created and assigned to the `_elementResolver` property.",
+              "return": {
+                "type": {
+                  "text": "ElementResolutionController"
+                }
+              },
               "readonly": true
             },
             {
@@ -2000,6 +2031,12 @@
                 "text": "boolean"
               },
               "privacy": "private",
+              "description": "Determines if the overlay uses a dialog.\nReturns `true` if the overlay type is \"modal\" or \"page\".",
+              "return": {
+                "type": {
+                  "text": "boolean"
+                }
+              },
               "readonly": true
             },
             {
@@ -2009,15 +2046,27 @@
                 "text": "'auto' | 'manual' | undefined"
               },
               "privacy": "private",
+              "description": "Determines the value for the popover attribute based on the overlay type.",
+              "return": {
+                "type": {
+                  "text": "'auto' | 'manual' | undefined"
+                }
+              },
               "readonly": true
             },
             {
               "kind": "field",
-              "name": "requiresPosition",
+              "name": "requiresPositioning",
               "type": {
                 "text": "boolean"
               },
               "privacy": "protected",
+              "description": "Determines if the overlay requires positioning based on its type and state.",
+              "return": {
+                "type": {
+                  "text": "boolean"
+                }
+              },
               "readonly": true
             },
             {
@@ -2028,7 +2077,8 @@
                 "type": {
                   "text": "void"
                 }
-              }
+              },
+              "description": "Manages the positioning of the overlay relative to its trigger element.\n\nThis method calculates the necessary parameters for positioning the overlay,\nsuch as offset, placement, and tip padding, and then delegates the actual\npositioning to the `PlacementController`."
             },
             {
               "kind": "method",
@@ -2038,7 +2088,8 @@
                 "type": {
                   "text": "Promise<void>"
                 }
-              }
+              },
+              "description": "Manages the process of opening the popover.\n\nThis method handles the necessary steps to open the popover, including managing delays,\nensuring the popover is in the DOM, making transitions, and applying focus."
             },
             {
               "kind": "method",
@@ -2054,15 +2105,18 @@
                   "name": "targetOpenState",
                   "type": {
                     "text": "boolean"
-                  }
+                  },
+                  "description": "The target open state of the overlay."
                 },
                 {
                   "name": "focusEl",
                   "type": {
                     "text": "HTMLElement | null"
-                  }
+                  },
+                  "description": "The element to focus after opening the popover."
                 }
-              ]
+              ],
+              "description": "Applies focus to the appropriate element after the popover has been opened.\n\nThis method handles the focus management for the overlay, ensuring that the correct\nelement receives focus based on the overlay's type and state."
             },
             {
               "kind": "method",
@@ -2072,12 +2126,23 @@
                 "type": {
                   "text": "void"
                 }
-              }
+              },
+              "description": "Returns focus to the trigger element if the overlay is closed.\n\nThis method ensures that focus is returned to the trigger element when the overlay is closed,\nunless the overlay is of type \"hint\" or the focus is already outside the overlay."
             },
             {
               "kind": "field",
               "name": "closeOnFocusOut",
-              "privacy": "private"
+              "privacy": "private",
+              "description": "Handles the focus out event to close the overlay if the focus moves outside of it.\n\nThis method ensures that the overlay is closed when the focus moves to an element\noutside of the overlay, unless the focus is moved to a related element.",
+              "parameters": [
+                {
+                  "description": "The focus out event.",
+                  "name": "event",
+                  "type": {
+                    "text": "FocusEvent"
+                  }
+                }
+              ]
             },
             {
               "kind": "method",
@@ -2093,9 +2158,11 @@
                   "name": "oldOpen",
                   "type": {
                     "text": "boolean"
-                  }
+                  },
+                  "description": "The previous open state of the overlay."
                 }
-              ]
+              ],
+              "description": "Manages the process of opening or closing the overlay.\n\nThis method handles the necessary steps to open or close the overlay, including updating the state,\nmanaging the overlay stack, and handling focus events."
             },
             {
               "kind": "method",
@@ -2105,7 +2172,8 @@
                 "type": {
                   "text": "void"
                 }
-              }
+              },
+              "description": "Binds event handling strategies to the overlay based on the specified trigger interaction.\n\nThis method sets up the appropriate event handling strategy for the overlay, ensuring that\nit responds correctly to user interactions such as clicks, hovers, or long presses."
             },
             {
               "kind": "method",
@@ -2121,9 +2189,11 @@
                   "name": "event",
                   "type": {
                     "text": "Event & { newState: string }"
-                  }
+                  },
+                  "description": "The `beforetoggle` event with the new state."
                 }
-              ]
+              ],
+              "description": "Handles the `beforetoggle` event to manage the overlay's state.\n\nThis method checks the new state of the event and calls `handleBrowserClose`\nif the new state is not 'open'."
             },
             {
               "kind": "method",
@@ -2139,9 +2209,11 @@
                   "name": "event",
                   "type": {
                     "text": "Event"
-                  }
+                  },
+                  "description": "The browser's close event."
                 }
-              ]
+              ],
+              "description": "Handles the browser's close event to manage the overlay's state.\n\nThis method stops the propagation of the event and closes the overlay if it is not\nactively opening. If the overlay is actively opening, it calls `manuallyKeepOpen`."
             },
             {
               "kind": "method",
@@ -2151,7 +2223,8 @@
                 "type": {
                   "text": "void"
                 }
-              }
+              },
+              "description": "Manually keeps the overlay open.\n\nThis method sets the overlay to open, allows placement updates, and manages the open state."
             },
             {
               "kind": "method",
@@ -2161,7 +2234,8 @@
                 "type": {
                   "text": "void"
                 }
-              }
+              },
+              "description": "Handles the `slotchange` event to manage the overlay's state.\n\nThis method checks if there are any elements in the slot. If there are no elements,\nit releases the description from the strategy. If there are elements and the trigger\nis non-virtual, it prepares the description for the trigger element."
             },
             {
               "kind": "method",
@@ -2171,7 +2245,8 @@
                 "type": {
                   "text": "boolean"
                 }
-              }
+              },
+              "description": "Determines whether the overlay should prevent closing.\n\nThis method checks the `willPreventClose` flag and resets it to `false`.\nIt returns the value of the `willPreventClose` flag."
             },
             {
               "kind": "method",
@@ -2181,7 +2256,8 @@
                 "type": {
                   "text": "void"
                 }
-              }
+              },
+              "description": "Requests slottable content for the overlay.\n\nThis method dispatches a `SlottableRequestEvent` to request or remove slottable content\nbased on the current open state of the overlay. It ensures that the same state is not\ndispatched twice in a row."
             },
             {
               "kind": "method",
@@ -2191,7 +2267,8 @@
                 "type": {
                   "text": "TemplateResult"
                 }
-              }
+              },
+              "description": "Renders the content of the overlay.\n\nThis method returns a template result containing a slot element. The slot element\nlistens for the `slotchange` event to manage the overlay's state."
             },
             {
               "kind": "field",
@@ -2200,6 +2277,12 @@
                 "text": "StyleInfo"
               },
               "privacy": "private",
+              "description": "Generates a style map for the dialog element.\n\nThis method returns an object containing CSS custom properties for the dialog element.\nThe `--swc-overlay-open-count` custom property is set to the current open count of overlays.",
+              "return": {
+                "type": {
+                  "text": "StyleInfo"
+                }
+              },
               "readonly": true
             },
             {
@@ -2210,7 +2293,8 @@
                 "type": {
                   "text": "TemplateResult"
                 }
-              }
+              },
+              "description": "Renders the dialog element for the overlay.\n\nThis method returns a template result containing a dialog element. The dialog element\nincludes various attributes and event listeners to manage the overlay's state and behavior."
             },
             {
               "kind": "method",
@@ -2220,7 +2304,8 @@
                 "type": {
                   "text": "TemplateResult"
                 }
-              }
+              },
+              "description": "Renders the popover element for the overlay.\n\nThis method returns a template result containing a div element styled as a popover.\nThe popover element includes various attributes and event listeners to manage the overlay's state and behavior."
             }
           ],
           "events": [
@@ -2243,7 +2328,8 @@
               "type": {
                 "text": "boolean"
               },
-              "description": "An Overlay that is `delayed` will wait until a warm-up period of 1000ms\nhas completed before opening. Once the warmup period has completed, all\nsubsequent Overlays will open immediately. When no Overlays are opened,\na cooldown period of 1000ms will begin. Once the cooldown has completed,\nthe next Overlay to be opened will be subject to the warm-up period if\nprovided that option.",
+              "description": "An Overlay that is `delayed` will wait until a warm-up period of 1000ms\nhas completed before opening. Once the warm-up period has completed, all\nsubsequent Overlays will open immediately. When no Overlays are opened,\na cool-down period of 1000ms will begin. Once the cool-down has completed,\nthe next Overlay to be opened will be subject to the warm-up period if\nprovided that option.\n\nThis behavior helps to manage the performance and user experience by\npreventing multiple overlays from opening simultaneously and ensuring\na smooth transition between opening and closing overlays.",
+              "default": "false",
               "fieldName": "delayed"
             },
             {
@@ -2251,7 +2337,8 @@
               "type": {
                 "text": "boolean"
               },
-              "description": "Whether the overlay is currently functional or not",
+              "description": "Indicates whether the overlay is currently functional or not.\n\nWhen set to `true`, the overlay is disabled, and any active strategy is aborted.\nThe overlay will also close if it is currently open. When set to `false`, the\noverlay will re-bind events and re-open if it was previously open.",
+              "default": "false",
               "fieldName": "disabled"
             },
             {
@@ -2260,7 +2347,7 @@
                 "text": "number | [number, number]"
               },
               "default": "0",
-              "description": "The `offset` property accepts either a single number, to\ndefine the offset of the Overlay along the main axis from\nthe trigger, or 2-tuple, to define the offset along the\nmain axis and the cross axis. This option has no effect\nwhen there is no trigger element.",
+              "description": "The `offset` property accepts either a single number to define the offset of the\nOverlay along the main axis from the trigger, or a 2-tuple to define the offset\nalong both the main axis and the cross axis. This option has no effect when there\nis no trigger element.",
               "fieldName": "offset"
             },
             {
@@ -2268,7 +2355,8 @@
               "type": {
                 "text": "boolean"
               },
-              "description": "Whether the Overlay is projected onto the \"top layer\" or not.",
+              "description": "Indicates whether the Overlay is projected onto the \"top layer\" or not.\n\nWhen set to `true`, the overlay is open and visible. When set to `false`, the overlay is closed and hidden.",
+              "default": "false",
               "fieldName": "open"
             },
             {
@@ -2276,7 +2364,7 @@
               "type": {
                 "text": "\"top\" | \"top-start\" | \"top-end\" | \"right\" | \"right-start\" | \"right-end\" | \"bottom\" | \"bottom-start\" | \"bottom-end\" | \"left\" | \"left-start\" | \"left-end\""
               },
-              "description": "Instruct the Overlay where to place itself in\nrelationship to the trigger element.",
+              "description": "Instruct the Overlay where to place itself in relationship to the trigger element.",
               "fieldName": "placement"
             },
             {
@@ -2291,16 +2379,17 @@
             {
               "name": "tip-padding",
               "type": {
-                "text": "number | undefined"
+                "text": "number"
               },
+              "description": "The padding around the tip of the overlay.\nThis property defines the padding around the tip of the overlay, which can be used to adjust its positioning.",
               "fieldName": "tipPadding"
             },
             {
               "name": "trigger",
               "type": {
-                "text": "string | undefined"
+                "text": "string"
               },
-              "description": "An optional ID reference for the trigger element combined with the optional\ninteraction (click | hover | longpress) by which the overlay shold open\nthe overlay with an `@`: e.g. `trigger@click` opens the overlay when an\nelement with the ID \"trigger\" is clicked.",
+              "description": "An optional ID reference for the trigger element combined with the optional\ninteraction (click | hover | longpress) by which the overlay should open.\nThe format is `trigger@interaction`, e.g., `trigger@click` opens the overlay\nwhen an element with the ID \"trigger\" is clicked.",
               "fieldName": "trigger"
             },
             {
@@ -2314,7 +2403,7 @@
             }
           ],
           "superclass": {
-            "name": "OverlayFeatures",
+            "name": "ComputedOverlayBase",
             "module": "src/Overlay.ts"
           },
           "tagName": "sp-overlay",
@@ -3099,11 +3188,12 @@
       "declarations": [
         {
           "kind": "variable",
-          "name": "placementUpdatedSymbol"
+          "name": "placementUpdatedSymbol",
+          "description": "Symbol used to indicate that the placement has been updated."
         },
         {
           "kind": "class",
-          "description": "",
+          "description": "Controller for managing the placement of an overlay.\n\nThis class implements the ReactiveController interface and provides methods\nfor managing the positioning and constraints of an overlay element.",
           "name": "PlacementController",
           "members": [
             {
@@ -3112,21 +3202,24 @@
               "type": {
                 "text": "() => void | undefined"
               },
-              "privacy": "private"
+              "privacy": "private",
+              "description": "Function to clean up resources when the controller is no longer needed."
             },
             {
               "kind": "field",
               "name": "initialHeight",
               "type": {
-                "text": "number | undefined"
-              }
+                "text": "number"
+              },
+              "description": "Initial height of the overlay."
             },
             {
               "kind": "field",
               "name": "isConstrained",
               "type": {
-                "text": "boolean | undefined"
-              }
+                "text": "boolean"
+              },
+              "description": "Indicates whether the overlay is constrained by available space."
             },
             {
               "kind": "field",
@@ -3135,6 +3228,7 @@
                 "text": "ReactiveElement & { elements: OpenableElement[] }"
               },
               "privacy": "private",
+              "description": "The host element that uses this controller.",
               "default": "host"
             },
             {
@@ -3143,13 +3237,18 @@
               "type": {
                 "text": "OverlayOptionsV1"
               },
-              "privacy": "private"
+              "privacy": "private",
+              "description": "Options for configuring the overlay placement."
             },
             {
               "kind": "field",
               "name": "originalPlacements",
               "privacy": "private",
-              "default": "new WeakMap<HTMLElement, Placement>()"
+              "default": "new WeakMap<HTMLElement, Placement>()",
+              "description": "A WeakMap to store the original placements of overlay elements.",
+              "type": {
+                "text": "WeakMap<HTMLElement, Placement>"
+              }
             },
             {
               "kind": "field",
@@ -3157,7 +3256,8 @@
               "type": {
                 "text": "HTMLElement"
               },
-              "privacy": "private"
+              "privacy": "private",
+              "description": "The target element for the overlay."
             },
             {
               "kind": "method",
@@ -3174,16 +3274,21 @@
                   "default": "this.target",
                   "type": {
                     "text": "HTMLElement"
-                  }
+                  },
+                  "description": "The target element for the overlay.",
+                  "optional": true
                 },
                 {
                   "name": "options",
                   "default": "this.options",
                   "type": {
                     "text": "OverlayOptionsV1"
-                  }
+                  },
+                  "description": "The options for configuring the overlay placement.",
+                  "optional": true
                 }
-              ]
+              ],
+              "description": "Places the overlay relative to the target element.\n\nThis method sets up the necessary configurations and event listeners to manage the\npositioning and constraints of the overlay element."
             },
             {
               "kind": "field",
@@ -3191,15 +3296,20 @@
               "type": {
                 "text": "boolean"
               },
-              "default": "false"
+              "privacy": "public",
+              "default": "false",
+              "description": "Flag to allow or disallow placement updates."
             },
             {
               "kind": "field",
-              "name": "closeForAncestorUpdate"
+              "name": "closeForAncestorUpdate",
+              "description": "Closes the overlay if an ancestor element is updated.\n\nThis method checks if placement updates are allowed and if the overlay type is not 'modal'.\nIf these conditions are met and a cleanup function is defined, it dispatches a 'close' event\non the target element to close the overlay."
             },
             {
               "kind": "field",
-              "name": "updatePlacement"
+              "name": "updatePlacement",
+              "privacy": "private",
+              "description": "Updates the placement of the overlay.\n\nThis method calls the computePlacement method to recalculate the overlay's position."
             },
             {
               "kind": "method",
@@ -3208,7 +3318,8 @@
                 "type": {
                   "text": "Promise<void>"
                 }
-              }
+              },
+              "description": "Computes the placement of the overlay relative to the target element.\n\nThis method calculates the necessary positioning and constraints for the overlay element\nusing various middleware functions. It updates the overlay's style and attributes based\non the computed position."
             },
             {
               "kind": "method",
@@ -3218,12 +3329,14 @@
                 "type": {
                   "text": "void"
                 }
-              }
+              },
+              "description": "Clears the overlay's position styles.\n\nThis method removes the max-height and max-width styles from the target element,\nand resets the initial height and constrained state of the overlay."
             },
             {
               "kind": "field",
               "name": "resetOverlayPosition",
-              "privacy": "public"
+              "privacy": "public",
+              "description": "Resets the overlay's position.\n\nThis method clears the overlay's position, forces a reflow, and recomputes the placement."
             },
             {
               "kind": "method",
@@ -3232,7 +3345,8 @@
                 "type": {
                   "text": "void"
                 }
-              }
+              },
+              "description": "Lifecycle method called when the host element is connected to the DOM.\n\nThis method sets up an event listener to reset the overlay's position when the 'sp-update-overlays' event is dispatched."
             },
             {
               "kind": "method",
@@ -3241,7 +3355,8 @@
                 "type": {
                   "text": "void"
                 }
-              }
+              },
+              "description": "Lifecycle method called when the host element is updated.\n\nThis method cleans up resources if the overlay is not open."
             },
             {
               "kind": "method",
@@ -3250,7 +3365,8 @@
                 "type": {
                   "text": "void"
                 }
-              }
+              },
+              "description": "Lifecycle method called when the host element is disconnected from the DOM.\n\nThis method removes the event listener and cleans up resources."
             }
           ]
         }