fix(core/tooltip|dropdown): find trigger if in same shadow DOM

.changeset/eighty-kangaroos-judge.md

@@ -0,0 +1,5 @@
+---
+"@siemens/ix": patch
+---
+
+Enable discovery of trigger elements if in same shadow DOM for ix-tooltip and ix-dropdown.

packages/core/component-doc.json

@@ -6453,7 +6453,7 @@
             "references": {
               "ElementReference": {
                 "location": "import",
-                "path": "src/components/utils/element-reference",
+                "path": "../utils/element-reference",
                 "id": "src/components/utils/element-reference.ts::ElementReference"
               }
             }
@@ -6680,7 +6680,7 @@
             "references": {
               "ElementReference": {
                 "location": "import",
-                "path": "src/components/utils/element-reference",
+                "path": "../utils/element-reference",
                 "id": "src/components/utils/element-reference.ts::ElementReference"
               }
             }
@@ -20120,8 +20120,8 @@
             "references": {
               "ElementReference": {
                 "location": "import",
-                "path": "../utils/element-reference",
-                "id": "src/components/utils/element-reference.ts::ElementReference"
+                "path": "src/components",
+                "id": "src/components.d.ts::ElementReference"
               }
             }
           },
@@ -21945,6 +21945,11 @@
       "docstring": "",
       "path": "src/components/toast/toast-utils.ts"
     },
+    "src/components.d.ts::ElementReference": {
+      "declaration": "any",
+      "docstring": "",
+      "path": "src/components.d.ts"
+    },
     "../../node_modules/.pnpm/@stencil+core@4.17.2/node_modules/@stencil/core/internal/stencil-core/index.d.ts::Element": {
       "declaration": "any",
       "docstring": "",

packages/core/src/components.d.ts

@@ -46,7 +46,7 @@ import { TextareaResizeBehavior } from "./components/input/textarea";
 import { TimePickerCorners } from "./components/time-picker/time-picker";
 import { ToastConfig, ToastType } from "./components/toast/toast-utils";
 import { ShowToastResult } from "./components/toast/toast-container";
-import { ElementReference as ElementReference1 } from "./components/utils/element-reference";
+import { ElementReference as ElementReference1 } from "./components.d";
 import { Element } from "@stencil/core";
 import { TreeContext, TreeItemContext, TreeModel, UpdateCallback } from "./components/tree/tree-model";
 import { TextDecoration, TypographyColors, TypographyFormat } from "./components/typography/typography";
@@ -92,7 +92,7 @@ export { TextareaResizeBehavior } from "./components/input/textarea";
 export { TimePickerCorners } from "./components/time-picker/time-picker";
 export { ToastConfig, ToastType } from "./components/toast/toast-utils";
 export { ShowToastResult } from "./components/toast/toast-container";
-export { ElementReference as ElementReference1 } from "./components/utils/element-reference";
+export { ElementReference as ElementReference1 } from "./components.d";
 export { Element } from "@stencil/core";
 export { TreeContext, TreeItemContext, TreeModel, UpdateCallback } from "./components/tree/tree-model";
 export { TextDecoration, TypographyColors, TypographyFormat } from "./components/typography/typography";
@@ -2998,7 +2998,7 @@ export namespace Components {
         /**
           * CSS selector for hover trigger element e.g. `for="[data-my-custom-select]"`
          */
-        "for"?: ElementReference1;
+        "for"?: ElementReference;
         "hideDelay": number;
         "hideTooltip": () => Promise<void>;
         /**
@@ -8225,7 +8225,7 @@ declare namespace LocalJSX {
         /**
           * CSS selector for hover trigger element e.g. `for="[data-my-custom-select]"`
          */
-        "for"?: ElementReference1;
+        "for"?: ElementReference;
         "hideDelay"?: number;
         /**
           * Define if the user can access the tooltip via mouse.

packages/core/src/components/dropdown/dropdown.tsx

@@ -37,11 +37,12 @@ import {
   hasDropdownItemWrapperImplemented,
 } from './dropdown-controller';
 import { AlignedPlacement } from './placement';
+import { findElement } from '../utils/find-element';
 import {
   addDisposableEventListener,
   DisposableEventListener,
 } from '../utils/disposable-event-listener';
-import { ElementReference } from 'src/components/utils/element-reference';
+import { ElementReference } from '../utils/element-reference';
 
 let sequenceId = 0;
 
@@ -322,7 +323,7 @@ export class Dropdown implements ComponentInterface, DropdownInterface {
   }
 
   private async resolveElement(element: ElementReference) {
-    const el = await this.findElement(element);
+    const el = await findElement(element);
 
     return this.checkForSubmenuAnchor(el);
   }
@@ -346,41 +347,6 @@ export class Dropdown implements ComponentInterface, DropdownInterface {
     return element;
   }
 
-  private findElement(element: ElementReference): Promise<Element | undefined> {
-    if (element instanceof Promise) {
-      return element;
-    }
-
-    if (typeof element === 'object') {
-      return Promise.resolve(element);
-    }
-
-    if (typeof element != 'string') {
-      return Promise.resolve(undefined);
-    }
-
-    const selector = `#${element}`;
-    return new Promise((resolve) => {
-      const el = document.querySelector(selector);
-      if (el !== null) {
-        return resolve(el);
-      }
-
-      const observer = new MutationObserver(() => {
-        const el = document.querySelector(selector);
-        if (el) {
-          resolve(el);
-          observer.disconnect();
-        }
-      });
-
-      observer.observe(document.body, {
-        childList: true,
-        subtree: true,
-      });
-    });
-  }
-
   private async resolveAnchorElement() {
     if (this.anchor) {
       this.anchorElement = await this.resolveElement(this.anchor);

packages/core/src/components/tooltip/test/tooltip.ct.ts

@@ -23,6 +23,53 @@ test('renders', async ({ mount, page }) => {
   await expect(tooltip).toBeVisible();
 });
 
+test('renders in shadow DOM', async ({ mount, page }) => {
+  await mount(``);
+
+  await page.evaluate(() => {
+    customElements.define('test-component', class extends HTMLElement {});
+    const testComponent = document.createElement('test-component');
+    testComponent.attachShadow({ mode: 'open' });
+
+    const tooltip = document.createElement('ix-tooltip');
+    tooltip.innerHTML = 'tooltip';
+    tooltip.for = '.test';
+
+    const button = document.createElement('ix-button');
+    button.innerHTML = 'button';
+    button.classList.add('test');
+
+    document.querySelector('#mount')?.appendChild(testComponent);
+    testComponent.shadowRoot?.appendChild(button);
+    testComponent.shadowRoot?.appendChild(tooltip);
+  });
+
+  const tooltip = page.locator('ix-tooltip');
+  const button = page.locator('ix-button');
+
+  await button.hover();
+
+  await expect(tooltip).toHaveClass(/hydrated/);
+  await expect(tooltip).toBeVisible();
+});
+
+test('renders in slot', async ({ mount, page }) => {
+  await mount(`
+    <ix-blind>
+      <ix-tooltip for=".test">tooltip</ix-tooltip>
+      <ix-button class="test">button</ix-button>
+    </ix-blind>
+  `);
+
+  const tooltip = page.locator('ix-tooltip');
+  const button = page.locator('ix-button');
+
+  await button.hover();
+
+  await expect(tooltip).toHaveClass(/hydrated/);
+  await expect(tooltip).toBeVisible();
+});
+
 test.describe('a11y', () => {
   test('closes on ESC', async ({ mount, page }) => {
     await mount(`

packages/core/src/components/tooltip/tooltip.tsx

@@ -28,7 +28,8 @@ import {
 import { OnListener } from '../utils/listener';
 import { tooltipController } from './tooltip-controller';
 import { IxOverlayComponent } from '../utils/overlay';
-import { ElementReference } from '../utils/element-reference';
+import { resolveSelector } from '../utils/find-element';
+import { ElementReference } from 'src/components';
 
 type ArrowPosition = {
   top?: string;
@@ -255,7 +256,7 @@ export class Tooltip implements IxOverlayComponent {
 
   private async queryAnchorElements(): Promise<Array<HTMLElement> | undefined> {
     if (typeof this.for === 'string') {
-      return Promise.resolve(Array.from(document.querySelectorAll(this.for)));
+      return resolveSelector(this.for, this.hostElement);
     }
 
     if (this.for instanceof HTMLElement) {

packages/core/src/components/utils/find-element.ts

@@ -0,0 +1,136 @@
+/*
+ * SPDX-FileCopyrightText: 2024 Siemens AG
+ *
+ * SPDX-License-Identifier: MIT
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+/**
+ * Will try to resolve the selector in the light dom, shadow dom or slot
+ * @param selector The selector to resolve
+ * @param hostElement The element to start the search from
+ * @returns Promise with the resolved elements or undefined if not found
+ */
+export async function resolveSelector(
+  selector: string,
+  hostElement?: HTMLElement
+): Promise<HTMLElement[] | undefined> {
+  const elements: HTMLElement[] = Array.from(
+    document.querySelectorAll(selector)
+  );
+
+  if (elements.length > 0) {
+    return Promise.resolve(elements);
+  }
+
+  if (hostElement === undefined) {
+    return Promise.resolve(undefined);
+  }
+
+  const shadowRoot = getRootFor(hostElement);
+
+  if (shadowRoot === undefined || !(shadowRoot instanceof ShadowRoot)) {
+    return Promise.resolve(undefined);
+  }
+
+  const elementsInShadowRoot: HTMLElement[] = Array.from(
+    shadowRoot.querySelectorAll(selector)
+  );
+
+  const elementsInHost: HTMLElement[] = Array.from(
+    shadowRoot.host.querySelectorAll(selector)
+  );
+
+  const elementsInComponent: HTMLElement[] = [
+    ...elementsInHost,
+    ...elementsInShadowRoot,
+  ];
+
+  if (elementsInComponent.length > 0) {
+    return Promise.resolve(elementsInComponent);
+  }
+
+  return Promise.resolve(undefined);
+}
+
+/**
+ * Walk up the DOM to find the nearest shadow root
+ * @param element The element to get the root for
+ * @param parent This will determine how far up the DOM to travel to find the root
+ * @returns The root element
+ */
+export function getRootFor(element: HTMLElement, parent = document.body) {
+  if (!element.parentElement && !element.parentNode) {
+    return undefined;
+  }
+
+  if (element.parentNode instanceof ShadowRoot) {
+    return element.parentNode;
+  }
+
+  let currentNode = element.parentElement;
+
+  while (currentNode) {
+    if (currentNode.shadowRoot) {
+      return currentNode.shadowRoot;
+    } else if (currentNode.parentNode instanceof ShadowRoot) {
+      return currentNode.parentNode;
+    }
+
+    currentNode = currentNode.parentElement;
+  }
+
+  return parent;
+}
+
+export function waitForSelector(
+  selector: string,
+  node = document,
+  hostElement?: HTMLElement
+): Promise<Element> {
+  return new Promise((resolve) => {
+    const waitForElements = () => {
+      resolveSelector(selector, hostElement).then((elements) => {
+        if (elements && elements.length > 0) {
+          resolve(elements[0]);
+          observer?.disconnect();
+        }
+      });
+    };
+
+    waitForElements();
+
+    const observer = new MutationObserver(() => {
+      waitForElements();
+    });
+
+    observer.observe(node.body, {
+      childList: true,
+      subtree: true,
+    });
+  });
+}
+
+/**
+ * Find an element by ID or reference
+ * @param element The element to find
+ * @param hostElement The element to start the search from
+ * @returns A promise that will resolve to the element
+ */
+export function findElement(
+  element: string | HTMLElement | Promise<HTMLElement>,
+  hostElement?: HTMLElement
+): Promise<Element> {
+  if (element instanceof Promise) {
+    return element;
+  }
+
+  if (typeof element === 'object') {
+    return Promise.resolve(element);
+  }
+
+  const selector = `#${element}`;
+  return waitForSelector(selector, document, hostElement);
+}