lennerd / react-leaflet

React components for Leaflet maps

React-Leaflet

React components for Leaflet maps.

Install

npm install react-leaflet

React and Leaflet are peer dependencies, if you haven't already installed them use:

npm install leaflet react react-leaflet

Getting started

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: '&copy; <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 { 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='&copy; <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>;

React.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.

Technical considerations

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 ref property so that they are properly handled by React's algorithm.
• <Popup> contents are rendered by Leaflet calling React.renderToStaticMarkup(), therefore the rendered components have a different context from their owner.
• Not all layers are implemented and even less tested.

API

Helpers

setIconDefaultImagePath(path: string): Setter for Leaflet.Icon.Default.imagePath, set to //cdnjs.cloudflare.com/ajax/libs/leaflet/0.7.3/images by default.

PropTypes

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.

Events

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.

Components

The properties documented for each component are the ones aimed to be supported (tested and made dynamic when possible) by React-Leaflet.
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.

Base components

These components are base classes used by other components. They can be extended to create custom components but should not be used directly.

MapComponent

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.

MapLayer

Base class extending MapComponent using the provided map prop to add its element and passing it down to its children.

BaseTileLayer

Base class extending MapLayer with a render() method and handling a TitleLayer opacity and zIndex props.

PopupContainer

Base class extending MapLayer with a render() method passing its leafletElement to its children as the popupContainer prop.

Map

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.

Properties

• center: LatLng (optional, dynamic): Center of the map. This property is dynamic, if you change it it will be reflected in the map.
• className: String (optional, dynamic): className property of the <div> container for the map.
• id: String (optional): The ID of the <div> container for the map. If you don't provide it, a unique one will be created.
• maxBounds: Bounds (optional)
• maxZoom: Number (optional)
• minZoom: Number (optional)
• style: Object (optional, dynamic): style property of the <div> container for the map.
• zoom: Number (optional, dynamic)

UI Layers

Marker

• position: LatLng (required, dynamic)
• icon: Leaflet.Icon (optional, dynamic)
• zIndexOffset: Number (optional, dynamic)
• opacity: Number (optional, dynamic)

Popup

The Popup children will be rendered as its content using React.renderToStaticMarkup(), they must be valid React elements.

• position: LatLng (optional, dynamic)

Raster Layers

TileLayer

• url: String (required, dynamic)
• opacity: Number (optional, dynamic)
• zIndex: Number (optional, dynamic)

ImageOverlay

• url: String (required, dynamic)
• opacity: Number (optional, dynamic)
• attribution: String (optional)

Implemented but needing testing and documentation

• CanvasTileLayer
• WMSTileLayer

Vector Layers

Circle

• center: LatLng (required, dynamic)
• radius: Number (required, dynamic)

CircleMarker

• center: LatLng (required, dynamic)
• radius: Number (optional, dynamic)

Polyline

• positions: LatLngList (required, dynamic)

MultiPolyline

• polylines: Array<LatLngList> (required, dynamic)

Polygon

• positions: LatLngList (required, dynamic)

MultiPolygon

• polygons: Array<LatLngList> (required, dynamic)

Rectangle

• bounds: Bounds (required, dynamic)

Other Layers

Implemented but needing testing and documentation

• FeatureGroup
• GeoJson

Creating custom components

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.

Changelog

See CHANGELOG file.

License

MIT
See LICENSE file.