Skip to content

Commit 48c119b

Browse files
authored
Update usePlacesWidget docs for returned value
1 parent b9ffbd7 commit 48c119b

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

README.md

+7
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,13 @@ export default () => {
110110

111111
It has only one config argument which has propperties: `apiKey`, `ref`, `onPlaceSelected`, `options`, `inputAutocompleteValue`, `googleMapsScriptBaseUrl`. The same props described [here](#reactgoogleautocomplete)
112112

113+
### Returned value
114+
115+
This hook returns object with only two properties:
116+
117+
- `ref` - is a react ref which you can assign to any input you would like.
118+
- `autocompleteRef` - is the [autocomplete](https://developers.google.com/maps/documentation/javascript/reference/places-widget#Autocomplete) instance
119+
113120
## usePlacesAutocompleteService
114121

115122
![](https://img.badgesize.io/ErrorPro/react-google-autocomplete/master/lib/usePlacesAutocompleteService.js?compression=brotli&label=brotli)

0 commit comments

Comments
 (0)