@linzjs/step-ag-grid 13.1.0 → 13.1.1

package/dist/src/components/Grid.d.ts

@@ -26,4 +26,4 @@ export interface GridProps {
 /**
  * Wrapper for AgGrid to add commonly used functionality.
  */
-export declare const Grid: (params: GridProps) => JSX.Element;
+export declare const Grid: ({ rowSelection, "data-testid": dataTestId, ...params }: GridProps) => JSX.Element;

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

@@ -495,12 +495,13 @@ var GridHeaderSelect = function (_a) {
 /**
  * Wrapper for AgGrid to add commonly used functionality.
  */
-var Grid = function (params) {
-    var _a, _b, _c, _d;
-    var _e = useContext(GridContext), gridReady = _e.gridReady, setApis = _e.setApis, prePopupOps = _e.prePopupOps, ensureRowVisible = _e.ensureRowVisible, selectRowsById = _e.selectRowsById, focusByRowById = _e.focusByRowById, ensureSelectedRowIsVisible = _e.ensureSelectedRowIsVisible, sizeColumnsToFit = _e.sizeColumnsToFit, externallySelectedItemsAreInSync = _e.externallySelectedItemsAreInSync, setExternallySelectedItemsAreInSync = _e.setExternallySelectedItemsAreInSync, isExternalFilterPresent = _e.isExternalFilterPresent, doesExternalFilterPass = _e.doesExternalFilterPass;
+var Grid = function (_a) {
+    var _b, _c, _d;
+    var _e = _a.rowSelection, rowSelection = _e === void 0 ? "multiple" : _e, dataTestId = _a["data-testid"], params = __rest(_a, ["rowSelection", "data-testid"]);
+    var _f = useContext(GridContext), gridReady = _f.gridReady, setApis = _f.setApis, prePopupOps = _f.prePopupOps, ensureRowVisible = _f.ensureRowVisible, selectRowsById = _f.selectRowsById, focusByRowById = _f.focusByRowById, ensureSelectedRowIsVisible = _f.ensureSelectedRowIsVisible, sizeColumnsToFit = _f.sizeColumnsToFit, externallySelectedItemsAreInSync = _f.externallySelectedItemsAreInSync, setExternallySelectedItemsAreInSync = _f.setExternallySelectedItemsAreInSync, isExternalFilterPresent = _f.isExternalFilterPresent, doesExternalFilterPass = _f.doesExternalFilterPass;
     var checkUpdating = useContext(GridUpdatingContext).checkUpdating;
     var lastSelectedIds = useRef([]);
-    var _f = useState(false), staleGrid = _f[0], setStaleGrid = _f[1];
+    var _g = useState(false), staleGrid = _g[0], setStaleGrid = _g[1];
     var postSortRows = usePostSortRowsHook({ setStaleGrid: setStaleGrid });
     /**
      * On data load select the first row of the grid if required.
@@ -523,7 +524,7 @@ var Grid = function (params) {
         externallySelectedItemsAreInSync,
         focusByRowById,
         gridReady,
-        params,
+        params.externalSelectedItems,
         params.autoSelectFirstRow,
         params.rowData,
         selectRowsById,
@@ -614,11 +615,10 @@ var Grid = function (params) {
                     maxWidth: 42,
                     suppressSizeToFit: true,
                     checkboxSelection: true,
-                    headerComponent: params.rowSelection === "multiple" ? GridHeaderSelect : null,
+                    headerComponent: rowSelection === "multiple" ? GridHeaderSelect : null,
                     suppressHeaderKeyboardEvent: function (e) {
                         if ((e.event.key === "Enter" || e.event.key === " ") && !e.event.repeat) {
-                            var selectedNodeCount = e.api.getSelectedRows().length;
-                            if (selectedNodeCount == 0) {
+                            if (isEmpty(e.api.getSelectedRows())) {
                                 e.api.selectAllFiltered();
                             }
                             else {
@@ -634,15 +634,15 @@ var Grid = function (params) {
     }, [
         params.columnDefs,
         params.selectable,
-        params.rowSelection,
         params.readOnly,
-        (_a = params.defaultColDef) === null || _a === void 0 ? void 0 : _a.editable,
+        (_b = params.defaultColDef) === null || _b === void 0 ? void 0 : _b.editable,
+        rowSelection,
         clickSelectorCheckboxWhenContainingCellClicked,
     ]);
     var onGridReady = useCallback(function (event) {
-        setApis(event.api, event.columnApi, params["data-testid"]);
+        setApis(event.api, event.columnApi, dataTestId);
         synchroniseExternallySelectedItemsToGrid();
-    }, [setApis, synchroniseExternallySelectedItemsToGrid]);
+    }, [dataTestId, setApis, synchroniseExternallySelectedItemsToGrid]);
     var noRowsOverlayComponent = useCallback(function (event) {
         var _a, _b, _c;
         var hasData = ((_b = (_a = params.rowData) === null || _a === void 0 ? void 0 : _a.length) !== null && _b !== void 0 ? _b : 0) > 0;
@@ -652,7 +652,7 @@ var Grid = function (params) {
                 : !hasFilteredData
                     ? "All rows have been filtered"
                     : "" }));
-    }, [params.noRowsOverlayText, (_b = params.rowData) === null || _b === void 0 ? void 0 : _b.length]);
+    }, [params.noRowsOverlayText, (_c = params.rowData) === null || _c === void 0 ? void 0 : _c.length]);
     var onModelUpdated = useCallback(function (event) {
         event.api.getDisplayedRowCount() === 0 ? event.api.showNoRowsOverlay() : event.api.hideOverlay();
     }, []);
@@ -716,7 +716,7 @@ var Grid = function (params) {
             sizeColumnsToFit();
         }
     }, [columnDefs === null || columnDefs === void 0 ? void 0 : columnDefs.length, sizeColumnsToFit]);
-    return (jsx("div", __assign({ "data-testid": params["data-testid"], className: clsx("Grid-container", "ag-theme-alpine", staleGrid && "Grid-sortIsStale", gridReady && params.rowData && "Grid-ready") }, { children: jsx("div", __assign({ style: { flex: 1 } }, { children: jsx(AgGridReact, { animateRows: params.animateRows, rowClassRules: params.rowClassRules, getRowId: function (params) { return "".concat(params.data.id); }, suppressRowClickSelection: true, rowSelection: (_c = params.rowSelection) !== null && _c !== void 0 ? _c : "multiple", suppressBrowserResizeObserver: true, colResizeDefault: "shift", onFirstDataRendered: sizeColumnsToFit, onGridSizeChanged: sizeColumnsToFit, suppressClickEdit: true, onCellKeyPress: onCellKeyPress, onCellClicked: onCellClicked, onCellDoubleClicked: onCellDoubleClick, onCellEditingStarted: refreshSelectedRows, domLayout: params.domLayout, columnDefs: columnDefs, rowData: params.rowData, noRowsOverlayComponent: noRowsOverlayComponent, onModelUpdated: onModelUpdated, onGridReady: onGridReady, onSortChanged: ensureSelectedRowIsVisible, postSortRows: (_d = params.postSortRows) !== null && _d !== void 0 ? _d : postSortRows, onSelectionChanged: synchroniseExternalStateToGridSelection, onColumnMoved: params.onColumnMoved, alwaysShowVerticalScroll: params.alwaysShowVerticalScroll, isExternalFilterPresent: isExternalFilterPresent, doesExternalFilterPass: doesExternalFilterPass }) })) })));
+    return (jsx("div", __assign({ "data-testid": dataTestId, className: clsx("Grid-container", "ag-theme-alpine", staleGrid && "Grid-sortIsStale", gridReady && params.rowData && "Grid-ready") }, { children: jsx("div", __assign({ style: { flex: 1 } }, { children: jsx(AgGridReact, { animateRows: params.animateRows, rowClassRules: params.rowClassRules, getRowId: function (params) { return "".concat(params.data.id); }, suppressRowClickSelection: true, rowSelection: rowSelection, suppressBrowserResizeObserver: true, colResizeDefault: "shift", onFirstDataRendered: sizeColumnsToFit, onGridSizeChanged: sizeColumnsToFit, suppressClickEdit: true, onCellKeyPress: onCellKeyPress, onCellClicked: onCellClicked, onCellDoubleClicked: onCellDoubleClick, onCellEditingStarted: refreshSelectedRows, domLayout: params.domLayout, columnDefs: columnDefs, rowData: params.rowData, noRowsOverlayComponent: noRowsOverlayComponent, onModelUpdated: onModelUpdated, onGridReady: onGridReady, onSortChanged: ensureSelectedRowIsVisible, postSortRows: (_d = params.postSortRows) !== null && _d !== void 0 ? _d : postSortRows, onSelectionChanged: synchroniseExternalStateToGridSelection, onColumnMoved: params.onColumnMoved, alwaysShowVerticalScroll: params.alwaysShowVerticalScroll, isExternalFilterPresent: isExternalFilterPresent, doesExternalFilterPass: doesExternalFilterPass }) })) })));
 };
 
 var GridPopoverContext = createContext({