@spectrum-web-components/overlay 0.42.2 → 0.42.3

package/custom-elements.json

@@ -81,79 +81,6 @@
             }
           }
         },
-        {
-          "kind": "class",
-          "description": "",
-          "name": "BeforetoggleClosedEvent",
-          "members": [
-            {
-              "kind": "field",
-              "name": "currentState",
-              "type": {
-                "text": "string"
-              },
-              "default": "'open'"
-            },
-            {
-              "kind": "field",
-              "name": "newState",
-              "type": {
-                "text": "string"
-              },
-              "default": "'closed'"
-            }
-          ],
-          "superclass": {
-            "name": "Event",
-            "module": "src/AbstractOverlay.ts"
-          }
-        },
-        {
-          "kind": "class",
-          "description": "",
-          "name": "BeforetoggleOpenEvent",
-          "members": [
-            {
-              "kind": "field",
-              "name": "currentState",
-              "type": {
-                "text": "string"
-              },
-              "default": "'closed'"
-            },
-            {
-              "kind": "field",
-              "name": "newState",
-              "type": {
-                "text": "string"
-              },
-              "default": "'open'"
-            }
-          ],
-          "superclass": {
-            "name": "Event",
-            "module": "src/AbstractOverlay.ts"
-          }
-        },
-        {
-          "kind": "class",
-          "description": "",
-          "name": "OverlayStateEvent",
-          "members": [
-            {
-              "kind": "field",
-              "name": "detail",
-              "type": {
-                "text": "{\n        interaction: string;\n        reason?: 'external-click';\n    }"
-              },
-              "default": "{\n            interaction,\n            reason,\n        }"
-            }
-          ],
-          "superclass": {
-            "name": "Event",
-            "module": "src/AbstractOverlay.ts"
-          }
-        },
         {
           "kind": "function",
           "name": "guaranteedAllTransitionend",
@@ -587,7 +514,7 @@
                 {
                   "name": "overlay",
                   "type": {
-                    "text": "Overlay"
+                    "text": "AbstractOverlay"
                   }
                 },
                 {
@@ -622,30 +549,6 @@
             "module": "src/AbstractOverlay.js"
           }
         },
-        {
-          "kind": "js",
-          "name": "BeforetoggleClosedEvent",
-          "declaration": {
-            "name": "BeforetoggleClosedEvent",
-            "module": "src/AbstractOverlay.js"
-          }
-        },
-        {
-          "kind": "js",
-          "name": "BeforetoggleOpenEvent",
-          "declaration": {
-            "name": "BeforetoggleOpenEvent",
-            "module": "src/AbstractOverlay.js"
-          }
-        },
-        {
-          "kind": "js",
-          "name": "OverlayStateEvent",
-          "declaration": {
-            "name": "OverlayStateEvent",
-            "module": "src/AbstractOverlay.js"
-          }
-        },
         {
           "kind": "js",
           "name": "guaranteedAllTransitionend",
@@ -756,6 +659,70 @@
                 "module": "src/InteractionController.js"
               }
             },
+            {
+              "kind": "field",
+              "name": "handleOverlayReady",
+              "type": {
+                "text": "(overlay: AbstractOverlay) => void | undefined"
+              },
+              "privacy": "private",
+              "default": "handleOverlayReady",
+              "inheritedFrom": {
+                "name": "InteractionController",
+                "module": "src/InteractionController.js"
+              }
+            },
+            {
+              "kind": "field",
+              "name": "open",
+              "type": {
+                "text": "boolean"
+              },
+              "privacy": "public",
+              "description": "Set `open` against the associated Overlay lazily.",
+              "inheritedFrom": {
+                "name": "InteractionController",
+                "module": "src/InteractionController.js"
+              }
+            },
+            {
+              "kind": "field",
+              "name": "overlay",
+              "type": {
+                "text": "AbstractOverlay"
+              },
+              "privacy": "public",
+              "default": "overlay",
+              "inheritedFrom": {
+                "name": "InteractionController",
+                "module": "src/InteractionController.js"
+              }
+            },
+            {
+              "kind": "field",
+              "name": "_overlay",
+              "type": {
+                "text": "AbstractOverlay"
+              },
+              "privacy": "private",
+              "inheritedFrom": {
+                "name": "InteractionController",
+                "module": "src/InteractionController.js"
+              }
+            },
+            {
+              "kind": "field",
+              "name": "isPersistent",
+              "type": {
+                "text": "boolean"
+              },
+              "privacy": "protected",
+              "default": "!!isPersistent",
+              "inheritedFrom": {
+                "name": "InteractionController",
+                "module": "src/InteractionController.js"
+              }
+            },
             {
               "kind": "method",
               "name": "prepareDescription",
@@ -803,6 +770,19 @@
                 "module": "src/InteractionController.js"
               }
             },
+            {
+              "kind": "method",
+              "name": "initOverlay",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "inheritedFrom": {
+                "name": "InteractionController",
+                "module": "src/InteractionController.js"
+              }
+            },
             {
               "kind": "method",
               "name": "abort",
@@ -1031,6 +1011,19 @@
                 "module": "src/InteractionController.js"
               }
             },
+            {
+              "kind": "method",
+              "name": "initOverlay",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "inheritedFrom": {
+                "name": "InteractionController",
+                "module": "src/InteractionController.js"
+              }
+            },
             {
               "kind": "field",
               "name": "abortController",
@@ -1054,6 +1047,70 @@
                 "module": "src/InteractionController.js"
               }
             },
+            {
+              "kind": "field",
+              "name": "handleOverlayReady",
+              "type": {
+                "text": "(overlay: AbstractOverlay) => void | undefined"
+              },
+              "privacy": "private",
+              "default": "handleOverlayReady",
+              "inheritedFrom": {
+                "name": "InteractionController",
+                "module": "src/InteractionController.js"
+              }
+            },
+            {
+              "kind": "field",
+              "name": "open",
+              "type": {
+                "text": "boolean"
+              },
+              "privacy": "public",
+              "description": "Set `open` against the associated Overlay lazily.",
+              "inheritedFrom": {
+                "name": "InteractionController",
+                "module": "src/InteractionController.js"
+              }
+            },
+            {
+              "kind": "field",
+              "name": "overlay",
+              "type": {
+                "text": "AbstractOverlay"
+              },
+              "privacy": "public",
+              "default": "overlay",
+              "inheritedFrom": {
+                "name": "InteractionController",
+                "module": "src/InteractionController.js"
+              }
+            },
+            {
+              "kind": "field",
+              "name": "_overlay",
+              "type": {
+                "text": "AbstractOverlay"
+              },
+              "privacy": "private",
+              "inheritedFrom": {
+                "name": "InteractionController",
+                "module": "src/InteractionController.js"
+              }
+            },
+            {
+              "kind": "field",
+              "name": "isPersistent",
+              "type": {
+                "text": "boolean"
+              },
+              "privacy": "protected",
+              "default": "!!isPersistent",
+              "inheritedFrom": {
+                "name": "InteractionController",
+                "module": "src/InteractionController.js"
+              }
+            },
             {
               "kind": "method",
               "name": "releaseDescription",
@@ -1161,6 +1218,50 @@
               },
               "readonly": true
             },
+            {
+              "kind": "field",
+              "name": "handleOverlayReady",
+              "type": {
+                "text": "(overlay: AbstractOverlay) => void | undefined"
+              },
+              "privacy": "private",
+              "default": "handleOverlayReady"
+            },
+            {
+              "kind": "field",
+              "name": "open",
+              "type": {
+                "text": "boolean"
+              },
+              "privacy": "public",
+              "description": "Set `open` against the associated Overlay lazily."
+            },
+            {
+              "kind": "field",
+              "name": "overlay",
+              "type": {
+                "text": "AbstractOverlay"
+              },
+              "privacy": "public",
+              "default": "overlay"
+            },
+            {
+              "kind": "field",
+              "name": "_overlay",
+              "type": {
+                "text": "AbstractOverlay"
+              },
+              "privacy": "private"
+            },
+            {
+              "kind": "field",
+              "name": "isPersistent",
+              "type": {
+                "text": "boolean"
+              },
+              "privacy": "protected",
+              "default": "!!isPersistent"
+            },
             {
               "kind": "field",
               "name": "type",
@@ -1212,6 +1313,15 @@
                 }
               }
             },
+            {
+              "kind": "method",
+              "name": "initOverlay",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              }
+            },
             {
               "kind": "method",
               "name": "abort",
@@ -1449,6 +1559,83 @@
                 "module": "src/InteractionController.js"
               }
             },
+            {
+              "kind": "field",
+              "name": "handleOverlayReady",
+              "type": {
+                "text": "(overlay: AbstractOverlay) => void | undefined"
+              },
+              "privacy": "private",
+              "default": "handleOverlayReady",
+              "inheritedFrom": {
+                "name": "InteractionController",
+                "module": "src/InteractionController.js"
+              }
+            },
+            {
+              "kind": "field",
+              "name": "open",
+              "type": {
+                "text": "boolean"
+              },
+              "privacy": "public",
+              "description": "Set `open` against the associated Overlay lazily.",
+              "inheritedFrom": {
+                "name": "InteractionController",
+                "module": "src/InteractionController.js"
+              }
+            },
+            {
+              "kind": "field",
+              "name": "overlay",
+              "type": {
+                "text": "AbstractOverlay"
+              },
+              "privacy": "public",
+              "default": "overlay",
+              "inheritedFrom": {
+                "name": "InteractionController",
+                "module": "src/InteractionController.js"
+              }
+            },
+            {
+              "kind": "field",
+              "name": "_overlay",
+              "type": {
+                "text": "AbstractOverlay"
+              },
+              "privacy": "private",
+              "inheritedFrom": {
+                "name": "InteractionController",
+                "module": "src/InteractionController.js"
+              }
+            },
+            {
+              "kind": "field",
+              "name": "isPersistent",
+              "type": {
+                "text": "boolean"
+              },
+              "privacy": "protected",
+              "default": "!!isPersistent",
+              "inheritedFrom": {
+                "name": "InteractionController",
+                "module": "src/InteractionController.js"
+              }
+            },
+            {
+              "kind": "method",
+              "name": "initOverlay",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "inheritedFrom": {
+                "name": "InteractionController",
+                "module": "src/InteractionController.js"
+              }
+            },
             {
               "kind": "method",
               "name": "abort",
@@ -1518,14 +1705,6 @@
       "kind": "javascript-module",
       "path": "src/Overlay.js",
       "declarations": [
-        {
-          "kind": "variable",
-          "name": "strategies",
-          "type": {
-            "text": "object"
-          },
-          "default": "{\n    click: ClickController,\n    longpress: LongpressController,\n    hover: HoverController,\n}"
-        },
         {
           "kind": "class",
           "description": "",
@@ -2095,14 +2274,6 @@
             "module": "./LongpressController.js"
           }
         },
-        {
-          "kind": "js",
-          "name": "strategies",
-          "declaration": {
-            "name": "strategies",
-            "module": "src/Overlay.js"
-          }
-        },
         {
           "kind": "js",
           "name": "Overlay",

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@spectrum-web-components/overlay",
-    "version": "0.42.2",
+    "version": "0.42.3",
     "publishConfig": {
         "access": "public"
     },
@@ -77,6 +77,10 @@
             "development": "./src/VirtualTrigger.dev.js",
             "default": "./src/VirtualTrigger.js"
         },
+        "./src/events.js": {
+            "development": "./src/events.dev.js",
+            "default": "./src/events.js"
+        },
         "./src/fullSizePlugin.js": {
             "development": "./src/fullSizePlugin.dev.js",
             "default": "./src/fullSizePlugin.js"
@@ -115,6 +119,10 @@
             "development": "./src/slottable-request-event.dev.js",
             "default": "./src/slottable-request-event.js"
         },
+        "./src/strategies.js": {
+            "development": "./src/strategies.dev.js",
+            "default": "./src/strategies.js"
+        },
         "./active-overlay.js": {
             "development": "./active-overlay.dev.js",
             "default": "./active-overlay.js"
@@ -152,11 +160,11 @@
     "dependencies": {
         "@floating-ui/dom": "^1.6.1",
         "@floating-ui/utils": "^0.2.1",
-        "@spectrum-web-components/action-button": "^0.42.2",
-        "@spectrum-web-components/base": "^0.42.2",
-        "@spectrum-web-components/reactive-controllers": "^0.42.2",
-        "@spectrum-web-components/shared": "^0.42.2",
-        "@spectrum-web-components/theme": "^0.42.2"
+        "@spectrum-web-components/action-button": "^0.42.3",
+        "@spectrum-web-components/base": "^0.42.3",
+        "@spectrum-web-components/reactive-controllers": "^0.42.3",
+        "@spectrum-web-components/shared": "^0.42.3",
+        "@spectrum-web-components/theme": "^0.42.3"
     },
     "types": "./src/index.d.ts",
     "customElements": "custom-elements.json",
@@ -168,5 +176,5 @@
         "./stories/overlay-story-components.js",
         "./**/*.dev.js"
     ],
-    "gitHead": "e19af30387032608baaa88c6a17c2ee50103a7c5"
+    "gitHead": "a03edce4f21f232f1705d8eb222e6e5436cad4c3"
 }

package/src/AbstractOverlay.d.ts

@@ -1,5 +1,5 @@
 import { SpectrumElement } from '@spectrum-web-components/base';
-import type { OpenableElement, OverlayOptions, OverlayOptionsV1, OverlayState, OverlayTypes, Placement, TriggerInteractions, TriggerInteractionsV1 } from './overlay-types.js';
+import type { OpenableElement, OverlayOptions, OverlayOptionsV1, OverlayState, OverlayTypes, Placement, TriggerInteractionsV1 } from './overlay-types.js';
 import type { Overlay } from './Overlay.js';
 import type { VirtualTrigger } from './VirtualTrigger.js';
 import { OverlayTimer } from './overlay-timer.js';
@@ -7,34 +7,6 @@ import type { PlacementController } from './PlacementController.js';
 import type { ElementResolutionController } from '@spectrum-web-components/reactive-controllers/src/ElementResolution.js';
 export declare const overlayTimer: OverlayTimer;
 export declare const noop: () => void;
-export declare class BeforetoggleClosedEvent extends Event {
-    currentState: string;
-    newState: string;
-    constructor();
-}
-export declare class BeforetoggleOpenEvent extends Event {
-    currentState: string;
-    newState: string;
-    constructor();
-}
-export declare class OverlayStateEvent extends Event {
-    overlay: HTMLElement;
-    detail: {
-        interaction: string;
-        reason?: 'external-click';
-    };
-    constructor(type: string, overlay: HTMLElement, { publish, interaction, reason, }: {
-        publish?: boolean;
-        interaction: TriggerInteractions;
-        reason?: 'external-click';
-    });
-}
-declare global {
-    interface GlobalEventHandlersEventMap {
-        'sp-open': OverlayStateEvent;
-        'sp-close': OverlayStateEvent;
-    }
-}
 /**
  * Apply a "transitionend" listener to an element that may not transition but
  * guarantee the callback will be fired either way.
@@ -96,5 +68,5 @@ export declare class AbstractOverlay extends SpectrumElement {
      */
     static open(trigger: HTMLElement, interaction: TriggerInteractionsV1, content: HTMLElement, optionsV1: OverlayOptionsV1): Promise<() => void>;
     static open(content: HTMLElement, options?: OverlayOptions): Promise<Overlay>;
-    static applyOptions(overlay: Overlay, options: OverlayOptions): void;
+    static applyOptions(overlay: AbstractOverlay, options: OverlayOptions): void;
 }

package/src/AbstractOverlay.dev.js

@@ -6,43 +6,6 @@ export const overlayTimer = new OverlayTimer();
 export const noop = () => {
   return;
 };
-export class BeforetoggleClosedEvent extends Event {
-  constructor() {
-    super("beforetoggle", {
-      bubbles: false,
-      composed: false
-    });
-    this.currentState = "open";
-    this.newState = "closed";
-  }
-}
-export class BeforetoggleOpenEvent extends Event {
-  constructor() {
-    super("beforetoggle", {
-      bubbles: false,
-      composed: false
-    });
-    this.currentState = "closed";
-    this.newState = "open";
-  }
-}
-export class OverlayStateEvent extends Event {
-  constructor(type, overlay, {
-    publish,
-    interaction,
-    reason
-  }) {
-    super(type, {
-      bubbles: publish,
-      composed: publish
-    });
-    this.overlay = overlay;
-    this.detail = {
-      interaction,
-      reason
-    };
-  }
-}
 export const guaranteedAllTransitionend = (el, action, cb) => {
   const abortController = new AbortController();
   const runningTransitions = /* @__PURE__ */ new Map();