@linzjs/step-ag-grid 12.0.0 → 12.1.0

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

@@ -1,2 +1,3 @@
 import { GridFilterExternal } from "../contexts/GridContext";
-export declare const useGridFilter: (filter: GridFilterExternal) => void;
+import { GridBaseRow } from "./Grid";
+export declare const useGridFilter: <RowType extends GridBaseRow>(filter: GridFilterExternal<RowType> | undefined) => void;

package/dist/src/components/gridFilter/GridFilterButtons.d.ts

@@ -0,0 +1,16 @@
+import { ClassValue } from "clsx";
+import { LuiButtonProps } from "@linzjs/lui/dist/components/LuiButton/LuiButton";
+import { GridBaseRow } from "../Grid";
+import { GridFilterExternal } from "../../contexts/GridContext";
+interface GridFilterButtonsOption<RowType extends GridBaseRow> {
+    defaultSelected?: boolean;
+    filter?: GridFilterExternal<RowType>;
+    label: string;
+}
+export type GridFilterButtonsProps<RowType extends GridBaseRow> = {
+    className?: ClassValue;
+    luiButtonProps?: Partial<LuiButtonProps>;
+    options: GridFilterButtonsOption<RowType>[];
+};
+export declare const GridFilterButtons: <RowType extends GridBaseRow>({ className, luiButtonProps, options, }: GridFilterButtonsProps<RowType>) => JSX.Element;
+export {};

package/dist/src/components/gridFilter/GridFilterQuick.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="react" />
 export interface GridFilterQuickProps {
     quickFilterPlaceholder?: string;
     defaultValue?: string;

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

@@ -1,8 +1,8 @@
 /// <reference types="react" />
 import { GridApi, RowNode } from "ag-grid-community";
 import { GridBaseRow } from "../components/Grid";
-export type GridFilterExternal = (data: any, rowNode: RowNode) => boolean;
-export interface GridContextType {
+export type GridFilterExternal<RowType extends GridBaseRow> = (data: RowType, rowNode: RowNode) => boolean;
+export interface GridContextType<RowType extends GridBaseRow> {
     gridReady: boolean;
     setGridApi: (gridApi: GridApi | undefined) => void;
     prePopupOps: () => void;
@@ -29,9 +29,10 @@ export interface GridContextType {
     externallySelectedItemsAreInSync: boolean;
     setExternallySelectedItemsAreInSync: (inSync: boolean) => void;
     waitForExternallySelectedItemsToBeInSync: () => Promise<void>;
-    addExternalFilter: (filter: GridFilterExternal) => void;
-    removeExternalFilter: (filter: GridFilterExternal) => void;
+    addExternalFilter: (filter: GridFilterExternal<RowType>) => void;
+    removeExternalFilter: (filter: GridFilterExternal<RowType>) => void;
     isExternalFilterPresent: () => boolean;
     doesExternalFilterPass: (node: RowNode) => boolean;
 }
-export declare const GridContext: import("react").Context<GridContextType>;
+export declare const GridContext: import("react").Context<GridContextType<any>>;
+export declare const useGridContext: <RowType extends GridBaseRow>() => GridContextType<RowType>;

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

@@ -1,4 +1,5 @@
 import { ReactElement, ReactNode } from "react";
+import { GridBaseRow } from "../components/Grid";
 interface GridContextProps {
     children: ReactNode;
 }
@@ -7,5 +8,5 @@ interface GridContextProps {
  * Make sure you wrap AgGrid in this.
  * Also, make sure the provider is created in a separate component, otherwise it won't be found.
  */
-export declare const GridContextProvider: (props: GridContextProps) => ReactElement;
+export declare const GridContextProvider: <RowType extends GridBaseRow>(props: GridContextProps) => ReactElement;
 export {};

package/dist/src/index.d.ts

@@ -35,6 +35,10 @@ export * from "./components/gridForm/GridFormTextInput";
 export * from "./components/gridForm/GridFormTextArea";
 export * from "./components/gridForm/GridFormMessage";
 export * from "./components/gridForm/GridFormEditBearing";
+export { useGridFilter } from "./components/GridFilter";
+export * from "./components/gridFilter/GridFilterQuick";
+export * from "./components/gridFilter/GridFilters";
+export * from "./components/GridWrapper";
 export { GridHeaderSelect } from "./components/gridHeader/GridHeaderSelect";
 export { TextAreaInput } from "./lui/TextAreaInput";
 export { TextInputFormatted } from "./lui/TextInputFormatted";

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

@@ -2076,7 +2076,8 @@ var GridContext = createContext({
         console.error("no context provider for doesExternalFilterPass");
         return true;
     }
-});
+});
+var useGridContext = function () { return useContext(GridContext); };
 
 var GridUpdatingContext = createContext({
     checkUpdating: function () {
@@ -60410,6 +60411,39 @@ var GridFormSubComponentTextInput = function (props) {
     return (jsx(TextInputFormatted, { value: value, error: invalid(), onChange: function (e) { return setValue(e.target.value); }, helpText: helpText, placeholder: props.placeholder, style: { width: "100%" }, allowTabToSave: true }));
 };
 
+var useGridFilter = function (filter) {
+    var _a = useContext(GridContext), addExternalFilter = _a.addExternalFilter, removeExternalFilter = _a.removeExternalFilter;
+    useEffect(function () {
+        var thisFilter = filter;
+        thisFilter && addExternalFilter(thisFilter);
+        return function () {
+            thisFilter && removeExternalFilter(thisFilter);
+        };
+    }, [addExternalFilter, filter, removeExternalFilter]);
+};
+
+var GridFilterQuick = function (_a) {
+    var quickFilterPlaceholder = _a.quickFilterPlaceholder, defaultValue = _a.defaultValue;
+    var setQuickFilter = useContext(GridContext).setQuickFilter;
+    var _b = useState(defaultValue !== null && defaultValue !== void 0 ? defaultValue : ""), quickFilterValue = _b[0], setQuickFilterValue = _b[1];
+    useEffect(function () {
+        setQuickFilter(quickFilterValue);
+    }, [quickFilterValue, setQuickFilter]);
+    return (jsx("input", { "aria-label": "Search", className: "lui-margin-top-xxs lui-margin-bottom-xxs Grid-quickFilterBox", type: "text", placeholder: quickFilterPlaceholder !== null && quickFilterPlaceholder !== void 0 ? quickFilterPlaceholder : "Search...", value: quickFilterValue, onChange: function (event) {
+            setQuickFilterValue(event.target.value);
+        } }));
+};
+
+var GridFilters = function (_a) {
+    var children = _a.children;
+    return jsx("div", __assign$9({ className: "Grid-container-filters" }, { children: children }));
+};
+
+var GridWrapper = function (_a) {
+    var children = _a.children, maxHeight = _a.maxHeight;
+    return (jsx("div", __assign$9({ className: "Grid-wrapper", style: { maxHeight: maxHeight } }, { children: children })));
+};
+
 var GridFormSubComponentTextArea = function (props) {
     var _a;
     var _b = useContext(GridSubComponentContext), value = _b.value, data = _b.data, setValue = _b.setValue, setValid = _b.setValid, context = _b.context;
@@ -80648,5 +80682,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, 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 };
+export { ActionButton, ComponentLoadingWrapper, ControlledMenu, Editor, FocusableItem, GenericCellEditorComponentWrapper, Grid, GridCell, GridCellMultiEditor, GridCellMultiSelectClassRules, GridCellRenderer, GridContext, GridContextProvider, GridFilterQuick, GridFilters, 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, 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, useGridContext, useGridFilter, useGridPopoverContext, useGridPopoverHook, useMenuState, usePostSortRowsHook, validateMenuOptions, wait$2 as wait };
 //# sourceMappingURL=step-ag-grid.esm.js.map