@spectrum-web-components/overlay 0.15.2 → 0.15.3

package/test/overlay-lifecycle.test.js

@@ -0,0 +1,162 @@
+/*
+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 { elementUpdated, expect, fixture, html, oneEvent, waitUntil, } from '@open-wc/testing';
+import '@spectrum-web-components/tooltip/sp-tooltip.js';
+import '@spectrum-web-components/action-button/sp-action-button.js';
+import '@spectrum-web-components/overlay/overlay-trigger.js';
+import { a11ySnapshot, findAccessibilityNode } from '@web/test-runner-commands';
+describe('Overlay Trigger - Lifecycle Methods', () => {
+    it('calls the overlay lifecycle (willOpen/Close)', async () => {
+        const el = await fixture(html `
+            <overlay-trigger placement="right-start">
+                <sp-action-button slot="trigger">
+                    Button with Tooltip
+                </sp-action-button>
+                <sp-tooltip slot="hover-content">
+                    Described by this content on focus/hover. 1
+                </sp-tooltip>
+            </overlay-trigger>
+        `);
+        await elementUpdated(el);
+        expect(el.open).to.be.undefined;
+        expect(el.childNodes.length).to.equal(5);
+        const trigger = el.querySelector('[slot="trigger"]');
+        let snapshot = (await a11ySnapshot({}));
+        expect(findAccessibilityNode(snapshot, (node) => node.name === 'Button with Tooltip' &&
+            typeof node.description === 'undefined'), '`name`ed with no `description`');
+        const opened = oneEvent(el, 'sp-opened');
+        trigger.dispatchEvent(new FocusEvent('focusin', { bubbles: true, composed: true }));
+        await opened;
+        expect(el.open).to.equal('hover');
+        snapshot = (await a11ySnapshot({}));
+        expect(el.childNodes.length).to.equal(6);
+        expect(findAccessibilityNode(snapshot, (node) => node.name === 'Button with Tooltip' &&
+            node.description ===
+                'Described by this content on focus/hover.'), '`name`ed with `description`');
+        const closed = oneEvent(el, 'sp-closed');
+        trigger.dispatchEvent(new FocusEvent('focusout', { bubbles: true, composed: true }));
+        await closed;
+        await elementUpdated(el);
+        await waitUntil(() => el.open === null);
+        expect(el.childNodes.length).to.equal(5);
+    });
+    it('calls the overlay lifecycle (willOpen/openCanceled)', async () => {
+        const el = await fixture(html `
+            <overlay-trigger placement="right-start">
+                <sp-action-button slot="trigger">
+                    Button with Tooltip
+                </sp-action-button>
+                <sp-tooltip slot="hover-content" delayed>
+                    Described by this content on focus/hover. 2
+                </sp-tooltip>
+            </overlay-trigger>
+        `);
+        await elementUpdated(el);
+        expect(el.open).to.be.undefined;
+        expect(el.childNodes.length, 'always').to.equal(5);
+        const trigger = el.querySelector('[slot="trigger"]');
+        trigger.dispatchEvent(new FocusEvent('focusin', { bubbles: true, composed: true }));
+        await elementUpdated(el);
+        trigger.dispatchEvent(new FocusEvent('focusout', { bubbles: true, composed: true }));
+        await elementUpdated(el);
+        await waitUntil(() => {
+            return el.open === null;
+        }, 'open');
+        await elementUpdated(el);
+        await waitUntil(() => {
+            return el.childNodes.length === 5;
+        }, 'children');
+    });
+    it('gardens `aria-describedby` in its target', async () => {
+        const el = await fixture(html `
+            <overlay-trigger placement="right-start">
+                <sp-action-button slot="trigger" aria-describedby="descriptor">
+                    Button with Tooltip
+                </sp-action-button>
+                <sp-tooltip slot="hover-content" delayed>
+                    Described by this content on focus/hover. 2
+                </sp-tooltip>
+            </overlay-trigger>
+            <div id="descriptor">I'm a description!</div>
+        `);
+        const trigger = el.querySelector('[slot="trigger"]');
+        const tooltip = el.querySelector('sp-tooltip');
+        await elementUpdated(el);
+        expect(trigger.getAttribute('aria-describedby')).to.equal('descriptor');
+        expect(el.open).to.be.undefined;
+        expect(el.childNodes.length, 'always').to.equal(5);
+        const opened = oneEvent(el, 'sp-opened');
+        trigger.dispatchEvent(new FocusEvent('focusin', { bubbles: true, composed: true }));
+        await opened;
+        expect(trigger.getAttribute('aria-describedby')).to.equal(`descriptor ${tooltip._tooltipId}`);
+        const closed = oneEvent(el, 'sp-closed');
+        trigger.dispatchEvent(new FocusEvent('focusout', { bubbles: true, composed: true }));
+        await closed;
+        expect(trigger.getAttribute('aria-describedby')).to.equal('descriptor');
+    });
+    it('adds and removes `aria-describedby` attribute', async () => {
+        const el = await fixture(html `
+            <overlay-trigger placement="right-start">
+                <sp-action-button slot="trigger">
+                    Button with Tooltip
+                </sp-action-button>
+                <sp-tooltip slot="hover-content" delayed>
+                    Described by this content on focus/hover. 2
+                </sp-tooltip>
+            </overlay-trigger>
+        `);
+        const trigger = el.querySelector('[slot="trigger"]');
+        const tooltip = el.querySelector('sp-tooltip');
+        await elementUpdated(el);
+        expect(trigger.hasAttribute('aria-describedby')).to.be.false;
+        expect(el.open).to.be.undefined;
+        expect(el.childNodes.length, 'always').to.equal(5);
+        const opened = oneEvent(el, 'sp-opened');
+        trigger.dispatchEvent(new FocusEvent('focusin', { bubbles: true, composed: true }));
+        await opened;
+        expect(trigger.getAttribute('aria-describedby')).to.equal(`${tooltip._tooltipId}`);
+        const closed = oneEvent(el, 'sp-closed');
+        trigger.dispatchEvent(new FocusEvent('focusout', { bubbles: true, composed: true }));
+        await closed;
+        expect(trigger.hasAttribute('aria-describedby')).to.be.false;
+    });
+    it('does not duplicate `aria-describedby` attribute', async () => {
+        const el = await fixture(html `
+            <overlay-trigger placement="right-start">
+                <sp-action-button slot="trigger">
+                    Button with Tooltip
+                </sp-action-button>
+                <sp-tooltip slot="hover-content" delayed>
+                    Described by this content on focus/hover. 2
+                </sp-tooltip>
+            </overlay-trigger>
+        `);
+        const trigger = el.querySelector('[slot="trigger"]');
+        const tooltip = el.querySelector('sp-tooltip');
+        const tooltipId = tooltip
+            ._tooltipId;
+        trigger.setAttribute('aria-describedby', tooltipId);
+        await elementUpdated(el);
+        expect(trigger.getAttribute('aria-describedby')).to.equal(tooltipId);
+        expect(el.open).to.be.undefined;
+        expect(el.childNodes.length, 'always').to.equal(5);
+        const opened = oneEvent(el, 'sp-opened');
+        trigger.dispatchEvent(new FocusEvent('focusin', { bubbles: true, composed: true }));
+        await opened;
+        expect(trigger.getAttribute('aria-describedby')).to.equal(tooltipId);
+        const closed = oneEvent(el, 'sp-closed');
+        trigger.dispatchEvent(new FocusEvent('focusout', { bubbles: true, composed: true }));
+        await closed;
+        expect(trigger.getAttribute('aria-describedby')).to.equal(tooltipId);
+    });
+});
+//# sourceMappingURL=overlay-lifecycle.test.js.map

package/test/overlay-lifecycle.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"overlay-lifecycle.test.js","sourceRoot":"","sources":["overlay-lifecycle.test.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;EAUE;AACF,OAAO,EACH,cAAc,EACd,MAAM,EACN,OAAO,EACP,IAAI,EACJ,QAAQ,EACR,SAAS,GACZ,MAAM,kBAAkB,CAAC;AAC1B,OAAO,gDAAgD,CAAC;AACxD,OAAO,4DAA4D,CAAC;AAEpE,OAAO,qDAAqD,CAAC;AAC7D,OAAO,EAAE,YAAY,EAAE,qBAAqB,EAAE,MAAM,2BAA2B,CAAC;AAGhF,QAAQ,CAAC,qCAAqC,EAAE,GAAG,EAAE;IACjD,EAAE,CAAC,8CAA8C,EAAE,KAAK,IAAI,EAAE;QAC1D,MAAM,EAAE,GAAG,MAAM,OAAO,CAAiB,IAAI,CAAA;;;;;;;;;SAS5C,CAAC,CAAC;QAEH,MAAM,cAAc,CAAC,EAAE,CAAC,CAAC;QAEzB,MAAM,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,SAAS,CAAC;QAChC,MAAM,CAAC,EAAE,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QACzC,MAAM,OAAO,GAAG,EAAE,CAAC,aAAa,CAAC,kBAAkB,CAAgB,CAAC;QAKpE,IAAI,QAAQ,GAAG,CAAC,MAAM,YAAY,CAAC,EAAE,CAAC,CAErC,CAAC;QACF,MAAM,CACF,qBAAqB,CACjB,QAAQ,EACR,CAAC,IAAI,EAAE,EAAE,CACL,IAAI,CAAC,IAAI,KAAK,qBAAqB;YACnC,OAAO,IAAI,CAAC,WAAW,KAAK,WAAW,CAC9C,EACD,gCAAgC,CACnC,CAAC;QACF,MAAM,MAAM,GAAG,QAAQ,CAAC,EAAE,EAAE,WAAW,CAAC,CAAC;QACzC,OAAO,CAAC,aAAa,CACjB,IAAI,UAAU,CAAC,SAAS,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAC/D,CAAC;QACF,MAAM,MAAM,CAAC;QAEb,MAAM,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAClC,QAAQ,GAAG,CAAC,MAAM,YAAY,CAAC,EAAE,CAAC,CAEjC,CAAC;QAEF,MAAM,CAAC,EAAE,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QACzC,MAAM,CACF,qBAAqB,CACjB,QAAQ,EACR,CAAC,IAAI,EAAE,EAAE,CACL,IAAI,CAAC,IAAI,KAAK,qBAAqB;YACnC,IAAI,CAAC,WAAW;gBACZ,2CAA2C,CACtD,EACD,6BAA6B,CAChC,CAAC;QAEF,MAAM,MAAM,GAAG,QAAQ,CAAC,EAAE,EAAE,WAAW,CAAC,CAAC;QACzC,OAAO,CAAC,aAAa,CACjB,IAAI,UAAU,CAAC,UAAU,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAChE,CAAC;QACF,MAAM,MAAM,CAAC;QACb,MAAM,cAAc,CAAC,EAAE,CAAC,CAAC;QAEzB,MAAM,SAAS,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC;QACxC,MAAM,CAAC,EAAE,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAC7C,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,qDAAqD,EAAE,KAAK,IAAI,EAAE;QACjE,MAAM,EAAE,GAAG,MAAM,OAAO,CAAiB,IAAI,CAAA;;;;;;;;;SAS5C,CAAC,CAAC;QAEH,MAAM,cAAc,CAAC,EAAE,CAAC,CAAC;QAEzB,MAAM,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,SAAS,CAAC;QAChC,MAAM,CAAC,EAAE,CAAC,UAAU,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QACnD,MAAM,OAAO,GAAG,EAAE,CAAC,aAAa,CAAC,kBAAkB,CAAgB,CAAC;QACpE,OAAO,CAAC,aAAa,CACjB,IAAI,UAAU,CAAC,SAAS,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAC/D,CAAC;QACF,MAAM,cAAc,CAAC,EAAE,CAAC,CAAC;QACzB,OAAO,CAAC,aAAa,CACjB,IAAI,UAAU,CAAC,UAAU,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAChE,CAAC;QACF,MAAM,cAAc,CAAC,EAAE,CAAC,CAAC;QAEzB,MAAM,SAAS,CAAC,GAAG,EAAE;YACjB,OAAO,EAAE,CAAC,IAAI,KAAK,IAAI,CAAC;QAC5B,CAAC,EAAE,MAAM,CAAC,CAAC;QACX,MAAM,cAAc,CAAC,EAAE,CAAC,CAAC;QACzB,MAAM,SAAS,CAAC,GAAG,EAAE;YACjB,OAAO,EAAE,CAAC,UAAU,CAAC,MAAM,KAAK,CAAC,CAAC;QACtC,CAAC,EAAE,UAAU,CAAC,CAAC;IACnB,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,0CAA0C,EAAE,KAAK,IAAI,EAAE;QACtD,MAAM,EAAE,GAAG,MAAM,OAAO,CAAiB,IAAI,CAAA;;;;;;;;;;SAU5C,CAAC,CAAC;QAEH,MAAM,OAAO,GAAG,EAAE,CAAC,aAAa,CAAC,kBAAkB,CAAgB,CAAC;QACpE,MAAM,OAAO,GAAG,EAAE,CAAC,aAAa,CAAC,YAAY,CAAY,CAAC;QAE1D,MAAM,cAAc,CAAC,EAAE,CAAC,CAAC;QAEzB,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,kBAAkB,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;QACxE,MAAM,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,SAAS,CAAC;QAChC,MAAM,CAAC,EAAE,CAAC,UAAU,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAEnD,MAAM,MAAM,GAAG,QAAQ,CAAC,EAAE,EAAE,WAAW,CAAC,CAAC;QACzC,OAAO,CAAC,aAAa,CACjB,IAAI,UAAU,CAAC,SAAS,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAC/D,CAAC;QACF,MAAM,MAAM,CAAC;QAEb,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,kBAAkB,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CACrD,cACK,OAA6C,CAAC,UACnD,EAAE,CACL,CAAC;QAEF,MAAM,MAAM,GAAG,QAAQ,CAAC,EAAE,EAAE,WAAW,CAAC,CAAC;QACzC,OAAO,CAAC,aAAa,CACjB,IAAI,UAAU,CAAC,UAAU,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAChE,CAAC;QACF,MAAM,MAAM,CAAC;QAEb,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,kBAAkB,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;IAC5E,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,+CAA+C,EAAE,KAAK,IAAI,EAAE;QAC3D,MAAM,EAAE,GAAG,MAAM,OAAO,CAAiB,IAAI,CAAA;;;;;;;;;SAS5C,CAAC,CAAC;QAEH,MAAM,OAAO,GAAG,EAAE,CAAC,aAAa,CAAC,kBAAkB,CAAgB,CAAC;QACpE,MAAM,OAAO,GAAG,EAAE,CAAC,aAAa,CAAC,YAAY,CAAY,CAAC;QAE1D,MAAM,cAAc,CAAC,EAAE,CAAC,CAAC;QAEzB,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,kBAAkB,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC;QAC7D,MAAM,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,SAAS,CAAC;QAChC,MAAM,CAAC,EAAE,CAAC,UAAU,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAEnD,MAAM,MAAM,GAAG,QAAQ,CAAC,EAAE,EAAE,WAAW,CAAC,CAAC;QACzC,OAAO,CAAC,aAAa,CACjB,IAAI,UAAU,CAAC,SAAS,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAC/D,CAAC;QACF,MAAM,MAAM,CAAC;QAEb,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,kBAAkB,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CACrD,GAAI,OAA6C,CAAC,UAAU,EAAE,CACjE,CAAC;QAEF,MAAM,MAAM,GAAG,QAAQ,CAAC,EAAE,EAAE,WAAW,CAAC,CAAC;QACzC,OAAO,CAAC,aAAa,CACjB,IAAI,UAAU,CAAC,UAAU,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAChE,CAAC;QACF,MAAM,MAAM,CAAC;QAEb,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,kBAAkB,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC;IACjE,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,iDAAiD,EAAE,KAAK,IAAI,EAAE;QAC7D,MAAM,EAAE,GAAG,MAAM,OAAO,CAAiB,IAAI,CAAA;;;;;;;;;SAS5C,CAAC,CAAC;QAEH,MAAM,OAAO,GAAG,EAAE,CAAC,aAAa,CAAC,kBAAkB,CAAgB,CAAC;QACpE,MAAM,OAAO,GAAG,EAAE,CAAC,aAAa,CAAC,YAAY,CAAY,CAAC;QAC1D,MAAM,SAAS,GAAI,OAA6C;aAC3D,UAAU,CAAC;QAChB,OAAO,CAAC,YAAY,CAAC,kBAAkB,EAAE,SAAS,CAAC,CAAC;QAEpD,MAAM,cAAc,CAAC,EAAE,CAAC,CAAC;QAEzB,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,kBAAkB,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QACrE,MAAM,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,SAAS,CAAC;QAChC,MAAM,CAAC,EAAE,CAAC,UAAU,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAEnD,MAAM,MAAM,GAAG,QAAQ,CAAC,EAAE,EAAE,WAAW,CAAC,CAAC;QACzC,OAAO,CAAC,aAAa,CACjB,IAAI,UAAU,CAAC,SAAS,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAC/D,CAAC;QACF,MAAM,MAAM,CAAC;QAEb,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,kBAAkB,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QAErE,MAAM,MAAM,GAAG,QAAQ,CAAC,EAAE,EAAE,WAAW,CAAC,CAAC;QACzC,OAAO,CAAC,aAAa,CACjB,IAAI,UAAU,CAAC,UAAU,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAChE,CAAC;QACF,MAAM,MAAM,CAAC;QAEb,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,kBAAkB,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;IACzE,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,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 {\n    elementUpdated,\n    expect,\n    fixture,\n    html,\n    oneEvent,\n    waitUntil,\n} from '@open-wc/testing';\nimport '@spectrum-web-components/tooltip/sp-tooltip.js';\nimport '@spectrum-web-components/action-button/sp-action-button.js';\nimport { OverlayTrigger } from '..';\nimport '@spectrum-web-components/overlay/overlay-trigger.js';\nimport { a11ySnapshot, findAccessibilityNode } from '@web/test-runner-commands';\nimport { Tooltip } from '@spectrum-web-components/tooltip';\n\ndescribe('Overlay Trigger - Lifecycle Methods', () => {\n    it('calls the overlay lifecycle (willOpen/Close)', async () => {\n        const el = await fixture<OverlayTrigger>(html`\n            <overlay-trigger placement=\"right-start\">\n                <sp-action-button slot=\"trigger\">\n                    Button with Tooltip\n                </sp-action-button>\n                <sp-tooltip slot=\"hover-content\">\n                    Described by this content on focus/hover. 1\n                </sp-tooltip>\n            </overlay-trigger>\n        `);\n\n        await elementUpdated(el);\n\n        expect(el.open).to.be.undefined;\n        expect(el.childNodes.length).to.equal(5);\n        const trigger = el.querySelector('[slot=\"trigger\"]') as HTMLElement;\n        type DescribedNode = {\n            name: string;\n            description: string;\n        };\n        let snapshot = (await a11ySnapshot({})) as unknown as DescribedNode & {\n            children: DescribedNode[];\n        };\n        expect(\n            findAccessibilityNode<DescribedNode>(\n                snapshot,\n                (node) =>\n                    node.name === 'Button with Tooltip' &&\n                    typeof node.description === 'undefined'\n            ),\n            '`name`ed with no `description`'\n        );\n        const opened = oneEvent(el, 'sp-opened');\n        trigger.dispatchEvent(\n            new FocusEvent('focusin', { bubbles: true, composed: true })\n        );\n        await opened;\n\n        expect(el.open).to.equal('hover');\n        snapshot = (await a11ySnapshot({})) as unknown as DescribedNode & {\n            children: DescribedNode[];\n        };\n\n        expect(el.childNodes.length).to.equal(6);\n        expect(\n            findAccessibilityNode<DescribedNode>(\n                snapshot,\n                (node) =>\n                    node.name === 'Button with Tooltip' &&\n                    node.description ===\n                        'Described by this content on focus/hover.'\n            ),\n            '`name`ed with `description`'\n        );\n\n        const closed = oneEvent(el, 'sp-closed');\n        trigger.dispatchEvent(\n            new FocusEvent('focusout', { bubbles: true, composed: true })\n        );\n        await closed;\n        await elementUpdated(el);\n\n        await waitUntil(() => el.open === null);\n        expect(el.childNodes.length).to.equal(5);\n    });\n    it('calls the overlay lifecycle (willOpen/openCanceled)', async () => {\n        const el = await fixture<OverlayTrigger>(html`\n            <overlay-trigger placement=\"right-start\">\n                <sp-action-button slot=\"trigger\">\n                    Button with Tooltip\n                </sp-action-button>\n                <sp-tooltip slot=\"hover-content\" delayed>\n                    Described by this content on focus/hover. 2\n                </sp-tooltip>\n            </overlay-trigger>\n        `);\n\n        await elementUpdated(el);\n\n        expect(el.open).to.be.undefined;\n        expect(el.childNodes.length, 'always').to.equal(5);\n        const trigger = el.querySelector('[slot=\"trigger\"]') as HTMLElement;\n        trigger.dispatchEvent(\n            new FocusEvent('focusin', { bubbles: true, composed: true })\n        );\n        await elementUpdated(el);\n        trigger.dispatchEvent(\n            new FocusEvent('focusout', { bubbles: true, composed: true })\n        );\n        await elementUpdated(el);\n\n        await waitUntil(() => {\n            return el.open === null;\n        }, 'open');\n        await elementUpdated(el);\n        await waitUntil(() => {\n            return el.childNodes.length === 5;\n        }, 'children');\n    });\n    it('gardens `aria-describedby` in its target', async () => {\n        const el = await fixture<OverlayTrigger>(html`\n            <overlay-trigger placement=\"right-start\">\n                <sp-action-button slot=\"trigger\" aria-describedby=\"descriptor\">\n                    Button with Tooltip\n                </sp-action-button>\n                <sp-tooltip slot=\"hover-content\" delayed>\n                    Described by this content on focus/hover. 2\n                </sp-tooltip>\n            </overlay-trigger>\n            <div id=\"descriptor\">I'm a description!</div>\n        `);\n\n        const trigger = el.querySelector('[slot=\"trigger\"]') as HTMLElement;\n        const tooltip = el.querySelector('sp-tooltip') as Tooltip;\n\n        await elementUpdated(el);\n\n        expect(trigger.getAttribute('aria-describedby')).to.equal('descriptor');\n        expect(el.open).to.be.undefined;\n        expect(el.childNodes.length, 'always').to.equal(5);\n\n        const opened = oneEvent(el, 'sp-opened');\n        trigger.dispatchEvent(\n            new FocusEvent('focusin', { bubbles: true, composed: true })\n        );\n        await opened;\n\n        expect(trigger.getAttribute('aria-describedby')).to.equal(\n            `descriptor ${\n                (tooltip as unknown as { _tooltipId: string })._tooltipId\n            }`\n        );\n\n        const closed = oneEvent(el, 'sp-closed');\n        trigger.dispatchEvent(\n            new FocusEvent('focusout', { bubbles: true, composed: true })\n        );\n        await closed;\n\n        expect(trigger.getAttribute('aria-describedby')).to.equal('descriptor');\n    });\n    it('adds and removes `aria-describedby` attribute', async () => {\n        const el = await fixture<OverlayTrigger>(html`\n            <overlay-trigger placement=\"right-start\">\n                <sp-action-button slot=\"trigger\">\n                    Button with Tooltip\n                </sp-action-button>\n                <sp-tooltip slot=\"hover-content\" delayed>\n                    Described by this content on focus/hover. 2\n                </sp-tooltip>\n            </overlay-trigger>\n        `);\n\n        const trigger = el.querySelector('[slot=\"trigger\"]') as HTMLElement;\n        const tooltip = el.querySelector('sp-tooltip') as Tooltip;\n\n        await elementUpdated(el);\n\n        expect(trigger.hasAttribute('aria-describedby')).to.be.false;\n        expect(el.open).to.be.undefined;\n        expect(el.childNodes.length, 'always').to.equal(5);\n\n        const opened = oneEvent(el, 'sp-opened');\n        trigger.dispatchEvent(\n            new FocusEvent('focusin', { bubbles: true, composed: true })\n        );\n        await opened;\n\n        expect(trigger.getAttribute('aria-describedby')).to.equal(\n            `${(tooltip as unknown as { _tooltipId: string })._tooltipId}`\n        );\n\n        const closed = oneEvent(el, 'sp-closed');\n        trigger.dispatchEvent(\n            new FocusEvent('focusout', { bubbles: true, composed: true })\n        );\n        await closed;\n\n        expect(trigger.hasAttribute('aria-describedby')).to.be.false;\n    });\n    it('does not duplicate `aria-describedby` attribute', async () => {\n        const el = await fixture<OverlayTrigger>(html`\n            <overlay-trigger placement=\"right-start\">\n                <sp-action-button slot=\"trigger\">\n                    Button with Tooltip\n                </sp-action-button>\n                <sp-tooltip slot=\"hover-content\" delayed>\n                    Described by this content on focus/hover. 2\n                </sp-tooltip>\n            </overlay-trigger>\n        `);\n\n        const trigger = el.querySelector('[slot=\"trigger\"]') as HTMLElement;\n        const tooltip = el.querySelector('sp-tooltip') as Tooltip;\n        const tooltipId = (tooltip as unknown as { _tooltipId: string })\n            ._tooltipId;\n        trigger.setAttribute('aria-describedby', tooltipId);\n\n        await elementUpdated(el);\n\n        expect(trigger.getAttribute('aria-describedby')).to.equal(tooltipId);\n        expect(el.open).to.be.undefined;\n        expect(el.childNodes.length, 'always').to.equal(5);\n\n        const opened = oneEvent(el, 'sp-opened');\n        trigger.dispatchEvent(\n            new FocusEvent('focusin', { bubbles: true, composed: true })\n        );\n        await opened;\n\n        expect(trigger.getAttribute('aria-describedby')).to.equal(tooltipId);\n\n        const closed = oneEvent(el, 'sp-closed');\n        trigger.dispatchEvent(\n            new FocusEvent('focusout', { bubbles: true, composed: true })\n        );\n        await closed;\n\n        expect(trigger.getAttribute('aria-describedby')).to.equal(tooltipId);\n    });\n});\n"]}

package/test/overlay-timer.test.js

@@ -0,0 +1,129 @@
+/*
+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 { useFakeTimers } from 'sinon';
+import { OverlayTimer } from '../src/overlay-timer.js';
+import { expect } from '@open-wc/testing';
+describe('Overlays timer', () => {
+    let clock;
+    beforeEach(() => {
+        clock = useFakeTimers();
+    });
+    afterEach(() => {
+        clock.restore();
+    });
+    it('should resolve after warmup', async () => {
+        const timer = new OverlayTimer({
+            warmUpDelay: 500,
+            coolDownDelay: 500,
+        });
+        const element = document.createElement('div');
+        const promise = timer.openTimer(element);
+        clock.next();
+        expect(clock.now).to.equal(500);
+        const cancelled = await promise;
+        expect(cancelled).to.be.false;
+    });
+    it('should resolve true when cancelled', async () => {
+        const timer = new OverlayTimer({
+            warmUpDelay: 500,
+            coolDownDelay: 500,
+        });
+        const element = document.createElement('div');
+        const promise = timer.openTimer(element);
+        clock.tick(10);
+        timer.close(element);
+        clock.next();
+        const cancelled = await promise;
+        expect(cancelled).to.be.true;
+    });
+    it('should resolve cancelled when opening new overlay', async () => {
+        const timer = new OverlayTimer({
+            warmUpDelay: 500,
+            coolDownDelay: 500,
+        });
+        const element1 = document.createElement('div');
+        const element2 = document.createElement('div');
+        const promise1 = timer.openTimer(element1);
+        clock.tick(10);
+        const promise2 = timer.openTimer(element2);
+        clock.tick(10);
+        let cancelled = await promise1;
+        expect(cancelled).to.be.true;
+        clock.next();
+        cancelled = await promise2;
+        expect(cancelled).to.be.false;
+        expect(clock.now).to.equal(510);
+    });
+    it('should cooldown after closing overlay', async () => {
+        const timer = new OverlayTimer({
+            warmUpDelay: 500,
+            coolDownDelay: 500,
+        });
+        const element = document.createElement('div');
+        let promise = timer.openTimer(element);
+        clock.next();
+        timer.close(element);
+        clock.next();
+        expect(clock.now).to.equal(1000);
+        promise = timer.openTimer(element);
+        clock.next();
+        const cancelled = await promise;
+        expect(cancelled).to.be.false;
+        expect(clock.now).to.equal(1500);
+    });
+    it('should open overlay quickly when hot', async () => {
+        const timer = new OverlayTimer({
+            warmUpDelay: 500,
+            coolDownDelay: 500,
+        });
+        const element = document.createElement('div');
+        let promise = timer.openTimer(element);
+        clock.next();
+        timer.close(element);
+        clock.tick(1);
+        promise = timer.openTimer(element);
+        clock.next();
+        const cancelled = await promise;
+        expect(cancelled).to.be.false;
+        expect(clock.now).to.equal(501);
+    });
+    it('should cooldown after opening and closing overlay multiple times', async () => {
+        const timer = new OverlayTimer({
+            warmUpDelay: 500,
+            coolDownDelay: 500,
+        });
+        const element = document.createElement('div');
+        let promise = timer.openTimer(element);
+        clock.next();
+        expect(clock.now).to.equal(500);
+        timer.close(element);
+        clock.tick(1);
+        for (let i = 0; i < 10; i++) {
+            const element = document.createElement('div');
+            promise = timer.openTimer(element);
+            clock.next();
+            const cancelled = await promise;
+            expect(cancelled).to.be.false;
+            timer.close(element);
+            clock.tick(1);
+        }
+        // Wait for cooldown
+        clock.next();
+        expect(clock.now).to.equal(1010);
+        promise = timer.openTimer(element);
+        clock.next();
+        const cancelled = await promise;
+        expect(cancelled).to.be.false;
+        expect(clock.now).to.equal(1510);
+    });
+});
+//# sourceMappingURL=overlay-timer.test.js.map

package/test/overlay-timer.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"overlay-timer.test.js","sourceRoot":"","sources":["overlay-timer.test.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;EAUE;AAEF,OAAO,EAAmB,aAAa,EAAE,MAAM,OAAO,CAAC;AACvD,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AACvD,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAE1C,QAAQ,CAAC,gBAAgB,EAAE,GAAG,EAAE;IAC5B,IAAI,KAAsB,CAAC;IAE3B,UAAU,CAAC,GAAG,EAAE;QACZ,KAAK,GAAG,aAAa,EAAE,CAAC;IAC5B,CAAC,CAAC,CAAC;IAEH,SAAS,CAAC,GAAG,EAAE;QACX,KAAK,CAAC,OAAO,EAAE,CAAC;IACpB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6BAA6B,EAAE,KAAK,IAAI,EAAE;QACzC,MAAM,KAAK,GAAG,IAAI,YAAY,CAAC;YAC3B,WAAW,EAAE,GAAG;YAChB,aAAa,EAAE,GAAG;SACrB,CAAC,CAAC;QACH,MAAM,OAAO,GAAG,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;QAC9C,MAAM,OAAO,GAAG,KAAK,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;QACzC,KAAK,CAAC,IAAI,EAAE,CAAC;QACb,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAChC,MAAM,SAAS,GAAG,MAAM,OAAO,CAAC;QAChC,MAAM,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC;IAClC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,oCAAoC,EAAE,KAAK,IAAI,EAAE;QAChD,MAAM,KAAK,GAAG,IAAI,YAAY,CAAC;YAC3B,WAAW,EAAE,GAAG;YAChB,aAAa,EAAE,GAAG;SACrB,CAAC,CAAC;QACH,MAAM,OAAO,GAAG,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;QAC9C,MAAM,OAAO,GAAG,KAAK,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;QACzC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACf,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACrB,KAAK,CAAC,IAAI,EAAE,CAAC;QACb,MAAM,SAAS,GAAG,MAAM,OAAO,CAAC;QAChC,MAAM,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC;IACjC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,mDAAmD,EAAE,KAAK,IAAI,EAAE;QAC/D,MAAM,KAAK,GAAG,IAAI,YAAY,CAAC;YAC3B,WAAW,EAAE,GAAG;YAChB,aAAa,EAAE,GAAG;SACrB,CAAC,CAAC;QACH,MAAM,QAAQ,GAAG,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;QAC/C,MAAM,QAAQ,GAAG,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;QAC/C,MAAM,QAAQ,GAAG,KAAK,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;QAC3C,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACf,MAAM,QAAQ,GAAG,KAAK,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;QAC3C,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACf,IAAI,SAAS,GAAG,MAAM,QAAQ,CAAC;QAC/B,MAAM,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC;QAC7B,KAAK,CAAC,IAAI,EAAE,CAAC;QACb,SAAS,GAAG,MAAM,QAAQ,CAAC;QAC3B,MAAM,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC;QAC9B,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACpC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uCAAuC,EAAE,KAAK,IAAI,EAAE;QACnD,MAAM,KAAK,GAAG,IAAI,YAAY,CAAC;YAC3B,WAAW,EAAE,GAAG;YAChB,aAAa,EAAE,GAAG;SACrB,CAAC,CAAC;QACH,MAAM,OAAO,GAAG,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;QAC9C,IAAI,OAAO,GAAG,KAAK,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;QACvC,KAAK,CAAC,IAAI,EAAE,CAAC;QACb,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACrB,KAAK,CAAC,IAAI,EAAE,CAAC;QACb,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACjC,OAAO,GAAG,KAAK,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;QACnC,KAAK,CAAC,IAAI,EAAE,CAAC;QACb,MAAM,SAAS,GAAG,MAAM,OAAO,CAAC;QAChC,MAAM,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC;QAC9B,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IACrC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sCAAsC,EAAE,KAAK,IAAI,EAAE;QAClD,MAAM,KAAK,GAAG,IAAI,YAAY,CAAC;YAC3B,WAAW,EAAE,GAAG;YAChB,aAAa,EAAE,GAAG;SACrB,CAAC,CAAC;QACH,MAAM,OAAO,GAAG,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;QAC9C,IAAI,OAAO,GAAG,KAAK,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;QACvC,KAAK,CAAC,IAAI,EAAE,CAAC;QACb,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACrB,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACd,OAAO,GAAG,KAAK,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;QACnC,KAAK,CAAC,IAAI,EAAE,CAAC;QACb,MAAM,SAAS,GAAG,MAAM,OAAO,CAAC;QAChC,MAAM,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC;QAC9B,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACpC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kEAAkE,EAAE,KAAK,IAAI,EAAE;QAC9E,MAAM,KAAK,GAAG,IAAI,YAAY,CAAC;YAC3B,WAAW,EAAE,GAAG;YAChB,aAAa,EAAE,GAAG;SACrB,CAAC,CAAC;QACH,MAAM,OAAO,GAAG,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;QAC9C,IAAI,OAAO,GAAG,KAAK,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;QACvC,KAAK,CAAC,IAAI,EAAE,CAAC;QACb,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAChC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACrB,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAEd,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,EAAE,EAAE;YACzB,MAAM,OAAO,GAAG,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;YAC9C,OAAO,GAAG,KAAK,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;YACnC,KAAK,CAAC,IAAI,EAAE,CAAC;YACb,MAAM,SAAS,GAAG,MAAM,OAAO,CAAC;YAChC,MAAM,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC;YAC9B,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YACrB,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;SACjB;QAED,oBAAoB;QACpB,KAAK,CAAC,IAAI,EAAE,CAAC;QACb,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACjC,OAAO,GAAG,KAAK,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;QACnC,KAAK,CAAC,IAAI,EAAE,CAAC;QACb,MAAM,SAAS,GAAG,MAAM,OAAO,CAAC;QAChC,MAAM,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC;QAC9B,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IACrC,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,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*/\n\nimport { SinonFakeTimers, useFakeTimers } from 'sinon';\nimport { OverlayTimer } from '../src/overlay-timer.js';\nimport { expect } from '@open-wc/testing';\n\ndescribe('Overlays timer', () => {\n    let clock: SinonFakeTimers;\n\n    beforeEach(() => {\n        clock = useFakeTimers();\n    });\n\n    afterEach(() => {\n        clock.restore();\n    });\n\n    it('should resolve after warmup', async () => {\n        const timer = new OverlayTimer({\n            warmUpDelay: 500,\n            coolDownDelay: 500,\n        });\n        const element = document.createElement('div');\n        const promise = timer.openTimer(element);\n        clock.next();\n        expect(clock.now).to.equal(500);\n        const cancelled = await promise;\n        expect(cancelled).to.be.false;\n    });\n\n    it('should resolve true when cancelled', async () => {\n        const timer = new OverlayTimer({\n            warmUpDelay: 500,\n            coolDownDelay: 500,\n        });\n        const element = document.createElement('div');\n        const promise = timer.openTimer(element);\n        clock.tick(10);\n        timer.close(element);\n        clock.next();\n        const cancelled = await promise;\n        expect(cancelled).to.be.true;\n    });\n\n    it('should resolve cancelled when opening new overlay', async () => {\n        const timer = new OverlayTimer({\n            warmUpDelay: 500,\n            coolDownDelay: 500,\n        });\n        const element1 = document.createElement('div');\n        const element2 = document.createElement('div');\n        const promise1 = timer.openTimer(element1);\n        clock.tick(10);\n        const promise2 = timer.openTimer(element2);\n        clock.tick(10);\n        let cancelled = await promise1;\n        expect(cancelled).to.be.true;\n        clock.next();\n        cancelled = await promise2;\n        expect(cancelled).to.be.false;\n        expect(clock.now).to.equal(510);\n    });\n\n    it('should cooldown after closing overlay', async () => {\n        const timer = new OverlayTimer({\n            warmUpDelay: 500,\n            coolDownDelay: 500,\n        });\n        const element = document.createElement('div');\n        let promise = timer.openTimer(element);\n        clock.next();\n        timer.close(element);\n        clock.next();\n        expect(clock.now).to.equal(1000);\n        promise = timer.openTimer(element);\n        clock.next();\n        const cancelled = await promise;\n        expect(cancelled).to.be.false;\n        expect(clock.now).to.equal(1500);\n    });\n\n    it('should open overlay quickly when hot', async () => {\n        const timer = new OverlayTimer({\n            warmUpDelay: 500,\n            coolDownDelay: 500,\n        });\n        const element = document.createElement('div');\n        let promise = timer.openTimer(element);\n        clock.next();\n        timer.close(element);\n        clock.tick(1);\n        promise = timer.openTimer(element);\n        clock.next();\n        const cancelled = await promise;\n        expect(cancelled).to.be.false;\n        expect(clock.now).to.equal(501);\n    });\n\n    it('should cooldown after opening and closing overlay multiple times', async () => {\n        const timer = new OverlayTimer({\n            warmUpDelay: 500,\n            coolDownDelay: 500,\n        });\n        const element = document.createElement('div');\n        let promise = timer.openTimer(element);\n        clock.next();\n        expect(clock.now).to.equal(500);\n        timer.close(element);\n        clock.tick(1);\n\n        for (let i = 0; i < 10; i++) {\n            const element = document.createElement('div');\n            promise = timer.openTimer(element);\n            clock.next();\n            const cancelled = await promise;\n            expect(cancelled).to.be.false;\n            timer.close(element);\n            clock.tick(1);\n        }\n\n        // Wait for cooldown\n        clock.next();\n        expect(clock.now).to.equal(1010);\n        promise = timer.openTimer(element);\n        clock.next();\n        const cancelled = await promise;\n        expect(cancelled).to.be.false;\n        expect(clock.now).to.equal(1510);\n    });\n});\n"]}

package/test/overlay-trigger-click.test.js

@@ -0,0 +1,76 @@
+/*
+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 { elementUpdated, expect, fixture, html, waitUntil, } from '@open-wc/testing';
+import '@spectrum-web-components/popover/sp-popover.js';
+import '@spectrum-web-components/action-button/sp-action-button.js';
+import '@spectrum-web-components/icons-workflow/icons/sp-icon-magnify.js';
+import '@spectrum-web-components/popover/sp-popover.js';
+import '@spectrum-web-components/overlay/overlay-trigger.js';
+import { spy } from 'sinon';
+describe('Overlay Trigger - Click', () => {
+    it('displays `click` declaratively', async () => {
+        const openedSpy = spy();
+        const closedSpy = spy();
+        const el = await fixture((() => html `
+                <overlay-trigger
+                    placement="right-start"
+                    open="click"
+                    @sp-opened=${() => openedSpy()}
+                    @sp-closed=${() => closedSpy()}
+                >
+                    <sp-action-button slot="trigger">
+                        <sp-icon-magnify slot="icon"></sp-icon-magnify>
+                    </sp-action-button>
+                    <sp-popover slot="click-content" tip></sp-popover>
+                </overlay-trigger>
+            `)());
+        await elementUpdated(el);
+        await waitUntil(() => openedSpy.calledOnce, 'click content projected to overlay', { timeout: 2000 });
+        el.removeAttribute('open');
+        await elementUpdated(el);
+        await waitUntil(() => closedSpy.calledOnce, 'click content returned', {
+            timeout: 2000,
+        });
+    });
+    it('opens a second time', async () => {
+        const openedSpy = spy();
+        const closedSpy = spy();
+        const el = await fixture(html `
+            <overlay-trigger
+                placement="right-start"
+                type="modal"
+                open="click"
+                @sp-opened=${() => openedSpy()}
+                @sp-closed=${() => closedSpy()}
+            >
+                <sp-action-button slot="trigger">
+                    <sp-icon-magnify slot="icon"></sp-icon-magnify>
+                </sp-action-button>
+                <sp-popover slot="click-content" tip></sp-popover>
+            </overlay-trigger>
+        `);
+        await elementUpdated(el);
+        const trigger = el.querySelector('[slot=trigger]');
+        await waitUntil(() => openedSpy.calledOnce, 'click content projected to overlay', { timeout: 2000 });
+        expect(el.open).to.equal('click');
+        el.removeAttribute('open');
+        await elementUpdated(el);
+        await waitUntil(() => closedSpy.calledOnce, 'click content returned', {
+            timeout: 2000,
+        });
+        expect(el.open).to.be.null;
+        trigger.click();
+        await waitUntil(() => openedSpy.callCount === 2, 'click content projected to overlay, again', { timeout: 2000 });
+        expect(el.open).to.equal('click');
+    });
+});
+//# sourceMappingURL=overlay-trigger-click.test.js.map

package/test/overlay-trigger-click.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"overlay-trigger-click.test.js","sourceRoot":"","sources":["overlay-trigger-click.test.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;EAUE;AACF,OAAO,EACH,cAAc,EACd,MAAM,EACN,OAAO,EACP,IAAI,EACJ,SAAS,GACZ,MAAM,kBAAkB,CAAC;AAC1B,OAAO,gDAAgD,CAAC;AACxD,OAAO,4DAA4D,CAAC;AACpE,OAAO,kEAAkE,CAAC;AAC1E,OAAO,gDAAgD,CAAC;AAExD,OAAO,qDAAqD,CAAC;AAC7D,OAAO,EAAE,GAAG,EAAE,MAAM,OAAO,CAAC;AAG5B,QAAQ,CAAC,yBAAyB,EAAE,GAAG,EAAE;IACrC,EAAE,CAAC,gCAAgC,EAAE,KAAK,IAAI,EAAE;QAC5C,MAAM,SAAS,GAAG,GAAG,EAAE,CAAC;QACxB,MAAM,SAAS,GAAG,GAAG,EAAE,CAAC;QACxB,MAAM,EAAE,GAAG,MAAM,OAAO,CACpB,CAAC,GAAG,EAAE,CAAC,IAAI,CAAA;;;;iCAIU,GAAG,EAAE,CAAC,SAAS,EAAE;iCACjB,GAAG,EAAE,CAAC,SAAS,EAAE;;;;;;;aAOrC,CAAC,EAAE,CACP,CAAC;QACF,MAAM,cAAc,CAAC,EAAE,CAAC,CAAC;QAEzB,MAAM,SAAS,CACX,GAAG,EAAE,CAAC,SAAS,CAAC,UAAU,EAC1B,oCAAoC,EACpC,EAAE,OAAO,EAAE,IAAI,EAAE,CACpB,CAAC;QAEF,EAAE,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;QAC3B,MAAM,cAAc,CAAC,EAAE,CAAC,CAAC;QAEzB,MAAM,SAAS,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,UAAU,EAAE,wBAAwB,EAAE;YAClE,OAAO,EAAE,IAAI;SAChB,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,qBAAqB,EAAE,KAAK,IAAI,EAAE;QACjC,MAAM,SAAS,GAAG,GAAG,EAAE,CAAC;QACxB,MAAM,SAAS,GAAG,GAAG,EAAE,CAAC;QACxB,MAAM,EAAE,GAAG,MAAM,OAAO,CAAiB,IAAI,CAAA;;;;;6BAKxB,GAAG,EAAE,CAAC,SAAS,EAAE;6BACjB,GAAG,EAAE,CAAC,SAAS,EAAE;;;;;;;SAOrC,CAAC,CAAC;QACH,MAAM,cAAc,CAAC,EAAE,CAAC,CAAC;QACzB,MAAM,OAAO,GAAG,EAAE,CAAC,aAAa,CAAC,gBAAgB,CAAiB,CAAC;QAEnE,MAAM,SAAS,CACX,GAAG,EAAE,CAAC,SAAS,CAAC,UAAU,EAC1B,oCAAoC,EACpC,EAAE,OAAO,EAAE,IAAI,EAAE,CACpB,CAAC;QACF,MAAM,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAElC,EAAE,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;QAC3B,MAAM,cAAc,CAAC,EAAE,CAAC,CAAC;QAEzB,MAAM,SAAS,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,UAAU,EAAE,wBAAwB,EAAE;YAClE,OAAO,EAAE,IAAI;SAChB,CAAC,CAAC;QAEH,MAAM,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC;QAE3B,OAAO,CAAC,KAAK,EAAE,CAAC;QAChB,MAAM,SAAS,CACX,GAAG,EAAE,CAAC,SAAS,CAAC,SAAS,KAAK,CAAC,EAC/B,2CAA2C,EAC3C,EAAE,OAAO,EAAE,IAAI,EAAE,CACpB,CAAC;QACF,MAAM,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IACtC,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,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 {\n    elementUpdated,\n    expect,\n    fixture,\n    html,\n    waitUntil,\n} from '@open-wc/testing';\nimport '@spectrum-web-components/popover/sp-popover.js';\nimport '@spectrum-web-components/action-button/sp-action-button.js';\nimport '@spectrum-web-components/icons-workflow/icons/sp-icon-magnify.js';\nimport '@spectrum-web-components/popover/sp-popover.js';\nimport { OverlayTrigger } from '..';\nimport '@spectrum-web-components/overlay/overlay-trigger.js';\nimport { spy } from 'sinon';\nimport { ActionButton } from '@spectrum-web-components/action-button';\n\ndescribe('Overlay Trigger - Click', () => {\n    it('displays `click` declaratively', async () => {\n        const openedSpy = spy();\n        const closedSpy = spy();\n        const el = await fixture<OverlayTrigger>(\n            (() => html`\n                <overlay-trigger\n                    placement=\"right-start\"\n                    open=\"click\"\n                    @sp-opened=${() => openedSpy()}\n                    @sp-closed=${() => closedSpy()}\n                >\n                    <sp-action-button slot=\"trigger\">\n                        <sp-icon-magnify slot=\"icon\"></sp-icon-magnify>\n                    </sp-action-button>\n                    <sp-popover slot=\"click-content\" tip></sp-popover>\n                </overlay-trigger>\n            `)()\n        );\n        await elementUpdated(el);\n\n        await waitUntil(\n            () => openedSpy.calledOnce,\n            'click content projected to overlay',\n            { timeout: 2000 }\n        );\n\n        el.removeAttribute('open');\n        await elementUpdated(el);\n\n        await waitUntil(() => closedSpy.calledOnce, 'click content returned', {\n            timeout: 2000,\n        });\n    });\n    it('opens a second time', async () => {\n        const openedSpy = spy();\n        const closedSpy = spy();\n        const el = await fixture<OverlayTrigger>(html`\n            <overlay-trigger\n                placement=\"right-start\"\n                type=\"modal\"\n                open=\"click\"\n                @sp-opened=${() => openedSpy()}\n                @sp-closed=${() => closedSpy()}\n            >\n                <sp-action-button slot=\"trigger\">\n                    <sp-icon-magnify slot=\"icon\"></sp-icon-magnify>\n                </sp-action-button>\n                <sp-popover slot=\"click-content\" tip></sp-popover>\n            </overlay-trigger>\n        `);\n        await elementUpdated(el);\n        const trigger = el.querySelector('[slot=trigger]') as ActionButton;\n\n        await waitUntil(\n            () => openedSpy.calledOnce,\n            'click content projected to overlay',\n            { timeout: 2000 }\n        );\n        expect(el.open).to.equal('click');\n\n        el.removeAttribute('open');\n        await elementUpdated(el);\n\n        await waitUntil(() => closedSpy.calledOnce, 'click content returned', {\n            timeout: 2000,\n        });\n\n        expect(el.open).to.be.null;\n\n        trigger.click();\n        await waitUntil(\n            () => openedSpy.callCount === 2,\n            'click content projected to overlay, again',\n            { timeout: 2000 }\n        );\n        expect(el.open).to.equal('click');\n    });\n});\n"]}

package/test/overlay-trigger-extended.test.js

@@ -0,0 +1,215 @@
+/*
+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 { elementUpdated, expect, fixture, html, nextFrame, oneEvent, waitUntil, } from '@open-wc/testing';
+import '../overlay-trigger.js';
+import '@spectrum-web-components/button/sp-button.js';
+import '@spectrum-web-components/popover/sp-popover.js';
+import '@spectrum-web-components/textfield/sp-textfield.js';
+import { sendMouse } from '../../../test/plugins/browser.js';
+const initTest = async (styles = html ``) => {
+    const test = await fixture(html `
+            <div class="container">
+                <style>
+                    .container {
+                        display: flex;
+                        align-items: center;
+                        justify-content: center;
+                    }
+                </style>
+                ${styles}
+                <overlay-trigger type="modal" id="trigger" placement="top">
+                    <sp-button
+                        id="outer-button"
+                        variant="primary"
+                        slot="trigger"
+                    >
+                        Show Popover
+                    </sp-button>
+                    <sp-popover
+                        id="outer-popover"
+                        dialog
+                        slot="click-content"
+                        direction="bottom"
+                        tip
+                        open
+                        tabindex="0"
+                        placement="top"
+                    >
+                        This is the overlay content.
+                    </sp-popover>
+                </overlay-trigger>
+            </div>
+        `);
+    return {
+        overlayTrigger: test.querySelector('overlay-trigger'),
+        button: test.querySelector('sp-button'),
+        popover: test.querySelector('sp-popover'),
+    };
+};
+describe('Overlay Trigger - extended', () => {
+    let overlayTrigger;
+    let button;
+    let popover;
+    afterEach(async () => {
+        if (overlayTrigger.open) {
+            const closed = oneEvent(overlayTrigger, 'sp-closed');
+            overlayTrigger.open = undefined;
+            await closed;
+        }
+    });
+    it('manages `placement` on open', async () => {
+        ({ overlayTrigger, button, popover } = await initTest());
+        expect(popover.placement).to.equal('top');
+        const open = oneEvent(overlayTrigger, 'sp-opened');
+        button.click();
+        await open;
+        expect(popover.placement).to.equal('bottom');
+        const close = oneEvent(overlayTrigger, 'sp-closed');
+        overlayTrigger.open = undefined;
+        await close;
+        expect(popover.placement).to.equal('top');
+    });
+    it('manages `placement` on scroll', async () => {
+        ({ overlayTrigger, button, popover } = await initTest(html `
+            <style>
+                sp-button {
+                    margin: 100vh 0;
+                    transform: translateY(-100%);
+                }
+            </style>
+        `));
+        expect(popover.placement).to.equal('top');
+        const open = oneEvent(overlayTrigger, 'sp-opened');
+        button.click();
+        await open;
+        expect(popover.placement).to.equal('top');
+        const { scrollHeight } = document.documentElement;
+        document.documentElement.scrollTop = scrollHeight / 2;
+        // one frame for scroll to trigger
+        await nextFrame();
+        // one frame for the UI to update
+        await nextFrame();
+        // _then_ we test...
+        expect(popover.placement).to.equal('bottom');
+    });
+    it('occludes content behind the overlay', async () => {
+        ({ overlayTrigger, button, popover } = await initTest());
+        const textfield = document.createElement('sp-textfield');
+        document.body.append(textfield);
+        const boundingRect = textfield.getBoundingClientRect();
+        expect(document.activeElement).to.not.equal(textfield);
+        await sendMouse({
+            steps: [
+                {
+                    type: 'click',
+                    position: [
+                        boundingRect.left + boundingRect.width / 2,
+                        boundingRect.top + boundingRect.height / 2,
+                    ],
+                },
+            ],
+        });
+        expect(document.activeElement).to.equal(textfield);
+        expect(popover.placement).to.equal('top');
+        const open = oneEvent(overlayTrigger, 'sp-opened');
+        button.click();
+        await open;
+        expect(overlayTrigger.open).to.equal('click');
+        expect(popover.placement).to.equal('bottom');
+        const close = oneEvent(overlayTrigger, 'sp-closed');
+        await sendMouse({
+            steps: [
+                {
+                    type: 'click',
+                    position: [
+                        boundingRect.left + boundingRect.width / 2,
+                        boundingRect.top + boundingRect.height / 2,
+                    ],
+                },
+            ],
+        });
+        await close;
+        expect(overlayTrigger.open).to.be.null;
+        expect(document.activeElement).to.not.equal(textfield);
+        await sendMouse({
+            steps: [
+                {
+                    type: 'click',
+                    position: [
+                        boundingRect.left + boundingRect.width / 2,
+                        boundingRect.top + boundingRect.height / 2,
+                    ],
+                },
+            ],
+        });
+        expect(document.activeElement).to.equal(textfield);
+        textfield.remove();
+    });
+    it('occludes wheel interactions behind the overlay', async () => {
+        ({ overlayTrigger, button, popover } = await initTest());
+        const scrollingArea = document.createElement('div');
+        Object.assign(scrollingArea.style, {
+            width: '100px',
+            height: '100px',
+            overflow: 'auto',
+        });
+        const content = Array(100).fill('This is content within my box that will scroll.');
+        scrollingArea.textContent = content.join(' ');
+        document.body.append(scrollingArea);
+        await nextFrame();
+        const boundingRect = scrollingArea.getBoundingClientRect();
+        expect(scrollingArea.scrollTop).to.equal(0);
+        const distance = 1;
+        await sendMouse({
+            steps: [
+                {
+                    type: 'move',
+                    position: [
+                        boundingRect.left + boundingRect.width / 2,
+                        boundingRect.top + boundingRect.height / 2,
+                    ],
+                },
+            ],
+        });
+        await sendMouse({
+            steps: [
+                {
+                    type: 'wheel',
+                    position: [0, distance],
+                },
+            ],
+        });
+        // wait for scroll to complete
+        await waitUntil(() => scrollingArea.scrollTop === distance, `scroll went to ${distance}`);
+        expect(scrollingArea.scrollTop).to.equal(distance);
+        expect(popover.placement).to.equal('top');
+        const open = oneEvent(overlayTrigger, 'sp-opened');
+        button.click();
+        await open;
+        const activeOverlay = document.querySelector('active-overlay');
+        await elementUpdated(activeOverlay);
+        expect(overlayTrigger.open).to.equal('click');
+        expect(popover.placement).to.equal('bottom');
+        expect(scrollingArea.scrollTop).to.equal(distance);
+        await sendMouse({
+            steps: [
+                {
+                    type: 'wheel',
+                    position: [0, -distance],
+                },
+            ],
+        });
+        expect(scrollingArea.scrollTop, `scrollTop should be ${distance}.`).to.equal(distance);
+        scrollingArea.remove();
+    });
+});
+//# sourceMappingURL=overlay-trigger-extended.test.js.map