@vaadin/virtual-list 24.7.0-alpha1 → 24.7.0-alpha2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vaadin/virtual-list",
-  "version": "24.7.0-alpha1",
+  "version": "24.7.0-alpha2",
   "publishConfig": {
     "access": "public"
   },
@@ -39,15 +39,15 @@
   "dependencies": {
     "@open-wc/dedupe-mixin": "^1.3.0",
     "@polymer/polymer": "^3.0.0",
-    "@vaadin/component-base": "24.7.0-alpha1",
-    "@vaadin/lit-renderer": "24.7.0-alpha1",
-    "@vaadin/vaadin-lumo-styles": "24.7.0-alpha1",
-    "@vaadin/vaadin-material-styles": "24.7.0-alpha1",
-    "@vaadin/vaadin-themable-mixin": "24.7.0-alpha1",
+    "@vaadin/component-base": "24.7.0-alpha2",
+    "@vaadin/lit-renderer": "24.7.0-alpha2",
+    "@vaadin/vaadin-lumo-styles": "24.7.0-alpha2",
+    "@vaadin/vaadin-material-styles": "24.7.0-alpha2",
+    "@vaadin/vaadin-themable-mixin": "24.7.0-alpha2",
     "lit": "^3.0.0"
   },
   "devDependencies": {
-    "@vaadin/chai-plugins": "24.7.0-alpha1",
+    "@vaadin/chai-plugins": "24.7.0-alpha2",
     "@vaadin/testing-helpers": "^1.0.0",
     "sinon": "^18.0.0"
   },
@@ -55,5 +55,5 @@
     "web-types.json",
     "web-types.lit.json"
   ],
-  "gitHead": "04be941c9a7b659871c97f31b9cc3ffd7528087b"
+  "gitHead": "e2523f9b4abc5a9586fb758166f823dc40c399dd"
 }

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

@@ -53,6 +53,15 @@ export declare class VirtualListMixinClass<TItem = VirtualListDefaultItem> {
    */
   items: TItem[] | undefined;
 
+  /**
+   * A function that generates accessible names for virtual list items.
+   * The function gets the item as an argument and the
+   * return value should be a string representing that item. The
+   * result gets applied to the corresponding virtual list child element
+   * as an `aria-label` attribute.
+   */
+  itemAccessibleNameGenerator?: (item: TItem) => string;
+
   /**
    * Scroll to a specific index in the virtual list.
    */

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

@@ -36,13 +36,25 @@ export const VirtualListMixin = (superClass) =>
          */
         renderer: { type: Function, sync: true },
 
+        /**
+         * A function that generates accessible names for virtual list items.
+         * The function gets the item as an argument and the
+         * return value should be a string representing that item. The
+         * result gets applied to the corresponding virtual list child element
+         * as an `aria-label` attribute.
+         */
+        itemAccessibleNameGenerator: {
+          type: Function,
+          sync: true,
+        },
+
         /** @private */
         __virtualizer: Object,
       };
     }
 
     static get observers() {
-      return ['__itemsOrRendererChanged(items, renderer, __virtualizer)'];
+      return ['__itemsOrRendererChanged(items, renderer, __virtualizer, itemAccessibleNameGenerator)'];
     }
 
     /**
@@ -65,7 +77,7 @@ export const VirtualListMixin = (superClass) =>
 
     constructor() {
       super();
-      this.__onDragStart = this.__onDragStart.bind(this);
+      this.__onDocumentDragStart = this.__onDocumentDragStart.bind(this);
     }
 
     /** @protected */
@@ -84,22 +96,19 @@ export const VirtualListMixin = (superClass) =>
       this.addController(this.__overflowController);
 
       processTemplates(this);
+      this.__updateAria();
     }
 
     /** @protected */
     connectedCallback() {
       super.connectedCallback();
-      // Chromium based browsers cannot properly generate drag images for elements
-      // that have children with massive heights. This workaround prevents crashes
-      // and performance issues by excluding the items from the drag image.
-      // https://github.com/vaadin/web-components/issues/7985
-      document.addEventListener('dragstart', this.__onDragStart, { capture: true });
+      document.addEventListener('dragstart', this.__onDocumentDragStart, { capture: true });
     }
 
     /** @protected */
     disconnectedCallback() {
       super.disconnectedCallback();
-      document.removeEventListener('dragstart', this.__onDragStart, { capture: true });
+      document.removeEventListener('dragstart', this.__onDocumentDragStart, { capture: true });
     }
 
     /**
@@ -116,18 +125,34 @@ export const VirtualListMixin = (superClass) =>
       return [...Array(count)].map(() => document.createElement('div'));
     }
 
+    /** @private */
+    __updateAria() {
+      this.role = 'list';
+    }
+
     /** @private */
     __updateElement(el, index) {
+      const item = this.items[index];
+      el.ariaSetSize = String(this.items.length);
+      el.ariaPosInSet = String(index + 1);
+      el.ariaLabel = this.itemAccessibleNameGenerator ? this.itemAccessibleNameGenerator(item) : null;
+      this.__updateElementRole(el);
+
       if (el.__renderer !== this.renderer) {
         el.__renderer = this.renderer;
         this.__clearRenderTargetContent(el);
       }
 
       if (this.renderer) {
-        this.renderer(el, this, { item: this.items[index], index });
+        this.renderer(el, this, { item, index });
       }
     }
 
+    /** @private */
+    __updateElementRole(el) {
+      el.role = 'listitem';
+    }
+
     /**
      * Clears the content of a render target.
      * @private
@@ -153,25 +178,24 @@ export const VirtualListMixin = (superClass) =>
       }
     }
 
-    /** @private */
-    __onDragStart(e) {
-      // The dragged element can be the element itself or a parent of the element
-      if (!e.target.contains(this)) {
-        return;
-      }
-      // The threshold value 20000 provides a buffer to both
-      //   - avoid the crash and the performance issues
-      //   - unnecessarily avoid excluding items from the drag image
-      if (this.$.items.offsetHeight > 20000) {
-        const initialItemsMaxHeight = this.$.items.style.maxHeight;
-        const initialVirtualListOverflow = this.style.overflow;
-        // Momentarily hides the items until the browser starts generating the
-        // drag image.
-        this.$.items.style.maxHeight = '0';
-        this.style.overflow = 'hidden';
+    /**
+     * Webkit-based browsers have issues with generating drag images
+     * for elements that have children with massive heights. Chromium
+     * browsers crash, while Safari experiences significant performance
+     * issues. To mitigate these issues, we hide the items container
+     * when drag starts to remove it from the drag image.
+     *
+     * Related issues:
+     * - https://github.com/vaadin/web-components/issues/7985
+     * - https://issues.chromium.org/issues/383356871
+     *
+     * @private
+     */
+    __onDocumentDragStart(e) {
+      if (e.target.contains(this) && this.scrollHeight > 20000) {
+        this.$.items.style.display = 'none';
         requestAnimationFrame(() => {
-          this.$.items.style.maxHeight = initialItemsMaxHeight;
-          this.style.overflow = initialVirtualListOverflow;
+          this.$.items.style.display = '';
         });
       }
     }

package/web-types.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://json.schemastore.org/web-types",
   "name": "@vaadin/virtual-list",
-  "version": "24.7.0-alpha1",
+  "version": "24.7.0-alpha2",
   "description-markup": "markdown",
   "contributions": {
     "html": {
@@ -43,6 +43,17 @@
                     "undefined"
                   ]
                 }
+              },
+              {
+                "name": "itemAccessibleNameGenerator",
+                "description": "A function that generates accessible names for virtual list items.\nThe function gets the item as an argument and the\nreturn value should be a string representing that item. The\nresult gets applied to the corresponding virtual list child element\nas an `aria-label` attribute.",
+                "value": {
+                  "type": [
+                    "Function",
+                    "null",
+                    "undefined"
+                  ]
+                }
               }
             ],
             "events": []

package/web-types.lit.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://json.schemastore.org/web-types",
   "name": "@vaadin/virtual-list",
-  "version": "24.7.0-alpha1",
+  "version": "24.7.0-alpha2",
   "description-markup": "markdown",
   "framework": "lit",
   "framework-config": {
@@ -32,6 +32,13 @@
               "value": {
                 "kind": "expression"
               }
+            },
+            {
+              "name": ".itemAccessibleNameGenerator",
+              "description": "A function that generates accessible names for virtual list items.\nThe function gets the item as an argument and the\nreturn value should be a string representing that item. The\nresult gets applied to the corresponding virtual list child element\nas an `aria-label` attribute.",
+              "value": {
+                "kind": "expression"
+              }
             }
           ]
         }