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

Add @mui/icons-material as default on Installation page (Docs) #28517

Closed
1 task done
igorradovanov opened this issue Sep 21, 2021 · 1 comment
Closed
1 task done

Add @mui/icons-material as default on Installation page (Docs) #28517

igorradovanov opened this issue Sep 21, 2021 · 1 comment
Labels
docs Improvements or additions to the documentation

Comments

@igorradovanov
Copy link

  • I have searched the issues of this repository and believe that this is not a duplicate.

Summary 💡

Many component demos are using the Icons and for new users, this can be confusing because the default list of dependencies does not include the installation of the @mui/icons-material module:

// with npm
npm install @mui/material @emotion/react @emotion/styled

// with yarn
yarn add @mui/material @emotion/react @emotion/styled

Examples 🌈

When a user tries to use a demo component, they will be presented with the next error due that @mui/icons-material is not installed by default:

image

Motivation 🔦

I think this will improve the docs and onboarding of new users.

@igorradovanov igorradovanov added the status: waiting for maintainer These issues haven't been looked at yet by a maintainer label Sep 21, 2021
@mnajdova
Copy link
Member

Thanks for the feedback. We have a section for icons just below that one, here is the one specific to the SVG icons - https://next.material-ui.com/getting-started/installation/#svg-icons

It's riskier to add it in the default installation command, as people may consider it required in order for the material components to be used.

@mnajdova mnajdova added docs Improvements or additions to the documentation and removed status: waiting for maintainer These issues haven't been looked at yet by a maintainer labels Sep 21, 2021
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

No branches or pull requests

2 participants