Google Maps JavaScript API React Wrapper

!Build
!Release
!GitHub contributors

> [!IMPORTANT]
> This library has been archived.
> We recommend all users of this package to switch to the new
> @vis.gl/react-google-maps,
> which provides a collection of components and hooks and can be configured
> to be fully compatible with this package.
>
> See the migration guide
> for more details on how to switch from this package to @vis.gl/react-google-maps.

Description

Wrap React components with this library to load the Google Maps JavaScript API.

``jsx
import {Wrapper} from '@googlemaps/react-wrapper';

const MyApp = () => (



);
`

The preceding example will not render any elements unless the Google Maps JavaScript API is successfully loaded. To handle error cases and the time until load is complete, it is recommended to provide render props.

`jsx
import {Wrapper, Status} from '@googlemaps/react-wrapper';

const render = status => {
switch (status) {
case Status.LOADING:
return ;
case Status.FAILURE:
return ;
case Status.SUCCESS:
return ;
}
};

const MyApp = () => ;
`

When combining children and render props, the children will render on success and the render prop will be executed for other status values.

`tsx
import {Wrapper, Status} from '@googlemaps/react-wrapper';

const render = (status: Status): ReactElement => {
if (status === Status.FAILURE) return ;
return ;
};

const MyApp = () => (



);
`

$3

This wrapper uses [@googlemaps/js-api-loader][js_api_loader] to load the Google Maps JavaScript API. This library uses a singleton pattern and will not attempt to load the library more than once. All options accepted by [@googlemaps/js-api-loader][js_api_loader] are also accepted as props to the wrapper component.

$3

The following snippets demonstrates the usage of useRef and useEffect hooks with Google Maps.

`tsx
function MyMapComponent({
center,
zoom,
}: {
center: google.maps.LatLngLiteral;
zoom: number;
}) {
const ref = useRef();
const [map, setMap] = useState(null);

useEffect(() => {
const map = new google.maps.Map(ref.current, {center, zoom});
setMap(map);

return () => {
google.maps.event.clearInstanceListeners(map);
setMap(null);
};
}, []);

useEffect(() => {
if (!map) return;

// do something with the map instance
}, [map]);

return