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

[DataGrid] Add "Custom columns" page to the docs #9270

Closed
joserodolfofreitas opened this issue Jun 8, 2023 · 4 comments · Fixed by #13695
Closed

[DataGrid] Add "Custom columns" page to the docs #9270

joserodolfofreitas opened this issue Jun 8, 2023 · 4 comments · Fixed by #13695
Assignees
Labels
component: data grid This is the name of the generic UI component, not the React module! docs Improvements or additions to the documentation

Comments

@joserodolfofreitas
Copy link
Member

joserodolfofreitas commented Jun 8, 2023

Summary

It's a recurrent pain point that users try to find some of our column implementations used in the demos and can't find them behind the data grid generator, also we have no "targetted" page where users can quickly find some good examples of custom columns and how to implement it. "Rendering cells" is under column definition.

We need to improve the discoverability and better showcase good examples of custom columns like the star-rate component, date picker and now also the sparklines.

Proposal

A new page under the Columns menu with:

  • a showcase of star-rate component reviewing important APIs used (like renderCell, valueFormatter and etc.)
  • a showcase of sparklines integration with any needed additional concepts
  • a showcase of date pickers integration with any needed additional concepts
  • a Data Grid demo that doesn't use the data generator and showcases exclusively custom columns (star rate, progress bar, link, currency, sparklines and etc).
@joserodolfofreitas joserodolfofreitas added docs Improvements or additions to the documentation component: data grid This is the name of the generic UI component, not the React module! labels Jun 8, 2023
@github-project-automation github-project-automation bot moved this to 🆕 Needs refinement in MUI X Data Grid Jun 8, 2023
@joserodolfofreitas joserodolfofreitas changed the title [DataGrid] Add custom columns page [DataGrid] Add "Custom columns" page to the docs. Jun 8, 2023
@flaviendelangle
Copy link
Member

a showcase of date pickers integration with any needed additional concepts

Would you keep the "editing with date picker" recipe as well or would it be removed ?

@joserodolfofreitas
Copy link
Member Author

Would you keep the "editing with date picker" recipe as well or would it be removed ?

I don't see a reason to remove it. There's always the argument of maintainability, but I think it's a small case that doesn't hurt.

@cherniavskii
Copy link
Member

a showcase of star-rate component reviewing important APIs used (like renderCell, valueFormatter and etc.)

I think we already have a demo for this one in https://mui.com/x/react-data-grid/editing/#create-your-own-edit-component
We can reuse it in the Columns docs group as well.

a showcase of date pickers integration with any needed additional concepts

For this one we can reuse https://mui.com/x/react-data-grid/recipes-editing/#usage-with-mui-x-date-pickers

a Data Grid demo that doesn't use the data generator and showcases exclusively custom columns (star rate, progress bar, link, currency, sparklines and etc).

Filled quantity seems to be a particularly interesting example:

@cherniavskii cherniavskii moved this from 🆕 Needs refinement to 🔖 Ready in MUI X Data Grid Jun 20, 2023
@oliviertassinari oliviertassinari changed the title [DataGrid] Add "Custom columns" page to the docs. [DataGrid] Add "Custom columns" page to the docs Dec 5, 2023
@arminmeh arminmeh self-assigned this Jun 26, 2024
@arminmeh arminmeh moved this from 🔖 Ready to 🏗 In progress in MUI X Data Grid Jun 27, 2024
Copy link

This issue has been closed. If you have a similar problem but not exactly the same, please open a new issue.
Now, if you have additional information related to this issue or things that could help future readers, feel free to leave a comment.

@arminmeh arminmeh moved this from 🏗 In progress to ✅ Done in MUI X Data Grid Sep 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component: data grid This is the name of the generic UI component, not the React module! docs Improvements or additions to the documentation
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

4 participants