{"_id":"@cwoebker/capacitor-start-navigation","_rev":"6-dba6710c52c34f53f07f3f7a2c0d73d2","name":"@cwoebker/capacitor-start-navigation","dist-tags":{"latest":"7.0.0"},"versions":{"6.0.2":{"name":"@cwoebker/capacitor-start-navigation","version":"6.0.2","keywords":["capacitor","plugin","native"],"author":{"name":"Cecil Wöbker"},"license":"MIT","_id":"@cwoebker/capacitor-start-navigation@6.0.2","maintainers":[{"name":"cwoebker","email":"cwoebker@gmail.com"}],"homepage":"https://github.com/cwoebker/capacitor-start-navigation#readme","bugs":{"url":"https://github.com/cwoebker/capacitor-start-navigation/issues"},"dist":{"shasum":"5d894d6a44ac6d7cc804b4f30eca7a0ee136b1b6","tarball":"https://registry.npmjs.org/@cwoebker/capacitor-start-navigation/-/capacitor-start-navigation-6.0.2.tgz","fileCount":44,"integrity":"sha512-EaZ6581ohRY5NT5DV1Tql2u8TbwyscH/cZEfA9N5VBeifF7fHZjnAr7gnqeBMSnBwZYTCqxBL5N0I/JtV4+T7g==","signatures":[{"sig":"MEUCICDJSQ/zSGZfG76hll0qOJivo0nMr6KFelTtUra+U36hAiEA8jnM05RJ1otiU30i7INMaGewCOXOleBBPsyaz1CPCwA=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":151166},"main":"dist/esm/index.js","types":"dist/esm/index.d.ts","gitHead":"2ad1b290d6e62cb9994a3a9848e26b6575eb6854","scripts":{"fmt":"npm run eslint -- --fix && npm run prettier -- --write && npm run swiftlint -- --fix --format","lint":"npm run eslint && npm run prettier -- --check && npm run swiftlint -- lint","build":"npm run clean && npm run docgen && tsc && rollup -c rollup.config.js","clean":"rimraf ./dist","watch":"tsc --watch","docgen":"docgen --api StartNavigationPlugin --output-readme README.md --output-json dist/docs.json","eslint":"eslint . --ext ts","verify":"npm run verify:ios && npm run verify:android && npm run verify:web","prettier":"prettier \"**/*.{css,html,ts,js,java}\"","swiftlint":"node-swiftlint","verify:ios":"cd ios && pod install && xcodebuild -workspace Plugin.xcworkspace -scheme Plugin -destination generic/platform=iOS && cd ..","verify:web":"npm run build","prepublishOnly":"npm run build","verify:android":"cd android && .\\gradlew clean build test && cd .."},"_npmUser":{"name":"cwoebker","email":"cwoebker@gmail.com"},"capacitor":{"ios":{"src":"ios"},"android":{"src":"android"}},"swiftlint":"@ionic/swiftlint-config","repository":{"url":"git+https://github.com/cwoebker/capacitor-start-navigation.git","type":"git"},"_npmVersion":"10.8.1","description":"Starts navigation in the native maps application","directories":{},"_nodeVersion":"20.16.0","eslintConfig":{"rules":{"@typescript-eslint/quotes":["error","double",{"allowTemplateLiterals":true}],"@typescript-eslint/no-inferrable-types":"off"},"extends":"@ionic/eslint-config/recommended"},"_hasShrinkwrap":false,"devDependencies":{"eslint":"^7.11.0","rimraf":"^3.0.2","rollup":"^2.75.6","prettier":"~3.3.2","swiftlint":"^1.0.1","typescript":"~4.1.5","@capacitor/cli":"^6.0.0","@capacitor/ios":"^6.0.0","@capacitor/core":"^6.0.0","@capacitor/docgen":"^0.2.2","@capacitor/android":"^6.0.0","@ionic/eslint-config":"^0.4.0","prettier-plugin-java":"~1.0.2","@ionic/prettier-config":"^4.0.0","@ionic/swiftlint-config":"^1.1.2","@rollup/plugin-node-resolve":"^13.3.0"},"peerDependencies":{"@capacitor/core":"^6.0.0"},"_npmOperationalInternal":{"tmp":"tmp/capacitor-start-navigation_6.0.2_1723627412506_0.05935309182073811","host":"s3://npm-registry-packages"}},"7.0.0":{"name":"@cwoebker/capacitor-start-navigation","version":"7.0.0","description":"Starts navigation in the native maps application","main":"dist/esm/index.js","types":"dist/esm/index.d.ts","scripts":{"verify":"npm run verify:ios && npm run verify:android && npm run verify:web","verify:ios":"cd ios && pod install && xcodebuild -workspace Plugin.xcworkspace -scheme Plugin -destination generic/platform=iOS && cd ..","verify:android":"cd android && ./gradlew clean build test && cd ..","verify:web":"npm run build","lint":"npm run eslint && npm run prettier -- --check && npm run swiftlint -- lint","fmt":"npm run eslint -- --fix && npm run prettier -- --write && npm run swiftlint -- --fix --format","eslint":"eslint . --ext ts","prettier":"prettier \"**/*.{css,html,ts,js,java}\" --plugin=prettier-plugin-java","swiftlint":"node-swiftlint","docgen":"docgen --api StartNavigationPlugin --output-readme README.md --output-json dist/docs.json","build":"npm run clean && npm run docgen && tsc && rollup -c rollup.config.mjs","clean":"rimraf ./dist","watch":"tsc --watch","prepublishOnly":"npm run build"},"author":{"name":"Cecil Wöbker"},"license":"MIT","peerDependencies":{"@capacitor/core":">=7.0.0"},"devDependencies":{"@capacitor/android":"^7.0.0","@capacitor/cli":"^7.0.0","@capacitor/core":"^7.0.0","@capacitor/docgen":"^0.3.0","@capacitor/ios":"^7.0.0","@ionic/eslint-config":"^0.4.0","@ionic/prettier-config":"^4.0.0","@ionic/swiftlint-config":"^2.0.0","@rollup/plugin-node-resolve":"^16.0.1","eslint":"^8.57.0","prettier":"^3.4.2","prettier-plugin-java":"^2.6.6","rimraf":"^6.0.1","rollup":"^4.30.1","swiftlint":"^2.0.0","typescript":"~4.1.5"},"swiftlint":"@ionic/swiftlint-config","eslintConfig":{"extends":"@ionic/eslint-config/recommended","rules":{"@typescript-eslint/no-inferrable-types":"off","@typescript-eslint/quotes":["error","double",{"allowTemplateLiterals":true}]}},"keywords":["capacitor","plugin","native"],"capacitor":{"ios":{"src":"ios"},"android":{"src":"android"}},"repository":{"type":"git","url":"git+https://github.com/cwoebker/capacitor-start-navigation.git"},"bugs":{"url":"https://github.com/cwoebker/capacitor-start-navigation/issues"},"packageManager":"yarn@1.22.21+sha1.1959a18351b811cdeedbd484a8f86c3cc3bbaf72","_id":"@cwoebker/capacitor-start-navigation@7.0.0","gitHead":"a1026a253163985d7c896b2da1d948d4742e5b9b","homepage":"https://github.com/cwoebker/capacitor-start-navigation#readme","_nodeVersion":"22.13.1","_npmVersion":"11.3.0","dist":{"integrity":"sha512-0/4P3FZaqfL8yIzVRKjlhmhJzrNWqTzvd2JLbY0OyfQIeols2+AVl08RRlMiowEn2aEP8mkH+MTefbseSbxjYg==","shasum":"8e743f325a7a347d8284eb1cf9363fdd4556947a","tarball":"https://registry.npmjs.org/@cwoebker/capacitor-start-navigation/-/capacitor-start-navigation-7.0.0.tgz","fileCount":83,"unpackedSize":296728,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEQCIBfl1Erw/nZAZP4UXvdyGBzci8c/kRFmdkZDpeG3ynToAiB8IoVnya7oNlQv65Kyg0/enrdrhvg5+SuNAyRcH9CmtA=="}]},"_npmUser":{"name":"cwoebker","email":"cwoebker@gmail.com"},"directories":{},"maintainers":[{"name":"cwoebker","email":"cwoebker@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/capacitor-start-navigation_7.0.0_1747481892379_0.21547570789557668"},"_hasShrinkwrap":false}},"time":{"created":"2024-08-14T09:17:19.184Z","modified":"2025-05-17T11:38:12.749Z","6.0.0":"2024-08-14T09:17:19.491Z","6.0.1":"2024-08-14T09:21:26.290Z","6.0.2":"2024-08-14T09:23:32.717Z","7.0.0":"2025-05-17T11:38:12.563Z"},"bugs":{"url":"https://github.com/cwoebker/capacitor-start-navigation/issues"},"author":{"name":"Cecil Wöbker"},"license":"MIT","homepage":"https://github.com/cwoebker/capacitor-start-navigation#readme","keywords":["capacitor","plugin","native"],"repository":{"type":"git","url":"git+https://github.com/cwoebker/capacitor-start-navigation.git"},"description":"Starts navigation in the native maps application","maintainers":[{"name":"cwoebker","email":"cwoebker@gmail.com"}],"readme":"# capacitor-start-navigation [![npm version](https://badge.fury.io/js/@cwoebker%2Fcapacitor-start-navigation.svg)](https://badge.fury.io/js/@cwoebker%2Fcapacitor-start-navigation)\n\nCapacitor plugin that allows your app to start native navigation.\n\nForked from https://github.com/ProteanSoftware/capacitor-start-navigation originally.\n\n\n## API\n\n<docgen-index>\n\n* [`launchMapsApp(...)`](#launchmapsapp)\n* [Interfaces](#interfaces)\n* [Type Aliases](#type-aliases)\n\n</docgen-index>\n\n<docgen-api>\n<!--Update the source file JSDoc comments and rerun docgen to update the docs below-->\n\n### launchMapsApp(...)\n\n```typescript\nlaunchMapsApp(options: StartNavigationOptions) => Promise<void>\n```\n\nOpens the native maps applications with directions started\n\n| Param         | Type                                                                      |\n| ------------- | ------------------------------------------------------------------------- |\n| **`options`** | <code><a href=\"#startnavigationoptions\">StartNavigationOptions</a></code> |\n\n--------------------\n\n\n### Interfaces\n\n\n#### StartNavigationOptions\n\n| Prop             | Type                                                                              | Description                                                                                                                                                                       |\n| ---------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **`latitude`**   | <code>string \\| number \\| null</code>                                             | Geo-coordinate latitude. Can be null for address only search.                                                                                                                     |\n| **`longitude`**  | <code>string \\| number \\| null</code>                                             | Geo-coordinate longitude. Can be null for address only search.                                                                                                                    |\n| **`address`**    | <code><a href=\"#startnavigationaddress\">StartNavigationAddress</a> \\| null</code> | Search for an address. (iOS and Android) Can be used in combination with &lt;c&gt;latitude&lt;/c&gt; and &lt;c&gt;longitude&lt;/c&gt; to refine search results (Android only).    |\n| **`name`**       | <code>string \\| null</code>                                                       | Name label to be shown for end Location                                                                                                                                           |\n| **`travelMode`** | <code><a href=\"#travelmode\">TravelMode</a></code>                                 | 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 |\n\n\n#### StartNavigationAddress\n\n| Prop             | Type                        |\n| ---------------- | --------------------------- |\n| **`street`**     | <code>string \\| null</code> |\n| **`city`**       | <code>string \\| null</code> |\n| **`state`**      | <code>string \\| null</code> |\n| **`postalCode`** | <code>string \\| null</code> |\n| **`country`**    | <code>string \\| null</code> |\n\n\n### Type Aliases\n\n\n#### TravelMode\n\n<code>\"driving\" | \"walking\" | \"transit\" | \"bicycling\"</code>\n\n</docgen-api>\n## Usage\n\n```ts\nimport { StartNavigation } from \"capacitor-start-navigation\";\n\n//\n// launches native maps with directions to Warwick, UK\nStartNavigation.launchMapsApp({\n  latitude: 52.28333,\n  longitude: -1.58333,\n  name: \"Example location\",\n  travelMode: \"walking\"\n});\n\n//\n// launches native maps with directions to Warwick, UK\nStartNavigation.launchMapsApp({\n  address: {\n    street: \"Market Place\",\n    city: \"Warwick\",\n    postalCode: \"CV34 4SA\",\n    Country: \"United Kingdom\"\n  },\n  name: \"Example location\"\n});\n\n```\n\n### TravelMode\n\nDefaults to 'driving'.  \nAll options are available on web.  \nOn iOS only 'driving', 'walking' & 'transit' are available.  \nOn Android only 'driving', 'walking', 'bicycling' are available.\n\n## iOS setup\n\n- `sudo gem install cocoapods` _(once a time)_\n- `ionic start my-cap-app --capacitor`\n- `cd my-cap-app`\n- `mkdir www && touch www/index.html`\n- `npx cap add ios`\n- `npm install --save capacitor-start-navigation`\n- `npx cap sync ios` _(always do sync after a plugin install)_\n- `npx cap open ios`\n\n## Android setup\n\n- `ionic start my-cap-app --capacitor`\n- `cd my-cap-app`\n- `mkdir www && touch www/index.html`\n- `npx cap add android`\n- `npm install --save capacitor-start-navigation`\n- `npx cap sync android` _(always do sync after a plugin install)_\n- `npx cap open android`\n\nNow you should be set to go. Try to run your client using `ionic cap run android --livereload`.\n\n## License\n\nMIT","readmeFilename":"README.md"}