google-map-react is a component written over a small set of the Google Maps API. It allows you to render any React component on the Google Map. It is fully isomorphic and can render on a server. Additionally, it can render map components in the browser even if the Google Maps API is not loaded. It uses an internal, tweakable hover algorithm - every object on the map can be hovered.
It allows you to create interfaces like this example (You can scroll the table, zoom/move the map, hover/click on markers, and click on table rows)
Features
Works with your Components
Instead of the ugly Google Maps markers, balloons and other map components, you can render your cool animated react components on the map.
Isomorphic Rendering
It renders on the server. (Welcome search engines) (you can disable javascript in browser dev tools, and reload any example page to see how it works)
Component Positions Calculated Independently of Google Maps API
It renders components on the map before (and even without) the Google Maps API loaded.
Google Maps API Loads on Demand
There is no need to place a <script src= tag at top of page. The Google Maps API loads upon the first usage of the GoogleMap component.
Internal Hover Algorithm
Now every object on the map can be hovered (however, you can still use css hover selectors if you want). If you try zooming out here example, you will still be able to hover on almost every map marker.
This algorithm allows you to tweak hover probability of map objects, for example making some objects "more hoverable". distance_hover example with different hover probabilities
Known Issues
- Small icons jiggle on Firefox (I don't see this in my older 'GoogleMap' version, so I will find the problem soon)
- Older browsers (http://caniuse.com/#feat=promises) will need a ES6 Promise polyfill in order to work.
Installation
npm
npm install --save google-map-react
bower
We no longer intend to support Bower. Please stop using Bower. NPM works very well for front-end development, and you should use it instead. ((c)Dan Abramov)
UMD AMD and other build are available under dist folder after npm install
What's it Look Like?
In the simple case you just need to add lat lng props to any child of GoogleMap component.
simple example in action
import React, {PropTypes, Component} from 'react';
import shouldPureComponentUpdate from 'react-pure-render/function';
import GoogleMap from 'google-map-react';
import MyGreatPlace from './my_great_place.jsx';
export default class SimpleMapPage extends Component {
static defaultProps = {
center: {lat: 59.938043, lng: 30.337157},
zoom: 9,
greatPlaceCoords: {lat: 59.724465, lng: 30.080121}
};
shouldComponentUpdate = shouldPureComponentUpdate;
constructor(props) {
super(props);
}
render() {
return (
<GoogleMap
defaultCenter={this.props.center}
defaultZoom={this.props.zoom}>
<MyGreatPlace lat={59.955413} lng={30.337844} text={'A'} /* Kreyser Avrora */ />
<MyGreatPlace {...this.props.greatPlaceCoords} text={'B'} /* road circle */ />
</GoogleMap>
);
}
}Examples
-
Hover effects: simple hover (source); distance hover (source)
-
Example project: main (source); balderdash (same source as main)
-
Clustering example (new) google-map-clustering-example
-
All api examples: google-map-react-examples
-
jsbin example jsbin example
-
local develop example (new) develop example
Contribute
To get a reloadable env, with map, clone this project and
npm install
npm run start
# open browser at localhost:4000GoogleMap API
parameters
apiKey (string) (Deprecated use bootstrapURLKeys)
Google maps api key. (Optional, but your map will be rate-limited with no key)
bootstrapURLKeys (object)
Example:
<GoogleMap
bootstrapURLKeys={{
key: API_KEY,
language: 'ru',
...otherUrlParams,
}}
>defaultCenter (array or object)
[lat, lng] or { lat: lat, lng: lng}
Default lat/lng at which to center the map - changing this prop throws a warning
center (array or object)
[lat, lng] or { lat: lat, lng: lng}
Lat/lng at which to center the map
defaultZoom: (number)
Default map zoom level - changing this prop throws a warning
zoom (number)
Map zoom level
hoverDistance (number)
Default: 30
margin (array)
In onChange callback, gives you a marginBounds argument property, where lat lng will be shifted using margin you have set. For example, you could use a simple check pointInRect to not show Markers near map bounds.
debounced (bool)
Default: true
layerTypes (string[])
You can add some "layers" for map like a traffic or transit
layerTypes={['TrafficLayer', 'TransitLayer']}callbacks
options (func|object)
Set map options such as controls positions / styles, etc.
Example:
createMapOptions: function (maps) {
return {
panControl: false,
mapTypeControl: false,
scrollwheel: false,
styles: [{ stylers: [{ 'saturation': -100 }, { 'gamma': 0.8 }, { 'lightness': 4 }, { 'visibility': 'on' }] }]
}
}
<GoogleMap options={createMapOptions} ... />See "Custom map options example" in Examples below for a further example.
onClick (func)
({ x, y, lat, lng, event })
The event prop in args is the outer div onClick event, not the gmap-api 'click' event.
Example:
_onClick = ({x, y, lat, lng, event}) => console.log(x, y, lat, lng, event)
// ES5 users
function _onClick(obj){ console.log(obj.x, obj.y, obj.lat, obj.lng, obj.event);}
<GoogleMap onClick={_onClick} ... />onBoundsChange (func) (Deprecated use onChange)
({ center, zoom, bounds, marginBounds })
[lat, lng] = center;
[topLat, leftLng, bottomLat, rightLng] = bounds;
onChildClick (func)
onChildMouseEnter (func)
onChildMouseLeave (func)
onZoomAnimationStart (func)
onZoomAnimationEnd (func)
onMapTypeIdChange (func)
When the user changes the map type (HYBRID, ROADMAP, SATELLITE, TERRAIN) this fires
distanceToMouse (func)
googleMapLoader (func)
onGoogleApiLoaded (func)
Directly access the maps API - use at your own risk!
<GoogleMap onGoogleApiLoaded={({map, maps}) => console.log(map, maps)} />To prevent warning message add yesIWantToUseGoogleMapApiInternals property to GoogleMap
<GoogleMap onGoogleApiLoaded={({map, maps}) => console.log(map, maps)}
yesIWantToUseGoogleMapApiInternals
/>Child Component API
parameters
lat (number)
Latitude to place the marker component
lng (number)
Longitude to place the marker component
$hover (bool) [automatic]
GoogleMap passes a $hover prop to hovered components. To detect hover it an uses internal mechanism, explained in x_distance_hover example
Example:
render() {
const style = this.props.$hover ? greatPlaceStyleHover : greatPlaceStyle;
return (
<div style={style}>
{this.props.text}
</div>
);
}Utility functions
fitBounds (func)
Use fitBounds to get zoom and center.
Example:
import { fitBounds } from 'google-map-react/utils';
const bounds = {
nw: {
lat: 50.01038826014866,
lng: -118.6525866875
},
se: {
lat: 32.698335045970396,
lng: -92.0217273125
}
};
// Or
const bounds = {
ne: {
lat: 50.01038826014866,
lng: -118.6525866875
},
sw: {
lat: 32.698335045970396,
lng: -92.0217273125
}
};
const size = {
width: 640, // Map width in pixels
height: 380, // Map height in pixels
};
const {center, zoom} = fitBounds(bounds, size);tile2LatLng (func)
latLng2Tile (func)
getTilesIds (func)
Tips
My map doesn't appear
Make sure the container element has width and height. The map will try to fill the parent container, but if the container has no size, the map will collapse to 0 width / height.
Positioning a marker
Initially any map object has its top left corner at lat lng coordinates. It's up to you to set the object origin to 0,0 coordinates.
Example (centering the marker):
const MARKER_SIZE = 40;
const greatPlaceStyle = {
position: 'absolute',
width: MARKER_SIZE,
height: MARKER_SIZE,
left: -MARKER_SIZE / 2,
top: -MARKER_SIZE / 2
}render() {
return (
<div style={greatPlaceStyle}>
{this.props.text}
</div>
);
}Rendering in a modal
If at the moment of GoogleMap control created, a modal has no size (width,height=0) or/and not displayed, the simple solution is to add something like this in render:
render() {
return this.props.modalIsOpen
? <GoogleMap />
: null;
}Adding a searchbox
import React from 'react';
export default class SearchBox extends React.Component {
static propTypes = {
placeholder: React.PropTypes.string,
onPlacesChanged: React.PropTypes.func
}
render() {
return <input ref="input" {...this.props} type="text"/>;
}
onPlacesChanged = () => {
if (this.props.onPlacesChanged) {
this.props.onPlacesChanged(this.searchBox.getPlaces());
}
}
componentDidMount() {
var input = React.findDOMNode(this.refs.input);
this.searchBox = new google.maps.places.SearchBox(input);
this.searchBox.addListener('places_changed', this.onPlacesChanged);
}
componentWillUnmount() {
this.searchBox.removeListener('places_changed', this.onPlacesChanged);
}
}You will need to preload the google maps API, but google-map-react checks if the base api is already loaded,
and if so, uses it, so it won't load a second copy of the library.
<script type="text/javascript" src="https://maps.google.com/maps/api/js?libraries=places&sensor=false"></script>Override the default minimum zoom
WARNING: Setting these options can break markers calculation, causing no homeomorphism between screen coordinates and map.
You can use the minZoomOverride associated with the minZoom in the custom map options to prevent a minimum zoom from being calculated:
function createMapOptions() {
return {
minZoomOverride: true,
minZoom: 2,
};
}(Really big thanks to April Arcus for documentation fixes) (thank you Dan Abramov for titles structure) (great thanks to Vladimir Akimov he knows why)