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] Add Performance section for Modal #23168

Merged
merged 6 commits into from
Oct 20, 2020
Merged

[docs] Add Performance section for Modal #23168

merged 6 commits into from
Oct 20, 2020

Conversation

jaebradley
Copy link
Contributor

@jaebradley jaebradley commented Oct 19, 2020

Summary

Closes #21987.

I did not add a Performance section as mentioned in the discussion in the issue, but rather, simply added some guidance in the Temporary drawer section.

Happy to move this around and adjust as needed (like adding an explicit demo).

image

@mui-pr-bot
Copy link

mui-pr-bot commented Oct 19, 2020

Details of bundle changes

Generated by 🚫 dangerJS against cb1e261

@oliviertassinari oliviertassinari added component: modal This is the name of the generic UI component, not the React module! docs Improvements or additions to the documentation labels Oct 19, 2020
Copy link
Member

@eps1lon eps1lon left a comment

Choose a reason for hiding this comment

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

We should include an example here. Mounting/unmounting is not something that will matter long term with regards to data fetching so this section might become outdated. By including the use case we're not letting people guess what this might be useful for.

@oliviertassinari oliviertassinari changed the title [docs] Add ModalProps documentation to Drawer demo [docs] Add Performance section for Modal Oct 19, 2020
Copy link
Member

@eps1lon eps1lon left a comment

Choose a reason for hiding this comment

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

That's helpful!

@oliviertassinari oliviertassinari merged commit 94963a2 into mui:next Oct 20, 2020
@oliviertassinari
Copy link
Member

@jaebradley Thanks!

@jaebradley jaebradley deleted the issue-21987-add-modal-props-documentation-to-drawer-demo branch October 20, 2020 19:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component: modal This is the name of the generic UI component, not the React module! docs Improvements or additions to the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Allow persistent Drawer to display overlay - or allow temporary drawer to remain in DOM while hidden
4 participants