Leaflet.GridLayer.GoogleMutant

Leaflet.GridLayer.GoogleMutant

Leaflet plugin to display Google maps baselayers using DOM mutation observers.

Leaflet.GridLayer.GoogleMutant

A LeafletJS plugin to use Google maps basemaps.

Demo

http://ivansanchez.gitlab.io/Leaflet.GridLayer.GoogleMutant/demo.html

Why?

It is already possible to display Google Maps in Leaflet, but unfortunately the state of the art is far from perfect:

In order to provide the best Leaflet experience, GoogleMutant uses both DOM mutation observers and L.GridLayer from Leaflet 1.0.0. The basemap tiles are still requested through the Google maps JavaScript API, but they switch places to use Leaflet drag and zoom.

Compatibility

This plugin doesn't work on IE10 or lower, as that browser doesn't implement DOM mutation observers. Chrome, Firefox, Safari, IE11 and Edge are fine.

Usage

Include the GMaps JS API in your HTML, plus Leaflet:

<script src="https://maps.googleapis.com/maps/api/js?key=YOUR_API_KEY" async defer></script>
<link rel="stylesheet" href="https://unpkg.com/leaflet@1.0.1/dist/leaflet.css" />
<script src="https://unpkg.com/leaflet@1.0.1/dist/leaflet.js"></script>

Include the GoogleMutant javascript file:

<script src='https://unpkg.com/leaflet.gridlayer.googlemutant@latest/Leaflet.GoogleMutant.js'></script>

Then, you can create an instance of L.GridLayer.GoogleMutant on your JS code:

var roads = L.gridLayer.googleMutant({
    type: 'roadmap' // valid values are 'roadmap', 'satellite', 'terrain' and 'hybrid'
}).addTo(map);

It's also possible to use custom styling by passing a value to the style option, e.g.:

var styled = L.gridLayer.googleMutant({
    type: 'roadmap',
    styles: [
        {elementType: 'labels', stylers: [{visibility: 'off'}]},
        {featureType: 'water', stylers: [{color: '#444444'}]}
    ]
}).addTo(map);

Installing a local copy

If you don't want to rely on a CDN to load GoogleMutant, you can:

  • Fetch it with NPM by running npm install --save leaflet.gridlayer.googlemutant.
  • Fetch it with Yarn by running yarn add leaflet.gridlayer.googlemutant.
  • We discourage using Bower but, if you must, bower install https://gitlab.com/IvanSanchez/Leaflet.GridLayer.GoogleMutant.git.

You can also download a static copy from the CDN, or clone this git repo.

Known caveats

hybrid mode prunes tiles before needed for no apparent reason, so the map flickers when there is a zoom change.

If you are targeting IE11, then include the following before the script element that references the GoogleMutant javascript file:

<script src="https://unpkg.com/es6-promise@4.0.5/dist/es6-promise.min.js"></script>
<script>ES6Promise.polyfill();</script>

This will polyfill in Javascript Promises for IE.

Legalese


"THE BEER-WARE LICENSE": ivan@sanchezortega.es wrote this file. As long as you retain this notice you can do whatever you want with this stuff. If we meet some day, and you think this stuff is worth it, you can buy me a beer in return.