Package Exports

@capgo/capacitor-launch-navigator
@capgo/capacitor-launch-navigator/dist/esm/index.js
@capgo/capacitor-launch-navigator/dist/plugin.cjs.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@capgo/capacitor-launch-navigator) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

@capgo/capacitor-launch-navigator

➡️ Get Instant updates for your App with Capgo

Missing a feature? We’ll build the plugin for you 💪

Capacitor plugin for launching navigation apps to navigate to a destination.

This plugin is a Capacitor port of the popular phonegap-launch-navigator plugin, supporting navigation with latitude/longitude coordinates only (no address support - use @capgo/capacitor-nativegeocoder for address geocoding).

Install

npm install @capgo/capacitor-launch-navigator
npx cap sync

iOS Setup

Add URL schemes to your Info.plist to detect installed navigation apps:

<key>LSApplicationQueriesSchemes</key>
<array>
    <string>comgooglemaps</string>
    <string>waze</string>
    <string>citymapper</string>
    <string>navigon</string>
    <string>transit</string>
    <string>yandexnavi</string>
    <string>uber</string>
    <string>tomtomgo</string>
    <string>com.sygic.aura</string>
    <string>here-route</string>
    <string>moovit</string>
    <string>lyft</string>
    <string>mapsme</string>
    <string>cabify</string>
    <string>baidumap</string>
    <string>iosamap</string>
    <string>99app</string>
</array>

Usage

import { LaunchNavigator, IOSNavigationApp, AndroidNavigationApp, TransportMode } from '@capgo/capacitor-launch-navigator';

// Navigate to a location using default app
await LaunchNavigator.navigate({
    destination: [37.7749, -122.4194] // San Francisco coordinates
});

// Navigate with options
await LaunchNavigator.navigate({
    destination: [37.7749, -122.4194],
    options: {
        start: [37.7849, -122.4094], // Starting point
        app: 'google_maps', // Specific app to use
        transportMode: TransportMode.DRIVING
    }
});

// Check if an app is available
const { available } = await LaunchNavigator.isAppAvailable({
    app: IOSNavigationApp.GOOGLE_MAPS
});

// Get list of available navigation apps
const { apps } = await LaunchNavigator.getAvailableApps();
apps.forEach(app => {
    console.log(`${app.name} is ${app.available ? 'available' : 'not installed'}`);
});

Important Notes

Coordinates Only: This plugin only accepts latitude/longitude coordinates for navigation. Address strings are not supported.
Address Geocoding: If you need to convert addresses to coordinates, use @capgo/capacitor-nativegeocoder.

iOS

Apple Maps
Google Maps
Waze
Citymapper
Garmin Navigon
Transit App
Yandex Navigator
Uber
TomTom
Sygic
HERE Maps
Moovit
Lyft
MAPS.ME
Cabify
Baidu Maps
Gaode Maps
99 Taxi

Android

Google Maps
Waze
Citymapper
Uber
Yandex Navigator
Sygic
HERE Maps
Moovit
Lyft
MAPS.ME
Cabify
Baidu Maps
Gaode Maps

Main plugin interface

navigate(...)

navigate(options: { destination: [number, number]; options?: NavigateOptions; }) => Promise<void>

Navigate to a location using latitude and longitude

Param	Type	Description
`options`	`{ destination: [number, number]; options?: NavigateOptions; }`	Navigation options with destination coordinates

isAppAvailable(...)

isAppAvailable(options: { app: IOSNavigationApp | AndroidNavigationApp | string; }) => Promise<{ available: boolean; }>

Check if a specific navigation app is available

Param	Type	Description
`options`	`{ app: string; }`	Options containing app identifier

Returns: Promise<{ available: boolean; }>

getAvailableApps()

getAvailableApps() => Promise<{ apps: AvailableApp[]; }>

Get list of available navigation apps on the device

Returns: Promise<{ apps: AvailableApp[]; }>

getSupportedApps()

getSupportedApps() => Promise<{ apps: string[]; }>

Get list of supported apps for the current platform

Returns: Promise<{ apps: string[]; }>

getDefaultApp()

getDefaultApp() => Promise<{ app: string; }>

Get the name of the default app for navigation

Returns: Promise<{ app: string; }>

getPluginVersion()

getPluginVersion() => Promise<{ version: string; }>

Get the native Capacitor plugin version

Returns: Promise<{ version: string; }>

Interfaces

NavigateOptions

Options for navigation

Prop	Type	Description
`start`	`[number, number]`	Starting location coordinates [latitude, longitude]
`startName`	`string`	Starting location name
`destinationName`	`string`	Destination name (will be ignored since we only support coordinates)
`transportMode`	`TransportMode`	Transport mode
`app`	`string`	Specific app to launch (if not specified, will use default or prompt)
`launchMode`	`LaunchMode`	Launch mode
`extras`	`Record<string, any>`	Additional parameters specific to certain apps
`enableDebug`	`boolean`	Enable debug logging

AvailableApp

Result of checking app availability

Prop	Type	Description
`app`	`string`	App identifier
`name`	`string`	Display name of the app
`available`	`boolean`	Whether the app is available on the device

Type Aliases

Record

Construct a type with a set of properties K of type T

{ [P in K]: T; }

Enums

TransportMode

Members	Value
`DRIVING`	`'driving'`
`WALKING`	`'walking'`
`BICYCLING`	`'bicycling'`
`TRANSIT`	`'transit'`

IOSNavigationApp

Members	Value
`APPLE_MAPS`	`'apple_maps'`
`GOOGLE_MAPS`	`'google_maps'`
`WAZE`	`'waze'`
`CITYMAPPER`	`'citymapper'`
`GARMIN_NAVIGON`	`'garmin_navigon'`
`TRANSIT_APP`	`'transit_app'`
`YANDEX_NAVIGATOR`	`'yandex'`
`UBER`	`'uber'`
`TOMTOM`	`'tomtom'`
`SYGIC`	`'sygic'`
`HERE_MAPS`	`'here'`
`MOOVIT`	`'moovit'`
`LYFT`	`'lyft'`
`MAPS_ME`	`'mapsme'`
`CABIFY`	`'cabify'`
`BAIDU`	`'baidu'`
`GAODE`	`'gaode'`
`TAXI_99`	`'99taxi'`

AndroidNavigationApp

Members	Value
`GOOGLE_MAPS`	`'google_maps'`
`WAZE`	`'waze'`
`CITYMAPPER`	`'citymapper'`
`UBER`	`'uber'`
`YANDEX`	`'yandex'`
`SYGIC`	`'sygic'`
`HERE_MAPS`	`'here'`
`MOOVIT`	`'moovit'`
`LYFT`	`'lyft'`
`MAPS_ME`	`'mapsme'`
`CABIFY`	`'cabify'`
`BAIDU`	`'baidu'`
`GAODE`	`'gaode'`

LaunchMode

Members	Value
`MAPS`	`'maps'`
`TURN_BY_TURN`	`'turn_by_turn'`
`GEO`	`'geo'`

This plugin was inspired by the work of https://github.com/dpa99c/phonegap-launch-navigator