Merge pull request #377 from KoRiGaN/feature/ready-event

Feature/ready event

docs/components/l-circle-marker/README.md

@@ -69,9 +69,7 @@ export default {
 
 ## Events
 
-`l-circle-marker` does not emit any event on his own.
-
-[filename](../events-notice.md ':include')
+[filename](../shared-events.md ':include')
 
 ## Extends
 

docs/components/l-circle/README.md

@@ -65,9 +65,7 @@ export default {
 
 ## Events
 
-`l-circle` does not emit any event on his own.
-
-[filename](../events-notice.md ':include')
+[filename](../shared-events.md ':include')
 
 ## Extends
 

docs/components/l-control-attribution/README.md

@@ -57,9 +57,7 @@ export default {
 
 ## Events
 
-`l-control-attribution` does not emit any event on his own.
-
-[filename](../events-notice.md ':include')
+[filename](../shared-events.md ':include')
 
 ## Extends
 

docs/components/l-control-layers/README.md

@@ -93,9 +93,7 @@ export default {
 
 ## Events
 
-`l-control-layers` does not emit any event on his own.
-
-[filename](../events-notice.md ':include')
+[filename](../shared-events.md ':include')
 
 ## Extends
 

docs/components/l-control-scale/README.md

@@ -67,9 +67,7 @@ export default {
 
 ## Events
 
-`l-control-scale` does not emit any event on his own.
-
-[filename](../events-notice.md ':include')
+[filename](../shared-events.md ':include')
 
 ## Extends
 

docs/components/l-control-zoom/README.md

@@ -69,9 +69,7 @@ export default {
 
 ## Events
 
-`l-control-zoom` does not emit any event on his own.
-
-[filename](../events-notice.md ':include')
+[filename](../shared-events.md ':include')
 
 ## Extends
 

docs/components/l-control/README.md

@@ -58,9 +58,7 @@ export default {
 
 ## Events
 
-`l-control` does not emit any event on his own.
-
-[filename](../events-notice.md ':include')
+[filename](../shared-events.md ':include')
 
 
 ## Extends

docs/components/l-feature-group/README.md

@@ -75,9 +75,7 @@ export default {
 
 ## Events
 
-`l-feature-group` does not emit any event on his own.
-
-[filename](../events-notice.md ':include')
+[filename](../shared-events.md ':include')
 
 ## Extends
 

docs/components/l-geo-json/README.md

@@ -77,9 +77,7 @@ export default {
 
 ## Events
 
-`l-geo-json` does not emit any event on his own.
-
-[filename](../events-notice.md ':include')
+[filename](../shared-events.md ':include')
 
 ## Extends
 

docs/components/l-grid-layer/README.md

@@ -70,11 +70,10 @@ export default {
 
 ## Events
 
-`l-grid-layer` does emit any event on his own.
 Leaflet's `tileunload` event is internally used to trigger the destruction
 of the tile components when a tile leaves the visible area.
 
-[filename](../events-notice.md ':include')
+[filename](../shared-events.md ':include')
 
 ## Extends
 

docs/components/l-icon/README.md

@@ -152,6 +152,4 @@ export default {
 
 ## Events
 
-`l-icon` does not emit any event on his own.
-
-[filename](../events-notice.md ':include')
+[filename](../shared-events.md ':include')

docs/components/l-image-overlay/README.md

@@ -64,9 +64,7 @@ export default {
 
 ## Events
 
-`l-image-overlay` does not emit any event on his own.
-
-[filename](../events-notice.md ':include')
+[filename](../shared-events.md ':include')
 
 ## Extends
 

docs/components/l-map/README.md

@@ -169,14 +169,14 @@ export default {
 
 ## Events
 
-* **leaflet:load** - emitted when the leaflet map instance is ready
+* **leaflet:load** - emitted when the leaflet map instance is ready **This Event is deprecated in favour of `ready`**
 * **update:zoom** - emitted when the zoom of the map changes - `update:zoom` is emitted together with a `Number` value representing the  current `zoom`
 * **update:center** - emitted when the center of the map changes - `update:center` is emitted together with an instance of  `L.LatLng` value representing the  current `center` [L.latLng](https://leafletjs.com/reference-1.3.0.html#latlng)
 * **update:bounds** - emitted when the bounds of the map changes - `update:bounds` is emitted together with an instance of  `L.latLngBounds` value representing the  current `bound` [L.latLngBounds](https://leafletjs.com/reference-1.3.0.html#latlngbounds)
 
 !>  **update:zoom**, **update:center**, **update:bounds** are all debounced events based on `leaflet` `moveend` event and support `sync` modifier
 
-[filename](../events-notice.md ':include')
+[filename](../shared-events.md ':include')
 
 ## Extends
 

docs/components/l-marker/README.md

@@ -79,7 +79,7 @@ export default {
 
 !>  **update:latlng** support `sync` modifier
 
-[filename](../events-notice.md ':include')
+[filename](../shared-events.md ':include')
 
 ## Extends
 

docs/components/l-polygon/README.md

@@ -63,9 +63,7 @@ export default {
 
 ## Events
 
-`l-polygon` does not emit any event on his own.
-
-[filename](../events-notice.md ':include')
+[filename](../shared-events.md ':include')
 
 ## Extends
 

docs/components/l-polyline/README.md

@@ -63,9 +63,7 @@ export default {
 
 ## Events
 
-`l-polyline` does not emit any event on his own.
-
-[filename](../events-notice.md ':include')
+[filename](../shared-events.md ':include')
 
 ## Extends
 

docs/components/l-popup/README.md

@@ -60,9 +60,7 @@ export default {
 
 ## Events
 
-`l-popup` does not emit any event on his own.
-
-[filename](../events-notice.md ':include')
+[filename](../shared-events.md ':include')
 
 ## Extends
 

docs/components/l-rectangle/README.md

@@ -63,9 +63,7 @@ export default {
 
 ## Events
 
-`l-rectangle` does not emit any event on his own.
-
-[filename](../events-notice.md ':include')
+[filename](../shared-events.md ':include')
 
 ## Extends
 

docs/components/l-tile-layer/README.md

@@ -57,9 +57,7 @@ export default {
 
 ## Events
 
-`l-tile-layer` does not emit any event on his own.
-
-[filename](../events-notice.md ':include')
+[filename](../shared-events.md ':include')
 
 ## Extends
 

docs/components/l-tooltip/README.md

@@ -53,9 +53,7 @@ export default {
 
 ## Events
 
-`l-tooltip` does not emit any event on his own.
-
-[filename](../events-notice.md ':include')
+[filename](../shared-events.md ':include')
 
 ## Extends
 

docs/components/l-wms-tile-layer/README.md

@@ -81,9 +81,7 @@ export default {
 
 ## Events
 
-`l-wms-tile-layer` does not emit any event on his own.
-
-[filename](../events-notice.md ':include')
+[filename](../shared-events.md ':include')
 
 ## Extends
 

docs/components/shared-events.md

@@ -0,0 +1,3 @@
+* **ready** - emitted when the component is ready, - `ready` is emitted togheter with the `mapObject` dictionary that contains the underlying `leaflet` instance
+
+All native leaflet events are passed through, e.g. `@leafletevent="..."`.

examples/src/components/LoadTest.vue

@@ -23,7 +23,7 @@
           <img
             width="300"
             src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAZAAAAGQCAMAAAC3Ycb+AAACLlBMVEVMaXFBuINBuIM8enI/nnxBuINBuINBuIM8enJBuIM8enJBuINBuINBuIM8enJBuIM8enJBuINBuIM7eXFBuINBuIM8eXFBuINBuIM8eHFBuIM8eXFBuIM8eHBBuIM8eHBBuIM8d3BBuINBuIM8d3BBuINBuINBuIM8dnBBuINBuIM8dnBBuINBuIM7dXBBuINBuIM8dG9BuINBuIM8dG9BuIM8dG9BuINBuIM8c29BuINBuIM7cm5BuINBuIM7cW5BuIM7cW9BuINBuINBuIM7cW5BuINBuINBuIM7b21BuINBuIM6b21BuIM7bm1BuINBuIM7bW1BuINBuIM6bGxBuINBuIM6a2xBuIM6a2xBuINBuIM6amxBuIM6aWtBuINBuIM6aGpBuINBuIM6ZmpBuINBuIM5ZGlBuIM5Y2lBuINBuIM5YWhBuINBuIM5YGdBuIM4XmdBuINBuIM4XGZBuINBuIM4WmVBuIM3WGRBuIM3V2RBuINBuIM3VGNBuIM2UmI2UGFBuIM1TWA1SV41Sl41S141TF81TWA2T2A2UWE2U2I3VWM3WGQ4W2U4Xmc5YGc5YWg5ZGk6Zmo6Z2o6aGo6a2w7bW07bm07cG48c287dnA7eHA8enI8fHI9fnM8gXM9g3Q9hnU9iXY+i3c+jHc+j3g+kXk+lHo/l3o/mXs+m3s/nnw/oH0/o31Apn5BqH5Aqn9BrH9BroBBr4BCsYBBs4FBtoJCt4JBuIP7mHZoAAAAhHRSTlMAAQICAwQHCAgLDQ4QEhIVFhcaGh4hIiUoKissLzEzNDc4Oj4/QERFRkhLTVBTVldaXV5iYmZnaW1vcHV3eHx8gIGDhIeJio+Sk5aZm52foaWmqKyusLS1t7m6u7y/wMLHx8zP0NPW1trc3uLi5Obn6urt7+/y8/T29vf4+vv7/P39/v7L5yYnAAAKeElEQVR42uzBgQAAAADDoPtTH2TVAAAAAAAAAAAAAMg6NfegXmu6BVG4tm3btm3btm1bM3bOtm17Xt1pu5OlkfT3v7cxnqp1zio0SFovlZleaQYp/O6odWp90VGv0wxyWGXmsEHSXjvqYmtplrNuGGWKysgUo9xw1ixJ9Q456kOWQc7WVJmoedYgWR8cdaieJI101gOjrFCZWGGU+84aqZ9U2eqob3kGudRG4rW5ZJC8b47aWkU/6+Gs50bZIfF2GOW5s3roV0ud9T+jDBZusFGKnbVUv2l22lFv0w1yrJJglY4ZJP2to0430++mOuuWUWYLNtsot5w1VX+otd9Rn3MMcr6RUI3OGyT7s6P219KfDHLWI6NsEGqDUR45a5D+rOJGR33LN0hGZ4E6Zxgk/5ujNlbUX3R01kuj7BNon1FeOquj/ma+s64aZbQwo41y1Vnz9XcNjzvqfaZBTlUXpPopg2S+d9TxhvqHsc66a5TFgiw2yl1njdU/VdvpqK+5BslqKkTTLIPkfnHUzmr6F32c9dQo24TYZpSnzuqjf7XGWUUGSesrQN80gxQ5a43+XetzjnoTVs0Nttuea60SzIx+zY1it52pktSBa+5HrubWVYrqct32I9xt66hEw4OtuauVotVGeeCs4SpZuDU3s51S0i4z1G67pYpK0S3YmrtbKdkdbLftqlItcdZlowxVCoYa5bKzlqh0TeCa+y7DICeqKGlVThgk4x3cbZsohsnOum2UuUraXKPcdtZkxVJrL1xzsw1yoZGS1OhCqN12bw3FNDA6NTf63XagYquw3lHfCwyS3l1J6Z5ukILvjlpfQXFo76xXRjmgpBwwyitntVdc5jnrmlHGKQnjjHLNWfMUn4ZHAxgoADWX7rZZcLc92lBxGuOse3zN/S+67T1njVG8qoZbc1soQS24bvsV7rZVFbfeznrG19zod9veSsAqZxXzNbe8u22xs1YqES3DrbmVlIBKXLd9A3fblkrIdGfdNMoMJWCGUW46a7oSU+egoz5lG+R8XcWtLjc++OSog3WUoGHB1ty1itvaYLvtMCWqypZgBwodFKcOwY4PtlRWwro460X519zdRnnhrC5KwiJnXTHKCMVlhFGuOGuRktHkZLRrbrjd9mQTJWWSs+4YZYHisCDYbjtRyamxx1FfcrCa21QxNcW6bc4XR+2poST1d9Zjo2xWTJuN8thZ/ZW44GtuL8XQK+Rum7S2wd7NHSi3bpsGd9uLbZWCOc66bpQJKtUEo1x31hylosGRaN7NhXsad6SBUjLKWfeNskylWBZstx2l1FTdDtfcPINktVKJWmUZJA/utturKkU9g625O8rjNO6Zs3oqZcuDrbkDVIIBwXbb5Upd8zNRu5sL9zTuTHMBpgV7Nzcjat12mgi19wdbc+vrX9QPttvuryXEEGc9LNuBwgajPHTWEDEqborS3Vy4p3GbKgrSKUp3c7uDPY3rJMzCYO/mRkSn2y4Up/FxuubSAwV+fEB32+ONBRoffs2lu+0dZ40XqdouR32B7+bCP43bVU2ofs56wtdctts+cVY/sX5g7w4wAoECKIoaALPuwRACIZIgEATR7trEw/ndf7fxeOcPjof52Nc4Hg/zsa9tPB7mY1/bfDzMx76m+XiYj31t8/EwH/ua5uNhPva1zMfDfOxrmY+H+djXNB8POwP7WjfHw3Zrro99TfPxMB/7mubjYT72tc3Hw3zsa5uPh/nY1zQfD/Oxr20+HuZjX9N8PMzHvrb5eJiPfU3z8TAf+9rm42E+9rXNx8N87Guaj4f52Nc2Hw/zsa/AmtvabX08zMe+9vl4mI997fPxMB/7muXjYT72NcjHw1jsa7/bHoyH+djXPvpuzj+N2+bjYT72tc3Hw3zsa5qPh/nY1zYfD/Oxr2k+HuZjX9t8PMzHvqb5eJiPfW3z8TAf+9rm42E+9jXKx8N87GuQj4f52NcgHw/zsa9BPh4GY19AAB7mYF9AAB4GYV9AAB7mYF9AAB4GYV9AAB6GY193zQ3sthIeBmNfQAAe5mBfQAAeBmFfQAAe5mBfQAAeBmFfQAAe5mBfQAAe5mBfQAAeBmFfQAAe5mBfQAAeBmFfQAAe5mBfQAAeBmFfQAAe5mBfQAAe5mBfQAAeBmFfQAAe5mBfQAAeBmFfQAAepmNfg3w8bNDjN459hfCwM7CvEh52AvaVwsNOwb58PGzWG4V93bs5/zSuhYf52FcLD/Oxrxge5mNfLTzMx75ieJiPfbXwMB/7iuFhPvbVwsN87KuFh/nYVwwP87GvFh7mY18xPOzhy8e+UniYj3218DAf+2rhYT72FcPDfOyrhYf52FcAD0Owr7vm3t3Wx8N87KuFh/nYVwsP87GvGB7mY18tPMzHvgJ4mIt93bs5/zQuhof52FcLD/OxrxYe9v/Tx75SeJiPfbXwMB/7+j142HsO+/LxsBj25eNhNezLx8Ni2JePh9WwLx8Pi2FfPh5Ww758PKyGffl4WAz78vGw87GvCB724mNfATwsgH35eJiGfd019+62Ph7278PHvlJ4mI99ZfCwAPbl42GvNezLx8Nq2JePh9WwLx8Pi2FfPh7Wwr58POzZxr78/u7xsBj25eNhMezLx8Ni2JePhx2IfQXwsCcf+0rhYT72FcPDfOyrhYf52FcMD8OxL781HuZjXzE8zMe+aniYj33F8DAf+yrhYRj2de/m7mmciIf52FcND/Oxrxge5mNfDTwMw77umnt3WxcP87GvGB7mY181PMzHvkp4mI99BfCwn/bu6UoSAACi6CqPtW2NbZtxdnaTRON93JdGnVMX9tXCw2BfMTwM9tXCw2BfLTwM9hXDw2BfLTwM9hXDw2BfUTwM9pVec+22Q+jVYAjFsC94WAv7gofFsC94WAv7gofFsC94WAD7cjfnNK6Ch8G+WngY7CuGh8G+WngY7CuJh/WxL3gY7GvYXQyGUAD7gofBvgJ4GOyrhof1sS94GOxr2D0aAh4WwL7gYbCvBh7Wx77gYbCvYbcwGEIB7AseFsC+4GGwr8Caa7dt4GGwrxYeBvuK4WGwrxYeBvuK4WGwrxYeBvtq4WGwrxgeBvuq4WGwr8DdnNO4Kh4G+4rhYbCvFh4G+2rhYbCvHh7Wx77gYX3sCx7Wx77gYbCvYXcL+6rhYS3sS5uwrzAeFsC+9K+Gfbmba53G6W0M+9IJ7KuGh7WwL63UsC9rbmu31XfYVw0Pa2FfehbDvrRXw77gYS3sSzM17Ase1sK+9DGGfem6hn3Bw1rYlzZq2Bc8rIV96U8Y+7Lm2m0DvYphXzquYV/wsBb2paUa9gUPa2Ff+hbGvtzNOY0L9AT2FWsX9hXGw2BfgaZhX2E8DPYV6APsK9YF7CuMh8G+Aq3BvsJ4GOwr0G/YVxgPg30Fegn7inUI+wrjYbCvQAuwrzAeBvsK9AX21V9z7bYZPAz2FWgb9hXGw2Bfgf7DvsJ4GOwr0DvYV6wz2FcXD4N9FVqFfVXv5pzGNfrZxL7gYbCvSs9hX7EOetgXPAz2VWquhn3Bw2BfrT7DviRJkiRJkiRJkiRJkiRJkiQNszucKAuToL+DiQAAAABJRU5ErkJggg=="
-          />
+          >
         </l-popup>
       </l-marker>
     </l-map>

src/components/LCircle.vue

@@ -31,6 +31,7 @@ export default {
     this.ready = true;
     this.parentContainer = findRealParent(this.$parent);
     this.parentContainer.addLayer(this, !this.visible);
+    this.$emit('ready', this.mapObject);
   },
   methods: {}
 };

src/components/LCircleMarker.vue

@@ -35,6 +35,7 @@ export default {
     this.ready = true;
     this.parentContainer = findRealParent(this.$parent);
     this.parentContainer.addLayer(this, !this.visible);
+    this.$emit('ready', this.mapObject);
   }
 };
 </script>

src/components/LControl.vue

@@ -29,6 +29,7 @@ export default {
     this.parentContainer = findRealParent(this.$parent);
     this.mapObject.setElement(this.$el);
     this.mapObject.addTo(this.parentContainer.mapObject);
+    this.$emit('ready', this.mapObject);
   }
 };
 </script>

src/components/LControlAttribution.vue

@@ -21,6 +21,7 @@ export default {
     this.mapObject = control.attribution(options);
     propsBinder(this, this.mapObject, this.$options.props);
     this.mapObject.addTo(this.$parent.mapObject);
+    this.$emit('ready', this.mapObject);
   },
   render () {
     return null;

src/components/LControlLayers.vue

@@ -41,6 +41,7 @@ export default {
     this.mapObject = control.layers(null, null, options);
     propsBinder(this, this.mapObject, this.$options.props);
     this.$parent.registerLayerControl(this);
+    this.$emit('ready', this.mapObject);
   },
   methods: {
     addLayer (layer) {

src/components/LControlScale.vue

@@ -36,6 +36,7 @@ export default {
     this.mapObject = control.scale(options);
     propsBinder(this, this.mapObject, this.$options.props);
     this.mapObject.addTo(this.$parent.mapObject);
+    this.$emit('ready', this.mapObject);
   },
   render () {
     return null;

src/components/LControlZoom.vue

@@ -36,6 +36,7 @@ export default {
     this.mapObject = control.zoom(options);
     propsBinder(this, this.mapObject, this.$options.props);
     this.mapObject.addTo(this.$parent.mapObject);
+    this.$emit('ready', this.mapObject);
   },
   render () {
     return null;

src/components/LFeatureGroup.vue

@@ -26,6 +26,7 @@ export default {
     if (this.visible) {
       this.parentContainer.addLayer(this);
     }
+    this.$emit('ready', this.mapObject);
   }
 };
 </script>

src/components/LGeoJson.vue

@@ -37,6 +37,7 @@ export default {
     propsBinder(this, this.mapObject, this.$options.props);
     this.parentContainer = findRealParent(this.$parent, true);
     this.parentContainer.addLayer(this, !this.visible);
+    this.$emit('ready', this.mapObject);
   },
   beforeDestroy () {
     this.parentContainer.mapObject.removeLayer(this.mapObject);

src/components/LGridLayer.vue

@@ -43,6 +43,7 @@ export default {
     this.mapObject.createTile = this.createTile;
     this.parentContainer = findRealParent(this.$parent);
     this.parentContainer.addLayer(this, !this.visible);
+    this.$emit('ready', this.mapObject);
   },
   beforeDestroy () {
     this.parentContainer.removeLayer(this.mapObject);

src/components/LIcon.vue

@@ -101,6 +101,7 @@ export default {
     );
 
     this.scheduleCreateIcon();
+    this.$emit('ready', this.mapObject);
   },
 
   beforeDestroy () {

src/components/LIconDefault.vue

@@ -14,6 +14,7 @@ export default {
   mounted () {
     Icon.Default.imagePath = this.imagePath;
     propsBinder(this, this.mapObject, this.$options.props);
+    this.$emit('ready', this.mapObject);
   },
   methods: {
     setImagePath (newVal, oldVal) {

src/components/LImageOverlay.vue

@@ -13,6 +13,7 @@ export default {
     propsBinder(this, this.mapObject, this.$options.props);
     this.parentContainer = findRealParent(this.$parent);
     this.parentContainer.addLayer(this, !this.visible);
+    this.$emit('ready', this.mapObject);
   },
   render () {
     return null;

src/components/LLayerGroup.vue

@@ -26,6 +26,7 @@ export default {
     if (this.visible) {
       this.parentContainer.addLayer(this);
     }
+    this.$emit('ready', this.mapObject);
   }
 };
 </script>

src/components/LMap.vue

@@ -156,7 +156,9 @@ export default {
     DomEvent.on(this.mapObject, this.$listeners);
     propsBinder(this, this.mapObject, this.$options.props);
     this.ready = true;
+    // DEPRECATED leaflet:load
     this.$emit('leaflet:load');
+    this.$emit('ready', this.mapObject);
   },
   methods: {
     registerLayerControl (lControlLayers) {

src/components/LMarker.vue

@@ -52,6 +52,7 @@ export default {
     this.parentContainer = findRealParent(this.$parent);
     this.parentContainer.addLayer(this, !this.visible);
     this.ready = true;
+    this.$emit('ready', this.mapObject);
   },
   methods: {
     setDraggable (newVal, oldVal) {

src/components/LPolygon.vue

@@ -31,6 +31,7 @@ export default {
     this.ready = true;
     this.parentContainer = findRealParent(this.$parent);
     this.parentContainer.addLayer(this, !this.visible);
+    this.$emit('ready', this.mapObject);
   }
 };
 </script>

src/components/LPolyline.vue

@@ -31,6 +31,7 @@ export default {
     this.ready = true;
     this.parentContainer = findRealParent(this.$parent);
     this.parentContainer.addLayer(this, !this.visible);
+    this.$emit('ready', this.mapObject);
   }
 };
 </script>