@capgo/capacitor-launch-navigator

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

Documentation

The most complete doc is available here: https://capgo.app/docs/plugins/launch-navigator/

Compatibility

Note: The major version of this plugin follows the major version of Capacitor. Use the version that matches your Capacitor installation (e.g., plugin v8 for Capacitor 8). Only the latest major version is actively maintained.

Install

You can use our AI-Assisted Setup to install the plugin. Add the Capgo skills to your AI tool using the following command:

npx skills add https://github.com/cap-go/capacitor-skills --skill capacitor-plugins

Then use the following prompt:

Use the `capacitor-plugins` skill from `cap-go/capacitor-skills` to install the `@capgo/capacitor-launch-navigator` plugin in my project.

If you prefer Manual Setup, install the plugin by running the following commands and follow the platform-specific instructions below:

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>guru</string>
    <string>om</string>
    <string>yandexmaps</string>
    <string>dgis</string>
    <string>cabify</string>
    <string>baidumap</string>
    <string>iosamap</string>
    <string>tesla</string>
    <string>taxis99</string>
</array>

Android Setup

No additional setup required! The plugin automatically handles Android 11+ (API level 30+) package visibility and is fully backward compatible with earlier Android versions.

The plugin's manifest includes <queries> declarations for all supported navigation apps, which are automatically merged into your app's manifest during the build process. On Android 10 and below, the <queries> element is safely ignored.

<queries>
    <package android:name="com.google.android.apps.maps" />
    <package android:name="com.waze" />
    <package android:name="com.citymapper.app.release" />
    <package android:name="com.ubercab" />
    <package android:name="ru.yandex.yandexnavi" />
    <package android:name="com.sygic.aura" />
    <package android:name="com.here.app.maps" />
    <package android:name="com.tranzmate" />
    <package android:name="me.lyft.android" />
    <package android:name="com.mapswithme.maps.pro" />
    <package android:name="com.tomtom.gplay.navapp" />
    <package android:name="com.bodunov.galileo" />
    <package android:name="com.bodunov.GalileoPro" />
    <package android:name="app.organicmaps" />
    <package android:name="ru.yandex.yandexmaps" />
    <package android:name="cz.seznam.mapy" />
    <package android:name="ru.dublgis.dgismobile" />
    <package android:name="com.cabify.rider" />
    <package android:name="com.baidu.BaiduMap" />
    <package android:name="com.taxis99" />
    <package android:name="com.autonavi.minimap" />
    <package android:name="com.teslamotors.tesla" />

    <intent>
        <action android:name="android.intent.action.VIEW" />
        <data android:scheme="geo" />
    </intent>
</queries>

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'}`);
});

// Fetch local provider icons for display
const { icons, failures } = await LaunchNavigator.getAppIcons({
    apps: ['google_maps', 'waze']
});

icons.forEach(icon => {
    const image = document.querySelector<HTMLImageElement>(`img[data-app="${icon.app}"]`);
    if (image) {
        image.src = icon.localUrl; // Uses the local cache after the first fetch
    }
});

// Force a refresh when an icon needs to be repaired
await LaunchNavigator.refreshAppIcons({
    apps: ['waze']
});

console.log('Icon failures:', failures);

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.
• Tesla: app: 'tesla' shares a Google Maps position text to the Tesla app. Android targets the Tesla app directly; iOS opens the native share sheet because iOS does not allow selecting another app's share extension programmatically.
• PhoneGap app identifiers: App IDs now match phonegap-launch-navigator for Navigon, HERE Maps, MAPS.ME, and 99 Taxi. Legacy IDs (garmin_navigon, here, mapsme, 99taxi) are still accepted.
• Android geo apps: app: 'geo' opens the native Android chooser for any installed app that handles the geo: URI scheme. getAvailableApps() also returns discovered geo: apps by package name, so apps like Locus Map, Komoot, and OsmAnd can be listed when installed.
• 99 Taxi: app: 'taxis_99' follows the PhoneGap app identifier. A start coordinate is required.

Supported Navigation Apps

iOS

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

Android

• Geo intent chooser
• Google Maps
• Waze
• Citymapper
• Uber
• Yandex Navigator
• Sygic
• HERE Maps
• Moovit
• Lyft
• MAPS.ME
• TomTom GO
• Guru Maps
• Organic Maps
• Yandex Maps
• Mapy.com
• 2GIS
• Cabify
• Baidu Maps
• 99 Taxi
• Gaode Maps
• Tesla
• Any installed app that supports the Android geo: URI scheme

API

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

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

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

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

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

getAppIcons(options?: GetAppIconsOptions | undefined) => Promise<ProviderIconsResult>

refreshAppIcons(options?: GetAppIconsOptions | undefined) => Promise<ProviderIconsResult>

clearIconCache(options?: ClearIconCacheOptions | undefined) => Promise<{ cleared: number; }>

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

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