-
-
Notifications
You must be signed in to change notification settings - Fork 1.4k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[DataGrid] Allow to filter non-filterable columns programmatically #11538
Merged
Merged
Changes from 4 commits
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
f876266
[DataGrid] Introduce read-only filters
MBilalShafi 0197ca8
Fix issue of not initializing operator
MBilalShafi 73ec029
Add tests and run proptypes
MBilalShafi bd97d9b
Fix the test for JSDom
MBilalShafi 02174e6
Merge branch 'next' into fix-10552/filterable
MBilalShafi 2fbdec1
Update documentation
MBilalShafi c2f354c
Use filterableColumnsLookup
MBilalShafi 1aeb33a
Merge branch 'next' into fix-10552/filterable
MBilalShafi 243ae70
docs:api
MBilalShafi fd6b776
Update docs/data/data-grid/filtering/index.md
MBilalShafi 19386b1
Merge branch 'next' into fix-10552/filterable
MBilalShafi 81497f6
:(
MBilalShafi File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
import * as React from 'react'; | ||
import { DataGrid, GridToolbar } from '@mui/x-data-grid'; | ||
import { useDemoData } from '@mui/x-data-grid-generator'; | ||
|
||
const VISIBLE_FIELDS = ['name', 'rating', 'country', 'dateCreated', 'isAdmin']; | ||
|
||
export default function ReadOnlyFilters() { | ||
const { data } = useDemoData({ | ||
dataSet: 'Employee', | ||
visibleFields: VISIBLE_FIELDS, | ||
rowLength: 100, | ||
}); | ||
|
||
const columns = React.useMemo( | ||
() => | ||
data.columns.map((column) => ({ | ||
...column, | ||
filterable: column.field !== 'name', | ||
})), | ||
[data.columns], | ||
); | ||
|
||
const [filterModel, setFilterModel] = React.useState({ | ||
items: [ | ||
{ | ||
field: 'name', | ||
operator: 'contains', | ||
value: 'a', | ||
}, | ||
], | ||
}); | ||
|
||
return ( | ||
<div style={{ height: 400, width: '100%' }}> | ||
<DataGrid | ||
{...data} | ||
columns={columns} | ||
slots={{ | ||
toolbar: GridToolbar, | ||
}} | ||
filterModel={filterModel} | ||
onFilterModelChange={(newFilterModel) => setFilterModel(newFilterModel)} | ||
/> | ||
</div> | ||
); | ||
} |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
import * as React from 'react'; | ||
import { DataGrid, GridFilterModel, GridToolbar } from '@mui/x-data-grid'; | ||
import { useDemoData } from '@mui/x-data-grid-generator'; | ||
|
||
const VISIBLE_FIELDS = ['name', 'rating', 'country', 'dateCreated', 'isAdmin']; | ||
|
||
export default function ReadOnlyFilters() { | ||
const { data } = useDemoData({ | ||
dataSet: 'Employee', | ||
visibleFields: VISIBLE_FIELDS, | ||
rowLength: 100, | ||
}); | ||
|
||
const columns = React.useMemo( | ||
() => | ||
data.columns.map((column) => ({ | ||
...column, | ||
filterable: column.field !== 'name', | ||
})), | ||
[data.columns], | ||
); | ||
|
||
const [filterModel, setFilterModel] = React.useState<GridFilterModel>({ | ||
items: [ | ||
{ | ||
field: 'name', | ||
operator: 'contains', | ||
value: 'a', | ||
}, | ||
], | ||
}); | ||
|
||
return ( | ||
<div style={{ height: 400, width: '100%' }}> | ||
<DataGrid | ||
{...data} | ||
columns={columns} | ||
slots={{ | ||
toolbar: GridToolbar, | ||
}} | ||
filterModel={filterModel} | ||
onFilterModelChange={(newFilterModel) => setFilterModel(newFilterModel)} | ||
/> | ||
</div> | ||
); | ||
} |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
<DataGrid | ||
{...data} | ||
columns={columns} | ||
slots={{ | ||
toolbar: GridToolbar, | ||
}} | ||
filterModel={filterModel} | ||
onFilterModelChange={(newFilterModel) => setFilterModel(newFilterModel)} | ||
/> |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -103,6 +103,26 @@ You can use the `onFilterModelChange` prop to listen to changes to the filters a | |
|
||
{{"demo": "ControlledFilters.js", "bg": "inline", "defaultCodeOpen": false}} | ||
|
||
### Read-only filters | ||
|
||
You can initialize the `filterModel`, set the `filterModel` prop, or use `apiRef.current.setFilterModel` to define the filters for columns with `colDef.filterable` set to `false`. These filters will be applied but the user won't be able to change them. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. A small possible positive side effect would be this kind of filtering will now be possible in read-only mode without tweaking |
||
|
||
```jsx | ||
const columns = [ | ||
{ field: 'name', filterable: false }, | ||
...otherColumns, | ||
] | ||
|
||
<DataGrid | ||
filterModel={{ | ||
items: [{ field: 'name', operator: 'contains', value: 'a' }], | ||
}} | ||
columns={columns} | ||
/> | ||
``` | ||
|
||
{{"demo": "ReadOnlyFilters.js", "bg": "inline", "defaultCodeOpen": false}} | ||
|
||
## Disable the filters | ||
|
||
### For all columns | ||
|
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
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
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
9 changes: 4 additions & 5 deletions
9
packages/grid/x-data-grid-pro/src/components/headerFiltering/GridHeaderFilterClearButton.tsx
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
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Since the MIT Grid allows one filter at a max, I have allowed clearing the read-only filter by adding a filter on another column. Users can prevent this by controlling the filter and not updating the
filterModel
onfilterModelChange
.