@vaadin/combo-box 23.0.0-alpha1 → 23.0.0-alpha5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vaadin/combo-box",
-  "version": "23.0.0-alpha1",
+  "version": "23.0.0-alpha5",
   "publishConfig": {
     "access": "public"
   },
@@ -17,6 +17,7 @@
     "url": "https://github.com/vaadin/web-components/issues"
   },
   "main": "vaadin-combo-box.js",
+  "type": "module",
   "files": [
     "src",
     "theme",
@@ -32,25 +33,24 @@
   ],
   "dependencies": {
     "@open-wc/dedupe-mixin": "^1.3.0",
-    "@polymer/iron-resizable-behavior": "^3.0.0",
     "@polymer/polymer": "^3.0.0",
-    "@vaadin/component-base": "23.0.0-alpha1",
-    "@vaadin/field-base": "23.0.0-alpha1",
-    "@vaadin/input-container": "23.0.0-alpha1",
-    "@vaadin/item": "23.0.0-alpha1",
-    "@vaadin/vaadin-lumo-styles": "23.0.0-alpha1",
-    "@vaadin/vaadin-material-styles": "23.0.0-alpha1",
-    "@vaadin/vaadin-overlay": "23.0.0-alpha1",
-    "@vaadin/vaadin-themable-mixin": "23.0.0-alpha1"
+    "@vaadin/component-base": "23.0.0-alpha5",
+    "@vaadin/field-base": "23.0.0-alpha5",
+    "@vaadin/input-container": "23.0.0-alpha5",
+    "@vaadin/item": "23.0.0-alpha5",
+    "@vaadin/vaadin-lumo-styles": "23.0.0-alpha5",
+    "@vaadin/vaadin-material-styles": "23.0.0-alpha5",
+    "@vaadin/vaadin-overlay": "23.0.0-alpha5",
+    "@vaadin/vaadin-themable-mixin": "23.0.0-alpha5"
   },
   "devDependencies": {
     "@esm-bundle/chai": "^4.3.4",
-    "@vaadin/dialog": "23.0.0-alpha1",
-    "@vaadin/polymer-legacy-adapter": "23.0.0-alpha1",
+    "@vaadin/dialog": "23.0.0-alpha5",
+    "@vaadin/polymer-legacy-adapter": "23.0.0-alpha5",
     "@vaadin/testing-helpers": "^0.3.2",
-    "@vaadin/text-field": "23.0.0-alpha1",
+    "@vaadin/text-field": "23.0.0-alpha5",
     "lit": "^2.0.0",
     "sinon": "^9.2.0"
   },
-  "gitHead": "fbcb07328fdf88260e3b461088d207426b21c710"
+  "gitHead": "74f9294964eb8552d96578c14af6ad214f5257bc"
 }

package/src/vaadin-combo-box-data-provider-mixin.d.ts

@@ -1,6 +1,6 @@
 /**
  * @license
- * Copyright (c) 2021 Vaadin Ltd.
+ * Copyright (c) 2015 - 2022 Vaadin Ltd.
  * This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
  */
 import { Constructor } from '@open-wc/dedupe-mixin';

package/src/vaadin-combo-box-data-provider-mixin.js

@@ -1,6 +1,6 @@
 /**
  * @license
- * Copyright (c) 2021 Vaadin Ltd.
+ * Copyright (c) 2015 - 2022 Vaadin Ltd.
  * This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
  */
 import { ComboBoxPlaceholder } from './vaadin-combo-box-placeholder.js';
@@ -158,9 +158,8 @@ export const ComboBoxDataProviderMixin = (superClass) =>
       const loadedItem = this.filteredItems[page * this.pageSize];
       if (loadedItem !== undefined) {
         return loadedItem instanceof ComboBoxPlaceholder;
-      } else {
-        return this.size === undefined;
       }
+      return this.size === undefined;
     }
 
     /** @private */

package/src/vaadin-combo-box-dropdown.js

@@ -1,13 +1,11 @@
 /**
  * @license
- * Copyright (c) 2021 Vaadin Ltd.
+ * Copyright (c) 2015 - 2022 Vaadin Ltd.
  * This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
  */
 import './vaadin-combo-box-item.js';
 import './vaadin-combo-box-overlay.js';
 import './vaadin-combo-box-scroller.js';
-import { IronResizableBehavior } from '@polymer/iron-resizable-behavior/iron-resizable-behavior.js';
-import { mixinBehaviors } from '@polymer/polymer/lib/legacy/class.js';
 import { html, PolymerElement } from '@polymer/polymer/polymer-element.js';
 
 /**
@@ -16,7 +14,7 @@ import { html, PolymerElement } from '@polymer/polymer/polymer-element.js';
  * @extends HTMLElement
  * @private
  */
-export class ComboBoxDropdown extends mixinBehaviors(IronResizableBehavior, PolymerElement) {
+export class ComboBoxDropdown extends PolymerElement {
   static get is() {
     return 'vaadin-combo-box-dropdown';
   }
@@ -31,6 +29,8 @@ export class ComboBoxDropdown extends mixinBehaviors(IronResizableBehavior, Poly
         theme$="[[theme]]"
         position-target="[[positionTarget]]"
         no-vertical-overlap
+        restore-focus-on-close="[[restoreFocusOnClose]]"
+        restore-focus-node="[[restoreFocusNode]]"
       ></vaadin-combo-box-overlay>
     `;
   }
@@ -171,14 +171,6 @@ export class ComboBoxDropdown extends mixinBehaviors(IronResizableBehavior, Poly
     this._overlayOpened = false;
   }
 
-  notifyResize() {
-    super.notifyResize();
-
-    if (this.positionTarget && this.opened) {
-      this._setOverlayWidth();
-    }
-  }
-
   _fireTouchAction(sourceEvent) {
     this.dispatchEvent(
       new CustomEvent('vaadin-overlay-touch-action', {
@@ -262,6 +254,7 @@ export class ComboBoxDropdown extends mixinBehaviors(IronResizableBehavior, Poly
     }
   }
 
+  // eslint-disable-next-line max-params
   __updateScroller(scroller, items, opened, loading, selectedItem, itemIdPath, focusedIndex, renderer, theme) {
     if (scroller) {
       scroller.setProperties({

package/src/vaadin-combo-box-item.js

@@ -1,6 +1,6 @@
 /**
  * @license
- * Copyright (c) 2021 Vaadin Ltd.
+ * Copyright (c) 2015 - 2022 Vaadin Ltd.
  * This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
  */
 import { html, PolymerElement } from '@polymer/polymer/polymer-element.js';
@@ -140,7 +140,7 @@ export class ComboBoxItem extends ThemableMixin(DirMixin(PolymerElement)) {
   }
 
   /** @private */
-  __rendererOrItemChanged(renderer, index, item, _selected, _focused) {
+  __rendererOrItemChanged(renderer, index, item) {
     if (item === undefined || index === undefined) {
       return;
     }
@@ -161,7 +161,9 @@ export class ComboBoxItem extends ThemableMixin(DirMixin(PolymerElement)) {
 
   /** @private */
   __updateLabel(label, renderer) {
-    if (renderer) return;
+    if (renderer) {
+      return;
+    }
 
     this.textContent = label;
   }

package/src/vaadin-combo-box-light.d.ts

@@ -1,6 +1,6 @@
 /**
  * @license
- * Copyright (c) 2021 Vaadin Ltd.
+ * Copyright (c) 2015 - 2022 Vaadin Ltd.
  * This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
  */
 import { DisabledMixinClass } from '@vaadin/component-base/src/disabled-mixin.js';

package/src/vaadin-combo-box-light.js

@@ -1,6 +1,6 @@
 /**
  * @license
- * Copyright (c) 2021 Vaadin Ltd.
+ * Copyright (c) 2015 - 2022 Vaadin Ltd.
  * This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
  */
 import './vaadin-combo-box-dropdown.js';
@@ -79,6 +79,8 @@ class ComboBoxLight extends ComboBoxDataProviderMixin(ComboBoxMixin(ThemableMixi
         id="dropdown"
         opened="[[opened]]"
         position-target="[[inputElement]]"
+        restore-focus-on-close="[[__restoreFocusOnClose]]"
+        restore-focus-node="[[inputElement]]"
         renderer="[[renderer]]"
         _focused-index="[[_focusedIndex]]"
         _item-id-path="[[itemIdPath]]"
@@ -133,9 +135,8 @@ class ComboBoxLight extends ComboBoxDataProviderMixin(ComboBoxMixin(ThemableMixi
   checkValidity() {
     if (this.inputElement.validate) {
       return this.inputElement.validate();
-    } else {
-      return super.checkValidity();
     }
+    return super.checkValidity();
   }
 
   /**

package/src/vaadin-combo-box-mixin.d.ts

@@ -1,6 +1,6 @@
 /**
  * @license
- * Copyright (c) 2021 Vaadin Ltd.
+ * Copyright (c) 2015 - 2022 Vaadin Ltd.
  * This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
  */
 import { Constructor } from '@open-wc/dedupe-mixin';

package/src/vaadin-combo-box-mixin.js

@@ -1,20 +1,23 @@
 /**
  * @license
- * Copyright (c) 2021 Vaadin Ltd.
+ * Copyright (c) 2015 - 2022 Vaadin Ltd.
  * This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
  */
 import { isTouch } from '@vaadin/component-base/src/browser-utils.js';
+import { ControllerMixin } from '@vaadin/component-base/src/controller-mixin.js';
 import { DisabledMixin } from '@vaadin/component-base/src/disabled-mixin.js';
 import { KeyboardMixin } from '@vaadin/component-base/src/keyboard-mixin.js';
 import { processTemplates } from '@vaadin/component-base/src/templates.js';
 import { InputMixin } from '@vaadin/field-base/src/input-mixin.js';
+import { VirtualKeyboardController } from '@vaadin/field-base/src/virtual-keyboard-controller.js';
 import { ComboBoxPlaceholder } from './vaadin-combo-box-placeholder.js';
 
 /**
  * @polymerMixin
+ * @param {function(new:HTMLElement)} subclass
  */
 export const ComboBoxMixin = (subclass) =>
-  class VaadinComboBoxMixinElement extends KeyboardMixin(InputMixin(DisabledMixin(subclass))) {
+  class VaadinComboBoxMixinElement extends ControllerMixin(KeyboardMixin(InputMixin(DisabledMixin(subclass)))) {
     static get properties() {
       return {
         /**
@@ -190,7 +193,10 @@ export const ComboBoxMixin = (subclass) =>
         },
 
         /** @private */
-        _closeOnBlurIsPrevented: Boolean
+        _closeOnBlurIsPrevented: Boolean,
+
+        /** @private */
+        __restoreFocusOnClose: Boolean
       };
     }
 
@@ -292,6 +298,8 @@ export const ComboBoxMixin = (subclass) =>
       this.addEventListener('touchstart', bringToFrontListener);
 
       processTemplates(this);
+
+      this.addController(new VirtualKeyboardController(this));
     }
 
     /**
@@ -305,6 +313,8 @@ export const ComboBoxMixin = (subclass) =>
         return;
       }
 
+      this.$.dropdown._scroller.requestContentUpdate();
+
       this._getItemElements().forEach((item) => {
         item.requestContentUpdate();
       });
@@ -364,6 +374,8 @@ export const ComboBoxMixin = (subclass) =>
         if (!this.hasAttribute('focused') && !isTouch) {
           this.focus();
         }
+
+        this.__restoreFocusOnClose = true;
       } else {
         this._onClosed();
         if (this._openedWithFocusRing && this.hasAttribute('focused')) {
@@ -404,6 +416,11 @@ export const ComboBoxMixin = (subclass) =>
     _handleClearButtonClick(event) {
       event.preventDefault();
       this._clear();
+
+      // De-select dropdown item
+      if (this.opened) {
+        this.requestContentUpdate();
+      }
     }
 
     /** @private */
@@ -435,23 +452,25 @@ export const ComboBoxMixin = (subclass) =>
      * @override
      */
     _onKeyDown(e) {
-      if (e.keyCode === 40) {
+      if (e.key === 'Tab') {
+        this.__restoreFocusOnClose = false;
+      } else if (e.key === 'ArrowDown') {
         this._closeOnBlurIsPrevented = true;
         this._onArrowDown();
         this._closeOnBlurIsPrevented = false;
 
         // prevent caret from moving
         e.preventDefault();
-      } else if (e.keyCode === 38) {
+      } else if (e.key === 'ArrowUp') {
         this._closeOnBlurIsPrevented = true;
         this._onArrowUp();
         this._closeOnBlurIsPrevented = false;
 
         // prevent caret from moving
         e.preventDefault();
-      } else if (e.keyCode === 13) {
+      } else if (e.key === 'Enter') {
         this._onEnter(e);
-      } else if (e.keyCode === 27) {
+      } else if (e.key === 'Escape') {
         this._onEscape(e);
       }
     }
@@ -581,25 +600,23 @@ export const ComboBoxMixin = (subclass) =>
           // The clear button is visible and the overlay is closed, so clear the value.
           this._clear();
         }
-      } else {
+      } else if (this.opened) {
         // Auto-open is enabled
-        if (this.opened) {
-          // The overlay is open
-          e.stopPropagation();
+        // The overlay is open
+        e.stopPropagation();
 
-          if (this._focusedIndex > -1) {
-            // An item is focused, revert the input to the filtered value
-            this._focusedIndex = -1;
-            this._revertInputValue();
-          } else {
-            // No item is focused, cancel the change and close the overlay
-            this.cancel();
-          }
-        } else if (this.clearButtonVisible && !!this.value) {
-          e.stopPropagation();
-          // The clear button is visible and the overlay is closed, so clear the value.
-          this._clear();
+        if (this._focusedIndex > -1) {
+          // An item is focused, revert the input to the filtered value
+          this._focusedIndex = -1;
+          this._revertInputValue();
+        } else {
+          // No item is focused, cancel the change and close the overlay
+          this.cancel();
         }
+      } else if (this.clearButtonVisible && !!this.value) {
+        e.stopPropagation();
+        // The clear button is visible and the overlay is closed, so clear the value.
+        this._clear();
       }
     }
 
@@ -643,8 +660,6 @@ export const ComboBoxMixin = (subclass) =>
 
     /** @private */
     _onOpened() {
-      setTimeout(() => this._resizeDropdown(), 1);
-
       // Defer scroll position adjustment to improve performance.
       requestAnimationFrame(() => {
         this.$.dropdown.adjustScrollPosition();
@@ -687,17 +702,20 @@ export const ComboBoxMixin = (subclass) =>
         }
       } else {
         const toLowerCase = (item) => item && item.toLowerCase && item.toLowerCase();
-        const itemsMatchedByLabel =
-          (this.filteredItems &&
-            this.filteredItems.filter(
-              (item) => toLowerCase(this._getItemLabel(item)) === toLowerCase(this._inputElementValue)
-            )) ||
-          [];
+
+        // Try to find an item whose label matches the input value. A matching item is searched from
+        // the filteredItems array (if available) and the selectedItem (if available).
+        const itemMatchingByLabel = [...(this.filteredItems || []), this.selectedItem].find((item) => {
+          return toLowerCase(this._getItemLabel(item)) === toLowerCase(this._inputElementValue);
+        });
+
         if (
           this.allowCustomValue &&
           // to prevent a repetitive input value being saved after pressing ESC and Tab.
-          !itemsMatchedByLabel.length
+          !itemMatchingByLabel
         ) {
+          // An item matching by label was not found, but custom values are allowed.
+          // Dispatch a custom-value-set event with the input value.
           const e = new CustomEvent('custom-value-set', {
             detail: this._inputElementValue,
             composed: true,
@@ -710,9 +728,11 @@ export const ComboBoxMixin = (subclass) =>
             this._selectItemForValue(customValue);
             this.value = customValue;
           }
-        } else if (!this.allowCustomValue && !this.opened && itemsMatchedByLabel.length > 0) {
-          this.value = this._getItemValue(itemsMatchedByLabel[0]);
+        } else if (!this.allowCustomValue && !this.opened && itemMatchingByLabel) {
+          // An item matching by label was found, select it.
+          this.value = this._getItemValue(itemMatchingByLabel);
         } else {
+          // Revert the input value
           this._inputElementValue = this.selectedItem ? this._getItemLabel(this.selectedItem) : this.value || '';
         }
       }
@@ -820,11 +840,6 @@ export const ComboBoxMixin = (subclass) =>
       }
     }
 
-    /** @private */
-    _resizeDropdown() {
-      this.$.dropdown.notifyResize();
-    }
-
     /** @private */
     _selectedItemChanged(selectedItem) {
       if (selectedItem === null || selectedItem === undefined) {
@@ -931,10 +946,14 @@ export const ComboBoxMixin = (subclass) =>
       if (e.path === 'filteredItems' || e.path === 'filteredItems.splices') {
         this._setOverlayItems(this.filteredItems);
 
-        this._focusedIndex =
-          this.opened || this.autoOpenDisabled
-            ? this.$.dropdown.indexOfLabel(this.filter)
-            : this._indexOfValue(this.value, this.filteredItems);
+        const filterIndex = this.$.dropdown.indexOfLabel(this.filter);
+        if (this.opened) {
+          this._focusedIndex = filterIndex;
+        } else {
+          // Pre-select item matching the filter to focus it later when overlay opens
+          const valueIndex = this._indexOfValue(this.value, this.filteredItems);
+          this._focusedIndex = filterIndex === -1 ? valueIndex : filterIndex;
+        }
 
         // see https://github.com/vaadin/web-components/issues/2615
         if (this.selectedItem === null && this._focusedIndex >= 0) {

package/src/vaadin-combo-box-overlay.js

@@ -1,6 +1,6 @@
 /**
  * @license
- * Copyright (c) 2021 Vaadin Ltd.
+ * Copyright (c) 2015 - 2022 Vaadin Ltd.
  * This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
  */
 import { OverlayElement } from '@vaadin/vaadin-overlay/src/vaadin-overlay.js';

package/src/vaadin-combo-box-placeholder.js

@@ -1,6 +1,6 @@
 /**
  * @license
- * Copyright (c) 2021 Vaadin Ltd.
+ * Copyright (c) 2015 - 2022 Vaadin Ltd.
  * This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
  */
 

package/src/vaadin-combo-box-scroller.js

@@ -1,6 +1,6 @@
 /**
  * @license
- * Copyright (c) 2021 Vaadin Ltd.
+ * Copyright (c) 2015 - 2022 Vaadin Ltd.
  * This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
  */
 import { html, PolymerElement } from '@polymer/polymer/polymer-element.js';
@@ -136,8 +136,8 @@ export class ComboBoxScroller extends PolymerElement {
   }
 
   __openedChanged(opened) {
-    if (this.__virtualizer && opened) {
-      this.__virtualizer.update();
+    if (opened) {
+      this.requestContentUpdate();
     }
   }
 
@@ -163,6 +163,12 @@ export class ComboBoxScroller extends PolymerElement {
     });
   }
 
+  requestContentUpdate() {
+    if (this.__virtualizer) {
+      this.__virtualizer.update();
+    }
+  }
+
   scrollIntoView(index) {
     if (!(this.opened && index >= 0)) {
       return;
@@ -221,9 +227,8 @@ export class ComboBoxScroller extends PolymerElement {
       return false;
     } else if (itemIdPath && item !== undefined && selectedItem !== undefined) {
       return this.get(itemIdPath, item) === this.get(itemIdPath, selectedItem);
-    } else {
-      return item === selectedItem;
     }
+    return item === selectedItem;
   }
 
   /** @private */
@@ -233,29 +238,29 @@ export class ComboBoxScroller extends PolymerElement {
       this.__virtualizer.flush();
       // Ensure the total count of items is properly announced.
       this.setAttribute('aria-setsize', items.length);
-      this.__virtualizer.update();
+      this.requestContentUpdate();
     }
   }
 
   /** @private */
   __loadingChanged(loading) {
     if (this.__virtualizer && !loading) {
-      setTimeout(() => this.__virtualizer.update());
+      setTimeout(() => this.requestContentUpdate());
     }
   }
 
   /** @private */
   __focusedIndexChanged(index) {
     if (this.__virtualizer && index >= 0) {
-      this.__virtualizer.update();
+      this.requestContentUpdate();
       this.scrollIntoView(index);
     }
   }
 
   /** @private */
   __rendererChanged(renderer, oldRenderer) {
-    if (this.__virtualizer && (renderer || oldRenderer)) {
-      this.__virtualizer.update();
+    if (renderer || oldRenderer) {
+      this.requestContentUpdate();
     }
   }
 
@@ -288,7 +293,7 @@ export class ComboBoxScroller extends PolymerElement {
     el.id = `${this.__hostTagName}-item-${index}`;
     el.setAttribute('role', this.__getAriaRole(index));
     el.setAttribute('aria-selected', this.__getAriaSelected(focusedIndex, index));
-    el.setAttribute('aria-posinset', index);
+    el.setAttribute('aria-posinset', index + 1);
 
     if (this.theme) {
       el.setAttribute('theme', this.theme);

package/src/vaadin-combo-box.d.ts

@@ -1,6 +1,6 @@
 /**
  * @license
- * Copyright (c) 2021 Vaadin Ltd.
+ * Copyright (c) 2015 - 2022 Vaadin Ltd.
  * This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
  */
 import { ControllerMixinClass } from '@vaadin/component-base/src/controller-mixin.js';

package/src/vaadin-combo-box.js

@@ -1,6 +1,6 @@
 /**
  * @license
- * Copyright (c) 2021 Vaadin Ltd.
+ * Copyright (c) 2015 - 2022 Vaadin Ltd.
  * This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
  */
 import '@vaadin/input-container/src/vaadin-input-container.js';
@@ -201,6 +201,8 @@ class ComboBox extends ComboBoxDataProviderMixin(
         opened="[[opened]]"
         renderer="[[renderer]]"
         position-target="[[_positionTarget]]"
+        restore-focus-on-close="[[__restoreFocusOnClose]]"
+        restore-focus-node="[[inputElement]]"
         _focused-index="[[_focusedIndex]]"
         _item-id-path="[[itemIdPath]]"
         _item-label-path="[[itemLabelPath]]"
@@ -242,7 +244,7 @@ class ComboBox extends ComboBoxDataProviderMixin(
         this.ariaTarget = input;
       })
     );
-    this.addController(new LabelledInputController(this.inputElement, this._labelNode));
+    this.addController(new LabelledInputController(this.inputElement, this._labelController));
     this._positionTarget = this.shadowRoot.querySelector('[part="input-field"]');
     this._toggleElement = this.$.toggleButton;
   }