Need private packages and team management tools?Check out npm Teams »

nativescript-directions

1.3.1 • Public • Published

NativeScript Directions plugin

Build Status NPM version Downloads Twitter Follow

Installation

From the command prompt go to your app's root folder and execute:

tns plugin add nativescript-directions

Usage

Demo app (XML + TypeScript)

Want to dive in quickly? Check out the demo app! Otherwise, continue reading.

You can run the demo app from the root of the project by typing npm run demo.ios.device or npm run demo.android.

Demo app (Angular)

This plugin is part of the plugin showcase app I built using Angular.

API

available

Not all devices have the Google (Android) or Apple (iOS) Maps app installed. Well, most do of course, but on an Android simulator you may be out of luck, so let's check beforehand:

JavaScript
// require the plugin
var Directions = require("nativescript-directions").Directions;
 
// instantiate the plugin
var directions = new Directions();
 
directions.available().then(
  function(avail) {
    console.log(avail ? "Yes" : "No");
  }
);
TypeScript
// require the plugin
import { Directions } from "nativescript-directions";
 
// instantiate the plugin
let directions = new Directions();
 
directions.available().then(avail => {
    console.log(avail ? "Yes" : "No");
});

navigate

This function opens the native Maps app with a predefined from and to address.

If you don't pass from the current location of the user will be used.

If an address is specified then lat and lng will be ignored.

If you pass in an Array of to addresses, then the last item is the destination, the others become 'waypoints'.

Note that if there's an ocean in between from and to you won't be able to get directions, don't blame this plugin for that 😁

JavaScript
directions.navigate({
  from: { // optional, default 'current location'
    lat: 52.215987,
    lng: 5.282764
  },
  to: { // either pass in a single object or an Array (see the TypeScript example below)
    address: "Hof der Kolommen 34, Amersfoort, Netherlands"
  }
  // for iOS-specific options, see the TypeScript example below.
}).then(
  function() {
    console.log("Maps app launched.");
  },
  function(error) {
    console.log(error);
  }
);
TypeScript
directions.navigate({
  from: { // optional, default 'current location'
    lat: 52.215987,
    lng: 5.282764
  },
  to: [{ // if an Array is passed (as in this example), the last item is the destination, the addresses in between are 'waypoints'.
    address: "Hof der Kolommen 34, Amersfoort, Netherlands",
  },
  {
    address: "Aak 98, Wieringerwerf, Netherlands"
  }],
  type: "walking", // optional, can be: driving, transit, bicycling or walking
  ios: {
    preferGoogleMaps: true, // If the Google Maps app is installed, use that one instead of Apple Maps, because it supports waypoints. Default true.
    allowGoogleMapsWeb: true // If waypoints are passed in and Google Maps is not installed, you can either open Apple Maps and the first waypoint is used as the to-address (the rest is ignored), or you can open Google Maps on web so all waypoints are shown (set this property to true). Default false.
  }
}).then(() => {
    console.log("Maps app launched.");
}, error => {
    console.log(error);
});

Future work

  • Perhaps add Android-specific options like opening the map in StreetView mode, or pre-defining the transportation type (walk/bike/car).

Install

npm i nativescript-directions

DownloadsWeekly Downloads

80

Version

1.3.1

License

MIT

Unpacked Size

14.1 kB

Total Files

11

Last publish

Collaborators

  • avatar