Leaflet Routing Machine

This plugin is barely maintained! It has been a good long while since I had any reason to work with routing or Leaflet, and it does not look like that will change. I do not spend time on maintaining this plugin, and only rarely can I find time to respond to issues. If you want to take over as maintainer, feel free to contact me at [email protected].

Find the way from A to B on a Leaflet map. The plugin supports multiple backends:

• OSRM - builtin and used by default (version 5)
• Mapbox Directions API - builtin with the class L.Routing.Mapbox
• GraphHopper - through plugin lrm-graphopper
• Mapzen Valhalla - through plugin lrm-valhalla
• TomTom Online Routing API - through plugin lrm-tomtom by Mathias Rohnstock
• Legacy support for OSRM version 4 through plugin lrm-osrm4
• Esri - through plugin lrm-esri

Features

• Standard Leaflet control, with Leaflet look and feel
• Routing from start to destination, with possibility of via points
• Add, edit and remove waypoints through both address input and using the map
• Multiple language support
• Highly customizable for advanced use
• Customizable look (theming / skins)
• Open Source released under ISC License (more or less equivalent with the MIT license)

Go to the Leaflet Routing Machine site for more information, demos, tutorials and more.

Update 2020-04-06: Out of the box, Leaflet Routing Machine relies on OSRM's demo server. At this moment, the demo server (which is outside scope of the plugin and outside control of the plugin's author) is no longer maintained, and its SSL certificate has expired. The plugin will not work unless you configure a routing backend yourself. I am sorry to say that, to my knowledge, there is no good default.

Support and New Features

Leaflet Routing Machine is in many ways already a feature complete routing UI. Most likely, your requirements are already covered and require very little adaptation.

For questions and discussions, you might want to look at the Leaflet Routing Machine gitter.

Building

yarn bundle

This requires Node and npm, or yarn.

Usage

Download latest release, or obtain the latest release via unpkg.com.

<link rel="stylesheet" href="https://unpkg.com/[email protected]/dist/leaflet-routing-machine.css" />
<script src="https://unpkg.com/[email protected]/dist/leaflet-routing-machine.js"></script>

or via npm/yarn:

npm install --save @myorders/leaflet-routing-machine

yarn add @myorders/leaflet-routing-machine

import * as L from 'leaflet';
import { OSRMv1, Control as RoutingControl } from '@myorders/leaflet-routing-machine';

const map = new L.Map();
const serviceUrl = 'https://routing.myorders.io';
const router = new OSRMv1({ serviceUrl, profile: 'driving' });
const routingControl = new RoutingControl({ waypoints: [...], router }).addTo(leafletMap);

Customize Waypoint Markers

You can now customize waypoint markers with markerOptions option for the RoutingControl.

import * as L from 'leaflet';
import { OSRMv1, Control as RoutingControl } from '@myorders/leaflet-routing-machine';

const map = new L.Map();
const serviceUrl = 'https://routing.myorders.io';
const router = new OSRMv1({ serviceUrl, profile: 'driving' });
const routingControl = new RoutingControl({ 
    waypoints: [...], 
    markerOptions: {
        icon: L.icon({ ... })
    },
    router 
}).addTo(leafletMap);

Go to the Leaflet Routing Machine site for more information, demos, tutorials and more.