@vaadin/field-base 22.0.0-alpha5 → 22.0.0-alpha9

package/src/clear-button-mixin.js

@@ -1,82 +0,0 @@
-/**
- * @license
- * Copyright (c) 2021 Vaadin Ltd.
- * This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
- */
-import { dedupingMixin } from '@polymer/polymer/lib/utils/mixin.js';
-import { InputMixin } from './input-mixin.js';
-import { KeyboardMixin } from './keyboard-mixin.js';
-
-const ClearButtonMixinImplementation = (superclass) =>
-  class ClearButtonMixinClass extends InputMixin(KeyboardMixin(superclass)) {
-    static get properties() {
-      return {
-        /**
-         * Set to true to display the clear icon which clears the input.
-         * @attr {boolean} clear-button-visible
-         */
-        clearButtonVisible: {
-          type: Boolean,
-          reflectToAttribute: true,
-          value: false
-        }
-      };
-    }
-
-    /**
-     * Any element extending this mixin is required to implement this getter.
-     * It returns the reference to the clear button element.
-     * @protected
-     * @return {Element | null | undefined}
-     */
-    get clearElement() {
-      console.warn(`Please implement the 'clearElement' property in <${this.localName}>`);
-      return null;
-    }
-
-    /** @protected */
-    get _clearOnEsc() {
-      return true;
-    }
-
-    /** @protected */
-    ready() {
-      super.ready();
-
-      if (this.clearElement) {
-        this.clearElement.addEventListener('click', (e) => this._onClearButtonClick(e));
-      }
-    }
-
-    /**
-     * @param {Event} event
-     * @protected
-     */
-    _onClearButtonClick(event) {
-      event.preventDefault();
-      this.inputElement.focus();
-      this.clear();
-      this.inputElement.dispatchEvent(new Event('input', { bubbles: true, composed: true }));
-      this.inputElement.dispatchEvent(new Event('change', { bubbles: true }));
-    }
-
-    /**
-     * @param {KeyboardEvent} event
-     * @protected
-     * @override
-     */
-    _onKeyDown(event) {
-      super._onKeyDown(event);
-
-      if (event.key === 'Escape' && this.clearButtonVisible && this._clearOnEsc) {
-        const dispatchChange = !!this.value;
-        this.clear();
-        dispatchChange && this.inputElement.dispatchEvent(new Event('change', { bubbles: true }));
-      }
-    }
-  };
-
-/**
- * A mixin to add clear button support to field components.
- */
-export const ClearButtonMixin = dedupingMixin(ClearButtonMixinImplementation);

package/src/delegate-input-state-mixin.d.ts

@@ -1,43 +0,0 @@
-/**
- * @license
- * Copyright (c) 2021 Vaadin Ltd.
- * This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
- */
-import { DelegateStateMixin } from './delegate-state-mixin.js';
-import { InputMixin } from './input-mixin.js';
-import { ValidateMixin } from './validate-mixin.js';
-
-/**
- * A mixin to forward properties to the input element.
- */
-declare function DelegateInputStateMixin<T extends new (...args: any[]) => {}>(
-  base: T
-): T & DelegateInputStateMixinConstructor;
-
-interface DelegateInputStateMixinConstructor {
-  new (...args: any[]): DelegateInputStateMixin;
-}
-
-interface DelegateInputStateMixin extends DelegateStateMixin, ValidateMixin, InputMixin {
-  /**
-   * The name of this field.
-   */
-  name: string;
-
-  /**
-   * A hint to the user of what can be entered in the field.
-   */
-  placeholder: string;
-
-  /**
-   * When present, it specifies that the field is read-only.
-   */
-  readonly: boolean;
-
-  /**
-   * The text usually displayed in a tooltip popup when the mouse is over the field.
-   */
-  title: string;
-}
-
-export { DelegateInputStateMixinConstructor, DelegateInputStateMixin };

package/src/delegate-input-state-mixin.js

@@ -1,63 +0,0 @@
-/**
- * @license
- * Copyright (c) 2021 Vaadin Ltd.
- * This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
- */
-import { dedupingMixin } from '@polymer/polymer/lib/utils/mixin.js';
-import { DelegateStateMixin } from './delegate-state-mixin.js';
-import { InputMixin } from './input-mixin.js';
-import { ValidateMixin } from './validate-mixin.js';
-
-const DelegateInputStateMixinImplementation = (superclass) =>
-  class DelegateInputStateMixinClass extends DelegateStateMixin(ValidateMixin(InputMixin(superclass))) {
-    static get properties() {
-      return {
-        /**
-         * The name of this field.
-         */
-        name: {
-          type: String,
-          reflectToAttribute: true
-        },
-
-        /**
-         * A hint to the user of what can be entered in the field.
-         */
-        placeholder: {
-          type: String,
-          reflectToAttribute: true
-        },
-
-        /**
-         * When present, it specifies that the field is read-only.
-         */
-        readonly: {
-          type: Boolean,
-          value: false,
-          reflectToAttribute: true
-        },
-
-        /**
-         * The text usually displayed in a tooltip popup when the mouse is over the field.
-         */
-        title: {
-          type: String,
-          reflectToAttribute: true
-        }
-      };
-    }
-
-    static get delegateAttrs() {
-      return ['name', 'type', 'placeholder', 'required', 'readonly', 'invalid', 'title'];
-    }
-
-    /** @protected */
-    get _delegateStateTarget() {
-      return this.inputElement;
-    }
-  };
-
-/**
- * A mixin to delegate attributes to the input element.
- */
-export const DelegateInputStateMixin = dedupingMixin(DelegateInputStateMixinImplementation);

package/src/disabled-mixin.d.ts

@@ -1,23 +0,0 @@
-/**
- * @license
- * Copyright (c) 2021 Vaadin Ltd.
- * This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
- */
-
-/**
- * A mixin to provide disabled property for field components.
- */
-declare function DisabledMixin<T extends new (...args: any[]) => {}>(base: T): T & DisabledMixinConstructor;
-
-interface DisabledMixinConstructor {
-  new (...args: any[]): DisabledMixin;
-}
-
-interface DisabledMixin {
-  /**
-   * If true, the user cannot interact with this element.
-   */
-  disabled: boolean;
-}
-
-export { DisabledMixinConstructor, DisabledMixin };

package/src/disabled-mixin.js

@@ -1,60 +0,0 @@
-/**
- * @license
- * Copyright (c) 2021 Vaadin Ltd.
- * This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
- */
-import { dedupingMixin } from '@polymer/polymer/lib/utils/mixin.js';
-
-const DisabledMixinImplementation = (superclass) =>
-  class DisabledMixinClass extends superclass {
-    static get properties() {
-      return {
-        /**
-         * If true, the user cannot interact with this element.
-         */
-        disabled: {
-          type: Boolean,
-          value: false,
-          observer: '_disabledChanged',
-          reflectToAttribute: true
-        }
-      };
-    }
-
-    /**
-     * @param {boolean} disabled
-     * @protected
-     */
-    _disabledChanged(disabled) {
-      this._setAriaDisabled(disabled);
-    }
-
-    /**
-     * @param {boolean} disabled
-     * @protected
-     */
-    _setAriaDisabled(disabled) {
-      if (disabled) {
-        this.setAttribute('aria-disabled', 'true');
-      } else {
-        this.removeAttribute('aria-disabled');
-      }
-    }
-
-    /**
-     * Overrides the default element `click` method in order to prevent
-     * firing the `click` event when the element is disabled.
-     *
-     * @override
-     */
-    click() {
-      if (!this.disabled) {
-        super.click();
-      }
-    }
-  };
-
-/**
- * A mixin to provide disabled property for field components.
- */
-export const DisabledMixin = dedupingMixin(DisabledMixinImplementation);

package/src/field-aria-mixin.d.ts

@@ -1,24 +0,0 @@
-/**
- * @license
- * Copyright (c) 2021 Vaadin Ltd.
- * This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
- */
-import { HelperTextMixin } from './helper-text-mixin.js';
-import { ValidateMixin } from './validate-mixin.js';
-
-/**
- * A mixin to handle field ARIA attributes based on the label, error message and helper text.
- */
-declare function FieldAriaMixin<T extends new (...args: any[]) => {}>(base: T): T & FieldAriaMixinConstructor;
-
-interface FieldAriaMixinConstructor {
-  new (...args: any[]): FieldAriaMixin;
-}
-
-interface FieldAriaMixin extends HelperTextMixin, ValidateMixin {
-  readonly _ariaTarget: HTMLElement;
-
-  readonly _ariaAttr: string;
-}
-
-export { FieldAriaMixin, FieldAriaMixinConstructor };

package/src/field-aria-mixin.js

@@ -1,61 +0,0 @@
-/**
- * @license
- * Copyright (c) 2021 Vaadin Ltd.
- * This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
- */
-import { dedupingMixin } from '@polymer/polymer/lib/utils/mixin.js';
-import { HelperTextMixin } from './helper-text-mixin.js';
-import { ValidateMixin } from './validate-mixin.js';
-
-const FieldAriaMixinImplementation = (superclass) =>
-  class FieldAriaMixinClass extends HelperTextMixin(ValidateMixin(superclass)) {
-    /** @protected */
-    get _ariaTarget() {
-      return this;
-    }
-
-    /** @protected */
-    get _ariaAttr() {
-      return 'aria-describedby';
-    }
-
-    static get observers() {
-      return ['__ariaChanged(invalid, _helperId)'];
-    }
-
-    /** @protected */
-    ready() {
-      super.ready();
-
-      this._updateAriaAttribute(this.invalid, this._helperId);
-    }
-
-    /** @protected */
-    _updateAriaAttribute(invalid, helperId) {
-      const attr = this._ariaAttr;
-
-      if (this._ariaTarget && attr) {
-        // For groups, add all IDs to aria-labelledby rather than aria-describedby -
-        // that should guarantee that it's announced when the group is entered.
-        const ariaIds = attr === 'aria-describedby' ? [helperId] : [this._labelId, helperId];
-
-        // Error message ID needs to be dynamically added / removed based on the validity
-        // Otherwise assistive technologies would announce the error, even if we hide it.
-        if (invalid) {
-          ariaIds.push(this._errorId);
-        }
-
-        this._ariaTarget.setAttribute(attr, ariaIds.join(' '));
-      }
-    }
-
-    /** @private */
-    __ariaChanged(invalid, helperId) {
-      this._updateAriaAttribute(invalid, helperId);
-    }
-  };
-
-/**
- * A mixin to handle field ARIA attributes based on the label, error message and helper text.
- */
-export const FieldAriaMixin = dedupingMixin(FieldAriaMixinImplementation);

package/src/focus-mixin.d.ts

@@ -1,33 +0,0 @@
-/**
- * @license
- * Copyright (c) 2021 Vaadin Ltd.
- * This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
- */
-
-/**
- * A mixin to handle `focused` and `focus-ring` attributes based on focus.
- */
-declare function FocusMixin<T extends new (...args: any[]) => {}>(base: T): T & FocusMixinConstructor;
-
-interface FocusMixinConstructor {
-  new (...args: any[]): FocusMixin;
-}
-
-interface FocusMixin {
-  /**
-   * Override to change how focused and focus-ring attributes are set.
-   */
-  _setFocused(focused: boolean): void;
-
-  /**
-   * Override to define if the field receives focus based on the event.
-   */
-  _shouldSetFocus(event: FocusEvent): boolean;
-
-  /**
-   * Override to define if the field loses focus based on the event.
-   */
-  _shouldRemoveFocus(event: FocusEvent): boolean;
-}
-
-export { FocusMixinConstructor, FocusMixin };

package/src/focus-mixin.js

@@ -1,104 +0,0 @@
-/**
- * @license
- * Copyright (c) 2021 Vaadin Ltd.
- * This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
- */
-import { dedupingMixin } from '@polymer/polymer/lib/utils/mixin.js';
-
-// We consider the keyboard to be active if the window has received a keydown
-// event since the last mousedown event.
-let keyboardActive = false;
-
-// Listen for top-level keydown and mousedown events.
-// Use capture phase so we detect events even if they're handled.
-window.addEventListener(
-  'keydown',
-  () => {
-    keyboardActive = true;
-  },
-  { capture: true }
-);
-
-window.addEventListener(
-  'mousedown',
-  () => {
-    keyboardActive = false;
-  },
-  { capture: true }
-);
-
-const FocusMixinImplementation = (superclass) =>
-  class FocusMixinClass extends superclass {
-    /** @protected */
-    ready() {
-      this.addEventListener('focusin', (e) => {
-        if (this._shouldSetFocus(e)) {
-          this._setFocused(true);
-        }
-      });
-
-      this.addEventListener('focusout', (e) => {
-        if (this._shouldRemoveFocus(e)) {
-          this._setFocused(false);
-        }
-      });
-
-      // In super.ready() other 'focusin' and 'focusout' listeners might be
-      // added, so we call it after our own ones to ensure they execute first.
-      // Issue to watch out: when incorrect, <vaadin-combo-box> refocuses the
-      // input field on iOS after “Done” is pressed.
-      super.ready();
-    }
-
-    /** @protected */
-    disconnectedCallback() {
-      super.disconnectedCallback();
-
-      // in non-Chrome browsers, blur does not fire on the element when it is disconnected.
-      // reproducible in `<vaadin-date-picker>` when closing on `Cancel` or `Today` click.
-      if (this.hasAttribute('focused')) {
-        this._setFocused(false);
-      }
-    }
-
-    /**
-     * Override to change how focused and focus-ring attributes are set.
-     *
-     * @param {boolean} focused
-     * @protected
-     */
-    _setFocused(focused) {
-      this.toggleAttribute('focused', focused);
-
-      // focus-ring is true when the element was focused from the keyboard.
-      // Focus Ring [A11ycasts]: https://youtu.be/ilj2P5-5CjI
-      this.toggleAttribute('focus-ring', focused && keyboardActive);
-    }
-
-    /**
-     * Override to define if the field receives focus based on the event.
-     *
-     * @param {FocusEvent} event
-     * @return {boolean}
-     * @protected
-     */
-    _shouldSetFocus(_event) {
-      return true;
-    }
-
-    /**
-     * Override to define if the field loses focus based on the event.
-     *
-     * @param {FocusEvent} event
-     * @return {boolean}
-     * @protected
-     */
-    _shouldRemoveFocus(_event) {
-      return true;
-    }
-  };
-
-/**
- * A mixin to handle `focused` and `focus-ring` attributes based on focus.
- */
-export const FocusMixin = dedupingMixin(FocusMixinImplementation);

package/src/helper-text-mixin.d.ts

@@ -1,24 +0,0 @@
-/**
- * @license
- * Copyright (c) 2021 Vaadin Ltd.
- * This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
- */
-import { SlotMixin } from './slot-mixin.js';
-
-/**
- * A mixin to provide helper text via corresponding property or named slot.
- */
-declare function HelperTextMixin<T extends new (...args: any[]) => {}>(base: T): T & HelperTextMixinConstructor;
-
-interface HelperTextMixinConstructor {
-  new (...args: any[]): HelperTextMixin;
-}
-
-interface HelperTextMixin extends SlotMixin {
-  /**
-   * String used for the helper text.
-   */
-  helperText: string;
-}
-
-export { HelperTextMixinConstructor, HelperTextMixin };

package/src/helper-text-mixin.js

@@ -1,144 +0,0 @@
-/**
- * @license
- * Copyright (c) 2021 Vaadin Ltd.
- * This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
- */
-import { dedupingMixin } from '@polymer/polymer/lib/utils/mixin.js';
-import { SlotMixin } from './slot-mixin.js';
-
-const HelperTextMixinImplementation = (superclass) =>
-  class HelperTextMixinClass extends SlotMixin(superclass) {
-    static get properties() {
-      return {
-        /**
-         * String used for the helper text.
-         * @attr {string} helper-text
-         */
-        helperText: {
-          type: String,
-          observer: '_helperTextChanged'
-        },
-
-        /** @protected */
-        _helperId: String
-      };
-    }
-
-    get slots() {
-      return {
-        ...super.slots,
-        helper: () => {
-          const helper = document.createElement('div');
-          helper.textContent = this.helperText;
-          return helper;
-        }
-      };
-    }
-
-    /** @protected */
-    get _helperNode() {
-      return this._getDirectSlotChild('helper');
-    }
-
-    constructor() {
-      super();
-
-      // Ensure every instance has unique ID
-      const uniqueId = (HelperTextMixinClass._uniqueId = 1 + HelperTextMixinClass._uniqueId || 0);
-      this._helperId = `helper-${this.localName}-${uniqueId}`;
-
-      // Save generated ID to restore later
-      this.__savedHelperId = this._helperId;
-    }
-
-    /** @protected */
-    connectedCallback() {
-      super.connectedCallback();
-
-      if (this._helperNode) {
-        this._currentHelper = this._helperNode;
-        this._helperNode.id = this._helperId;
-
-        this._applyCustomHelper();
-      }
-    }
-
-    /** @protected */
-    ready() {
-      super.ready();
-
-      this.__helperSlot = this.shadowRoot.querySelector('[name="helper"]');
-      this.__helperSlot.addEventListener('slotchange', this.__onHelperSlotChange.bind(this));
-      this.__helperIdObserver = new MutationObserver((mutationRecord) => {
-        mutationRecord.forEach((mutation) => {
-          // only handle helper nodes
-          if (
-            mutation.type === 'attributes' &&
-            mutation.attributeName === 'id' &&
-            mutation.target === this._currentHelper &&
-            mutation.target.id !== this.__savedHelperId
-          ) {
-            this.__updateHelperId(mutation.target);
-          }
-        });
-      });
-
-      this.__helperIdObserver.observe(this, { attributes: true, subtree: true });
-    }
-
-    /** @private */
-    __updateHelperId(customHelper) {
-      let newId;
-
-      if (customHelper.id) {
-        newId = customHelper.id;
-      } else {
-        newId = this.__savedHelperId;
-        customHelper.id = newId;
-      }
-
-      this._helperId = newId;
-    }
-
-    /** @private */
-    __onHelperSlotChange() {
-      // Check fot slotted element node that is not the one created by this mixin.
-      const customHelper = this.__helperSlot
-        .assignedElements({ flatten: true })
-        .find((node) => node !== this._currentHelper);
-
-      if (customHelper) {
-        this.__updateHelperId(customHelper);
-
-        if (this._currentHelper.isConnected) {
-          this._currentHelper.remove();
-        }
-
-        this._applyCustomHelper();
-
-        this._currentHelper = customHelper;
-      }
-    }
-
-    /** @protected */
-    _applyCustomHelper() {
-      const helper = this._helperNode.textContent;
-      if (helper !== this.helperText) {
-        this.helperText = helper;
-      }
-    }
-
-    /** @protected */
-    _helperTextChanged(helper) {
-      if (this._helperNode) {
-        this._helperNode.textContent = helper;
-      }
-
-      this.toggleAttribute('has-helper', Boolean(helper));
-    }
-  };
-
-/**
- * A mixin to provide helper text via corresponding property or named slot.
- */
-export const HelperTextMixin = dedupingMixin(HelperTextMixinImplementation);

package/src/input-slot-mixin.d.ts

@@ -1,26 +0,0 @@
-/**
- * @license
- * Copyright (c) 2021 Vaadin Ltd.
- * This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
- */
-import { DelegatesFocusMixin } from './delegate-focus-mixin.js';
-import { SlotMixin } from './slot-mixin.js';
-import { InputMixin } from './input-mixin.js';
-
-/**
- * A mixin to add `<input>` element to the corresponding named slot.
- */
-declare function InputSlotMixin<T extends new (...args: any[]) => {}>(base: T): T & InputSlotMixinConstructor;
-
-interface InputSlotMixinConstructor {
-  new (...args: any[]): InputSlotMixin;
-}
-
-interface InputSlotMixin extends DelegatesFocusMixin, InputMixin, SlotMixin {
-  /**
-   * String used to define input type.
-   */
-  readonly type: string;
-}
-
-export { InputSlotMixinConstructor, InputSlotMixin };