@spectrum-web-components/overlay 0.15.0 → 0.15.2

package/src/overlay-timer.js

@@ -0,0 +1,89 @@
+/*
+Copyright 2020 Adobe. All rights reserved.
+This file is licensed to you under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License. You may obtain a copy
+of the License at http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under
+the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+OF ANY KIND, either express or implied. See the License for the specific language
+governing permissions and limitations under the License.
+*/
+const DEFAULT_WARMUP = 1000;
+const DEFAULT_COOLDOWN = 1000;
+/**
+ * A timer to help with implementation of warnup/cooldown behavior as described here:
+ * https://spectrum.adobe.com/page/tooltip/#Immediate-or-delayed-appearance
+ */
+export class OverlayTimer {
+    constructor(options = {}) {
+        this.warmUpDelay = DEFAULT_WARMUP;
+        this.coolDownDelay = DEFAULT_COOLDOWN;
+        this.isWarm = false;
+        this.timeout = 0;
+        Object.assign(this, options);
+    }
+    async openTimer(component) {
+        this.cancelCooldownTimer();
+        if (!this.component || component !== this.component) {
+            if (this.component) {
+                this.close(this.component);
+                this.cancelCooldownTimer();
+            }
+            this.component = component;
+            if (this.isWarm) {
+                return false;
+            }
+            this.promise = new Promise((resolve) => {
+                this.resolve = resolve;
+                this.timeout = window.setTimeout(() => {
+                    if (this.resolve) {
+                        this.resolve(false);
+                        this.isWarm = true;
+                    }
+                }, this.warmUpDelay);
+            });
+            return this.promise;
+        }
+        else if (this.promise) {
+            return this.promise;
+        }
+        else {
+            // This should never happen
+            throw new Error('Inconsistent state');
+        }
+    }
+    close(component) {
+        if (this.component && this.component === component) {
+            this.resetCooldownTimer();
+            if (this.timeout > 0) {
+                clearTimeout(this.timeout);
+                this.timeout = 0;
+            }
+            if (this.resolve) {
+                this.resolve(true);
+                delete this.resolve;
+            }
+            delete this.promise;
+            delete this.component;
+        }
+    }
+    resetCooldownTimer() {
+        if (this.isWarm) {
+            if (this.cooldownTimeout) {
+                window.clearTimeout(this.cooldownTimeout);
+            }
+            this.cooldownTimeout = window.setTimeout(() => {
+                this.isWarm = false;
+                delete this.cooldownTimeout;
+            }, this.coolDownDelay);
+        }
+    }
+    cancelCooldownTimer() {
+        if (this.cooldownTimeout) {
+            window.clearTimeout(this.cooldownTimeout);
+        }
+        delete this.cooldownTimeout;
+    }
+}
+//# sourceMappingURL=overlay-timer.js.map

package/src/overlay-timer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"overlay-timer.js","sourceRoot":"","sources":["overlay-timer.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;EAUE;AAEF,MAAM,cAAc,GAAG,IAAI,CAAC;AAC5B,MAAM,gBAAgB,GAAG,IAAI,CAAC;AAE9B;;;GAGG;AACH,MAAM,OAAO,YAAY;IAYrB,YACI,UAA4D,EAAE;QAZ1D,gBAAW,GAAG,cAAc,CAAC;QAC7B,kBAAa,GAAG,gBAAgB,CAAC;QAEjC,WAAM,GAAG,KAAK,CAAC;QAIf,YAAO,GAAG,CAAC,CAAC;QAOhB,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IACjC,CAAC;IAEM,KAAK,CAAC,SAAS,CAAC,SAAsB;QACzC,IAAI,CAAC,mBAAmB,EAAE,CAAC;QAE3B,IAAI,CAAC,IAAI,CAAC,SAAS,IAAI,SAAS,KAAK,IAAI,CAAC,SAAS,EAAE;YACjD,IAAI,IAAI,CAAC,SAAS,EAAE;gBAChB,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;gBAC3B,IAAI,CAAC,mBAAmB,EAAE,CAAC;aAC9B;YACD,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;YAE3B,IAAI,IAAI,CAAC,MAAM,EAAE;gBACb,OAAO,KAAK,CAAC;aAChB;YAED,IAAI,CAAC,OAAO,GAAG,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;gBACnC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;gBACvB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,UAAU,CAAC,GAAG,EAAE;oBAClC,IAAI,IAAI,CAAC,OAAO,EAAE;wBACd,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;wBACpB,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;qBACtB;gBACL,CAAC,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;YACzB,CAAC,CAAC,CAAC;YACH,OAAO,IAAI,CAAC,OAAO,CAAC;SACvB;aAAM,IAAI,IAAI,CAAC,OAAO,EAAE;YACrB,OAAO,IAAI,CAAC,OAAO,CAAC;SACvB;aAAM;YACH,2BAA2B;YAC3B,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAC;SACzC;IACL,CAAC;IAEM,KAAK,CAAC,SAAsB;QAC/B,IAAI,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,SAAS,KAAK,SAAS,EAAE;YAChD,IAAI,CAAC,kBAAkB,EAAE,CAAC;YAC1B,IAAI,IAAI,CAAC,OAAO,GAAG,CAAC,EAAE;gBAClB,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;gBAC3B,IAAI,CAAC,OAAO,GAAG,CAAC,CAAC;aACpB;YACD,IAAI,IAAI,CAAC,OAAO,EAAE;gBACd,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;gBACnB,OAAO,IAAI,CAAC,OAAO,CAAC;aACvB;YACD,OAAO,IAAI,CAAC,OAAO,CAAC;YACpB,OAAO,IAAI,CAAC,SAAS,CAAC;SACzB;IACL,CAAC;IAEO,kBAAkB;QACtB,IAAI,IAAI,CAAC,MAAM,EAAE;YACb,IAAI,IAAI,CAAC,eAAe,EAAE;gBACtB,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;aAC7C;YACD,IAAI,CAAC,eAAe,GAAG,MAAM,CAAC,UAAU,CAAC,GAAG,EAAE;gBAC1C,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;gBACpB,OAAO,IAAI,CAAC,eAAe,CAAC;YAChC,CAAC,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;SAC1B;IACL,CAAC;IAEO,mBAAmB;QACvB,IAAI,IAAI,CAAC,eAAe,EAAE;YACtB,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;SAC7C;QACD,OAAO,IAAI,CAAC,eAAe,CAAC;IAChC,CAAC;CACJ","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*/\n\nconst DEFAULT_WARMUP = 1000;\nconst DEFAULT_COOLDOWN = 1000;\n\n/**\n * A timer to help with implementation of warnup/cooldown behavior as described here:\n * https://spectrum.adobe.com/page/tooltip/#Immediate-or-delayed-appearance\n */\nexport class OverlayTimer {\n    private warmUpDelay = DEFAULT_WARMUP;\n    private coolDownDelay = DEFAULT_COOLDOWN;\n\n    private isWarm = false;\n    private cooldownTimeout?: number;\n\n    private component?: HTMLElement;\n    private timeout = 0;\n    private promise?: Promise<boolean>;\n    private resolve?: (cancelled: boolean) => void;\n\n    constructor(\n        options: { warmUpDelay?: number; coolDownDelay?: number } = {}\n    ) {\n        Object.assign(this, options);\n    }\n\n    public async openTimer(component: HTMLElement): Promise<boolean> {\n        this.cancelCooldownTimer();\n\n        if (!this.component || component !== this.component) {\n            if (this.component) {\n                this.close(this.component);\n                this.cancelCooldownTimer();\n            }\n            this.component = component;\n\n            if (this.isWarm) {\n                return false;\n            }\n\n            this.promise = new Promise((resolve) => {\n                this.resolve = resolve;\n                this.timeout = window.setTimeout(() => {\n                    if (this.resolve) {\n                        this.resolve(false);\n                        this.isWarm = true;\n                    }\n                }, this.warmUpDelay);\n            });\n            return this.promise;\n        } else if (this.promise) {\n            return this.promise;\n        } else {\n            // This should never happen\n            throw new Error('Inconsistent state');\n        }\n    }\n\n    public close(component: HTMLElement): void {\n        if (this.component && this.component === component) {\n            this.resetCooldownTimer();\n            if (this.timeout > 0) {\n                clearTimeout(this.timeout);\n                this.timeout = 0;\n            }\n            if (this.resolve) {\n                this.resolve(true);\n                delete this.resolve;\n            }\n            delete this.promise;\n            delete this.component;\n        }\n    }\n\n    private resetCooldownTimer(): void {\n        if (this.isWarm) {\n            if (this.cooldownTimeout) {\n                window.clearTimeout(this.cooldownTimeout);\n            }\n            this.cooldownTimeout = window.setTimeout(() => {\n                this.isWarm = false;\n                delete this.cooldownTimeout;\n            }, this.coolDownDelay);\n        }\n    }\n\n    private cancelCooldownTimer(): void {\n        if (this.cooldownTimeout) {\n            window.clearTimeout(this.cooldownTimeout);\n        }\n        delete this.cooldownTimeout;\n    }\n}\n"]}

package/src/overlay-trigger.css.d.ts

@@ -0,0 +1,2 @@
+declare const styles: import("@spectrum-web-components/base").CSSResult;
+export default styles;

package/src/overlay-trigger.css.js

@@ -0,0 +1,17 @@
+/*
+Copyright 2020 Adobe. All rights reserved.
+This file is licensed to you under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License. You may obtain a copy
+of the License at http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under
+the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+OF ANY KIND, either express or implied. See the License for the specific language
+governing permissions and limitations under the License.
+*/
+import { css } from '@spectrum-web-components/base';
+const styles = css `
+:host([disabled]) ::slotted([slot=trigger]){pointer-events:none}#overlay-content{display:none}
+`;
+export default styles;
+//# sourceMappingURL=overlay-trigger.css.js.map

package/src/overlay-trigger.css.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"overlay-trigger.css.js","sourceRoot":"","sources":["overlay-trigger.css.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;EAUE;AACF,OAAO,EAAE,GAAG,EAAE,MAAM,+BAA+B,CAAC;AACpD,MAAM,MAAM,GAAG,GAAG,CAAA;;CAEjB,CAAC;AACF,eAAe,MAAM,CAAC","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 { css } from '@spectrum-web-components/base';\nconst styles = css`\n:host([disabled]) ::slotted([slot=trigger]){pointer-events:none}#overlay-content{display:none}\n`;\nexport default styles;"]}

package/src/overlay-types.d.ts

@@ -0,0 +1,52 @@
+import type { ThemeData } from '@spectrum-web-components/theme/src/Theme.js';
+import type { Placement as FloatingUIPlacement } from '@floating-ui/dom';
+import type { VirtualTrigger } from './VirtualTrigger.js';
+export declare type TriggerInteractions = 'click' | 'longpress' | 'hover' | 'custom' | 'replace' | 'inline' | 'modal';
+export interface OverlayOpenDetail {
+    content: HTMLElement;
+    contentTip?: HTMLElement;
+    delayed: boolean;
+    offset: number;
+    skidding?: number;
+    placement?: Placement;
+    receivesFocus?: 'auto';
+    virtualTrigger?: VirtualTrigger;
+    trigger: HTMLElement;
+    interaction: TriggerInteractions;
+    theme: ThemeData;
+    notImmediatelyClosable?: boolean;
+    abortPromise?: Promise<boolean>;
+}
+export interface OverlayOpenCloseDetail {
+    interaction: TriggerInteractions;
+    reason?: 'external-click';
+}
+export interface OverlayCloseReasonDetail {
+    reason?: 'external-click';
+}
+/**
+ * Used, via an event, to query details about how an element should be shown in
+ * an overlay
+ */
+export interface OverlayDisplayQueryDetail {
+    overlayRootName?: string;
+    overlayRootElement?: HTMLElement;
+    overlayContentTipElement?: HTMLElement;
+}
+export declare type Placement = FloatingUIPlacement | 'none';
+export declare type OverlayOptions = {
+    delayed?: boolean;
+    placement?: Placement;
+    offset?: number;
+    receivesFocus?: 'auto';
+    notImmediatelyClosable?: boolean;
+    abortPromise?: Promise<boolean>;
+    virtualTrigger?: VirtualTrigger;
+};
+declare global {
+    interface GlobalEventHandlersEventMap {
+        'sp-overlay-query': CustomEvent<OverlayDisplayQueryDetail>;
+        'sp-open': CustomEvent<OverlayOpenCloseDetail>;
+        'sp-close': CustomEvent<OverlayOpenCloseDetail>;
+    }
+}

package/src/overlay-types.js

@@ -0,0 +1,13 @@
+/*
+Copyright 2020 Adobe. All rights reserved.
+This file is licensed to you under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License. You may obtain a copy
+of the License at http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under
+the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+OF ANY KIND, either express or implied. See the License for the specific language
+governing permissions and limitations under the License.
+*/
+export {};
+//# sourceMappingURL=overlay-types.js.map

package/src/overlay-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"overlay-types.js","sourceRoot":"","sources":["overlay-types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;EAUE","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*/\n\nimport type { ThemeData } from '@spectrum-web-components/theme/src/Theme.js';\nimport type { Placement as FloatingUIPlacement } from '@floating-ui/dom';\nimport type { VirtualTrigger } from './VirtualTrigger.js';\n\nexport type TriggerInteractions =\n    | 'click'\n    | 'longpress'\n    | 'hover'\n    | 'custom'\n    | 'replace'\n    | 'inline'\n    | 'modal';\n\nexport interface OverlayOpenDetail {\n    content: HTMLElement;\n    contentTip?: HTMLElement;\n    delayed: boolean;\n    offset: number;\n    skidding?: number;\n    placement?: Placement;\n    receivesFocus?: 'auto';\n    virtualTrigger?: VirtualTrigger;\n    trigger: HTMLElement;\n    interaction: TriggerInteractions;\n    theme: ThemeData;\n    notImmediatelyClosable?: boolean;\n    abortPromise?: Promise<boolean>;\n}\n\nexport interface OverlayOpenCloseDetail {\n    interaction: TriggerInteractions;\n    reason?: 'external-click';\n}\n\nexport interface OverlayCloseReasonDetail {\n    reason?: 'external-click';\n}\n\n/**\n * Used, via an event, to query details about how an element should be shown in\n * an overlay\n */\nexport interface OverlayDisplayQueryDetail {\n    overlayRootName?: string;\n    overlayRootElement?: HTMLElement;\n    overlayContentTipElement?: HTMLElement;\n}\n\nexport type Placement = FloatingUIPlacement | 'none';\n\nexport type OverlayOptions = {\n    delayed?: boolean;\n    placement?: Placement;\n    offset?: number;\n    receivesFocus?: 'auto';\n    notImmediatelyClosable?: boolean;\n    abortPromise?: Promise<boolean>;\n    virtualTrigger?: VirtualTrigger;\n};\n\ndeclare global {\n    interface GlobalEventHandlersEventMap {\n        'sp-overlay-query': CustomEvent<OverlayDisplayQueryDetail>;\n        'sp-open': CustomEvent<OverlayOpenCloseDetail>;\n        'sp-close': CustomEvent<OverlayOpenCloseDetail>;\n    }\n}\n"]}

package/src/overlay.d.ts

@@ -0,0 +1,59 @@
+import type { OverlayOptions, TriggerInteractions } from './overlay-types';
+/**
+ * This class allows access to the overlay system which allows a client to
+ * position an element in the overlay positioned relative to another node.
+ */
+export declare class Overlay {
+    private static overlayStack;
+    private isOpen;
+    private overlayElement;
+    private owner;
+    private interaction;
+    /**
+     *
+     * @param owner the parent element we will use to position the overlay element
+     * @param interaction the type of interaction that caused this overlay to be shown
+     * @param overlayElement the item to display as an overlay
+     */
+    constructor(owner: HTMLElement, interaction: TriggerInteractions, overlayElement: HTMLElement);
+    /**
+     * Open an overlay
+     *
+     * @param owner the parent element we will use to position the overlay element
+     * @param interaction the type of interaction that caused this overlay to be shown
+     * @param overlayElement the item to display as an overlay
+     * @param options display parameters
+     * @param options.delayed if true delay opening of the overlay based on the global warmup/cooldown timer
+     * @param options.offset distance to offset the overlay
+     * @param options.placement side on which to position the overlay
+     * @returns an Overlay object which can be used to close the overlay
+     */
+    static open(owner: HTMLElement, interaction: TriggerInteractions, overlayElement: HTMLElement, options: OverlayOptions): Promise<() => void>;
+    static update(): void;
+    /**
+     * Open an overlay
+     *
+     * @param options display parameters
+     * @param options.delayed delay before opening the overlay
+     * @param options.offset distance to offset the overlay
+     * @param options.placement side on which to position the overlay
+     * @returns a Promise that resolves to true if this operation was cancelled
+     */
+    open({ abortPromise, delayed, offset, placement, receivesFocus, notImmediatelyClosable, virtualTrigger, }: OverlayOptions): Promise<boolean>;
+    /**
+     * Close the overlay if it is open
+     */
+    close(): void;
+}
+/**
+ * Announces that an overlay-based UI element has opened
+ * @event sp-open
+ * @type {object}
+ * @property {TriggerInteractions} interaction type of interaction that triggered the opening
+ */
+/**
+ * Announces that an overlay-based UI element has opened
+ * @event sp-close
+ * @type {object}
+ * @property {TriggerInteractions} interaction type of interaction that triggered the closing
+ */

package/src/overlay.js

@@ -0,0 +1,119 @@
+/*
+Copyright 2020 Adobe. All rights reserved.
+This file is licensed to you under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License. You may obtain a copy
+of the License at http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under
+the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+OF ANY KIND, either express or implied. See the License for the specific language
+governing permissions and limitations under the License.
+*/
+import { OverlayStack } from './overlay-stack.js';
+/**
+ * This class allows access to the overlay system which allows a client to
+ * position an element in the overlay positioned relative to another node.
+ */
+export class Overlay {
+    /**
+     *
+     * @param owner the parent element we will use to position the overlay element
+     * @param interaction the type of interaction that caused this overlay to be shown
+     * @param overlayElement the item to display as an overlay
+     */
+    constructor(owner, interaction, overlayElement) {
+        this.isOpen = false;
+        this.owner = owner;
+        this.overlayElement = overlayElement;
+        this.interaction = interaction;
+    }
+    /**
+     * Open an overlay
+     *
+     * @param owner the parent element we will use to position the overlay element
+     * @param interaction the type of interaction that caused this overlay to be shown
+     * @param overlayElement the item to display as an overlay
+     * @param options display parameters
+     * @param options.delayed if true delay opening of the overlay based on the global warmup/cooldown timer
+     * @param options.offset distance to offset the overlay
+     * @param options.placement side on which to position the overlay
+     * @returns an Overlay object which can be used to close the overlay
+     */
+    static async open(owner, interaction, overlayElement, options) {
+        const overlay = new Overlay(owner, interaction, overlayElement);
+        await overlay.open(options);
+        return () => {
+            overlay.close();
+        };
+    }
+    static update() {
+        const overlayUpdateEvent = new CustomEvent('sp-update-overlays', {
+            bubbles: true,
+            composed: true,
+            cancelable: true,
+        });
+        document.dispatchEvent(overlayUpdateEvent);
+    }
+    /**
+     * Open an overlay
+     *
+     * @param options display parameters
+     * @param options.delayed delay before opening the overlay
+     * @param options.offset distance to offset the overlay
+     * @param options.placement side on which to position the overlay
+     * @returns a Promise that resolves to true if this operation was cancelled
+     */
+    async open({ abortPromise, delayed, offset = 0, placement = 'top', receivesFocus, notImmediatelyClosable, virtualTrigger, }) {
+        /* c8 ignore next */
+        if (this.isOpen)
+            return true;
+        if (delayed === undefined) {
+            delayed = this.overlayElement.hasAttribute('delayed');
+        }
+        const queryThemeDetail = {
+            color: undefined,
+            scale: undefined,
+            lang: undefined,
+        };
+        const queryThemeEvent = new CustomEvent('sp-query-theme', {
+            bubbles: true,
+            composed: true,
+            detail: queryThemeDetail,
+            cancelable: true,
+        });
+        this.owner.dispatchEvent(queryThemeEvent);
+        const overlayDetailQuery = {};
+        const queryOverlayDetailEvent = new CustomEvent('sp-overlay-query', {
+            bubbles: true,
+            composed: true,
+            detail: overlayDetailQuery,
+            cancelable: true,
+        });
+        this.overlayElement.dispatchEvent(queryOverlayDetailEvent);
+        await Overlay.overlayStack.openOverlay(Object.assign({ abortPromise, content: this.overlayElement, contentTip: overlayDetailQuery.overlayContentTipElement, delayed, offset: offset, placement: placement, trigger: this.owner, interaction: this.interaction, theme: queryThemeDetail, receivesFocus,
+            notImmediatelyClosable,
+            virtualTrigger }, overlayDetailQuery));
+        this.isOpen = true;
+        return true;
+    }
+    /**
+     * Close the overlay if it is open
+     */
+    close() {
+        Overlay.overlayStack.closeOverlay(this.overlayElement);
+    }
+}
+Overlay.overlayStack = new OverlayStack();
+/**
+ * Announces that an overlay-based UI element has opened
+ * @event sp-open
+ * @type {object}
+ * @property {TriggerInteractions} interaction type of interaction that triggered the opening
+ */
+/**
+ * Announces that an overlay-based UI element has opened
+ * @event sp-close
+ * @type {object}
+ * @property {TriggerInteractions} interaction type of interaction that triggered the closing
+ */
+//# sourceMappingURL=overlay.js.map

package/src/overlay.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"overlay.js","sourceRoot":"","sources":["overlay.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;EAUE;AAQF,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAElD;;;GAGG;AACH,MAAM,OAAO,OAAO;IAQhB;;;;;OAKG;IACH,YACI,KAAkB,EAClB,WAAgC,EAChC,cAA2B;QAdvB,WAAM,GAAG,KAAK,CAAC;QAgBnB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;QACrC,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;IACnC,CAAC;IAED;;;;;;;;;;;OAWG;IACI,MAAM,CAAC,KAAK,CAAC,IAAI,CACpB,KAAkB,EAClB,WAAgC,EAChC,cAA2B,EAC3B,OAAuB;QAEvB,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,KAAK,EAAE,WAAW,EAAE,cAAc,CAAC,CAAC;QAChE,MAAM,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC5B,OAAO,GAAS,EAAE;YACd,OAAO,CAAC,KAAK,EAAE,CAAC;QACpB,CAAC,CAAC;IACN,CAAC;IAEM,MAAM,CAAC,MAAM;QAChB,MAAM,kBAAkB,GAAG,IAAI,WAAW,CAAC,oBAAoB,EAAE;YAC7D,OAAO,EAAE,IAAI;YACb,QAAQ,EAAE,IAAI;YACd,UAAU,EAAE,IAAI;SACnB,CAAC,CAAC;QACH,QAAQ,CAAC,aAAa,CAAC,kBAAkB,CAAC,CAAC;IAC/C,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAAC,IAAI,CAAC,EACd,YAAY,EACZ,OAAO,EACP,MAAM,GAAG,CAAC,EACV,SAAS,GAAG,KAAK,EACjB,aAAa,EACb,sBAAsB,EACtB,cAAc,GACD;QACb,oBAAoB;QACpB,IAAI,IAAI,CAAC,MAAM;YAAE,OAAO,IAAI,CAAC;QAE7B,IAAI,OAAO,KAAK,SAAS,EAAE;YACvB,OAAO,GAAG,IAAI,CAAC,cAAc,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;SACzD;QAED,MAAM,gBAAgB,GAAc;YAChC,KAAK,EAAE,SAAS;YAChB,KAAK,EAAE,SAAS;YAChB,IAAI,EAAE,SAAS;SAClB,CAAC;QACF,MAAM,eAAe,GAAG,IAAI,WAAW,CAAY,gBAAgB,EAAE;YACjE,OAAO,EAAE,IAAI;YACb,QAAQ,EAAE,IAAI;YACd,MAAM,EAAE,gBAAgB;YACxB,UAAU,EAAE,IAAI;SACnB,CAAC,CAAC;QACH,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,eAAe,CAAC,CAAC;QAE1C,MAAM,kBAAkB,GAA8B,EAAE,CAAC;QACzD,MAAM,uBAAuB,GACzB,IAAI,WAAW,CAA4B,kBAAkB,EAAE;YAC3D,OAAO,EAAE,IAAI;YACb,QAAQ,EAAE,IAAI;YACd,MAAM,EAAE,kBAAkB;YAC1B,UAAU,EAAE,IAAI;SACnB,CAAC,CAAC;QACP,IAAI,CAAC,cAAc,CAAC,aAAa,CAAC,uBAAuB,CAAC,CAAC;QAE3D,MAAM,OAAO,CAAC,YAAY,CAAC,WAAW,iBAClC,YAAY,EACZ,OAAO,EAAE,IAAI,CAAC,cAAc,EAC5B,UAAU,EAAE,kBAAkB,CAAC,wBAAwB,EACvD,OAAO,EACP,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,SAAS,EACpB,OAAO,EAAE,IAAI,CAAC,KAAK,EACnB,WAAW,EAAE,IAAI,CAAC,WAAW,EAC7B,KAAK,EAAE,gBAAgB,EACvB,aAAa;YACb,sBAAsB;YACtB,cAAc,IACX,kBAAkB,EACvB,CAAC;QACH,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;QACnB,OAAO,IAAI,CAAC;IAChB,CAAC;IAED;;OAEG;IACI,KAAK;QACR,OAAO,CAAC,YAAY,CAAC,YAAY,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IAC3D,CAAC;;AAjIc,oBAAY,GAAG,IAAI,YAAY,EAAE,CAAC;AAoIrD;;;;;GAKG;AAEH;;;;;GAKG","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*/\n\nimport type { ThemeData } from '@spectrum-web-components/theme/src/Theme.js';\nimport type {\n    OverlayDisplayQueryDetail,\n    OverlayOptions,\n    TriggerInteractions,\n} from './overlay-types';\nimport { OverlayStack } from './overlay-stack.js';\n\n/**\n * This class allows access to the overlay system which allows a client to\n * position an element in the overlay positioned relative to another node.\n */\nexport class Overlay {\n    private static overlayStack = new OverlayStack();\n\n    private isOpen = false;\n    private overlayElement: HTMLElement;\n    private owner: HTMLElement;\n    private interaction: TriggerInteractions;\n\n    /**\n     *\n     * @param owner the parent element we will use to position the overlay element\n     * @param interaction the type of interaction that caused this overlay to be shown\n     * @param overlayElement the item to display as an overlay\n     */\n    constructor(\n        owner: HTMLElement,\n        interaction: TriggerInteractions,\n        overlayElement: HTMLElement\n    ) {\n        this.owner = owner;\n        this.overlayElement = overlayElement;\n        this.interaction = interaction;\n    }\n\n    /**\n     * Open an overlay\n     *\n     * @param owner the parent element we will use to position the overlay element\n     * @param interaction the type of interaction that caused this overlay to be shown\n     * @param overlayElement the item to display as an overlay\n     * @param options display parameters\n     * @param options.delayed if true delay opening of the overlay based on the global warmup/cooldown timer\n     * @param options.offset distance to offset the overlay\n     * @param options.placement side on which to position the overlay\n     * @returns an Overlay object which can be used to close the overlay\n     */\n    public static async open(\n        owner: HTMLElement,\n        interaction: TriggerInteractions,\n        overlayElement: HTMLElement,\n        options: OverlayOptions\n    ): Promise<() => void> {\n        const overlay = new Overlay(owner, interaction, overlayElement);\n        await overlay.open(options);\n        return (): void => {\n            overlay.close();\n        };\n    }\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    /**\n     * Open an overlay\n     *\n     * @param options display parameters\n     * @param options.delayed delay before opening the overlay\n     * @param options.offset distance to offset the overlay\n     * @param options.placement side on which to position the overlay\n     * @returns a Promise that resolves to true if this operation was cancelled\n     */\n    public async open({\n        abortPromise,\n        delayed,\n        offset = 0,\n        placement = 'top',\n        receivesFocus,\n        notImmediatelyClosable,\n        virtualTrigger,\n    }: OverlayOptions): Promise<boolean> {\n        /* c8 ignore next */\n        if (this.isOpen) return true;\n\n        if (delayed === undefined) {\n            delayed = this.overlayElement.hasAttribute('delayed');\n        }\n\n        const queryThemeDetail: ThemeData = {\n            color: undefined,\n            scale: undefined,\n            lang: undefined,\n        };\n        const queryThemeEvent = new CustomEvent<ThemeData>('sp-query-theme', {\n            bubbles: true,\n            composed: true,\n            detail: queryThemeDetail,\n            cancelable: true,\n        });\n        this.owner.dispatchEvent(queryThemeEvent);\n\n        const overlayDetailQuery: OverlayDisplayQueryDetail = {};\n        const queryOverlayDetailEvent =\n            new CustomEvent<OverlayDisplayQueryDetail>('sp-overlay-query', {\n                bubbles: true,\n                composed: true,\n                detail: overlayDetailQuery,\n                cancelable: true,\n            });\n        this.overlayElement.dispatchEvent(queryOverlayDetailEvent);\n\n        await Overlay.overlayStack.openOverlay({\n            abortPromise,\n            content: this.overlayElement,\n            contentTip: overlayDetailQuery.overlayContentTipElement,\n            delayed,\n            offset: offset,\n            placement: placement,\n            trigger: this.owner,\n            interaction: this.interaction,\n            theme: queryThemeDetail,\n            receivesFocus,\n            notImmediatelyClosable,\n            virtualTrigger,\n            ...overlayDetailQuery,\n        });\n        this.isOpen = true;\n        return true;\n    }\n\n    /**\n     * Close the overlay if it is open\n     */\n    public close(): void {\n        Overlay.overlayStack.closeOverlay(this.overlayElement);\n    }\n}\n\n/**\n * Announces that an overlay-based UI element has opened\n * @event sp-open\n * @type {object}\n * @property {TriggerInteractions} interaction type of interaction that triggered the opening\n */\n\n/**\n * Announces that an overlay-based UI element has opened\n * @event sp-close\n * @type {object}\n * @property {TriggerInteractions} interaction type of interaction that triggered the closing\n */\n"]}