@vaadin/grid 25.2.7 → 25.3.0-alpha10

package/src/vaadin-grid-header-footer-rendering-mixin.js

@@ -0,0 +1,296 @@
+/**
+ * @license
+ * Copyright (c) 2016 - 2026 Vaadin Ltd.
+ * This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
+ */
+import { html, nothing, render } from 'lit';
+import { cache } from 'lit/directives/cache.js';
+import { classMap } from 'lit/directives/class-map.js';
+import { ifDefined } from 'lit/directives/if-defined.js';
+import { repeat } from 'lit/directives/repeat.js';
+import { styleMap } from 'lit/directives/style-map.js';
+import { microTask } from '@vaadin/component-base/src/async.js';
+import { Debouncer } from '@vaadin/component-base/src/debounce.js';
+import { partMap } from '@vaadin/component-base/src/directives/part-map.js';
+import { cellContent } from './directives/cell-content-directive.js';
+
+function isContentCell(column, level, columnTree) {
+  const isLastRow = level === columnTree.length - 1;
+  return isLastRow || column.localName === 'vaadin-grid-column-group';
+}
+
+function isHeaderRowVisible(columns, level, columnTree) {
+  return columns.some((column) => {
+    if (column.hidden || !isContentCell(column, level, columnTree)) {
+      return false;
+    }
+
+    if (column.headerRenderer) {
+      // The column has a header renderer -> row should be visible
+      return true;
+    }
+
+    if (column.header === null) {
+      // The column header is explicitly set to null -> doesn't block hiding the row
+      return false;
+    }
+
+    return column.path || column.header !== undefined;
+  });
+}
+
+function isFooterRowVisible(columns, level, columnTree) {
+  return columns.some((column) => {
+    if (column.hidden || !isContentCell(column, level, columnTree)) {
+      return false;
+    }
+
+    return column.footerRenderer;
+  });
+}
+
+/**
+ * Converts a whitespace separated list of custom part names
+ * into an object accepted by the `partMap` directive.
+ */
+function getCustomParts(partName) {
+  return Object.fromEntries(
+    (partName ?? '')
+      .split(' ')
+      .filter((name) => name !== '')
+      .map((name) => [name, true]),
+  );
+}
+
+/**
+ * A mixin providing rendering of header and footer rows based on the column tree.
+ */
+export const HeaderFooterRenderingMixin = (superClass) =>
+  class HeaderFooterRenderingMixin extends superClass {
+    /** @private */
+    __scheduleRenderHeaderFooter() {
+      this.__renderHeaderFooterDebouncer = Debouncer.debounce(this.__renderHeaderFooterDebouncer, microTask, () => {
+        this.__renderHeaderFooter();
+      });
+    }
+
+    /** @private */
+    __renderHeaderFooter() {
+      this.__renderHeaderFooterDebouncer?.cancel();
+
+      const sortedColumnTree = (this._columnTree ?? []).map((columns) => {
+        return columns.toSorted((a, b) => a._order - b._order);
+      });
+
+      sortedColumnTree.flat().forEach((column) => {
+        column._emptyCells = [];
+      });
+
+      this.#renderHeader(sortedColumnTree);
+      this.#renderFooter(sortedColumnTree);
+
+      this._resetKeyboardNavigation();
+      this.__a11yUpdateGridSize(this.size, this._columnTree, this.__emptyState);
+    }
+
+    #renderHeader(columnTree) {
+      const rows = this.#getRows(columnTree, 'header');
+      render(rows.map(this.#renderHeaderRow), this.$.header, { host: this });
+
+      this.$.table.toggleAttribute('has-header', !!this.$.header.querySelector('tr:not([hidden])'));
+
+      this.$.header.querySelectorAll('.header-cell').forEach((cell) => {
+        const column = cell._column;
+        const isColumnRow = cell.parentElement === this.$.header.lastElementChild;
+        if (isColumnRow || column.localName === 'vaadin-grid-column-group') {
+          column._headerCell = cell;
+        } else {
+          column._emptyCells.push(cell);
+        }
+      });
+    }
+
+    #renderHeaderRow = ({ level, cells, isLastRow, isFirstRow, isRowVisible }) => {
+      const rowParts = {
+        'first-header-row': isFirstRow,
+        'last-header-row': isLastRow,
+      };
+
+      return html`
+        <tr
+          role="row"
+          part="row header-row${partMap(rowParts)}"
+          class="row header-row${classMap(rowParts)}"
+          tabindex="-1"
+          ?hidden=${!isRowVisible}
+        >
+          ${repeat(
+            cells,
+            ({ column }) => column._id,
+            ({ column, isFirstCell, isLastCell, isContentCell }) => {
+              // `cache` keeps the cell and its rendered content when the
+              // column gets hidden, so it can be restored as-is when the
+              // column is shown again.
+              if (column.hidden) {
+                return cache(nothing);
+              }
+
+              const cellParts = {
+                'first-header-row-cell': isFirstRow,
+                'last-header-row-cell': isLastRow,
+                'first-column-cell': isFirstCell,
+                'last-column-cell': isLastCell,
+              };
+
+              const customCellParts = isContentCell ? getCustomParts(column.headerPartName) : {};
+
+              return cache(html`
+                <th
+                  role="columnheader"
+                  part="cell header-cell${partMap({ ...cellParts, ...customCellParts })}"
+                  class="cell header-cell${classMap(cellParts)}"
+                  style="${styleMap({
+                    width: column.width,
+                    'flex-grow': column.flexGrow,
+                  })}"
+                  ?first-column="${isFirstCell}"
+                  ?last-column="${isLastCell}"
+                  @keydown="${this.__onCellKeyDown}"
+                  @mousedown=${this.__onCellMouseDown}
+                  @mouseenter=${this.__onCellMouseEnter}
+                  @mouseleave=${this.__onCellMouseLeave}
+                  colspan="${ifDefined(column._colSpan)}"
+                  aria-colspan="${ifDefined(column._colSpan)}"
+                  tabindex="-1"
+                  ._column=${column}
+                >
+                  ${cellContent(this, `vaadin-grid-header-cell-content-${level}-${column._id}`, {
+                    textAlign: column.textAlign,
+                  })}
+                  ${column.resizable ? html`<div part="resize-handle" class="resize-handle"></div>` : nothing}
+                </th>
+              `);
+            },
+          )}
+        </tr>
+      `;
+    };
+
+    #renderFooter(columnTree) {
+      const rows = this.#getRows(columnTree, 'footer');
+      render(rows.map(this.#renderFooterRow), this.$.footer, { host: this });
+
+      this.$.table.toggleAttribute('has-footer', !!this.$.footer.querySelector('tr:not([hidden])'));
+
+      this.$.footer.querySelectorAll('.footer-cell').forEach((cell) => {
+        const column = cell._column;
+        const isColumnRow = cell.parentElement === this.$.footer.firstElementChild;
+        if (isColumnRow || column.localName === 'vaadin-grid-column-group') {
+          column._footerCell = cell;
+        } else {
+          column._emptyCells.push(cell);
+        }
+      });
+    }
+
+    #renderFooterRow = ({ level, cells, isLastRow, isFirstRow, isRowVisible }) => {
+      const rowParts = {
+        'first-footer-row': isFirstRow,
+        'last-footer-row': isLastRow,
+      };
+
+      return html`
+        <tr
+          role="row"
+          part="row footer-row${partMap(rowParts)}"
+          class="row footer-row${classMap(rowParts)}"
+          tabindex="-1"
+          ?hidden=${!isRowVisible}
+        >
+          ${repeat(
+            cells,
+            ({ column }) => column._id,
+            ({ column, isFirstCell, isLastCell, isContentCell }) => {
+              // `cache` keeps the cell and its rendered content when the
+              // column gets hidden, so it can be restored as-is when the
+              // column is shown again.
+              if (column.hidden) {
+                return cache(nothing);
+              }
+
+              const cellParts = {
+                'first-footer-row-cell': isFirstRow,
+                'last-footer-row-cell': isLastRow,
+                'first-column-cell': isFirstCell,
+                'last-column-cell': isLastCell,
+              };
+
+              const customCellParts = isContentCell ? getCustomParts(column.footerPartName) : {};
+
+              return cache(html`
+                <td
+                  role="gridcell"
+                  part="cell footer-cell${partMap({ ...cellParts, ...customCellParts })}"
+                  class="cell footer-cell${classMap(cellParts)}"
+                  style="${styleMap({
+                    width: column.width,
+                    'flex-grow': column.flexGrow,
+                  })}"
+                  ?first-column="${isFirstCell}"
+                  ?last-column="${isLastCell}"
+                  @keydown="${this.__onCellKeyDown}"
+                  @mousedown=${this.__onCellMouseDown}
+                  @mouseenter=${this.__onCellMouseEnter}
+                  @mouseleave=${this.__onCellMouseLeave}
+                  colspan="${ifDefined(column._colSpan)}"
+                  aria-colspan="${ifDefined(column._colSpan)}"
+                  tabindex="-1"
+                  ._column=${column}
+                >
+                  ${cellContent(this, `vaadin-grid-footer-cell-content-${level}-${column._id}`, {
+                    textAlign: column.textAlign,
+                  })}
+                </td>
+              `);
+            },
+          )}
+        </tr>
+      `;
+    };
+
+    #getRows(columnTree, section) {
+      let rows = columnTree.map((columns, level) => {
+        const visibleColumns = columns.filter((column) => !column.hidden);
+
+        return {
+          level,
+          cells: columns.map((column) => {
+            return {
+              column,
+              isFirstCell: column === visibleColumns.at(0),
+              isLastCell: column === visibleColumns.at(-1),
+              isContentCell: isContentCell(column, level, columnTree),
+            };
+          }),
+          isRowVisible:
+            section === 'header'
+              ? isHeaderRowVisible(columns, level, columnTree)
+              : isFooterRowVisible(columns, level, columnTree),
+        };
+      });
+
+      if (section === 'footer') {
+        rows = rows.toReversed();
+      }
+
+      const visibleRows = rows.filter((row) => row.isRowVisible);
+
+      return rows.map((row) => {
+        return {
+          ...row,
+          isFirstRow: row === visibleRows.at(0),
+          isLastRow: row === visibleRows.at(-1),
+        };
+      });
+    }
+  };

package/src/vaadin-grid-helpers.js

@@ -5,6 +5,19 @@
  */
 import { microTask } from '@vaadin/component-base/src/async.js';
 import { Debouncer } from '@vaadin/component-base/src/debounce.js';
+import { getClosestElement } from '@vaadin/component-base/src/dom-utils.js';
+
+/**
+ * Returns the grid cell that contains the given node, or `undefined` if the
+ * node is not inside a cell's content.
+ *
+ * @param {Node} node
+ * @return {HTMLElement | undefined}
+ */
+export function getClosestCell(node) {
+  const content = getClosestElement('vaadin-grid-cell-content', node);
+  return content?.assignedSlot?.parentElement;
+}
 
 /**
  * Returns the cells of the given row, excluding the details cell.

package/src/vaadin-grid-keyboard-navigation-mixin.js

@@ -154,9 +154,7 @@ export const KeyboardNavigationMixin = (superClass) =>
 
     /** @private */
     _focusableChanged(focusable, oldFocusable) {
-      if (oldFocusable) {
-        oldFocusable.setAttribute('tabindex', '-1');
-      }
+      oldFocusable?.setAttribute('tabindex', '-1');
       if (focusable) {
         this._updateGridSectionFocusTarget(focusable);
       }
@@ -415,9 +413,7 @@ export const KeyboardNavigationMixin = (superClass) =>
     _onRowNavigation(activeRow, dy) {
       const { dstRow } = this.__navigateRows(dy, activeRow);
 
-      if (dstRow) {
-        dstRow.focus();
-      }
+      dstRow?.focus();
     }
 
     /** @private */
@@ -765,7 +761,7 @@ export const KeyboardNavigationMixin = (superClass) =>
       // When clicking a cell with only text nodes, skip activating the cell
       // on click, since that is already handled on keydown.
       const cell = e.composedPath()[0];
-      const target = (cell._content && cell._content.firstElementChild) || cell;
+      const target = cell._content?.firstElementChild || cell;
       const wasNavigating = this.hasAttribute('navigating');
       const clickEvent = new MouseEvent('click', {
         shiftKey: e.shiftKey,