@linzjs/step-ag-grid 7.8.1 → 7.10.0

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

@@ -20,6 +20,7 @@ export interface GridProps {
     postSortRows?: GridOptions["postSortRows"];
     animateRows?: boolean;
     rowClassRules?: GridOptions["rowClassRules"];
+    rowSelection?: "single" | "multiple";
 }
 /**
  * Wrapper for AgGrid to add commonly used functionality.

package/dist/src/components/gridRender/GridRenderGenericCell.d.ts

@@ -2,6 +2,7 @@
 import { ICellRendererParams } from "ag-grid-community";
 import { GridBaseRow } from "../Grid";
 import { ColDefT } from "../GridCell";
+import { SuppressKeyboardEventParams } from "ag-grid-community/dist/lib/entities/colDef";
 export interface RowICellRendererParams<RowType extends GridBaseRow> extends ICellRendererParams {
     data: RowType;
 }
@@ -10,8 +11,9 @@ export interface GenericCellColDef<RowType extends GridBaseRow> extends ColDefT<
 }
 export interface GenericCellRendererParams<RowType extends GridBaseRow> {
     singleClickEdit?: boolean;
-    editableIcon?: JSX.Element | undefined;
+    rightHoverElement?: JSX.Element | undefined;
     editAction?: (selectedRows: RowType[]) => void;
+    shortcutKeys?: Record<string, ((params: SuppressKeyboardEventParams) => boolean | void) | undefined>;
     warning?: (props: RowICellRendererParams<RowType>) => string | boolean | null | undefined;
     info?: (props: RowICellRendererParams<RowType>) => string | boolean | null | undefined;
 }

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

@@ -2669,12 +2669,12 @@ var GridHeaderSelect = function (_a) {
  * Wrapper for AgGrid to add commonly used functionality.
  */
 var Grid = function (params) {
-    var _a, _b;
-    var _c = useContext(GridContext), gridReady = _c.gridReady, setGridApi = _c.setGridApi, setQuickFilter = _c.setQuickFilter, ensureRowVisible = _c.ensureRowVisible, selectRowsById = _c.selectRowsById, ensureSelectedRowIsVisible = _c.ensureSelectedRowIsVisible, sizeColumnsToFit = _c.sizeColumnsToFit;
+    var _a, _b, _c;
+    var _d = useContext(GridContext), gridReady = _d.gridReady, setGridApi = _d.setGridApi, setQuickFilter = _d.setQuickFilter, ensureRowVisible = _d.ensureRowVisible, selectRowsById = _d.selectRowsById, ensureSelectedRowIsVisible = _d.ensureSelectedRowIsVisible, sizeColumnsToFit = _d.sizeColumnsToFit;
     var checkUpdating = useContext(GridUpdatingContext).checkUpdating;
-    var _d = useState(""), internalQuickFilter = _d[0], setInternalQuickFilter = _d[1];
+    var _e = useState(""), internalQuickFilter = _e[0], setInternalQuickFilter = _e[1];
     var lastSelectedIds = useRef([]);
-    var _e = useState(false), staleGrid = _e[0], setStaleGrid = _e[1];
+    var _f = useState(false), staleGrid = _f[0], setStaleGrid = _f[1];
     var postSortRows = usePostSortRowsHook({ setStaleGrid: setStaleGrid });
     /**
      * AgGrid checkbox select does not pass clicks within cell but not on the checkbox to checkbox.
@@ -2794,18 +2794,8 @@ var Grid = function (params) {
         }
     }, [checkUpdating]);
     var onCellDoubleClick = useCallback(function (event) {
-        var _a, _b, _c, _d, _e;
-        var editable = fnOrVar((_a = event.colDef) === null || _a === void 0 ? void 0 : _a.editable, event);
-        if (!editable)
-            return;
-        var editAction = (_c = (_b = event.colDef) === null || _b === void 0 ? void 0 : _b.cellRendererParams) === null || _c === void 0 ? void 0 : _c.editAction;
-        if (editAction) {
-            // Clicked row comes first in selected rows
-            editAction(__spreadArray([event.data], event.api.getSelectedRows().filter(function (row) { return row.id !== event.data.id; }), true));
-        }
-        else if (!((_e = (_d = event.colDef) === null || _d === void 0 ? void 0 : _d.cellRendererParams) === null || _e === void 0 ? void 0 : _e.singleClickEdit)) {
+        if (!invokeEditAction(event))
             startCellEditing(event);
-        }
     }, [startCellEditing]);
     var onCellClicked = useCallback(function (event) {
         var _a, _b;
@@ -2813,9 +2803,20 @@ var Grid = function (params) {
             startCellEditing(event);
         }
     }, [startCellEditing]);
+    var invokeEditAction = function (e) {
+        var _a, _b, _c;
+        var editAction = (_b = (_a = e.colDef) === null || _a === void 0 ? void 0 : _a.cellRendererParams) === null || _b === void 0 ? void 0 : _b.editAction;
+        if (!editAction)
+            return false;
+        var editable = fnOrVar((_c = e.colDef) === null || _c === void 0 ? void 0 : _c.editable, e);
+        editable && editAction(__spreadArray([e.data], e.api.getSelectedRows().filter(function (row) { return row.id !== e.data.id; }), true));
+        return true;
+    };
     var onCellKeyPress = useCallback(function (e) {
-        if (e.event.key === "Enter")
-            startCellEditing(e);
+        if (e.event.key === "Enter") {
+            if (!invokeEditAction(e))
+                startCellEditing(e);
+        }
     }, [startCellEditing]);
     var onCellEditingStopped = useCallback(function (event) {
         refreshSelectedRows(event);
@@ -2831,7 +2832,7 @@ var Grid = function (params) {
     }, [columnDefs === null || columnDefs === void 0 ? void 0 : columnDefs.length, sizeColumnsToFit]);
     return (jsxs("div", __assign({ "data-testid": params["data-testid"], className: clsx("Grid-container", "ag-theme-alpine", staleGrid && "Grid-sortIsStale") }, { children: [params.quickFilter && (jsx("div", __assign({ className: "Grid-quickFilter" }, { children: jsx("input", { "aria-label": "Search", className: "lui-margin-top-xxs lui-margin-bottom-xxs Grid-quickFilterBox", type: "text", placeholder: (_a = params.quickFilterPlaceholder) !== null && _a !== void 0 ? _a : "Search...", value: internalQuickFilter, onChange: function (event) {
                         setInternalQuickFilter(event.target.value);
-                    } }) }))), jsx(AgGridReact, { animateRows: params.animateRows, rowClassRules: params.rowClassRules, defaultColDef: params.defaultColDef, getRowId: function (params) { return "".concat(params.data.id); }, suppressRowClickSelection: true, rowSelection: "multiple", suppressBrowserResizeObserver: true, colResizeDefault: "shift", onFirstDataRendered: sizeColumnsToFit, onGridSizeChanged: sizeColumnsToFit, suppressClickEdit: true, onCellKeyPress: onCellKeyPress, onCellClicked: onCellClicked, onCellDoubleClicked: onCellDoubleClick, onCellEditingStarted: refreshSelectedRows, onCellEditingStopped: onCellEditingStopped, domLayout: params.domLayout, columnDefs: columnDefs, rowData: params.rowData, noRowsOverlayComponent: noRowsOverlayComponent, onGridReady: onGridReady, onSortChanged: ensureSelectedRowIsVisible, postSortRows: (_b = params.postSortRows) !== null && _b !== void 0 ? _b : postSortRows, onSelectionChanged: synchroniseExternalStateToGridSelection })] })));
+                    } }) }))), jsx(AgGridReact, { animateRows: params.animateRows, rowClassRules: params.rowClassRules, defaultColDef: params.defaultColDef, getRowId: function (params) { return "".concat(params.data.id); }, suppressRowClickSelection: true, rowSelection: (_b = params.rowSelection) !== null && _b !== void 0 ? _b : "multiple", suppressBrowserResizeObserver: true, colResizeDefault: "shift", onFirstDataRendered: sizeColumnsToFit, onGridSizeChanged: sizeColumnsToFit, suppressClickEdit: true, onCellKeyPress: onCellKeyPress, onCellClicked: onCellClicked, onCellDoubleClicked: onCellDoubleClick, onCellEditingStarted: refreshSelectedRows, onCellEditingStopped: onCellEditingStopped, domLayout: params.domLayout, columnDefs: columnDefs, rowData: params.rowData, noRowsOverlayComponent: noRowsOverlayComponent, onGridReady: onGridReady, onSortChanged: ensureSelectedRowIsVisible, postSortRows: (_c = params.postSortRows) !== null && _c !== void 0 ? _c : postSortRows, onSelectionChanged: synchroniseExternalStateToGridSelection })] })));
 };
 
 var GridCellMultiSelectClassRules = {
@@ -2860,7 +2861,7 @@ var GridCellRenderer = function (props) {
     var warningText = warningFn ? warningFn(props) : undefined;
     var infoFn = rendererParams === null || rendererParams === void 0 ? void 0 : rendererParams.info;
     var infoText = infoFn ? infoFn(props) : undefined;
-    return (jsx(GridLoadableCell, __assign({ isLoading: checkUpdating((_b = (_a = colDef.field) !== null && _a !== void 0 ? _a : colDef.colId) !== null && _b !== void 0 ? _b : "", props.data.id) }, { children: jsxs(Fragment$1, { children: [typeof warningText === "string" && jsx(GridIcon, { icon: "ic_warning", title: warningText }), typeof infoText === "string" && jsx(GridIcon, { icon: "ic_info", title: infoText }), jsx("div", __assign({ style: { display: "flex", flex: 1, overflow: "hidden" } }, { children: ((_c = colDef === null || colDef === void 0 ? void 0 : colDef.cellRendererParams) === null || _c === void 0 ? void 0 : _c.originalCellRenderer) ? (jsx(colDef.cellRendererParams.originalCellRenderer, __assign({}, props))) : (jsx("span", __assign({ title: props.valueFormatted }, { children: props.valueFormatted }))) })), fnOrVar((_d = props.colDef) === null || _d === void 0 ? void 0 : _d.editable, props) && (rendererParams === null || rendererParams === void 0 ? void 0 : rendererParams.editableIcon) && (jsx("div", __assign({ style: { display: "flex", alignItems: "center" } }, { children: rendererParams === null || rendererParams === void 0 ? void 0 : rendererParams.editableIcon })))] }) })));
+    return (jsx(GridLoadableCell, __assign({ isLoading: checkUpdating((_b = (_a = colDef.field) !== null && _a !== void 0 ? _a : colDef.colId) !== null && _b !== void 0 ? _b : "", props.data.id) }, { children: jsxs(Fragment$1, { children: [typeof warningText === "string" && jsx(GridIcon, { icon: "ic_warning", title: warningText }), typeof infoText === "string" && jsx(GridIcon, { icon: "ic_info", title: infoText }), jsx("div", __assign({ style: { display: "flex", flex: 1, overflow: "hidden" } }, { children: ((_c = colDef === null || colDef === void 0 ? void 0 : colDef.cellRendererParams) === null || _c === void 0 ? void 0 : _c.originalCellRenderer) ? (jsx(colDef.cellRendererParams.originalCellRenderer, __assign({}, props))) : (jsx("span", __assign({ title: props.valueFormatted }, { children: props.valueFormatted }))) })), fnOrVar((_d = props.colDef) === null || _d === void 0 ? void 0 : _d.editable, props) && (rendererParams === null || rendererParams === void 0 ? void 0 : rendererParams.rightHoverElement) && (jsx("div", __assign({ style: { display: "flex", alignItems: "center" } }, { children: rendererParams === null || rendererParams === void 0 ? void 0 : rendererParams.rightHoverElement })))] }) })));
 };
 /*
  * All cells should use this
@@ -2872,6 +2873,13 @@ var GridCell = function (props, custom) {
         editable: (_a = props.editable) !== null && _a !== void 0 ? _a : true,
         cellEditor: GenericCellEditorComponentWrapper(custom)
     })), { suppressKeyboardEvent: function (e) {
+            var _a, _b, _c, _d;
+            var shortcutKeys = (_b = (_a = e.colDef.cellRendererParams) === null || _a === void 0 ? void 0 : _a.shortcutKeys) !== null && _b !== void 0 ? _b : {};
+            var exec = shortcutKeys[e.event.key];
+            if (!e.editing && !e.event.repeat && e.event.type === "keypress" && exec) {
+                var editable = fnOrVar((_c = e.colDef) === null || _c === void 0 ? void 0 : _c.editable, e);
+                return editable ? (_d = exec(e)) !== null && _d !== void 0 ? _d : true : true;
+            }
             // It's important that aggrid doesn't trigger edit on enter
             // as the incorrect selected rows will be returned
             return !["ArrowLeft", "ArrowRight", "ArrowDown", "ArrowUp", "Tab", " "].includes(e.event.key);
@@ -3908,7 +3916,7 @@ var bearingCorrectionValueFormatter = function (params) {
         return "–";
     }
     if (typeof value === "string") {
-        return convertDDToDMS(bearingNumberParser(value), true, true);
+        return convertDDToDMS(bearingNumberParser(value), true, false);
     }
     return convertDDToDMS(value, true, false);
 };