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][material-ui] Revamp Composition guide #43266

Merged

Conversation

ZeeshanTamboli
Copy link
Member

@ZeeshanTamboli ZeeshanTamboli commented Aug 12, 2024

This PR addresses the feedback provided in #41590 by improving the Composition guide.

Changes by Commit

  • 1549e1f: Removed an unnecessary link to the Wrapping section in the Tooltip docs. The reference was irrelevant to the discussion about passing ref to children.
  • 66d330a: Updated the documentation to avoid instructing users on what not to do, which is more of a general React pattern issue rather than specific to Material UI. The unstable nested components pattern is covered by an ESLint rule here. Also replaced the deprecated <ListItem button /> with <ListItemButton>.
  • 0e55ea4: Revised the documentation to emphasize that the component prop accepts any React component, removing an unnecessary discussion on prop forwarding.
  • e4406bb: Corrected the demo by removing an explicit role="undefined" from Link (see docs on when it's needed), as ListItemButton which renders ButtonBase already handles the role when to prop is provided to it.

Previews

@ZeeshanTamboli ZeeshanTamboli added docs Improvements or additions to the documentation package: material-ui Specific to @mui/material labels Aug 12, 2024
@mui-bot
Copy link

mui-bot commented Aug 12, 2024

@ZeeshanTamboli
Copy link
Member Author

I am not sure who to ask for a review here.

@ZeeshanTamboli
Copy link
Member Author

Can I get a review here?

Copy link
Member

@aarongarciah aarongarciah left a comment

Choose a reason for hiding this comment

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

Very nice

docs/data/material/guides/composition/composition.md Outdated Show resolved Hide resolved
Co-authored-by: Aarón García Hervás <aaron.garcia.hervas@gmail.com>
Signed-off-by: Zeeshan Tamboli <zeeshan.tamboli@gmail.com>
@siriwatknp
Copy link
Member

I am not sure who to ask for a review here.

Sorry for the delay. For next time, if it's related to structure of the docs, please include @samuelsycamore in the review.

@ZeeshanTamboli ZeeshanTamboli merged commit 63d2dfa into mui:next Aug 19, 2024
22 checks passed
@ZeeshanTamboli ZeeshanTamboli deleted the docs-revamp-and-fix-composition-guide branch August 19, 2024 11:37
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 package: material-ui Specific to @mui/material
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants