You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: docs/components.md
+32-32
Original file line number
Diff line number
Diff line change
@@ -70,7 +70,7 @@ Base class extending [`MapEvented`](#mapevented) to add support for panes.
70
70
Base class extending `React.Component` for controls.\
71
71
It exposes a `leafletElement` property to access the `Leaflet` object created for the control.
72
72
73
-
[🍃 Leaflet Control reference](http://leafletjs.com/reference-1.5.0.html#control) • [🔍 Source](https://github.com/PaulLeCam/react-leaflet/blob/master/src/MapControl.js)
73
+
[🍃 Leaflet Control reference](http://leafletjs.com/reference-1.6.0.html#control) • [🔍 Source](https://github.com/PaulLeCam/react-leaflet/blob/master/src/MapControl.js)
74
74
75
75
### MapEvented
76
76
@@ -83,31 +83,31 @@ It exposes a `leafletElement` property to access the `Leaflet` object created fo
83
83
84
84
Base class extending [`MapComponent`](#mapcomponent), handling adding the layer to the map and removing it when relevant. It exposes the `layerContainer` property, to be used by extending classes to access their containing layer.
Base class extending [`MapLayer`](#maplayer) with the following methods:
91
91
92
-
-`getPathOptions(object props): object`: filters the input `props` and return a new object of [Path options](http://leafletjs.com/reference-1.5.0.html#path-options) properties.
93
-
-`setStyle(object options = {}): void`: alias to the Leaflet element [`setStyle()`](http://leafletjs.com/reference-1.5.0.html#path-setstyle).
92
+
-`getPathOptions(object props): object`: filters the input `props` and return a new object of [Path options](http://leafletjs.com/reference-1.6.0.html#path-options) properties.
93
+
-`setStyle(object options = {}): void`: alias to the Leaflet element [`setStyle()`](http://leafletjs.com/reference-1.6.0.html#path-setstyle).
94
94
-`setStyleIfChanged(object fromProps, object toProps): void`: extracts the Path options of the two arguments, and calls `setStyle()` with the new options if different from the previous ones.
This is the top-level component that must be mounted for child components to be rendered. Refer to [🍃 Leaflet's documentation](http://leafletjs.com/reference-1.5.0.html#map-options) for more information about the properties.
100
+
This is the top-level component that must be mounted for child components to be rendered. Refer to [🍃 Leaflet's documentation](http://leafletjs.com/reference-1.6.0.html#map-options) for more information about the properties.
-`animate: boolean` (optional): If `true`, panning will always be animated if possible. Defaults to `false`.
107
107
-`duration: number` (optional): Duration of animated panning, in seconds. Defaults to `0.25`.
108
108
-`easeLinearity: number` (optional): The curvature factor of panning animation easing (third parameter of the Cubic Bezier curve). 1.0 means linear animation, and the smaller this number, the more bowed the curve. Defaults to `0.25`.
109
109
-`noMoveStart: boolean` (optional): If true, panning won't fire movestart event on start (used internally for panning inertia). Defaults to `false`.
110
-
-`bounds: bounds` (optional): A rectangle for the map to contain. It will be centered, and the map will zoom in as close as it can while still showing the full bounds. Changes are compared using the [`🍃 equals() method of LatLngBounds`](http://leafletjs.com/reference-1.5.0.html#latlngbounds-equals).
110
+
-`bounds: bounds` (optional): A rectangle for the map to contain. It will be centered, and the map will zoom in as close as it can while still showing the full bounds. Changes are compared using the [`🍃 equals() method of LatLngBounds`](http://leafletjs.com/reference-1.6.0.html#latlngbounds-equals).
111
111
-`boundsOptions: Object` (optional): Options passed to the `fitBounds()` method.
112
112
-`boxZoom: boolean` (optional): If `true`, the map can be zoomed to a rectangular area specified by dragging the mouse while pressing the shift key. Defaults to true.
113
113
-`center: latLng` (optional if `viewport` is provided with a center value): Center of the map. Changes are compared by value, so `[51.0, 0.0]` is considered the same as `{lat: 51, lng: 0}`.
@@ -129,7 +129,7 @@ This is the top-level component that must be mounted for child components to be
129
129
**Other properties**
130
130
131
131
-`id: string` (optional): The ID of the `<div>` container for the map.
132
-
-`whenReady: () => void` (optional): A function called as soon as the map is ready, see [🍃 Leaflet's documentation](http://leafletjs.com/reference-1.5.0.html#map-whenready) for more information.
132
+
-`whenReady: () => void` (optional): A function called as soon as the map is ready, see [🍃 Leaflet's documentation](http://leafletjs.com/reference-1.6.0.html#map-whenready) for more information.
133
133
134
134
**Manipulating the viewport**
135
135
@@ -197,7 +197,7 @@ See the [viewport example](https://github.com/PaulLeCam/react-leaflet/blob/maste
Only children components of the `Pane` component will be added to the corresponding pane. This does not affect the behavior of other Leaflet factories used in these children.
203
203
@@ -211,7 +211,7 @@ Only children components of the `Pane` component will be added to the correspond
Copy file name to clipboardexpand all lines: docs/events.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -6,4 +6,4 @@ title: Events
6
6
Leaflet exposes its own events, different from React. You can listen to them using React-Leaflet by adding a callback to a property prefixed by `on`. Ex: `<Map onMoveend={this.handleMoveend}>...</Map>`.\
7
7
The event name is normalized, so the above example would work using the `onmoveend`, `onMoveend`, `onMoveEnd` or another naming preference for the property.
8
8
9
-
Check [🍃 Leaflet's documentation](http://leafletjs.com/reference-1.5.0.html) for the events associated to each component.
9
+
Check [🍃 Leaflet's documentation](http://leafletjs.com/reference-1.6.0.html) for the events associated to each component.
Copy file name to clipboardexpand all lines: website/versioned_docs/version-v2/components.md
+32-32
Original file line number
Diff line number
Diff line change
@@ -71,7 +71,7 @@ Base class extending [`MapEvented`](#mapevented) to add support for panes.
71
71
Base class extending `React.Component` for controls.\
72
72
It exposes a `leafletElement` property to access the `Leaflet` object created for the control.
73
73
74
-
[🍃 Leaflet Control reference](http://leafletjs.com/reference-1.5.0.html#control) • [🔍 Source](https://github.com/PaulLeCam/react-leaflet/blob/master/src/MapControl.js)
74
+
[🍃 Leaflet Control reference](http://leafletjs.com/reference-1.6.0.html#control) • [🔍 Source](https://github.com/PaulLeCam/react-leaflet/blob/master/src/MapControl.js)
75
75
76
76
### MapEvented
77
77
@@ -84,31 +84,31 @@ It exposes a `leafletElement` property to access the `Leaflet` object created fo
84
84
85
85
Base class extending [`MapComponent`](#mapcomponent), handling adding the layer to the map and removing it when relevant. It exposes the `layerContainer` property, to be used by extending classes to access their containing layer.
Base class extending [`MapLayer`](#maplayer) with the following methods:
92
92
93
-
-`getPathOptions(object props): object`: filters the input `props` and return a new object of [Path options](http://leafletjs.com/reference-1.5.0.html#path-options) properties.
94
-
-`setStyle(object options = {}): void`: alias to the Leaflet element [`setStyle()`](http://leafletjs.com/reference-1.5.0.html#path-setstyle).
93
+
-`getPathOptions(object props): object`: filters the input `props` and return a new object of [Path options](http://leafletjs.com/reference-1.6.0.html#path-options) properties.
94
+
-`setStyle(object options = {}): void`: alias to the Leaflet element [`setStyle()`](http://leafletjs.com/reference-1.6.0.html#path-setstyle).
95
95
-`setStyleIfChanged(object fromProps, object toProps): void`: extracts the Path options of the two arguments, and calls `setStyle()` with the new options if different from the previous ones.
This is the top-level component that must be mounted for child components to be rendered. Refer to [🍃 Leaflet's documentation](http://leafletjs.com/reference-1.5.0.html#map-options) for more information about the properties.
101
+
This is the top-level component that must be mounted for child components to be rendered. Refer to [🍃 Leaflet's documentation](http://leafletjs.com/reference-1.6.0.html#map-options) for more information about the properties.
-`animate: boolean` (optional): If `true`, panning will always be animated if possible. Defaults to `false`.
108
108
-`duration: number` (optional): Duration of animated panning, in seconds. Defaults to `0.25`.
109
109
-`easeLinearity: number` (optional): The curvature factor of panning animation easing (third parameter of the Cubic Bezier curve). 1.0 means linear animation, and the smaller this number, the more bowed the curve. Defaults to `0.25`.
110
110
-`noMoveStart: boolean` (optional): If true, panning won't fire movestart event on start (used internally for panning inertia). Defaults to `false`.
111
-
-`bounds: bounds` (optional): A rectangle for the map to contain. It will be centered, and the map will zoom in as close as it can while still showing the full bounds. Changes are compared using the [`🍃 equals() method of LatLngBounds`](http://leafletjs.com/reference-1.5.0.html#latlngbounds-equals).
111
+
-`bounds: bounds` (optional): A rectangle for the map to contain. It will be centered, and the map will zoom in as close as it can while still showing the full bounds. Changes are compared using the [`🍃 equals() method of LatLngBounds`](http://leafletjs.com/reference-1.6.0.html#latlngbounds-equals).
112
112
-`boundsOptions: Object` (optional): Options passed to the `fitBounds()` method.
113
113
-`boxZoom: boolean` (optional): If `true`, the map can be zoomed to a rectangular area specified by dragging the mouse while pressing the shift key. Defaults to true.
114
114
-`center: latLng` (optional if `viewport` is provided with a center value): Center of the map. Changes are compared by value, so `[51.0, 0.0]` is considered the same as `{lat: 51, lng: 0}`.
@@ -130,7 +130,7 @@ This is the top-level component that must be mounted for child components to be
130
130
**Other properties**
131
131
132
132
-`id: string` (optional): The ID of the `<div>` container for the map.
133
-
-`whenReady: () => void` (optional): A function called as soon as the map is ready, see [🍃 Leaflet's documentation](http://leafletjs.com/reference-1.5.0.html#map-whenready) for more information.
133
+
-`whenReady: () => void` (optional): A function called as soon as the map is ready, see [🍃 Leaflet's documentation](http://leafletjs.com/reference-1.6.0.html#map-whenready) for more information.
134
134
135
135
**Manipulating the viewport**
136
136
@@ -198,7 +198,7 @@ See the [viewport example](https://github.com/PaulLeCam/react-leaflet/blob/maste
Only children components of the `Pane` component will be added to the corresponding pane. This does not affect the behavior of other Leaflet factories used in these children.
204
204
@@ -212,7 +212,7 @@ Only children components of the `Pane` component will be added to the correspond
Copy file name to clipboardexpand all lines: website/versioned_docs/version-v2/events.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -7,4 +7,4 @@ original_id: events
7
7
Leaflet exposes its own events, different from React. You can listen to them using React-Leaflet by adding a callback to a property prefixed by `on`. Ex: `<Map onMoveend={this.handleMoveend}>...</Map>`.\
8
8
The event name is normalized, so the above example would work using the `onmoveend`, `onMoveend`, `onMoveEnd` or another naming preference for the property.
9
9
10
-
Check [🍃 Leaflet's documentation](http://leafletjs.com/reference-1.5.0.html) for the events associated to each component.
10
+
Check [🍃 Leaflet's documentation](http://leafletjs.com/reference-1.6.0.html) for the events associated to each component.
0 commit comments