@spectrum-web-components/overlay 0.16.4 → 0.16.6-devmode.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/active-overlay.dev.js +3 -0
- package/active-overlay.dev.js.map +7 -0
- package/active-overlay.js +3 -14
- package/active-overlay.js.map +7 -1
- package/overlay-trigger.dev.js +3 -0
- package/overlay-trigger.dev.js.map +7 -0
- package/overlay-trigger.js +3 -14
- package/overlay-trigger.js.map +7 -1
- package/package.json +68 -14
- package/src/ActiveOverlay.dev.js +445 -0
- package/src/ActiveOverlay.dev.js.map +7 -0
- package/src/ActiveOverlay.js +404 -424
- package/src/ActiveOverlay.js.map +7 -1
- package/src/OverlayTrigger.dev.js +293 -0
- package/src/OverlayTrigger.dev.js.map +7 -0
- package/src/OverlayTrigger.js +245 -264
- package/src/OverlayTrigger.js.map +7 -1
- package/src/VirtualTrigger.dev.js +30 -0
- package/src/VirtualTrigger.dev.js.map +7 -0
- package/src/VirtualTrigger.js +28 -38
- package/src/VirtualTrigger.js.map +7 -1
- package/src/active-overlay.css.dev.js +12 -0
- package/src/active-overlay.css.dev.js.map +7 -0
- package/src/active-overlay.css.js +3 -14
- package/src/active-overlay.css.js.map +7 -1
- package/src/index.dev.js +7 -0
- package/src/index.dev.js.map +7 -0
- package/src/index.js +7 -18
- package/src/index.js.map +7 -1
- package/src/loader.dev.js +5 -0
- package/src/loader.dev.js.map +7 -0
- package/src/loader.js +3 -14
- package/src/loader.js.map +7 -1
- package/src/overlay-events.dev.js +7 -0
- package/src/overlay-events.dev.js.map +7 -0
- package/src/overlay-events.js +5 -16
- package/src/overlay-events.js.map +7 -1
- package/src/overlay-stack.dev.js +436 -0
- package/src/overlay-stack.dev.js.map +7 -0
- package/src/overlay-stack.js +374 -420
- package/src/overlay-stack.js.map +7 -1
- package/src/overlay-timer.dev.js +71 -0
- package/src/overlay-timer.dev.js.map +7 -0
- package/src/overlay-timer.js +64 -82
- package/src/overlay-timer.js.map +7 -1
- package/src/overlay-trigger.css.dev.js +6 -0
- package/src/overlay-trigger.css.dev.js.map +7 -0
- package/src/overlay-trigger.css.js +3 -14
- package/src/overlay-trigger.css.js.map +7 -1
- package/src/overlay-types.dev.js +1 -0
- package/src/overlay-types.dev.js.map +7 -0
- package/src/overlay-types.js +1 -13
- package/src/overlay-types.js.map +7 -1
- package/src/overlay-utils.dev.js +28 -0
- package/src/overlay-utils.dev.js.map +7 -0
- package/src/overlay-utils.js +22 -33
- package/src/overlay-utils.js.map +7 -1
- package/src/overlay.dev.js +85 -0
- package/src/overlay.dev.js.map +7 -0
- package/src/overlay.js +83 -119
- package/src/overlay.js.map +7 -1
- package/stories/overlay-story-components.js +188 -184
- package/stories/overlay-story-components.js.map +7 -1
- package/stories/overlay.stories.js +238 -228
- package/stories/overlay.stories.js.map +7 -1
- package/sync/overlay-trigger.dev.js +7 -0
- package/sync/overlay-trigger.dev.js.map +7 -0
- package/sync/overlay-trigger.js +5 -16
- package/sync/overlay-trigger.js.map +7 -1
- package/test/benchmark/basic-test.js +7 -18
- package/test/benchmark/basic-test.js.map +7 -1
- package/test/overlay-lifecycle.test.js +107 -115
- package/test/overlay-lifecycle.test.js.map +7 -1
- package/test/overlay-timer.test.js +110 -122
- package/test/overlay-timer.test.js.map +7 -1
- package/test/overlay-trigger-click.test.js +43 -48
- package/test/overlay-trigger-click.test.js.map +7 -1
- package/test/overlay-trigger-extended.test.js +167 -182
- package/test/overlay-trigger-extended.test.js.map +7 -1
- package/test/overlay-trigger-hover-click.test.js +59 -73
- package/test/overlay-trigger-hover-click.test.js.map +7 -1
- package/test/overlay-trigger-hover.test.js +74 -77
- package/test/overlay-trigger-hover.test.js.map +7 -1
- package/test/overlay-trigger-longpress.test.js +166 -178
- package/test/overlay-trigger-longpress.test.js.map +7 -1
- package/test/overlay-trigger-sync.test.js +400 -422
- package/test/overlay-trigger-sync.test.js.map +7 -1
- package/test/overlay-trigger.test.js +400 -422
- package/test/overlay-trigger.test.js.map +7 -1
- package/test/overlay.test-vrt.js +4 -15
- package/test/overlay.test-vrt.js.map +7 -1
- package/test/overlay.test.js +458 -479
- package/test/overlay.test.js.map +7 -1
package/src/overlay-utils.js
CHANGED
|
@@ -1,39 +1,28 @@
|
|
|
1
|
-
/*
|
|
2
|
-
Copyright 2022 Adobe. All rights reserved.
|
|
3
|
-
This file is licensed to you under the Apache License, Version 2.0 (the "License");
|
|
4
|
-
you may not use this file except in compliance with the License. You may obtain a copy
|
|
5
|
-
of the License at http://www.apache.org/licenses/LICENSE-2.0
|
|
6
|
-
|
|
7
|
-
Unless required by applicable law or agreed to in writing, software distributed under
|
|
8
|
-
the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
|
|
9
|
-
OF ANY KIND, either express or implied. See the License for the specific language
|
|
10
|
-
governing permissions and limitations under the License.
|
|
11
|
-
*/
|
|
12
1
|
export const parentOverlayOf = (el) => {
|
|
13
|
-
|
|
14
|
-
return null;
|
|
15
|
-
const closestOverlay = el.closest('active-overlay');
|
|
16
|
-
if (closestOverlay) {
|
|
17
|
-
return closestOverlay;
|
|
18
|
-
}
|
|
19
|
-
const rootNode = el.getRootNode();
|
|
20
|
-
if (rootNode.host) {
|
|
21
|
-
return parentOverlayOf(rootNode.host);
|
|
22
|
-
}
|
|
2
|
+
if (!el)
|
|
23
3
|
return null;
|
|
4
|
+
const closestOverlay = el.closest("active-overlay");
|
|
5
|
+
if (closestOverlay) {
|
|
6
|
+
return closestOverlay;
|
|
7
|
+
}
|
|
8
|
+
const rootNode = el.getRootNode();
|
|
9
|
+
if (rootNode.host) {
|
|
10
|
+
return parentOverlayOf(rootNode.host);
|
|
11
|
+
}
|
|
12
|
+
return null;
|
|
24
13
|
};
|
|
25
14
|
export const findOverlaysRootedInOverlay = (rootOverlay, activeOverlays) => {
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
}
|
|
15
|
+
const overlays = [];
|
|
16
|
+
if (!rootOverlay)
|
|
17
|
+
return [];
|
|
18
|
+
for (const overlay of activeOverlays) {
|
|
19
|
+
if (!overlay.root)
|
|
20
|
+
continue;
|
|
21
|
+
if (parentOverlayOf(overlay.root) === rootOverlay) {
|
|
22
|
+
overlays.push(overlay);
|
|
23
|
+
overlays.push(...findOverlaysRootedInOverlay(overlay, activeOverlays));
|
|
36
24
|
}
|
|
37
|
-
|
|
25
|
+
}
|
|
26
|
+
return overlays;
|
|
38
27
|
};
|
|
39
|
-
//# sourceMappingURL=overlay-utils.js.map
|
|
28
|
+
//# sourceMappingURL=overlay-utils.js.map
|
package/src/overlay-utils.js.map
CHANGED
|
@@ -1 +1,7 @@
|
|
|
1
|
-
{
|
|
1
|
+
{
|
|
2
|
+
"version": 3,
|
|
3
|
+
"sources": ["overlay-utils.ts"],
|
|
4
|
+
"sourcesContent": ["/*\nCopyright 2022 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 { ActiveOverlay } from './ActiveOverlay';\n\nexport const parentOverlayOf = (el?: Element): ActiveOverlay | null => {\n if (!el) return null;\n const closestOverlay = el.closest('active-overlay');\n if (closestOverlay) {\n return closestOverlay;\n }\n const rootNode = el.getRootNode() as ShadowRoot;\n if (rootNode.host) {\n return parentOverlayOf(rootNode.host);\n }\n return null;\n};\n\nexport const findOverlaysRootedInOverlay = (\n rootOverlay: ActiveOverlay | undefined,\n activeOverlays: ActiveOverlay[]\n): ActiveOverlay[] => {\n const overlays: ActiveOverlay[] = [];\n if (!rootOverlay) return [];\n for (const overlay of activeOverlays) {\n if (!overlay.root) continue;\n if (parentOverlayOf(overlay.root) === rootOverlay) {\n overlays.push(overlay);\n overlays.push(\n ...findOverlaysRootedInOverlay(overlay, activeOverlays)\n );\n }\n }\n return overlays;\n};\n"],
|
|
5
|
+
"mappings": "AAcO,aAAM,kBAAkB,CAAC,OAAuC;AACnE,MAAI,CAAC;AAAI,WAAO;AAChB,QAAM,iBAAiB,GAAG,QAAQ,gBAAgB;AAClD,MAAI,gBAAgB;AAChB,WAAO;AAAA,EACX;AACA,QAAM,WAAW,GAAG,YAAY;AAChC,MAAI,SAAS,MAAM;AACf,WAAO,gBAAgB,SAAS,IAAI;AAAA,EACxC;AACA,SAAO;AACX;AAEO,aAAM,8BAA8B,CACvC,aACA,mBACkB;AAClB,QAAM,WAA4B,CAAC;AACnC,MAAI,CAAC;AAAa,WAAO,CAAC;AAC1B,aAAW,WAAW,gBAAgB;AAClC,QAAI,CAAC,QAAQ;AAAM;AACnB,QAAI,gBAAgB,QAAQ,IAAI,MAAM,aAAa;AAC/C,eAAS,KAAK,OAAO;AACrB,eAAS,KACL,GAAG,4BAA4B,SAAS,cAAc,CAC1D;AAAA,IACJ;AAAA,EACJ;AACA,SAAO;AACX;",
|
|
6
|
+
"names": []
|
|
7
|
+
}
|
|
@@ -0,0 +1,85 @@
|
|
|
1
|
+
import { OverlayStack } from "./overlay-stack.dev.js";
|
|
2
|
+
const _Overlay = class {
|
|
3
|
+
constructor(owner, interaction, overlayElement) {
|
|
4
|
+
this.isOpen = false;
|
|
5
|
+
this.owner = owner;
|
|
6
|
+
this.overlayElement = overlayElement;
|
|
7
|
+
this.interaction = interaction;
|
|
8
|
+
}
|
|
9
|
+
static async open(owner, interaction, overlayElement, options) {
|
|
10
|
+
const overlay = new _Overlay(owner, interaction, overlayElement);
|
|
11
|
+
await overlay.open(options);
|
|
12
|
+
return () => {
|
|
13
|
+
overlay.close();
|
|
14
|
+
};
|
|
15
|
+
}
|
|
16
|
+
static update() {
|
|
17
|
+
const overlayUpdateEvent = new CustomEvent("sp-update-overlays", {
|
|
18
|
+
bubbles: true,
|
|
19
|
+
composed: true,
|
|
20
|
+
cancelable: true
|
|
21
|
+
});
|
|
22
|
+
document.dispatchEvent(overlayUpdateEvent);
|
|
23
|
+
}
|
|
24
|
+
async open({
|
|
25
|
+
abortPromise,
|
|
26
|
+
delayed,
|
|
27
|
+
offset = 0,
|
|
28
|
+
placement = "top",
|
|
29
|
+
receivesFocus,
|
|
30
|
+
notImmediatelyClosable,
|
|
31
|
+
virtualTrigger,
|
|
32
|
+
root
|
|
33
|
+
}) {
|
|
34
|
+
if (this.isOpen)
|
|
35
|
+
return true;
|
|
36
|
+
if (delayed === void 0) {
|
|
37
|
+
delayed = this.overlayElement.hasAttribute("delayed");
|
|
38
|
+
}
|
|
39
|
+
const queryThemeDetail = {
|
|
40
|
+
color: void 0,
|
|
41
|
+
scale: void 0,
|
|
42
|
+
lang: void 0,
|
|
43
|
+
theme: void 0
|
|
44
|
+
};
|
|
45
|
+
const queryThemeEvent = new CustomEvent("sp-query-theme", {
|
|
46
|
+
bubbles: true,
|
|
47
|
+
composed: true,
|
|
48
|
+
detail: queryThemeDetail,
|
|
49
|
+
cancelable: true
|
|
50
|
+
});
|
|
51
|
+
this.owner.dispatchEvent(queryThemeEvent);
|
|
52
|
+
const overlayDetailQuery = {};
|
|
53
|
+
const queryOverlayDetailEvent = new CustomEvent("sp-overlay-query", {
|
|
54
|
+
bubbles: true,
|
|
55
|
+
composed: true,
|
|
56
|
+
detail: overlayDetailQuery,
|
|
57
|
+
cancelable: true
|
|
58
|
+
});
|
|
59
|
+
this.overlayElement.dispatchEvent(queryOverlayDetailEvent);
|
|
60
|
+
await _Overlay.overlayStack.openOverlay({
|
|
61
|
+
abortPromise,
|
|
62
|
+
content: this.overlayElement,
|
|
63
|
+
contentTip: overlayDetailQuery.overlayContentTipElement,
|
|
64
|
+
delayed,
|
|
65
|
+
offset,
|
|
66
|
+
placement,
|
|
67
|
+
trigger: this.owner,
|
|
68
|
+
interaction: this.interaction,
|
|
69
|
+
theme: queryThemeDetail,
|
|
70
|
+
receivesFocus,
|
|
71
|
+
root,
|
|
72
|
+
notImmediatelyClosable,
|
|
73
|
+
virtualTrigger,
|
|
74
|
+
...overlayDetailQuery
|
|
75
|
+
});
|
|
76
|
+
this.isOpen = true;
|
|
77
|
+
return true;
|
|
78
|
+
}
|
|
79
|
+
close() {
|
|
80
|
+
_Overlay.overlayStack.closeOverlay(this.overlayElement);
|
|
81
|
+
}
|
|
82
|
+
};
|
|
83
|
+
export let Overlay = _Overlay;
|
|
84
|
+
Overlay.overlayStack = new OverlayStack();
|
|
85
|
+
//# sourceMappingURL=overlay.dev.js.map
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
{
|
|
2
|
+
"version": 3,
|
|
3
|
+
"sources": ["overlay.ts"],
|
|
4
|
+
"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.dev.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 root,\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 theme: 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 root,\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"],
|
|
5
|
+
"mappings": "AAkBA;AAMO,uBAAc;AAAA,EAcjB,YACI,OACA,aACA,gBACF;AAfM,kBAAS;AAgBb,SAAK,QAAQ;AACb,SAAK,iBAAiB;AACtB,SAAK,cAAc;AAAA,EACvB;AAAA,eAcoB,KAChB,OACA,aACA,gBACA,SACmB;AACnB,UAAM,UAAU,IAAI,SAAQ,OAAO,aAAa,cAAc;AAC9D,UAAM,QAAQ,KAAK,OAAO;AAC1B,WAAO,MAAY;AACf,cAAQ,MAAM;AAAA,IAClB;AAAA,EACJ;AAAA,SAEc,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,QAWa,KAAK;AAAA,IACd;AAAA,IACA;AAAA,IACA,SAAS;AAAA,IACT,YAAY;AAAA,IACZ;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,KACiC;AAEjC,QAAI,KAAK;AAAQ,aAAO;AAExB,QAAI,YAAY,QAAW;AACvB,gBAAU,KAAK,eAAe,aAAa,SAAS;AAAA,IACxD;AAEA,UAAM,mBAA8B;AAAA,MAChC,OAAO;AAAA,MACP,OAAO;AAAA,MACP,MAAM;AAAA,MACN,OAAO;AAAA,IACX;AACA,UAAM,kBAAkB,IAAI,YAAuB,kBAAkB;AAAA,MACjE,SAAS;AAAA,MACT,UAAU;AAAA,MACV,QAAQ;AAAA,MACR,YAAY;AAAA,IAChB,CAAC;AACD,SAAK,MAAM,cAAc,eAAe;AAExC,UAAM,qBAAgD,CAAC;AACvD,UAAM,0BACF,IAAI,YAAuC,oBAAoB;AAAA,MAC3D,SAAS;AAAA,MACT,UAAU;AAAA,MACV,QAAQ;AAAA,MACR,YAAY;AAAA,IAChB,CAAC;AACL,SAAK,eAAe,cAAc,uBAAuB;AAEzD,UAAM,SAAQ,aAAa,YAAY;AAAA,MACnC;AAAA,MACA,SAAS,KAAK;AAAA,MACd,YAAY,mBAAmB;AAAA,MAC/B;AAAA,MACA;AAAA,MACA;AAAA,MACA,SAAS,KAAK;AAAA,MACd,aAAa,KAAK;AAAA,MAClB,OAAO;AAAA,MACP;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,SACG;AAAA,IACP,CAAC;AACD,SAAK,SAAS;AACd,WAAO;AAAA,EACX;AAAA,EAKO,QAAc;AACjB,aAAQ,aAAa,aAAa,KAAK,cAAc;AAAA,EACzD;AACJ;AAtIO;AACY,AADZ,QACY,eAAe,IAAI,aAAa;",
|
|
6
|
+
"names": []
|
|
7
|
+
}
|
package/src/overlay.js
CHANGED
|
@@ -1,121 +1,85 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
1
|
+
import { OverlayStack } from "./overlay-stack.js";
|
|
2
|
+
const _Overlay = class {
|
|
3
|
+
constructor(owner, interaction, overlayElement) {
|
|
4
|
+
this.isOpen = false;
|
|
5
|
+
this.owner = owner;
|
|
6
|
+
this.overlayElement = overlayElement;
|
|
7
|
+
this.interaction = interaction;
|
|
8
|
+
}
|
|
9
|
+
static async open(owner, interaction, overlayElement, options) {
|
|
10
|
+
const overlay = new _Overlay(owner, interaction, overlayElement);
|
|
11
|
+
await overlay.open(options);
|
|
12
|
+
return () => {
|
|
13
|
+
overlay.close();
|
|
14
|
+
};
|
|
15
|
+
}
|
|
16
|
+
static update() {
|
|
17
|
+
const overlayUpdateEvent = new CustomEvent("sp-update-overlays", {
|
|
18
|
+
bubbles: true,
|
|
19
|
+
composed: true,
|
|
20
|
+
cancelable: true
|
|
21
|
+
});
|
|
22
|
+
document.dispatchEvent(overlayUpdateEvent);
|
|
23
|
+
}
|
|
24
|
+
async open({
|
|
25
|
+
abortPromise,
|
|
26
|
+
delayed,
|
|
27
|
+
offset = 0,
|
|
28
|
+
placement = "top",
|
|
29
|
+
receivesFocus,
|
|
30
|
+
notImmediatelyClosable,
|
|
31
|
+
virtualTrigger,
|
|
32
|
+
root
|
|
33
|
+
}) {
|
|
34
|
+
if (this.isOpen)
|
|
35
|
+
return true;
|
|
36
|
+
if (delayed === void 0) {
|
|
37
|
+
delayed = this.overlayElement.hasAttribute("delayed");
|
|
29
38
|
}
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
scale: undefined,
|
|
76
|
-
lang: undefined,
|
|
77
|
-
theme: undefined,
|
|
78
|
-
};
|
|
79
|
-
const queryThemeEvent = new CustomEvent('sp-query-theme', {
|
|
80
|
-
bubbles: true,
|
|
81
|
-
composed: true,
|
|
82
|
-
detail: queryThemeDetail,
|
|
83
|
-
cancelable: true,
|
|
84
|
-
});
|
|
85
|
-
this.owner.dispatchEvent(queryThemeEvent);
|
|
86
|
-
const overlayDetailQuery = {};
|
|
87
|
-
const queryOverlayDetailEvent = new CustomEvent('sp-overlay-query', {
|
|
88
|
-
bubbles: true,
|
|
89
|
-
composed: true,
|
|
90
|
-
detail: overlayDetailQuery,
|
|
91
|
-
cancelable: true,
|
|
92
|
-
});
|
|
93
|
-
this.overlayElement.dispatchEvent(queryOverlayDetailEvent);
|
|
94
|
-
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,
|
|
95
|
-
root,
|
|
96
|
-
notImmediatelyClosable,
|
|
97
|
-
virtualTrigger }, overlayDetailQuery));
|
|
98
|
-
this.isOpen = true;
|
|
99
|
-
return true;
|
|
100
|
-
}
|
|
101
|
-
/**
|
|
102
|
-
* Close the overlay if it is open
|
|
103
|
-
*/
|
|
104
|
-
close() {
|
|
105
|
-
Overlay.overlayStack.closeOverlay(this.overlayElement);
|
|
106
|
-
}
|
|
107
|
-
}
|
|
39
|
+
const queryThemeDetail = {
|
|
40
|
+
color: void 0,
|
|
41
|
+
scale: void 0,
|
|
42
|
+
lang: void 0,
|
|
43
|
+
theme: void 0
|
|
44
|
+
};
|
|
45
|
+
const queryThemeEvent = new CustomEvent("sp-query-theme", {
|
|
46
|
+
bubbles: true,
|
|
47
|
+
composed: true,
|
|
48
|
+
detail: queryThemeDetail,
|
|
49
|
+
cancelable: true
|
|
50
|
+
});
|
|
51
|
+
this.owner.dispatchEvent(queryThemeEvent);
|
|
52
|
+
const overlayDetailQuery = {};
|
|
53
|
+
const queryOverlayDetailEvent = new CustomEvent("sp-overlay-query", {
|
|
54
|
+
bubbles: true,
|
|
55
|
+
composed: true,
|
|
56
|
+
detail: overlayDetailQuery,
|
|
57
|
+
cancelable: true
|
|
58
|
+
});
|
|
59
|
+
this.overlayElement.dispatchEvent(queryOverlayDetailEvent);
|
|
60
|
+
await _Overlay.overlayStack.openOverlay({
|
|
61
|
+
abortPromise,
|
|
62
|
+
content: this.overlayElement,
|
|
63
|
+
contentTip: overlayDetailQuery.overlayContentTipElement,
|
|
64
|
+
delayed,
|
|
65
|
+
offset,
|
|
66
|
+
placement,
|
|
67
|
+
trigger: this.owner,
|
|
68
|
+
interaction: this.interaction,
|
|
69
|
+
theme: queryThemeDetail,
|
|
70
|
+
receivesFocus,
|
|
71
|
+
root,
|
|
72
|
+
notImmediatelyClosable,
|
|
73
|
+
virtualTrigger,
|
|
74
|
+
...overlayDetailQuery
|
|
75
|
+
});
|
|
76
|
+
this.isOpen = true;
|
|
77
|
+
return true;
|
|
78
|
+
}
|
|
79
|
+
close() {
|
|
80
|
+
_Overlay.overlayStack.closeOverlay(this.overlayElement);
|
|
81
|
+
}
|
|
82
|
+
};
|
|
83
|
+
export let Overlay = _Overlay;
|
|
108
84
|
Overlay.overlayStack = new OverlayStack();
|
|
109
|
-
|
|
110
|
-
* Announces that an overlay-based UI element has opened
|
|
111
|
-
* @event sp-open
|
|
112
|
-
* @type {object}
|
|
113
|
-
* @property {TriggerInteractions} interaction type of interaction that triggered the opening
|
|
114
|
-
*/
|
|
115
|
-
/**
|
|
116
|
-
* Announces that an overlay-based UI element has opened
|
|
117
|
-
* @event sp-close
|
|
118
|
-
* @type {object}
|
|
119
|
-
* @property {TriggerInteractions} interaction type of interaction that triggered the closing
|
|
120
|
-
*/
|
|
121
|
-
//# sourceMappingURL=overlay.js.map
|
|
85
|
+
//# sourceMappingURL=overlay.js.map
|
package/src/overlay.js.map
CHANGED
|
@@ -1 +1,7 @@
|
|
|
1
|
-
{
|
|
1
|
+
{
|
|
2
|
+
"version": 3,
|
|
3
|
+
"sources": ["overlay.ts"],
|
|
4
|
+
"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 root,\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 theme: 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 root,\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"],
|
|
5
|
+
"mappings": "AAkBA;AAMO,uBAAc;AAAA,EAcjB,YACI,OACA,aACA,gBACF;AAfM,kBAAS;AAgBb,SAAK,QAAQ;AACb,SAAK,iBAAiB;AACtB,SAAK,cAAc;AAAA,EACvB;AAAA,eAcoB,KAChB,OACA,aACA,gBACA,SACmB;AACnB,UAAM,UAAU,IAAI,SAAQ,OAAO,aAAa,cAAc;AAC9D,UAAM,QAAQ,KAAK,OAAO;AAC1B,WAAO,MAAY;AACf,cAAQ,MAAM;AAAA,IAClB;AAAA,EACJ;AAAA,SAEc,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,QAWa,KAAK;AAAA,IACd;AAAA,IACA;AAAA,IACA,SAAS;AAAA,IACT,YAAY;AAAA,IACZ;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,KACiC;AAEjC,QAAI,KAAK;AAAQ,aAAO;AAExB,QAAI,YAAY,QAAW;AACvB,gBAAU,KAAK,eAAe,aAAa,SAAS;AAAA,IACxD;AAEA,UAAM,mBAA8B;AAAA,MAChC,OAAO;AAAA,MACP,OAAO;AAAA,MACP,MAAM;AAAA,MACN,OAAO;AAAA,IACX;AACA,UAAM,kBAAkB,IAAI,YAAuB,kBAAkB;AAAA,MACjE,SAAS;AAAA,MACT,UAAU;AAAA,MACV,QAAQ;AAAA,MACR,YAAY;AAAA,IAChB,CAAC;AACD,SAAK,MAAM,cAAc,eAAe;AAExC,UAAM,qBAAgD,CAAC;AACvD,UAAM,0BACF,IAAI,YAAuC,oBAAoB;AAAA,MAC3D,SAAS;AAAA,MACT,UAAU;AAAA,MACV,QAAQ;AAAA,MACR,YAAY;AAAA,IAChB,CAAC;AACL,SAAK,eAAe,cAAc,uBAAuB;AAEzD,UAAM,SAAQ,aAAa,YAAY;AAAA,MACnC;AAAA,MACA,SAAS,KAAK;AAAA,MACd,YAAY,mBAAmB;AAAA,MAC/B;AAAA,MACA;AAAA,MACA;AAAA,MACA,SAAS,KAAK;AAAA,MACd,aAAa,KAAK;AAAA,MAClB,OAAO;AAAA,MACP;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,SACG;AAAA,IACP,CAAC;AACD,SAAK,SAAS;AACd,WAAO;AAAA,EACX;AAAA,EAKO,QAAc;AACjB,aAAQ,aAAa,aAAa,KAAK,cAAc;AAAA,EACzD;AACJ;AAtIO;AACY,AADZ,QACY,eAAe,IAAI,aAAa;",
|
|
6
|
+
"names": []
|
|
7
|
+
}
|