@vaadin/field-base 22.0.0-alpha1 → 22.0.0-alpha10

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

@@ -1,32 +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;
-
-  /**
-   * Clear the value of this field.
-   */
-  clear(): void;
-
-  readonly _clearOnEsc: boolean;
-}
-
-export { ClearButtonMixin, ClearButtonMixinConstructor };

package/src/clear-button-mixin.js

@@ -1,87 +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));
-      }
-    }
-
-    /**
-     * Clear the value of this field.
-     */
-    clear() {
-      this.value = this._inputNode.value = '';
-    }
-
-    /**
-     * @param {Event} event
-     * @protected
-     */
-    _onClearButtonClick(event) {
-      event.preventDefault();
-      this._inputNode.focus();
-      this.clear();
-      this._inputNode.dispatchEvent(new Event('input', { bubbles: true, composed: true }));
-      this._inputNode.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._inputNode.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 };

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 ['_invalidChanged(invalid)'];
-    }
-
-    /** @protected */
-    connectedCallback() {
-      super.connectedCallback();
-
-      this._updateAriaAttribute(this.invalid);
-    }
-
-    /** @protected */
-    _updateAriaAttribute(invalid) {
-      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' ? [this._helperId] : [this._labelId, this._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(' '));
-      }
-    }
-
-    /** @protected */
-    _invalidChanged(invalid) {
-      this._updateAriaAttribute(invalid);
-    }
-  };
-
-/**
- * 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,109 +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'
-        }
-      };
-    }
-
-    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}`;
-    }
-
-    /** @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));
-    }
-
-    /** @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) {
-        customHelper.id = this._helperId;
-
-        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-aria-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 slotted `<input>` and `<label>` elements.
- */
-declare function InputAriaMixin<T extends new (...args: any[]) => {}>(base: T): T & InputAriaMixinConstructor;
-
-interface InputAriaMixinConstructor {
-  new (...args: any[]): InputAriaMixin;
-}
-
-interface InputAriaMixin extends InputMixin, LabelMixin {}
-
-export { InputAriaMixin, InputAriaMixinConstructor };

package/src/input-aria-mixin.js

@@ -1,69 +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 InputAriaMixinImplementation = (superclass) =>
-  class InputAriaMixinClass extends InputMixin(LabelMixin(superclass)) {
-    constructor() {
-      super();
-
-      this.__preventDuplicateLabelClick = this.__preventDuplicateLabelClick.bind(this);
-    }
-
-    /** @protected */
-    connectedCallback() {
-      super.connectedCallback();
-
-      this._enhanceLightDomA11y();
-
-      if (this._labelNode) {
-        this._labelNode.addEventListener('click', this.__preventDuplicateLabelClick);
-      }
-    }
-
-    /** @protected */
-    disconnectedCallback() {
-      super.disconnectedCallback();
-
-      if (this._labelNode) {
-        this._labelNode.removeEventListener('click', this.__preventDuplicateLabelClick);
-      }
-    }
-
-    /** @protected */
-    _enhanceLightDomA11y() {
-      if (this._inputNode) {
-        this._inputNode.setAttribute('aria-labelledby', this._labelId);
-      }
-
-      if (this._labelNode) {
-        this._labelNode.setAttribute('for', this._inputId);
-      }
-    }
-
-    /**
-     * 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._inputNode.removeEventListener('click', inputClickHandler);
-      };
-      this._inputNode.addEventListener('click', inputClickHandler);
-    }
-  };
-
-/**
- * A mixin to link slotted `<input>` and `<label>` elements.
- */
-export const InputAriaMixin = dedupingMixin(InputAriaMixinImplementation);

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

@@ -1,40 +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 { InputAriaMixin } from './input-aria-mixin.js';
-import { ValidateMixin } from './validate-mixin.js';
-
-/**
- * A mixin to forward properties to the native <input> element.
- */
-declare function InputPropsMixin<T extends new (...args: any[]) => {}>(base: T): T & InputPropsMixinConstructor;
-
-interface InputPropsMixinConstructor {
-  new (...args: any[]): InputPropsMixin;
-}
-
-interface InputPropsMixin extends InputAriaMixin, ValidateMixin {
-  /**
-   * 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 { InputPropsMixinConstructor, InputPropsMixin };