スタートガイド

インストール

AIアシストによるセットアップでプラグインをインストールできます。以下のコマンドを使用して、お使いのAIツールに Capgo のスキルを追加してください：

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

次に、以下のプロンプトを使用します：

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：インストール済みのアプリではなく、外部のマップリンクが開きます。
• アイコン：〜でキャッシュし、 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

アプリの利用可能性の確認結果。

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',
}

Source of Truth

このページはプラグインの src/definitions.tsから生成されています。upstream で公開 API が変更されたら、再度 sync を実行してください。

Getting Startedの続きを進める

使用している場合 スタートガイド ダッシュボードと API の運用を計画するには、これを次と連携させます @capgo/capacitor-launch-navigator の使用方法 @capgo/capacitor-launch-navigator でネイティブ機能を使用する場合、 API の概要 「API の概要」の実装の詳細については、 はじめに 「はじめに」における実装の詳細については、 API キー および「API Keys」の実装の詳細については、 デバイス 実装の詳細については Devices を参照してください。