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][docs] Add overlay documentation #13624

Merged
merged 5 commits into from
Jun 26, 2024

Conversation

KenanYusuf
Copy link
Contributor

@KenanYusuf KenanYusuf commented Jun 25, 2024

Adds a new section to the Data Grid documentation to cover the various overlays, including: No rows overlay, No results overlay and Loading overlay.

https://deploy-preview-13624--material-ui-x.netlify.app/x/react-data-grid/overlays/

Changes include:

  • Moved loading overlay and no rows overlay customization examples from the Custom subcomponents section to their own Overlays section
  • Updated no rows overlay customization examples to use a new MUI-made icon/illustration instead of one from another library
  • Added no results overlay documentation and customization example
  • Updated Layout documentation to use the same MUI-made icon in the auto height example

To add some more context as to why this change is being made, we are adding variants to the Loading overlay (#13293) and there didn't feel like another suitable place to document these options.

@KenanYusuf KenanYusuf changed the title Add overlay documentation [DataGrid] Add overlay documentation Jun 25, 2024
@KenanYusuf KenanYusuf 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 25, 2024
@KenanYusuf KenanYusuf changed the title [DataGrid] Add overlay documentation [DataGrid][docs] Add overlay documentation Jun 25, 2024
@mui-bot
Copy link

mui-bot commented Jun 25, 2024

docs/data/data-grid/overlays/overlays.md Outdated Show resolved Hide resolved
@cherniavskii cherniavskii added the customization: css Design CSS customizability label Jun 25, 2024
Co-authored-by: Andrew Cherniavskii <[email protected]>
Signed-off-by: Kenan Yusuf <[email protected]>
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! customization: css Design CSS customizability docs Improvements or additions to the documentation
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants