@proteansoftware/capacitor-start-navigation

capacitor-start-navigation

Capacitor plugin that allows your app to start native navigation

API

• launchMapsApp(...)
• Interfaces
• Type Aliases

launchMapsApp(...)

launchMapsApp(options: StartNavigationOptions) => Promise<void>

Opens the native maps applications with directions started

Param	Type
options	StartNavigationOptions

---

Interfaces

StartNavigationOptions

Prop	Type	Description
latitude	string | number | null	Geo-coordinate latitude. Can be null for address only search.
longitude	string | number | null	Geo-coordinate longitude. Can be null for address only search.
address	StartNavigationAddress | null	Search for an address. (iOS and Android) Can be used in combination with <c>latitude</c> and <c>longitude</c> to refine search results (Android only).
name	string | null	Name label to be shown for end Location
travelMode	TravelMode	Defaults to 'driving' All options are available on web On iOS only 'driving', 'walking' & 'transit' are available On Android only 'driving', 'walking', 'bicycling' are available

StartNavigationAddress

Prop	Type
street	string | null
city	string | null
state	string | null
postalCode	string | null
country	string | null

Type Aliases

TravelMode

'driving' | 'walking' | 'transit' | 'bicycling'

## Usage

import { StartNavigation } from "@proteansoftware/capacitor-start-navigation";

//
// launches native maps with directions to Warwick, UK
StartNavigation.launchMapsApp({
  latitude: 52.28333,
  longitude: -1.58333,
  name: "Example location",
  travelMode: "walking"
});

//
// launches native maps with directions to Warwick, UK
StartNavigation.launchMapsApp({
  address: {
    street: "Market Place",
    city: "Warwick",
    postalCode: "CV34 4SA",
    Country: "United Kingdom"
  },
  name: "Example location"
});

TravelMode

Defaults to 'driving'.
All options are available on web.
On iOS only 'driving', 'walking' & 'transit' are available.
On Android only 'driving', 'walking', 'bicycling' are available.

iOS setup

• sudo gem install cocoapods (once a time)
• ionic start my-cap-app --capacitor
• cd my-cap-app
• mkdir www && touch www/index.html
• npx cap add ios
• npm install --save @proteansoftware/capacitor-start-navigation
• npx cap sync ios (always do sync after a plugin install)
• npx cap open ios

Android setup

• ionic start my-cap-app --capacitor
• cd my-cap-app
• mkdir www && touch www/index.html
• npx cap add android
• npm install --save @proteansoftware/capacitor-start-navigation
• npx cap sync android (always do sync after a plugin install)
• npx cap open android

Now you should be set to go. Try to run your client using ionic cap run android --livereload.

License

MIT