@spectrum-web-components/overlay 0.35.0 → 0.35.1-rc.24

package/src/AbstractOverlay.d.ts

@@ -0,0 +1,56 @@
+import { SpectrumElement } from '@spectrum-web-components/base';
+import type { OpenableElement, OverlayOptions, OverlayOptionsV1, OverlayState, OverlayTypes, TriggerInteractionsV1 } from './overlay-types.js';
+import { Overlay } from './Overlay.js';
+import type { VirtualTrigger } from './VirtualTrigger.js';
+import { OverlayTimer } from './overlay-timer.js';
+import { PlacementController } from './PlacementController.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();
+}
+/**
+ * Apply a "transitionend" listener to an element that may not transition but
+ * guarantee the callback will be fired either way.
+ *
+ * @param el {HTMLElement} - Target of the "transition" listeners.
+ * @param action {Function} - Method to trigger the "transition".
+ * @param cb {Function} - Callback to trigger when the "transition" has ended.
+ */
+export declare const guaranteedAllTransitionend: (el: HTMLElement, action: () => void, cb: () => void) => void;
+export declare function nextFrame(): Promise<void>;
+export declare class AbstractOverlay extends SpectrumElement {
+    protected applyFocus(_targetOpenState: boolean, _focusEl: HTMLElement | null): Promise<void>;
+    delayed: boolean;
+    dialogEl: HTMLDialogElement & {
+        showPopover(): void;
+        hidePopover(): void;
+    };
+    dispose: () => void;
+    protected ensureOnDOM(_targetOpenState: boolean): Promise<void>;
+    elements: OpenableElement[];
+    protected makeTransition(_targetOpenState: boolean): Promise<HTMLElement | null>;
+    protected manageDelay(_targetOpenState: boolean): Promise<void>;
+    protected manageDialogOpen(): Promise<void>;
+    protected managePopoverOpen(): Promise<void>;
+    protected managePosition(): void;
+    get open(): boolean;
+    set open(_open: boolean);
+    protected placementController: PlacementController;
+    receivesFocus: 'true' | 'false' | 'auto';
+    get state(): OverlayState;
+    set state(_state: OverlayState);
+    protected _state: OverlayState;
+    triggerElement: HTMLElement | VirtualTrigger | null;
+    type: OverlayTypes;
+    static update(): void;
+    static open(trigger: HTMLElement, interaction: TriggerInteractionsV1, content: HTMLElement, optionsV1: OverlayOptionsV1): Promise<() => void>;
+    static open(content: HTMLElement, options?: OverlayOptions): Promise<Overlay>;
+}

package/src/AbstractOverlay.dev.js

@@ -0,0 +1,198 @@
+"use strict";
+import { SpectrumElement } from "@spectrum-web-components/base";
+import { reparentChildren } from "@spectrum-web-components/shared/src/reparent-children.js";
+import { Overlay } from "./Overlay.dev.js";
+import { OverlayTimer } from "./overlay-timer.dev.js";
+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 const guaranteedAllTransitionend = (el, action, cb) => {
+  const runningTransitions = /* @__PURE__ */ new Map();
+  const cleanup = () => {
+    el.removeEventListener("transitionrun", handleTransitionrun);
+    el.removeEventListener("transitionend", handleTransitionend);
+    cb();
+  };
+  let guarantee2;
+  let guarantee3;
+  const guarantee1 = requestAnimationFrame(() => {
+    guarantee2 = requestAnimationFrame(() => {
+      guarantee3 = requestAnimationFrame(() => {
+        cleanup();
+      });
+    });
+  });
+  const handleTransitionend = (event) => {
+    if (event.target !== el) {
+      return;
+    }
+    runningTransitions.set(
+      event.propertyName,
+      runningTransitions.get(event.propertyName) - 1
+    );
+    if (!runningTransitions.get(event.propertyName)) {
+      runningTransitions.delete(event.propertyName);
+    }
+    if (runningTransitions.size === 0) {
+      cleanup();
+    }
+  };
+  const handleTransitionrun = (event) => {
+    if (event.target !== el) {
+      return;
+    }
+    if (!runningTransitions.has(event.propertyName)) {
+      runningTransitions.set(event.propertyName, 0);
+    }
+    runningTransitions.set(
+      event.propertyName,
+      runningTransitions.get(event.propertyName) + 1
+    );
+    cancelAnimationFrame(guarantee1);
+    cancelAnimationFrame(guarantee2);
+    cancelAnimationFrame(guarantee3);
+  };
+  el.addEventListener("transitionrun", handleTransitionrun);
+  el.addEventListener("transitionend", handleTransitionend);
+  action();
+};
+export function nextFrame() {
+  return new Promise((res) => requestAnimationFrame(() => res()));
+}
+export class AbstractOverlay extends SpectrumElement {
+  constructor() {
+    super(...arguments);
+    this.dispose = noop;
+  }
+  async applyFocus(_targetOpenState, _focusEl) {
+    return;
+  }
+  async ensureOnDOM(_targetOpenState) {
+    return;
+  }
+  async makeTransition(_targetOpenState) {
+    return null;
+  }
+  async manageDelay(_targetOpenState) {
+    return;
+  }
+  async manageDialogOpen() {
+    return;
+  }
+  async managePopoverOpen() {
+    return;
+  }
+  managePosition() {
+    return;
+  }
+  get open() {
+    return false;
+  }
+  set open(_open) {
+    return;
+  }
+  get state() {
+    return "closed";
+  }
+  set state(_state) {
+    return;
+  }
+  static update() {
+    const overlayUpdateEvent = new CustomEvent("sp-update-overlays", {
+      bubbles: true,
+      composed: true,
+      cancelable: true
+    });
+    document.dispatchEvent(overlayUpdateEvent);
+  }
+  static async open(triggerOrContent, interactionOrOptions, content, optionsV1) {
+    var _a, _b, _c, _d;
+    const v2 = arguments.length === 2;
+    const overlayContent = content || triggerOrContent;
+    const overlay = new Overlay();
+    let restored = false;
+    overlay.dispose = () => {
+      overlay.addEventListener("sp-closed", () => {
+        if (!restored) {
+          restoreContent();
+          restored = true;
+        }
+        requestAnimationFrame(() => {
+          overlay.remove();
+        });
+      });
+      overlay.open = false;
+      overlay.dispose = noop;
+    };
+    const restoreContent = reparentChildren([overlayContent], overlay, {
+      position: "beforeend",
+      prepareCallback: (el) => {
+        const slot = el.slot;
+        el.removeAttribute("slot");
+        return () => {
+          el.slot = slot;
+        };
+      }
+    });
+    const v1 = !v2 && overlayContent && optionsV1;
+    if (v1) {
+      if (true) {
+        window.__swc.warn(
+          overlay,
+          `You are interacting with an ${overlay.localName} element via a deprecated imperative API. This API will be removed in a future version of the SWC library. Consider leveraging an ${overlay.localName} directly.`,
+          "https://opensource.adobe.com/spectrum-web-components/components/overlay/",
+          { level: "deprecation" }
+        );
+      }
+      const trigger = triggerOrContent;
+      const interaction = interactionOrOptions;
+      const options2 = optionsV1;
+      overlay.delayed = options2.delayed || overlayContent.hasAttribute("delayed");
+      overlay.receivesFocus = (_a = options2.receivesFocus) != null ? _a : "auto";
+      overlay.triggerElement = options2.virtualTrigger || trigger;
+      overlay.type = interaction === "modal" ? "modal" : interaction === "hover" ? "hint" : "auto";
+      overlay.offset = (_b = options2.offset) != null ? _b : 6;
+      overlay.placement = options2.placement;
+      overlay.willPreventClose = !!options2.notImmediatelyClosable;
+      trigger.insertAdjacentElement("afterend", overlay);
+      await overlay.updateComplete;
+      overlay.open = true;
+      return overlay.dispose;
+    }
+    const options = interactionOrOptions;
+    overlay.append(overlayContent);
+    overlay.delayed = options.delayed || overlayContent.hasAttribute("delayed");
+    overlay.receivesFocus = (_c = options.receivesFocus) != null ? _c : "auto";
+    overlay.triggerElement = options.trigger || null;
+    overlay.type = options.type || "modal";
+    overlay.offset = (_d = options.offset) != null ? _d : 6;
+    overlay.placement = options.placement;
+    overlay.willPreventClose = !!options.notImmediatelyClosable;
+    overlay.updateComplete.then(() => {
+      overlay.open = true;
+    });
+    return overlay;
+  }
+}
+//# sourceMappingURL=AbstractOverlay.dev.js.map

package/src/AbstractOverlay.dev.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["AbstractOverlay.ts"],
+  "sourcesContent": ["/*\nCopyright 2020 Adobe. All rights reserved.\nThis file is licensed to you under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License. You may obtain a copy\nof the License at http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software distributed under\nthe License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS\nOF ANY KIND, either express or implied. See the License for the specific language\ngoverning permissions and limitations under the License.\n*/\nimport { SpectrumElement } from '@spectrum-web-components/base';\nimport { reparentChildren } from '@spectrum-web-components/shared/src/reparent-children.js';\n\nimport type {\n    OpenableElement,\n    OverlayOptions,\n    OverlayOptionsV1,\n    OverlayState,\n    OverlayTypes,\n    TriggerInteractionsV1,\n} from './overlay-types.dev.js'\nimport { Overlay } from './Overlay.dev.js'\nimport type { VirtualTrigger } from './VirtualTrigger.dev.js'\nimport { OverlayTimer } from './overlay-timer.dev.js'\nimport { PlacementController } from './PlacementController.dev.js'\n\nexport const overlayTimer = new OverlayTimer();\n\nexport const noop = (): void => {\n    return;\n};\n\nexport class BeforetoggleClosedEvent extends Event {\n    currentState = 'open';\n    newState = 'closed';\n    constructor() {\n        super('beforetoggle', {\n            bubbles: false,\n            composed: false,\n        });\n    }\n}\n\nexport class BeforetoggleOpenEvent extends Event {\n    currentState = 'closed';\n    newState = 'open';\n    constructor() {\n        super('beforetoggle', {\n            bubbles: false,\n            composed: false,\n        });\n    }\n}\n\n/**\n * Apply a \"transitionend\" listener to an element that may not transition but\n * guarantee the callback will be fired either way.\n *\n * @param el {HTMLElement} - Target of the \"transition\" listeners.\n * @param action {Function} - Method to trigger the \"transition\".\n * @param cb {Function} - Callback to trigger when the \"transition\" has ended.\n */\nexport const guaranteedAllTransitionend = (\n    el: HTMLElement,\n    action: () => void,\n    cb: () => void\n): void => {\n    const runningTransitions = new Map<string, number>();\n    const cleanup = (): void => {\n        el.removeEventListener('transitionrun', handleTransitionrun);\n        el.removeEventListener('transitionend', handleTransitionend);\n        cb();\n    };\n    let guarantee2: number;\n    let guarantee3: number;\n    // WebKit fires `transitionrun` a little earlier, the multiple guarantees here\n    // allow WebKit to be caught, but doesn't remove the animation listener until\n    // after it would have fired in Chromium.\n    const guarantee1 = requestAnimationFrame(() => {\n        guarantee2 = requestAnimationFrame(() => {\n            guarantee3 = requestAnimationFrame(() => {\n                cleanup();\n            });\n        });\n    });\n    const handleTransitionend = (event: TransitionEvent): void => {\n        if (event.target !== el) {\n            return;\n        }\n        runningTransitions.set(\n            event.propertyName,\n            (runningTransitions.get(event.propertyName) as number) - 1\n        );\n        if (!runningTransitions.get(event.propertyName)) {\n            runningTransitions.delete(event.propertyName);\n        }\n        if (runningTransitions.size === 0) {\n            cleanup();\n        }\n    };\n    const handleTransitionrun = (event: TransitionEvent): void => {\n        if (event.target !== el) {\n            return;\n        }\n        if (!runningTransitions.has(event.propertyName)) {\n            runningTransitions.set(event.propertyName, 0);\n        }\n        runningTransitions.set(\n            event.propertyName,\n            (runningTransitions.get(event.propertyName) as number) + 1\n        );\n        cancelAnimationFrame(guarantee1);\n        cancelAnimationFrame(guarantee2);\n        cancelAnimationFrame(guarantee3);\n    };\n    el.addEventListener('transitionrun', handleTransitionrun);\n    el.addEventListener('transitionend', handleTransitionend);\n    action();\n};\n\nexport function nextFrame(): Promise<void> {\n    return new Promise((res) => requestAnimationFrame(() => res()));\n}\n\nexport class AbstractOverlay extends SpectrumElement {\n    protected async applyFocus(\n        _targetOpenState: boolean,\n        _focusEl: HTMLElement | null\n    ): Promise<void> {\n        return;\n    }\n    delayed!: boolean;\n    dialogEl!: HTMLDialogElement & {\n        showPopover(): void;\n        hidePopover(): void;\n    };\n    dispose = noop;\n    protected async ensureOnDOM(_targetOpenState: boolean): Promise<void> {\n        return;\n    }\n    elements!: OpenableElement[];\n    protected async makeTransition(\n        _targetOpenState: boolean\n    ): Promise<HTMLElement | null> {\n        return null;\n    }\n    protected async manageDelay(_targetOpenState: boolean): Promise<void> {\n        return;\n    }\n    protected async manageDialogOpen(): Promise<void> {\n        return;\n    }\n    protected async managePopoverOpen(): Promise<void> {\n        return;\n    }\n    protected managePosition(): void {\n        return;\n    }\n    get open(): boolean {\n        return false;\n    }\n    set open(_open: boolean) {\n        return;\n    }\n    protected placementController!: PlacementController;\n    receivesFocus!: 'true' | 'false' | 'auto';\n    get state(): OverlayState {\n        return 'closed';\n    }\n    set state(_state: OverlayState) {\n        return;\n    }\n    protected _state!: OverlayState;\n    triggerElement!: HTMLElement | VirtualTrigger | null;\n    type!: OverlayTypes;\n\n    public static update(): void {\n        const overlayUpdateEvent = new CustomEvent('sp-update-overlays', {\n            bubbles: true,\n            composed: true,\n            cancelable: true,\n        });\n        document.dispatchEvent(overlayUpdateEvent);\n    }\n\n    public static async open(\n        trigger: HTMLElement,\n        interaction: TriggerInteractionsV1,\n        content: HTMLElement,\n        optionsV1: OverlayOptionsV1\n    ): Promise<() => void>;\n    public static async open(\n        content: HTMLElement,\n        options?: OverlayOptions\n    ): Promise<Overlay>;\n    public static async open(\n        triggerOrContent: HTMLElement,\n        interactionOrOptions:\n            | TriggerInteractionsV1\n            | OverlayOptions\n            | undefined,\n        content?: HTMLElement,\n        optionsV1?: OverlayOptionsV1\n    ): Promise<Overlay | (() => void)> {\n        const v2 = arguments.length === 2;\n        const overlayContent = content || triggerOrContent;\n        const overlay = new Overlay();\n        let restored = false;\n        overlay.dispose = () => {\n            overlay.addEventListener('sp-closed', () => {\n                if (!restored) {\n                    restoreContent();\n                    restored = true;\n                }\n                requestAnimationFrame(() => {\n                    overlay.remove();\n                });\n            });\n            overlay.open = false;\n            overlay.dispose = noop;\n        };\n        /**\n         * Since content must exist in an <sp-overlay>, we need a way to get it there.\n         * The best & most-direct way is to declaratively use an <sp-overlay> element,\n         * but for imperative users, we'll reparent content into an overlay that we've created for them.\n         **/\n        const restoreContent = reparentChildren([overlayContent], overlay, {\n            position: 'beforeend',\n            prepareCallback: (el) => {\n                // Ensure that content to be overlaid is no longer targetted to a specific `slot`.\n                // This allow for it to be visible in the overlaid context.\n                const slot = el.slot;\n                el.removeAttribute('slot');\n                return () => {\n                    el.slot = slot;\n                };\n            },\n        });\n\n        const v1 = !v2 && overlayContent && optionsV1;\n        if (v1) {\n            if (window.__swc.DEBUG) {\n                window.__swc.warn(\n                    overlay,\n                    `You are interacting with an ${overlay.localName} element via a deprecated imperative API. This API will be removed in a future version of the SWC library. Consider leveraging an ${overlay.localName} directly.`,\n                    'https://opensource.adobe.com/spectrum-web-components/components/overlay/',\n                    { level: 'deprecation' }\n                );\n            }\n            const trigger = triggerOrContent;\n            const interaction = interactionOrOptions;\n            const options = optionsV1;\n            overlay.delayed =\n                options.delayed || overlayContent.hasAttribute('delayed');\n            overlay.receivesFocus = options.receivesFocus ?? 'auto';\n            overlay.triggerElement = options.virtualTrigger || trigger;\n            overlay.type =\n                interaction === 'modal'\n                    ? 'modal'\n                    : interaction === 'hover'\n                    ? 'hint'\n                    : 'auto';\n            overlay.offset = options.offset ?? 6;\n            overlay.placement = options.placement;\n            overlay.willPreventClose = !!options.notImmediatelyClosable;\n            trigger.insertAdjacentElement('afterend', overlay);\n            await overlay.updateComplete;\n            overlay.open = true;\n            return overlay.dispose;\n        }\n\n        const options = interactionOrOptions as OverlayOptions;\n        overlay.append(overlayContent);\n        overlay.delayed =\n            options.delayed || overlayContent.hasAttribute('delayed');\n        overlay.receivesFocus = options.receivesFocus ?? 'auto';\n        overlay.triggerElement = options.trigger || null;\n        overlay.type = options.type || 'modal';\n        overlay.offset = options.offset ?? 6;\n        overlay.placement = options.placement;\n        overlay.willPreventClose = !!options.notImmediatelyClosable;\n        overlay.updateComplete.then(() => {\n            // Do we want to \"open\" this path, or leave that to the consumer?\n            overlay.open = true;\n        });\n        return overlay;\n    }\n}\n"],
+  "mappings": ";AAWA,SAAS,uBAAuB;AAChC,SAAS,wBAAwB;AAUjC,SAAS,eAAe;AAExB,SAAS,oBAAoB;AAGtB,aAAM,eAAe,IAAI,aAAa;AAEtC,aAAM,OAAO,MAAY;AAC5B;AACJ;AAEO,aAAM,gCAAgC,MAAM;AAAA,EAG/C,cAAc;AACV,UAAM,gBAAgB;AAAA,MAClB,SAAS;AAAA,MACT,UAAU;AAAA,IACd,CAAC;AANL,wBAAe;AACf,oBAAW;AAAA,EAMX;AACJ;AAEO,aAAM,8BAA8B,MAAM;AAAA,EAG7C,cAAc;AACV,UAAM,gBAAgB;AAAA,MAClB,SAAS;AAAA,MACT,UAAU;AAAA,IACd,CAAC;AANL,wBAAe;AACf,oBAAW;AAAA,EAMX;AACJ;AAUO,aAAM,6BAA6B,CACtC,IACA,QACA,OACO;AACP,QAAM,qBAAqB,oBAAI,IAAoB;AACnD,QAAM,UAAU,MAAY;AACxB,OAAG,oBAAoB,iBAAiB,mBAAmB;AAC3D,OAAG,oBAAoB,iBAAiB,mBAAmB;AAC3D,OAAG;AAAA,EACP;AACA,MAAI;AACJ,MAAI;AAIJ,QAAM,aAAa,sBAAsB,MAAM;AAC3C,iBAAa,sBAAsB,MAAM;AACrC,mBAAa,sBAAsB,MAAM;AACrC,gBAAQ;AAAA,MACZ,CAAC;AAAA,IACL,CAAC;AAAA,EACL,CAAC;AACD,QAAM,sBAAsB,CAAC,UAAiC;AAC1D,QAAI,MAAM,WAAW,IAAI;AACrB;AAAA,IACJ;AACA,uBAAmB;AAAA,MACf,MAAM;AAAA,MACL,mBAAmB,IAAI,MAAM,YAAY,IAAe;AAAA,IAC7D;AACA,QAAI,CAAC,mBAAmB,IAAI,MAAM,YAAY,GAAG;AAC7C,yBAAmB,OAAO,MAAM,YAAY;AAAA,IAChD;AACA,QAAI,mBAAmB,SAAS,GAAG;AAC/B,cAAQ;AAAA,IACZ;AAAA,EACJ;AACA,QAAM,sBAAsB,CAAC,UAAiC;AAC1D,QAAI,MAAM,WAAW,IAAI;AACrB;AAAA,IACJ;AACA,QAAI,CAAC,mBAAmB,IAAI,MAAM,YAAY,GAAG;AAC7C,yBAAmB,IAAI,MAAM,cAAc,CAAC;AAAA,IAChD;AACA,uBAAmB;AAAA,MACf,MAAM;AAAA,MACL,mBAAmB,IAAI,MAAM,YAAY,IAAe;AAAA,IAC7D;AACA,yBAAqB,UAAU;AAC/B,yBAAqB,UAAU;AAC/B,yBAAqB,UAAU;AAAA,EACnC;AACA,KAAG,iBAAiB,iBAAiB,mBAAmB;AACxD,KAAG,iBAAiB,iBAAiB,mBAAmB;AACxD,SAAO;AACX;AAEO,gBAAS,YAA2B;AACvC,SAAO,IAAI,QAAQ,CAAC,QAAQ,sBAAsB,MAAM,IAAI,CAAC,CAAC;AAClE;AAEO,aAAM,wBAAwB,gBAAgB;AAAA,EAA9C;AAAA;AAYH,mBAAU;AAAA;AAAA,EAXV,MAAgB,WACZ,kBACA,UACa;AACb;AAAA,EACJ;AAAA,EAOA,MAAgB,YAAY,kBAA0C;AAClE;AAAA,EACJ;AAAA,EAEA,MAAgB,eACZ,kBAC2B;AAC3B,WAAO;AAAA,EACX;AAAA,EACA,MAAgB,YAAY,kBAA0C;AAClE;AAAA,EACJ;AAAA,EACA,MAAgB,mBAAkC;AAC9C;AAAA,EACJ;AAAA,EACA,MAAgB,oBAAmC;AAC/C;AAAA,EACJ;AAAA,EACU,iBAAuB;AAC7B;AAAA,EACJ;AAAA,EACA,IAAI,OAAgB;AAChB,WAAO;AAAA,EACX;AAAA,EACA,IAAI,KAAK,OAAgB;AACrB;AAAA,EACJ;AAAA,EAGA,IAAI,QAAsB;AACtB,WAAO;AAAA,EACX;AAAA,EACA,IAAI,MAAM,QAAsB;AAC5B;AAAA,EACJ;AAAA,EAKA,OAAc,SAAe;AACzB,UAAM,qBAAqB,IAAI,YAAY,sBAAsB;AAAA,MAC7D,SAAS;AAAA,MACT,UAAU;AAAA,MACV,YAAY;AAAA,IAChB,CAAC;AACD,aAAS,cAAc,kBAAkB;AAAA,EAC7C;AAAA,EAYA,aAAoB,KAChB,kBACA,sBAIA,SACA,WAC+B;AA5MvC;AA6MQ,UAAM,KAAK,UAAU,WAAW;AAChC,UAAM,iBAAiB,WAAW;AAClC,UAAM,UAAU,IAAI,QAAQ;AAC5B,QAAI,WAAW;AACf,YAAQ,UAAU,MAAM;AACpB,cAAQ,iBAAiB,aAAa,MAAM;AACxC,YAAI,CAAC,UAAU;AACX,yBAAe;AACf,qBAAW;AAAA,QACf;AACA,8BAAsB,MAAM;AACxB,kBAAQ,OAAO;AAAA,QACnB,CAAC;AAAA,MACL,CAAC;AACD,cAAQ,OAAO;AACf,cAAQ,UAAU;AAAA,IACtB;AAMA,UAAM,iBAAiB,iBAAiB,CAAC,cAAc,GAAG,SAAS;AAAA,MAC/D,UAAU;AAAA,MACV,iBAAiB,CAAC,OAAO;AAGrB,cAAM,OAAO,GAAG;AAChB,WAAG,gBAAgB,MAAM;AACzB,eAAO,MAAM;AACT,aAAG,OAAO;AAAA,QACd;AAAA,MACJ;AAAA,IACJ,CAAC;AAED,UAAM,KAAK,CAAC,MAAM,kBAAkB;AACpC,QAAI,IAAI;AACJ,UAAI,MAAoB;AACpB,eAAO,MAAM;AAAA,UACT;AAAA,UACA,+BAA+B,QAAQ,8IAA8I,QAAQ;AAAA,UAC7L;AAAA,UACA,EAAE,OAAO,cAAc;AAAA,QAC3B;AAAA,MACJ;AACA,YAAM,UAAU;AAChB,YAAM,cAAc;AACpB,YAAMA,WAAU;AAChB,cAAQ,UACJA,SAAQ,WAAW,eAAe,aAAa,SAAS;AAC5D,cAAQ,iBAAgB,KAAAA,SAAQ,kBAAR,YAAyB;AACjD,cAAQ,iBAAiBA,SAAQ,kBAAkB;AACnD,cAAQ,OACJ,gBAAgB,UACV,UACA,gBAAgB,UAChB,SACA;AACV,cAAQ,UAAS,KAAAA,SAAQ,WAAR,YAAkB;AACnC,cAAQ,YAAYA,SAAQ;AAC5B,cAAQ,mBAAmB,CAAC,CAACA,SAAQ;AACrC,cAAQ,sBAAsB,YAAY,OAAO;AACjD,YAAM,QAAQ;AACd,cAAQ,OAAO;AACf,aAAO,QAAQ;AAAA,IACnB;AAEA,UAAM,UAAU;AAChB,YAAQ,OAAO,cAAc;AAC7B,YAAQ,UACJ,QAAQ,WAAW,eAAe,aAAa,SAAS;AAC5D,YAAQ,iBAAgB,aAAQ,kBAAR,YAAyB;AACjD,YAAQ,iBAAiB,QAAQ,WAAW;AAC5C,YAAQ,OAAO,QAAQ,QAAQ;AAC/B,YAAQ,UAAS,aAAQ,WAAR,YAAkB;AACnC,YAAQ,YAAY,QAAQ;AAC5B,YAAQ,mBAAmB,CAAC,CAAC,QAAQ;AACrC,YAAQ,eAAe,KAAK,MAAM;AAE9B,cAAQ,OAAO;AAAA,IACnB,CAAC;AACD,WAAO;AAAA,EACX;AACJ;",
+  "names": ["options"]
+}

package/src/AbstractOverlay.js

@@ -0,0 +1,2 @@
+"use strict";import{SpectrumElement as E}from"@spectrum-web-components/base";import{reparentChildren as O}from"@spectrum-web-components/shared/src/reparent-children.js";import{Overlay as T}from"./Overlay.js";import{OverlayTimer as w}from"./overlay-timer.js";export const overlayTimer=new w,noop=()=>{};export class BeforetoggleClosedEvent extends Event{constructor(){super("beforetoggle",{bubbles:!1,composed:!1});this.currentState="open";this.newState="closed"}}export class BeforetoggleOpenEvent extends Event{constructor(){super("beforetoggle",{bubbles:!1,composed:!1});this.currentState="closed";this.newState="open"}}export const guaranteedAllTransitionend=(n,c,o)=>{const t=new Map,d=()=>{n.removeEventListener("transitionrun",m),n.removeEventListener("transitionend",e),o()};let p,u;const a=requestAnimationFrame(()=>{p=requestAnimationFrame(()=>{u=requestAnimationFrame(()=>{d()})})}),e=r=>{r.target===n&&(t.set(r.propertyName,t.get(r.propertyName)-1),t.get(r.propertyName)||t.delete(r.propertyName),t.size===0&&d())},m=r=>{r.target===n&&(t.has(r.propertyName)||t.set(r.propertyName,0),t.set(r.propertyName,t.get(r.propertyName)+1),cancelAnimationFrame(a),cancelAnimationFrame(p),cancelAnimationFrame(u))};n.addEventListener("transitionrun",m),n.addEventListener("transitionend",e),c()};export function nextFrame(){return new Promise(n=>requestAnimationFrame(()=>n()))}export class AbstractOverlay extends E{constructor(){super(...arguments);this.dispose=noop}async applyFocus(o,t){}async ensureOnDOM(o){}async makeTransition(o){return null}async manageDelay(o){}async manageDialogOpen(){}async managePopoverOpen(){}managePosition(){}get open(){return!1}set open(o){}get state(){return"closed"}set state(o){}static update(){const o=new CustomEvent("sp-update-overlays",{bubbles:!0,composed:!0,cancelable:!0});document.dispatchEvent(o)}static async open(o,t,d,p){var y,g,b,f;const u=arguments.length===2,a=d||o,e=new T;let m=!1;e.dispose=()=>{e.addEventListener("sp-closed",()=>{m||(r(),m=!0),requestAnimationFrame(()=>{e.remove()})}),e.open=!1,e.dispose=noop};const r=O([a],e,{position:"beforeend",prepareCallback:i=>{const v=i.slot;return i.removeAttribute("slot"),()=>{i.slot=v}}});if(!u&&a&&p){const i=o,v=t,l=p;return e.delayed=l.delayed||a.hasAttribute("delayed"),e.receivesFocus=(y=l.receivesFocus)!=null?y:"auto",e.triggerElement=l.virtualTrigger||i,e.type=v==="modal"?"modal":v==="hover"?"hint":"auto",e.offset=(g=l.offset)!=null?g:6,e.placement=l.placement,e.willPreventClose=!!l.notImmediatelyClosable,i.insertAdjacentElement("afterend",e),await e.updateComplete,e.open=!0,e.dispose}const s=t;return e.append(a),e.delayed=s.delayed||a.hasAttribute("delayed"),e.receivesFocus=(b=s.receivesFocus)!=null?b:"auto",e.triggerElement=s.trigger||null,e.type=s.type||"modal",e.offset=(f=s.offset)!=null?f:6,e.placement=s.placement,e.willPreventClose=!!s.notImmediatelyClosable,e.updateComplete.then(()=>{e.open=!0}),e}}
+//# sourceMappingURL=AbstractOverlay.js.map

package/src/AbstractOverlay.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["AbstractOverlay.ts"],
+  "sourcesContent": ["/*\nCopyright 2020 Adobe. All rights reserved.\nThis file is licensed to you under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License. You may obtain a copy\nof the License at http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software distributed under\nthe License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS\nOF ANY KIND, either express or implied. See the License for the specific language\ngoverning permissions and limitations under the License.\n*/\nimport { SpectrumElement } from '@spectrum-web-components/base';\nimport { reparentChildren } from '@spectrum-web-components/shared/src/reparent-children.js';\n\nimport type {\n    OpenableElement,\n    OverlayOptions,\n    OverlayOptionsV1,\n    OverlayState,\n    OverlayTypes,\n    TriggerInteractionsV1,\n} from './overlay-types.js';\nimport { Overlay } from './Overlay.js';\nimport type { VirtualTrigger } from './VirtualTrigger.js';\nimport { OverlayTimer } from './overlay-timer.js';\nimport { PlacementController } from './PlacementController.js';\n\nexport const overlayTimer = new OverlayTimer();\n\nexport const noop = (): void => {\n    return;\n};\n\nexport class BeforetoggleClosedEvent extends Event {\n    currentState = 'open';\n    newState = 'closed';\n    constructor() {\n        super('beforetoggle', {\n            bubbles: false,\n            composed: false,\n        });\n    }\n}\n\nexport class BeforetoggleOpenEvent extends Event {\n    currentState = 'closed';\n    newState = 'open';\n    constructor() {\n        super('beforetoggle', {\n            bubbles: false,\n            composed: false,\n        });\n    }\n}\n\n/**\n * Apply a \"transitionend\" listener to an element that may not transition but\n * guarantee the callback will be fired either way.\n *\n * @param el {HTMLElement} - Target of the \"transition\" listeners.\n * @param action {Function} - Method to trigger the \"transition\".\n * @param cb {Function} - Callback to trigger when the \"transition\" has ended.\n */\nexport const guaranteedAllTransitionend = (\n    el: HTMLElement,\n    action: () => void,\n    cb: () => void\n): void => {\n    const runningTransitions = new Map<string, number>();\n    const cleanup = (): void => {\n        el.removeEventListener('transitionrun', handleTransitionrun);\n        el.removeEventListener('transitionend', handleTransitionend);\n        cb();\n    };\n    let guarantee2: number;\n    let guarantee3: number;\n    // WebKit fires `transitionrun` a little earlier, the multiple guarantees here\n    // allow WebKit to be caught, but doesn't remove the animation listener until\n    // after it would have fired in Chromium.\n    const guarantee1 = requestAnimationFrame(() => {\n        guarantee2 = requestAnimationFrame(() => {\n            guarantee3 = requestAnimationFrame(() => {\n                cleanup();\n            });\n        });\n    });\n    const handleTransitionend = (event: TransitionEvent): void => {\n        if (event.target !== el) {\n            return;\n        }\n        runningTransitions.set(\n            event.propertyName,\n            (runningTransitions.get(event.propertyName) as number) - 1\n        );\n        if (!runningTransitions.get(event.propertyName)) {\n            runningTransitions.delete(event.propertyName);\n        }\n        if (runningTransitions.size === 0) {\n            cleanup();\n        }\n    };\n    const handleTransitionrun = (event: TransitionEvent): void => {\n        if (event.target !== el) {\n            return;\n        }\n        if (!runningTransitions.has(event.propertyName)) {\n            runningTransitions.set(event.propertyName, 0);\n        }\n        runningTransitions.set(\n            event.propertyName,\n            (runningTransitions.get(event.propertyName) as number) + 1\n        );\n        cancelAnimationFrame(guarantee1);\n        cancelAnimationFrame(guarantee2);\n        cancelAnimationFrame(guarantee3);\n    };\n    el.addEventListener('transitionrun', handleTransitionrun);\n    el.addEventListener('transitionend', handleTransitionend);\n    action();\n};\n\nexport function nextFrame(): Promise<void> {\n    return new Promise((res) => requestAnimationFrame(() => res()));\n}\n\nexport class AbstractOverlay extends SpectrumElement {\n    protected async applyFocus(\n        _targetOpenState: boolean,\n        _focusEl: HTMLElement | null\n    ): Promise<void> {\n        return;\n    }\n    delayed!: boolean;\n    dialogEl!: HTMLDialogElement & {\n        showPopover(): void;\n        hidePopover(): void;\n    };\n    dispose = noop;\n    protected async ensureOnDOM(_targetOpenState: boolean): Promise<void> {\n        return;\n    }\n    elements!: OpenableElement[];\n    protected async makeTransition(\n        _targetOpenState: boolean\n    ): Promise<HTMLElement | null> {\n        return null;\n    }\n    protected async manageDelay(_targetOpenState: boolean): Promise<void> {\n        return;\n    }\n    protected async manageDialogOpen(): Promise<void> {\n        return;\n    }\n    protected async managePopoverOpen(): Promise<void> {\n        return;\n    }\n    protected managePosition(): void {\n        return;\n    }\n    get open(): boolean {\n        return false;\n    }\n    set open(_open: boolean) {\n        return;\n    }\n    protected placementController!: PlacementController;\n    receivesFocus!: 'true' | 'false' | 'auto';\n    get state(): OverlayState {\n        return 'closed';\n    }\n    set state(_state: OverlayState) {\n        return;\n    }\n    protected _state!: OverlayState;\n    triggerElement!: HTMLElement | VirtualTrigger | null;\n    type!: OverlayTypes;\n\n    public static update(): void {\n        const overlayUpdateEvent = new CustomEvent('sp-update-overlays', {\n            bubbles: true,\n            composed: true,\n            cancelable: true,\n        });\n        document.dispatchEvent(overlayUpdateEvent);\n    }\n\n    public static async open(\n        trigger: HTMLElement,\n        interaction: TriggerInteractionsV1,\n        content: HTMLElement,\n        optionsV1: OverlayOptionsV1\n    ): Promise<() => void>;\n    public static async open(\n        content: HTMLElement,\n        options?: OverlayOptions\n    ): Promise<Overlay>;\n    public static async open(\n        triggerOrContent: HTMLElement,\n        interactionOrOptions:\n            | TriggerInteractionsV1\n            | OverlayOptions\n            | undefined,\n        content?: HTMLElement,\n        optionsV1?: OverlayOptionsV1\n    ): Promise<Overlay | (() => void)> {\n        const v2 = arguments.length === 2;\n        const overlayContent = content || triggerOrContent;\n        const overlay = new Overlay();\n        let restored = false;\n        overlay.dispose = () => {\n            overlay.addEventListener('sp-closed', () => {\n                if (!restored) {\n                    restoreContent();\n                    restored = true;\n                }\n                requestAnimationFrame(() => {\n                    overlay.remove();\n                });\n            });\n            overlay.open = false;\n            overlay.dispose = noop;\n        };\n        /**\n         * Since content must exist in an <sp-overlay>, we need a way to get it there.\n         * The best & most-direct way is to declaratively use an <sp-overlay> element,\n         * but for imperative users, we'll reparent content into an overlay that we've created for them.\n         **/\n        const restoreContent = reparentChildren([overlayContent], overlay, {\n            position: 'beforeend',\n            prepareCallback: (el) => {\n                // Ensure that content to be overlaid is no longer targetted to a specific `slot`.\n                // This allow for it to be visible in the overlaid context.\n                const slot = el.slot;\n                el.removeAttribute('slot');\n                return () => {\n                    el.slot = slot;\n                };\n            },\n        });\n\n        const v1 = !v2 && overlayContent && optionsV1;\n        if (v1) {\n            if (window.__swc.DEBUG) {\n                window.__swc.warn(\n                    overlay,\n                    `You are interacting with an ${overlay.localName} element via a deprecated imperative API. This API will be removed in a future version of the SWC library. Consider leveraging an ${overlay.localName} directly.`,\n                    'https://opensource.adobe.com/spectrum-web-components/components/overlay/',\n                    { level: 'deprecation' }\n                );\n            }\n            const trigger = triggerOrContent;\n            const interaction = interactionOrOptions;\n            const options = optionsV1;\n            overlay.delayed =\n                options.delayed || overlayContent.hasAttribute('delayed');\n            overlay.receivesFocus = options.receivesFocus ?? 'auto';\n            overlay.triggerElement = options.virtualTrigger || trigger;\n            overlay.type =\n                interaction === 'modal'\n                    ? 'modal'\n                    : interaction === 'hover'\n                    ? 'hint'\n                    : 'auto';\n            overlay.offset = options.offset ?? 6;\n            overlay.placement = options.placement;\n            overlay.willPreventClose = !!options.notImmediatelyClosable;\n            trigger.insertAdjacentElement('afterend', overlay);\n            await overlay.updateComplete;\n            overlay.open = true;\n            return overlay.dispose;\n        }\n\n        const options = interactionOrOptions as OverlayOptions;\n        overlay.append(overlayContent);\n        overlay.delayed =\n            options.delayed || overlayContent.hasAttribute('delayed');\n        overlay.receivesFocus = options.receivesFocus ?? 'auto';\n        overlay.triggerElement = options.trigger || null;\n        overlay.type = options.type || 'modal';\n        overlay.offset = options.offset ?? 6;\n        overlay.placement = options.placement;\n        overlay.willPreventClose = !!options.notImmediatelyClosable;\n        overlay.updateComplete.then(() => {\n            // Do we want to \"open\" this path, or leave that to the consumer?\n            overlay.open = true;\n        });\n        return overlay;\n    }\n}\n"],
+  "mappings": "aAWA,OAAS,mBAAAA,MAAuB,gCAChC,OAAS,oBAAAC,MAAwB,2DAUjC,OAAS,WAAAC,MAAe,eAExB,OAAS,gBAAAC,MAAoB,qBAGtB,aAAM,aAAe,IAAIA,EAEnB,KAAO,IAAY,CAEhC,EAEO,aAAM,gCAAgC,KAAM,CAG/C,aAAc,CACV,MAAM,eAAgB,CAClB,QAAS,GACT,SAAU,EACd,CAAC,EANL,kBAAe,OACf,cAAW,QAMX,CACJ,CAEO,aAAM,8BAA8B,KAAM,CAG7C,aAAc,CACV,MAAM,eAAgB,CAClB,QAAS,GACT,SAAU,EACd,CAAC,EANL,kBAAe,SACf,cAAW,MAMX,CACJ,CAUO,aAAM,2BAA6B,CACtCC,EACAC,EACAC,IACO,CACP,MAAMC,EAAqB,IAAI,IACzBC,EAAU,IAAY,CACxBJ,EAAG,oBAAoB,gBAAiBK,CAAmB,EAC3DL,EAAG,oBAAoB,gBAAiBM,CAAmB,EAC3DJ,EAAG,CACP,EACA,IAAIK,EACAC,EAIJ,MAAMC,EAAa,sBAAsB,IAAM,CAC3CF,EAAa,sBAAsB,IAAM,CACrCC,EAAa,sBAAsB,IAAM,CACrCJ,EAAQ,CACZ,CAAC,CACL,CAAC,CACL,CAAC,EACKE,EAAuBI,GAAiC,CACtDA,EAAM,SAAWV,IAGrBG,EAAmB,IACfO,EAAM,aACLP,EAAmB,IAAIO,EAAM,YAAY,EAAe,CAC7D,EACKP,EAAmB,IAAIO,EAAM,YAAY,GAC1CP,EAAmB,OAAOO,EAAM,YAAY,EAE5CP,EAAmB,OAAS,GAC5BC,EAAQ,EAEhB,EACMC,EAAuBK,GAAiC,CACtDA,EAAM,SAAWV,IAGhBG,EAAmB,IAAIO,EAAM,YAAY,GAC1CP,EAAmB,IAAIO,EAAM,aAAc,CAAC,EAEhDP,EAAmB,IACfO,EAAM,aACLP,EAAmB,IAAIO,EAAM,YAAY,EAAe,CAC7D,EACA,qBAAqBD,CAAU,EAC/B,qBAAqBF,CAAU,EAC/B,qBAAqBC,CAAU,EACnC,EACAR,EAAG,iBAAiB,gBAAiBK,CAAmB,EACxDL,EAAG,iBAAiB,gBAAiBM,CAAmB,EACxDL,EAAO,CACX,EAEO,gBAAS,WAA2B,CACvC,OAAO,IAAI,QAASU,GAAQ,sBAAsB,IAAMA,EAAI,CAAC,CAAC,CAClE,CAEO,aAAM,wBAAwBf,CAAgB,CAA9C,kCAYH,aAAU,KAXV,MAAgB,WACZgB,EACAC,EACa,CAEjB,CAOA,MAAgB,YAAYD,EAA0C,CAEtE,CAEA,MAAgB,eACZA,EAC2B,CAC3B,OAAO,IACX,CACA,MAAgB,YAAYA,EAA0C,CAEtE,CACA,MAAgB,kBAAkC,CAElD,CACA,MAAgB,mBAAmC,CAEnD,CACU,gBAAuB,CAEjC,CACA,IAAI,MAAgB,CAChB,MAAO,EACX,CACA,IAAI,KAAKE,EAAgB,CAEzB,CAGA,IAAI,OAAsB,CACtB,MAAO,QACX,CACA,IAAI,MAAMC,EAAsB,CAEhC,CAKA,OAAc,QAAe,CACzB,MAAMC,EAAqB,IAAI,YAAY,qBAAsB,CAC7D,QAAS,GACT,SAAU,GACV,WAAY,EAChB,CAAC,EACD,SAAS,cAAcA,CAAkB,CAC7C,CAYA,aAAoB,KAChBC,EACAC,EAIAC,EACAC,EAC+B,CA5MvC,IAAAC,EAAAC,EAAAC,EAAAC,EA6MQ,MAAMC,EAAK,UAAU,SAAW,EAC1BC,EAAiBP,GAAWF,EAC5BU,EAAU,IAAI7B,EACpB,IAAI8B,EAAW,GACfD,EAAQ,QAAU,IAAM,CACpBA,EAAQ,iBAAiB,YAAa,IAAM,CACnCC,IACDC,EAAe,EACfD,EAAW,IAEf,sBAAsB,IAAM,CACxBD,EAAQ,OAAO,CACnB,CAAC,CACL,CAAC,EACDA,EAAQ,KAAO,GACfA,EAAQ,QAAU,IACtB,EAMA,MAAME,EAAiBhC,EAAiB,CAAC6B,CAAc,EAAGC,EAAS,CAC/D,SAAU,YACV,gBAAkB3B,GAAO,CAGrB,MAAM8B,EAAO9B,EAAG,KAChB,OAAAA,EAAG,gBAAgB,MAAM,EAClB,IAAM,CACTA,EAAG,KAAO8B,CACd,CACJ,CACJ,CAAC,EAGD,GADW,CAACL,GAAMC,GAAkBN,EAC5B,CASJ,MAAMW,EAAUd,EACVe,EAAcd,EACde,EAAUb,EAChB,OAAAO,EAAQ,QACJM,EAAQ,SAAWP,EAAe,aAAa,SAAS,EAC5DC,EAAQ,eAAgBN,EAAAY,EAAQ,gBAAR,KAAAZ,EAAyB,OACjDM,EAAQ,eAAiBM,EAAQ,gBAAkBF,EACnDJ,EAAQ,KACJK,IAAgB,QACV,QACAA,IAAgB,QAChB,OACA,OACVL,EAAQ,QAASL,EAAAW,EAAQ,SAAR,KAAAX,EAAkB,EACnCK,EAAQ,UAAYM,EAAQ,UAC5BN,EAAQ,iBAAmB,CAAC,CAACM,EAAQ,uBACrCF,EAAQ,sBAAsB,WAAYJ,CAAO,EACjD,MAAMA,EAAQ,eACdA,EAAQ,KAAO,GACRA,EAAQ,QAGnB,MAAMM,EAAUf,EAChB,OAAAS,EAAQ,OAAOD,CAAc,EAC7BC,EAAQ,QACJM,EAAQ,SAAWP,EAAe,aAAa,SAAS,EAC5DC,EAAQ,eAAgBJ,EAAAU,EAAQ,gBAAR,KAAAV,EAAyB,OACjDI,EAAQ,eAAiBM,EAAQ,SAAW,KAC5CN,EAAQ,KAAOM,EAAQ,MAAQ,QAC/BN,EAAQ,QAASH,EAAAS,EAAQ,SAAR,KAAAT,EAAkB,EACnCG,EAAQ,UAAYM,EAAQ,UAC5BN,EAAQ,iBAAmB,CAAC,CAACM,EAAQ,uBACrCN,EAAQ,eAAe,KAAK,IAAM,CAE9BA,EAAQ,KAAO,EACnB,CAAC,EACMA,CACX,CACJ",
+  "names": ["SpectrumElement", "reparentChildren", "Overlay", "OverlayTimer", "el", "action", "cb", "runningTransitions", "cleanup", "handleTransitionrun", "handleTransitionend", "guarantee2", "guarantee3", "guarantee1", "event", "res", "_targetOpenState", "_focusEl", "_open", "_state", "overlayUpdateEvent", "triggerOrContent", "interactionOrOptions", "content", "optionsV1", "_a", "_b", "_c", "_d", "v2", "overlayContent", "overlay", "restored", "restoreContent", "slot", "trigger", "interaction", "options"]
+}

package/src/Overlay.d.ts

@@ -0,0 +1,147 @@
+import { PropertyValues, TemplateResult } from '@spectrum-web-components/base';
+import { AbstractOverlay } from './AbstractOverlay.js';
+import { OpenableElement, OverlayState, OverlayTypes, Placement } from './overlay-types.js';
+import { VirtualTrigger } from './VirtualTrigger.js';
+import { PlacementController } from './PlacementController.js';
+export declare const LONGPRESS_INSTRUCTIONS: {
+    touch: string;
+    keyboard: string;
+    mouse: string;
+};
+declare let OverlayFeatures: typeof AbstractOverlay & import("./overlay-types.js").Constructor<import("@lit/reactive-element").ReactiveElement>;
+/**
+ * @element sp-overlay
+ *
+ * @fires sp-opened - announces that an overlay has completed any entry animations
+ * @fires sp-closed - announce that an overlay has compelted any exit animations
+ */
+export declare class Overlay extends OverlayFeatures {
+    static styles: import("@spectrum-web-components/base").CSSResult[];
+    abortController: AbortController;
+    /**
+     * An Overlay that is `delayed` will wait until a warm-up period of 1000ms
+     * has completed before opening. Once the warmup period has completed, all
+     * subsequent Overlays will open immediately. When no Overlays are opened,
+     * a cooldown period of 1000ms will begin. Once the cooldown has completed,
+     * the next Overlay to be opened will be subject to the warm-up period if
+     * provided that option.
+     */
+    delayed: boolean;
+    dialogEl: HTMLDialogElement & {
+        showPopover(): void;
+        hidePopover(): void;
+    };
+    /**
+     * Whether the overlay is currently functional or not
+     */
+    get disabled(): boolean;
+    set disabled(disabled: boolean);
+    private _disabled;
+    elements: OpenableElement[];
+    parentOverlayToForceClose?: Overlay;
+    private get hasNonVirtualTrigger();
+    protected longpressState: 'null' | 'potential' | 'opening' | 'pressed';
+    private longressTimeout;
+    /**
+     * The `offset` property accepts either a single number, to
+     * define the offset of the Overlay along the main axis from
+     * the trigger, or 2-tuple, to define the offset along the
+     * main axis and the cross axis. This option has no effect
+     * when there is no trigger element.
+     */
+    offset: number | [number, number];
+    protected placementController: PlacementController;
+    get open(): boolean;
+    set open(open: boolean);
+    private _open;
+    static openCount: number;
+    /**
+     * Instruct the Overlay where to place itself in
+     * relationship to the trigger element.
+     */
+    placement?: Placement;
+    receivesFocus: 'true' | 'false' | 'auto';
+    private releaseAriaDescribedby;
+    private releaseLongpressDescribedby;
+    slotEl: HTMLSlotElement;
+    get state(): OverlayState;
+    set state(state: OverlayState);
+    _state: OverlayState;
+    tipPadding?: number;
+    /**
+     * An optional ID reference for the trigger element combined with the optional
+     * interaction (click | hover | longpress) by which the overlay shold open
+     * the overlay with an `@`: e.g. `trigger@click` opens the overlay when an
+     * element with the ID "trigger" is clicked.
+     */
+    trigger?: string;
+    /**
+     * An element reference for the trigger element that the overlay should relate to.
+     */
+    triggerElement: HTMLElement | VirtualTrigger | null;
+    /**
+     * The specific interaction to listen for on the `triggerElement` to open the overlay.
+     */
+    triggerInteraction?: 'click' | 'longpress' | 'hover';
+    type: OverlayTypes;
+    protected wasOpen: boolean;
+    private elementResolver;
+    private get usesDialog();
+    private get popoverValue();
+    protected get requiresPosition(): boolean;
+    protected managePosition(): void;
+    protected managePopoverOpen(): Promise<void>;
+    protected applyFocus(targetOpenState: boolean, focusEl: HTMLElement | null): Promise<void>;
+    protected manageOpen(oldOpen: boolean): Promise<void>;
+    protected unbindEvents(): void;
+    protected bindEvents(): void;
+    protected bindClickEvents(triggerElement: HTMLElement): void;
+    protected bindLongpressEvents(triggerElement: HTMLElement): void;
+    protected bindHoverEvents(triggerElement: HTMLElement): void;
+    protected manageTriggerElement(triggerElement: HTMLElement | null): void;
+    private elementIds;
+    private prepareLongpressDescription;
+    private prepareAriaDescribedby;
+    private handlePointerdown;
+    private handlePointerup;
+    /**
+     * @private
+     */
+    protected handleKeydown: (event: KeyboardEvent) => void;
+    protected handleKeyup: (event: KeyboardEvent) => void;
+    /**
+     * An overlay with a `click` interaction should not close on click `triggerElement`.
+     * When a click is initiated (`pointerdown`), apply `preventNextToggle` when the
+     * overlay is `open` to prevent from toggling the overlay when the click event
+     * propagates later in the interaction.
+     */
+    private preventNextToggle;
+    protected handlePointerdownForClick: () => void;
+    protected handleClick: () => void;
+    private focusedin;
+    protected handleFocusin: () => void;
+    protected handleFocusout: () => void;
+    private pointerentered;
+    protected handlePointerenter: () => void;
+    protected handlePointerleave: (event: PointerEvent) => void;
+    protected handleOverlayPointerleave: (event: PointerEvent) => void;
+    protected doPointerleave(): void;
+    protected handleLongpress: () => void;
+    protected handleBeforetoggle(event: Event & {
+        newState: string;
+    }): void;
+    protected handleBrowserClose(): void;
+    protected handleSlotchange(): void;
+    willPreventClose: boolean;
+    shouldPreventClose(): boolean;
+    willUpdate(changes: PropertyValues): void;
+    protected updated(changes: PropertyValues): void;
+    protected renderContent(): TemplateResult;
+    private get dialogStyleMap();
+    protected renderDialog(): TemplateResult;
+    protected renderPopover(): TemplateResult;
+    render(): TemplateResult;
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+}
+export {};