@lion/ui 0.21.1-menu-system.0 → 0.22.0

package/components/overlays/src/OverlayMixin.js

@@ -1,5 +1,6 @@
 import { dedupeMixin } from '@open-wc/dedupe-mixin';
 import { OverlayController } from './OverlayController.js';
+import { isEqualConfig } from './utils/is-equal-config.js';
 
 /**
  * @typedef {<T>(ingOverlayHost:T) => void} PostProcessor
@@ -31,7 +32,10 @@ export const OverlayMixinImplementation = superclass => {
   class OverlayMixin extends superclass {
     static get properties() {
       return {
-        opened: { type: Boolean, reflect: true },
+        opened: {
+          type: Boolean,
+          reflect: true,
+        },
       };
     }
 
@@ -65,13 +69,13 @@ export const OverlayMixinImplementation = superclass => {
 
     /** @param {OverlayConfig} value */
     set config(value) {
-      // The OverlayController already guards against redundant updates
-      // (see OverlayController#updateConfig), so we delegate unconditionally here.
-      if (this._overlayCtrl) {
+      const shouldUpdate = !isEqualConfig(this.config, value);
+
+      if (this._overlayCtrl && shouldUpdate) {
         this._overlayCtrl.updateConfig(value);
       }
       this.__config = value;
-      if (this._overlayCtrl) {
+      if (this._overlayCtrl && shouldUpdate) {
         this.__syncToOverlayController();
       }
     }
@@ -156,8 +160,6 @@ export const OverlayMixinImplementation = superclass => {
      */
     // eslint-disable-next-line class-methods-use-this
     _setupOpenCloseListeners() {
-      // Keeps the close-overlay event private for the controller.
-      // (we already have )
       /**
        * @param {{ stopPropagation: () => void; }} ev
        */
@@ -215,6 +217,12 @@ export const OverlayMixinImplementation = superclass => {
     // @ts-expect-error
     static enabledWarnings = super.enabledWarnings?.filter(w => w !== 'change-in-update') || [];
 
+    get _overlayInvokerNode() {
+      return /** @type {HTMLElement | undefined} */ (
+        Array.from(this.children).find(child => child.slot === 'invoker')
+      );
+    }
+
     /**
      * @overridable
      */
@@ -247,77 +255,13 @@ export const OverlayMixinImplementation = superclass => {
       );
     }
 
-    /**
-     * Returns the element that can actually receive focus inside the passed
-     * invoker (wrapper) element: the element itself when it is focusable,
-     * otherwise the first focusable descendant.
-     * @param {Element|null|undefined} focusableElOrWrapper
-     * @returns {Element|null}
-     */
-    static _getFocusableInvokerEl(focusableElOrWrapper) {
-      if (!focusableElOrWrapper) return null;
-      const focusableSelector = '[tabindex], button, a[href], [role=button]';
-      return focusableElOrWrapper.matches(focusableSelector)
-        ? focusableElOrWrapper
-        : focusableElOrWrapper.querySelector(focusableSelector);
-    }
-
-    /**
-     * The node that opens/closes this overlay.
-     *
-     * Resolved in a stable, declarative way (independent of the exact DOM order)
-     * by looking, in order, for:
-     * 1. a child with `[slot="invoker"]`
-     * 2. any element in the same root that opts in via `[data-invoker]` and
-     *    references this host by id (`for="<id>"`)
-     * 3. a preceding sibling that opts in via `[data-invoker]`
-     * @protected
-     */
-    get _overlayInvokerNode() {
-      if (!this.__invokerNode) {
-        this.__invokerNode = this._getInvokerNode();
-      }
-      return this.__invokerNode;
-    }
-
-    /**
-     * @protected
-     * @returns {Element|null}
-     */
-    _getInvokerNode() {
-      const ctor = /** @type {typeof OverlayMixin} */ (this.constructor);
-
-      const slottedNode = Array.from(this.children).find(child => child.slot === 'invoker');
-      if (slottedNode) {
-        return ctor._getFocusableInvokerEl(slottedNode);
-      }
-
-      if (this.id) {
-        // Reference the invoker declaratively: `<button data-invoker for="my-menu">`
-        const root = /** @type {Document|ShadowRoot} */ (this.getRootNode());
-        const explicitInvoker = root.querySelector?.(`[data-invoker][for="${this.id}"]`);
-        if (explicitInvoker) {
-          return ctor._getFocusableInvokerEl(explicitInvoker);
-        }
-      }
-
-      // Fall back to a preceding sibling that opted in via [data-invoker]
-      const { previousElementSibling } = this;
-      return previousElementSibling && previousElementSibling.hasAttribute('data-invoker')
-        ? ctor._getFocusableInvokerEl(previousElementSibling)
-        : null;
-    }
-
     /** @protected */
     _setupOverlayCtrl() {
       if (this.#hasSetup) return;
-
-      const invokerNode = this._overlayInvokerNode;
-
       const config = {
         contentNode: this._overlayContentNode,
         contentWrapperNode: this._overlayContentWrapperNode,
-        invokerNode: invokerNode && invokerNode instanceof HTMLElement ? invokerNode : undefined,
+        invokerNode: this._overlayInvokerNode,
         referenceNode: this._overlayReferenceNode,
         backdropNode: this._overlayBackdropNode,
       };
@@ -338,8 +282,6 @@ export const OverlayMixinImplementation = superclass => {
 
     /** @protected */
     _teardownOverlayCtrl() {
-      // Make sure that dynamic behavior (e.g. responsive) is possible by allowing multiple setups and teardowns of the overlay controller.
-      this.#hasSetup = false;
       if (!this._overlayCtrl) return;
 
       this._teardownOpenCloseListeners();
@@ -492,7 +434,6 @@ export const OverlayMixinImplementation = superclass => {
   for (const postProcessor of overlayMixinPostProcessors) {
     postProcessor(OverlayMixin);
   }
-  // @ts-ignore https://github.com/microsoft/TypeScript/issues/36821#issuecomment-588375051
-  return OverlayMixin;
+  return /** @type {* & OverlayMixin} */ (OverlayMixin);
 };
 export const OverlayMixin = dedupeMixin(OverlayMixinImplementation);

package/components/overlays/src/utils/adopt-styles.js

@@ -124,7 +124,7 @@ export function adoptStyle(renderRoot, style, { teardown = false } = {}) {
   if (!teardown) {
     // @ts-ignore
     // eslint-disable-next-line no-param-reassign
-    renderRoot.adoptedStyleSheets = [...(renderRoot.adoptedStyleSheets || []), sheet];
+    renderRoot.adoptedStyleSheets = [...renderRoot.adoptedStyleSheets, sheet];
   } else if (renderRoot.adoptedStyleSheets.includes(sheet)) {
     // @ts-ignore
     // eslint-disable-next-line no-param-reassign

package/components/overlays/src/utils/is-equal-config.js

@@ -12,24 +12,15 @@
  */
 export function isEqualConfig(a, b) {
   if (typeof a !== 'object' || typeof b !== 'object' || a === null || b === null) {
-    if (typeof a === 'function' && typeof b === 'function') {
-      return /** @type {Function} */ (a).toString() === /** @type {Function} */ (b).toString();
-    }
     return a === b;
   }
-  if (a instanceof Node && b instanceof Node) {
-    return a === b;
-  }
-
-  const aProps = Object.keys(a);
-  const bProps = Object.keys(b);
+  const aObj = /** @type {Record<string, any>} */ (a);
+  const bObj = /** @type {Record<string, any>} */ (b);
+  const aProps = Object.keys(aObj);
+  const bProps = Object.keys(bObj);
   if (aProps.length !== bProps.length) {
     return false;
   }
-  return aProps.every(
-    prop =>
-      Object.prototype.hasOwnProperty.call(b, prop) &&
-      // @ts-ignore - dynamic property access
-      isEqualConfig(a[prop], b[prop]),
-  );
+  const isEqual = /** @param {string} prop */ prop => isEqualConfig(aObj[prop], bObj[prop]);
+  return aProps.every(isEqual);
 }

package/components/overlays/test/OverlayController.test.js

@@ -115,35 +115,26 @@ const withLocalTestConfig = () =>
  */
 async function createNestedEscControllers(parentContent) {
   const childContent = /** @type {HTMLDivElement} */ (parentContent.querySelector('div[id]'));
+  // Assert valid fixure
+  const isValidFixture =
+    (parentContent.id.startsWith('parent-overlay--hidesOnEsc') ||
+      parentContent.id.startsWith('parent-overlay--hidesOnOutsideEsc')) &&
+    (childContent.id.startsWith('child-overlay--hidesOnEsc') ||
+      childContent.id.startsWith('child-overlay--hidesOnOutsideEsc'));
+  if (!isValidFixture) {
+    throw new Error('Provide a valid fixture');
+  }
 
   if (parentContent.hasAttribute('data-convert-to-shadow-root')) {
     const shadowRootParent = parentContent.attachShadow({ mode: 'open' });
     shadowRootParent.appendChild(childContent);
   }
 
-  const parentConfig = {};
-  const childConfig = {};
-
   const parentHasOutsideOnEsc = parentContent.id.startsWith('parent-overlay--hidesOnOutsideEsc');
   const childHasOutsideOnEsc = childContent.id.startsWith('child-overlay--hidesOnOutsideEsc');
 
-  if (parentHasOutsideOnEsc) {
-    parentConfig.hidesOnOutsideEsc = true;
-  } else {
-    parentConfig.hidesOnEsc = true;
-  }
-  if (childHasOutsideOnEsc) {
-    childConfig.hidesOnOutsideEsc = true;
-  } else {
-    childConfig.hidesOnEsc = true;
-  }
-
-  const parentHasSyncChildrenCloseState =
-    parentContent.dataset.syncChildrenCloseState !== undefined;
-
-  if (parentHasSyncChildrenCloseState) {
-    parentConfig.syncChildrenCloseState = true;
-  }
+  const parentConfig = parentHasOutsideOnEsc ? { hidesOnOutsideEsc: true } : { hidesOnEsc: true };
+  const childConfig = childHasOutsideOnEsc ? { hidesOnOutsideEsc: true } : { hidesOnEsc: true };
 
   const parentOverlay = new OverlayController({
     ...withGlobalTestConfig(),
@@ -292,9 +283,8 @@ describe('OverlayController', () => {
             contentNode,
           });
         };
-
         expect(createOverlayController).to.throw(
-          '[OverlayController] Could not find a render target, makes sure contentNode has a parent element (or contentWrapperNode is connected)',
+          '[OverlayController] Could not find a render target, since the provided contentNode is not connected to the DOM. Make sure that it is connected, e.g. by doing "document.body.appendChild(contentNode)", before passing it on.',
         );
       });
 
@@ -356,21 +346,6 @@ describe('OverlayController', () => {
       await ctrl.hide();
       expect(ctrl.isShown).to.be.false;
     });
-
-    it('cleans up the dom structure it created', async () => {
-      const contentNode = /** @type {HTMLElement} */ (fixtureSync(html`<div>my content</div>`));
-      const ctrl = new OverlayController({
-        placementMode: 'global',
-        contentNode,
-      });
-      await ctrl.show();
-      expect(ctrl.contentWrapperNode).to.exist;
-      expect(ctrl.__wrappingDialogNode).to.exist;
-
-      await ctrl.teardown();
-      expect(ctrl.contentWrapperNode).to.not.exist;
-      expect(ctrl.__wrappingDialogNode).to.not.exist;
-    });
   });
 
   describe('Node Configuration', () => {
@@ -428,7 +403,7 @@ describe('OverlayController', () => {
               { ignoreAttributes: ['closedby'] },
             );
 
-            expect(el).lightDom.to.equal(`<div data-content="" slot="content">projected</div>`);
+            expect(el).lightDom.to.equal(`<div slot="content">projected</div>`);
           });
         });
 
@@ -450,7 +425,7 @@ describe('OverlayController', () => {
               `
               <dialog data-overlay-outer-wrapper="" open="" role="none" style="${wrappingDialogNodeStyle}">
                 <div data-id="content-wrapper">
-                  <div data-content="" id="content">non projected</div>
+                  <div id="content">non projected</div>
                 </div>
               </dialog>
           `,
@@ -645,7 +620,6 @@ describe('OverlayController', () => {
     });
   });
 
-  // TODO: make features modular (so they can be treeshaken) and test their lifecycle within this desrcibe
   describe('Feature Configuration', () => {
     describe('trapsKeyboardFocus', () => {
       it('focuses the overlay on show', async () => {
@@ -889,7 +863,10 @@ describe('OverlayController', () => {
 
     describe('Nested hidesOnEsc / hidesOnOutsideEsc', () => {
       describe('Parent has hidesOnEsc and child has hidesOnOutsideEsc', () => {
-        it('on [Escape] press in child overlay: parent hides, child stays shown', async () => {
+        // TODO: This test is flaky. We need to investigate why the child overlay
+        // is not staying shown after the parent overlay is hidden. The failing line
+        // is highlighted below.
+        it.skip('on [Escape] press in child overlay: parent hides, child stays shown', async () => {
           const parentContent = /** @type {HTMLDivElement} */ (
             await fixture(
               html` <!-- -->
@@ -900,16 +877,12 @@ describe('OverlayController', () => {
           );
           const { parentOverlay, childOverlay } = await createNestedEscControllers(parentContent);
           await mimicEscapePress(childOverlay.contentNode);
-          await childOverlay._showComplete;
-          await parentOverlay._showComplete;
-          await childOverlay._hideComplete;
-          await parentOverlay._hideComplete;
-          if (!childOverlay.isShown) {
-            await waitUntil(() => childOverlay.isShown);
-          }
-          if (parentOverlay.isShown) {
-            await waitUntil(() => !parentOverlay.isShown);
-          }
+          await waitUntil(() => !parentOverlay.isShown);
+
+          // TODO: This is the failing line ("sometimes").
+          // The child overlay is not staying shown after the parent overlay is hidden.
+          await waitUntil(() => childOverlay.isShown);
+
           await childOverlay.teardown();
           await parentOverlay.teardown();
         });
@@ -1015,7 +988,6 @@ describe('OverlayController', () => {
         });
       });
     });
-
     describe('hidesOnOutsideClick', () => {
       it('hides on outside click', async () => {
         const contentNode = /** @type {HTMLElement} */ (await fixture('<div>Content</div>'));
@@ -1736,97 +1708,6 @@ describe('OverlayController', () => {
         expect(ctrl1.hasActiveBackdrop).to.be.true;
       });
     });
-
-    describe('elementToFocusOnShow', () => {
-      it('adds tabindex="-1" to the content node when elementToFocusOnShow is true', async () => {
-        const ctrl = new OverlayController({
-          ...withGlobalTestConfig(),
-          isBlocking: false,
-          elementToFocusOnShow: true,
-        });
-        const contentNode = /** @type {HTMLElement} */ (await fixture('<div>Content</div>'));
-        ctrl.updateConfig({ contentNode });
-        await ctrl.show();
-        expect(contentNode.getAttribute('tabindex')).to.equal('-1');
-      });
-
-      it('makes contentNode the root of "next tab flow"', async () => {
-        const ctrl = new OverlayController({
-          ...withGlobalTestConfig(),
-          isBlocking: false,
-          elementToFocusOnShow: true,
-        });
-        const contentNode = /** @type {HTMLElement} */ (
-          await fixture('<div><button>Button</button></div>')
-        );
-        ctrl.updateConfig({ contentNode });
-        await ctrl.show();
-        const button = /** @type {HTMLButtonElement} */ (contentNode.querySelector('button'));
-        button.focus();
-        expect(isActiveElement(button)).to.be.true;
-      });
-    });
-
-    describe('syncChildrenCloseState', () => {
-      it('does not close all children of nested controllers when syncChildrenCloseState is false', async () => {
-        const parentContent = /** @type {HTMLDivElement} */ (
-          await fixture(
-            html` <!-- -->
-              <div data-sync-children-close-state id="parent-overlay">
-                <div id="child-overlay">we open our child and it will close when parent does</div>
-              </div>`,
-          )
-        );
-        const { parentOverlay, childOverlay } = await createNestedEscControllers(parentContent);
-        expect(parentOverlay.isShown).to.be.true;
-        expect(childOverlay.isShown).to.be.true;
-
-        await parentOverlay.hide();
-        await childOverlay._hideComplete;
-        expect(parentOverlay.isShown).to.be.false;
-        expect(childOverlay.isShown).to.be.false;
-      });
-
-      it('does not close all children of nested controllers when syncChildrenCloseState is false', async () => {
-        const parentContent = /** @type {HTMLDivElement} */ (
-          await fixture(
-            html` <!-- -->
-              <div id="parent-overlay">
-                <div id="child-overlay">
-                  we open our child and it will not close when parent does
-                </div>
-              </div>`,
-          )
-        );
-        const { parentOverlay, childOverlay } = await createNestedEscControllers(parentContent);
-        expect(parentOverlay.isShown).to.be.true;
-        expect(childOverlay.isShown).to.be.true;
-
-        await parentOverlay.hide();
-        expect(parentOverlay.isShown).to.be.false;
-        expect(childOverlay.isShown).to.be.true;
-      });
-    });
-
-    describe('isActivated', () => {
-      it('allows to conditionally disable overlay/openable functionality (for responsive context like nav menus, accordions/collapsibles vs plain headings/content etc.)', async () => {
-        const ctrl = new OverlayController({
-          ...withGlobalTestConfig(),
-          isActivated: false,
-        });
-        expect(ctrl.__hasSetup).to.be.false;
-        ctrl.updateConfig({
-          isActivated: true,
-        });
-        expect(ctrl.__hasSetup).to.be.true;
-      });
-    });
-
-    // TODO
-    describe('hideVisually', () => {});
-
-    // TODO
-    describe('requireConnectedNodes', () => {});
   });
 
   describe('Show / Hide / Toggle', () => {
@@ -2417,7 +2298,6 @@ describe('OverlayController', () => {
     });
 
     it('should run with scroll prevention', async () => {
-      await overlayControllerPreventsScroll.hide();
       await overlayControllerPreventsScroll.show();
 
       expect(

package/components/overlays/test-suites/OverlayMixin.suite.js

@@ -540,13 +540,13 @@ export function runOverlayMixinSuite({ tagString, tag, suffix = '' }) {
       it('works with cache directive when reconnected', async () => {
         class CachingContext extends LitElement {
           static properties = {
-            showOverlay: { type: Boolean },
+            switched: { type: Boolean },
           };
 
           constructor() {
             super();
 
-            this.showOverlay = true;
+            this.switched = false;
           }
 
           get overlayEl() {
@@ -555,12 +555,12 @@ export function runOverlayMixinSuite({ tagString, tag, suffix = '' }) {
 
           render() {
             return html`${cache(
-              this.showOverlay
-                ? html`<${tag} id="myOverlay">
+              this.switched
+                ? html`something else`
+                : html`<${tag} id="myOverlay">
               <div slot="content">content b</div>
               <button slot="invoker">invoker button b</button>
-            </${tag}>`
-                : html`something else`,
+            </${tag}>`,
             )}`;
           }
         }
@@ -581,7 +581,7 @@ export function runOverlayMixinSuite({ tagString, tag, suffix = '' }) {
         // @ts-expect-error [allow-protected] in tests
         const setupSpy = sinon.spy(el.overlayEl, '_setupOverlayCtrl');
 
-        el.showOverlay = false;
+        el.switched = true;
         // render the new content
         await el.updateComplete;
         // wait for the teardown to complete
@@ -591,7 +591,7 @@ export function runOverlayMixinSuite({ tagString, tag, suffix = '' }) {
         expect(teardownSpy.callCount).to.equal(1);
         expect(setupSpy.callCount).to.equal(0);
 
-        el.showOverlay = true;
+        el.switched = false;
         await el.updateComplete;
         expect(setupSpy.callCount).to.equal(1);
 

package/components/overlays/types/ArrowMixinTypes.ts

@@ -26,7 +26,9 @@ export declare class ArrowHost {
 
   protected _defineOverlayConfig(): OverlayConfig;
 
-  protected _getPopperArrowConfig(popperConfigToExtendFrom: Partial<PopperOptions>): Partial<PopperOptions>;
+  protected _getPopperArrowConfig(
+    popperConfigToExtendFrom: Partial<PopperOptions>,
+  ): Partial<PopperOptions>;
 
   private __setupRepositionCompletePromise(): void;
 

package/components/overlays/types/OverlayConfig.ts

@@ -21,6 +21,7 @@ export type OverlayPhase =
   | 'add'
   | 'remove';
 
+
 export interface ViewportConfig {
   placement: ViewportPlacement;
 }
@@ -96,30 +97,14 @@ export interface OverlayConfig {
   /** By default, the tooltip content is a 'description' for the invoker (uses aria-describedby) Setting this property to 'label' makes the content function as a label (via aria-labelledby) */
   invokerRelation?: 'label' | 'description';
 
+  /** render a div instead of dialog */
+  _noDialogEl?: Boolean;
+
   /**
    * Determines the conditions hiding/showing should be based on. It gets the OverlayController as input and returns an object with
    * functions with Overlay phases as keys
    */
   visibilityTriggerFunction?: Function;
+}
 
-  /**
-   * Whether the overlay content should receive focus when shown.
-   */
-  elementToFocusOnShow?: boolean;
-
-  /*
-   * By default, we function either as overlay or disclosure. In some cases, this should be dynamically set (think of responsive changes).
-   * or it depends on the context (a top level menu is not openable (unless it's a context menu), its children menus are).
-   */
-  isActivated?: boolean;
-
-  /**
-   * By default, an error is thrown when contentNode is not connected to the DOM.
-   * This allows to prepare nodes and later connect them to dom.
-   */
-  requireConnectedNodes?: boolean;
-
-  syncChildrenCloseState?: boolean;
 
-  _shouldTeardownDomStructure?: boolean;
-}

package/components/overlays/types/OverlayMixinTypes.ts

@@ -17,8 +17,6 @@ export interface DefineOverlayConfig {
 }
 
 export declare class OverlayHost {
-  static _getFocusableInvokerEl(focusableElOrWrapper: Element): Element | null;
-
   opened: Boolean;
   get config(): Partial<OverlayConfig>;
   set config(value: Partial<OverlayConfig>);