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 GoogleMapReact
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.
What's it Look Like?
In the simple case you just need to add lat
lng
props to any child of GoogleMapReact
component.
import React, { Component } from 'react';
import GoogleMapReact from 'google-map-react';
const AnyReactComponent = ({ text }) => <div>{text}</div>;
class SimpleMap extends Component {
static defaultProps = {
center: {lat: 59.95, lng: 30.33},
zoom: 11
};
render() {
return (
<GoogleMapReact
defaultCenter={this.props.center}
defaultZoom={this.props.zoom}
>
<AnyReactComponent
lat={59.955413}
lng={30.337844}
text={'Kreyser Avrora'}
/>
</GoogleMapReact>
);
}
}
Installation
npm install --save google-map-react
Examples
-
Hover effects: simple hover (source); distance hover (source)
-
Example project: main (source); balderdash (same source as main)
-
Clustering example (source) google-map-clustering-example
-
How to render thousands of markers (new) google-map-thousands-markers
-
All api examples: google-map-react-examples
-
jsbin example jsbin example
-
webpackbin examples (new) docs with webpackbin examples (In progress)
-
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:4000
API
NEW DOCS (In progress)
Thank you
(Really big thanks to April Arcus for documentation fixes)
(thank you Dan Abramov for titles structure)
(great thanks to Vladimir Akimov he knows why)
License
MIT (http://www.opensource.org/licenses/mit-license.php)
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
Known Issues
- Older browsers (http://caniuse.com/#feat=promises) will need a ES6 Promise polyfill in order to work.