@vaadin/component-base 24.0.0-alpha5 → 24.0.0-alpha6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vaadin/component-base",
-  "version": "24.0.0-alpha5",
+  "version": "24.0.0-alpha6",
   "publishConfig": {
     "access": "public"
   },
@@ -42,5 +42,5 @@
     "@vaadin/testing-helpers": "^0.3.2",
     "sinon": "^13.0.2"
   },
-  "gitHead": "fc0b1721eda9e39cb289b239e440fc9e29573a31"
+  "gitHead": "0004ac92b6e5f415b5fa949e0582d1d11e527b1f"
 }

package/src/element-mixin.js

@@ -39,7 +39,7 @@ const registered = new Set();
 export const ElementMixin = (superClass) =>
   class VaadinElementMixin extends DirMixin(superClass) {
     static get version() {
-      return '24.0.0-alpha5';
+      return '24.0.0-alpha6';
     }
 
     /** @protected */

package/src/slot-controller.d.ts

@@ -54,10 +54,19 @@ export class SlotController extends EventTarget implements ReactiveController {
    */
   getSlotChild(): Node;
 
+  /**
+   * Create and attach default node using the provided tag name, if any.
+   */
   protected attachDefaultNode(): Node | undefined;
 
+  /**
+   * Run both `initCustomNode` and `initNode` for a custom slotted node.
+   */
   protected initAddedNode(node: Node): void;
 
+  /**
+   * Run `slotInitializer` for the node managed by the controller.
+   */
   protected initNode(node: Node): void;
 
   /**

package/src/slot-controller.js

@@ -92,7 +92,7 @@ export class SlotController extends EventTarget {
   }
 
   /**
-   * Create and attach default node using the slot factory.
+   * Create and attach default node using the provided tag name, if any.
    * @return {Node | undefined}
    * @protected
    */
@@ -102,7 +102,7 @@ export class SlotController extends EventTarget {
     // Check if the node was created previously and if so, reuse it.
     let node = this.defaultNode;
 
-    // Slot factory is optional, some slots don't have default content.
+    // Tag name is optional, sometimes we don't init default content.
     if (!node && tagName) {
       node = document.createElement(tagName);
       if (node instanceof Element) {
@@ -145,6 +145,8 @@ export class SlotController extends EventTarget {
   }
 
   /**
+   * Run `slotInitializer` for the node managed by the controller.
+   *
    * @param {Node} node
    * @protected
    */
@@ -173,7 +175,12 @@ export class SlotController extends EventTarget {
    */
   teardownNode(_node) {}
 
-  /** @protected */
+  /**
+   * Run both `initCustomNode` and `initNode` for a custom slotted node.
+   *
+   * @param {Node} node
+   * @protected
+   */
   initAddedNode(node) {
     if (node !== this.defaultNode) {
       this.initCustomNode(node);

package/src/slot-observe-controller.d.ts

@@ -0,0 +1,28 @@
+/**
+ * @license
+ * Copyright (c) 2022 Vaadin Ltd.
+ * This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
+ */
+import { SlotController } from './slot-controller.js';
+
+/**
+ * A controller that observes slotted element mutations, especially ID attribute
+ * and the text content, and fires an event to notify host element about those.
+ */
+export class SlotObserveController extends SlotController {
+  /**
+   * Setup the mutation observer on the node to update ID and notify host.
+   * Node doesn't get observed automatically until this method is called.
+   */
+  protected observeNode(node: Node): void;
+
+  /**
+   * Override to restore default node when a custom one is removed.
+   */
+  protected restoreDefaultNode(): void;
+
+  /**
+   * Override to update default node text on property change.
+   */
+  protected updateDefaultNode(node: Node): void;
+}

package/src/slot-observe-controller.js

@@ -0,0 +1,175 @@
+/**
+ * @license
+ * Copyright (c) 2022 Vaadin Ltd.
+ * This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
+ */
+import { SlotController } from './slot-controller.js';
+
+/**
+ * A controller that observes slotted element mutations, especially ID attribute
+ * and the text content, and fires an event to notify host element about those.
+ */
+export class SlotObserveController extends SlotController {
+  constructor(host, slot, tagName, config = {}) {
+    super(host, slot, tagName, { ...config, useUniqueId: true });
+  }
+
+  /**
+   * Override to initialize the newly added custom node.
+   *
+   * @param {Node} node
+   * @protected
+   * @override
+   */
+  initCustomNode(node) {
+    this.__updateNodeId(node);
+    this.__notifyChange(node);
+  }
+
+  /**
+   * Override to notify the controller host about removal of
+   * the custom node, and to apply the default one if needed.
+   *
+   * @param {Node} _node
+   * @protected
+   * @override
+   */
+  teardownNode(_node) {
+    const node = this.getSlotChild();
+
+    // Custom node is added to the slot
+    if (node && node !== this.defaultNode) {
+      this.__notifyChange(node);
+    } else {
+      this.restoreDefaultNode();
+      this.updateDefaultNode(this.node);
+    }
+  }
+
+  /**
+   * Override method inherited from `SlotMixin`
+   * to set ID attribute on the default node.
+   *
+   * @return {Node}
+   * @protected
+   * @override
+   */
+  attachDefaultNode() {
+    const node = super.attachDefaultNode();
+
+    if (node) {
+      this.__updateNodeId(node);
+    }
+
+    return node;
+  }
+
+  /**
+   * Override to restore default node when a custom one is removed.
+   *
+   * @protected
+   */
+  restoreDefaultNode() {
+    // To be implemented
+  }
+
+  /**
+   * Override to update default node text on property change.
+   *
+   * @param {Node} node
+   * @protected
+   */
+  updateDefaultNode(node) {
+    this.__notifyChange(node);
+  }
+
+  /**
+   * Setup the mutation observer on the node to update ID and notify host.
+   * Node doesn't get observed automatically until this method is called.
+   *
+   * @param {Node} node
+   * @protected
+   */
+  observeNode(node) {
+    // Stop observing the previous node, if any.
+    if (this.__nodeObserver) {
+      this.__nodeObserver.disconnect();
+    }
+
+    this.__nodeObserver = new MutationObserver((mutations) => {
+      mutations.forEach((mutation) => {
+        const target = mutation.target;
+
+        // Ensure the mutation target is the currently connected node
+        // to ignore async mutations dispatched for removed element.
+        const isCurrentNodeMutation = target === this.node;
+
+        if (mutation.type === 'attributes') {
+          // We use attributeFilter to only observe ID mutation,
+          // no need to check for attribute name separately.
+          if (isCurrentNodeMutation && target.id !== this.defaultId) {
+            this.__updateNodeId(target);
+          }
+        } else if (isCurrentNodeMutation || target.parentElement === this.node) {
+          // Node text content has changed.
+          this.__notifyChange(this.node);
+        }
+      });
+    });
+
+    // Observe changes to node ID attribute, text content and children.
+    this.__nodeObserver.observe(node, {
+      attributes: true,
+      attributeFilter: ['id'],
+      childList: true,
+      subtree: true,
+      characterData: true,
+    });
+  }
+
+  /**
+   * Returns true if a node is an HTML element with children,
+   * or is a defined custom element, or has non-empty text.
+   *
+   * @param {Node} node
+   * @return {boolean}
+   * @private
+   */
+  __hasContent(node) {
+    if (!node) {
+      return false;
+    }
+
+    return (
+      node.children.length > 0 ||
+      (node.nodeType === Node.ELEMENT_NODE && customElements.get(node.localName)) ||
+      (node.textContent && node.textContent.trim() !== '')
+    );
+  }
+
+  /**
+   * Fire an event to notify the controller host about node changes.
+   *
+   * @param {Node} node
+   * @private
+   */
+  __notifyChange(node) {
+    this.dispatchEvent(
+      new CustomEvent('slot-content-changed', {
+        detail: { hasContent: this.__hasContent(node), node },
+      }),
+    );
+  }
+
+  /**
+   * Set default ID on the node in case it is an HTML element.
+   *
+   * @param {Node} node
+   * @private
+   */
+  __updateNodeId(node) {
+    if (node.nodeType === Node.ELEMENT_NODE && !node.id) {
+      node.id = this.defaultId;
+    }
+  }
+}