[WC-2706]: Control over stored filters

packages/pluggableWidgets/datagrid-web/CHANGELOG.md

@@ -6,6 +6,10 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 ## [Unreleased]
 
+### Added
+
+-   We introduced a setting to exclude filters from being stored in the Personalization configuration.
+
 ## [2.28.2] - 2024-12-12
 
 ### Fixed

packages/pluggableWidgets/datagrid-web/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@mendix/datagrid-web",
     "widgetName": "Datagrid",
-    "version": "2.28.2",
+    "version": "2.28.3",
     "description": "",
     "copyright": "© Mendix Technology BV 2023. All rights reserved.",
     "private": true,

packages/pluggableWidgets/datagrid-web/src/Datagrid.tsx

@@ -61,7 +61,7 @@ const Container = observer((props: Props): ReactElement => {
         onClickTrigger: props.onClickTrigger,
         onClick: props.onClick
     });
-    useOnResetFiltersEvent(props.rootStore.staticInfo.name, props.rootStore.staticInfo.filtersChannelName);
+    useOnResetFiltersEvent(rootStore.staticInfo.name, rootStore.staticInfo.filtersChannelName);
 
     const visibleColumnsCount = selectActionHelper.showCheckboxColumn
         ? columnsStore.visibleColumns.length + 1

packages/pluggableWidgets/datagrid-web/src/Datagrid.xml

@@ -336,6 +336,10 @@
                     <caption>On change</caption>
                     <description />
                 </property>
+                <property key="storeFiltersInPersonalization" type="boolean" defaultValue="true">
+                    <caption>Store filters</caption>
+                    <description />
+                </property>
             </propertyGroup>
         </propertyGroup>
         <propertyGroup caption="Grid wide filtering">

packages/pluggableWidgets/datagrid-web/src/__tests__/perf.spec.tsx

@@ -84,7 +84,8 @@ describe("Datagrid", () => {
             filterList: [],
             configurationStorageType: "attribute",
             configurationAttribute: undefined,
-            loadingType: "spinner"
+            loadingType: "spinner",
+            storeFiltersInPersonalization: true
         };
         const user = userEvent.setup();
         let renderCount = 0;

packages/pluggableWidgets/datagrid-web/src/helpers/state/GridPersonalizationStore.ts

@@ -18,6 +18,7 @@ export class GridPersonalizationStore {
     private readonly gridName: string;
     private readonly gridColumnsHash: string;
     private readonly schemaVersion: GridPersonalizationStorageSettings["schemaVersion"] = 2;
+    private readonly storeFilters: boolean;
 
     private storage: PersonalizationStorage;
 
@@ -30,6 +31,7 @@ export class GridPersonalizationStore {
     ) {
         this.gridName = props.name;
         this.gridColumnsHash = getHash(this.columnsStore._allColumns, this.gridName);
+        this.storeFilters = props.storeFiltersInPersonalization;
 
         makeObservable<GridPersonalizationStore, "applySettings">(this, {
             settings: computed,
@@ -134,8 +136,8 @@ export class GridPersonalizationStore {
             this.gridName,
             this.gridColumnsHash,
             this.columnsStore.columnSettings,
-            this.columnsStore.filterSettings,
-            this.headerFilters.settings
+            this.storeFilters ? this.columnsStore.filterSettings : new Map(),
+            this.storeFilters ? this.headerFilters.settings : new Map()
         );
     }
 }

packages/pluggableWidgets/datagrid-web/src/package.xml

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8" ?>
 <package xmlns="http://www.mendix.com/package/1.0/">
-    <clientModule name="Datagrid" version="2.28.2" xmlns="http://www.mendix.com/clientModule/1.0/">
+    <clientModule name="Datagrid" version="2.28.3" xmlns="http://www.mendix.com/clientModule/1.0/">
         <widgetFiles>
             <widgetFile path="Datagrid.xml" />
         </widgetFiles>

packages/pluggableWidgets/datagrid-web/typings/DatagridProps.d.ts

@@ -131,6 +131,7 @@ export interface DatagridContainerProps {
     columnsHidable: boolean;
     configurationStorageType: ConfigurationStorageTypeEnum;
     configurationAttribute?: EditableValue<string>;
+    storeFiltersInPersonalization: boolean;
     filterList: FilterListType[];
     filtersPlaceholder?: ReactNode;
     filterSectionTitle?: DynamicValue<string>;
@@ -177,6 +178,7 @@ export interface DatagridPreviewProps {
     configurationStorageType: ConfigurationStorageTypeEnum;
     configurationAttribute: string;
     onConfigurationChange: {} | null;
+    storeFiltersInPersonalization: boolean;
     filterList: FilterListPreviewType[];
     filtersPlaceholder: { widgetCount: number; renderer: ComponentType<{ children: ReactNode; caption?: string }> };
     filterSectionTitle: string;