[DataGrid] Update quick filter input when model is modified #5013
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
These are the results for the performance tests:
|
2 tasks
alexfauquette
force-pushed
the
control-quickfiltering
branch
from
82b81d9 to
08d17eb
Compare
m4theushw
reviewed
Jun 1, 2022
|
|
||
| const apiRef = useGridApiContext(); | ||
| const rootProps = useGridRootProps(); | ||
| const quickFilterValues = gridQuickFilterValuesSelector(apiRef); |
packages/grid/x-data-grid/src/components/toolbar/GridToolbarQuickFilter.tsx
Show resolved
Hide resolved
Comment on lines
88
to
91
| setPrevQuickFilterValues(quickFilterValues); | ||
| if (!isDeepEqual(quickFilterParser(searchValue), quickFilterValues)) { | ||
| // The input value and the new model are un-sync so we will update the input | ||
| setSearchValue(quickFilterFormatter(quickFilterValues ?? [])); |
There was a problem hiding this comment.
It's calling this effect twice. You can do two things to improve it:
- use a ref for
prevQuickFilterValues, since it's not part of the state of the component - instead of
setSearchValuedosetSearchValue(prevSearchValue => { ... })to removesearchValuefrom the dependencies.
packages/grid/x-data-grid/src/components/toolbar/GridToolbarQuickFilter.tsx
Show resolved
Hide resolved
packages/grid/x-data-grid/src/components/toolbar/GridToolbarQuickFilter.tsx
Show resolved
Hide resolved
Co-authored-by: Matheus Wichman <matheushw@outlook.com>
…erial-ui-x into control-quickfiltering
|
I added tests, and a sentence in the doc to define this new formatter |
m4theushw
reviewed
Jun 2, 2022
| @@ -19,6 +19,15 @@ export const gridFilterModelSelector = createSelector( | |||
| (filterState) => filterState.filterModel, | |||
| ); | |||
|
|
|||
| /** | |||
| * Get the current quick filter values. | |||
There was a problem hiding this comment.
Suggested change
| * Get the current quick filter values. | |
| * Gets the current quick filter values. |
There was a problem hiding this comment.
All the other lines are with Get
There was a problem hiding this comment.
That's inconsistent because all API methods use the present tense. Anyway, leave as it is and we can fix all later.
| @@ -368,13 +368,16 @@ The values used by the quick filter are obtained by splitting with space. | |||
| If you want to implement a more advanced logic, the `<GridToolbarQuickFilter/>` component accepts a prop `quickFilterParser`. | |||
| This function takes the string from the search text field and returns an array of values. | |||
|
|
|||
| If you control the `quickFilterValues` either by controlling `filterModel` or with the initial state, you should provide a `quickFilterFormatter` which will be used to update the content of the input. | |||
There was a problem hiding this comment.
I didn't understand this part. There's a default value formatter so the user doesn't need to always pass one.
There was a problem hiding this comment.
I tried to be more explicit
packages/grid/x-data-grid/src/tests/quickFiltering.DataGrid.test.tsx
Outdated
Show resolved
Hide resolved
packages/grid/x-data-grid/src/tests/quickFiltering.DataGrid.test.tsx
Outdated
Show resolved
Hide resolved
joserodolfofreitas
pushed a commit
to joserodolfofreitas/mui-x
that referenced
this pull request
Jun 13, 2022
Co-authored-by: Matheus Wichman <matheushw@outlook.com>
alexfauquette
added a commit
to alexfauquette/mui-x
that referenced
this pull request
Aug 26, 2022
Co-authored-by: Matheus Wichman <matheushw@outlook.com>
oliviertassinari
added
the
component: data grid
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fix #4921
I assume the quick filter value is rarely modified from somewhere else. It can be reset by clicking a button, or when putting back a saved state.
From this, I propose to add a prop to the input named
quickFilterFormatter. This prop is used only if the quick filter state is updated and does not correspond anymore to the input content. In such a case, we use thisquickFilterFormatterto update the input content.