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] Allow linking icons state in the URL #25053

Closed
1 task done
GabriFila opened this issue Feb 22, 2021 · 6 comments · Fixed by #30075
Closed
1 task done

[docs] Allow linking icons state in the URL #25053

GabriFila opened this issue Feb 22, 2021 · 6 comments · Fixed by #30075
Labels
docs Improvements or additions to the documentation package: icons Specific to @mui/icons priority: important This change can make a difference

Comments

@GabriFila
Copy link

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

Summary 💡

Allow reaching the MUI icon picker with the search parameter already set through chrome search engine shortcuts.

Examples 🌈

A working and useful example can be found here where you can use the shortcut to quickly access the dictionary translation of a word.

Motivation 🔦

I use a lot this library and its icons, and every time I want to search for an icon I need to search in google, then click on the page link and type the search. I know it may sound unnecessary but I believe it could be appealing and useful to some people. I would also like to work on it

Thank you

@GabriFila GabriFila added the status: waiting for maintainer These issues haven't been looked at yet by a maintainer label Feb 22, 2021
@oliviertassinari
Copy link
Member

oliviertassinari commented Feb 23, 2021

We have explored supporting the open search API in #16764. I don't think that we should do anything special for the icons. It leads me to open algolia/docsearch#769.

@oliviertassinari oliviertassinari 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 Feb 23, 2021
@oliviertassinari oliviertassinari changed the title Search engine shortcut for icon browser [docs] Search engine shortcut Feb 23, 2021
@oliviertassinari oliviertassinari changed the title [docs] Search engine shortcut [docs] Search engine shortcut (OpenSearch support) Feb 23, 2021
@GabriFila
Copy link
Author

Sorry I didn't find that issue in my search.

When I say "search engine shortcut" I'm referring to the search parameter in the url not to the OpenSearch support.

This means that the only change on the MUI docs would be to look for the URL in the parameter on component load and, if it is present, set it as value of the search text field.

The actual visible change is when using the the URL bar in Chrome.

I believe this could be useful for some, but most importantly:

  • it will not add any backend cost
  • it will not break compatibility with other browsers
  • it shouldn't take much effort to implement
  • it can be a side feature for users who know it

I proposed it only for the icon page because I believe it is the only one where it could be actually useful, since people who use MUI will probably visit it frequently and to me it seems that the icons are not indexed with Algolia (but I could be wrong)

@oliviertassinari oliviertassinari added the package: icons Specific to @mui/icons label Feb 23, 2021
@oliviertassinari oliviertassinari changed the title [docs] Search engine shortcut (OpenSearch support) [docs] Allow linking icons state in the URL Feb 23, 2021
@oliviertassinari
Copy link
Member

oliviertassinari commented Feb 23, 2021

@GabriFila Oh ok, I didn't understand your request correctly then. So you want to reproduce what https://material.io/resources/icons/ supports. 💯 for allowing to link specific icons, search, and variants with coworkers and self. I recall mentioning it with @DanailH.

@oliviertassinari oliviertassinari added the priority: important This change can make a difference label Feb 23, 2021
@GabriFila
Copy link
Author

Yes, I meant something like that 😍, could I get assigned to this issue and make a PR to add it?

Sorry, I don't know if there are specific procedures and/or requirements.

@oliviertassinari
Copy link
Member

@GabriFila Prefect, feel free to solve this pain :)

@oliviertassinari
Copy link
Member

The pain was also raised in mui/mui-x#1030 (comment) too :)

Screenshot 2021-12-17 at 14 17 39

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: icons Specific to @mui/icons priority: important This change can make a difference
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants