Skip to content

Commit f147d45

Browse files
authored
docs: add note about StaticMap component (#661)
1 parent 55acea2 commit f147d45

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

docs/api-reference/components/static-map.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,14 @@
33
React component and utility function to create and render [Google Static Maps][gmp-static-map] images. This implementation provides both a React component for rendering and a URL generation utility that supports all Google Static Maps API features. The main purpose of the utility function is to enable 'url-signing' in various
44
server environments.
55

6+
:::note
7+
8+
Currently, the `StaticMap` component is just a thin wrapper for a
9+
regular `img` element. This will likely change in future versions when
10+
additional features are added to static maps.
11+
12+
:::
13+
614
The main parameters to control the map are `center`,
715
`zoom`, `width` and `height`. With a plain map all of these are required for the map to show. There are cases where `center` and `zoom` can be omitted and the viewport can be automatically be determined from other data. This is the case when having markers, paths or other `visible` locations which can form an automatic bounding box for the map view.
816

0 commit comments

Comments
 (0)