Skip to content

Commit 20177ff

Browse files
author
Nicolò Maria Mezzopera
committed
feat: add ready events to the docs
1 parent 772d9bf commit 20177ff

File tree

23 files changed

+25
-60
lines changed

23 files changed

+25
-60
lines changed

‎docs/components/events-notice.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

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

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -69,9 +69,7 @@ export default {
6969

7070
## Events
7171

72-
`l-circle-marker` does not emit any event on his own.
73-
74-
[filename](../events-notice.md ':include')
72+
[filename](../shared-events.md ':include')
7573

7674
## Extends
7775

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

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -65,9 +65,7 @@ export default {
6565

6666
## Events
6767

68-
`l-circle` does not emit any event on his own.
69-
70-
[filename](../events-notice.md ':include')
68+
[filename](../shared-events.md ':include')
7169

7270
## Extends
7371

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

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -57,9 +57,7 @@ export default {
5757

5858
## Events
5959

60-
`l-control-attribution` does not emit any event on his own.
61-
62-
[filename](../events-notice.md ':include')
60+
[filename](../shared-events.md ':include')
6361

6462
## Extends
6563

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

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -93,9 +93,7 @@ export default {
9393

9494
## Events
9595

96-
`l-control-layers` does not emit any event on his own.
97-
98-
[filename](../events-notice.md ':include')
96+
[filename](../shared-events.md ':include')
9997

10098
## Extends
10199

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

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -67,9 +67,7 @@ export default {
6767

6868
## Events
6969

70-
`l-control-scale` does not emit any event on his own.
71-
72-
[filename](../events-notice.md ':include')
70+
[filename](../shared-events.md ':include')
7371

7472
## Extends
7573

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

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -69,9 +69,7 @@ export default {
6969

7070
## Events
7171

72-
`l-control-zoom` does not emit any event on his own.
73-
74-
[filename](../events-notice.md ':include')
72+
[filename](../shared-events.md ':include')
7573

7674
## Extends
7775

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

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -58,9 +58,7 @@ export default {
5858

5959
## Events
6060

61-
`l-control` does not emit any event on his own.
62-
63-
[filename](../events-notice.md ':include')
61+
[filename](../shared-events.md ':include')
6462

6563

6664
## Extends

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

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -75,9 +75,7 @@ export default {
7575

7676
## Events
7777

78-
`l-feature-group` does not emit any event on his own.
79-
80-
[filename](../events-notice.md ':include')
78+
[filename](../shared-events.md ':include')
8179

8280
## Extends
8381

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

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -77,9 +77,7 @@ export default {
7777

7878
## Events
7979

80-
`l-geo-json` does not emit any event on his own.
81-
82-
[filename](../events-notice.md ':include')
80+
[filename](../shared-events.md ':include')
8381

8482
## Extends
8583

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -70,11 +70,10 @@ export default {
7070

7171
## Events
7272

73-
`l-grid-layer` does emit any event on his own.
7473
Leaflet's `tileunload` event is internally used to trigger the destruction
7574
of the tile components when a tile leaves the visible area.
7675

77-
[filename](../events-notice.md ':include')
76+
[filename](../shared-events.md ':include')
7877

7978
## Extends
8079

‎docs/components/l-icon/README.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -152,6 +152,4 @@ export default {
152152

153153
## Events
154154

155-
`l-icon` does not emit any event on his own.
156-
157-
[filename](../events-notice.md ':include')
155+
[filename](../shared-events.md ':include')

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

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -64,9 +64,7 @@ export default {
6464

6565
## Events
6666

67-
`l-image-overlay` does not emit any event on his own.
68-
69-
[filename](../events-notice.md ':include')
67+
[filename](../shared-events.md ':include')
7068

7169
## Extends
7270

‎docs/components/l-map/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -169,14 +169,14 @@ export default {
169169

170170
## Events
171171

172-
* **leaflet:load** - emitted when the leaflet map instance is ready
172+
* **leaflet:load** - emitted when the leaflet map instance is ready **This Event is deprecated in favour of `ready`**
173173
* **update:zoom** - emitted when the zoom of the map changes - `update:zoom` is emitted together with a `Number` value representing the current `zoom`
174174
* **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)
175175
* **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)
176176

177177
!> **update:zoom**, **update:center**, **update:bounds** are all debounced events based on `leaflet` `moveend` event and support `sync` modifier
178178

179-
[filename](../events-notice.md ':include')
179+
[filename](../shared-events.md ':include')
180180

181181
## Extends
182182

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ export default {
7979

8080
!> **update:latlng** support `sync` modifier
8181

82-
[filename](../events-notice.md ':include')
82+
[filename](../shared-events.md ':include')
8383

8484
## Extends
8585

‎docs/components/l-polygon/README.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -63,9 +63,7 @@ export default {
6363

6464
## Events
6565

66-
`l-polygon` does not emit any event on his own.
67-
68-
[filename](../events-notice.md ':include')
66+
[filename](../shared-events.md ':include')
6967

7068
## Extends
7169

‎docs/components/l-polyline/README.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -63,9 +63,7 @@ export default {
6363

6464
## Events
6565

66-
`l-polyline` does not emit any event on his own.
67-
68-
[filename](../events-notice.md ':include')
66+
[filename](../shared-events.md ':include')
6967

7068
## Extends
7169

‎docs/components/l-popup/README.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -60,9 +60,7 @@ export default {
6060

6161
## Events
6262

63-
`l-popup` does not emit any event on his own.
64-
65-
[filename](../events-notice.md ':include')
63+
[filename](../shared-events.md ':include')
6664

6765
## Extends
6866

‎docs/components/l-rectangle/README.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -63,9 +63,7 @@ export default {
6363

6464
## Events
6565

66-
`l-rectangle` does not emit any event on his own.
67-
68-
[filename](../events-notice.md ':include')
66+
[filename](../shared-events.md ':include')
6967

7068
## Extends
7169

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

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -57,9 +57,7 @@ export default {
5757

5858
## Events
5959

60-
`l-tile-layer` does not emit any event on his own.
61-
62-
[filename](../events-notice.md ':include')
60+
[filename](../shared-events.md ':include')
6361

6462
## Extends
6563

‎docs/components/l-tooltip/README.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -53,9 +53,7 @@ export default {
5353

5454
## Events
5555

56-
`l-tooltip` does not emit any event on his own.
57-
58-
[filename](../events-notice.md ':include')
56+
[filename](../shared-events.md ':include')
5957

6058
## Extends
6159

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

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -81,9 +81,7 @@ export default {
8181

8282
## Events
8383

84-
`l-wms-tile-layer` does not emit any event on his own.
85-
86-
[filename](../events-notice.md ':include')
84+
[filename](../shared-events.md ':include')
8785

8886
## Extends
8987

‎docs/components/shared-events.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
* **ready** - emitted when the component is ready, - `ready` is emitted togheter with the `mapObject` dictionary that contains the underlying `leaflet` instance
2+
3+
All native leaflet events are passed through, e.g. `@leafletevent="..."`.

0 commit comments

Comments
 (0)