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] Fix internal link to valueParser #5450

Merged
merged 1 commit into from
Jul 25, 2022

Conversation

alexfauquette
Copy link
Member

Fix #5176

@mui-bot
Copy link

mui-bot commented Jul 11, 2022

These are the results for the performance tests:

Test case Unit Min Max Median Mean σ
Filter 100k rows ms 288.5 513 446.1 414.08 76.849
Sort 100k rows ms 578.5 1,065 771.8 854.54 169.667
Select 100k rows ms 141.1 295.7 220.4 220.02 55.254
Deselect 100k rows ms 111.2 241.1 146.7 173.64 52.069

Generated by 🚫 dangerJS against 0ddc502

@alexfauquette alexfauquette added the docs Improvements or additions to the documentation label Jul 11, 2022
@alexfauquette alexfauquette merged commit 0c6082d into mui:master Jul 25, 2022
@alexfauquette alexfauquette deleted the fix-doc-link branch July 25, 2022 06:36
@@ -73,7 +73,7 @@ In the following demo, a formatter is used to display the tax rate's decimal val

The value generated is only used for rendering purposes.
Filtering and sorting do not rely on the formatted value.
Use the [`valueParser`](/x/react-data-grid/cells/#value-parser) to support filtering.
Use the [`valueParser`](/x/react-data-grid/editing/#value-parser-and-value-setter) to support filtering.
Copy link
Member

@oliviertassinari oliviertassinari Jul 25, 2022

Choose a reason for hiding this comment

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

I think that it's a bit confusing. We say, use the value parser to implement customer filtering input value parser

Screenshot 2022-07-25 at 13 13 11

and then link people to a different feature: edition, which is not filtering.

Maybe it would make sense to have the same section in the documentation as https://mui.com/x/react-data-grid/filtering/#parsing-values but for the column 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.

I remind that during the first months, I found parser, getter, formatted and setter quite confusing and open #3215

What would you think about a dedicated page for them to provide an overview of how data is transformed like proposed in #3215 ?

Copy link
Member

@oliviertassinari oliviertassinari Jul 25, 2022

Choose a reason for hiding this comment

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

Flavien had commented a bit on this problem in #4956 (comment). I guess the demo in https://mui.com/x/react-data-grid/column-definition/#value-formatter is a good illustration of the need for valueParser. When you search for 20 you get no results 🙃. Link it here

The chart #3215 (comment) helps understand how this works 👍 . It could help to have documentation about it. The tricky part might be, how do we have developers find it when they need it?

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.

Broken link to valueParser
4 participants