@linzjs/step-ag-grid 29.2.4 → 29.3.0

package/dist/step-ag-grid.esm.js

@@ -2,7 +2,7 @@ import { jsx, jsxs, Fragment } from 'react/jsx-runtime';
 import { LuiMiniSpinner, LuiStatusSpinner, LuiIcon, LuiButtonGroup, LuiButton, LuiCheckboxInput } from '@linzjs/lui';
 import { ModuleRegistry, AllCommunityModule } from 'ag-grid-community';
 import { AgGridReact } from 'ag-grid-react';
-import { negate, isEmpty, findIndex, defer, debounce as debounce$1, sum, xorBy, last, difference, omit, sortBy, delay, partition, compact, pick, groupBy, fromPairs, toPairs, isEqual, pull, filter, sumBy, remove, flatten, castArray } from 'lodash-es';
+import { negate, isEmpty, findIndex, defer, debounce as debounce$1, xorBy, last, difference, omit, sortBy, delay, partition, compact, pick, groupBy, fromPairs, toPairs, isEqual, pull, filter, sumBy, remove, flatten, castArray } from 'lodash-es';
 import React, { useRef, useLayoutEffect, useEffect, createContext, useContext, useState, useMemo, memo, forwardRef, useCallback, useReducer, cloneElement, useImperativeHandle, Fragment as Fragment$1, useId } from 'react';
 import { unstable_batchedUpdates, flushSync, createPortal } from 'react-dom';
 
@@ -2777,6 +2777,8 @@ const Grid = ({ 'data-testid': dataTestId, defaultPostSort = true, rowSelection
     const hasSetContentSizeEmpty = useRef(false);
     const needsAutoSize = useRef(true);
     const lastFullResize = useRef();
+    const autoSizeResultRef = useRef(null);
+    const prevRowsVisibleRef = useRef(false);
     const setInitialContentSize = useCallback(() => {
         if (!gridDivRef.current?.clientWidth || rowData == null) {
             // Don't resize grids if they are offscreen as it doesn't work.
@@ -2789,37 +2791,50 @@ const Grid = ({ 'data-testid': dataTestId, defaultPostSort = true, rowSelection
             needsAutoSize.current = true;
             return;
         }
-        const skipHeader = sizeColumns === 'auto-skip-headers' && gridRendered === 'rows-visible';
-        if (sizeColumns === 'auto' || skipHeader) {
-            const result = autoSizeColumns({
-                skipHeader,
-                userSizedColIds: new Set(userSizedColIds.current.keys()),
-                includeFlex: true,
-            });
-            if (!result) {
+        // 1. First we autosize to get the size of the columns on an infinite grid.
+        if (sizeColumns === 'auto' || sizeColumns === 'auto-skip-headers') {
+            // You can't skip headers until the grid has content
+            const rowsVisible = gridRendered === 'rows-visible';
+            const skipHeader = sizeColumns === 'auto-skip-headers' && rowsVisible;
+            // If grid was empty and now has content we need to autosize
+            if (rowsVisible !== prevRowsVisibleRef.current && rowsVisible) {
+                prevRowsVisibleRef.current = rowsVisible;
+                autoSizeResultRef.current = null;
+            }
+            const autoSizeResult = autoSizeResultRef.current ??
+                autoSizeColumns({
+                    skipHeader,
+                    userSizedColIds: new Set(userSizedColIds.current.keys()),
+                });
+            // Auto-size failed retry later
+            if (!autoSizeResult) {
                 needsAutoSize.current = true;
                 return;
             }
-            // Default max intial width is 256x initial visible column count, max of 80% window width
-            const maxWidth = maxInitialWidth ||
-                sum(params.columnDefs.map((c) => (!c.hide ? c.maxInitialWidth || 128 : 0)));
-            result.width = Math.min(result.width, maxWidth);
+            autoSizeResultRef.current = autoSizeResult;
+            // Calculate the auto-sized width, limit it to maxInitialWidth
+            autoSizeResult.width = maxInitialWidth ? Math.min(autoSizeResult.width, maxInitialWidth) : autoSizeResult.width;
             if (gridRendered === 'empty') {
+                // If the grid is empty we still do an onContentSize callback, we will do another callback when grid has data
+                // We don't do this callback if we have previously had row data, or have already called back for empty
                 if (!hasSetContentSizeEmpty.current && !hasSetContentSize.current) {
                     hasSetContentSizeEmpty.current = true;
-                    params.onContentSize?.(result);
+                    params.onContentSize?.(autoSizeResult);
                 }
             }
             else if (gridRendered === 'rows-visible') {
+                // we have rows now so callback grid size
                 if (!hasSetContentSize.current) {
-                    if (lastFullResize.current === result.width) {
+                    // Only callback if grid size has settled
+                    if (lastFullResize.current === autoSizeResult.width) {
                         hasSetContentSize.current = true;
-                        params.onContentSize?.(result);
+                        params.onContentSize?.(autoSizeResult);
                     }
                     else {
-                        needsAutoSize.current = true;
+                        // Need to retry callback when size has settelled
+                        lastFullResize.current = autoSizeResult.width;
+                        return;
                     }
-                    lastFullResize.current = result.width;
                 }
             }
             else {
@@ -2827,6 +2842,7 @@ const Grid = ({ 'data-testid': dataTestId, defaultPostSort = true, rowSelection
                 console.error('Unknown value returned from hasGridRendered');
             }
         }
+        // 2. Now we size columns to fit the grid width
         if (sizeColumns !== 'none') {
             sizeColumnsToFit();
         }
@@ -2984,6 +3000,8 @@ const Grid = ({ 'data-testid': dataTestId, defaultPostSort = true, rowSelection
     const onRowDataChanged = useCallback(() => {
         const length = rowData?.length ?? 0;
         if (previousRowDataLength.current !== length) {
+            // We need to autosize all cells again
+            autoSizeResultRef.current = null;
             setInitialContentSize();
             previousRowDataLength.current = length;
         }
@@ -3126,12 +3144,15 @@ const Grid = ({ 'data-testid': dataTestId, defaultPostSort = true, rowSelection
     /**
      * Resize columns to fit if required on window/container resize
      */
-    const onGridSizeChanged = useCallback((event) => {
+    const onGridResize = useCallback((event) => {
         if (sizeColumns !== 'none') {
+            // Flex columns can expand to fit after resize, but they cannot shrink less than use resized value
+            // Double click column resize handle to reset this behaviour
             const columnLimits = [
                 ...userSizedColIds.current.entries().map(([c, w]) => ({
                     key: c,
                     minWidth: w,
+                    maxWidth: w,
                 })),
             ];
             event.api.sizeColumnsToFit({ columnLimits });
@@ -3156,12 +3177,17 @@ const Grid = ({ 'data-testid': dataTestId, defaultPostSort = true, rowSelection
         switch (e.source) {
             case 'uiColumnResized':
                 userSizedColIds.current.set(colId, width);
+                const colDef = e.column?.getColDef();
+                if (!colDef?.flex) {
+                    onGridResize(e);
+                }
                 break;
             case 'autosizeColumns':
                 userSizedColIds.current.delete(colId);
+                onGridResize(e);
                 break;
         }
-    }, []);
+    }, [onGridResize]);
     const gridContextMenu = useGridContextMenu({ contextMenu: params.contextMenu, contextMenuSelectRow });
     const startDragYRef = useRef(null);
     const clearHighlightRowClasses = useCallback(() => {
@@ -3258,6 +3284,7 @@ const Grid = ({ 'data-testid': dataTestId, defaultPostSort = true, rowSelection
         return (jsx(GridNoRowsOverlay, { loading: !rowData || params.loading === true, rowCount: rowCount, headerRowHeight: headerRowCount * rowHeight, filteredRowCount: event.api.getDisplayedRowCount(), noRowsOverlayText: params.noRowsOverlayText, noRowsMatchingOverlayText: params.noRowsMatchingOverlayText }));
     }, [columnDefs, params.loading, params.noRowsMatchingOverlayText, params.noRowsOverlayText, rowData, rowHeight]);
     const selectionColumnDef = useMemo(() => {
+        // Note this has to be 1 for hidden otherwise ag-grid does crazy things whilst resizing
         const selectWidth = params.hideSelectColumn ? 0 : selectable && params.onRowDragEnd ? 76 : 48;
         return {
             suppressNavigable: params.hideSelectColumn,
@@ -3303,7 +3330,7 @@ const Grid = ({ 'data-testid': dataTestId, defaultPostSort = true, rowSelection
                             enableClickSelection: params.enableClickSelection ?? false,
                             mode: rowSelection == 'single' ? 'singleRow' : 'multiRow',
                         }
-                        : undefined, rowHeight: rowHeight, animateRows: params.animateRows ?? false, rowClassRules: params.rowClassRules, getRowId: getRowId, onGridSizeChanged: onGridSizeChanged, suppressColumnVirtualisation: suppressColumnVirtualization, suppressClickEdit: true, onColumnVisible: setInitialContentSize, onRowDataUpdated: onRowDataChanged, onCellFocused: onCellFocused, onCellKeyDown: onCellKeyPress, onCellClicked: onCellClicked, onCellDoubleClicked: onCellDoubleClick, domLayout: params.domLayout, onColumnResized: onColumnResized, defaultColDef: defaultColDef, columnDefs: columnDefsAdjusted, selectionColumnDef: selectionColumnDef, rowData: rowData, postSortRows: params.onRowDragEnd || !defaultPostSort ? undefined : postSortRows, onModelUpdated: onModelUpdated, onGridReady: onGridReady, onSortChanged: ensureSelectedRowIsVisible, quickFilterParser: quickFilterParser, onSelectionChanged: synchroniseExternalStateToGridSelection, onColumnMoved: params.onColumnMoved, noRowsOverlayComponent: noRowsOverlayComponent, alwaysShowVerticalScroll: params.alwaysShowVerticalScroll, isExternalFilterPresent: isExternalFilterPresent, doesExternalFilterPass: doesExternalFilterPass, maintainColumnOrder: true, preventDefaultOnContextMenu: true, onCellContextMenu: gridContextMenu.cellContextMenu, rowDragText: params.rowDragText, onRowDragCancel: clearHighlightRowClasses, onRowDragMove: onRowDragMove, onRowDragEnd: onRowDragEnd, suppressCellFocus: params.suppressCellFocus, pinnedTopRowData: params.pinnedTopRowData, pinnedBottomRowData: params.pinnedBottomRowData, onRowClicked: params.onRowClicked, onRowDoubleClicked: params.onRowDoubleClicked, suppressStartEditOnTab: true }) })] }));
+                        : undefined, rowHeight: rowHeight, animateRows: params.animateRows ?? false, rowClassRules: params.rowClassRules, getRowId: getRowId, onGridSizeChanged: onGridResize, suppressColumnVirtualisation: suppressColumnVirtualization, suppressClickEdit: true, onColumnVisible: setInitialContentSize, onRowDataUpdated: onRowDataChanged, onCellFocused: onCellFocused, onCellKeyDown: onCellKeyPress, onCellClicked: onCellClicked, onCellDoubleClicked: onCellDoubleClick, domLayout: params.domLayout, onColumnResized: onColumnResized, defaultColDef: defaultColDef, columnDefs: columnDefsAdjusted, selectionColumnDef: selectionColumnDef, rowData: rowData, postSortRows: params.onRowDragEnd || !defaultPostSort ? undefined : postSortRows, onModelUpdated: onModelUpdated, onGridReady: onGridReady, onSortChanged: ensureSelectedRowIsVisible, quickFilterParser: quickFilterParser, onSelectionChanged: synchroniseExternalStateToGridSelection, onColumnMoved: params.onColumnMoved, noRowsOverlayComponent: noRowsOverlayComponent, alwaysShowVerticalScroll: params.alwaysShowVerticalScroll, isExternalFilterPresent: isExternalFilterPresent, doesExternalFilterPass: doesExternalFilterPass, maintainColumnOrder: true, preventDefaultOnContextMenu: true, onCellContextMenu: gridContextMenu.cellContextMenu, rowDragText: params.rowDragText, onRowDragCancel: clearHighlightRowClasses, onRowDragMove: onRowDragMove, onRowDragEnd: onRowDragEnd, suppressCellFocus: params.suppressCellFocus, pinnedTopRowData: params.pinnedTopRowData, pinnedBottomRowData: params.pinnedBottomRowData, onRowClicked: params.onRowClicked, onRowDoubleClicked: params.onRowDoubleClicked, suppressStartEditOnTab: true }) })] }));
 };
 const quickFilterParser = (filterStr) => {
     // filter is exact matches exactly groups separated by commas
@@ -5138,7 +5165,9 @@ const GridPopoverTextInput = (colDef, params) => GridCell(colDef, {
     ...params,
 });
 
-const GridWrapper = ({ children, maxHeight }) => (jsx("div", { className: 'Grid-wrapper', style: { maxHeight }, children: children }));
+const GridWrapper = forwardRef(function GridWrapperFr({ children, maxHeight, className }, ref) {
+    return (jsx("div", { className: clsx('Grid-wrapper', className), style: { maxHeight }, ref: ref, children: children }));
+});
 
 const getColId = (colDef) => colDef.colId ?? '';
 const isFlexColumn = (colDef) => !!colDef.flex && !isGridCellFiller(colDef);