@vaadin/field-base 22.0.0-alpha3 → 22.0.0-alpha7

package/src/validate-mixin.js

@@ -4,128 +4,53 @@
  * 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 ValidateMixinImplementation = (superclass) =>
-  class ValidateMixinClass extends SlotMixin(superclass) {
-    static get properties() {
-      return {
-        /**
-         * Set to true when the field is invalid.
-         */
-        invalid: {
-          type: Boolean,
-          reflectToAttribute: true,
-          notify: true,
-          value: false
-        },
-
-        /**
-         * Specifies that the user must fill in a value.
-         */
-        required: {
-          type: Boolean,
-          reflectToAttribute: true
-        },
-
-        /**
-         * Error to show when the field is invalid.
-         *
-         * @attr {string} error-message
-         */
-        errorMessage: {
-          type: String
-        }
-      };
-    }
-
-    get slots() {
-      return {
-        ...super.slots,
-        'error-message': () => {
-          const error = document.createElement('div');
-          error.textContent = this.errorMessage;
-          error.setAttribute('aria-live', 'assertive');
-          return error;
-        }
-      };
-    }
-
-    static get observers() {
-      return ['_updateErrorMessage(invalid, errorMessage)'];
-    }
-
-    /** @protected */
-    get _errorNode() {
-      return this._getDirectSlotChild('error-message');
-    }
-
-    constructor() {
-      super();
-
-      // Ensure every instance has unique ID
-      const uniqueId = (ValidateMixinClass._uniqueId = 1 + ValidateMixinClass._uniqueId || 0);
-      this._errorId = `error-${this.localName}-${uniqueId}`;
-    }
-
-    /** @protected */
-    connectedCallback() {
-      super.connectedCallback();
-
-      if (this._errorNode) {
-        this._errorNode.id = this._errorId;
-
-        this._applyCustomError();
-      }
-    }
-
-    /**
-     * Returns true if field is valid, and sets `invalid` based on the field validity.
-     *
-     * @return {boolean} True if the value is valid.
-     */
-    validate() {
-      return !(this.invalid = !this.checkValidity());
-    }
-
-    /**
-     * Returns true if the field value satisfies all constraints (if any).
-     *
-     * @return {boolean}
-     */
-    checkValidity() {
-      return !this.required || !!this.value;
-    }
-
-    /** @protected */
-    _applyCustomError() {
-      const error = this.__errorMessage;
-      if (error && error !== this.errorMessage) {
-        this.errorMessage = error;
-        delete this.__errorMessage;
+/**
+ * A mixin to provide required state and validation logic.
+ *
+ * @polymerMixin
+ */
+export const ValidateMixin = dedupingMixin(
+  (superclass) =>
+    class ValidateMixinClass extends superclass {
+      static get properties() {
+        return {
+          /**
+           * Set to true when the field is invalid.
+           */
+          invalid: {
+            type: Boolean,
+            reflectToAttribute: true,
+            notify: true,
+            value: false
+          },
+
+          /**
+           * Specifies that the user must fill in a value.
+           */
+          required: {
+            type: Boolean,
+            reflectToAttribute: true
+          }
+        };
       }
-    }
 
-    /**
-     * @param {boolean} invalid
-     * @protected
-     */
-    _updateErrorMessage(invalid, errorMessage) {
-      if (!this._errorNode) {
-        return;
+      /**
+       * Returns true if field is valid, and sets `invalid` based on the field validity.
+       *
+       * @return {boolean} True if the value is valid.
+       */
+      validate() {
+        return !(this.invalid = !this.checkValidity());
       }
 
-      // save the custom error message content
-      if (this._errorNode.textContent && !errorMessage) {
-        this.__errorMessage = this._errorNode.textContent.trim();
+      /**
+       * Returns true if the field value satisfies all constraints (if any).
+       *
+       * @return {boolean}
+       */
+      checkValidity() {
+        return !this.required || !!this.value;
       }
-      const hasError = Boolean(invalid && errorMessage);
-      this._errorNode.textContent = hasError ? errorMessage : '';
-      this.toggleAttribute('has-error-message', hasError);
     }
-  };
-
-/**
- * A mixin to provide required state and validation logic.
- */
-export const ValidateMixin = dedupingMixin(ValidateMixinImplementation);
+);

package/src/active-mixin.d.ts

@@ -1,25 +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 { DisabledMixin } from './disabled-mixin.js';
-
-/**
- * A mixin to toggle the `active` attribute.
- *
- * The attribute is set whenever the user activates the element by a pointer
- * or presses an activation key on the element from the keyboard.
- *
- * The attribute is removed as soon as the element is deactivated
- * by the pointer or by releasing the activation key.
- */
-declare function ActiveMixin<T extends new (...args: any[]) => {}>(base: T): T & ActiveMixinConstructor;
-
-interface ActiveMixinConstructor {
-  new (...args: any[]): ActiveMixin;
-}
-
-interface ActiveMixin extends DisabledMixin {}
-
-export { ActiveMixinConstructor, ActiveMixin };

package/src/active-mixin.js

@@ -1,84 +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 { GestureEventListeners } from '@polymer/polymer/lib/mixins/gesture-event-listeners.js';
-import { DisabledMixin } from './disabled-mixin.js';
-
-const ActiveMixinImplementation = (superclass) =>
-  class ActiveMixinClass extends DisabledMixin(GestureEventListeners(superclass)) {
-    /**
-     * An array of activation keys.
-     *
-     * See possible values here:
-     * https://developer.mozilla.org/ru/docs/Web/API/KeyboardEvent/key/Key_Values
-     *
-     * @protected
-     * @return {!Array<!string>}
-     */
-    get _activeKeys() {
-      return ['Enter', ' '];
-    }
-
-    /** @protected */
-    ready() {
-      super.ready();
-
-      // POINTERDOWN
-      this._addEventListenerToNode(this, 'down', () => {
-        if (this.disabled) return;
-
-        this.setAttribute('active', '');
-      });
-
-      // POINTERUP
-      this._addEventListenerToNode(this, 'up', () => {
-        this.removeAttribute('active');
-      });
-
-      // KEYDOWN
-      this.addEventListener('keydown', (event) => {
-        if (this.disabled) return;
-
-        if (this._activeKeys.includes(event.key)) {
-          this.setAttribute('active', '');
-        }
-      });
-
-      // KEYUP
-      this.addEventListener('keyup', (event) => {
-        if (this._activeKeys.includes(event.key)) {
-          this.removeAttribute('active');
-        }
-      });
-
-      // BLUR
-      this.addEventListener('blur', () => {
-        this.removeAttribute('active');
-      });
-    }
-
-    /** @protected */
-    disconnectedCallback() {
-      super.disconnectedCallback();
-
-      // When the element is disconnecting from the DOM at the moment being active,
-      // the `active` attribute needs to be manually removed from the element.
-      // Otherwise, it will preserve on the element until the element is activated once again.
-      // The case reproduces for `<vaadin-date-picker>` when closing on `Cancel` or `Today` click.
-      this.removeAttribute('active');
-    }
-  };
-
-/**
- * A mixin to toggle the `active` attribute.
- *
- * The attribute is set whenever the user activates the element by a pointer
- * or presses an activation key on the element from the keyboard.
- *
- * The attribute is removed as soon as the element is deactivated
- * by the pointer or by releasing the activation key.
- */
-export const ActiveMixin = dedupingMixin(ActiveMixinImplementation);

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

@@ -1,20 +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 { LabelMixin } from './label-mixin.js';
-import { InputMixin } from './input-mixin.js';
-
-/**
- * A mixin to link an input element with a slotted `<label>` element.
- */
-declare function AriaLabelMixin<T extends new (...args: any[]) => {}>(base: T): T & AriaLabelMixinConstructor;
-
-interface AriaLabelMixinConstructor {
-  new (...args: any[]): AriaLabelMixin;
-}
-
-interface AriaLabelMixin extends InputMixin, LabelMixin {}
-
-export { AriaLabelMixin, AriaLabelMixinConstructor };

package/src/aria-label-mixin.js

@@ -1,71 +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 { LabelMixin } from './label-mixin.js';
-import { InputMixin } from './input-mixin.js';
-
-const AriaLabelMixinImplementation = (superclass) =>
-  class AriaLabelMixinClass extends InputMixin(LabelMixin(superclass)) {
-    constructor() {
-      super();
-
-      this.__preventDuplicateLabelClick = this.__preventDuplicateLabelClick.bind(this);
-    }
-
-    /** @protected */
-    connectedCallback() {
-      super.connectedCallback();
-
-      if (this._labelNode) {
-        this._labelNode.addEventListener('click', this.__preventDuplicateLabelClick);
-      }
-    }
-
-    /** @protected */
-    disconnectedCallback() {
-      super.disconnectedCallback();
-
-      if (this._labelNode) {
-        this._labelNode.removeEventListener('click', this.__preventDuplicateLabelClick);
-      }
-    }
-
-    /**
-     * Override an observer from `InputMixin`.
-     * @protected
-     * @override
-     */
-    _inputElementChanged(input) {
-      super._inputElementChanged(input);
-
-      if (input) {
-        input.setAttribute('aria-labelledby', this._labelId);
-
-        this._labelNode.setAttribute('for', input.id);
-      }
-    }
-
-    /**
-     * The native platform fires an event for both the click on the label, and also
-     * the subsequent click on the native input element caused by label click.
-     * This results in two click events arriving at the host, but we only want one.
-     * This method prevents the duplicate click and ensures the correct isTrusted event
-     * with the correct event.target arrives at the host.
-     * @private
-     */
-    __preventDuplicateLabelClick() {
-      const inputClickHandler = (e) => {
-        e.stopImmediatePropagation();
-        this.inputElement.removeEventListener('click', inputClickHandler);
-      };
-      this.inputElement.addEventListener('click', inputClickHandler);
-    }
-  };
-
-/**
- * A mixin to link an input element with a slotted `<label>` element.
- */
-export const AriaLabelMixin = dedupingMixin(AriaLabelMixinImplementation);

package/src/char-length-mixin.d.ts

@@ -1,30 +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 { ForwardInputPropsMixin } from './forward-input-props-mixin.js';
-
-/**
- * A mixin to provide `minlength` and `maxlength` properties
- * for components that use `<input>` or `<textarea>`.
- */
-declare function CharLengthMixin<T extends new (...args: any[]) => {}>(base: T): T & CharLengthMixinConstructor;
-
-interface CharLengthMixinConstructor {
-  new (...args: any[]): CharLengthMixin;
-}
-
-interface CharLengthMixin extends ForwardInputPropsMixin {
-  /**
-   * Maximum number of characters (in Unicode code points) that the user can enter.
-   */
-  maxlength: number | null | undefined;
-
-  /**
-   * Minimum number of characters (in Unicode code points) that the user can enter.
-   */
-  minlength: number | null | undefined;
-}
-
-export { CharLengthMixin, CharLengthMixinConstructor };

package/src/char-length-mixin.js

@@ -1,42 +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 { ForwardInputPropsMixin } from './forward-input-props-mixin.js';
-
-const CharLengthMixinImplementation = (superclass) =>
-  class CharLengthMixinClass extends ForwardInputPropsMixin(superclass) {
-    static get properties() {
-      return {
-        /**
-         * Maximum number of characters (in Unicode code points) that the user can enter.
-         */
-        maxlength: {
-          type: Number
-        },
-
-        /**
-         * Minimum number of characters (in Unicode code points) that the user can enter.
-         */
-        minlength: {
-          type: Number
-        }
-      };
-    }
-
-    static get forwardProps() {
-      return [...super.forwardProps, 'maxlength', 'minlength'];
-    }
-
-    static get constraints() {
-      return [...super.constraints, 'maxlength', 'minlength'];
-    }
-  };
-
-/**
- * A mixin to provide `minlength` and `maxlength` properties
- * for components that use `<input>` or `<textarea>`.
- */
-export const CharLengthMixin = dedupingMixin(CharLengthMixinImplementation);

package/src/clear-button-mixin.d.ts

@@ -1,27 +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 { InputMixin } from './input-mixin.js';
-
-/**
- * A mixin to add clear button support to field components.
- */
-declare function ClearButtonMixin<T extends new (...args: any[]) => {}>(base: T): T & ClearButtonMixinConstructor;
-
-interface ClearButtonMixinConstructor {
-  new (...args: any[]): ClearButtonMixin;
-}
-
-interface ClearButtonMixin extends InputMixin {
-  /**
-   * Set to true to display the clear icon which clears the input.
-   * @attr {boolean} clear-button-visible
-   */
-  clearButtonVisible: boolean;
-
-  readonly _clearOnEsc: boolean;
-}
-
-export { ClearButtonMixin, ClearButtonMixinConstructor };

package/src/clear-button-mixin.js

@@ -1,80 +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';
-
-const ClearButtonMixinImplementation = (superclass) =>
-  class ClearButtonMixinClass extends InputMixin(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();
-
-      this.addEventListener('keydown', (e) => this._onKeyDown(e));
-
-      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 {Event} event
-     * @protected
-     */
-    _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/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,48 +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');
-      }
-    }
-  };
-
-/**
- * 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 };