@vaadin/field-highlighter 23.1.0-beta4 → 23.1.0-rc3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vaadin/field-highlighter",
-  "version": "23.1.0-beta4",
+  "version": "23.1.0-rc3",
   "publishConfig": {
     "access": "public"
   },
@@ -34,27 +34,27 @@
   ],
   "dependencies": {
     "@polymer/polymer": "^3.0.0",
-    "@vaadin/component-base": "23.1.0-beta4",
-    "@vaadin/vaadin-lumo-styles": "23.1.0-beta4",
-    "@vaadin/vaadin-material-styles": "23.1.0-beta4",
-    "@vaadin/vaadin-overlay": "23.1.0-beta4",
-    "@vaadin/vaadin-themable-mixin": "23.1.0-beta4",
+    "@vaadin/component-base": "23.1.0-rc3",
+    "@vaadin/vaadin-lumo-styles": "23.1.0-rc3",
+    "@vaadin/vaadin-material-styles": "23.1.0-rc3",
+    "@vaadin/vaadin-overlay": "23.1.0-rc3",
+    "@vaadin/vaadin-themable-mixin": "23.1.0-rc3",
     "lit": "^2.0.0"
   },
   "devDependencies": {
     "@esm-bundle/chai": "^4.3.4",
-    "@vaadin/checkbox": "23.1.0-beta4",
-    "@vaadin/combo-box": "23.1.0-beta4",
-    "@vaadin/date-picker": "23.1.0-beta4",
-    "@vaadin/date-time-picker": "23.1.0-beta4",
-    "@vaadin/item": "23.1.0-beta4",
-    "@vaadin/list-box": "23.1.0-beta4",
-    "@vaadin/radio-group": "23.1.0-beta4",
-    "@vaadin/select": "23.1.0-beta4",
+    "@vaadin/checkbox": "23.1.0-rc3",
+    "@vaadin/combo-box": "23.1.0-rc3",
+    "@vaadin/date-picker": "23.1.0-rc3",
+    "@vaadin/date-time-picker": "23.1.0-rc3",
+    "@vaadin/item": "23.1.0-rc3",
+    "@vaadin/list-box": "23.1.0-rc3",
+    "@vaadin/radio-group": "23.1.0-rc3",
+    "@vaadin/select": "23.1.0-rc3",
     "@vaadin/testing-helpers": "^0.3.2",
-    "@vaadin/text-field": "23.1.0-beta4",
-    "@vaadin/time-picker": "23.1.0-beta4",
+    "@vaadin/text-field": "23.1.0-rc3",
+    "@vaadin/time-picker": "23.1.0-rc3",
     "sinon": "^13.0.2"
   },
-  "gitHead": "06e283473964ecb3085aacf3eddb5333d052a045"
+  "gitHead": "49c312fbe0228adb559296d45655bbfd4eac6235"
 }

package/src/vaadin-field-highlighter.d.ts

@@ -20,8 +20,6 @@ export interface FieldHighlighterUser {
  * See https://vaadin.com/collaboration for Collaboration Engine documentation.
  */
 declare class FieldHighlighterController implements ReactiveController {
-  constructor(host: HTMLElement);
-
   /**
    * The controller host element.
    */
@@ -47,6 +45,8 @@ declare class FieldHighlighterController implements ReactiveController {
    */
   users: FieldHighlighterUser[];
 
+  constructor(host: HTMLElement);
+
   hostConnected(): void;
 
   redraw(): void;

package/src/vaadin-user-tags.js

@@ -10,9 +10,6 @@ import { html, PolymerElement } from '@polymer/polymer/polymer-element.js';
 import { timeOut } from '@vaadin/component-base/src/async.js';
 import { Debouncer } from '@vaadin/component-base/src/debounce.js';
 
-const DURATION = 200;
-const DELAY = 2000;
-
 const listenOnce = (elem, type) => {
   return new Promise((resolve) => {
     const listener = () => {
@@ -96,20 +93,60 @@ export class UserTags extends PolymerElement {
         value: () => [],
       },
 
+      duration: {
+        type: Number,
+        value: 200,
+      },
+
+      delay: {
+        type: Number,
+        value: 2000,
+      },
+
       /** @private */
-      _flashQueue: {
+      __flashQueue: {
         type: Array,
         value: () => [],
       },
+
+      /** @private */
+      __isTargetVisible: {
+        type: Boolean,
+        value: false,
+      },
     };
   }
 
+  constructor() {
+    super();
+
+    this.__targetVisibilityObserver = new IntersectionObserver(
+      ([entry]) => {
+        this.__onTargetVisibilityChange(entry.isIntersecting);
+      },
+      { threshold: 1 },
+    );
+  }
+
+  /** @protected */
+  connectedCallback() {
+    super.connectedCallback();
+
+    if (this.target) {
+      this.__targetVisibilityObserver.observe(this.target);
+    }
+  }
+
   /** @protected */
   disconnectedCallback() {
     super.disconnectedCallback();
     this.opened = false;
+    if (this.target) {
+      this.__targetVisibilityObserver.unobserve(this.target);
+    }
   }
 
+  /** @protected */
   ready() {
     super.ready();
 
@@ -125,8 +162,43 @@ export class UserTags extends PolymerElement {
   }
 
   /** @private */
-  __targetChanged(target) {
-    this.$.overlay.positionTarget = target;
+  __onTargetVisibilityChange(isVisible) {
+    this.__isTargetVisible = isVisible;
+
+    // Open the overlay and run the flashing animation for the user tags
+    // that have been enqueued (if any) during a `.setUsers()` call
+    // because the field was not visible at that point.
+    if (isVisible && this.__flashQueue.length > 0 && !this.flashing) {
+      this.flashTags(this.__flashQueue.shift());
+      return;
+    }
+
+    // Open the overlay when the field is visible and focused.
+    // - opens the overlay in the case it was not opened during a `.show()` call because the field was not visible at that point.
+    // - re-opens the overlay in the case it was closed because the focused field became not visible for a while (see the below check).
+    if (isVisible && this.hasFocus) {
+      this.opened = true;
+      return;
+    }
+
+    // Close the overlay when the field is not visible.
+    // The focused field will be re-opened once it becomes visible again (see the above check).
+    if (!isVisible && this.opened) {
+      this.opened = false;
+    }
+  }
+
+  /** @private */
+  __targetChanged(newTarget, oldTarget) {
+    this.$.overlay.positionTarget = newTarget;
+
+    if (oldTarget) {
+      this.__targetVisibilityObserver.unobserve(oldTarget);
+    }
+
+    if (newTarget) {
+      this.__targetVisibilityObserver.observe(newTarget);
+    }
   }
 
   /** @private */
@@ -217,12 +289,12 @@ export class UserTags extends PolymerElement {
     const changedTags = this.getChangedTags(addedUsers, removedUsers);
 
     // Check if flash queue contains pending tags for removed users
-    if (this._flashQueue.length > 0) {
+    if (this.__flashQueue.length > 0) {
       for (let i = 0; i < removedUsers.length; i++) {
         if (changedTags.removed[i] === null) {
-          for (let j = 0; j < this._flashQueue.length; j++) {
-            if (this._flashQueue[j].some((tag) => tag.uid === removedUsers[i].id)) {
-              this.splice('_flashQueue', i, 1);
+          for (let j = 0; j < this.__flashQueue.length; j++) {
+            if (this.__flashQueue[j].some((tag) => tag.uid === removedUsers[i].id)) {
+              this.splice('__flashQueue', i, 1);
             }
           }
         }
@@ -231,16 +303,25 @@ export class UserTags extends PolymerElement {
 
     if (this.opened && this.hasFocus) {
       this.updateTags(users, changedTags);
-    } else if (addedUsers.length && document.visibilityState !== 'hidden') {
+    } else if (addedUsers.length > 0 && document.visibilityState !== 'hidden') {
       // Avoid adding to queue if window is not visible.
-      const tags = changedTags.added;
-      if (this.flashing) {
+
+      const addedTags = changedTags.added;
+      const removedTags = changedTags.removed;
+
+      // Only sync the removed user tags.
+      // The added tags are handled by the `flashTags` method.
+      this.updateTagsSync(users, {
+        added: [],
+        removed: removedTags,
+      });
+
+      if (this.flashing || !this.__isTargetVisible) {
         // Schedule next flash later
-        this.push('_flashQueue', tags);
+        this.push('__flashQueue', addedTags);
       } else {
-        this.flashTags(tags);
+        this.flashTags(addedTags);
       }
-      this.set('users', users);
     } else {
       this.updateTagsSync(users, changedTags);
     }
@@ -271,36 +352,40 @@ export class UserTags extends PolymerElement {
 
     this.flashPromise = new Promise((resolve) => {
       listenOnce(this.$.overlay, 'vaadin-overlay-open').then(() => {
-        this._debounceFlashStart = Debouncer.debounce(this._debounceFlashStart, timeOut.after(DURATION + DELAY), () => {
-          // Animate disappearing
-          if (!this.hasFocus) {
-            added.forEach((tag) => tag.classList.remove('show'));
-          }
-          this._debounceFlashEnd = Debouncer.debounce(this._debounceFlashEnd, timeOut.after(DURATION), () => {
-            // Show all tags
-            const finishFlash = () => {
-              hidden.forEach((tag) => (tag.style.display = 'block'));
-              this.flashing = false;
-              resolve();
-            };
-
-            if (this.hasFocus) {
-              finishFlash();
-            } else {
-              // Wait for overlay closing animation to complete
-              listenOnce(this.$.overlay, 'animationend').then(() => {
-                finishFlash();
-              });
-
-              this.opened = false;
+        this._debounceFlashStart = Debouncer.debounce(
+          this._debounceFlashStart,
+          timeOut.after(this.duration + this.delay),
+          () => {
+            // Animate disappearing
+            if (!this.hasFocus) {
+              added.forEach((tag) => tag.classList.remove('show'));
             }
-          });
-        });
+            this._debounceFlashEnd = Debouncer.debounce(this._debounceFlashEnd, timeOut.after(this.duration), () => {
+              // Show all tags
+              const finishFlash = () => {
+                hidden.forEach((tag) => (tag.style.display = 'block'));
+                this.flashing = false;
+                resolve();
+              };
+
+              if (this.hasFocus) {
+                finishFlash();
+              } else {
+                // Wait for overlay closing animation to complete
+                listenOnce(this.$.overlay, 'animationend').then(() => {
+                  finishFlash();
+                });
+
+                this.opened = false;
+              }
+            });
+          },
+        );
       });
     }).then(() => {
-      if (this._flashQueue.length > 0) {
-        const tags = this._flashQueue[0];
-        this.splice('_flashQueue', 0, 1);
+      if (this.__flashQueue.length > 0) {
+        const tags = this.__flashQueue[0];
+        this.splice('__flashQueue', 0, 1);
         this.flashTags(tags);
       }
     });
@@ -321,7 +406,7 @@ export class UserTags extends PolymerElement {
   updateTags(users, changed) {
     this.applyTagsStart(changed);
 
-    this._debounceRender = Debouncer.debounce(this._debounceRender, timeOut.after(DURATION), () => {
+    this._debounceRender = Debouncer.debounce(this._debounceRender, timeOut.after(this.duration), () => {
       this.set('users', users);
 
       this.applyTagsEnd(changed);
@@ -340,7 +425,9 @@ export class UserTags extends PolymerElement {
 
   show() {
     this.hasFocus = true;
-    this.opened = true;
+    if (this.__isTargetVisible) {
+      this.opened = true;
+    }
   }
 
   hide() {

package/theme/lumo/vaadin-user-tags.js

@@ -3,5 +3,6 @@
  * Copyright (c) 2021 - 2022 Vaadin Ltd.
  * This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
  */
+import '@vaadin/vaadin-overlay/theme/lumo/vaadin-overlay.js';
 import './vaadin-user-tags-styles.js';
 import '../../src/vaadin-user-tags.js';

package/theme/material/vaadin-user-tags.js

@@ -3,5 +3,6 @@
  * Copyright (c) 2021 - 2022 Vaadin Ltd.
  * This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
  */
+import '@vaadin/vaadin-overlay/theme/material/vaadin-overlay.js';
 import './vaadin-user-tags-styles.js';
 import '../../src/vaadin-user-tags.js';