@linzjs/step-ag-grid 13.1.2 → 13.2.0

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

@@ -22,8 +22,11 @@ export interface GridProps {
     autoSelectFirstRow?: boolean;
     onColumnMoved?: GridOptions["onColumnMoved"];
     alwaysShowVerticalScroll?: boolean;
+    onGridSizeChanged: GridOptions["onGridSizeChanged"];
+    onFirstDataRendered: GridOptions["onFirstDataRendered"];
+    suppressColumnVirtualization: GridOptions["suppressColumnVirtualisation"];
 }
 /**
  * Wrapper for AgGrid to add commonly used functionality.
  */
-export declare const Grid: ({ rowSelection, "data-testid": dataTestId, ...params }: GridProps) => JSX.Element;
+export declare const Grid: ({ "data-testid": dataTestId, rowSelection, suppressColumnVirtualization, ...params }: GridProps) => JSX.Element;

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

@@ -0,0 +1,5 @@
+/// <reference types="react" />
+export declare const GridNoRowsOverlay: (params: {
+    rowData: any[] | null | undefined;
+    noRowsOverlayText: string | undefined;
+}) => JSX.Element;

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

@@ -8,6 +8,7 @@ export * from "./gridForm";
 export * from "./gridHeader";
 export * from "./GridIcon";
 export * from "./GridLoadableCell";
+export * from "./GridNoRowsOverlay";
 export * from "./gridPopoverEdit";
 export * from "./GridPopoverHook";
 export * from "./gridRender";

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

@@ -295,6 +295,13 @@ var stringByteLengthIsInvalid = function (str, maxBytes) {
 };
 var fnOrVar = function (fn, param) { return (typeof fn === "function" ? fn(param) : fn); };
 
+var GridNoRowsOverlay = function (params) {
+    var _a;
+    return (jsx("span", { children: isEmpty(params.rowData)
+            ? (_a = params.noRowsOverlayText) !== null && _a !== void 0 ? _a : "There are currently no rows"
+            : "All rows have been filtered" }));
+};
+
 /**
  * Retains last sort order from via <AgGrid postRowSort>.
  * Then applies this sort until next sort column change.
@@ -496,12 +503,12 @@ var GridHeaderSelect = function (_a) {
  * Wrapper for AgGrid to add commonly used functionality.
  */
 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 _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, params = __rest(_a, ["data-testid", "rowSelection", "suppressColumnVirtualization"]);
+    var _h = useContext(GridContext), gridReady = _h.gridReady, setApis = _h.setApis, prePopupOps = _h.prePopupOps, ensureRowVisible = _h.ensureRowVisible, selectRowsById = _h.selectRowsById, focusByRowById = _h.focusByRowById, ensureSelectedRowIsVisible = _h.ensureSelectedRowIsVisible, sizeColumnsToFit = _h.sizeColumnsToFit, externallySelectedItemsAreInSync = _h.externallySelectedItemsAreInSync, setExternallySelectedItemsAreInSync = _h.setExternallySelectedItemsAreInSync, isExternalFilterPresent = _h.isExternalFilterPresent, doesExternalFilterPass = _h.doesExternalFilterPass;
     var checkUpdating = useContext(GridUpdatingContext).checkUpdating;
     var lastSelectedIds = useRef([]);
-    var _g = useState(false), staleGrid = _g[0], setStaleGrid = _g[1];
+    var _j = useState(false), staleGrid = _j[0], setStaleGrid = _j[1];
     var postSortRows = usePostSortRowsHook({ setStaleGrid: setStaleGrid });
     /**
      * On data load select the first row of the grid if required.
@@ -643,16 +650,6 @@ var Grid = function (_a) {
         setApis(event.api, event.columnApi, dataTestId);
         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;
-        var hasFilteredData = event.api.getDisplayedRowCount() > 0;
-        return (jsx("span", { children: !hasData
-                ? (_c = params.noRowsOverlayText) !== null && _c !== void 0 ? _c : "There are currently no rows"
-                : !hasFilteredData
-                    ? "All rows have been filtered"
-                    : "" }));
-    }, [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 +713,7 @@ var Grid = function (_a) {
             sizeColumnsToFit();
         }
     }, [columnDefs === null || columnDefs === void 0 ? void 0 : columnDefs.length, sizeColumnsToFit]);
-    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 }) })) })));
+    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: (_c = params.onFirstDataRendered) !== null && _c !== void 0 ? _c : sizeColumnsToFit, onGridSizeChanged: (_d = params.onGridSizeChanged) !== null && _d !== void 0 ? _d : sizeColumnsToFit, suppressColumnVirtualisation: suppressColumnVirtualization, suppressClickEdit: true, onCellKeyPress: onCellKeyPress, onCellClicked: onCellClicked, onCellDoubleClicked: onCellDoubleClick, onCellEditingStarted: refreshSelectedRows, domLayout: params.domLayout, columnDefs: columnDefs, rowData: params.rowData, noRowsOverlayComponent: GridNoRowsOverlay, noRowsOverlayComponentParams: { rowData: params.rowData, noRowsOverlayText: params.noRowsOverlayText }, 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 }) })) })));
 };
 
 var GridPopoverContext = createContext({
@@ -25003,5 +25000,5 @@ var clickActionButton = function (text, container) { return __awaiter(void 0, vo
     });
 }); };
 
-export { ActionButton, ComponentLoadingWrapper, ControlledMenu, Editor, FocusableItem, FormError, GenericCellEditorComponentWrapper, Grid, GridCell, GridCellMultiEditor, GridCellMultiSelectClassRules, GridCellRenderer, GridContext, GridContextProvider, GridFilterButtons, GridFilterColumnsToggle, GridFilterHeaderIconButton, GridFilterQuick, GridFilters, GridFormDropDown, GridFormEditBearing, GridFormMessage, GridFormMultiSelect, GridFormPopoverMenu, GridFormSubComponentTextArea, GridFormSubComponentTextInput, GridFormTextArea, GridFormTextInput, GridHeaderSelect, GridIcon, GridLoadableCell, GridPopoutEditMultiSelect, GridPopoverContext, GridPopoverContextProvider, GridPopoverEditBearing, GridPopoverEditBearingCorrection, GridPopoverEditBearingCorrectionEditorParams, GridPopoverEditBearingEditorParams, GridPopoverEditDropDown, GridPopoverMenu, GridPopoverMessage, GridPopoverTextArea, GridPopoverTextInput, GridRenderPopoutMenuCell, GridSubComponentContext, GridUpdatingContext, GridUpdatingContextProvider, GridWrapper, 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, useGenerateOrDefaultId, useGridContext, useGridFilter, useGridPopoverContext, useGridPopoverHook, useMenuState, usePostSortRowsHook, validateMenuOptions, wait$2 as wait };
+export { ActionButton, ComponentLoadingWrapper, ControlledMenu, Editor, FocusableItem, FormError, GenericCellEditorComponentWrapper, Grid, GridCell, GridCellMultiEditor, GridCellMultiSelectClassRules, GridCellRenderer, GridContext, GridContextProvider, GridFilterButtons, GridFilterColumnsToggle, GridFilterHeaderIconButton, GridFilterQuick, GridFilters, GridFormDropDown, GridFormEditBearing, GridFormMessage, GridFormMultiSelect, GridFormPopoverMenu, GridFormSubComponentTextArea, GridFormSubComponentTextInput, GridFormTextArea, GridFormTextInput, GridHeaderSelect, GridIcon, GridLoadableCell, GridNoRowsOverlay, GridPopoutEditMultiSelect, GridPopoverContext, GridPopoverContextProvider, GridPopoverEditBearing, GridPopoverEditBearingCorrection, GridPopoverEditBearingCorrectionEditorParams, GridPopoverEditBearingEditorParams, GridPopoverEditDropDown, GridPopoverMenu, GridPopoverMessage, GridPopoverTextArea, GridPopoverTextInput, GridRenderPopoutMenuCell, GridSubComponentContext, GridUpdatingContext, GridUpdatingContextProvider, GridWrapper, 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, useGenerateOrDefaultId, useGridContext, useGridFilter, useGridPopoverContext, useGridPopoverHook, useMenuState, usePostSortRowsHook, validateMenuOptions, wait$2 as wait };
 //# sourceMappingURL=step-ag-grid.esm.js.map