Getting Started

Copy a setup prompt with the install steps and the full markdown guide for this plugin.

        Set up this Capacitor plugin in the project.

Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-launch-navigator`
Run the required Capacitor sync/update step after installation.
Read this markdown guide for the full setup steps: https://raw.githubusercontent.com/Cap-go/website/refs/heads/main/apps/docs/src/content/docs/docs/plugins/launch-navigator/getting-started.mdx
Use that guide for platform-specific steps, native file edits, permissions, config changes, imports, and usage setup.
If that guide references other docs pages, read them too.

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/capgo-skills --skill capacitor-plugins

Then use the following prompt:

Use the `capacitor-plugins` skill from `Cap-go/capgo-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:

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

Import

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

API Overview

`navigate`

Navigate to a location using latitude and longitude

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

await LaunchNavigator.navigate({} as {
    /**
     * Destination coordinates [latitude, longitude]
     */
    destination: [number, number];

    /**
     * Optional navigation options
     */
    options?: NavigateOptions;
  });

`isAppAvailable`

Check if a specific navigation app is available

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

await LaunchNavigator.isAppAvailable({} as {
    /**
     * App identifier to check
     */
    app: IOSNavigationApp | AndroidNavigationApp | string;
  });

`getAvailableApps`

Get list of available navigation apps on the device

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

await LaunchNavigator.getAvailableApps();

`getSupportedApps`

Get list of supported apps for the current platform

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

await LaunchNavigator.getSupportedApps();

`getDefaultApp`

Get the name of the default app for navigation

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

await LaunchNavigator.getDefaultApp();

Type Reference

`NavigateOptions`

Options for navigation.

export interface NavigateOptions {
  /**
   * Starting location coordinates [latitude, longitude]
   */
  start?: [number, number];

  /**
   * Starting location name
   */
  startName?: string;

  /**
   * Destination name (will be ignored since we only support coordinates)
   */
  destinationName?: string;

  /**
   * Transport mode
   */
  transportMode?: TransportMode;

  /**
   * Specific app to launch (if not specified, will use default or prompt)
   */
  app?: IOSNavigationApp | AndroidNavigationApp | string;

  /**
   * Launch mode
   */
  launchMode?: LaunchMode;

  /**
   * Additional parameters specific to certain apps
   */
  extras?: Record<string, any>;

  /**
   * Enable debug logging
   */
  enableDebug?: boolean;
}

`IOSNavigationApp`

Available navigation apps for iOS.

export enum IOSNavigationApp {
  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`

Available navigation apps for Android.

export enum AndroidNavigationApp {
  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',
}

`AvailableApp`

Result of checking app availability.

export interface AvailableApp {
  /**
   * App identifier
   */
  app: string;

  /**
   * Display name of the app
   */
  name: string;

  /**
   * Whether the app is available on the device
   */
  available: boolean;
}

`TransportMode`

Transport modes.

export enum TransportMode {
  DRIVING = 'driving',
  WALKING = 'walking',
  BICYCLING = 'bicycling',
  TRANSIT = 'transit',
}

`LaunchMode`

Launch modes.

export enum LaunchMode {
  MAPS = 'maps',
  TURN_BY_TURN = 'turn_by_turn',
  GEO = 'geo',
}

Source Of Truth

This page is generated from the plugin’s src/definitions.ts. Re-run the sync when the public API changes upstream.

Keep going from Getting Started

If you are using Getting Started to plan dashboard and API operations, connect it with Using @capgo/capacitor-launch-navigator for the native capability in Using @capgo/capacitor-launch-navigator, API Overview for the implementation detail in API Overview, Introduction for the implementation detail in Introduction, API Keys for the implementation detail in API Keys, and Devices for the implementation detail in Devices.