Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fullstackreact/google-maps-react
Companion code to the "How to Write a Google Maps React Component" Tutorial
https://github.com/fullstackreact/google-maps-react
google google-api google-maps googlemap react
Last synced: 3 days ago
JSON representation
Companion code to the "How to Write a Google Maps React Component" Tutorial
- Host: GitHub
- URL: https://github.com/fullstackreact/google-maps-react
- Owner: fullstackreact
- License: mit
- Created: 2016-04-25T19:42:01.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2023-01-18T13:02:12.000Z (about 2 years ago)
- Last Synced: 2025-01-15T23:06:29.424Z (10 days ago)
- Topics: google, google-api, google-maps, googlemap, react
- Language: JavaScript
- Homepage: https://www.fullstackreact.com/articles/how-to-write-a-google-maps-react-component/
- Size: 1.36 MB
- Stars: 1,636
- Watchers: 37
- Forks: 817
- Open Issues: 295
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-react-cn - google-maps-react - A declarative Google Map React component using React, lazy-loading dependencies, current-location finder and a test-driven approach by the Fullstack React team. (Uncategorized / Uncategorized)
- awesome-react - google-maps-react - A declarative Google Map React component using React, lazy-loading dependencies, current-location finder and a test-driven approach by the Fullstack React team.
- awesome-learning-resources - google-maps-react - A declarative Google Map React component using React, lazy-loading dependencies, current-location finder and a test-driven approach by the Fullstack React team. (Uncategorized / Uncategorized)
- awesome-list - google-maps-react
- awesome-react - google-maps-react - Companion code to the 'How to Write a Google Maps React Component' Tutorial ` 📝 a year ago` (React [🔝](#readme))
- jimsghstars - fullstackreact/google-maps-react - Companion code to the "How to Write a Google Maps React Component" Tutorial (JavaScript)
README
# Google Map React Component Tutorial [](https://www.fullstackreact.com)
> A declarative Google Map React component using React, lazy-loading dependencies, current-location finder and a test-driven approach by the [Fullstack React](https://fullstackreact.com) team.
See the [demo](https://fullstackreact.github.io/google-maps-react) and [accompanying blog post](https://www.fullstackreact.com/articles/how-to-write-a-google-maps-react-component/).
## Quickstart
First, install the library:
```shell
npm install --save google-maps-react
```
## Automatically Lazy-loading Google API
The library includes a helper to wrap around the Google maps API. The `GoogleApiWrapper` Higher-Order component accepts a configuration object which *must* include an `apiKey`. See [lib/GoogleApi.js](https://github.com/fullstackreact/google-maps-react/blob/master/src/lib/GoogleApi.js#L4) for all options it accepts.
```javascript
import {GoogleApiWrapper} from 'google-maps-react';
// ...
export class MapContainer extends React.Component {}
export default GoogleApiWrapper({
apiKey: (YOUR_GOOGLE_API_KEY_GOES_HERE)
})(MapContainer)
```
Alternatively, the `GoogleApiWrapper` Higher-Order component can be configured by passing a function that will be called with whe wrapped component's `props` and should returned the configuration object.
```javascript
export default GoogleApiWrapper(
(props) => ({
apiKey: props.apiKey,
language: props.language,
}
))(MapContainer)
```
If you want to add a loading container _other than the default_ loading container, simply pass it in the HOC, like so:
```javascript
const LoadingContainer = (props) => (
Fancy loading container!
)
export default GoogleApiWrapper({
apiKey: (YOUR_GOOGLE_API_KEY_GOES_HERE),
LoadingContainer: LoadingContainer
})(MapContainer)
```
## Sample Usage With Lazy-loading Google API:
```javascript
import {Map, InfoWindow, Marker, GoogleApiWrapper} from 'google-maps-react';
export class MapContainer extends Component {
render() {
return (
{this.state.selectedPlace.name}
);
}
}
export default GoogleApiWrapper({
apiKey: (YOUR_GOOGLE_API_KEY_GOES_HERE)
})(MapContainer)
```
*Note: [Marker](#marker) and [InfoWindow](#infowindow--sample-event-handler-functions) components are disscussed below.*
## Examples
Check out the example site at: [http://fullstackreact.github.io/google-maps-react](http://fullstackreact.github.io/google-maps-react)
## Additional Map Props
The Map component takes a number of optional props.
Zoom: (Shown Above) takes a number with the higher value representing a tighter focus on the map's center.
Style: Takes CSS style object - commonly width and height.
```javascript
const style = {
width: '100%',
height: '100%'
}
```
Container Style: Takes CSS style object - optional, commonly when you want to change from the default of position "absolute".
```javascript
const containerStyle = {
position: 'relative',
width: '100%',
height: '100%'
}
```
```javascript
```
center: Takes an object containing latitude and longitude coordinates. Use this if you want to re-render the map after the initial render.
```javascript
```
bounds: Takes a [google.maps.LatLngBounds()](https://developers.google.com/maps/documentation/javascript/reference/3/#LatLngBounds) object to adjust the center and zoom of the map.
```javascript
var points = [
{ lat: 42.02, lng: -77.01 },
{ lat: 42.03, lng: -77.02 },
{ lat: 41.03, lng: -77.04 },
{ lat: 42.05, lng: -77.02 }
]
var bounds = new this.props.google.maps.LatLngBounds();
for (var i = 0; i < points.length; i++) {
bounds.extend(points[i]);
}
return (
);
```
The following props are boolean values for map behavior:
`scrollwheel`, `draggable`, `keyboardShortcuts`, `disableDoubleClickZoom`
The following props are boolean values for presence of controls on the map:
`zoomControl`, `mapTypeControl`, `scaleControl`, `streetViewControl`, `panControl`, `rotateControl`, `fullscreenControl`
The following props are object values for control options such as placement of controls on the map:
`zoomControlOptions`, `mapTypeControlOptions`, `streetViewControlOptions`
See Google Maps [Controls](https://developers.google.com/maps/documentation/javascript/controls) for more information.
It also takes event handlers described below:
### Events
The `` component handles events out of the box. All event handlers are optional.
#### onReady
When the `` instance has been loaded and is ready on the page, it will call the `onReady` prop, if given. The `onReady` prop is useful for fetching places or using the autocomplete API for places.
```javascript
fetchPlaces(mapProps, map) {
const {google} = mapProps;
const service = new google.maps.places.PlacesService(map);
// ...
}
render() {
return (
)
}
```
#### onClick
To listen for clicks on the `` component, pass the `onClick` prop:
```javascript
mapClicked(mapProps, map, clickEvent) {
// ...
}
render() {
return (
)
}
```
#### onDragend
When our user changes the map center by dragging the Map around, we can get a callback after the event is fired with the `onDragend` prop:
```javascript
centerMoved(mapProps, map) {
// ...
}
render() {
return (
)
}
```
The `` component also listens to `onRecenter`, `onBounds_changed`, `onCenter_changed`, `onDblclick`, `onDragstart`, `onHeading_change`, `onIdle`, `onMaptypeid_changed`, `onMousemove`, `onMouseout`, `onMouseover`, `onProjection_changed`, `onResize`, `onRightclick`, `onTilesloaded`, `onTilt_changed`, and `onZoom_changed` events. See Google Maps [Events](https://developers.google.com/maps/documentation/javascript/events) for more information.
### Visibility
You can control the visibility of the map by using the `visible` prop. This is useful for situations when you want to use the Google Maps API without a map. The `` component will load like normal. See the [Google places demo](https://fullstackreact.github.io/google-maps-react/#/places)
For example:
```javascript
```
## Subcomponents
The `` api includes subcomponents intended on being used as children of the `Map` component. Any child can be used within the `Map` component and will receive the three `props` (as children):
* `map` - the Google instance of the `map`
* `google` - a reference to the `window.google` object
* `mapCenter` - the `google.maps.LatLng()` object referring to the center of the map instance
### Marker
To place a marker on the Map, include it as a child of the `` component.
```javascript
```
The `` component accepts a `position` prop that defines the location for the `position` on the map. It can be either a raw object or a `google.maps.LatLng()` instance.
If no `position` is passed in the `props`, the marker will default to the current position of the map, i.e. the `mapCenter` prop.
You can also pass any other `props` you want with the ``. It will be passed back through marker events.
The marker component can also accept a child InfoMarker component for situations where there is only 1 marker and 1 infowindow.
```javascript
moveMarker(props, marker, e) {
console.log(e.latLng.lat(), e.latLng.lng()) // get the new coordinates after drag end
}
```
```javascript
Click on the map or drag the marker to select location where the incident occurred
```
### Events
The `` component listens for events, similar to the `` component.
#### onClick
You can listen for an `onClick` event with the (appropriately named) `onClick` prop.
```javascript
onMarkerClick(props, marker, e) {
// ..
}
render() {
return (
)
}
```
#### mouseover
You can also pass a callback when the user mouses over a `` instance by passing the `onMouseover` callback:
```javascript
onMouseoverMarker(props, marker, e) {
// ..
}
render() {
return (
)
}
```
### Polygon
To place a polygon on the Map, set `` as child of Map component.
```javascript
render() {
const triangleCoords = [
{lat: 25.774, lng: -80.190},
{lat: 18.466, lng: -66.118},
{lat: 32.321, lng: -64.757},
{lat: 25.774, lng: -80.190}
];
return(
)
}
```
#### Events
The `` component listens to `onClick`, `onMouseover` and `onMouseout` events.
### Polyline
To place a polyline on the Map, set `` as child of Map component.
```javascript
render() {
const triangleCoords = [
{lat: 25.774, lng: -80.190},
{lat: 18.466, lng: -66.118},
{lat: 32.321, lng: -64.757},
{lat: 25.774, lng: -80.190}
];
return(
)
}
```
#### Events
The `` component listens to `onClick`, `onMouseover` and `onMouseout` events.
### InfoWindow
The `` component included in this library is gives us the ability to pop up a "more info" window on our Google map.
The visibility of the `` component is controlled by a `visible` prop. The `visible` prop is a boolean (`PropTypes.bool`) that shows the `` when true and hides it when false.
There are two ways how to control a position of the `` component.
You can use a `position` prop or connect the `` component directly to an existing `` component by using a `marker` prop.
```javascript
//note: code formatted for ES6 here
export class MapContainer extends Component {
state = {
showingInfoWindow: false,
activeMarker: {},
selectedPlace: {},
};
onMarkerClick = (props, marker, e) =>
this.setState({
selectedPlace: props,
activeMarker: marker,
showingInfoWindow: true
});
onMapClicked = (props) => {
if (this.state.showingInfoWindow) {
this.setState({
showingInfoWindow: false,
activeMarker: null
})
}
};
render() {
return (
{this.state.selectedPlace.name}
)
}
}
```
### Events
The `` throws events when it's showing/hiding. Every event is optional and can accept a handler to be called when the event is fired.
```javascript
{this.state.selectedPlace.name}
```
#### onClose
The `onClose` event is fired when the `` has been closed. It's useful for changing state in the parent component to keep track of the state of the ``.
#### onOpen
The `onOpen` event is fired when the window has been mounted in the Google map instance. It's useful for keeping track of the state of the `` from within the parent component.
### Circle
To place a circle on the Map, set `` as child of Map component.
```javascript
render() {
const coords = { lat: -21.805149, lng: -49.0921657 };
return (
console.log('mouseover')}
onClick={() => console.log('click')}
onMouseout={() => console.log('mouseout')}
strokeColor='transparent'
strokeOpacity={0}
strokeWeight={5}
fillColor='#FF0000'
fillOpacity={0.2}
/>
);
}
```
#### Events
The `` component listens to `onClick`, `onMouseover` and `onMouseout` events.
The `GoogleApiWrapper` automatically passes the `google` instance loaded when the component mounts (and will only load it once).
#### Custom Map Style
To set your own custom map style, import your custom map style in JSON format.
```javascript
const mapStyle = [
{
featureType: 'landscape.man_made',
elementType: 'geometry.fill',
stylers: [
{
color: '#dceafa'
}
]
},
]
_mapLoaded(mapProps, map) {
map.setOptions({
styles: mapStyle
})
}
render() {
return (
this._mapLoaded(mapProps, map)}
>
...
);
}
```
## Manually loading the Google API
If you prefer not to use the automatic loading option, you can also pass the `window.google` instance as a `prop` to your `` component.
```javascript
```
## Issues?
If you have some issues, please make an issue on the issues tab and try to include an example. We've had success with https://codesandbox.io
An example template might look like: [https://codesandbox.io/s/rzwrk2854](https://codesandbox.io/s/rzwrk2854)
## Contributing
```shell
git clone https://github.com/fullstackreact/google-maps-react.git
cd google-maps-react
npm install
make dev
```
The Google Map React component library uses React and the Google API to give easy access to the Google Maps library.
___
# Fullstack React Book
This Google Map React component library was built alongside the blog post [How to Write a Google Maps React Component](https://www.fullstackreact.com/articles/how-to-write-a-google-maps-react-component/).
This repo was written and is maintained by the [Fullstack React](https://fullstackreact.com) team. In the book we cover many more projects like this. We walk through each line of code, explain why it's there and how it works.
This app is only one of several apps we have in the book. If you're looking to learn React, there's no faster way than by spending a few hours with the Fullstack React book.
## License
[MIT](/LICENSE)