@vaadin/multi-select-combo-box 23.3.29 → 23.4.0-alpha2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vaadin/multi-select-combo-box",
-  "version": "23.3.29",
+  "version": "23.4.0-alpha2",
   "publishConfig": {
     "access": "public"
   },
@@ -37,14 +37,14 @@
   ],
   "dependencies": {
     "@polymer/polymer": "^3.0.0",
-    "@vaadin/combo-box": "~23.3.29",
-    "@vaadin/component-base": "~23.3.29",
-    "@vaadin/field-base": "~23.3.29",
-    "@vaadin/input-container": "~23.3.29",
-    "@vaadin/lit-renderer": "~23.3.29",
-    "@vaadin/vaadin-lumo-styles": "~23.3.29",
-    "@vaadin/vaadin-material-styles": "~23.3.29",
-    "@vaadin/vaadin-themable-mixin": "~23.3.29"
+    "@vaadin/combo-box": "23.4.0-alpha2",
+    "@vaadin/component-base": "23.4.0-alpha2",
+    "@vaadin/field-base": "23.4.0-alpha2",
+    "@vaadin/input-container": "23.4.0-alpha2",
+    "@vaadin/lit-renderer": "23.4.0-alpha2",
+    "@vaadin/vaadin-lumo-styles": "23.4.0-alpha2",
+    "@vaadin/vaadin-material-styles": "23.4.0-alpha2",
+    "@vaadin/vaadin-themable-mixin": "23.4.0-alpha2"
   },
   "devDependencies": {
     "@esm-bundle/chai": "^4.3.4",
@@ -56,5 +56,5 @@
     "web-types.json",
     "web-types.lit.json"
   ],
-  "gitHead": "5e34a34170af02e934a759c9e2f4b100202504c7"
+  "gitHead": "3fa9a5d13db6baf0307f863669ab2f3f5114c6a0"
 }

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

@@ -13,6 +13,10 @@ registerStyles(
       display: flex;
       width: 100%;
     }
+
+    :host([auto-expand-vertically]) #wrapper {
+      flex-wrap: wrap;
+    }
   `,
   {
     moduleId: 'vaadin-multi-select-combo-box-container-styles',
@@ -47,6 +51,21 @@ class MultiSelectComboBoxContainer extends InputContainer {
     }
     return memoizedTemplate;
   }
+
+  static get properties() {
+    return {
+      /**
+       * Set to true to not collapse selected items chips into the overflow
+       * chip and instead always expand vertically, causing input field to
+       * wrap into multiple lines when width is limited.
+       * @attr {boolean} auto-expand-vertically
+       */
+      autoExpandVertically: {
+        type: Boolean,
+        reflectToAttribute: true,
+      },
+    };
+  }
 }
 
 customElements.define(MultiSelectComboBoxContainer.is, MultiSelectComboBoxContainer);

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

@@ -86,6 +86,15 @@ class MultiSelectComboBoxInternal extends ComboBoxDataProviderMixin(ComboBoxMixi
         value: () => [],
       },
 
+      /**
+       * Set to true to group selected items at the top of the overlay.
+       * @attr {boolean} selected-items-on-top
+       */
+      selectedItemsOnTop: {
+        type: Boolean,
+        value: false,
+      },
+
       /**
        * Last input value entered by the user before value is updated.
        * Used to store `filter` property value before clearing it.
@@ -95,6 +104,14 @@ class MultiSelectComboBoxInternal extends ComboBoxDataProviderMixin(ComboBoxMixi
         notify: true,
       },
 
+      /**
+       * A subset of items to be shown at the top of the overlay.
+       */
+      topGroup: {
+        type: Array,
+        observer: '_topGroupChanged',
+      },
+
       _target: {
         type: Object,
       },
@@ -138,6 +155,39 @@ class MultiSelectComboBoxInternal extends ComboBoxDataProviderMixin(ComboBoxMixi
     this._toggleElement = this.querySelector('.toggle-button');
   }
 
+  /**
+   * Override combo-box method to group selected
+   * items at the top of the overlay.
+   *
+   * @protected
+   * @override
+   */
+  _setDropdownItems(items) {
+    if (this.filter || this.readonly || !this.selectedItemsOnTop) {
+      this._dropdownItems = items;
+      return;
+    }
+
+    if (items && items.length && this.topGroup && this.topGroup.length) {
+      // Filter out items included to the top group.
+      const filteredItems = items.filter(
+        (item) => this._comboBox._findIndex(item, this.topGroup, this.itemIdPath) === -1,
+      );
+
+      this._dropdownItems = this.topGroup.concat(filteredItems);
+      return;
+    }
+
+    this._dropdownItems = items;
+  }
+
+  /** @private */
+  _topGroupChanged(topGroup) {
+    if (topGroup) {
+      this._setDropdownItems(this.filteredItems);
+    }
+  }
+
   /**
    * Override combo-box method to set correct owner for using by item renderers.
    * This needs to be done before the scroller gets added to the DOM to ensure
@@ -149,6 +199,8 @@ class MultiSelectComboBoxInternal extends ComboBoxDataProviderMixin(ComboBoxMixi
   _initScroller() {
     const comboBox = this.getRootNode().host;
 
+    this._comboBox = comboBox;
+
     super._initScroller(comboBox);
   }
 
@@ -193,9 +245,9 @@ class MultiSelectComboBoxInternal extends ComboBoxDataProviderMixin(ComboBoxMixi
       this.__enterPressed = null;
 
       // Keep selected item focused after committing on Enter.
-      const focusedItem = this.filteredItems[this._focusedIndex];
+      const focusedItem = this._dropdownItems[this._focusedIndex];
       this._commitValue();
-      this._focusedIndex = this.filteredItems.indexOf(focusedItem);
+      this._focusedIndex = this._dropdownItems.indexOf(focusedItem);
 
       return;
     }

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

@@ -166,6 +166,21 @@ export interface MultiSelectComboBoxEventMap<TItem> extends HTMLElementEventMap
  * @fires {CustomEvent} validated - Fired whenever the field is validated.
  */
 declare class MultiSelectComboBox<TItem = ComboBoxDefaultItem> extends HTMLElement {
+  /**
+   * Set to true to auto expand horizontally, causing input field to
+   * grow until max width is reached.
+   * @attr {boolean} auto-expand-horizontally
+   */
+  autoExpandHorizontally: boolean;
+
+  /**
+   * Set to true to not collapse selected items chips into the overflow
+   * chip and instead always expand vertically, causing input field to
+   * wrap into multiple lines when width is limited.
+   * @attr {boolean} auto-expand-vertically
+   */
+  autoExpandVertically: boolean;
+
   /**
    * When true, the user can input a value that is not present in the items list.
    * @attr {boolean} allow-custom-value
@@ -295,6 +310,12 @@ declare class MultiSelectComboBox<TItem = ComboBoxDefaultItem> extends HTMLEleme
    */
   selectedItems: TItem[];
 
+  /**
+   * Set to true to group selected items at the top of the overlay.
+   * @attr {boolean} selected-items-on-top
+   */
+  selectedItemsOnTop: boolean;
+
   /**
    * Total number of items.
    */

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

@@ -46,6 +46,14 @@ const multiSelectComboBox = css`
     flex-basis: 0;
     padding: 0;
   }
+
+  :host([auto-expand-vertically]) #chips {
+    display: contents;
+  }
+
+  :host([auto-expand-horizontally]) [class$='container'] {
+    width: auto;
+  }
 `;
 
 registerStyles('vaadin-multi-select-combo-box', [inputFieldShared, multiSelectComboBox], {
@@ -167,6 +175,8 @@ class MultiSelectComboBox extends ResizeMixin(InputControlMixin(ThemableMixin(El
           size="{{size}}"
           filtered-items="[[__effectiveFilteredItems]]"
           selected-items="[[selectedItems]]"
+          selected-items-on-top="[[selectedItemsOnTop]]"
+          top-group="[[_topGroup]]"
           opened="{{opened}}"
           renderer="[[renderer]]"
           theme$="[[_theme]]"
@@ -177,6 +187,7 @@ class MultiSelectComboBox extends ResizeMixin(InputControlMixin(ThemableMixin(El
         >
           <vaadin-multi-select-combo-box-container
             part="input-field"
+            auto-expand-vertically="[[autoExpandVertically]]"
             readonly="[[readonly]]"
             disabled="[[disabled]]"
             invalid="[[invalid]]"
@@ -221,6 +232,31 @@ class MultiSelectComboBox extends ResizeMixin(InputControlMixin(ThemableMixin(El
 
   static get properties() {
     return {
+      /**
+       * Set to true to auto expand horizontally, causing input field to
+       * grow until max width is reached.
+       * @attr {boolean} auto-expand-horizontally
+       */
+      autoExpandHorizontally: {
+        type: Boolean,
+        value: false,
+        reflectToAttribute: true,
+        observer: '_autoExpandHorizontallyChanged',
+      },
+
+      /**
+       * Set to true to not collapse selected items chips into the overflow
+       * chip and instead always expand vertically, causing input field to
+       * wrap into multiple lines when width is limited.
+       * @attr {boolean} auto-expand-vertically
+       */
+      autoExpandVertically: {
+        type: Boolean,
+        value: false,
+        reflectToAttribute: true,
+        observer: '_autoExpandVerticallyChanged',
+      },
+
       /**
        * Set true to prevent the overlay from opening automatically.
        * @attr {boolean} auto-open-disabled
@@ -431,6 +467,15 @@ class MultiSelectComboBox extends ResizeMixin(InputControlMixin(ThemableMixin(El
        */
       filteredItems: Array,
 
+      /**
+       * Set to true to group selected items at the top of the overlay.
+       * @attr {boolean} selected-items-on-top
+       */
+      selectedItemsOnTop: {
+        type: Boolean,
+        value: false,
+      },
+
       /** @private */
       value: {
         type: String,
@@ -465,11 +510,19 @@ class MultiSelectComboBox extends ResizeMixin(InputControlMixin(ThemableMixin(El
       _lastFilter: {
         type: String,
       },
+
+      /** @private */
+      _topGroup: {
+        type: Array,
+      },
     };
   }
 
   static get observers() {
-    return ['_selectedItemsChanged(selectedItems, selectedItems.*)'];
+    return [
+      '_selectedItemsChanged(selectedItems, selectedItems.*)',
+      '__updateTopGroup(selectedItemsOnTop, selectedItems, opened)',
+    ];
   }
 
   /** @protected */
@@ -631,6 +684,20 @@ class MultiSelectComboBox extends ResizeMixin(InputControlMixin(ThemableMixin(El
     super._delegateAttribute(name, value);
   }
 
+  /** @private */
+  _autoExpandHorizontallyChanged(autoExpand, oldAutoExpand) {
+    if (autoExpand || oldAutoExpand) {
+      this.__updateChips();
+    }
+  }
+
+  /** @private */
+  _autoExpandVerticallyChanged(autoExpand, oldAutoExpand) {
+    if (autoExpand || oldAutoExpand) {
+      this.__updateChips();
+    }
+  }
+
   /**
    * Setting clear button visible reduces total space available
    * for rendering chips, and making it hidden increases it.
@@ -709,6 +776,10 @@ class MultiSelectComboBox extends ResizeMixin(InputControlMixin(ThemableMixin(El
 
     // Update selected for dropdown items
     this.requestContentUpdate();
+
+    if (this.opened) {
+      this.$.comboBox.$.overlay._updateOverlayWidth();
+    }
   }
 
   /** @private */
@@ -825,6 +896,15 @@ class MultiSelectComboBox extends ResizeMixin(InputControlMixin(ThemableMixin(El
     this.dispatchEvent(new CustomEvent('change', { bubbles: true }));
   }
 
+  /** @private */
+  __updateTopGroup(selectedItemsOnTop, selectedItems, opened) {
+    if (!selectedItemsOnTop) {
+      this._topGroup = [];
+    } else if (!opened) {
+      this._topGroup = [...selectedItems];
+    }
+  }
+
   /** @private */
   __createChip(item) {
     const chip = document.createElement('vaadin-multi-select-combo-box-chip');
@@ -888,14 +968,60 @@ class MultiSelectComboBox extends ResizeMixin(InputControlMixin(ThemableMixin(El
       remainingWidth -= this.__getOverflowWidth();
     }
 
+    const chipMinWidth = parseInt(getComputedStyle(this).getPropertyValue('--_chip-min-width'));
+
+    if (this.autoExpandHorizontally) {
+      const chips = [];
+
+      // First, add all chips to make the field fully expand
+      for (let i = items.length - 1, refNode = null; i >= 0; i--) {
+        const chip = this.__createChip(items[i]);
+        this.$.chips.insertBefore(chip, refNode);
+        refNode = chip;
+        chips.unshift(chip);
+      }
+
+      const overflowItems = [];
+      const availableWidth = this._inputField.$.wrapper.clientWidth - this.$.chips.clientWidth;
+
+      // When auto expanding vertically, no need to measure width
+      if (!this.autoExpandVertically && availableWidth < inputWidth) {
+        // Always show at least last item as a chip
+        while (chips.length > 1) {
+          const lastChip = chips.pop();
+          lastChip.remove();
+          overflowItems.unshift(items.pop());
+
+          // Remove chips until there is enough width for the input element to fit
+          const neededWidth = overflowItems.length > 0 ? inputWidth + this.__getOverflowWidth() : inputWidth;
+          if (this._inputField.$.wrapper.clientWidth - this.$.chips.clientWidth >= neededWidth) {
+            break;
+          }
+        }
+
+        if (chips.length === 1) {
+          chips[0].style.maxWidth = `${Math.max(chipMinWidth, remainingWidth)}px`;
+        }
+      }
+
+      this._overflowItems = overflowItems;
+      return;
+    }
+
     // Add chips until remaining width is exceeded
     for (let i = items.length - 1, refNode = null; i >= 0; i--) {
       const chip = this.__createChip(items[i]);
       this.$.chips.insertBefore(chip, refNode);
 
-      if (this.$.chips.clientWidth > remainingWidth) {
-        chip.remove();
-        break;
+      // When auto expanding vertically, no need to measure remaining width
+      if (!this.autoExpandVertically && this.$.chips.clientWidth > remainingWidth) {
+        // Always show at least last selected item as a chip
+        if (refNode === null) {
+          chip.style.maxWidth = `${Math.max(chipMinWidth, remainingWidth)}px`;
+        } else {
+          chip.remove();
+          break;
+        }
       }
 
       items.pop();

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

@@ -25,6 +25,16 @@ registerStyles(
   },
 );
 
+registerStyles(
+  'vaadin-multi-select-combo-box-container',
+  css`
+    :host([auto-expand-vertically]) {
+      padding-block: var(--lumo-space-xs);
+    }
+  `,
+  { moduleId: 'lumo-multi-select-combo-box-container' },
+);
+
 const multiSelectComboBox = css`
   :host([has-value]) {
     padding-inline-start: 0;
@@ -34,10 +44,22 @@ const multiSelectComboBox = css`
     caret-color: var(--lumo-body-text-color) !important;
   }
 
+  [part='label'] {
+    flex-shrink: 0;
+  }
+
   [part~='chip']:not(:last-of-type) {
     margin-inline-end: var(--lumo-space-xs);
   }
 
+  :host([auto-expand-vertically]) [part~='chip'] {
+    margin-block: calc(var(--lumo-space-xs) / 2);
+  }
+
+  :host([auto-expand-vertically]) ::slotted([slot='input']) {
+    min-height: calc(var(--lumo-text-field-size, var(--lumo-size-m)) - 2 * var(--lumo-space-xs));
+  }
+
   [part~='overflow']:not([hidden]) + :not(:empty) {
     margin-inline-start: var(--lumo-space-xs);
   }

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

@@ -34,6 +34,11 @@ const multiSelectComboBox = css`
     min-height: 32px;
   }
 
+  :host([auto-expand-vertically]) [part~='chip'] {
+    margin-top: 0.25rem;
+    align-self: flex-start;
+  }
+
   [part='input-field'] ::slotted(input) {
     padding: 6px 0;
   }

package/web-types.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://json.schemastore.org/web-types",
   "name": "@vaadin/multi-select-combo-box",
-  "version": "23.3.29",
+  "version": "23.4.0-alpha2",
   "description-markup": "markdown",
   "contributions": {
     "html": {
@@ -175,6 +175,28 @@
                 ]
               }
             },
+            {
+              "name": "auto-expand-horizontally",
+              "description": "Set to true to auto expand horizontally, causing input field to\ngrow until max width is reached.",
+              "value": {
+                "type": [
+                  "boolean",
+                  "null",
+                  "undefined"
+                ]
+              }
+            },
+            {
+              "name": "auto-expand-vertically",
+              "description": "Set to true to not collapse selected items chips into the overflow\nchip and instead always expand vertically, causing input field to\nwrap into multiple lines when width is limited.",
+              "value": {
+                "type": [
+                  "boolean",
+                  "null",
+                  "undefined"
+                ]
+              }
+            },
             {
               "name": "auto-open-disabled",
               "description": "Set true to prevent the overlay from opening automatically.",
@@ -285,6 +307,17 @@
                 ]
               }
             },
+            {
+              "name": "selected-items-on-top",
+              "description": "Set to true to group selected items at the top of the overlay.",
+              "value": {
+                "type": [
+                  "boolean",
+                  "null",
+                  "undefined"
+                ]
+              }
+            },
             {
               "name": "theme",
               "description": "The theme variants to apply to the component.",
@@ -453,6 +486,28 @@
                   ]
                 }
               },
+              {
+                "name": "autoExpandHorizontally",
+                "description": "Set to true to auto expand horizontally, causing input field to\ngrow until max width is reached.",
+                "value": {
+                  "type": [
+                    "boolean",
+                    "null",
+                    "undefined"
+                  ]
+                }
+              },
+              {
+                "name": "autoExpandVertically",
+                "description": "Set to true to not collapse selected items chips into the overflow\nchip and instead always expand vertically, causing input field to\nwrap into multiple lines when width is limited.",
+                "value": {
+                  "type": [
+                    "boolean",
+                    "null",
+                    "undefined"
+                  ]
+                }
+              },
               {
                 "name": "autoOpenDisabled",
                 "description": "Set true to prevent the overlay from opening automatically.",
@@ -626,6 +681,17 @@
                     "undefined"
                   ]
                 }
+              },
+              {
+                "name": "selectedItemsOnTop",
+                "description": "Set to true to group selected items at the top of the overlay.",
+                "value": {
+                  "type": [
+                    "boolean",
+                    "null",
+                    "undefined"
+                  ]
+                }
               }
             ],
             "events": [

package/web-types.lit.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://json.schemastore.org/web-types",
   "name": "@vaadin/multi-select-combo-box",
-  "version": "23.3.29",
+  "version": "23.4.0-alpha2",
   "description-markup": "markdown",
   "framework": "lit",
   "framework-config": {
@@ -68,6 +68,20 @@
                 "kind": "expression"
               }
             },
+            {
+              "name": "?autoExpandHorizontally",
+              "description": "Set to true to auto expand horizontally, causing input field to\ngrow until max width is reached.",
+              "value": {
+                "kind": "expression"
+              }
+            },
+            {
+              "name": "?autoExpandVertically",
+              "description": "Set to true to not collapse selected items chips into the overflow\nchip and instead always expand vertically, causing input field to\nwrap into multiple lines when width is limited.",
+              "value": {
+                "kind": "expression"
+              }
+            },
             {
               "name": "?autoOpenDisabled",
               "description": "Set true to prevent the overlay from opening automatically.",
@@ -96,6 +110,13 @@
                 "kind": "expression"
               }
             },
+            {
+              "name": "?selectedItemsOnTop",
+              "description": "Set to true to group selected items at the top of the overlay.",
+              "value": {
+                "kind": "expression"
+              }
+            },
             {
               "name": ".label",
               "description": "The label text for the input node.\nWhen no light dom defined via [slot=label], this value will be used.",