-
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
/
useGridFilter.tsx
350 lines (315 loc) · 11.6 KB
/
useGridFilter.tsx
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
import * as React from 'react';
import { GridEventListener, GridEvents } from '../../../models/events';
import { DataGridProcessedProps } from '../../../models/props/DataGridProps';
import { GridApiCommunity } from '../../../models/api/gridApiCommunity';
import { GridFilterApi } from '../../../models/api/gridFilterApi';
import { GridFeatureModeConstant } from '../../../models/gridFeatureMode';
import { GridFilterItem } from '../../../models/gridFilterItem';
import { GridRowId, GridRowModel } from '../../../models/gridRows';
import { useGridApiEventHandler } from '../../utils/useGridApiEventHandler';
import { useGridApiMethod } from '../../utils/useGridApiMethod';
import { useGridLogger } from '../../utils/useGridLogger';
import { gridFilterableColumnLookupSelector } from '../columns/gridColumnsSelector';
import { GridPreferencePanelsValue } from '../preferencesPanel/gridPreferencePanelsValue';
import { getDefaultGridFilterModel } from './gridFilterState';
import { gridFilterModelSelector, gridVisibleSortedRowEntriesSelector } from './gridFilterSelector';
import { useFirstRender } from '../../utils/useFirstRender';
import { gridRowIdsSelector } from '../rows';
import { GridPreProcessor, useGridRegisterPreProcessor } from '../../core/preProcessing';
import {
GRID_DEFAULT_STRATEGY,
GridStrategyProcessor,
useGridRegisterStrategyProcessor,
} from '../../core/strategyProcessing';
import {
buildAggregatedFilterApplier,
sanitizeFilterModel,
mergeStateWithFilterModel,
} from './gridFilterUtils';
import { GridStateInitializer } from '../../utils/useGridInitializeState';
export const filterStateInitializer: GridStateInitializer<
Pick<DataGridProcessedProps, 'filterModel' | 'initialState' | 'disableMultipleColumnsFiltering'>
> = (state, props, apiRef) => {
const filterModel =
props.filterModel ?? props.initialState?.filter?.filterModel ?? getDefaultGridFilterModel();
return {
...state,
filter: {
filterModel: sanitizeFilterModel(filterModel, props.disableMultipleColumnsFiltering, apiRef),
visibleRowsLookup: {},
filteredDescendantCountLookup: {},
},
};
};
/**
* @requires useGridColumns (method, event)
* @requires useGridParamsApi (method)
* @requires useGridRows (event)
*/
export const useGridFilter = (
apiRef: React.MutableRefObject<GridApiCommunity>,
props: Pick<
DataGridProcessedProps,
| 'initialState'
| 'filterModel'
| 'onFilterModelChange'
| 'filterMode'
| 'disableMultipleColumnsFiltering'
| 'components'
| 'componentsProps'
>,
): void => {
const logger = useGridLogger(apiRef, 'useGridFilter');
apiRef.current.unstable_updateControlState({
stateId: 'filter',
propModel: props.filterModel,
propOnChange: props.onFilterModelChange,
stateSelector: gridFilterModelSelector,
changeEvent: GridEvents.filterModelChange,
});
/**
* API METHODS
*/
const applyFilters = React.useCallback<GridFilterApi['unstable_applyFilters']>(() => {
apiRef.current.setState((state) => {
const filterModel = gridFilterModelSelector(state, apiRef.current.instanceId);
const isRowMatchingFilters =
props.filterMode === GridFeatureModeConstant.client
? buildAggregatedFilterApplier(filterModel, apiRef)
: null;
const filteringResult = apiRef.current.unstable_applyStrategyProcessor('filtering', {
isRowMatchingFilters,
});
return {
...state,
filter: {
...state.filter,
...filteringResult,
},
};
});
apiRef.current.publishEvent(GridEvents.visibleRowsSet);
apiRef.current.forceUpdate();
}, [apiRef, props.filterMode]);
const upsertFilterItem = React.useCallback<GridFilterApi['upsertFilterItem']>(
(item) => {
const filterModel = gridFilterModelSelector(apiRef);
const items = [...filterModel.items];
const itemIndex = items.findIndex((filterItem) => filterItem.id === item.id);
if (itemIndex === -1) {
items.push(item);
} else {
items[itemIndex] = item;
}
apiRef.current.setFilterModel({ ...filterModel, items });
},
[apiRef],
);
const deleteFilterItem = React.useCallback<GridFilterApi['deleteFilterItem']>(
(itemToDelete) => {
const filterModel = gridFilterModelSelector(apiRef);
const items = filterModel.items.filter((item) => item.id !== itemToDelete.id);
if (items.length === filterModel.items.length) {
return;
}
apiRef.current.setFilterModel({ ...filterModel, items });
},
[apiRef],
);
const showFilterPanel = React.useCallback<GridFilterApi['showFilterPanel']>(
(targetColumnField) => {
logger.debug('Displaying filter panel');
if (targetColumnField) {
const filterModel = gridFilterModelSelector(apiRef);
const filterItemsWithValue = filterModel.items.filter((item) => item.value !== undefined);
let newFilterItems: GridFilterItem[];
const filterItemOnTarget = filterItemsWithValue.find(
(item) => item.columnField === targetColumnField,
);
if (filterItemOnTarget) {
newFilterItems = filterItemsWithValue;
} else if (props.disableMultipleColumnsFiltering) {
newFilterItems = [{ columnField: targetColumnField }];
} else {
newFilterItems = [...filterItemsWithValue, { columnField: targetColumnField }];
}
apiRef.current.setFilterModel({
...filterModel,
items: newFilterItems,
});
}
apiRef.current.showPreferences(GridPreferencePanelsValue.filters);
},
[apiRef, logger, props.disableMultipleColumnsFiltering],
);
const hideFilterPanel = React.useCallback<GridFilterApi['hideFilterPanel']>(() => {
logger.debug('Hiding filter panel');
apiRef.current.hidePreferences();
}, [apiRef, logger]);
const setFilterLinkOperator = React.useCallback<GridFilterApi['setFilterLinkOperator']>(
(linkOperator) => {
const filterModel = gridFilterModelSelector(apiRef);
if (filterModel.linkOperator === linkOperator) {
return;
}
apiRef.current.setFilterModel({
...filterModel,
linkOperator,
});
},
[apiRef],
);
const setFilterModel = React.useCallback<GridFilterApi['setFilterModel']>(
(model) => {
const currentModel = gridFilterModelSelector(apiRef);
if (currentModel !== model) {
logger.debug('Setting filter model');
apiRef.current.setState(
mergeStateWithFilterModel(model, props.disableMultipleColumnsFiltering, apiRef),
);
apiRef.current.unstable_applyFilters();
}
},
[apiRef, logger, props.disableMultipleColumnsFiltering],
);
const getVisibleRowModels = React.useCallback<GridFilterApi['getVisibleRowModels']>(() => {
const visibleSortedRows = gridVisibleSortedRowEntriesSelector(apiRef);
return new Map<GridRowId, GridRowModel>(visibleSortedRows.map((row) => [row.id, row.model]));
}, [apiRef]);
const filterApi: GridFilterApi = {
setFilterLinkOperator,
unstable_applyFilters: applyFilters,
deleteFilterItem,
upsertFilterItem,
setFilterModel,
showFilterPanel,
hideFilterPanel,
getVisibleRowModels,
};
useGridApiMethod(apiRef, filterApi, 'GridFilterApi');
/**
* PRE-PROCESSING
*/
const stateExportPreProcessing = React.useCallback<GridPreProcessor<'exportState'>>(
(prevState) => {
const filterModelToExport = gridFilterModelSelector(apiRef);
if (
filterModelToExport.items.length === 0 &&
filterModelToExport.linkOperator === getDefaultGridFilterModel().linkOperator
) {
return prevState;
}
return {
...prevState,
filter: {
filterModel: filterModelToExport,
},
};
},
[apiRef],
);
const stateRestorePreProcessing = React.useCallback<GridPreProcessor<'restoreState'>>(
(params, context) => {
const filterModel = context.stateToRestore.filter?.filterModel;
if (filterModel == null) {
return params;
}
apiRef.current.setState(
mergeStateWithFilterModel(filterModel, props.disableMultipleColumnsFiltering, apiRef),
);
return {
...params,
callbacks: [...params.callbacks, apiRef.current.unstable_applyFilters],
};
},
[apiRef, props.disableMultipleColumnsFiltering],
);
const preferencePanelPreProcessing = React.useCallback<GridPreProcessor<'preferencePanel'>>(
(initialValue, value) => {
if (value === GridPreferencePanelsValue.filters) {
const FilterPanel = props.components.FilterPanel;
return <FilterPanel {...props.componentsProps?.filterPanel} />;
}
return initialValue;
},
[props.components.FilterPanel, props.componentsProps?.filterPanel],
);
const flatFilteringMethod = React.useCallback<GridStrategyProcessor<'filtering'>>(
(params) => {
if (props.filterMode === GridFeatureModeConstant.client && params.isRowMatchingFilters) {
const rowIds = gridRowIdsSelector(apiRef);
const filteredRowsLookup: Record<GridRowId, boolean> = {};
for (let i = 0; i < rowIds.length; i += 1) {
const rowId = rowIds[i];
filteredRowsLookup[rowId] = params.isRowMatchingFilters(rowId);
}
return {
filteredRowsLookup,
// For flat tree, the `visibleRowsLookup` and the `filteredRowsLookup` since no row is collapsed.
visibleRowsLookup: filteredRowsLookup,
filteredDescendantCountLookup: {},
};
}
return {
visibleRowsLookup: {},
filteredRowsLookup: {},
filteredDescendantCountLookup: {},
};
},
[apiRef, props.filterMode],
);
useGridRegisterPreProcessor(apiRef, 'exportState', stateExportPreProcessing);
useGridRegisterPreProcessor(apiRef, 'restoreState', stateRestorePreProcessing);
useGridRegisterPreProcessor(apiRef, 'preferencePanel', preferencePanelPreProcessing);
useGridRegisterStrategyProcessor(apiRef, GRID_DEFAULT_STRATEGY, 'filtering', flatFilteringMethod);
/**
* EVENTS
*/
const handleColumnsChange = React.useCallback<GridEventListener<GridEvents.columnsChange>>(() => {
logger.debug('onColUpdated - GridColumns changed, applying filters');
const filterModel = gridFilterModelSelector(apiRef);
const filterableColumnsLookup = gridFilterableColumnLookupSelector(apiRef);
const newFilterItems = filterModel.items.filter(
(item) => item.columnField && filterableColumnsLookup[item.columnField],
);
if (newFilterItems.length < filterModel.items.length) {
apiRef.current.setFilterModel({ ...filterModel, items: newFilterItems });
}
}, [apiRef, logger]);
const handleStrategyProcessorChange = React.useCallback<
GridEventListener<GridEvents.activeStrategyProcessorChange>
>(
(methodName) => {
if (methodName === 'filtering') {
apiRef.current.unstable_applyFilters();
}
},
[apiRef],
);
useGridApiEventHandler(apiRef, GridEvents.rowsSet, apiRef.current.unstable_applyFilters);
useGridApiEventHandler(
apiRef,
GridEvents.rowExpansionChange,
apiRef.current.unstable_applyFilters,
);
useGridApiEventHandler(apiRef, GridEvents.columnsChange, handleColumnsChange);
useGridApiEventHandler(
apiRef,
GridEvents.activeStrategyProcessorChange,
handleStrategyProcessorChange,
);
/**
* 1ST RENDER
*/
useFirstRender(() => {
apiRef.current.unstable_applyFilters();
});
/**
* EFFECTS
*/
React.useEffect(() => {
if (props.filterModel !== undefined) {
apiRef.current.setFilterModel(props.filterModel);
}
}, [apiRef, logger, props.filterModel]);
};