A declarative Google Map React component using React, lazy-loading dependencies, current-location finder and a test-driven approach by the Fullstack React team.
See the demo and accompanying blog post.
First, install the library:
npm install --save google-maps-reactUsage:
<Map google={this.props.google} zoom={14}>
<Marker onClick={this.onMarkerClick}
name={'Current location'} />
<InfoWindow onClose={this.onInfoWindowClose}>
<div>
<h1>{this.state.selectedPlace.name}</h1>
</div>
</InfoWindow>
</Map>
The <Map /> component requires a google prop be included to work. Without the google prop, it will explode.
<Map google={window.google} />The <Map /> component handles events out of the box. All event handlers are optional.
When the <Map /> 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.
React.createClass({
fetchPlaces: function(mapProps, map) {
const {google} = this.props;
const service = new google.maps.places.PlacesService(map);
// ...
},
render: function() {
return (
<Map google={this.props.google}
onReady={this.fetchPlaces}
visible={false}>
<Listing places={this.state.places} />
</Map>
)
}
});To listen for clicks on the <Map /> component, pass the onClick prop:
React.createClass({
mapClicked: function(mapProps, map, clickEvent) {
// ...
},
render: function() {
return (
<Map google={this.props.google}
onClick={this.mapClicked} />
)
}
});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:
React.createClass({
centerMoved: function(mapProps, map) {
// ...
},
render: function() {
return (
<Map google={this.props.google}
onDragend={this.centerMoved} />
)
}
});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 <Map /> component will load like normal. See the Google places demo
For example:
<Map google={this.props.google}
visible={false}>
<Listing places={this.state.places} />
</Map>The <Map /> 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 themapgoogle- a reference to thewindow.googleobjectmapCenter- thegoogle.maps.LatLng()object referring to the center of the map instance
To place a marker on the Map, include it as a child of the <Map /> component.
<Map google={this.props.google}
style={{width: '100%', height: '100%', position: 'relative'}}
className={'map'}
zoom={14}>
<Marker
name={'SOMA'}
position={{lat: 37.778519, lng: -122.405640}} />
<Marker
name={'Dolores park'}
position={{lat: 37.759703, lng: -122.428093}} />
<Marker />
</Map>The <Marker /> 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 <Marker />. It will be passed back through marker events.
The <Marker /> component listens for events, similar to the <Map /> component.
You can listen for an onClick event with the (appropriately named) onClick prop.
const WithMarkers = React.createClass({
onMarkerClick: function(props, marker, e) {
},
render: function() [
return (
<Map google={this.props.google}>
<Marker onClick={this.onMarkerClick}
name={'Current location'} />
</Map>
)
]
});You can also pass a callback when the user mouses over a <Marker /> instance by passing the onMouseover callback:
const Container = React.createClass({
onMouseoverMarker: function(props, marker, e) {
},
render: function() [
return (
<Map google={this.props.google}>
<Marker onMouseover={this.onMouseoverMarker}
name={'Current location'} />
</Map>
)
]
});The <InfoWindow /> 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 <InfoWindow /> component is controlled by a visible prop. The visible prop is a boolean (React.PropTypes.bool) that shows the <InfoWindow /> when true and hides it when false.
const WithMarkers = React.createClass({
getInitialState: function() {
return {
showingInfoWindow: false,
activeMarker: {},
selectedPlace: {},
}
},
onMarkerClick: function(props, marker, e) {
this.setState({
selectedPlace: props,
activeMarker: marker,
showingInfoWindow: true
});
},
onMapClicked: function(props) {
if (this.state.showingInfoWindow) {
this.setState({
showingInfoWindow: false,
activeMarker: null
})
}
},
render: function() {
return (
<Map google={this.props.google}
onClick={this.onMapClicked}>
<Marker onClick={this.onMarkerClick}
name={'Current location'} />
<InfoWindow
marker={this.state.activeMarker}
visible={this.state.showingInfoWindow}>
<div>
<h1>{this.state.selectedPlace.name}</h1>
</div>
</InfoWindow>
</Map>
)
}
});The <InfoWindow /> throws events when it's showing/hiding. Every event is optional and can accept a handler to be called when the event is fired.
<InfoWindow
onOpen={this.windowHasOpened}
onClose={this.windowHasClosed}
visible={this.state.showingInfoWindow}>
<div>
<h1>{this.state.selectedPlace.name}</h1>
</div>
</InfoWindow>The onClose event is fired when the <InfoWindow /> has been closed. It's useful for changing state in the parent component to keep track of the state of the <InfoWindow />.
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 <InfoWindow /> from within the parent component.
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 for all options it accepts.
import {GoogleApiWrapper} from 'GoogleMapsReactComponent'
// ...
export class Container extends React.Component {}
export default GoogleApiWrapper({
apiKey: __GAPI_KEY__
})(Container)The GoogleApiWrapper automatically passes the google instance loaded when the component mounts (and will only load it once).
If you prefer not to use the automatic loading option, you can also pass the window.google instance as a prop to your <Map /> component.
git clone https://github.com/fullstackreact/google-maps-react.git
cd google-maps-react
npm install
make devThe Google Map React component library uses React and the Google API to give easy access to the Google Maps library.
This Google Map React component library was built alongside the blog post How to Write a Google Maps React Component.
This repo was written and is maintained by the Fullstack React 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.