Vue2Leaflet

Vue2Leaflet is a JavaScript library for the Vue framework that wraps Leaflet making it easy to create reactive maps.

How to install

npm install vue2-leaflet leaflet --save

For more detailed information you can follow the Quick Start Guide

Breaking change from 1.x.x to 2.x.x

A new major release 2.0,0 is available and come with one breaking change:

Leaflet is not automatically installed anymore

Leaflet is now a peerDependency and need to be installed manually, we updated our docs to reflect this but please pay attention when migrating

Importing the library in Webpack / Rollup

Now the code of vue2-leaflet is split component by component (while using a bundler like Webpack/Rollup/Parcel) to do so the following syntax is not working anymore:

import Vue2Leaflet from 'vue2-leaflet' // INVALID

And has been replaced by

import * as Vue2Leaflet from 'vue2-leaflet' // VALID

Is highly suggested to import only the needed modules by doing so:

import {LMap, LTileLayer, LMarker} from 'vue2-leaflet'

This will reduce the size of the bundle significantly

Documentation

Go here to check out live examples and docs.

If you want to hack around, here is a JS Fiddle to get started

Leaflet Plugins

Leaflet plugins can easily work with Vue2Leaflet, if you want to use one I would recommand to look at the awesome work made by the community in the list below.

Vue2Leafet plugins

• vue2-leaflet-markercluster wrapper for MarkerCluster
• vue2-leaflet-polylinedecorator wrapper for PolylineDecorator
• vue2-leaflet-googlemutant wrapper for GoogleMutant
• vue2-leaflet-tracksymbol wrapper for TrackSymbol
• vue-choropleth to display a choropleth map given a certain GeoJSON
• vue2-leaflet-geosearch wrapper for GeoSearch
• vue2-leaflet-vectorgrid wrapper for VectorGrid to display gridded vector data
• vue2-leaflet-rotatedmarker wrapper for RotatedMarker
• vue2-leaflet-editablecirclemarker wrapper for leaflet-editablecirclemarker
• vue2-leaflet-hotline wrapper for hotline
• vue2-leaflet-movingmarker wrapper for Leaflet.Marker.SlideTo
• vue2-leaflet-path-transform wrapper for Leaflet.Path.Transform
• vue2-leaflet-gpx wrapper for leaflet-gpx
• vue2-leaflet-locatecontrol wrapper for Leaflet.Locate
• vue2-leaflet-polygonfillpattern wrapper for leaflet-polygon-fillPattern

If you have created a plugin and want it to be listed here, let me know :-).

Vue2Leaflet is only a wrapper for Leaflet. I want to keep it as simple as possible so I don't want to add any plugin support into this repo.

Authors

Mickaël Bouchaud

Inspired by many map wrapper (google and leaflet) for many framework (React, Angular and Vue 1.0)

Contributors

Thanks goes to these wonderful people

License

This project is licensed under the MIT License - see the LICENSE file for details