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][Autocomplete] Google Maps autocomplete demo missing instructions about autosuggest-highlight dependency #42567

Closed
wbt opened this issue Jun 7, 2024 · 2 comments · Fixed by #42837
Assignees
Labels
component: autocomplete This is the name of the generic UI component, not the React module! docs Improvements or additions to the documentation good first issue Great for first contributions. Enable to learn the contribution process. package: material-ui Specific to @mui/material ready to take Help wanted. Guidance available. There is a high chance the change will be accepted support: docs-feedback Feedback from documentation page

Comments

@wbt
Copy link
Contributor

wbt commented Jun 7, 2024

Related page

https://mui.com/material-ui/react-autocomplete/#google-maps-place

Kind of issue

Missing information

Issue description

The sample code at https://mui.com/material-ui/react-autocomplete/#google-maps-place fails compilation with three errors, that all boil down to a missing dependency.

This could be effectively fixed by copying the same first sentence found under "Highlights:" ("The following demo relies on autosuggest-highlight, a small (1 kB) utility for highlighting text in autosuggest and autocomplete components.") to the description.

Context

This is useful to be able to run the example more or less as published, with one's own API key as is already made clear.

Search keywords: maps autosuggest-highlight implied implicit any

@wbt wbt added status: waiting for maintainer These issues haven't been looked at yet by a maintainer support: docs-feedback Feedback from documentation page labels Jun 7, 2024
@zannager zannager added the component: autocomplete This is the name of the generic UI component, not the React module! label Jun 10, 2024
@mnajdova
Copy link
Member

Right, makes sense. Would you be up to opening a PR for this?

@mnajdova mnajdova added ready to take Help wanted. Guidance available. There is a high chance the change will be accepted and removed status: waiting for maintainer These issues haven't been looked at yet by a maintainer labels Jun 18, 2024
@wbt
Copy link
Contributor Author

wbt commented Jun 19, 2024

I'm not sure; the barrier seems somewhat high to PRs that are considered valuable in this repo, which leads me to a high degree of uncertainty in my estimate about the low amount of time/effort fixing this seems like it should take.

I'm willing to provide the feedback that sets out a clear path to improvement, but the extra hours of unpaid effort for uncertain outcomes don't seem likely to reach a top priority for me in the near future. If someone else wants to take it on, or help fix open-source's broken funding model here, that's fine with me. Otherwise, I might get to it eventually, but it won't be today.

@mj12albert mj12albert changed the title Maps autocomplete example documentation incomplete [docs][Autocomplete] Maps autocomplete example documentation incomplete Jun 24, 2024
@mj12albert mj12albert added the good first issue Great for first contributions. Enable to learn the contribution process. label Jun 24, 2024
@mj12albert mj12albert changed the title [docs][Autocomplete] Maps autocomplete example documentation incomplete [docs][Autocomplete] Google Maps autocomplete demo missing instructions about autosuggest-highlight dependency Jun 24, 2024
HoFa1997 added a commit to HoFa1997/material-ui that referenced this issue Jul 3, 2024
@ZeeshanTamboli ZeeshanTamboli added docs Improvements or additions to the documentation package: material-ui Specific to @mui/material labels Jul 4, 2024
@ZeeshanTamboli ZeeshanTamboli changed the title [docs][Autocomplete] Google Maps autocomplete demo missing instructions about autosuggest-highlight dependency [docs][material-ui][Autocomplete] Google Maps autocomplete demo missing instructions about autosuggest-highlight dependency Jul 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component: autocomplete This is the name of the generic UI component, not the React module! docs Improvements or additions to the documentation good first issue Great for first contributions. Enable to learn the contribution process. package: material-ui Specific to @mui/material ready to take Help wanted. Guidance available. There is a high chance the change will be accepted support: docs-feedback Feedback from documentation page
Projects
None yet
5 participants