feat: add ready events to the docs

Nicolò Maria Mezzopera · Nicolò Maria Mezzopera · commit 20177ff3c28f · 2019-04-20T21:49:36.000+02:00
diff --git a/docs/components/events-notice.md b/docs/components/events-notice.md
diff --git a/docs/components/l-circle-marker/README.md b/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
 
diff --git a/docs/components/l-circle/README.md b/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
 
diff --git a/docs/components/l-control-attribution/README.md b/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
 
diff --git a/docs/components/l-control-layers/README.md b/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
 
diff --git a/docs/components/l-control-scale/README.md b/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
 
diff --git a/docs/components/l-control-zoom/README.md b/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
 
diff --git a/docs/components/l-control/README.md b/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
diff --git a/docs/components/l-feature-group/README.md b/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
 
diff --git a/docs/components/l-geo-json/README.md b/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
 
diff --git a/docs/components/l-grid-layer/README.md b/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
 
diff --git a/docs/components/l-icon/README.md b/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')
diff --git a/docs/components/l-image-overlay/README.md b/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
 
diff --git a/docs/components/l-map/README.md b/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
 
diff --git a/docs/components/l-marker/README.md b/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
 
diff --git a/docs/components/l-polygon/README.md b/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
 
diff --git a/docs/components/l-polyline/README.md b/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
 
diff --git a/docs/components/l-popup/README.md b/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
 
diff --git a/docs/components/l-rectangle/README.md b/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
 
diff --git a/docs/components/l-tile-layer/README.md b/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
 
diff --git a/docs/components/l-tooltip/README.md b/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
 
diff --git a/docs/components/l-wms-tile-layer/README.md b/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
 
diff --git a/docs/components/shared-events.md b/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="..."`.
