import { expect, fixture, html, nextFrame } from '@open-wc/testing'; import sinon from 'sinon'; import { overlays } from '../src/overlays.js'; export function runOverlayMixinSuite({ /* tagString, */ tag, suffix = '' }) { describe(`OverlayMixin${suffix}`, () => { let el; beforeEach(async () => { el = await fixture(html` <${tag}>
content of the overlay
`); }); it('should not be opened by default', async () => { expect(el.opened).to.be.false; expect(el._overlayCtrl.isShown).to.be.false; }); it('syncs opened to overlayController', async () => { el.opened = true; expect(el.opened).to.be.true; await nextFrame(); // overlayCtrl show/hide is async expect(el._overlayCtrl.isShown).to.be.true; el.opened = false; expect(el.opened).to.be.false; await nextFrame(); // overlayCtrl show/hide is async expect(el._overlayCtrl.isShown).to.be.false; }); it('syncs overlayController to opened', async () => { expect(el.opened).to.be.false; await el._overlayCtrl.show(); expect(el.opened).to.be.true; await el._overlayCtrl.hide(); expect(el.opened).to.be.false; }); it('should respond to initially and dynamically setting the config', async () => { const itEl = await fixture(html` <${tag} .config=${{ trapsKeyboardFocus: false, viewportConfig: { placement: 'top' } }}>
content of the overlay
`); itEl.opened = true; await itEl.updateComplete; expect(itEl._overlayCtrl.trapsKeyboardFocus).to.be.false; itEl.config = { viewportConfig: { placement: 'left' } }; expect(itEl._overlayCtrl.viewportConfig.placement).to.equal('left'); }); it('fires "opened-changed" event on hide', async () => { const spy = sinon.spy(); el = await fixture(html` <${tag} @opened-changed="${spy}">
content of the overlay
`); expect(spy).not.to.have.been.called; await el._overlayCtrl.show(); expect(spy.callCount).to.equal(1); expect(el.opened).to.be.true; await el._overlayCtrl.hide(); expect(spy.callCount).to.equal(2); expect(el.opened).to.be.false; }); it('fires "before-closed" event on hide', async () => { const beforeSpy = sinon.spy(); el = await fixture(html` <${tag} @before-closed="${beforeSpy}" .opened="${true}">
content of the overlay
`); // Wait until it's done opening (handling features is async) await nextFrame(); expect(beforeSpy).not.to.have.been.called; await el._overlayCtrl.hide(); expect(beforeSpy).to.have.been.called; expect(el.opened).to.be.false; }); it('fires before-opened" event on show', async () => { const beforeSpy = sinon.spy(); el = await fixture(html` <${tag} @before-opened="${beforeSpy}">
content of the overlay
`); expect(beforeSpy).not.to.have.been.called; await el._overlayCtrl.show(); expect(beforeSpy).to.have.been.called; expect(el.opened).to.be.true; }); it('allows to call `preventDefault()` on "before-opened"/"before-closed" events', async () => { function preventer(ev) { ev.preventDefault(); } el = await fixture(html` <${tag} @before-opened="${preventer}" @before-closed="${preventer}">
content of the overlay
`); await el._overlayCtrl.show(); expect(el.opened).to.be.false; }); it('hides content on "close-overlay" event within the content ', async () => { function sendCloseEvent(e) { e.target.dispatchEvent(new Event('close-overlay', { bubbles: true })); } const closeBtn = await fixture(html` `); el = await fixture(html` <${tag} opened>
content of the overlay ${closeBtn}
`); closeBtn.click(); expect(el.opened).to.be.false; }); }); describe(`OverlayMixin${suffix} nested`, () => { it('reconstructs the overlay when disconnected and reconnected to DOM (support for nested overlay nodes)', async () => { const nestedEl = await fixture(html` <${tag}>
content of the nested overlay
`); const mainEl = await fixture(html` <${tag}>
open nested overlay: ${nestedEl}
`); if (mainEl._overlayCtrl.placementMode === 'global') { // Specifically checking the output in global root node, because the _contentOverlayNode still references // the node that was removed in the teardown but hasn't been garbage collected due to reference to it still existing.. // Find the outlets that are not backdrop outlets const outletsInGlobalRootNode = Array.from(overlays.globalRootNode.children).filter( child => child.slot === '_overlay-shadow-outlet' && !child.classList.contains('global-overlays__backdrop'), ); // Check the last one, which is the most nested one const lastContentNodeInContainer = outletsInGlobalRootNode[outletsInGlobalRootNode.length - 1]; expect(outletsInGlobalRootNode.length).to.equal(2); // Check that it indeed has the intended content expect(lastContentNodeInContainer.firstElementChild.innerText).to.equal( 'content of the nested overlay', ); expect(lastContentNodeInContainer.firstElementChild.slot).to.equal('content'); } else { const actualNestedOverlay = mainEl._overlayContentNode.firstElementChild; const outletNode = Array.from(actualNestedOverlay.children).find( child => child.slot === '_overlay-shadow-outlet', ); const contentNode = Array.from(outletNode.children).find(child => child.slot === 'content'); expect(contentNode).to.not.be.undefined; expect(contentNode.innerText).to.equal('content of the nested overlay'); } }); }); }