@vaadin/component-base 22.0.0-alpha9 → 22.0.0

package/README.md

@@ -1,9 +1,14 @@
 # @vaadin/component-base
 
-A set of mixins used by Vaadin components.
+A set of helpers and mixins used by Vaadin components.
+
+## Contributing
+
+Read the [contributing guide](https://vaadin.com/docs/latest/guide/contributing/overview) to learn about our development process, how to propose bugfixes and improvements, and how to test your changes to Vaadin components.
 
 ## License
 
 Apache License 2.0
 
-Vaadin collects development time usage statistics to improve this product. For details and to opt-out, see https://github.com/vaadin/vaadin-usage-statistics.
+Vaadin collects usage statistics at development time to improve this product.
+For details and to opt-out, see https://github.com/vaadin/vaadin-usage-statistics.

package/index.d.ts

@@ -1,4 +1,5 @@
 export { ActiveMixin } from './src/active-mixin.js';
+export { ControllerMixin } from './src/controller-mixin.js';
 export { DirMixin } from './src/dir-mixin.js';
 export { DisabledMixin } from './src/disabled-mixin.js';
 export { ElementMixin } from './src/element-mixin.js';

package/index.js

@@ -1,4 +1,5 @@
 export { ActiveMixin } from './src/active-mixin.js';
+export { ControllerMixin } from './src/controller-mixin.js';
 export { DirMixin } from './src/dir-mixin.js';
 export { DisabledMixin } from './src/disabled-mixin.js';
 export { ElementMixin } from './src/element-mixin.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vaadin/component-base",
-  "version": "22.0.0-alpha9",
+  "version": "22.0.0",
   "publishConfig": {
     "access": "public"
   },
@@ -30,6 +30,7 @@
     "web-component"
   ],
   "dependencies": {
+    "@open-wc/dedupe-mixin": "^1.3.0",
     "@polymer/polymer": "^3.0.0",
     "@vaadin/vaadin-development-mode-detector": "^2.0.0",
     "@vaadin/vaadin-usage-statistics": "^2.1.0",
@@ -37,8 +38,8 @@
   },
   "devDependencies": {
     "@esm-bundle/chai": "^4.3.4",
-    "@vaadin/testing-helpers": "^0.3.0",
+    "@vaadin/testing-helpers": "^0.3.2",
     "sinon": "^9.2.4"
   },
-  "gitHead": "6e8c899dc65918f97e3c0acb2076122c4b2ef274"
+  "gitHead": "b668e9b1a975227fbe34beb70d1cd5b03dce2348"
 }

package/src/active-mixin.d.ts

@@ -3,8 +3,9 @@
  * 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';
-import { KeyboardMixin } from './keyboard-mixin.js';
+import { Constructor } from '@open-wc/dedupe-mixin';
+import { DisabledMixinClass } from './disabled-mixin.js';
+import { KeyboardMixinClass } from './keyboard-mixin.js';
 
 /**
  * A mixin to toggle the `active` attribute.
@@ -15,12 +16,26 @@ import { KeyboardMixin } from './keyboard-mixin.js';
  * 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;
+export declare function ActiveMixin<T extends Constructor<HTMLElement>>(
+  base: T
+): T & Constructor<ActiveMixinClass> & Constructor<DisabledMixinClass> & Constructor<KeyboardMixinClass>;
 
-interface ActiveMixinConstructor {
-  new (...args: any[]): ActiveMixin;
-}
+export declare class ActiveMixinClass {
+  /**
+   * An array of activation keys.
+   *
+   * See possible values here:
+   * https://developer.mozilla.org/ru/docs/Web/API/KeyboardEvent/key/Key_Values
+   */
+  protected readonly _activeKeys: string[];
 
-interface ActiveMixin extends DisabledMixin, KeyboardMixin {}
+  /**
+   * Override to define if the component needs to be activated.
+   */
+  protected _shouldSetFocus(event: KeyboardEvent | MouseEvent): boolean;
 
-export { ActiveMixinConstructor, ActiveMixin };
+  /**
+   * Toggles the `active` attribute on the element.
+   */
+  protected _setActive(active: boolean): void;
+}

package/src/browser-utils.js

@@ -0,0 +1,35 @@
+/**
+ * @license
+ * Copyright (c) 2021 Vaadin Ltd.
+ * This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
+ */
+
+const testUserAgent = (regexp) => regexp.test(navigator.userAgent);
+
+const testPlatform = (regexp) => regexp.test(navigator.platform);
+
+const testVendor = (regexp) => regexp.test(navigator.vendor);
+
+export const isAndroid = testUserAgent(/Android/);
+
+export const isChrome = testUserAgent(/Chrome/) && testVendor(/Google Inc/);
+
+export const isFirefox = testUserAgent(/Firefox/);
+
+// iPadOS 13 lies and says it's a Mac, but we can distinguish by detecting touch support.
+export const isIPad = testPlatform(/^iPad/) || (testPlatform(/^Mac/) && navigator.maxTouchPoints > 1);
+
+export const isIPhone = testPlatform(/^iPhone/);
+
+export const isIOS = isIPhone || isIPad;
+
+export const isSafari = testUserAgent(/^((?!chrome|android).)*safari/i);
+
+export const isTouch = (() => {
+  try {
+    document.createEvent('TouchEvent');
+    return true;
+  } catch (e) {
+    return false;
+  }
+})();

package/src/controller-mixin.d.ts

@@ -0,0 +1,28 @@
+/**
+ * @license
+ * Copyright (c) 2021 Vaadin Ltd.
+ * This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
+ */
+import { Constructor } from '@open-wc/dedupe-mixin';
+import { ReactiveController, ReactiveControllerHost } from 'lit';
+
+/**
+ * A mixin for connecting controllers to the element.
+ */
+export declare function ControllerMixin<T extends Constructor<HTMLElement>>(
+  superclass: T
+): T & Constructor<ControllerMixinClass>;
+
+export declare class ControllerMixinClass
+  implements Pick<ReactiveControllerHost, 'addController' | 'removeController'>
+{
+  /**
+   * Registers a controller to participate in the element update cycle.
+   */
+  addController(controller: ReactiveController): void;
+
+  /**
+   * Removes a controller from the element.
+   */
+  removeController(controller: ReactiveController): void;
+}

package/src/controller-mixin.js

@@ -0,0 +1,67 @@
+/**
+ * @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';
+
+/**
+ * A mixin for connecting controllers to the element.
+ *
+ * @polymerMixin
+ */
+export const ControllerMixin = dedupingMixin(
+  (superClass) =>
+    class ControllerMixinClass extends superClass {
+      constructor() {
+        super();
+
+        /**
+         * @type {Set<import('lit').ReactiveController>}
+         */
+        this.__controllers = new Set();
+      }
+
+      /** @protected */
+      connectedCallback() {
+        super.connectedCallback();
+
+        this.__controllers.forEach((c) => {
+          c.hostConnected && c.hostConnected();
+        });
+      }
+
+      /** @protected */
+      disconnectedCallback() {
+        super.disconnectedCallback();
+
+        this.__controllers.forEach((c) => {
+          c.hostDisconnected && c.hostDisconnected();
+        });
+      }
+
+      /**
+       * Registers a controller to participate in the element update cycle.
+       *
+       * @param {import('lit').ReactiveController} controller
+       * @protected
+       */
+      addController(controller) {
+        this.__controllers.add(controller);
+        // Call hostConnected if a controller is added after the element is attached.
+        if (this.$ !== undefined && this.isConnected && controller.hostConnected) {
+          controller.hostConnected();
+        }
+      }
+
+      /**
+       * Removes a controller from the element.
+       *
+       * @param {import('lit').ReactiveController} controller
+       * @protected
+       */
+      removeController(controller) {
+        this.__controllers.delete(controller);
+      }
+    }
+);

package/src/dir-mixin.d.ts

@@ -3,22 +3,15 @@
  * Copyright (c) 2021 Vaadin Ltd.
  * This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
  */
+import { Constructor } from '@open-wc/dedupe-mixin';
 
 /**
  * A mixin to handle `dir` attribute based on the one set on the `<html>` element.
  */
-declare function DirMixin<T extends new (...args: any[]) => {}>(base: T): T & DirMixinConstructor;
+export declare function DirMixin<T extends Constructor<HTMLElement>>(base: T): T & Constructor<DirMixinClass>;
 
-interface DirMixinConstructor {
-  new (...args: any[]): DirMixin;
+export declare class DirMixinClass {
+  protected __getNormalizedScrollLeft(element: Element | null): number;
 
-  finalize(): void;
+  protected __setNormalizedScrollLeft(element: Element | null, scrollLeft: number): void;
 }
-
-interface DirMixin {
-  __getNormalizedScrollLeft(element: Element | null): number;
-
-  __setNormalizedScrollLeft(element: Element | null, scrollLeft: number): void;
-}
-
-export { DirMixin, DirMixinConstructor };

package/src/disabled-mixin.d.ts

@@ -3,21 +3,18 @@
  * Copyright (c) 2021 Vaadin Ltd.
  * This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
  */
+import { Constructor } from '@open-wc/dedupe-mixin';
 
 /**
  * A mixin to provide disabled property for field components.
  */
-declare function DisabledMixin<T extends new (...args: any[]) => {}>(base: T): T & DisabledMixinConstructor;
+export declare function DisabledMixin<T extends Constructor<HTMLElement>>(base: T): Constructor<DisabledMixinClass> & T;
 
-interface DisabledMixinConstructor {
-  new (...args: any[]): DisabledMixin;
-}
-
-interface DisabledMixin {
+export declare class DisabledMixinClass {
   /**
    * If true, the user cannot interact with this element.
    */
   disabled: boolean;
-}
 
-export { DisabledMixinConstructor, DisabledMixin };
+  protected _disabledChanged(disabled: boolean, oldDisabled: boolean): void;
+}

package/src/element-mixin.d.ts

@@ -3,20 +3,20 @@
  * Copyright (c) 2021 Vaadin Ltd.
  * This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
  */
-import { ReactiveControllerHost } from 'lit';
 import '../custom_typings/vaadin-usage-statistics.js';
 import '../custom_typings/vaadin.js';
-import { DirMixin, DirMixinConstructor } from './dir-mixin.js';
+import { Constructor } from '@open-wc/dedupe-mixin';
+import { DirMixinClass } from './dir-mixin.js';
 
-declare function ElementMixin<T extends new (...args: any[]) => {}>(
-  base: T
-): T & ElementMixinConstructor & DirMixinConstructor;
-
-interface ElementMixinConstructor {
-  new (...args: any[]): ElementMixin;
-  finalize(): void;
-}
+/**
+ * A mixin providing common logic for Vaadin components.
+ */
+export declare function ElementMixin<T extends Constructor<HTMLElement>>(
+  superclass: T
+): T & Constructor<DirMixinClass> & Constructor<ElementMixinClass>;
 
-interface ElementMixin extends Pick<ReactiveControllerHost, 'addController' | 'removeController'>, DirMixin {}
+export declare class ElementMixinClass {
+  static version: string;
 
-export { ElementMixin, ElementMixinConstructor };
+  protected static finalize(): void;
+}

package/src/element-mixin.js

@@ -32,7 +32,7 @@ const registered = new Set();
 export const ElementMixin = (superClass) =>
   class VaadinElementMixin extends DirMixin(superClass) {
     static get version() {
-      return '22.0.0-alpha9';
+      return '22.0.0';
     }
 
     /** @protected */
@@ -58,50 +58,10 @@ export const ElementMixin = (superClass) =>
     constructor() {
       super();
 
-      this.__controllers = new Set();
-
       if (document.doctype === null) {
         console.warn(
           'Vaadin components require the "standards mode" declaration. Please add <!DOCTYPE html> to the HTML document.'
         );
       }
     }
-
-    /** @protected */
-    connectedCallback() {
-      super.connectedCallback();
-
-      this.__controllers.forEach((c) => {
-        c.hostConnected && c.hostConnected();
-      });
-    }
-
-    /** @protected */
-    disconnectedCallback() {
-      super.disconnectedCallback();
-
-      this.__controllers.forEach((c) => {
-        c.hostDisconnected && c.hostDisconnected();
-      });
-    }
-
-    /**
-     * Registers a controller to participate in the element update cycle.
-     * @protected
-     */
-    addController(controller) {
-      this.__controllers.add(controller);
-      // Call hostConnected if a controller is added after the element is attached.
-      if (this.$ !== undefined && this.isConnected && controller.hostConnected) {
-        controller.hostConnected();
-      }
-    }
-
-    /**
-     * Removes a controller from the element.
-     * @protected
-     */
-    removeController(controller) {
-      this.__controllers.delete(controller);
-    }
   };

package/src/focus-mixin.d.ts

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

package/src/focus-mixin.js

@@ -35,6 +35,14 @@ window.addEventListener(
 export const FocusMixin = dedupingMixin(
   (superclass) =>
     class FocusMixinClass extends superclass {
+      /**
+       * @protected
+       * @return {boolean}
+       */
+      get _keyboardActive() {
+        return keyboardActive;
+      }
+
       /** @protected */
       ready() {
         this.addEventListener('focusin', (e) => {
@@ -78,13 +86,13 @@ export const FocusMixin = dedupingMixin(
 
         // 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);
+        this.toggleAttribute('focus-ring', focused && this._keyboardActive);
       }
 
       /**
        * Override to define if the field receives focus based on the event.
        *
-       * @param {FocusEvent} event
+       * @param {FocusEvent} _event
        * @return {boolean}
        * @protected
        */
@@ -95,7 +103,7 @@ export const FocusMixin = dedupingMixin(
       /**
        * Override to define if the field loses focus based on the event.
        *
-       * @param {FocusEvent} event
+       * @param {FocusEvent} _event
        * @return {boolean}
        * @protected
        */