@vaadin/virtual-list 24.3.0-alpha10 → 24.3.0-alpha11

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vaadin/virtual-list",
-  "version": "24.3.0-alpha10",
+  "version": "24.3.0-alpha11",
   "publishConfig": {
     "access": "public"
   },
@@ -37,12 +37,13 @@
     "web-component"
   ],
   "dependencies": {
+    "@open-wc/dedupe-mixin": "^1.3.0",
     "@polymer/polymer": "^3.0.0",
-    "@vaadin/component-base": "24.3.0-alpha10",
-    "@vaadin/lit-renderer": "24.3.0-alpha10",
-    "@vaadin/vaadin-lumo-styles": "24.3.0-alpha10",
-    "@vaadin/vaadin-material-styles": "24.3.0-alpha10",
-    "@vaadin/vaadin-themable-mixin": "24.3.0-alpha10"
+    "@vaadin/component-base": "24.3.0-alpha11",
+    "@vaadin/lit-renderer": "24.3.0-alpha11",
+    "@vaadin/vaadin-lumo-styles": "24.3.0-alpha11",
+    "@vaadin/vaadin-material-styles": "24.3.0-alpha11",
+    "@vaadin/vaadin-themable-mixin": "24.3.0-alpha11"
   },
   "devDependencies": {
     "@esm-bundle/chai": "^4.3.4",
@@ -54,5 +55,5 @@
     "web-types.json",
     "web-types.lit.json"
   ],
-  "gitHead": "0271523d93fe5df0425ff64206886614f3c6f401"
+  "gitHead": "123cf569a1b6ef6f4ef5fe8e60cb8d988699b98c"
 }

package/src/vaadin-virtual-list-mixin.d.ts

@@ -0,0 +1,68 @@
+/**
+ * @license
+ * Copyright (c) 2021 - 2023 Vaadin Ltd.
+ * This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
+ */
+import type { Constructor } from '@open-wc/dedupe-mixin';
+import type { ControllerMixinClass } from '@vaadin/component-base/src/controller-mixin.js';
+import type { VirtualList } from './vaadin-virtual-list.js';
+
+export type VirtualListDefaultItem = any;
+
+export interface VirtualListItemModel<TItem> {
+  index: number;
+  item: TItem;
+}
+
+export type VirtualListRenderer<TItem> = (
+  root: HTMLElement,
+  virtualList: VirtualList<TItem>,
+  model: VirtualListItemModel<TItem>,
+) => void;
+
+export declare function VirtualListMixin<TItem, T extends Constructor<HTMLElement>>(
+  base: T,
+): Constructor<ControllerMixinClass> & Constructor<VirtualListMixinClass<TItem>> & T;
+
+export declare class VirtualListMixinClass<TItem = VirtualListDefaultItem> {
+  /**
+   * Gets the index of the first visible item in the viewport.
+   */
+  readonly firstVisibleIndex: number;
+
+  /**
+   * Gets the index of the last visible item in the viewport.
+   */
+  readonly lastVisibleIndex: number;
+
+  /**
+   * Custom function for rendering the content of every item.
+   * Receives three arguments:
+   *
+   * - `root` The render target element representing one item at a time.
+   * - `virtualList` The reference to the `<vaadin-virtual-list>` element.
+   * - `model` The object with the properties related with the rendered
+   *   item, contains:
+   *   - `model.index` The index of the rendered item.
+   *   - `model.item` The item.
+   */
+  renderer: VirtualListRenderer<TItem> | undefined;
+
+  /**
+   * An array containing items determining how many instances to render.
+   */
+  items: TItem[] | undefined;
+
+  /**
+   * Scroll to a specific index in the virtual list.
+   */
+  scrollToIndex(index: number): void;
+
+  /**
+   * Requests an update for the content of the rows.
+   * While performing the update, it invokes the renderer passed in the `renderer` property for each visible row.
+   *
+   * It is not guaranteed that the update happens immediately (synchronously) after it is requested.
+   */
+  requestContentUpdate(): void;
+}

package/src/vaadin-virtual-list-mixin.js

@@ -0,0 +1,146 @@
+/**
+ * @license
+ * Copyright (c) 2021 - 2023 Vaadin Ltd.
+ * This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
+ */
+import { ControllerMixin } from '@vaadin/component-base/src/controller-mixin.js';
+import { OverflowController } from '@vaadin/component-base/src/overflow-controller.js';
+import { processTemplates } from '@vaadin/component-base/src/templates.js';
+import { Virtualizer } from '@vaadin/component-base/src/virtualizer.js';
+
+/**
+ * @polymerMixin
+ * @mixes ControllerMixin
+ */
+export const VirtualListMixin = (superClass) =>
+  class VirtualListMixinClass extends ControllerMixin(superClass) {
+    static get properties() {
+      return {
+        /**
+         * An array containing items determining how many instances to render.
+         * @type {Array<!VirtualListItem> | undefined}
+         */
+        items: { type: Array },
+
+        /**
+         * Custom function for rendering the content of every item.
+         * Receives three arguments:
+         *
+         * - `root` The render target element representing one item at a time.
+         * - `virtualList` The reference to the `<vaadin-virtual-list>` element.
+         * - `model` The object with the properties related with the rendered
+         *   item, contains:
+         *   - `model.index` The index of the rendered item.
+         *   - `model.item` The item.
+         * @type {VirtualListRenderer | undefined}
+         */
+        renderer: Function,
+
+        /** @private */
+        __virtualizer: Object,
+      };
+    }
+
+    static get observers() {
+      return ['__itemsOrRendererChanged(items, renderer, __virtualizer)'];
+    }
+
+    /**
+     * Gets the index of the first visible item in the viewport.
+     *
+     * @return {number}
+     */
+    get firstVisibleIndex() {
+      return this.__virtualizer.firstVisibleIndex;
+    }
+
+    /**
+     * Gets the index of the last visible item in the viewport.
+     *
+     * @return {number}
+     */
+    get lastVisibleIndex() {
+      return this.__virtualizer.lastVisibleIndex;
+    }
+
+    /** @protected */
+    ready() {
+      super.ready();
+
+      this.__virtualizer = new Virtualizer({
+        createElements: this.__createElements,
+        updateElement: this.__updateElement.bind(this),
+        elementsContainer: this,
+        scrollTarget: this,
+        scrollContainer: this.shadowRoot.querySelector('#items'),
+      });
+
+      this.__overflowController = new OverflowController(this);
+      this.addController(this.__overflowController);
+
+      processTemplates(this);
+    }
+
+    /**
+     * Scroll to a specific index in the virtual list.
+     *
+     * @param {number} index Index to scroll to
+     */
+    scrollToIndex(index) {
+      this.__virtualizer.scrollToIndex(index);
+    }
+
+    /** @private */
+    __createElements(count) {
+      return [...Array(count)].map(() => document.createElement('div'));
+    }
+
+    /** @private */
+    __updateElement(el, index) {
+      if (el.__renderer !== this.renderer) {
+        el.__renderer = this.renderer;
+        this.__clearRenderTargetContent(el);
+      }
+
+      if (this.renderer) {
+        this.renderer(el, this, { item: this.items[index], index });
+      }
+    }
+
+    /**
+     * Clears the content of a render target.
+     * @private
+     */
+    __clearRenderTargetContent(element) {
+      element.innerHTML = '';
+      // Whenever a Lit-based renderer is used, it assigns a Lit part to the node it was rendered into.
+      // When clearing the rendered content, this part needs to be manually disposed of.
+      // Otherwise, using a Lit-based renderer on the same node will throw an exception or render nothing afterward.
+      delete element._$litPart$;
+    }
+
+    /** @private */
+    __itemsOrRendererChanged(items, renderer, virtualizer) {
+      // If the renderer is removed but there are elements created by
+      // a previous renderer, we need to request an update from the virtualizer
+      // to get the already existing elements properly cleared.
+      const hasRenderedItems = this.childElementCount > 0;
+
+      if ((renderer || hasRenderedItems) && virtualizer) {
+        virtualizer.size = (items || []).length;
+        virtualizer.update();
+      }
+    }
+
+    /**
+     * Requests an update for the content of the rows.
+     * While performing the update, it invokes the renderer passed in the `renderer` property for each visible row.
+     *
+     * It is not guaranteed that the update happens immediately (synchronously) after it is requested.
+     */
+    requestContentUpdate() {
+      if (this.__virtualizer) {
+        this.__virtualizer.update();
+      }
+    }
+  };

package/src/vaadin-virtual-list-styles.d.ts

@@ -0,0 +1,8 @@
+/**
+ * @license
+ * Copyright (c) 2017 - 2023 Vaadin Ltd.
+ * This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
+ */
+import type { CSSResult } from 'lit';
+
+export const virtualListStyles: CSSResult;

package/src/vaadin-virtual-list-styles.js

@@ -0,0 +1,28 @@
+/**
+ * @license
+ * Copyright (c) 2017 - 2023 Vaadin Ltd.
+ * This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
+ */
+import { css } from 'lit';
+
+export const virtualListStyles = css`
+  :host {
+    display: block;
+    height: 400px;
+    overflow: auto;
+    flex: auto;
+    align-self: stretch;
+  }
+
+  :host([hidden]) {
+    display: none !important;
+  }
+
+  :host(:not([grid])) #items > ::slotted(*) {
+    width: 100%;
+  }
+
+  #items {
+    position: relative;
+  }
+`;

package/src/vaadin-virtual-list.d.ts

@@ -3,22 +3,16 @@
  * Copyright (c) 2021 - 2023 Vaadin Ltd.
  * This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
  */
-import { ControllerMixin } from '@vaadin/component-base/src/controller-mixin.js';
 import { ElementMixin } from '@vaadin/component-base/src/element-mixin.js';
 import { ThemableMixin } from '@vaadin/vaadin-themable-mixin/vaadin-themable-mixin.js';
+import type {
+  VirtualListDefaultItem,
+  VirtualListItemModel,
+  VirtualListMixinClass,
+  VirtualListRenderer,
+} from './vaadin-virtual-list-mixin.js';
 
-export type VirtualListDefaultItem = any;
-
-export interface VirtualListItemModel<TItem> {
-  index: number;
-  item: TItem;
-}
-
-export type VirtualListRenderer<TItem> = (
-  root: HTMLElement,
-  virtualList: VirtualList<TItem>,
-  model: VirtualListItemModel<TItem>,
-) => void;
+export { VirtualListDefaultItem, VirtualListItemModel, VirtualListRenderer };
 
 /**
  * `<vaadin-virtual-list>` is a Web Component for displaying a virtual/infinite list of items.
@@ -46,51 +40,11 @@ export type VirtualListRenderer<TItem> = (
  * @extends HTMLElement
  * @mixes ElementMixin
  * @mixes ThemableMixin
+ * @mixes VirtualListMixin
  */
-declare class VirtualList<TItem = VirtualListDefaultItem> extends ElementMixin(
-  ControllerMixin(ThemableMixin(HTMLElement)),
-) {
-  /**
-   * Gets the index of the first visible item in the viewport.
-   */
-  readonly firstVisibleIndex: number;
-
-  /**
-   * Gets the index of the last visible item in the viewport.
-   */
-  readonly lastVisibleIndex: number;
+declare class VirtualList<TItem = VirtualListDefaultItem> extends ThemableMixin(ElementMixin(HTMLElement)) {}
 
-  /**
-   * Custom function for rendering the content of every item.
-   * Receives three arguments:
-   *
-   * - `root` The render target element representing one item at a time.
-   * - `virtualList` The reference to the `<vaadin-virtual-list>` element.
-   * - `model` The object with the properties related with the rendered
-   *   item, contains:
-   *   - `model.index` The index of the rendered item.
-   *   - `model.item` The item.
-   */
-  renderer: VirtualListRenderer<TItem> | undefined;
-
-  /**
-   * An array containing items determining how many instances to render.
-   */
-  items: TItem[] | undefined;
-
-  /**
-   * Scroll to a specific index in the virtual list.
-   */
-  scrollToIndex(index: number): void;
-
-  /**
-   * Requests an update for the content of the rows.
-   * While performing the update, it invokes the renderer passed in the `renderer` property for each visible row.
-   *
-   * It is not guaranteed that the update happens immediately (synchronously) after it is requested.
-   */
-  requestContentUpdate(): void;
-}
+interface VirtualList<TItem = VirtualListDefaultItem> extends VirtualListMixinClass<TItem> {}
 
 declare global {
   interface HTMLElementTagNameMap {

package/src/vaadin-virtual-list.js

@@ -4,13 +4,13 @@
  * This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
  */
 import { html, PolymerElement } from '@polymer/polymer/polymer-element.js';
-import { ControllerMixin } from '@vaadin/component-base/src/controller-mixin.js';
 import { defineCustomElement } from '@vaadin/component-base/src/define.js';
 import { ElementMixin } from '@vaadin/component-base/src/element-mixin.js';
-import { OverflowController } from '@vaadin/component-base/src/overflow-controller.js';
-import { processTemplates } from '@vaadin/component-base/src/templates.js';
-import { Virtualizer } from '@vaadin/component-base/src/virtualizer.js';
-import { ThemableMixin } from '@vaadin/vaadin-themable-mixin/vaadin-themable-mixin.js';
+import { registerStyles, ThemableMixin } from '@vaadin/vaadin-themable-mixin/vaadin-themable-mixin.js';
+import { VirtualListMixin } from './vaadin-virtual-list-mixin.js';
+import { virtualListStyles } from './vaadin-virtual-list-styles.js';
+
+registerStyles('vaadin-virtual-list', virtualListStyles, { moduleId: 'vaadin-virtual-list-styles' });
 
 /**
  * `<vaadin-virtual-list>` is a Web Component for displaying a virtual/infinite list of items.
@@ -37,35 +37,13 @@ import { ThemableMixin } from '@vaadin/vaadin-themable-mixin/vaadin-themable-mix
  *
  * @customElement
  * @extends HTMLElement
- * @mixes ControllerMixin
  * @mixes ElementMixin
  * @mixes ThemableMixin
+ * @mixes VirtualListMixin
  */
-class VirtualList extends ElementMixin(ControllerMixin(ThemableMixin(PolymerElement))) {
+class VirtualList extends ElementMixin(ThemableMixin(VirtualListMixin(PolymerElement))) {
   static get template() {
     return html`
-      <style>
-        :host {
-          display: block;
-          height: 400px;
-          overflow: auto;
-          flex: auto;
-          align-self: stretch;
-        }
-
-        :host([hidden]) {
-          display: none !important;
-        }
-
-        :host(:not([grid])) #items > ::slotted(*) {
-          width: 100%;
-        }
-
-        #items {
-          position: relative;
-        }
-      </style>
-
       <div id="items">
         <slot></slot>
       </div>
@@ -75,136 +53,6 @@ class VirtualList extends ElementMixin(ControllerMixin(ThemableMixin(PolymerElem
   static get is() {
     return 'vaadin-virtual-list';
   }
-
-  static get properties() {
-    return {
-      /**
-       * An array containing items determining how many instances to render.
-       * @type {Array<!VirtualListItem> | undefined}
-       */
-      items: { type: Array },
-
-      /**
-       * Custom function for rendering the content of every item.
-       * Receives three arguments:
-       *
-       * - `root` The render target element representing one item at a time.
-       * - `virtualList` The reference to the `<vaadin-virtual-list>` element.
-       * - `model` The object with the properties related with the rendered
-       *   item, contains:
-       *   - `model.index` The index of the rendered item.
-       *   - `model.item` The item.
-       * @type {VirtualListRenderer | undefined}
-       */
-      renderer: Function,
-
-      /** @private */
-      __virtualizer: Object,
-    };
-  }
-
-  static get observers() {
-    return ['__itemsOrRendererChanged(items, renderer, __virtualizer)'];
-  }
-
-  /**
-   * Gets the index of the first visible item in the viewport.
-   *
-   * @return {number}
-   */
-  get firstVisibleIndex() {
-    return this.__virtualizer.firstVisibleIndex;
-  }
-
-  /**
-   * Gets the index of the last visible item in the viewport.
-   *
-   * @return {number}
-   */
-  get lastVisibleIndex() {
-    return this.__virtualizer.lastVisibleIndex;
-  }
-
-  /** @protected */
-  ready() {
-    super.ready();
-
-    this.__virtualizer = new Virtualizer({
-      createElements: this.__createElements,
-      updateElement: this.__updateElement.bind(this),
-      elementsContainer: this,
-      scrollTarget: this,
-      scrollContainer: this.shadowRoot.querySelector('#items'),
-    });
-
-    this.__overflowController = new OverflowController(this);
-    this.addController(this.__overflowController);
-
-    processTemplates(this);
-  }
-
-  /**
-   * Scroll to a specific index in the virtual list.
-   *
-   * @param {number} index Index to scroll to
-   */
-  scrollToIndex(index) {
-    this.__virtualizer.scrollToIndex(index);
-  }
-
-  /** @private */
-  __createElements(count) {
-    return [...Array(count)].map(() => document.createElement('div'));
-  }
-
-  /** @private */
-  __updateElement(el, index) {
-    if (el.__renderer !== this.renderer) {
-      el.__renderer = this.renderer;
-      this.__clearRenderTargetContent(el);
-    }
-
-    if (this.renderer) {
-      this.renderer(el, this, { item: this.items[index], index });
-    }
-  }
-
-  /**
-   * Clears the content of a render target.
-   * @private
-   */
-  __clearRenderTargetContent(element) {
-    element.innerHTML = '';
-    // Whenever a Lit-based renderer is used, it assigns a Lit part to the node it was rendered into.
-    // When clearing the rendered content, this part needs to be manually disposed of.
-    // Otherwise, using a Lit-based renderer on the same node will throw an exception or render nothing afterward.
-    delete element._$litPart$;
-  }
-
-  /** @private */
-  __itemsOrRendererChanged(items, renderer, virtualizer) {
-    // If the renderer is removed but there are elements created by
-    // a previous renderer, we need to request an update from the virtualizer
-    // to get the already existing elements properly cleared.
-    const hasRenderedItems = this.childElementCount > 0;
-
-    if ((renderer || hasRenderedItems) && virtualizer) {
-      virtualizer.size = (items || []).length;
-      virtualizer.update();
-    }
-  }
-
-  /**
-   * Requests an update for the content of the rows.
-   * While performing the update, it invokes the renderer passed in the `renderer` property for each visible row.
-   *
-   * It is not guaranteed that the update happens immediately (synchronously) after it is requested.
-   */
-  requestContentUpdate() {
-    if (this.__virtualizer) {
-      this.__virtualizer.update();
-    }
-  }
 }
 
 defineCustomElement(VirtualList);

package/web-types.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://json.schemastore.org/web-types",
   "name": "@vaadin/virtual-list",
-  "version": "24.3.0-alpha10",
+  "version": "24.3.0-alpha11",
   "description-markup": "markdown",
   "contributions": {
     "html": {

package/web-types.lit.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://json.schemastore.org/web-types",
   "name": "@vaadin/virtual-list",
-  "version": "24.3.0-alpha10",
+  "version": "24.3.0-alpha11",
   "description-markup": "markdown",
   "framework": "lit",
   "framework-config": {