You're Invited:Meet the Socket Team at BlackHat and DEF CON in Las Vegas, Aug 7-8.RSVP
Socket
Socket
Sign inDemoInstall

@proteansoftware/capacitor-start-navigation

Package Overview
Dependencies
1
Maintainers
1
Versions
21
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

@proteansoftware/capacitor-start-navigation

Starts navigation in the native maps application


Version published
Maintainers
1
Created

Readme

Source

capacitor-start-navigation npm version

Capacitor plugin that allows your app to start native navigation

API

launchMapsApp(...)

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

Opens the native maps applications with directions started

ParamType
optionsStartNavigationOptions

Interfaces

StartNavigationOptions
PropTypeDescription
latitudestring | number | nullGeo-coordinate latitude. Can be null for address only search.
longitudestring | number | nullGeo-coordinate longitude. Can be null for address only search.
addressStartNavigationAddress | nullSearch 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).
namestring | nullName label to be shown for end Location
travelModeTravelModeDefaults 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
PropType
streetstring | null
citystring | null
statestring | null
postalCodestring | null
countrystring | 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

Keywords

FAQs

Package last updated on 19 Jun 2023

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc