はじめに

インストール

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

インポート

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

APIの概要

navigate

緯度と経度を使用して場所に移動する

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

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

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

isAppAvailable

特定のナビゲーションアプリが利用可能かどうかを確認する

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

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

getAvailableApps

デバイス上の利用可能なナビゲーションアプリのリストを取得する

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

await LaunchNavigator.getAvailableApps();

getSupportedApps

現在のプラットフォームに対応するアプリのリストを取得する

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

await LaunchNavigator.getSupportedApps();

getDefaultApp

ナビゲーション用のデフォルトアプリ名を取得します。

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

await LaunchNavigator.getDefaultApp();

型の参照

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

クリップボードにコピー

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

真実の源

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