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

/material-icons documentation page is hard to find #17444

Closed
azz0r opened this issue Sep 16, 2019 · 6 comments · Fixed by #17558
Closed

/material-icons documentation page is hard to find #17444

azz0r opened this issue Sep 16, 2019 · 6 comments · Fixed by #17558
Labels
good first issue Great for first contributions. Enable to learn the contribution process. package: icons Specific to @mui/icons

Comments

@azz0r
Copy link

azz0r commented Sep 16, 2019

Hello,

I've been attempting to add icons to my site and I've find the process of finding the icon I need quite difficult.

Most of the material ui documentation links back to this page: https://material-ui.com/components/icons/

That page has some information on how icons work and potential issues etc, but it doesn't provide any listing of icons I can use.

I've ended up relying on sites like this: https://www.materialui.co/icons?s=load

It seems to me that the icon page on the material ui website should have functionality like this instead.

Edit: I've found https://material-ui.com/components/material-icons/ digging around more, it seems this should be easier to surface?

Thoughts?

@eps1lon
Copy link
Member

eps1lon commented Sep 16, 2019

Edit: I've found material-ui.com/components/material-icons digging around more, it seems this should be easier to surface?

It's mentioned on the page.

The goal is that the page will rank higher in search engine but it got added recently so this might take some time.

@oliviertassinari
Copy link
Member

oliviertassinari commented Sep 16, 2019

it seems this should be easier to surface?

@azz0r Right on spot! I'm all ears to proposals to improve it. I was thinking of this very problem recently but I made no progress.

#17435 changes this link to redirect to the icons search page:

bubu

@oliviertassinari oliviertassinari added the package: icons Specific to @mui/icons label Sep 16, 2019
@oliviertassinari oliviertassinari changed the title material-ui-icons documentation and listing is poor /material-icons documentation page is hard to find Sep 16, 2019
@azz0r
Copy link
Author

azz0r commented Sep 19, 2019

My personal opinion is that it would be better suited on the right hand side quick menu with a name that indicates its a way to view all icons available. Something like this:

Screenshot 2019-09-19 at 11 27 02

@oliviertassinari
Copy link
Member

@azz0r I would propose the following diff to reduce the distractions, would it help?:

diff --git a/docs/src/pages/components/icons/icons.md b/docs/src/pages/components/icons/icons.md
index 15b38f076..03d0fcae1 100644
--- a/docs/src/pages/components/icons/icons.md
+++ b/docs/src/pages/components/icons/icons.md
@@ -7,13 +7,7 @@ components: Icon, SvgIcon

 <p class="description">Guidance and suggestions for using icons with Material-UI.</p>

-A [system icon](https://material.io/design/iconography/system-icons.html) or UI icon,
-symbolizes a command, file, device, or directory.
-System icons are also used to represent common actions like trash, print, and save,
-and are commonly found in app bars, toolbars, buttons, and lists.
-Google has provided a set of [Material icons](https://material.io/tools/icons/?style=baseline) that follow these guidelines.
-
-Material-UI provides two components to render system icons: `SvgIcon` for rendering SVG paths, and `Icon` for rendering font icons.
+Material-UI provides two components to render [system icons](https://material.io/design/iconography/system-icons.html): `SvgIcon` for rendering SVG paths, and `Icon` for rendering font icons.

 ## SVG Icons

@@ -38,7 +32,7 @@ It's interesting to have the building blocks needed to implement custom icons, b

 #### Usage

-You can use the [internal search](/components/material-icons/) or [material.io/tools/icons](https://material.io/tools/icons/?style=baseline) to find a specific icon.
+You can use the [dedicated search](/components/material-icons/) (recommended) or [material.io/tools/icons](https://material.io/tools/icons/?style=baseline) to find a specific icon.
 When importing an icon, keep in mind that the names of the icons are `PascalCase`, for instance:

 - [`delete`](https://material.io/tools/icons/?icon=delete&style=baseline) is exposed as `@material-ui/icons/Delete`

@oliviertassinari
Copy link
Member

oliviertassinari commented Sep 20, 2019

@azz0r Your proposal with available icons is interesting too as I expect most people to want to use theme. Do you want to work on a pull request? :)

@oliviertassinari oliviertassinari added the good first issue Great for first contributions. Enable to learn the contribution process. label Sep 20, 2019
@croraf
Copy link
Contributor

croraf commented Sep 23, 2019

Indeed I remember that I too had the trouble of finding these icons. (but actually there wasn't a mui specific finder page before?)

I would maybe add Icons as the top level item of the leftside menu. I think this is the same proposal as the one from @azz0r

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Great for first contributions. Enable to learn the contribution process. package: icons Specific to @mui/icons
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants