View on GitHub

@nativescript/directions ​

A plugin that allows you to launch the Google Maps app, if it's installed on the device, with some directions. For more information, visit Directions action.

Contents ​

• Installation
• Use @nativescript/directions
  • Launch Google Maps with directions
  • Check if the Google Maps app is installed
• API
  • Directions methods
    • NavigateToOptions

Installation ​

To install the plugin, run the following command in the root directory of your app.

npm install @nativescript/directions

Use @nativescript/directions ​

Launch Google Maps with directions ​

To launch Google Maps with the desired directions, call the navigate method on Directions instance passing it a NavigateToOptions object.

import { Directions } from '@nativescript/directions'

const directions = new Directions()

directions
  .navigate({
    from: {
      lat: 52.215987,
      lng: 5.282764,
    },
    to: [
      {
        address: 'Hof der Kolommen 34, Amersfoort, Netherlands',
      },
      {
        address: 'Aak 98, Wieringerwerf, Netherlands',
      },
    ],
    type: 'walking',
    ios: {
      preferGoogleMaps: true,
      allowGoogleMapsWeb: true,
      useUniversalSyntax: true,
    },
    android: {
      newTask: true,
    },
  })
  .then(
    () => {
      console.log('Maps app launched.')
    },
    (error) => {
      console.log(error)
    }
  )

Check if the Google Maps app is installed ​

If you need to check if the Google Maps mobile application is installed on the device, call the available method.

const directions = new Directions()

directions.available().then((avail: boolean) => {
  console.log(avail ? 'Yes' : 'No')
})

API ​

Directions methods ​

The Directions class has the following two methods:

NavigateToOptions ​

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

AddressOptions ​

NavigateToOptionsType ​

;'driving' | 'transit' | 'bicycling' | 'walking'

iOSOptions ​

AndroidOptions ​

License ​

Apache License Version 2.0