@linzjs/step-ag-grid 7.13.0 → 7.13.1

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

@@ -9,4 +9,7 @@ export declare const Editor: <FN extends (param: any) => JSX.Element>(props: {
     editor: FN;
     editorParams: ComponentProps<FN>;
 }) => CellEditorSelectorResult;
-export declare const GridCellMultiEditor: <RowType extends GridBaseRow>(props: GenericCellColDef<RowType>, cellEditorSelector: (params: ICellEditorParams) => CellEditorSelectorResult) => ColDefT<RowType>;
+export interface RowCellEditorParams<RowType extends GridBaseRow> extends ICellEditorParams {
+    data: RowType;
+}
+export declare const GridCellMultiEditor: <RowType extends GridBaseRow>(props: GenericCellColDef<RowType>, cellEditorSelector: (params: RowCellEditorParams<RowType>) => CellEditorSelectorResult) => ColDefT<RowType>;

package/dist/src/components/gridForm/GridFormDropDown.d.ts

@@ -27,10 +27,10 @@ export interface GridFormPopoutDropDownProps<RowType extends GridBaseRow> extend
     filtered?: "local" | "reload";
     filterPlaceholder?: string;
     filterHelpText?: string;
+    noOptionsMessage?: string;
     onSelectedItem?: (props: GridPopoutEditDropDownSelectedItem<RowType>) => Promise<void>;
     onSelectFilter?: (props: GridPopoutEditDropDownSelectedItem<RowType>) => Promise<void>;
-    options: SelectOption[] | ((selectedRows: RowType[], filter?: string) => Promise<SelectOption[]> | SelectOption[]);
-    optionsRequestCancel?: () => void;
+    options: SelectOption[] | ((selectedRows: RowType[], filter?: string) => Promise<SelectOption[] | undefined> | SelectOption[] | undefined) | undefined;
 }
 export declare const GridFormDropDown: <RowType extends GridBaseRow>(props: GridFormPopoutDropDownProps<RowType>) => JSX.Element;
 export {};

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

@@ -2,12 +2,16 @@
 import { ICellRendererParams } from "ag-grid-community";
 import { GridBaseRow } from "../Grid";
 import { ColDefT } from "../GridCell";
-import { SuppressKeyboardEventParams } from "ag-grid-community/dist/lib/entities/colDef";
+import { EditableCallbackParams, SuppressKeyboardEventParams } from "ag-grid-community/dist/lib/entities/colDef";
 export interface RowICellRendererParams<RowType extends GridBaseRow> extends ICellRendererParams {
     data: RowType;
 }
+export interface RowEditableCallbackParams<RowType extends GridBaseRow> extends EditableCallbackParams {
+    data: RowType;
+}
 export interface GenericCellColDef<RowType extends GridBaseRow> extends ColDefT<RowType> {
     cellRendererParams?: GenericCellRendererParams<RowType>;
+    editable?: boolean | ((params: RowEditableCallbackParams<RowType>) => boolean);
 }
 export interface GenericCellRendererParams<RowType extends GridBaseRow> {
     singleClickEdit?: boolean;

package/dist/src/index.d.ts

@@ -10,6 +10,7 @@ export * from "./contexts/GridSubComponentContext";
 export type { GridBaseRow } from "./components/Grid";
 export { Grid } from "./components/Grid";
 export * from "./components/GridCell";
+export * from "./components/GridCellMultiEditor";
 export { GridIcon } from "./components/GridIcon";
 export { ComponentLoadingWrapper } from "./components/ComponentLoadingWrapper";
 export { GridCellMultiSelectClassRules } from "./components/GridCellMultiSelectClassRules";
@@ -30,6 +31,10 @@ export { GridFormSubComponentTextInput } from "./components/gridForm/GridFormSub
 export * from "./components/gridForm/GridFormDropDown";
 export * from "./components/gridForm/GridFormMultiSelect";
 export * from "./components/gridForm/GridFormPopoverMenu";
+export * from "./components/gridForm/GridFormTextInput";
+export * from "./components/gridForm/GridFormTextArea";
+export * from "./components/gridForm/GridFormMessage";
+export * from "./components/gridForm/GridFormEditBearing";
 export { GridHeaderSelect } from "./components/gridHeader/GridHeaderSelect";
 export { TextAreaInput } from "./lui/TextAreaInput";
 export { TextInputFormatted } from "./lui/TextInputFormatted";

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

@@ -3014,6 +3014,28 @@ var GenericCellEditorComponentWrapper = function (editor) {
     });
 };
 
+var Editor = function (props) { return ({
+    component: GenericCellEditorComponentWrapper(props.editor),
+    params: __assign(__assign({}, props.editorParams), { multiEdit: props.multiEdit })
+}); };
+/*
+ * All cells should use this
+ */
+var GridCellMultiEditor = function (props, cellEditorSelector) {
+    var _a, _b;
+    return __assign(__assign({ colId: (_a = props.colId) !== null && _a !== void 0 ? _a : props.field, field: props.field, sortable: !!((props === null || props === void 0 ? void 0 : props.field) || (props === null || props === void 0 ? void 0 : props.valueGetter)), resizable: true, editable: (_b = props.editable) !== null && _b !== void 0 ? _b : true, cellClassRules: GridCellMultiSelectClassRules, cellEditorSelector: cellEditorSelector, suppressKeyboardEvent: suppressCellKeyboardEvents, 
+        // Default value formatter, otherwise react freaks out on objects
+        valueFormatter: function (params) {
+            if (params.value == null)
+                return "–";
+            var types = ["number", "boolean", "string"];
+            if (types.includes(typeof params.value))
+                return "".concat(params.value);
+            else
+                return JSON.stringify(params.value);
+        } }, props), { cellRenderer: GridCellRenderer, cellRendererParams: __assign({ originalCellRenderer: props.cellRenderer }, props.cellRendererParams) });
+};
+
 /**
  * If loading is true this returns a loading spinner, otherwise it returns its children.
  */
@@ -3242,17 +3264,17 @@ var fieldToString = function (field) {
     return typeof field == "symbol" ? field.toString() : "".concat(field);
 };
 var GridFormDropDown = function (props) {
-    var _a = useGridPopoverContext(), selectedRows = _a.selectedRows, field = _a.field, data = _a.data;
+    var _a;
+    var _b = useGridPopoverContext(), selectedRows = _b.selectedRows, field = _b.field, data = _b.data;
     // Save triggers during async action processing which triggers another selectItem(), this ref blocks that
-    var _b = useState(""), filter = _b[0], setFilter = _b[1];
-    var _c = useState(), filteredValues = _c[0], setFilteredValues = _c[1];
-    var optionsInitialising = useRef(false);
-    var _d = useState(null), options = _d[0], setOptions = _d[1];
+    var _c = useState(""), filter = _c[0], setFilter = _c[1];
+    var _d = useState(), filteredValues = _d[0], setFilteredValues = _d[1];
+    var _e = useState(null), options = _e[0], setOptions = _e[1];
     var subComponentIsValid = useRef(false);
     var subComponentInitialValue = useRef(null);
-    var _e = useState(null), subSelectedValue = _e[0], setSubSelectedValue = _e[1];
+    var _f = useState(null), subSelectedValue = _f[0], setSubSelectedValue = _f[1];
     // Note: null is assumed to be the filter
-    var _f = useState(null), selectedItem = _f[0], setSelectedItem = _f[1];
+    var _g = useState(null), selectedItem = _g[0], setSelectedItem = _g[1];
     var selectItemHandler = useCallback(function (value, subComponentValue) { return __awaiter(void 0, void 0, void 0, function () {
         var hasChanged;
         return __generator(this, function (_a) {
@@ -3275,11 +3297,9 @@ var GridFormDropDown = function (props) {
     }); }, [field, props, selectedRows]);
     // Load up options list if it's async function
     useEffect(function () {
-        var _a;
-        if (options || optionsInitialising.current)
+        if (options)
             return;
-        optionsInitialising.current = true;
-        var optionsConf = (_a = props.options) !== null && _a !== void 0 ? _a : [];
+        var optionsConf = props.options;
         (function () { return __awaiter(void 0, void 0, void 0, function () {
             var optionsList;
             return __generator(this, function (_a) {
@@ -3291,24 +3311,26 @@ var GridFormDropDown = function (props) {
                         optionsConf = _a.sent();
                         _a.label = 2;
                     case 2:
-                        optionsList = optionsConf === null || optionsConf === void 0 ? void 0 : optionsConf.map(function (item) {
-                            return item == null || typeof item == "string"
-                                ? {
-                                    value: item,
-                                    label: item,
-                                    disabled: false
-                                }
-                                : item;
-                        });
-                        if (props.filtered) {
-                            // This is needed otherwise when filter input is rendered and sets autofocus
-                            // the mouse up of the double click edit triggers the cell to cancel editing
-                            delay(function () { return setOptions(optionsList); }, 100);
-                        }
-                        else {
-                            setOptions(optionsList);
+                        if (optionsConf !== undefined) {
+                            optionsList = optionsConf === null || optionsConf === void 0 ? void 0 : optionsConf.map(function (item) {
+                                return item == null || typeof item == "string"
+                                    ? {
+                                        value: item,
+                                        label: item,
+                                        disabled: false
+                                    }
+                                    : item;
+                            });
+                            if (props.filtered) {
+                                // This is needed otherwise when filter input is rendered and sets autofocus
+                                // the mouse up of the double click edit triggers the cell to cancel editing
+                                setOptions(optionsList);
+                                //delay(() => setOptions(optionsList), 100);
+                            }
+                            else {
+                                setOptions(optionsList);
+                            }
                         }
-                        optionsInitialising.current = false;
                         return [2 /*return*/];
                 }
             });
@@ -3331,15 +3353,16 @@ var GridFormDropDown = function (props) {
                 .filter(function (r) { return r !== undefined; }));
         }
     }, [props.filtered, filter, options]);
-    var researchOnFilterChange = dist$1(useCallback(function () {
-        setOptions(null);
-    }, []), 500);
+    var researchOnFilterChange = useMemo(function () {
+        return dist$1(function () {
+            setOptions(null);
+        }, 500);
+    }, []);
     var previousFilter = useRef(filter);
     // Reload filtering.
     useEffect(function () {
         if (previousFilter.current != filter && props.filtered == "reload") {
             previousFilter.current = filter;
-            props.optionsRequestCancel && props.optionsRequestCancel();
             researchOnFilterChange().then();
         }
     }, [filter, props, researchOnFilterChange]);
@@ -3391,7 +3414,7 @@ var GridFormDropDown = function (props) {
                             var ref = _a.ref;
                             return (jsxs("div", __assign({ style: { display: "flex", flexDirection: "column", width: "100%" } }, { children: [jsx("input", { className: "LuiTextInput-input", ref: ref, type: "text", placeholder: (_b = props.filterPlaceholder) !== null && _b !== void 0 ? _b : "Placeholder", "data-testid": "filteredMenu-free-text-input", defaultValue: filter, "data-allowtabtosave": true, "data-disableenterautosave": !props.onSelectFilter &&
                                             !(filteredValues && filteredValues.length === 1 && !filteredValues[0].subComponent), onChange: function (e) { return setFilter(e.target.value); } }), props.filterHelpText && isNotEmpty(filter) && (jsx(FormError, { error: null, helpText: props.filterHelpText }))] })));
-                        } })), jsx(MenuDivider, {}, "$$divider_filter")] }))), jsx(ComponentLoadingWrapper, __assign({ loading: !options, className: "GridFormDropDown-options" }, { children: jsxs(Fragment$1, { children: [options && (isEmpty(options) || (filteredValues && isEmpty(filteredValues))) && (jsx(MenuItem, __assign({ className: "GridPopoverEditDropDown-noOptions" }, { children: "No Options" }), "".concat(fieldToString(field), "-empty"))), options === null || options === void 0 ? void 0 : options.map(function (item, index) {
+                        } })), jsx(MenuDivider, {}, "$$divider_filter")] }))), jsx(ComponentLoadingWrapper, __assign({ loading: !options, className: "GridFormDropDown-options" }, { children: jsxs(Fragment$1, { children: [options && (isEmpty(options) || (filteredValues && isEmpty(filteredValues))) && (jsx(MenuItem, __assign({ className: "GridPopoverEditDropDown-noOptions" }, { children: (_a = props.noOptionsMessage) !== null && _a !== void 0 ? _a : "No Options" }), "".concat(fieldToString(field), "-empty"))), options === null || options === void 0 ? void 0 : options.map(function (item, index) {
                             var _a;
                             return item.value === MenuSeparatorString ? (jsx(MenuDivider, {}, "$$divider_".concat(index))) : item.value === MenuHeaderString ? (jsx(MenuHeader, { children: item.label }, "$$header_".concat(index))) : ((!filteredValues || filteredValues.includes(item)) && (jsxs("div", { children: [jsxs(MenuItem, __assign({ disabled: !!item.disabled, title: item.disabled && typeof item.disabled !== "boolean" ? item.disabled : "", value: item.value, onFocus: function () {
                                             setSelectedItem(item);
@@ -24772,5 +24795,5 @@ var clickActionButton = function (text, container) { return __awaiter(void 0, vo
     });
 }); };
 
-export { ActionButton, ComponentLoadingWrapper, ControlledMenu, FocusableItem, GenericCellEditorComponentWrapper, Grid, GridCell, GridCellMultiSelectClassRules, GridCellRenderer, GridContext, GridContextProvider, GridFormDropDown, GridFormMultiSelect, GridFormPopoverMenu, GridFormSubComponentTextArea, GridFormSubComponentTextInput, 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, bearingCorrectionValueFormatter, bearingNumberParser, bearingStringValidator, bearingValueFormatter, clickActionButton, clickMenuOption, clickMultiSelectOption, closeMenu, convertDDToDMS, countRows, deselectRow, editCell, findActionButton, findCell, findCellContains, findMenuOption, findMultiSelectOption, findParentWithClass, findRow, fnOrVar, getMultiSelectOptions, hasParentClass, isFloat, isNotEmpty, openAndClickMenuOption, queryMenuOption, queryRow, selectCell, selectRow, stringByteLengthIsInvalid, suppressCellKeyboardEvents, typeOtherInput, typeOtherTextArea, useDeferredPromise, useGridPopoverContext, useGridPopoverHook, useMenuState, usePostSortRowsHook, 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, bearingCorrectionValueFormatter, bearingNumberParser, bearingStringValidator, bearingValueFormatter, clickActionButton, clickMenuOption, clickMultiSelectOption, closeMenu, convertDDToDMS, countRows, deselectRow, editCell, findActionButton, findCell, findCellContains, findMenuOption, findMultiSelectOption, findParentWithClass, findRow, fnOrVar, getMultiSelectOptions, hasParentClass, isFloat, isNotEmpty, openAndClickMenuOption, queryMenuOption, queryRow, selectCell, selectRow, stringByteLengthIsInvalid, suppressCellKeyboardEvents, typeOtherInput, typeOtherTextArea, useDeferredPromise, useGridPopoverContext, useGridPopoverHook, useMenuState, usePostSortRowsHook, wait$2 as wait };
 //# sourceMappingURL=step-ag-grid.esm.js.map