Skip to main content

Launch Navigator Capacitor plugin

Open navigation apps like Google Maps or Apple Maps with directions to destinations

Install

bun add @capgo/capacitor-launch-navigator bunx cap sync
npm, pnpm or yarn
  • npm install @capgo/capacitor-launch-navigator
  • pnpm add @capgo/capacitor-launch-navigator
  • yarn add @capgo/capacitor-launch-navigator

Guide

How to use Launch Navigator in Capacitor

Test on device

Download the Capgo app, then scan the QR code.

Launch Navigator plugin preview QR code

Using @capgo/capacitor-launch-navigator

Main plugin interface.

Install

bun add @capgo/capacitor-launch-navigator
bunx cap sync

bunx cap sync copies the plugin's native code into your native projects. Run it again after every plugin upgrade.

Import

import { LaunchNavigator } from '@capgo/capacitor-launch-navigator';

API at a glance

Method Description
navigate Navigate to a location using latitude and longitude.
isAppAvailable Check if a specific navigation app is available.
getAvailableApps Get list of available navigation apps on the device.
getSupportedApps Get list of supported apps for the current platform.
getDefaultApp Get the name of the default app for navigation.
getAppIcons Fetch provider icons and cache them locally.
refreshAppIcons Refresh provider icons, ignoring the cache age.
clearIconCache Clear cached provider icons.

Examples

navigate()

Navigate to a location using latitude and longitude.

import { LaunchNavigator } from '@capgo/capacitor-launch-navigator';

await LaunchNavigator.navigate({ destination: [48.8566, 2.3522] });

isAppAvailable()

Check if a specific navigation app is available.

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

const result = await LaunchNavigator.isAppAvailable({ app: IOSNavigationApp.APPLE_MAPS });
console.log(result);

getAvailableApps()

Get list of available navigation apps on the device.

import { LaunchNavigator } from '@capgo/capacitor-launch-navigator';

const result = await LaunchNavigator.getAvailableApps();
console.log(result);

getSupportedApps()

Get list of supported apps for the current platform.

import { LaunchNavigator } from '@capgo/capacitor-launch-navigator';

const result = await LaunchNavigator.getSupportedApps();
console.log(result);

getDefaultApp()

Get the name of the default app for navigation.

import { LaunchNavigator } from '@capgo/capacitor-launch-navigator';

const result = await LaunchNavigator.getDefaultApp();
console.log(result);

getAppIcons()

Fetch provider icons and cache them locally.

import { LaunchNavigator } from '@capgo/capacitor-launch-navigator';

const result = await LaunchNavigator.getAppIcons();
console.log(result);

The table above lists the 8 core methods. Listener and version helpers, and the full contract of each method, are documented in the GitHub repository.

Full reference

Keep going from Using @capgo/capacitor-launch-navigator

If you are using Using @capgo/capacitor-launch-navigator to plan native plugin work, connect it with @capgo/capacitor-launch-navigator for the implementation detail in @capgo/capacitor-launch-navigator, Getting Started for the implementation detail in Getting Started, Capgo Plugin Directory for the product workflow in Capgo Plugin Directory, Capacitor Plugins by Capgo for the implementation detail in Capacitor Plugins by Capgo, and Adding or Updating Plugins for the implementation detail in Adding or Updating Plugins.

FAQ

Launch Navigator plugin FAQ

How do I install the Launch Navigator plugin in a Capacitor app?

Run "bun add @capgo/capacitor-launch-navigator" (or "npm install @capgo/capacitor-launch-navigator"), then run "bunx cap sync" so the iOS and Android projects pick up the native code. Import it from "@capgo/capacitor-launch-navigator" in your app code.

Does @capgo/capacitor-launch-navigator work with React, Vue and Angular?

Yes. Launch Navigator is a Capacitor package, so it works with any web framework that runs inside Capacitor, including Ionic, React, Vue, Angular, Svelte and plain JavaScript.

Which Capacitor version does @capgo/capacitor-launch-navigator support?

Capgo plugins follow Capacitor's major version: use the plugin major version that matches your Capacitor major version (for example plugin v8 with Capacitor 8). The compatibility table in the GitHub README lists the maintained versions.

Is @capgo/capacitor-launch-navigator free and open source?

Yes. The source code is public on GitHub at https://github.com/Cap-go/capacitor-launch-navigator/ and the package is free to install from npm. Bug reports and pull requests are welcome.

Can I update code that uses Launch Navigator without an App Store review?

Installing or upgrading the plugin changes native code, so it needs a new store build. After that, JavaScript, HTML and CSS changes that call the plugin can ship instantly with Capgo live updates.

Ship Launch Navigator changes without waiting for app review

Once the plugin is in your store build, Capgo live updates push your JavaScript, HTML and CSS changes to users in minutes.

Start with Capgo