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

Documentation

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

Compatibility

Plugin version	Capacitor compatibility	Maintained
v8..	v8..	✅
v7..	v7..	On demand
v6..	v6..	❌
v5..	v5..	❌

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

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>99app</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.

For reference: Package queries included in the plugin

The following navigation apps are declared in the plugin's manifest:

<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.autonavi.minimap" />
    <package android:name="com.teslamotors.tesla" />
</queries>

Compatibility:

Android 11+ (API 30+): Queries are required and enforced for package visibility
Android 10 and below (API 29-): Queries element is ignored; app detection works without restrictions

This ensures the plugin works correctly across all Android versions from API 24+ without any code changes.

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 directions link 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.

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

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
Gaode Maps
Tesla

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; }>

getAppIcons(...)

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

Fetch provider icons and cache them locally.

The native implementations revalidate cached icons after 24 hours by default. Pass forceRefresh: true to bypass the cache when an icon must be repaired.

Param	Type
`options`	`GetAppIconsOptions`

Returns: Promise<ProviderIconsResult>

refreshAppIcons(...)

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

Refresh provider icons, ignoring the cache age.

Param	Type
`options`	`GetAppIconsOptions`

Returns: Promise<ProviderIconsResult>

clearIconCache(...)

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

Clear cached provider icons.

Param	Type
`options`	`ClearIconCacheOptions`

Returns: Promise<{ cleared: number; }>

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

ProviderIconsResult

Result of fetching provider icons.

Prop	Type	Description
`icons`	`ProviderIcon[]`	Icons available from cache or freshly downloaded
`failures`	`ProviderIconFailure[]`	Providers that could not be fetched and had no cached fallback

ProviderIcon

Cached icon for a navigation provider.

Prop	Type	Description
`app`	`string`	Navigation app identifier
`name`	`string`	Display name for the provider
`localUrl`	`string`	URL that can be used directly in an image element inside the WebView.
`sourceUrl`	`string`	Web URL used to download the cached image
`mimeType`	`string`	MIME type reported for the cached image, when known
`fetchedAt`	`number`	Unix timestamp in milliseconds when the icon was last fetched
`fromCache`	`boolean`	Whether the icon came from the local cache without a network refresh
`stale`	`boolean`	Whether a stale cached icon was returned because refresh failed

ProviderIconFailure

Icon fetch failure for a provider.

Prop	Type	Description
`app`	`string`	Navigation app identifier
`name`	`string`	Display name for the provider
`sourceUrl`	`string`	Web URL that failed, when known
`message`	`string`	Failure message

GetAppIconsOptions

Options for fetching navigation provider icons.

Prop	Type	Description
`apps`	`string[]`	App identifiers to fetch. Defaults to all built-in providers for the current platform.
`providers`	`IconProvider[]`	Provider definitions to fetch or override built-in provider websites.
`maxAgeMs`	`number`	Cache revalidation interval in milliseconds. Defaults to 24 hours.
`forceRefresh`	`boolean`	Ignore the current cache and fetch icons again.

IconProvider

Web source used to discover or download a provider icon.

Prop	Type	Description
`app`	`string`	Navigation app identifier
`name`	`string`	Display name for the provider
`url`	`string`	Provider website used to discover favicon metadata
`iconUrl`	`string`	Direct image URL. When provided, the plugin downloads this URL instead of discovering a favicon from `url`.

ClearIconCacheOptions

Options for clearing cached provider icons.

Prop	Type	Description
`apps`	`string[]`	App identifiers to clear. Defaults to all cached icons.

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'`
`GURU_MAPS`	`'guru_maps'`
`ORGANIC_MAPS`	`'organic_maps'`
`YANDEX_MAPS`	`'yandex_maps'`
`TWO_GIS`	`'2gis'`
`CABIFY`	`'cabify'`
`BAIDU`	`'baidu'`
`GAODE`	`'gaode'`
`TESLA`	`'tesla'`
`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'`
`TOMTOM`	`'tomtom'`
`GURU_MAPS`	`'guru_maps'`
`ORGANIC_MAPS`	`'organic_maps'`
`YANDEX_MAPS`	`'yandex_maps'`
`MAPY`	`'mapy'`
`TWO_GIS`	`'2gis'`
`CABIFY`	`'cabify'`
`BAIDU`	`'baidu'`
`GAODE`	`'gaode'`
`TESLA`	`'tesla'`

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

Name		Name	Last commit message	Last commit date
Latest commit History 144 Commits
.github		.github
android		android
example-app		example-app
ios		ios
scripts		scripts
src		src
.eslintignore		.eslintignore
.gitignore		.gitignore
.prettierignore		.prettierignore
AGENTS.md		AGENTS.md
CHANGELOG.md		CHANGELOG.md
CONTRIBUTING.md		CONTRIBUTING.md
CapgoCapacitorLaunchNavigator.podspec		CapgoCapacitorLaunchNavigator.podspec
LICENSE		LICENSE
Package.swift		Package.swift
README.md		README.md
bun.lock		bun.lock
package.json		package.json
renovate.json		renovate.json
rollup.config.mjs		rollup.config.mjs
tsconfig.json		tsconfig.json

Plugin version	Capacitor compatibility	Maintained
v8..	v8..	✅
v7..	v7..	On demand
v6..	v6..	❌
v5..	v5..	❌

Uh oh!

Folders and files

Latest commit

History

Repository files navigation

@capgo/capacitor-launch-navigator

➡️ Get Instant updates for your App with Capgo

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

Documentation

Compatibility

Install

iOS Setup

Android Setup

Usage

Important Notes

Supported Navigation Apps

iOS

Android

API

navigate(...)

isAppAvailable(...)

getAvailableApps()

getSupportedApps()

getDefaultApp()

getAppIcons(...)

refreshAppIcons(...)

clearIconCache(...)

getPluginVersion()

Interfaces

NavigateOptions

AvailableApp

ProviderIconsResult

ProviderIcon

ProviderIconFailure

GetAppIconsOptions

IconProvider

ClearIconCacheOptions

Type Aliases

Record

Enums

TransportMode

IOSNavigationApp

AndroidNavigationApp

LaunchMode

About

Topics

Resources

License

Code of conduct

Contributing

Security policy

Uh oh!

Stars

Watchers

Forks

Releases 34

Sponsor this project

Uh oh!

Packages 0

Uh oh!

Contributors

Uh oh!

Languages

Packages