Skip to content

Commit 746a108

Browse files
committed
docs(useStreetViewPanorama): add map instance note to readme
1 parent dbf1e94 commit 746a108

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

library/docs/useStreetViewPanorama.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@ const [divContainer, setDivContainer] = useState<HTMLDivElement | null>(null);
3939

4040
or be created on its own to be used by the map:
4141

42+
4243
```tsx
4344
import React, {useEffect} from 'react';
4445
import {
@@ -58,6 +59,9 @@ const MyComponent = () => {
5859
return null;
5960
};
6061
```
62+
**NOTE**:
63+
The map instance is only created and can be used with the `useStreetViewPanorama` hook when the `mapContainer` is passed to the `GoogleMapsProvider`.
64+
6165

6266
## Return value
6367

@@ -71,7 +75,7 @@ google.maps.StreetViewPanorama
7175

7276
### StreetViewPanoramaProps
7377

74-
Optional options that can be passed to display a street view location: [Street View Locations and Point-of-View(POV)](https://developers.google.com/maps/documentation/javascript/streetview#StreetViewLocation).
78+
Optional options that can be passed to display a street view location: [Street View Locations and Point-of-View (POV)](https://developers.google.com/maps/documentation/javascript/streetview#StreetViewLocation).
7579

7680
```TypeScript
7781
interface StreetViewPanoramaProps {

0 commit comments

Comments
 (0)