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.

Sign up for GitHub

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

Jump to bottom

[docs] Improve filtering documentation page #3437

Merged
merged 44 commits into from Jan 11, 2022
Merged

[docs] Improve filtering documentation page #3437

merged 44 commits into from Jan 11, 2022

Conversation

flaviendelangle
Copy link
Member

@flaviendelangle flaviendelangle commented Dec 15, 2021 •
edited

Doc preview

Improve demos

  • Rework the demo to have 1 demo = 1 purpose (do not control the model in other demo that ControlledFilters for instance)
  • Add a singleSelect column on the FilterOperators demo
  • In the CustomInputComponent demo, hide the input component when the operator do not need it
  • Use the same set of columns on all demo

Improve paragraph order

Before:

image

After:

I tried to order the section like follow:

  1. How an end-user can use the filters
  2. How a developer can use the built-in filters
  3. How a developer can customize its own filters
  4. Full Examples

image

@flaviendelangle flaviendelangle self-assigned this Dec 15, 2021
@oliviertassinari oliviertassinari mentioned this pull request Dec 15, 2021
Merged
@flaviendelangle flaviendelangle added the docs Improvements or additions to the documentation label Dec 16, 2021
@flaviendelangle flaviendelangle mentioned this pull request Dec 21, 2021
Merged
3 tasks
@github-actions
Copy link

This pull request has conflicts, please resolve those before we can evaluate the pull request.

@github-actions github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged label Dec 23, 2021
@github-actions github-actions bot removed the PR: out-of-date The pull request has merge conflicts and can't be merged label Jan 5, 2022
alexfauquette
alexfauquette approved these changes Jan 10, 2022
View reviewed changes
Copy link
Member

@alexfauquette alexfauquette left a comment

Choose a reason for hiding this comment

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

Another amazing doc page 🚀

m4theushw
m4theushw reviewed Jan 10, 2022
View reviewed changes
Copy link
Member

@m4theushw m4theushw left a comment

Choose a reason for hiding this comment

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

👍

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
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
docs/src/pages/components/data-grid/filtering/filtering.md Outdated Show resolved Hide resolved
flaviendelangle and others added 6 commits January 10, 2022 16:59
@flaviendelangle @m4theushw
Update docs/src/pages/components/data-grid/filtering/filtering.md
ffaf566 
Co-authored-by: Matheus Wichman <matheushw@outlook.com>
@flaviendelangle @m4theushw
Update docs/src/pages/components/data-grid/filtering/filtering.md
118c7ad 
Co-authored-by: Matheus Wichman <matheushw@outlook.com>
@flaviendelangle @m4theushw
Update docs/src/pages/components/data-grid/filtering/filtering.md
2190e5b 
Co-authored-by: Matheus Wichman <matheushw@outlook.com>
@flaviendelangle @m4theushw
Update docs/src/pages/components/data-grid/filtering/filtering.md
df27b33 
Co-authored-by: Matheus Wichman <matheushw@outlook.com>
@flaviendelangle @m4theushw
Update docs/src/pages/components/data-grid/filtering/filtering.md
0d028a3 
Co-authored-by: Matheus Wichman <matheushw@outlook.com>
@flaviendelangle
Code review: Matheus
f75b54f
flaviendelangle and others added 10 commits January 11, 2022 08:58
@flaviendelangle @m4theushw
Update packages/grid/_modules_/grid/models/gridFilterItem.ts
a98501d 
Co-authored-by: Matheus Wichman <matheushw@outlook.com>
@flaviendelangle @m4theushw
Update packages/grid/_modules_/grid/models/gridFilterOperator.ts
5600dde 
Co-authored-by: Matheus Wichman <matheushw@outlook.com>
@flaviendelangle @m4theushw
Update packages/grid/_modules_/grid/models/gridFilterOperator.ts
44841d7 
Co-authored-by: Matheus Wichman <matheushw@outlook.com>
@flaviendelangle @m4theushw
Update packages/grid/_modules_/grid/models/gridFilterOperator.ts
d0344dc 
Co-authored-by: Matheus Wichman <matheushw@outlook.com>
@flaviendelangle @m4theushw
Update packages/grid/_modules_/grid/models/gridFilterOperator.ts
e3c710d 
Co-authored-by: Matheus Wichman <matheushw@outlook.com>
@flaviendelangle @m4theushw
Update packages/grid/_modules_/grid/models/gridFilterItem.ts
02a08b9 
Co-authored-by: Matheus Wichman <matheushw@outlook.com>
@flaviendelangle
Update filtering.md
4abd8e4
@flaviendelangle
Empty
5359e72
@flaviendelangle
Code review: Matheus
1497d0a
@flaviendelangle
Work
aa56573
@flaviendelangle flaviendelangle merged commit c3bbe9a into mui:master Jan 11, 2022
@flaviendelangle flaviendelangle deleted the filter-doc branch January 11, 2022 11:18
@zromick
Copy link

zromick commented Mar 3, 2022

Missing a word or two here: https://mui.com/components/data-grid/filtering/#:~:text=filterItem.operatorValue,key%20of

@flaviendelangle
Copy link
Member Author

Indeed, #4079

@flaviendelangle flaviendelangle mentioned this pull request Mar 3, 2022
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@m4theushw m4theushw m4theushw approved these changes

@joserodolfofreitas joserodolfofreitas joserodolfofreitas approved these changes

@alexfauquette alexfauquette alexfauquette approved these changes

Assignees

@flaviendelangle flaviendelangle

Labels
docs Improvements or additions to the documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
5 participants
@flaviendelangle @zromick @joserodolfofreitas @m4theushw @alexfauquette