canvas-datagrid 0.26.0 → 0.27.1

package/CHANGELOG.md

@@ -7,6 +7,48 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## 0.27.1 - 2026-11-07
+
+### Fixed
+
+- The mouse wheel over a tree grid or cell grid that has reached the end of
+  its scroll range now scrolls the parent grid, and the wheel over a top-level
+  grid at the end of its range scrolls the page, the way nested scrolling
+  elements chain in HTML. 0.27.0 kept the wheel on the hovered grid even when
+  it had nothing left to scroll. The page no longer scrolls along while a tree
+  grid or cell grid is scrolling.
+- Documentation: cell grids are created only for columns whose schema `type`
+  is `canvas-datagrid`; an array value on its own does not create one. The
+  `data` property docs claimed it did, and the `cellGridAttributes` and
+  `header.type` docs did not mention the type. The `rendercellgrid` event
+  fires on every draw, not once per cell grid. The "Cell Grids" section now
+  has an example and there is a "Create a cell grid" tutorial.
+
+## 0.27.0 - 2026-11-07
+
+### Changed
+
+- **Breaking:** the default `auto` width and height now size the grid to the
+  element it is placed in. When the parent has a size of its own in a
+  dimension (a fixed height, a flex or grid track, the width of a block), the
+  grid fills it, leaving room for the parent's other content, and follows the
+  parent when it is resized. When the parent has no size of its own (a
+  content-sized height, a shrink-to-fit width) the grid grows to fit its rows
+  and columns as before, but no further than the viewport, and scrolls for the
+  rest. Grids that previously relied on `auto` to grow to their content now
+  fill their container and show scroll bars when the data is larger; set
+  `style.width`/`style.height` explicitly to keep a fixed size.
+- Tree grids and cell grids show scroll bars when their data overflows them,
+  whatever the parent grid's `width`/`height` style is.
+
+### Fixed
+
+- The mouse wheel over a tree grid scrolled the parent grid as well, and with
+  nested tree grids every ancestor scrolled. Only the grid under the pointer
+  scrolls now, even when it has nothing left to scroll in that direction. The
+  pointer over a tree grid no longer counts as hovering the parent's row, and
+  collapsing a tree grid removes its wheel listener from the parent.
+
 ## 0.26.0 - 2026-09-19
 
 Version note: the project restarted its numbering at 0.3.0 in 2021 while the

package/dist/canvas-datagrid.debug.js

@@ -1676,9 +1676,86 @@ __webpack_require__.r(__webpack_exports__);
     };
   };
   /**
-   * Watches the host element and its parent for size changes so a grid sized
-   * with auto/percentage dimensions follows layout changes (flex, splitters,
-   * tab switches) without an explicit `resize()` call (#289, #239).
+   * The element the grid sits in: the parent of the `canvas-datagrid` host
+   * element, or the host of the shadow tree the grid was placed in.
+   * @returns {HTMLElement|undefined}
+   */
+  self.getContainerElement = function () {
+    var host = self.intf && self.intf.nodeType === 1 ? self.intf : self.canvas,
+      container = host && host.parentNode;
+    if (container && container.nodeType === 11 && container.host) {
+      container = container.host;
+    }
+    return container && container.nodeType === 1 ? container : undefined;
+  };
+  /**
+   * Measures the room the container offers the grid in each dimension.
+   * A dimension is `undefined` when the container has no size of its own
+   * there, that is when it grows with the grid (an auto height block, a
+   * shrink-to-fit width); the caller then falls back to the content size.
+   *
+   * The probe makes the canvas one pixel larger than the container's client
+   * size and checks whether the container followed. When it did not, the
+   * overflow that the probe produced tells how much of the container is
+   * taken by padding and siblings. Everything is restored synchronously, so
+   * nothing is painted and no ResizeObserver notification results.
+   * @returns {{width: (number|undefined), height: (number|undefined)}}
+   */
+  self.measureContainerSpace = function () {
+    var space = {},
+      canvas = self.canvas,
+      container = self.getContainerElement(),
+      cache = self.containerSpaceCache,
+      canvasStyle,
+      saved;
+    if (!container || !canvas) {
+      return space;
+    }
+    if (cache && cache.container === container && cache.clientWidth === container.clientWidth && cache.clientHeight === container.clientHeight) {
+      return cache.space;
+    }
+    canvasStyle = canvas.style;
+    saved = {
+      width: canvasStyle.width,
+      height: canvasStyle.height
+    };
+    ['height', 'width'].forEach(function (dim) {
+      var client = dim === 'height' ? 'clientHeight' : 'clientWidth',
+        scroll = dim === 'height' ? 'scrollHeight' : 'scrollWidth',
+        before = container[client],
+        probe = before + 1,
+        after;
+      canvasStyle[dim] = probe + 'px';
+      after = container[client];
+      if (before === 0 || after > before) {
+        // nothing to measure (hidden or inline) or the container grew with
+        // the grid: it has no size of its own in this dimension
+        space[dim] = undefined;
+      } else {
+        // the container kept its size and the grid overflows it by at least
+        // one pixel; the overflow beyond that pixel is padding and siblings
+        space[dim] = Math.max(0, Math.min(after, 2 * after + 1 - container[scroll]));
+      }
+      canvasStyle[dim] = saved[dim];
+    });
+    // resize() may run several times in one frame (drags, style changes);
+    // the probe forces layout, so reuse the result while the container
+    // keeps its size
+    self.containerSpaceCache = {
+      container: container,
+      clientWidth: container.clientWidth,
+      clientHeight: container.clientHeight,
+      space: space
+    };
+    requestAnimationFrame(function () {
+      self.containerSpaceCache = undefined;
+    });
+    return space;
+  };
+  /**
+   * Watches the host element and its container for size changes so a grid
+   * sized with auto/percentage dimensions follows layout changes (flex,
+   * splitters, tab switches) without an explicit `resize()` call (#289, #239).
    * Falls back to the `window` resize listener when ResizeObserver is missing.
    */
   self.initResizeObserver = function () {
@@ -1720,7 +1797,7 @@ __webpack_require__.r(__webpack_exports__);
     self.resizeObserver.disconnect();
     self.observedSizes = new Map();
     var host = self.intf && self.intf.nodeType === 1 ? self.intf : self.canvas;
-    [host, host && host.parentNode].forEach(function (target) {
+    [host, self.getContainerElement()].forEach(function (target) {
       if (target && target.nodeType === 1) {
         self.resizeObserver.observe(target);
       }
@@ -3870,15 +3947,31 @@ __webpack_require__.r(__webpack_exports__);
           treeGrid.parentNode.columnGroupsAreaHeight += columnGroupsAreaHeight || 0;
           treeGrid.parentNode.rowGroupsAreaWidth += rowGroupsAreaWidth || 0;
         }
+        // Hit-test entry for the child grid's area. Like every other visible
+        // cell it is in this grid's own coordinates (the child's offsetTop and
+        // offsetLeft are canvas coordinates) and carries the real tree size:
+        // `treeGrid.height`/`width` are undefined on child grids, which made
+        // this entry unmatchable, so a pointer over a tree grid still counted
+        // as hovering the parent and the parent scrolled along with the tree.
         self.visibleCells.unshift({
           rowIndex: rowOrderIndex,
           columnIndex: 0,
-          y: treeGrid.parentNode.offsetTop,
-          x: treeGrid.parentNode.offsetLeft,
-          height: treeGrid.height,
-          width: treeGrid.width,
+          y: y + rowSansTreeHeight,
+          x: rowHeaderCellWidth - 1,
+          height: treeHeight,
+          width: treeGrid.parentNode.offsetWidth,
           style: 'tree-grid',
-          type: treeGrid.parentNode.nodeType
+          type: treeGrid.parentNode.nodeType,
+          data: rowData,
+          header: {},
+          isGrid: false,
+          isNormal: false,
+          isHeader: false,
+          isCorner: false,
+          isRowHeader: false,
+          isColumnHeader: false,
+          selected: false,
+          hovered: false
         });
         treeGrid.draw();
       } else if (treeGrid) {
@@ -4950,21 +5043,35 @@ __webpack_require__.r(__webpack_exports__);
       rowHeaderCellWidth = self.getRowHeaderCellWidth(),
       topGroupAreaHeight = self.getColumnGroupAreaHeight(),
       leftGroupAreaWidth = self.getRowGroupAreaWidth(),
-      ch = self.style.cellHeight;
-    // sets actual DOM canvas element
+      ch = self.style.cellHeight,
+      containerSpace = self.isChildGrid ? {} : self.measureContainerSpace();
+    function isAutoSize(value) {
+      return value === undefined || value === 'auto' || value === '';
+    }
     function checkScrollBoxVisibility() {
-      var capped = self.autoSizeCapped || {};
-      self.scrollBox.horizontalBarVisible = (self.style.width !== 'auto' || capped.width) && dataWidth > self.scrollBox.width && self.style.overflowX !== 'hidden' || self.style.overflowX === 'scroll';
+      // an auto-sized grid shows a scroll bar only when it could not grow to
+      // its content (container, viewport or canvas limit); a child grid is
+      // always bounded by the tree row or cell that holds it
+      var constrained = self.autoSizeConstrained || {};
+      self.scrollBox.horizontalBarVisible = (!isAutoSize(self.style.width) || constrained.width) && dataWidth > self.scrollBox.width && self.style.overflowX !== 'hidden' || self.style.overflowX === 'scroll';
       self.scrollBox.horizontalBoxVisible = dataWidth > self.scrollBox.width;
-      self.scrollBox.verticalBarVisible = (self.style.height !== 'auto' || capped.height) && dataHeight > self.scrollBox.height && self.style.overflowY !== 'hidden' || self.style.overflowY === 'scroll';
+      self.scrollBox.verticalBarVisible = (!isAutoSize(self.style.height) || constrained.height) && dataHeight > self.scrollBox.height && self.style.overflowY !== 'hidden' || self.style.overflowY === 'scroll';
       self.scrollBox.verticalBoxVisible = dataHeight > self.scrollBox.height;
     }
     function setScrollBoxSize() {
       self.scrollBox.width = self.width - rowHeaderCellWidth - leftGroupAreaWidth;
       self.scrollBox.height = self.height - columnHeaderCellHeight - topGroupAreaHeight;
     }
+    // sizes the DOM canvas element and reads back the size the grid got
     function setCanvasSize() {
       if (self.isChildGrid) {
+        // a child grid fills the tree row or cell that holds it
+        self.autoSizeConstrained = {
+          width: true,
+          height: true
+        };
+        self.width = self.parentNode.offsetWidth;
+        self.height = self.parentNode.offsetHeight;
         return;
       }
       dims = {
@@ -4972,31 +5079,39 @@ __webpack_require__.r(__webpack_exports__);
         height: columnHeaderCellHeight + topGroupAreaHeight + dataHeight + cellBorder + 1,
         width: dataWidth + rowHeaderCellWidth + cellBorder + leftGroupAreaWidth
       };
-      // Browsers refuse to paint canvases beyond roughly 16k px per side, so
-      // an auto-sized grid with enough rows went blank past that point
-      // (#254). Cap the element and let it scroll for the remainder.
       var maxCanvasSize = self.attributes.maxCanvasSize;
-      self.autoSizeCapped = {
+      self.autoSizeConstrained = {
         width: false,
         height: false
       };
       ['width', 'height'].forEach(function (dim) {
-        if (dims[dim] > maxCanvasSize) {
-          dims[dim] = maxCanvasSize;
-          self.autoSizeCapped[dim] = true;
-        }
-      });
-      ['width', 'height'].forEach(function (dim) {
+        var styleIsAuto = isAutoSize(self.style[dim]),
+          inlineIsAuto = isAutoSize(self.appliedInlineStyles[dim]),
+          size;
         //TODO: support inherit
-        if (['auto', undefined].indexOf(self.style[dim]) !== -1 && ['auto', undefined].indexOf(self.appliedInlineStyles[dim]) !== -1) {
-          self.parentNodeStyle[dim] = dims[dim] + 'px';
-        } else if (['auto', undefined].indexOf(self.style[dim]) == -1 && ['auto', undefined].indexOf(self.appliedInlineStyles[dim]) == -1) {
-          self.parentNodeStyle[dim] = self.style[dim];
-          if (self.isComponent) {
-            self.canvas.style[dim] = self.style[dim];
+        if (styleIsAuto && inlineIsAuto) {
+          // No explicit size: fill the container when it has a size of its
+          // own in this dimension, otherwise fit the content but never grow
+          // past the viewport. Browsers also refuse to paint canvases beyond
+          // roughly 16k px per side (#254), so cap the element there too and
+          // let the grid scroll for the remainder.
+          size = dims[dim];
+          if (containerSpace[dim] !== undefined) {
+            size = containerSpace[dim];
+          } else {
+            size = Math.min(size, dim === 'height' ? window.innerHeight : window.innerWidth);
           }
+          size = Math.max(0, Math.min(size, maxCanvasSize));
+          self.autoSizeConstrained[dim] = size < dims[dim];
+          self.parentNodeStyle[dim] = size + 'px';
+        } else if (!styleIsAuto && !inlineIsAuto) {
+          self.parentNodeStyle[dim] = self.style[dim];
         }
       });
+      self.width = self.canvas.offsetWidth;
+      self.height = self.canvas.offsetHeight;
+      self.canvasOffsetLeft = self.args.canvasOffsetLeft || 0;
+      self.canvasOffsetTop = self.args.canvasOffsetTop || 0;
     }
     self.autoLastColumnWidth = undefined;
     dataWidth = self.refreshScrollCacheX();
@@ -5017,15 +5132,6 @@ __webpack_require__.r(__webpack_exports__);
       dataHeight += self.style.cellHeight;
     }
     setCanvasSize();
-    if (self.isChildGrid) {
-      self.width = self.parentNode.offsetWidth;
-      self.height = self.parentNode.offsetHeight;
-    } else if (self.height !== self.canvas.offsetHeight || self.width !== self.canvas.offsetWidth) {
-      self.height = self.canvas.offsetHeight;
-      self.width = self.canvas.offsetWidth;
-      self.canvasOffsetLeft = self.args.canvasOffsetLeft || 0;
-      self.canvasOffsetTop = self.args.canvasOffsetTop || 0;
-    }
     /// calculate scroll bar dimensions
     // non-controversial
     self.scrollBox.top = columnHeaderCellHeight + topGroupAreaHeight + columnHeaderCellBorder;
@@ -5037,18 +5143,12 @@ __webpack_require__.r(__webpack_exports__);
     // if the scroll box is visible, make room for it by expanding the size of the element
     // if the other dimension is set to auto
     if (self.scrollBox.horizontalBarVisible) {
-      if (self.style.height === 'auto' && !self.isChildGrid) {
-        self.height += sbw;
-      }
       dataHeight += sbw;
       setCanvasSize();
       setScrollBoxSize();
       checkScrollBoxVisibility();
     }
     if (self.scrollBox.verticalBarVisible) {
-      if (self.style.width === 'auto' && !self.isChildGrid) {
-        self.width += sbw;
-      }
       dataWidth += sbw;
       setCanvasSize();
       setScrollBoxSize();
@@ -6288,37 +6388,74 @@ __webpack_require__.r(__webpack_exports__);
     var l,
       t,
       ev = e,
+      childEvent,
       deltaX = e.deltaX === undefined ? e.NativeEvent.deltaX : e.deltaX,
       deltaY = e.deltaY === undefined ? e.NativeEvent.deltaY : e.deltaY,
       deltaMode = e.deltaMode === undefined ? e.NativeEvent.deltaMode : e.deltaMode;
     if (e.NativeEvent) e = e.NativeEvent;
+    if (self.disposed) {
+      return;
+    }
+    //BUG Issue 42: https://github.com/TonyGermaneri/canvas-datagrid/issues/42
+    //https://stackoverflow.com/questions/20110224/what-is-the-height-of-a-line-in-a-wheel-event-deltamode-dom-delta-line
+    if (deltaMode === 1) {
+      // line mode = 17 pixels per line
+      deltaY = deltaY * 17;
+    }
+    // A child grid receives the wheel through its parent's `wheel` grid
+    // event (`ev`), not from the DOM. It leaves two marks on that event for
+    // its ancestors: `hovered` says the pointer is over this grid or one of
+    // its descendants, so the ancestor is not the hovered grid itself;
+    // `claim` says this grid consumed the wheel, so no ancestor scrolls and
+    // neither does the page. A hovered grid with nothing left to scroll in
+    // the wheel's direction only marks itself hovered, so the wheel moves on
+    // to the parent grid, and from the top-level grid to the page, the way
+    // nested scrolling elements chain in HTML.
+    function hovered() {
+      if (ev !== e) {
+        ev.hoveredChildGrid = true;
+      }
+    }
+    function claim() {
+      e.preventDefault();
+      if (ev !== e) {
+        ev.claimedByChildGrid = true;
+        ev.preventDefault();
+      }
+    }
+    function canScroll() {
+      var box = self.scrollBox;
+      return box.scrollTop < box.scrollHeight && deltaY > 0 || box.scrollLeft < box.scrollWidth && deltaX > 0 || box.scrollTop > 0 && deltaY < 0 || box.scrollLeft > 0 && deltaX < 0;
+    }
     if (wheeling) {
-      ev.preventDefault(e);
+      // still applying the previous wheel, this one belongs here too
+      claim();
       return;
     }
-    if (self.dispatchEvent('wheel', {
+    childEvent = {
       NativeEvent: e
-    })) {
+    };
+    if (self.dispatchEvent('wheel', childEvent)) {
+      if (childEvent.claimedByChildGrid) {
+        claim();
+      }
       return;
     }
     self.touchHaltAnimation = true;
+    if (!self.hasFocus && !childEvent.hoveredChildGrid) {
+      return;
+    }
+    hovered();
+    if (!canScroll()) {
+      return;
+    }
+    claim();
     l = self.scrollBox.scrollLeft;
     t = self.scrollBox.scrollTop;
-    if (self.hasFocus) {
-      //BUG Issue 42: https://github.com/TonyGermaneri/canvas-datagrid/issues/42
-      //https://stackoverflow.com/questions/20110224/what-is-the-height-of-a-line-in-a-wheel-event-deltamode-dom-delta-line
-      if (deltaMode === 1) {
-        // line mode = 17 pixels per line
-        deltaY = deltaY * 17;
-      }
-      if (self.scrollBox.scrollTop < self.scrollBox.scrollHeight && deltaY > 0 || self.scrollBox.scrollLeft < self.scrollBox.scrollWidth && deltaX > 0 || self.scrollBox.scrollTop > 0 && deltaY < 0 || self.scrollBox.scrollLeft > 0 && deltaX < 0) {
-        ev.preventDefault(e);
-      }
-      wheeling = setTimeout(function () {
-        wheeling = undefined;
-        self.scrollBox.scrollTo(deltaX + l, deltaY + t);
-      }, 1);
-    }
+    wheeling = setTimeout(function () {
+      wheeling = undefined;
+      self.scrollBox.scrollTo(deltaX + l, deltaY + t);
+    }, 1);
   };
   self.pasteData = function (pasteValue, mimeType, startRowIndex, startColIndex, minRowsLength = 0, minColumnsLength = 0) {
     if (mimeType === 'text/html' && !(0,_util__WEBPACK_IMPORTED_MODULE_1__.isSupportedHtml)(pasteValue)) {
@@ -7620,7 +7757,8 @@ __webpack_require__.r(__webpack_exports__);
     self.eventParent.removeEventListener('dblclick', self.dblclick, false);
     self.eventParent.removeEventListener('click', self.click, false);
     self.eventParent.removeEventListener('mousemove', self.mousemove);
-    self.eventParent.removeEventListener('wheel', self.scrollWheel, false);
+    // child grids listen for the wheel on the parent grid's event, not the DOM
+    self[self.isChildGrid ? 'parentGrid' : 'eventParent'].removeEventListener('wheel', self.scrollWheel, false);
     self.canvas.removeEventListener('contextmenu', self.contextmenuEvent, false);
     self.canvas.removeEventListener('copy', self.copy);
     self.controlInput.removeEventListener('copy', self.copy);