@vaadin/multi-select-combo-box 24.4.0-alpha3 → 24.4.0-alpha5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vaadin/multi-select-combo-box",
-  "version": "24.4.0-alpha3",
+  "version": "24.4.0-alpha5",
   "publishConfig": {
     "access": "public"
   },
@@ -38,17 +38,17 @@
   ],
   "dependencies": {
     "@polymer/polymer": "^3.0.0",
-    "@vaadin/a11y-base": "24.4.0-alpha3",
-    "@vaadin/combo-box": "24.4.0-alpha3",
-    "@vaadin/component-base": "24.4.0-alpha3",
-    "@vaadin/field-base": "24.4.0-alpha3",
-    "@vaadin/input-container": "24.4.0-alpha3",
-    "@vaadin/item": "24.4.0-alpha3",
-    "@vaadin/lit-renderer": "24.4.0-alpha3",
-    "@vaadin/overlay": "24.4.0-alpha3",
-    "@vaadin/vaadin-lumo-styles": "24.4.0-alpha3",
-    "@vaadin/vaadin-material-styles": "24.4.0-alpha3",
-    "@vaadin/vaadin-themable-mixin": "24.4.0-alpha3"
+    "@vaadin/a11y-base": "24.4.0-alpha5",
+    "@vaadin/combo-box": "24.4.0-alpha5",
+    "@vaadin/component-base": "24.4.0-alpha5",
+    "@vaadin/field-base": "24.4.0-alpha5",
+    "@vaadin/input-container": "24.4.0-alpha5",
+    "@vaadin/item": "24.4.0-alpha5",
+    "@vaadin/lit-renderer": "24.4.0-alpha5",
+    "@vaadin/overlay": "24.4.0-alpha5",
+    "@vaadin/vaadin-lumo-styles": "24.4.0-alpha5",
+    "@vaadin/vaadin-material-styles": "24.4.0-alpha5",
+    "@vaadin/vaadin-themable-mixin": "24.4.0-alpha5"
   },
   "devDependencies": {
     "@esm-bundle/chai": "^4.3.4",
@@ -60,5 +60,5 @@
     "web-types.json",
     "web-types.lit.json"
   ],
-  "gitHead": "08563b9e009eb7f90921c172ab7982d64651aea2"
+  "gitHead": "05618f05f9604d328daa3e6501a5a29d522c2ec4"
 }

package/src/vaadin-multi-select-combo-box-internal.js

@@ -60,6 +60,14 @@ class MultiSelectComboBoxInternal extends ComboBoxDataProviderMixin(ComboBoxMixi
         notify: true,
       },
 
+      /**
+       * When true, filter string isn't cleared after selecting an item.
+       */
+      keepFilter: {
+        type: Boolean,
+        value: false,
+      },
+
       /**
        * When set to `true`, "loading" attribute is set
        * on the host and the overlay element.
@@ -236,7 +244,7 @@ class MultiSelectComboBoxInternal extends ComboBoxDataProviderMixin(ComboBoxMixi
 
       if (this.readonly) {
         this.close();
-      } else {
+      } else if (this._hasValidInputValue()) {
         // Keep selected item focused after committing on Enter.
         const focusedItem = this._dropdownItems[this._focusedIndex];
         this._commitValue();
@@ -268,6 +276,30 @@ class MultiSelectComboBoxInternal extends ComboBoxDataProviderMixin(ComboBoxMixi
     super._onEscape(event);
   }
 
+  /**
+   * Override from combo-box to ignore requests to clear the filter if the
+   * keepFilter option is enabled. Exceptions are when the dropdown is closed,
+   * so the filter is still cleared on cancel and focus out.
+   * @protected
+   * @override
+   */
+  _clearFilter() {
+    if (!this.keepFilter || !this.opened) {
+      super._clearFilter();
+    }
+  }
+
+  /**
+   * Override method from combo-box to always clear the filter when reverting
+   * the input value, regardless of the keepFilter option.
+   * @override
+   * @protected
+   */
+  _revertInputValueToValue() {
+    super._revertInputValueToValue();
+    this.filter = '';
+  }
+
   /**
    * @protected
    * @override

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

@@ -274,6 +274,12 @@ declare class MultiSelectComboBox<TItem = ComboBoxDefaultItem> extends HTMLEleme
    */
   i18n: MultiSelectComboBoxI18n;
 
+  /**
+   * When true, filter string isn't cleared after selecting an item.
+   * @attr {boolean} keep-filter
+   */
+  keepFilter: boolean;
+
   /**
    * True when loading items from the data provider, false otherwise.
    */

package/src/vaadin-multi-select-combo-box.js

@@ -183,6 +183,7 @@ class MultiSelectComboBox extends ResizeMixin(InputControlMixin(ThemableMixin(El
           top-group="[[_topGroup]]"
           opened="{{opened}}"
           renderer="[[renderer]]"
+          keep-filter="[[keepFilter]]"
           theme$="[[_theme]]"
           on-combo-box-item-selected="_onComboBoxItemSelected"
           on-change="_onComboBoxChange"
@@ -342,6 +343,14 @@ class MultiSelectComboBox extends ResizeMixin(InputControlMixin(ThemableMixin(El
         },
       },
 
+      /**
+       * When true, filter string isn't cleared after selecting an item.
+       */
+      keepFilter: {
+        type: Boolean,
+        value: false,
+      },
+
       /**
        * True when loading items from the data provider, false otherwise.
        */
@@ -824,10 +833,27 @@ class MultiSelectComboBox extends ResizeMixin(InputControlMixin(ThemableMixin(El
     return selectedItems.indexOf(item);
   }
 
-  /** @private */
-  __clearFilter() {
-    this.filter = '';
-    this.$.comboBox.clear();
+  /**
+   * Clear the internal combo box value and filter. Filter will not be cleared
+   * when the `keepFilter` option is enabled. Using `force` can enforce clearing
+   * the filter.
+   * @param {boolean} force overrides the keepFilter option
+   * @private
+   */
+  __clearInternalValue(force = false) {
+    if (!this.keepFilter || force) {
+      // Clear both combo box value and filter.
+      this.filter = '';
+      this.$.comboBox.clear();
+    } else {
+      // Only clear combo box value. This effectively resets _lastCommittedValue
+      // which allows toggling the same item multiple times via keyboard.
+      this.$.comboBox.clear();
+      // Restore input to the filter value. Needed when items are
+      // navigated with keyboard, which overrides the input value
+      // with the item label.
+      this._inputElementValue = this.filter;
+    }
   }
 
   /** @private */
@@ -859,7 +885,7 @@ class MultiSelectComboBox extends ResizeMixin(InputControlMixin(ThemableMixin(El
       const lastFilter = this._lastFilter;
       // Do not unselect when manually typing and committing an already selected item.
       if (lastFilter && lastFilter.toLowerCase() === itemLabel.toLowerCase()) {
-        this.__clearFilter();
+        this.__clearInternalValue();
         return;
       }
 
@@ -872,7 +898,7 @@ class MultiSelectComboBox extends ResizeMixin(InputControlMixin(ThemableMixin(El
     this.__updateSelection(itemsCopy);
 
     // Suppress `value-changed` event.
-    this.__clearFilter();
+    this.__clearInternalValue();
 
     this.__announceItem(itemLabel, isSelected, itemsCopy.length);
   }
@@ -1232,7 +1258,7 @@ class MultiSelectComboBox extends ResizeMixin(InputControlMixin(ThemableMixin(El
     // Stop the original event
     event.stopPropagation();
 
-    this.__clearFilter();
+    this.__clearInternalValue(true);
 
     this.dispatchEvent(
       new CustomEvent('custom-value-set', {

package/theme/lumo/vaadin-multi-select-combo-box-chip-styles.d.ts

@@ -0,0 +1,10 @@
+/**
+ * @license
+ * Copyright (c) 2021 - 2024 Vaadin Ltd.
+ * This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
+ */
+import '@vaadin/vaadin-lumo-styles/color.js';
+import '@vaadin/vaadin-lumo-styles/font-icons.js';
+import '@vaadin/vaadin-lumo-styles/spacing.js';
+import '@vaadin/vaadin-lumo-styles/style.js';
+import '@vaadin/vaadin-lumo-styles/typography.js';

package/theme/lumo/vaadin-multi-select-combo-box-styles.d.ts

@@ -0,0 +1,10 @@
+/**
+ * @license
+ * Copyright (c) 2021 - 2024 Vaadin Ltd.
+ * This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
+ */
+import '@vaadin/input-container/theme/lumo/vaadin-input-container-styles.js';
+import '@vaadin/vaadin-lumo-styles/color.js';
+import '@vaadin/vaadin-lumo-styles/font-icons.js';
+import '@vaadin/vaadin-lumo-styles/style.js';
+import '@vaadin/vaadin-lumo-styles/typography.js';

package/theme/lumo/vaadin-multi-select-combo-box.d.ts

@@ -0,0 +1,8 @@
+/**
+ * @license
+ * Copyright (c) 2021 - 2024 Vaadin Ltd.
+ * This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
+ */
+import './vaadin-multi-select-combo-box-chip-styles.js';
+import './vaadin-multi-select-combo-box-styles.js';
+import '../../src/vaadin-multi-select-combo-box.js';

package/theme/material/vaadin-multi-select-combo-box-chip-styles.d.ts

@@ -0,0 +1,8 @@
+/**
+ * @license
+ * Copyright (c) 2021 - 2024 Vaadin Ltd.
+ * This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
+ */
+import '@vaadin/vaadin-material-styles/color.js';
+import '@vaadin/vaadin-material-styles/font-icons.js';
+import '@vaadin/vaadin-material-styles/typography.js';

package/theme/material/vaadin-multi-select-combo-box-styles.d.ts

@@ -0,0 +1,9 @@
+/**
+ * @license
+ * Copyright (c) 2021 - 2024 Vaadin Ltd.
+ * This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
+ */
+import '@vaadin/input-container/theme/material/vaadin-input-container-styles.js';
+import '@vaadin/vaadin-material-styles/color.js';
+import '@vaadin/vaadin-material-styles/font-icons.js';
+import '@vaadin/vaadin-material-styles/typography.js';

package/theme/material/vaadin-multi-select-combo-box.d.ts

@@ -0,0 +1,8 @@
+/**
+ * @license
+ * Copyright (c) 2021 - 2024 Vaadin Ltd.
+ * This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
+ */
+import './vaadin-multi-select-combo-box-chip-styles.js';
+import './vaadin-multi-select-combo-box-styles.js';
+import '../../src/vaadin-multi-select-combo-box.js';

package/web-types.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://json.schemastore.org/web-types",
   "name": "@vaadin/multi-select-combo-box",
-  "version": "24.4.0-alpha3",
+  "version": "24.4.0-alpha5",
   "description-markup": "markdown",
   "contributions": {
     "html": {
@@ -263,6 +263,17 @@
                 ]
               }
             },
+            {
+              "name": "keep-filter",
+              "description": "When true, filter string isn't cleared after selecting an item.",
+              "value": {
+                "type": [
+                  "boolean",
+                  "null",
+                  "undefined"
+                ]
+              }
+            },
             {
               "name": "loading",
               "description": "True when loading items from the data provider, false otherwise.",
@@ -627,6 +638,17 @@
                   ]
                 }
               },
+              {
+                "name": "keepFilter",
+                "description": "When true, filter string isn't cleared after selecting an item.",
+                "value": {
+                  "type": [
+                    "boolean",
+                    "null",
+                    "undefined"
+                  ]
+                }
+              },
               {
                 "name": "loading",
                 "description": "True when loading items from the data provider, false otherwise.",

package/web-types.lit.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://json.schemastore.org/web-types",
   "name": "@vaadin/multi-select-combo-box",
-  "version": "24.4.0-alpha3",
+  "version": "24.4.0-alpha5",
   "description-markup": "markdown",
   "framework": "lit",
   "framework-config": {
@@ -89,6 +89,13 @@
                 "kind": "expression"
               }
             },
+            {
+              "name": "?keepFilter",
+              "description": "When true, filter string isn't cleared after selecting an item.",
+              "value": {
+                "kind": "expression"
+              }
+            },
             {
               "name": "?loading",
               "description": "True when loading items from the data provider, false otherwise.",