快速入门

安装

你可以使用我们的 AI 辅助设置来安装插件。使用以下命令将 Capgo skills 添加到你的 AI 工具中：

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

然后使用以下 prompt：

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

如果你更想手动设置，请运行以下命令安装插件，并按照下方各平台的说明操作：

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

导入

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

快速入门

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

await LaunchNavigator.navigate({
  destination: [37.7749, -122.4194],
  options: { app: 'google_maps' },
});

示例：让用户选择地图应用

const { apps } = await LaunchNavigator.getAvailableApps();
// render chooser UI, then navigate with options.app set to the selection

示例：先进行地理编码

使用 @capgo/capacitor-nativegeocoder forwardGeocode() 将地址转换为 [lat, lng] 在调用之前 navigate().

常见坑点

• 仅限坐标: 不支持街道地址 navigate().
• Web 端: 将打开外部地图链接，而非已安装的应用。
• 图标: cache with getAppIcons() 并在用户安装新地图应用时刷新。

API 概览

navigate

通过经纬度导航至指定位置

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

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

isAppAvailable

检查特定的导航应用是否可用

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

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

getAvailableApps

获取设备上可用的导航应用列表

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

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

getSupportedApps

获取当前平台支持的应用列表

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

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

getDefaultApp

获取默认导航应用的名称

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

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

类型参考

NavigateOptions

导航选项。

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

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

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

检查 App 是否可用后的结果。

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

传输模式。

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

LaunchMode

启动模式。

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

单一事实来源

本页面由插件的 src/definitions.ts生成。当上游的公共 API 发生变化时，请重新运行 sync。

从入门指南继续

如果你正在使用 快速入门 要规划 dashboard 和 API 操作，请将其连接到 使用 @capgo/capacitor-launch-navigator 用于“使用 @capgo/capacitor-launch-navigator”中的原生能力， API 概览 关于 API Overview 中的实现细节， 简介 关于 Introduction 中的实现细节， API 密钥 有关 API Keys 的实现细节，以及 设备 有关 Devices 的实现细节。