@mapbox/mapbox-gl-directions

Mapbox GL Directions
---

A full featured directions plugin for Mapbox GL JS using the Mapbox Directions API. Quickly add UI to display driving, cycling, or walking directions on the map. The Mapbox Directions API is powered by the OSRM routing engine and open data from the OpenStreetMap project.

For directions functionality in native mobile and desktop applications, see Mapbox Android Services, MapboxDirections.swift, and MapboxNavigation.swift.

$3

``javascript
var mapboxgl = require('mapbox-gl');
var MapboxDirections = require('@mapbox/mapbox-gl-directions');

var directions = new MapboxDirections({
accessToken: 'YOUR-MAPBOX-ACCESS-TOKEN',
unit: 'metric',
profile: 'mapbox/cycling'
});

var map = new mapboxgl.Map({
container: 'map'
});

map.addControl(directions, 'top-left');
``

Live example: https://www.mapbox.com/mapbox-gl-js/example/mapbox-gl-directions/

$3

See API.md for complete reference.

$3

See CONTRIBUTING.md.