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] Explain the icons package dependencies #33592

Merged
merged 3 commits into from Aug 12, 2022

Conversation

michaldudak
Copy link
Member

@michaldudak michaldudak commented Jul 20, 2022

A follow-up on the comment: #33311 (comment)

This PR adds an explanation of the dependencies of @mui/icons-material.

Preview: https://deploy-preview-33592--material-ui.netlify.app/material-ui/material-icons/

@michaldudak michaldudak added the docs Improvements or additions to the documentation label Jul 20, 2022
@mui-bot
Copy link

mui-bot commented Jul 20, 2022

No bundle size changes

Generated by 🚫 dangerJS against 8216a23

@samuelsycamore
Copy link
Member

Definitely an improvement! Do you think the icons should get full installation instructions that are formatted more like those on https://mui.com/material-ui/getting-started/installation/ ? With npm and yarn code snippets etc. They can be on this page, but I think it would be more consistent overall that way.

@michaldudak
Copy link
Member Author

How about linking to the Getting started page?

Something along these lines, for example:

If you don't use Material UI in your project yet, install the icons package with npm install @mui/icons-material @mui/material @emotion/styled @emotion/react. See Getting started for additional docs about how to make sure everything is set up correctly.

@samuelsycamore
Copy link
Member

How about linking to the Getting started page?

Something along these lines, for example:

If you don't use Material UI in your project yet, install the icons package with npm install @mui/icons-material @mui/material @emotion/styled @emotion/react. See Getting started for additional docs about how to make sure everything is set up correctly.

That's a good idea!

@michaldudak michaldudak merged commit 76eb1da into mui:master Aug 12, 2022
@michaldudak michaldudak deleted the material-icons-dependency branch August 12, 2022 07:20
daniel-rabe pushed a commit to daniel-rabe/material-ui that referenced this pull request Nov 29, 2022
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants