@linzjs/step-ag-grid 14.3.3 → 14.5.0

package/dist/src/contexts/GridContext.d.ts

@@ -36,6 +36,10 @@ export interface GridContextType<RowType extends GridBaseRow> {
     autoSizeColumns: (props?: AutoSizeColumnsProps) => AutoSizeColumnsResult;
     sizeColumnsToFit: () => void;
     cancelEdit: () => void;
+    startCellEditing: ({ rowId, colId }: {
+        rowId: number;
+        colId: string;
+    }) => void;
     stopEditing: () => void;
     updatingCells: (props: {
         selectedRows: GridBaseRow[];

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

@@ -220,6 +220,9 @@ var GridContext = createContext({
     cancelEdit: function () {
         console.error("no context provider for cancelEdit");
     },
+    startCellEditing: function () {
+        console.error("no context provider for startCellEditing");
+    },
     stopEditing: function () {
         console.error("no context provider for stopEditing");
     },
@@ -716,13 +719,14 @@ var GridHeaderSelect = function (_a) {
  * Wrapper for AgGrid to add commonly used functionality.
  */
 var Grid = function (_a) {
-    var _b, _c, _d;
-    var dataTestId = _a["data-testid"], _e = _a.rowSelection, rowSelection = _e === void 0 ? "multiple" : _e, _f = _a.suppressColumnVirtualization, suppressColumnVirtualization = _f === void 0 ? true : _f, _g = _a.theme, theme = _g === void 0 ? "ag-theme-alpine" : _g, _h = _a.sizeColumns, sizeColumns = _h === void 0 ? "auto" : _h, _j = _a.selectColumnPinned, selectColumnPinned = _j === void 0 ? null : _j, params = __rest(_a, ["data-testid", "rowSelection", "suppressColumnVirtualization", "theme", "sizeColumns", "selectColumnPinned"]);
-    var _k = useContext(GridContext), gridReady = _k.gridReady, setApis = _k.setApis, prePopupOps = _k.prePopupOps, ensureRowVisible = _k.ensureRowVisible, getFirstRowId = _k.getFirstRowId, selectRowsById = _k.selectRowsById, focusByRowById = _k.focusByRowById, ensureSelectedRowIsVisible = _k.ensureSelectedRowIsVisible, autoSizeColumns = _k.autoSizeColumns, sizeColumnsToFit = _k.sizeColumnsToFit, externallySelectedItemsAreInSync = _k.externallySelectedItemsAreInSync, setExternallySelectedItemsAreInSync = _k.setExternallySelectedItemsAreInSync, isExternalFilterPresent = _k.isExternalFilterPresent, doesExternalFilterPass = _k.doesExternalFilterPass, setOnCellEditingComplete = _k.setOnCellEditingComplete, getColDef = _k.getColDef;
-    var _l = useContext(GridUpdatingContext), checkUpdating = _l.checkUpdating, updatedDep = _l.updatedDep, updatingCols = _l.updatingCols;
+    var _b, _c, _d, _e;
+    var dataTestId = _a["data-testid"], _f = _a.rowSelection, rowSelection = _f === void 0 ? "multiple" : _f, _g = _a.suppressColumnVirtualization, suppressColumnVirtualization = _g === void 0 ? true : _g, _h = _a.theme, theme = _h === void 0 ? "ag-theme-alpine" : _h, _j = _a.sizeColumns, sizeColumns = _j === void 0 ? "auto" : _j, _k = _a.selectColumnPinned, selectColumnPinned = _k === void 0 ? null : _k, params = __rest(_a, ["data-testid", "rowSelection", "suppressColumnVirtualization", "theme", "sizeColumns", "selectColumnPinned"]);
+    var _l = useContext(GridContext), gridReady = _l.gridReady, setApis = _l.setApis, ensureRowVisible = _l.ensureRowVisible, getFirstRowId = _l.getFirstRowId, selectRowsById = _l.selectRowsById, focusByRowById = _l.focusByRowById, ensureSelectedRowIsVisible = _l.ensureSelectedRowIsVisible, autoSizeColumns = _l.autoSizeColumns, sizeColumnsToFit = _l.sizeColumnsToFit, externallySelectedItemsAreInSync = _l.externallySelectedItemsAreInSync, setExternallySelectedItemsAreInSync = _l.setExternallySelectedItemsAreInSync, isExternalFilterPresent = _l.isExternalFilterPresent, doesExternalFilterPass = _l.doesExternalFilterPass, setOnCellEditingComplete = _l.setOnCellEditingComplete, getColDef = _l.getColDef;
+    var _m = useContext(GridUpdatingContext), updatedDep = _m.updatedDep, updatingCols = _m.updatingCols;
+    var gridContext = useContext(GridContext);
     var gridDivRef = useRef(null);
     var lastSelectedIds = useRef([]);
-    var _m = useState(false), staleGrid = _m[0], setStaleGrid = _m[1];
+    var _o = useState(false), staleGrid = _o[0], setStaleGrid = _o[1];
     var postSortRows = usePostSortRowsHook({ setStaleGrid: setStaleGrid });
     /**
      * onContentSize should only be called at maximum twice.
@@ -985,22 +989,12 @@ var Grid = function (_a) {
      * Make sure node is selected for editing and start edit
      */
     var startCellEditing = useCallback(function (event) {
-        var _a;
-        prePopupOps();
-        if (!event.node.isSelected()) {
-            event.node.setSelected(true, true);
-        }
-        // Cell already being edited, so don't re-edit until finished
-        if (checkUpdating([(_a = event.colDef.field) !== null && _a !== void 0 ? _a : ""], event.data.id)) {
-            return;
-        }
-        if (event.rowIndex !== null) {
-            event.api.startEditingCell({
-                rowIndex: event.rowIndex,
-                colKey: event.column.getColId()
+        event.data.id &&
+            gridContext.startCellEditing({
+                rowId: event.data.id,
+                colId: event.column.getColId()
             });
-        }
-    }, [checkUpdating, prePopupOps]);
+    }, [gridContext]);
     /**
      * Handle double click edit
      */
@@ -1048,8 +1042,11 @@ var Grid = function (_a) {
      * but we don't want the non-flex auto-sized columns to "fit" size, so suppressSizeToFit is set to true.
      */
     var columnDefsAdjusted = useMemo(function () {
-        return columnDefs.map(function (colDef) { return (__assign(__assign({}, colDef), { suppressSizeToFit: (sizeColumns === "auto" || sizeColumns === "auto-skip-headers") && !colDef.flex })); });
-    }, [columnDefs, sizeColumns]);
+        return columnDefs.map(function (colDef) {
+            var _a;
+            return (__assign(__assign({}, colDef), { suppressSizeToFit: (sizeColumns === "auto" || sizeColumns === "auto-skip-headers") && !colDef.flex, sortable: colDef.sortable && ((_a = params.defaultColDef) === null || _a === void 0 ? void 0 : _a.sortable) !== false }));
+        });
+    }, [columnDefs, (_d = params.defaultColDef) === null || _d === void 0 ? void 0 : _d.sortable, sizeColumns]);
     /**
      * Set of colIds that need auto-sizing.
      */
@@ -1123,7 +1120,7 @@ var Grid = function (_a) {
                 }, onRowDataChanged: onRowDataChanged, onCellKeyPress: onCellKeyPress, onCellClicked: onCellClicked, onCellDoubleClicked: onCellDoubleClick, onCellEditingStarted: refreshSelectedRows, domLayout: params.domLayout, onColumnResized: onColumnResized, defaultColDef: __assign({ minWidth: 48 }, omit(params.defaultColDef, ["editable"])), columnDefs: columnDefsAdjusted, rowData: params.rowData, noRowsOverlayComponent: GridNoRowsOverlay, noRowsOverlayComponentParams: {
                     rowData: params.rowData,
                     noRowsOverlayText: params.noRowsOverlayText
-                }, 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, maintainColumnOrder: true }) })) })));
+                }, onModelUpdated: onModelUpdated, onGridReady: onGridReady, onSortChanged: ensureSelectedRowIsVisible, postSortRows: (_e = params.postSortRows) !== null && _e !== void 0 ? _e : postSortRows, onSelectionChanged: synchroniseExternalStateToGridSelection, onColumnMoved: params.onColumnMoved, alwaysShowVerticalScroll: params.alwaysShowVerticalScroll, isExternalFilterPresent: isExternalFilterPresent, doesExternalFilterPass: doesExternalFilterPass, maintainColumnOrder: true }) })) })));
 };
 
 var GridPopoverContext = createContext({
@@ -4647,16 +4644,16 @@ var GridWrapper = function (_a) {
  * Also, make sure the provider is created in a separate component, otherwise it won't be found.
  */
 var GridContextProvider = function (props) {
-    var modifyUpdating = useContext(GridUpdatingContext).modifyUpdating;
-    var _a = useState(), gridApi = _a[0], setGridApi = _a[1];
-    var _b = useState(), columnApi = _b[0], setColumnApi = _b[1];
-    var _c = useState(false), gridReady = _c[0], setGridReady = _c[1];
-    var _d = useState(""), quickFilter = _d[0], setQuickFilter = _d[1];
-    var _e = useState([]), invisibleColumnIds = _e[0], setInvisibleColumnIds = _e[1];
+    var _a = useContext(GridUpdatingContext), modifyUpdating = _a.modifyUpdating, checkUpdating = _a.checkUpdating;
+    var _b = useState(), gridApi = _b[0], setGridApi = _b[1];
+    var _c = useState(), columnApi = _c[0], setColumnApi = _c[1];
+    var _d = useState(false), gridReady = _d[0], setGridReady = _d[1];
+    var _e = useState(""), quickFilter = _e[0], setQuickFilter = _e[1];
+    var _f = useState([]), invisibleColumnIds = _f[0], setInvisibleColumnIds = _f[1];
     var testId = useRef();
     var idsBeforeUpdate = useRef([]);
     var prePopupFocusedCell = useRef();
-    var _f = useState(false), externallySelectedItemsAreInSync = _f[0], setExternallySelectedItemsAreInSync = _f[1];
+    var _g = useState(false), externallySelectedItemsAreInSync = _g[0], setExternallySelectedItemsAreInSync = _g[1];
     var externalFilters = useRef([]);
     /**
      * Set quick filter directly on grid, based on previously save quickFilter state.
@@ -4941,6 +4938,43 @@ var GridContextProvider = function (props) {
         }
         gridApi.stopEditing();
     }, [gridApi]);
+    var startCellEditing = useCallback(function (_a) {
+        var rowId = _a.rowId, colId = _a.colId;
+        return __awaiter(void 0, void 0, void 0, function () {
+            var colDef, rowNode, rowIndex, focusAndEdit;
+            var _b;
+            return __generator(this, function (_c) {
+                if (!gridApi)
+                    return [2 /*return*/];
+                colDef = gridApi.getColumnDef(colId);
+                if (!colDef)
+                    return [2 /*return*/];
+                prePopupOps();
+                rowNode = gridApi.getRowNode("".concat(rowId));
+                if (!rowNode) {
+                    return [2 /*return*/];
+                }
+                if (!rowNode.isSelected()) {
+                    rowNode.setSelected(true, false);
+                }
+                // Cell already being edited, so don't re-edit until finished
+                if (checkUpdating([(_b = colDef.field) !== null && _b !== void 0 ? _b : ""], rowId)) {
+                    return [2 /*return*/];
+                }
+                rowIndex = rowNode.rowIndex;
+                if (rowIndex != null) {
+                    focusAndEdit = function () {
+                        gridApi.startEditingCell({
+                            rowIndex: rowIndex,
+                            colKey: colId
+                        });
+                    };
+                    defer$1(focusAndEdit);
+                }
+                return [2 /*return*/];
+            });
+        });
+    }, [checkUpdating, gridApi, prePopupOps]);
     /**
      * This differs from stopEdit in that it will also invoke cellEditingCompleteCallback
      */
@@ -5151,6 +5185,7 @@ var GridContextProvider = function (props) {
             ensureSelectedRowIsVisible: ensureSelectedRowIsVisible,
             sizeColumnsToFit: sizeColumnsToFit,
             autoSizeColumns: autoSizeColumns,
+            startCellEditing: startCellEditing,
             stopEditing: stopEditing,
             cancelEdit: cancelEdit,
             updatingCells: updatingCells,