capacitor-start-navigation 

Capacitor plugin that allows your app to start native navigation.

Forked from https://github.com/ProteanSoftware/capacitor-start-navigation originally.

API

* launchMapsApp(...)
* Interfaces
* Type Aliases

$3

``typescript
launchMapsApp(options: StartNavigationOptions) => Promise
`

Opens the native maps applications with directions started

| Param | Type |
| ------------- | ------------------------------------------------------------------------- |
| options | StartNavigationOptions |

--------------------

$3


#### 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 |

$3


#### TravelMode

"driving" | "walking" | "transit" | "bicycling"

Usage

`ts
import { StartNavigation } from "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"
});

`

$3

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 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 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