Skip to content
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

[docs] Start documentation for the data grid filter features #754

Merged
merged 22 commits into from Dec 21, 2020

Conversation

dtassone
Copy link
Member

@dtassone dtassone commented Dec 16, 2020

Related to #201

WIP structure:

# Data Grid - Filtering

## Column filters

By default, when filtering is enabled.

### Basic filter

Per-column with 3 types: string, number, date/time.

<DataGrid /> open by default for the demo, enabled by default.

### Disable filter

- globally

<DataGrid />

- per column filterable: boolean

<DataGrid />

Benchmark
https://master--material-ui-x.netlify.app/components/data-grid/rows/#disable-sorting
https://ag-grid.com/javascript-grid-filtering/#configuring-filters-on-columns

### Custom filter operator

Demo ideas with Airtable rating ⭐️⭐️⭐️⭐️ or slider progress/quantity.

<DataGrid />

Benchmark
https://www.telerik.com/kendo-react-ui/components/grid/filtering/#toc-custom-filter-operators
https://devexpress.github.io/devextreme-reactive/react/grid/docs/guides/filtering/#custom-filter-operations

### Toolbar

How to enable and use the toolbar

### Server-side filter

<DataGrid />

Benchmark
https://master--material-ui-x.netlify.app/components/data-grid/rows/#server-side-sorting
https://devexpress.github.io/devextreme-reactive/react/grid/docs/guides/filtering/#remote-filtering

### Controlled filtering

<DataGrid />

https://master--material-ui-x.netlify.app/components/data-grid/pagination/#controlled-pagination

### Multi-filtering ⚡️

<XGrid />

### apiRef ⚡️

https://master--material-ui-x.netlify.app/components/data-grid/rows/#apiref

## Quick filter

@oliviertassinari oliviertassinari added the docs Improvements or additions to the documentation label Dec 16, 2020
@oliviertassinari oliviertassinari changed the title [Docs] Filter documentation [docs] Add docs for the data grid filter features Dec 16, 2020
Copy link
Member

@oliviertassinari oliviertassinari left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great start, I really appreciate that have you split the work into multiple chunks! It seems that you have focused here on doing half of the structure drawn in #644 :)

  • We can remove the 🚧 icon liked to the filtering feature: in the side nav and in the feature comparison

Capture d’écran 2020-12-16 à 19 50 19

  • One of the new demo turns my CPU into a 🍳 maker

Capture d’écran 2020-12-16 à 20 12 04

docs/src/pages/components/data-grid/filtering/filtering.md Outdated Show resolved Hide resolved

## 🚧 Quick filter
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why remove this section? Don't we still want to implement quick filtering?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes but we can add it later...

Just wanted to cleanup the page, but I can put it back, not an issue :)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

From my perspective, it depends on the following: do we want to implement this feature no matter what, and do we think it's important?

If the answer is yes to these two conditions, then I think we should keep linking the issue so we can use it to prioritize the roadmap. If the answer is no, then we probably want to remove the link, to no skewed the 👍 on the linked issue more.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could also add a new page with all the issues in progress so ppl can upvote issues from a central location

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

a new page with all the issues in progress

I think it's the option 2 mentioned before. We have this page, it's GitHub's issues, that we could maybe link a bit better, by mentioning it in the roadmap page: https://material-ui.com/discover-more/roadmap/.

docs/src/pages/components/data-grid/filtering/filtering.md Outdated Show resolved Hide resolved
docs/src/pages/components/data-grid/filtering/filtering.md Outdated Show resolved Hide resolved
docs/src/pages/components/data-grid/filtering/filtering.md Outdated Show resolved Hide resolved
@dtassone
Copy link
Member Author

Great start, I really appreciate that have you split the work into multiple chunks! It seems that you have focused here on doing half of the structure drawn in #644 :)

  • We can remove the 🚧 icon liked to the filtering feature: in the side nav and in the feature comparison
Capture d’écran 2020-12-16 à 19 50 19
  • One of the new demo turns my CPU into a 🍳 maker
Capture d’écran 2020-12-16 à 20 12 04

Yes I noticed some issues as well but it does not seem to occur all the time, I'm investigating

@oliviertassinari oliviertassinari changed the title [docs] Add docs for the data grid filter features [docs] Start documentation for the data grid filter features Dec 18, 2020
@oliviertassinari oliviertassinari merged commit 3f704d0 into mui:master Dec 21, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants