# Vue2Leaflet
[![All Contributors](https://img.shields.io/badge/all_contributors-17-orange.svg?style=flat-square)](#contributors-)
Vue2Leaflet is a JavaScript library for the [Vue](https://vuejs.org/) framework that wraps [Leaflet](http://leafletjs.com/) making it easy to create reactive maps.
## How to install
```bash
npm install vue2-leaflet leaflet --save
```
For more detailed information you can follow the [Quick Start Guide](https://vue2-leaflet.netlify.com/quickstart/)
## Breaking change from 1.x.x to 2.x.x
A new major release 2.0.0 is available and come with two breaking changes:
### 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:
```javascript
import Vue2Leaflet from 'vue2-leaflet'; // INVALID
```
And has been replaced by
```javascript
import * as Vue2Leaflet from 'vue2-leaflet'; // VALID
```
Is highly suggested to import only the needed modules by doing so:
```javascript
import { LMap, LTileLayer, LMarker } from 'vue2-leaflet';
```
This will reduce the size of the bundle significantly
## Documentation
[Go here](https://vue2-leaflet.netlify.com/) to check out live examples and docs.
## Support & Community
Do you have questions? Ideas? do you want to collaborate but you feel lost? Join us on discord [Invite Link](https://discord.gg/uVZAfUf)
## Leaflet Plugins
Vue2Leaflet has a wide array of plugins written by the community! [Check Here](https://vue2-leaflet.netlify.com/plugins/)
## Contribute
```bash
# clone the repository
git clone https://github.com/vue-leaflet/Vue2Leaflet.git
cd Vue2Leaflet
# install dependencies and build vue2-leaflet
npm install
# Compile the source and start the documentation server
npm run dev
```
Go to