vue2-leaflet

Vue2Leaflet

Vue2 component that helps with leaflet interaction

Implemented Components

• Map
• Marker
• Popup
• Tooltip
• TileLayer
• TileLayer.WMS
• ImageOverlay
• Polyline
• Polygon
• Rectangle
• Circle
• CircleMarker
• LayerGroup
• FeatureGroup
• GeoJSON

Build Setup

# install dependencies
npm install

# build for production with minification
npm run build

# Run demo at localhost:8080
npm link
cd examples
npm link vue2-leaflet
npm install
npm run dev

If you make changes to the library you should run 'npm run build' again in the root folder. The dev server should detect modification and reload the demo

How to display a map

Register Map and TileLayer components from Vue2Leaflet

Vue.component('v-map', Vue2Leaflet.Map);
Vue.component('v-tilelayer', Vue2Leaflet.TileLayer);

v-map and v-tilelayer are name you can choose that must match the tag your are using in your template.

Add the map to your template

<v-map :zoom=13 :center="[47.413220, -1.219482]">
	<v-tilelayer url="http://{s}.tile.osm.org/{z}/{x}/{y}.png"></v-tilelayer>
</v-map>

zoom, center, and url are properties or options of corresponding leaflet object. See leaflet documentation for more informations http://leafletjs.com/reference-1.0.0.html

Make sure the leaflet.css is included, either via a HTML link tag or in your component style via something like

@import "~leaflet/dist/leaflet.css";

If you need to set a custom icon path for leaflet you can directly set Leaflet option like this:

L.Icon.Default.imagePath = "/examples/images/";

or add a IconDefault element in your map like this (see custom_path.html for a complete example):

<v-icondefault :image-path="path"></v-icondefault>

Run demo

# serve with hot reload at localhost:8080
npm run dev

Go to http://localhost:8080/examples/simple.html to see a simple example displaying a marker

Go to http://localhost:8080/examples/multi_map.html to see two map with binding to the same data source

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:

• @zuck
• @SiggyF
• @nikos

License

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