search

mui / material-ui

Material UI: Ready-to-use foundational React components, free forever. It includes Material UI, which implements Google's Material Design.
https://mui.com/material-ui/
MIT License
92.44k stars 31.85k forks source link

[docs][material-ui][Autocomplete] Google Maps autocomplete demo missing instructions about `autosuggest-highlight` dependency #42567

Open wbt opened 4 weeks ago

wbt commented 4 weeks ago

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

mnajdova commented 2 weeks ago

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

wbt commented 2 weeks ago

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.