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

[data grid] Use multiple tabs instead of package for mock data set #13110

Closed
joserodolfofreitas opened this issue May 13, 2024 · 2 comments · Fixed by #13695
Closed

[data grid] Use multiple tabs instead of package for mock data set #13110

joserodolfofreitas opened this issue May 13, 2024 · 2 comments · Fixed by #13695
Labels
component: data grid This is the name of the generic UI component, not the React module! docs Improvements or additions to the documentation dx Related to developers' experience

Comments

@joserodolfofreitas
Copy link
Member

joserodolfofreitas commented May 13, 2024

Summary

To enhance transparency and devEx, I propose replacing the current dataset mocker package (x-data-grid-generator) with a more direct, user-friendly approach: we leverage the new "multi-tabs" feature of our docs-infra to embed the code snippets directly within the docs in a separate tab, so we don't pollute the main aspects of the code.

This will allow users to view, copy, and paste relevant code easily. The change aims to simplify the user experience by making code samples more accessible and reducing dependencies on external packages.

Motivation

  • Often users can't find the examples they are looking for within our docs (Like renderCountry and renderRating, which are hidden behind the package)
  • useDemoData is top1 of searches without a hit on our docs
image

Search keywords:

@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! dx Related to developers' experience labels May 13, 2024
@joserodolfofreitas joserodolfofreitas moved this to 🆕 Needs refinement in MUI X Data Grid May 13, 2024
@joserodolfofreitas
Copy link
Member Author

The docs-infra team is working on a way to reuse tabs/resources in different examples.
We should wait until this is ready to replace useDemoData.

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.

@DanailH DanailH moved this from 🏗 In progress to ✅ Done in MUI X Data Grid Nov 1, 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 dx Related to developers' experience
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

1 participant