React components for Leaflet maps.
npm install react-leafletReact, ReactDOM and Leaflet are peer dependencies, if you haven't already installed them use:
npm install leaflet react react-dom react-leafletAn UMD build is also available on npmcdn:
<script src="https://npmcdn.com/react-leaflet/dist/react-leaflet.min.js"></script>The library is injected as window.ReactLeaflet.
If you are not familiar with Leaflet, make sure you read its quick start guide first. You will need to add its CSS to your page to render the components properly.
All components are React wrappers for Leaflet elements and layers, they need a map instance and therefore must be included in a top-level <Map> component.
Leaflet example
import L from 'leaflet';
const position = [51.505, -0.09];
const map = L.map('map').setView(position, 13);
L.tileLayer('http://{s}.tile.osm.org/{z}/{x}/{y}.png', {
attribution: '© <a href="http://osm.org/copyright">OpenStreetMap</a> contributors'
}).addTo(map);
L.marker(position).addTo(map)
.bindPopup('A pretty CSS3 popup. <br> Easily customizable.');React-Leaflet
import React from 'react';
import { render } from 'react-dom';
import { Map, Marker, Popup, TileLayer } from 'react-leaflet';
const position = [51.505, -0.09];
const map = (
<Map center={position} zoom={13}>
<TileLayer
url='http://{s}.tile.osm.org/{z}/{x}/{y}.png'
attribution='© <a href="http://osm.org/copyright">OpenStreetMap</a> contributors'
/>
<Marker position={position}>
<Popup>
<span>A pretty CSS3 popup.<br/>Easily customizable.</span>
</Popup>
</Marker>
</Map>
);
render(map, document.getElementById('map-container'));Note that the <Map> component creates its own <div> container for the map, it does not get attached to an existing node.
This library uses React components as an interface, but not the virtual DOM, as all the DOM manipulations are managed by Leaflet, so there are a few things to keep in mind when using it:
- Leaflet makes direct calls to the DOM when it is loaded, therefore this library is not compatible with server-side rendering.
- The components exposed are abstractions for Leaflet layers, not DOM elements. Some of them have properties that can be updated directly by calling the setters exposed by Leaflet while others should be completely replaced, by setting an unique value on their
keyproperty so that they are properly handled by React's algorithm. - Not all layers are implemented and even less tested.
setIconDefaultImagePath(path: string): Setter for Leaflet.Icon.Default.imagePath, set to //cdnjs.cloudflare.com/ajax/libs/leaflet/0.7.7/images by default.
latLng: One of [number, number], {lat: number, lng: number} or {lat: number, lon: number}.
latLngList: An Array of LatLng.
bounds: An instance of Leaflet.LatLngBounds or a LatLngList.
controlPosition: One of topleft, topright, bottomleft or bottomright.
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 onLeaflet or simply on. Ex: <Map onLeafletMoveend={this.handleMoveend}>...</Map>.
Check Leaflet documentation for the events associated to each component.
The properties documented as dynamic properties are updated using the relevant Leaflet setter, other properties will not update the component when they are changed after the component is mounted.
All other properties are passed as the options argument to their corresponding Leaflet element and should work fine for static maps, it is however unlikely that they would updated if you change them afterwards.
You can directly access the Leaflet element created by a component using the getLeafletElement() method on this component. This leaflet element is usually created in componentWillMount(), except for the Map component where it can only be created after the <div> container is rendered.
These components are base classes used by other components. They can be extended to create custom components but should not be used directly.
Base class extending React.Component and handling events binding and unbind.
It exposes a getLeafletElement() method to access the Leaflet object created for the component.
Base class extending React.Component for controls.
It exposes a getLeafletElement() method to access the Leaflet object created for the control.
Base class extending MapComponent using the provided map prop to add its element and passing it down to its children.
It exposes the following methods:
getClonedChildrenWithMap(object extra): object: returns the cloned children of the component, adding themapand theextraprops provided to them.renderChildrenWithProps(object props): object: returns the cloned children of the component usinggetClonedChildrenWithMap(), wrapped in a<div>withdisplay: nonestyle.
Base class extending MapLayer with a render() method and handling a TitleLayer opacity and zIndex props.
Base class extending MapLayer with the following methods:
getPathOptions(object props): object: filters the inputpropsand return a new object of Path options properties.setStyle(object options = {}): void: alias to the Leaflet elementsetStyle().setStyleIfChanged(object fromProps, object toProps): void: extracts the Path options of the two arguments, and callssetStyle()with the new options if different from the previous ones.
This is the top-level component that must be mounted for children ones to be rendered. Refer to Leaflet documentation for more information about the properties.
Dynamic properties
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. This property is dynamic, if you change it it will be reflected on the map.boundsOptions: object(optional): Options passed to thefitBounds()method.center: latLng(optional): Center of the map. This property is dynamic, if you change it it will be reflected in the map.className: string(optional): className property of the<div>container for the map.maxBounds: bounds(optional)style: object(optional): style property of the<div>container for the map.zoom: number(optional)
Other properties
id: string(optional): The ID of the<div>container for the map. If you don't provide it, a unique one will be created.
Dynamic properties
position: latLng(required)icon: Leaflet.Icon(optional)zIndexOffset: number(optional)opacity: number(optional)
The Popup children will be rendered using ReactDOM.render(), they must be valid React elements.
Dynamic properties
position: latLng(optional)
Dynamic properties
url: string(required)opacity: number(optional)zIndex: number(optional)
Dynamic properties
url: string(required)opacity: number(optional)
- CanvasTileLayer
- WMSTileLayer
All vector layers extend the Path component and therefore accept dynamic Path options properties.
Dynamic properties
center: latLng(required)radius: number(required)
Dynamic properties
center: latLng(required)radius: number(optional)
Dynamic properties
positions: latLngList(required)
Dynamic properties
polylines: array<latLngList>(required)
Dynamic properties
positions: latLngList | Array<latLngList>(required)
Dynamic properties
polygons: array<latLngList>(required)
Dynamic properties
bounds: bounds(required, dynamic)
Use the LayerGroup wrapper component to group children layers together.
Extended LayerGroup supporting a Popup child.
Properties
data: GeoJSON(required). This property will not be updated if it is changed after the component is mounted.
Dynamic properties
position: controlPosition(optional)
Dynamic properties
position: controlPosition(optional)
Other properties
baseLayers: object(optional)overlays: object(optional)
Dynamic properties
position: controlPosition(optional)
Dynamic properties
position: controlPosition(optional)
If you want to create custom components, for example Leaflet plugins, you could extend one of the base components depending on the type of component you want to implement.
The created Leaflet map instance is injected by the Map component to all its children as the map property. Make sure to inject it in your component's children as well.
See CHANGELOG file.
MIT
See LICENSE file.