Directions Component for `react-native-maps`
Switch branches/tags
Nothing to show
Clone or download
bramus Merge pull request #47 from protyze/master
fetchAndRenderRoute when "mode" changes
Latest commit f58a6d1 Jun 15, 2018

react-native-maps-directions npm version

Directions component for react-native-maps – Draw a route between two coordinates, powered by the Google Maps Directions API



yarn add react-native-maps-directions

Basic Usage

Import MapViewDirections and render it as a child of a MapView component. The mandatory MapViewDirections props are:

  • origin: The origin location to start routing from
  • destination: The destination location to start routing to
  • apikey: Your Google Maps Directions API Key (request one here; if you're using an existing Google Maps API Key make sure you've enabled the Google Maps Directions API for that key using the Google API Console).
import MapViewDirections from 'react-native-maps-directions';

const origin = {latitude: 37.3318456, longitude: -122.0296002};
const destination = {latitude: 37.771707, longitude: -122.4053769};

<MapView initialRegion={…}>

Once the directions in between destination and origin has been fetched, a MapView.Polyline between the two will be drawn. Whenever one of both changes, new directions will be fetched and rendered.

Component API


Prop Type Default Note
origin LatLng or String The origin location to start routing from.
destination LatLng or String The destination location to start routing to.
apikey String Your Google Maps API Key (request one here; if you're using an existing Google Maps API Key make sure you've enabled the Google Maps Directions API for that key using the Google API Console by hitting the “Enable APIs and Services“ button).
waypoints [LatLng or String] Array of waypoints to use between origin and destination.
language String "en" The language to use when calculating directions. See here for more info.
mode String "driving" Which transportation mode to use when calculating directions. Allowed values are "driving", "bicycling", "walking", and "transit". (See here for more info).
resetOnChange boolean true Tweak if the rendered MapView.Polyline should reset or not when calculating the route between origin and destionation. Set to false if you see the directions line glitching.
directionsServiceBaseUrl string (Google's) Base URL of the Directions Service (API) you are using. By default the Google Directions API is used (""). Usually you won't need to change this.

More props

Since the result rendered on screen is a MapView.Polyline component, all MapView.Polyline props – except for coordinates – are also accepted.

<MapView initialRegion={…}>

An extra note on origin and destination

The values for the origin and destination props can take several forms. They can either be:

  • Coordinates in the form of an object with latitude and longitude keys
  • Coordinates in the form of a string with latitude and longitude values separated by a comma
  • Strings representing an address
  • Strings representing a location
  • Strings containing a Place Id from the Google Maps Place API prefixed with place_id:

All examples below have the same origin location, represented in the formats mentioned above:

<MapViewDirections origin={{ latitude: 37.3317876, longitude: -122.0054812 }} destination="" />
<MapViewDirections origin="37.3317876,-122.0054812" destination="" />
<MapViewDirections origin="Apple Park Visitor Center" destination="" />
<MapViewDirections origin="10600 N Tantau Ave, Cupertino, CA 95014, USA" destination="" />
<MapViewDirections origin="place_id:ChIJW5i0tJC1j4ARoUGtkogTaUU" destination="" />

Note: The origin and destination props don't need to use the same representation, you may mix them.

Tip: Don't forget to tweak the language prop when using localized location names.


Event Name Returns Notes
onStart { origin, destination, waypoints: [] } Callback that is called when the routing has started.
onReady { distance: Number, duration: Number, coordinates: [], fare: Object } Callback that is called when the routing has succesfully finished.
onError errorMessage Callback that is called in case the routing has failed.

Extended Example

This example will draw a route between AirBnB's Office and Apple's HQ

import React, { Component } from 'react';
import { Dimensions, StyleSheet } from 'react-native';
import MapView from 'react-native-maps';
import MapViewDirections from 'react-native-maps-directions';

const { width, height } = Dimensions.get('window');
const ASPECT_RATIO = width / height;
const LATITUDE = 37.771707;
const LONGITUDE = -122.4053769;
const LATITUDE_DELTA = 0.0922;


class Example extends Component {

  constructor(props) {

    // AirBnB's Office, and Apple Park
    this.state = {
      coordinates: [
          latitude: 37.3317876,
          longitude: -122.0054812,
          latitude: 37.771707,
          longitude: -122.4053769,

    this.mapView = null;

  onMapPress = (e) => {
      coordinates: [

  render() {
    return (
          latitude: LATITUDE,
          longitude: LONGITUDE,
          latitudeDelta: LATITUDE_DELTA,
          longitudeDelta: LONGITUDE_DELTA,
        ref={c => this.mapView = c}
        {, index) =>
          <MapView.Marker key={`coordinate_${index}`} coordinate={coordinate} />
        {(this.state.coordinates.length >= 2) && (
            waypoints={ (this.state.coordinates.length > 2) ? this.state.coordinates.slice(1, -1): null}
            onStart={(params) => {
              console.log(`Started routing between "${params.origin}" and "${params.destination}"`);
            onReady={(result) => {
              this.mapView.fitToCoordinates(result.coordinates, {
                edgePadding: {
                  right: (width / 20),
                  bottom: (height / 20),
                  left: (width / 20),
                  top: (height / 20),
            onError={(errorMessage) => {
              // console.log('GOT AN ERROR');

export default Example;


Please see CHANGELOG for more information on what has changed recently.


This code is inspired upon the article React Native Maps with Google Directions Api by Ali Oğuzhan Yıldız.


The MIT License (MIT). Please see License File for more information.