@linzjs/step-ag-grid 8.3.2 → 8.4.1

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

@@ -1,6 +1,6 @@
 /// <reference types="react" />
 import { GridBaseRow } from "./Grid";
-import { GenericCellColDef } from "./gridRender/GridRenderGenericCell";
+import { GenericCellColDef, RowValueFormatterParams, RowValueGetterParams } from "./gridRender/GridRenderGenericCell";
 import { ColDef, ICellEditorParams, ICellRendererParams } from "ag-grid-community";
 import { SuppressKeyboardEventParams } from "ag-grid-community/dist/lib/entities/colDef";
 export interface GenericCellEditorProps<E> {
@@ -14,6 +14,7 @@ export interface ColDefT<RowType extends GridBaseRow> extends ColDef {
     editor?: (editorProps: any) => JSX.Element;
 }
 export declare const suppressCellKeyboardEvents: (e: SuppressKeyboardEventParams) => any;
+export declare const generateFilterGetter: <RowType extends GridBaseRow>(field: string | undefined, filterValueGetter: string | ((params: RowValueGetterParams<RowType>) => string) | undefined, valueFormatter: string | ((params: RowValueFormatterParams<RowType>) => string) | undefined) => string | ((params: RowValueGetterParams<RowType>) => string) | undefined;
 export declare const GridCell: <RowType extends GridBaseRow, Props extends CellEditorCommon>(props: GenericCellColDef<RowType>, custom?: {
     multiEdit?: boolean | undefined;
     editor?: ((editorProps: Props) => JSX.Element) | undefined;

package/dist/src/components/GridCell.test.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -15,11 +15,15 @@ export interface RowValueFormatterParams<RowType extends GridBaseRow> extends Va
 export interface RowValueGetterParams<RowType extends GridBaseRow> extends ValueGetterParams {
     data: RowType;
 }
+export interface RowValueGetterParams<RowType extends GridBaseRow> extends ValueGetterParams {
+    data: RowType;
+}
 export interface GenericCellColDef<RowType extends GridBaseRow> extends ColDefT<RowType> {
     cellRenderer?: (params: RowICellRendererParams<RowType>) => any;
     cellRendererParams?: GenericCellRendererParams<RowType>;
     valueGetter?: string | ((params: RowValueGetterParams<RowType>) => any);
     valueFormatter?: string | ((params: RowValueFormatterParams<RowType>) => string);
+    filterValueGetter?: string | ((params: RowValueGetterParams<RowType>) => string);
     editable?: boolean | ((params: RowEditableCallbackParams<RowType>) => boolean);
 }
 export interface GenericCellRendererParams<RowType extends GridBaseRow> {
@@ -27,6 +31,6 @@ export interface GenericCellRendererParams<RowType extends GridBaseRow> {
     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;
+    warning?: (props: RowICellRendererParams<RowType>) => string | string[] | boolean | null | undefined;
+    info?: (props: RowICellRendererParams<RowType>) => string | string[] | boolean | null | undefined;
 }

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

@@ -2995,7 +2995,7 @@ var GridIcon = function (props) {
 };
 
 var GridCellRenderer = function (props) {
-    var _a, _b, _c, _d;
+    var _a, _b, _c;
     var checkUpdating = useContext(GridUpdatingContext).checkUpdating;
     var colDef = props.colDef;
     var rendererParams = colDef.cellRendererParams;
@@ -3003,7 +3003,11 @@ 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_outline", title: warningText }), typeof infoText === "string" && jsx(GridIcon, { icon: "ic_info_outline", 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 })))] }) })));
+    if (Array.isArray(warningText))
+        warningText = warningText.join("\n");
+    if (Array.isArray(infoText))
+        infoText = infoText.join("\n");
+    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: [!!warningText && (jsx(GridIcon, { icon: "ic_warning_outline", title: typeof warningText === "string" ? warningText : "Warning" })), !!infoText && jsx(GridIcon, { icon: "ic_info_outline", title: typeof infoText === "string" ? infoText : "Info" }), jsx("div", __assign({ style: { display: "flex", flex: 1, overflow: "hidden" } }, { children: ((_c = 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(colDef.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 })))] }) })));
 };
 var suppressCellKeyboardEvents = function (e) {
     var _a, _b, _c, _d;
@@ -3017,11 +3021,35 @@ var suppressCellKeyboardEvents = function (e) {
     // as the incorrect selected rows will be returned
     return !["ArrowLeft", "ArrowRight", "ArrowDown", "ArrowUp", "Tab", " ", "Home", "End", "PageUp", "PageDown"].includes(e.event.key);
 };
+var generateFilterGetter = function (field, filterValueGetter, valueFormatter) {
+    if (filterValueGetter)
+        return filterValueGetter;
+    // aggrid will default to valueGetter
+    if (typeof valueFormatter !== "function" || !field)
+        return undefined;
+    return function (params) {
+        var value = params.getValue(field);
+        var formattedValue = valueFormatter(__assign(__assign({}, params), { value: value }));
+        // Search for null values using standard dash
+        if (formattedValue === "–")
+            formattedValue += " -";
+        // Search by raw value as well as formatted
+        var gotValue = ["string", "number"].includes(typeof value) ? value : undefined;
+        return (formattedValue + (gotValue != null && formattedValue != gotValue ? " " + gotValue : "")) //
+            .replaceAll(/\s+/g, " ")
+            .trim();
+    };
+};
 /*
  * All cells should use this.
  */
 var GridCell = function (props, custom) {
     var _a, _b;
+    // Generate a default filter value getter which uses the formatted value plus
+    // the editable value if it's a string and different from the formatted value.
+    // This is so that e.g. bearings can be searched for by DMS or raw number.
+    var valueFormatter = props.valueFormatter;
+    var filterValueGetter = generateFilterGetter(props.field, props.filterValueGetter, valueFormatter);
     return __assign(__assign(__assign(__assign(__assign(__assign({ colId: props.field, sortable: !!((props === null || props === void 0 ? void 0 : props.field) || (props === null || props === void 0 ? void 0 : props.valueGetter)), resizable: true, editable: (_a = props.editable) !== null && _a !== void 0 ? _a : false }, ((custom === null || custom === void 0 ? void 0 : custom.editor) && {
         cellClassRules: GridCellMultiSelectClassRules,
         editable: (_b = props.editable) !== null && _b !== void 0 ? _b : true,
@@ -3029,6 +3057,8 @@ var GridCell = function (props, custom) {
     })), { suppressKeyboardEvent: suppressCellKeyboardEvents }), ((custom === null || custom === void 0 ? void 0 : custom.editorParams) && {
         cellEditorParams: __assign(__assign({}, custom.editorParams), { multiEdit: custom.multiEdit })
     })), { 
+        // If there's a valueFormatter and no filterValueGetter then create a filterValueGetter
+        filterValueGetter: filterValueGetter, 
         // Default value formatter, otherwise react freaks out on objects
         valueFormatter: function (params) {
             if (params.value == null)
@@ -3494,7 +3524,7 @@ var GridFormDropDown = function (props) {
                                                         setValue: function (value) {
                                                             setSubSelectedValue(value);
                                                             if (subComponentInitialValue.current === null) {
-                                                                // copy the default value of the subcomponent so we can change detect on save
+                                                                // copy the default value of the subcomponent, so we can change detect on save
                                                                 subComponentInitialValue.current = JSON.stringify(value);
                                                             }
                                                         },
@@ -24967,5 +24997,5 @@ var clickActionButton = function (text, container) { return __awaiter(void 0, vo
     });
 }); };
 
-export { ActionButton, ComponentLoadingWrapper, ControlledMenu, Editor, FocusableItem, GenericCellEditorComponentWrapper, Grid, GridCell, GridCellMultiEditor, GridCellMultiSelectClassRules, GridCellRenderer, GridContext, GridContextProvider, GridFormDropDown, GridFormEditBearing, GridFormMessage, GridFormMultiSelect, GridFormPopoverMenu, GridFormSubComponentTextArea, GridFormSubComponentTextInput, GridFormTextArea, GridFormTextInput, GridHeaderSelect, GridIcon, GridLoadableCell, GridPopoutEditMultiSelect, GridPopoverContext, GridPopoverContextProvider, GridPopoverEditBearing, GridPopoverEditBearingCorrection, GridPopoverEditDropDown, GridPopoverMenu, GridPopoverMessage, GridPopoverTextArea, GridPopoverTextInput, GridRenderPopoutMenuCell, GridSubComponentContext, GridUpdatingContext, GridUpdatingContextProvider, Menu, MenuButton, MenuDivider, MenuGroup, MenuHeader, MenuHeaderItem, MenuHeaderString, MenuItem, MenuRadioGroup, MenuSeparator, MenuSeparatorString, PopoutMenuSeparator, SubMenu, TextAreaInput, TextInputFormatted, bearingCorrectionRangeValidator, bearingCorrectionValueFormatter, bearingNumberParser, bearingRangeValidator, bearingStringValidator, bearingValueFormatter, clickActionButton, clickMenuOption, clickMultiSelectOption, closeMenu, closePopover, convertDDToDMS, countRows, deselectRow, editCell, findActionButton, findCell, findCellContains, findMenuOption, findMultiSelectOption, findOpenPopover, findParentWithClass, findRow, fnOrVar, getMultiSelectOptions, hasParentClass, isCellReadOnly, isFloat, isNotEmpty, openAndClickMenuOption, openAndFindMenuOption, queryMenuOption, queryRow, selectCell, selectRow, stringByteLengthIsInvalid, suppressCellKeyboardEvents, typeInputByLabel, typeInputByPlaceholder, typeOnlyInput, typeOtherInput, typeOtherTextArea, useDeferredPromise, useGridPopoverContext, useGridPopoverHook, useMenuState, usePostSortRowsHook, validateMenuOptions, wait$2 as wait };
+export { ActionButton, ComponentLoadingWrapper, ControlledMenu, Editor, FocusableItem, GenericCellEditorComponentWrapper, Grid, GridCell, GridCellMultiEditor, GridCellMultiSelectClassRules, GridCellRenderer, GridContext, GridContextProvider, GridFormDropDown, GridFormEditBearing, GridFormMessage, GridFormMultiSelect, GridFormPopoverMenu, GridFormSubComponentTextArea, GridFormSubComponentTextInput, GridFormTextArea, GridFormTextInput, GridHeaderSelect, GridIcon, GridLoadableCell, GridPopoutEditMultiSelect, GridPopoverContext, GridPopoverContextProvider, GridPopoverEditBearing, GridPopoverEditBearingCorrection, GridPopoverEditDropDown, GridPopoverMenu, GridPopoverMessage, GridPopoverTextArea, GridPopoverTextInput, GridRenderPopoutMenuCell, GridSubComponentContext, GridUpdatingContext, GridUpdatingContextProvider, Menu, MenuButton, MenuDivider, MenuGroup, MenuHeader, MenuHeaderItem, MenuHeaderString, MenuItem, MenuRadioGroup, MenuSeparator, MenuSeparatorString, PopoutMenuSeparator, SubMenu, TextAreaInput, TextInputFormatted, bearingCorrectionRangeValidator, bearingCorrectionValueFormatter, bearingNumberParser, bearingRangeValidator, bearingStringValidator, bearingValueFormatter, clickActionButton, clickMenuOption, clickMultiSelectOption, closeMenu, closePopover, convertDDToDMS, countRows, deselectRow, editCell, findActionButton, findCell, findCellContains, findMenuOption, findMultiSelectOption, findOpenPopover, findParentWithClass, findRow, fnOrVar, generateFilterGetter, getMultiSelectOptions, hasParentClass, isCellReadOnly, isFloat, isNotEmpty, openAndClickMenuOption, openAndFindMenuOption, queryMenuOption, queryRow, selectCell, selectRow, stringByteLengthIsInvalid, suppressCellKeyboardEvents, typeInputByLabel, typeInputByPlaceholder, typeOnlyInput, typeOtherInput, typeOtherTextArea, useDeferredPromise, useGridPopoverContext, useGridPopoverHook, useMenuState, usePostSortRowsHook, validateMenuOptions, wait$2 as wait };
 //# sourceMappingURL=step-ag-grid.esm.js.map