@vaadin/select 24.2.0-alpha3 → 24.2.0-alpha5

package/src/vaadin-select.js

@@ -9,23 +9,13 @@ import './vaadin-select-list-box.js';
 import './vaadin-select-overlay.js';
 import './vaadin-select-value-button.js';
 import { html, PolymerElement } from '@polymer/polymer/polymer-element.js';
-import { setAriaIDReference } from '@vaadin/a11y-base/src/aria-id-reference.js';
-import { DelegateFocusMixin } from '@vaadin/a11y-base/src/delegate-focus-mixin.js';
-import { KeyboardMixin } from '@vaadin/a11y-base/src/keyboard-mixin.js';
 import { screenReaderOnly } from '@vaadin/a11y-base/src/styles/sr-only-styles.js';
-import { DelegateStateMixin } from '@vaadin/component-base/src/delegate-state-mixin.js';
 import { ElementMixin } from '@vaadin/component-base/src/element-mixin.js';
-import { MediaQueryController } from '@vaadin/component-base/src/media-query-controller.js';
-import { OverlayClassMixin } from '@vaadin/component-base/src/overlay-class-mixin.js';
 import { processTemplates } from '@vaadin/component-base/src/templates.js';
-import { TooltipController } from '@vaadin/component-base/src/tooltip-controller.js';
-import { generateUniqueId } from '@vaadin/component-base/src/unique-id-utils.js';
-import { FieldMixin } from '@vaadin/field-base/src/field-mixin.js';
-import { LabelController } from '@vaadin/field-base/src/label-controller.js';
 import { fieldShared } from '@vaadin/field-base/src/styles/field-shared-styles.js';
 import { inputFieldContainer } from '@vaadin/field-base/src/styles/input-field-container-styles.js';
 import { registerStyles, ThemableMixin } from '@vaadin/vaadin-themable-mixin/vaadin-themable-mixin.js';
-import { ButtonController } from './button-controller.js';
+import { SelectBaseMixin } from './vaadin-select-base-mixin.js';
 
 registerStyles('vaadin-select', [fieldShared, inputFieldContainer, screenReaderOnly], {
   moduleId: 'vaadin-select-styles',
@@ -138,16 +128,10 @@ registerStyles('vaadin-select', [fieldShared, inputFieldContainer, screenReaderO
  *
  * @extends HTMLElement
  * @mixes ElementMixin
+ * @mixes SelectBaseMixin
  * @mixes ThemableMixin
- * @mixes FieldMixin
- * @mixes DelegateFocusMixin
- * @mixes DelegateStateMixin
- * @mixes KeyboardMixin
- * @mixes OverlayClassMixin
  */
-class Select extends OverlayClassMixin(
-  DelegateFocusMixin(DelegateStateMixin(KeyboardMixin(FieldMixin(ElementMixin(ThemableMixin(PolymerElement)))))),
-) {
+class Select extends SelectBaseMixin(ElementMixin(ThemableMixin(PolymerElement))) {
   static get is() {
     return 'vaadin-select';
   }
@@ -194,6 +178,7 @@ class Select extends OverlayClassMixin(
         with-backdrop="[[_phone]]"
         phone$="[[_phone]]"
         theme$="[[_theme]]"
+        on-vaadin-overlay-open="_onOverlayOpen"
       ></vaadin-select-overlay>
 
       <slot name="tooltip"></slot>
@@ -203,202 +188,15 @@ class Select extends OverlayClassMixin(
     `;
   }
 
-  static get properties() {
-    return {
-      /**
-       * An array containing items that will be rendered as the options of the select.
-       *
-       * #### Example
-       * ```js
-       * select.items = [
-       *   { label: 'Most recent first', value: 'recent' },
-       *   { component: 'hr' },
-       *   { label: 'Rating: low to high', value: 'rating-asc' },
-       *   { label: 'Rating: high to low', value: 'rating-desc' },
-       *   { component: 'hr' },
-       *   { label: 'Price: low to high', value: 'price-asc', disabled: true },
-       *   { label: 'Price: high to low', value: 'price-desc', disabled: true }
-       * ];
-       * ```
-       *
-       * Note: each item is rendered by default as the internal `<vaadin-select-item>` that is an extension of `<vaadin-item>`.
-       * To render the item with a custom component, provide a tag name by the `component` property.
-       *
-       * @type {!Array<!SelectItem>}
-       */
-      items: {
-        type: Array,
-        observer: '__itemsChanged',
-      },
-
-      /**
-       * Set when the select is open
-       * @type {boolean}
-       */
-      opened: {
-        type: Boolean,
-        value: false,
-        notify: true,
-        reflectToAttribute: true,
-        observer: '_openedChanged',
-      },
-
-      /**
-       * Custom function for rendering the content of the `<vaadin-select>`.
-       * Receives two arguments:
-       *
-       * - `root` The `<vaadin-select-overlay>` internal container
-       *   DOM element. Append your content to it.
-       * - `select` The reference to the `<vaadin-select>` element.
-       * @type {!SelectRenderer | undefined}
-       */
-      renderer: Function,
-
-      /**
-       * The `value` property of the selected item, or an empty string
-       * if no item is selected.
-       * On change or initialization, the component finds the item which matches the
-       * value and displays it.
-       * If no value is provided to the component, it selects the first item without
-       * value or empty value.
-       * Hint: If you do not want to select any item by default, you can either set all
-       * the values of inner vaadin-items, or set the vaadin-select value to
-       * an inexistent value in the items list.
-       * @type {string}
-       */
-      value: {
-        type: String,
-        value: '',
-        notify: true,
-        observer: '_valueChanged',
-      },
-
-      /**
-       * The name of this element.
-       */
-      name: {
-        type: String,
-      },
-
-      /**
-       * A hint to the user of what can be entered in the control.
-       * The placeholder will be displayed in the case that there
-       * is no item selected, or the selected item has an empty
-       * string label, or the selected item has no label and it's
-       * DOM content is empty.
-       */
-      placeholder: {
-        type: String,
-      },
-
-      /**
-       * When present, it specifies that the element is read-only.
-       * @type {boolean}
-       */
-      readonly: {
-        type: Boolean,
-        value: false,
-        reflectToAttribute: true,
-      },
-
-      /** @private */
-      _phone: Boolean,
-
-      /** @private */
-      _phoneMediaQuery: {
-        value: '(max-width: 420px), (max-height: 420px)',
-      },
-
-      /** @private */
-      _inputContainer: Object,
-
-      /** @private */
-      _items: Object,
-    };
-  }
-
-  static get delegateAttrs() {
-    return [...super.delegateAttrs, 'invalid'];
-  }
-
   static get observers() {
-    return [
-      '_updateAriaExpanded(opened, focusElement)',
-      '_updateSelectedItem(value, _items, placeholder)',
-      '_rendererChanged(renderer, _overlayElement)',
-    ];
-  }
-
-  constructor() {
-    super();
-
-    this._itemId = `value-${this.localName}-${generateUniqueId()}`;
-    this._srLabelController = new LabelController(this);
-    this._srLabelController.slotName = 'sr-label';
-  }
-
-  /** @protected */
-  disconnectedCallback() {
-    super.disconnectedCallback();
-
-    // Making sure the select is closed and removed from DOM after detaching the select.
-    this.opened = false;
+    return ['_rendererChanged(renderer, _overlayElement)'];
   }
 
   /** @protected */
   ready() {
     super.ready();
 
-    this._overlayElement = this.shadowRoot.querySelector('vaadin-select-overlay');
-    this._inputContainer = this.shadowRoot.querySelector('[part~="input-field"]');
-
-    this._valueButtonController = new ButtonController(this);
-    this.addController(this._valueButtonController);
-    this.addController(this._srLabelController);
-    this.addController(
-      new MediaQueryController(this._phoneMediaQuery, (matches) => {
-        this._phone = matches;
-      }),
-    );
-
     processTemplates(this);
-
-    this._tooltipController = new TooltipController(this);
-    this._tooltipController.setPosition('top');
-    this.addController(this._tooltipController);
-  }
-
-  /**
-   * Requests an update for the content of the select.
-   * While performing the update, it invokes the renderer passed in the `renderer` property.
-   *
-   * It is not guaranteed that the update happens immediately (synchronously) after it is requested.
-   */
-  requestContentUpdate() {
-    if (!this._overlayElement) {
-      return;
-    }
-
-    this._overlayElement.requestContentUpdate();
-
-    if (this._menuElement && this._menuElement.items) {
-      this._updateSelectedItem(this.value, this._menuElement.items);
-    }
-  }
-
-  /**
-   * Override an observer from `FieldMixin`
-   * to validate when required is removed.
-   *
-   * @protected
-   * @override
-   */
-  _requiredChanged(required) {
-    super._requiredChanged(required);
-
-    if (required === false) {
-      this.validate();
-    }
   }
 
   /**
@@ -411,387 +209,18 @@ class Select extends OverlayClassMixin(
       return;
     }
 
-    overlay.setProperties({ owner: this, renderer: renderer || this.__defaultRenderer });
+    overlay.renderer = renderer || this.__defaultRenderer;
 
     this.requestContentUpdate();
   }
 
-  /**
-   * @param {SelectItem[] | undefined | null} newItems
-   * @param {SelectItem[] | undefined | null} oldItems
-   * @private
-   */
-  __itemsChanged(newItems, oldItems) {
-    if (newItems || oldItems) {
-      this.requestContentUpdate();
-    }
-  }
-
-  /**
-   * @param {HTMLElement} menuElement
-   * @protected
-   */
-  _assignMenuElement(menuElement) {
-    if (menuElement && menuElement !== this.__lastMenuElement) {
-      this._menuElement = menuElement;
-
-      // Ensure items are initialized
-      this.__initMenuItems(menuElement);
-
-      menuElement.addEventListener('items-changed', () => {
-        this.__initMenuItems(menuElement);
-      });
-
-      menuElement.addEventListener('selected-changed', () => this.__updateValueButton());
-      // Use capture phase to make it possible for `<vaadin-grid-pro-edit-select>`
-      // to override and handle the keydown event before the value change happens.
-      menuElement.addEventListener('keydown', (e) => this._onKeyDownInside(e), true);
-      menuElement.addEventListener(
-        'click',
-        () => {
-          this.__userInteraction = true;
-          this.opened = false;
-        },
-        true,
-      );
-
-      // Store the menu element reference
-      this.__lastMenuElement = menuElement;
-    }
-  }
-
-  /** @private */
-  __initMenuItems(menuElement) {
-    if (menuElement.items) {
-      this._items = menuElement.items;
-    }
-  }
-
-  /** @private */
-  _valueChanged(value, oldValue) {
-    this.toggleAttribute('has-value', Boolean(value));
-
-    // Validate only if `value` changes after initialization.
-    if (oldValue !== undefined) {
-      this.validate();
-    }
-  }
-
-  /**
-   * Opens the overlay if the field is not read-only.
-   *
-   * @private
-   */
-  _onClick(event) {
-    // Prevent parent components such as `vaadin-grid`
-    // from handling the click event after it bubbles.
-    event.preventDefault();
-
-    this.opened = !this.readonly;
-  }
-
   /** @private */
-  _onToggleMouseDown(event) {
-    // Prevent mousedown event to avoid blur and preserve focused state
-    // while opening, and to restore focus-ring attribute on closing.
-    event.preventDefault();
-  }
-
-  /**
-   * @param {!KeyboardEvent} e
-   * @protected
-   * @override
-   */
-  _onKeyDown(e) {
-    if (e.target === this.focusElement && !this.readonly && !this.opened) {
-      if (/^(Enter|SpaceBar|\s|ArrowDown|Down|ArrowUp|Up)$/u.test(e.key)) {
-        e.preventDefault();
-        this.opened = true;
-      } else if (/[\p{L}\p{Nd}]/u.test(e.key) && e.key.length === 1) {
-        const selected = this._menuElement.selected;
-        const currentIdx = selected !== undefined ? selected : -1;
-        const newIdx = this._menuElement._searchKey(currentIdx, e.key);
-        if (newIdx >= 0) {
-          this.__userInteraction = true;
-
-          // Announce the value selected with the first letter shortcut
-          this._updateAriaLive(true);
-          this._menuElement.selected = newIdx;
-        }
-      }
-    }
-  }
-
-  /**
-   * @param {!KeyboardEvent} e
-   * @protected
-   */
-  _onKeyDownInside(e) {
-    if (/^(Tab)$/u.test(e.key)) {
-      this.opened = false;
-    }
-  }
-
-  /** @private */
-  _openedChanged(opened, wasOpened) {
-    if (opened) {
-      // Avoid multiple announcements when a value gets selected from the dropdown
-      this._updateAriaLive(false);
-
-      if (!this._overlayElement || !this._menuElement || !this.focusElement || this.disabled || this.readonly) {
-        this.opened = false;
-        return;
-      }
-
-      this._overlayElement.style.setProperty(
-        '--vaadin-select-text-field-width',
-        `${this._inputContainer.offsetWidth}px`,
-      );
-
-      // Preserve focus-ring to restore it later
-      const hasFocusRing = this.hasAttribute('focus-ring');
-      this._openedWithFocusRing = hasFocusRing;
-
-      // Opened select should not keep focus-ring
-      if (hasFocusRing) {
-        this.removeAttribute('focus-ring');
-      }
-
+  _onOverlayOpen() {
+    if (this._menuElement) {
       this._menuElement.focus();
-    } else if (wasOpened) {
-      this.focus();
-      if (this._openedWithFocusRing) {
-        this.setAttribute('focus-ring', '');
-      }
-      this.validate();
     }
   }
 
-  /** @private */
-  _updateAriaExpanded(opened, focusElement) {
-    if (focusElement) {
-      focusElement.setAttribute('aria-expanded', opened ? 'true' : 'false');
-    }
-  }
-
-  /** @private */
-  _updateAriaLive(ariaLive) {
-    if (this.focusElement) {
-      if (ariaLive) {
-        this.focusElement.setAttribute('aria-live', 'polite');
-      } else {
-        this.focusElement.removeAttribute('aria-live');
-      }
-    }
-  }
-
-  /** @private */
-  __attachSelectedItem(selected) {
-    let labelItem;
-
-    const label = selected.getAttribute('label');
-    if (label) {
-      labelItem = this.__createItemElement({ label });
-    } else {
-      labelItem = selected.cloneNode(true);
-    }
-
-    // Store reference to the original item
-    labelItem._sourceItem = selected;
-
-    this.__appendValueItemElement(labelItem, this.focusElement);
-
-    // Ensure the item gets proper styles
-    labelItem.selected = true;
-  }
-
-  /**
-   * @param {!SelectItem} item
-   * @private
-   */
-  __createItemElement(item) {
-    const itemElement = document.createElement(item.component || 'vaadin-select-item');
-    if (item.label) {
-      itemElement.textContent = item.label;
-    }
-    if (item.value) {
-      itemElement.value = item.value;
-    }
-    if (item.disabled) {
-      itemElement.disabled = item.disabled;
-    }
-    return itemElement;
-  }
-
-  /**
-   * @param {!HTMLElement} itemElement
-   * @param {!HTMLElement} parent
-   * @private
-   */
-  __appendValueItemElement(itemElement, parent) {
-    parent.appendChild(itemElement);
-    itemElement.removeAttribute('tabindex');
-    itemElement.removeAttribute('aria-selected');
-    itemElement.removeAttribute('role');
-    itemElement.setAttribute('id', this._itemId);
-  }
-
-  /**
-   * @param {string} accessibleName
-   * @protected
-   */
-  _accessibleNameChanged(accessibleName) {
-    this._srLabelController.setLabel(accessibleName);
-    this._setCustomAriaLabelledBy(accessibleName ? this._srLabelController.defaultId : null);
-  }
-
-  /**
-   * @param {string} accessibleNameRef
-   * @protected
-   */
-  _accessibleNameRefChanged(accessibleNameRef) {
-    this._setCustomAriaLabelledBy(accessibleNameRef);
-  }
-
-  /**
-   * @param {string} ariaLabelledby
-   * @private
-   */
-  _setCustomAriaLabelledBy(ariaLabelledby) {
-    const labelId = this._getLabelIdWithItemId(ariaLabelledby);
-    this._fieldAriaController.setLabelId(labelId, true);
-  }
-
-  /**
-   * @param {string | null} labelId
-   * @returns string | null
-   * @private
-   */
-  _getLabelIdWithItemId(labelId) {
-    const selected = this._items ? this._items[this._menuElement.selected] : false;
-    const itemId = selected || this.placeholder ? this._itemId : '';
-
-    return labelId ? `${labelId} ${itemId}`.trim() : null;
-  }
-
-  /** @private */
-  __updateValueButton() {
-    const valueButton = this.focusElement;
-
-    if (!valueButton) {
-      return;
-    }
-
-    valueButton.innerHTML = '';
-
-    const selected = this._items[this._menuElement.selected];
-
-    valueButton.removeAttribute('placeholder');
-
-    if (!selected) {
-      if (this.placeholder) {
-        const item = this.__createItemElement({ label: this.placeholder });
-        this.__appendValueItemElement(item, valueButton);
-        valueButton.setAttribute('placeholder', '');
-      }
-    } else {
-      this.__attachSelectedItem(selected);
-
-      if (!this._valueChanging) {
-        this._selectedChanging = true;
-        this.value = selected.value || '';
-        if (this.__userInteraction) {
-          this.opened = false;
-          this.dispatchEvent(new CustomEvent('change', { bubbles: true }));
-          this.__userInteraction = false;
-        }
-        delete this._selectedChanging;
-      }
-    }
-
-    const labelledIdReferenceConfig = selected || this.placeholder ? { newId: this._itemId } : { oldId: this._itemId };
-
-    setAriaIDReference(valueButton, 'aria-labelledby', labelledIdReferenceConfig);
-    if (this.accessibleName || this.accessibleNameRef) {
-      this._setCustomAriaLabelledBy(this.accessibleNameRef || this._srLabelController.defaultId);
-    }
-  }
-
-  /** @private */
-  _updateSelectedItem(value, items) {
-    if (items) {
-      const valueAsString = value == null ? value : value.toString();
-      this._menuElement.selected = items.reduce((prev, item, idx) => {
-        return prev === undefined && item.value === valueAsString ? idx : prev;
-      }, undefined);
-      if (!this._selectedChanging) {
-        this._valueChanging = true;
-        this.__updateValueButton();
-        delete this._valueChanging;
-      }
-    }
-  }
-
-  /**
-   * Override method inherited from `FocusMixin` to not remove focused
-   * state when select is opened and focus moves to list-box.
-   * @return {boolean}
-   * @protected
-   * @override
-   */
-  _shouldRemoveFocus() {
-    return !this.opened;
-  }
-
-  /**
-   * Override method inherited from `FocusMixin` to validate on blur.
-   * @param {boolean} focused
-   * @protected
-   * @override
-   */
-  _setFocused(focused) {
-    super._setFocused(focused);
-
-    // Do not validate when focusout is caused by document
-    // losing focus, which happens on browser tab switch.
-    if (!focused && document.hasFocus()) {
-      this.validate();
-    }
-  }
-
-  /**
-   * Returns true if the current value satisfies all constraints (if any)
-   *
-   * @return {boolean}
-   */
-  checkValidity() {
-    return !this.required || this.readonly || !!this.value;
-  }
-
-  /**
-   * Renders items when they are provided by the `items` property and clears the content otherwise.
-   * @param {!HTMLElement} root
-   * @param {!Select} _select
-   * @private
-   */
-  __defaultRenderer(root, _select) {
-    if (!this.items || this.items.length === 0) {
-      root.textContent = '';
-      return;
-    }
-
-    let listBox = root.firstElementChild;
-    if (!listBox) {
-      listBox = document.createElement('vaadin-select-list-box');
-      root.appendChild(listBox);
-    }
-
-    listBox.textContent = '';
-    this.items.forEach((item) => {
-      listBox.appendChild(this.__createItemElement(item));
-    });
-  }
-
   /**
    * Fired when the user commits a value change.
    *

package/theme/lumo/vaadin-select.js

@@ -4,6 +4,5 @@
  * 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.js';
-import '@vaadin/overlay/theme/lumo/vaadin-overlay.js';
 import './vaadin-select-styles.js';
 import '../../src/vaadin-select.js';

package/theme/material/vaadin-select.js

@@ -4,6 +4,5 @@
  * 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.js';
-import '@vaadin/overlay/theme/material/vaadin-overlay.js';
 import './vaadin-select-styles.js';
 import '../../src/vaadin-select.js';