v2.12.0 (issue210-address-as-parameter) - Adding ADDRESS as a potential parameter

README.md

@@ -249,8 +249,8 @@ showLocation({
   latitude: 38.8976763,
   longitude: -77.0387185,
   sourceLatitude: -8.0870631, // optionally specify starting location for directions
-  sourceLongitude: -34.8941619, // not optional if sourceLatitude is specified
-  title: 'The White House', // optional
+  sourceLongitude: -34.8941619, // required if sourceLatitude is specified
+  title: 'The White House', // optional 
   googleForceLatLon: false, // optionally force GoogleMaps to use the latlon for the query instead of the title
   googlePlaceId: 'ChIJGVtI4by3t4kRr51d_Qm_x58', // optionally specify the google-place-id
   alwaysIncludeGoogle: true, // optional, true will always add Google Maps to iOS and open in Safari, even if app is not installed (default: false)
@@ -265,12 +265,31 @@ showLocation({
 });
 ```
 
+Alternatively you can specify the `address` field and leave the latitude and longitude properties as empty strings 
+
+```js
+import {showLocation} from 'react-native-map-link';
+
+showLocation({
+  address: '1600 Pennsylvania Avenue NW, Washington, DC 20500', // Required if replacing latitude and longitude
+  title: 'The White House', // optional
+  alwaysIncludeGoogle: true, // optional, true will always add Google Maps to iOS and open in Safari, even if app is not installed (default: false)
+  dialogTitle: 'This is the dialog Title', // optional (default: 'Open in Maps')
+  dialogMessage: 'This is the amazing dialog Message', // optional (default: 'What app would you like to use?')
+  cancelText: 'This is the cancel button text', // optional (default: 'Cancel')
+  appsWhiteList: ['google-maps'], // optionally you can set which apps to show (default: will show all supported apps installed on device)
+  naverCallerName: 'com.example.myapp', // to link into Naver Map You should provide your appname which is the bundle ID in iOS and applicationId in android.
+  appTitles: { 'google-maps': 'My custom Google Maps title' }, // optionally you can override default app titles
+  app: 'uber',  // optionally specify specific app to use
+});
+```
+
 Notes:
 
 - The `sourceLatitude` / `sourceLongitude` options only work if you specify both. Currently supports all apps except Waze.
 - `directionsMode` works on google-maps, apple-maps and sygic (on apple-maps, `bike` mode will not work, while on sygic, only `walk` and `car` will work). Without setting it, the app will decide based on its own settings.
 - If you set `directionsMode` but do not set `sourceLatitude` and `sourceLongitude`, google-maps and apple-maps will still enter directions mode, and use the current location as starting point.
--
+- If you want to query an address instead of passing the `latitude` and `longitude` fields, you can do this by leaving both of the required fields as empty strings and provide a full address to be queried. Just be aware that not all applications support this.
 
 ### Or
 
@@ -296,6 +315,7 @@ const Demo = () => {
       const result = await getApps({
         latitude: 38.8976763,
         longitude: -77.0387185,
+        address: '1600 Pennsylvania Avenue NW, Washington, DC 20500', // optional 
         title: 'The White House', // optional
         googleForceLatLon: false, // optionally force GoogleMaps to use the latlon for the query instead of the title
         alwaysIncludeGoogle: true, // optional, true will always add Google Maps to iOS and open in Safari, even if app is not installed (default: false)

package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-native-map-link",
-  "version": "3.0.1",
+  "version": "3.1.0",
   "description": "Open the map app of the user's choice with a specific location.",
   "source": "src/index",
   "main": "lib/index.js",

src/index.ts

@@ -25,6 +25,7 @@ export type {PopupProps} from './components/popup/Popup';
 export const showLocation = async ({
   latitude,
   longitude,
+  address,
   sourceLatitude,
   sourceLongitude,
   appleIgnoreLatLon,
@@ -49,6 +50,7 @@ export const showLocation = async ({
   checkOptions({
     latitude,
     longitude,
+    address,
     googleForceLatLon,
     googlePlaceId,
     title: customTitle,
@@ -62,6 +64,7 @@ export const showLocation = async ({
   let sourceLat;
   let sourceLng;
   let sourceLatLng;
+  let fullAddress;
 
   if (sourceLatitude != null && sourceLongitude != null) {
     useSourceDestiny = true;
@@ -76,6 +79,10 @@ export const showLocation = async ({
     sourceLatLng = `${sourceLat},${sourceLng}`;
   }
 
+  if (address) {
+    fullAddress = encodeURIComponent(address);
+  }
+
   const lat = typeof latitude === 'string' ? parseFloat(latitude) : latitude;
   const lng = typeof longitude === 'string' ? parseFloat(longitude) : longitude;
   const latlng = `${lat},${lng}`;
@@ -121,6 +128,7 @@ export const showLocation = async ({
     sourceLat,
     sourceLng,
     sourceLatLng,
+    address: fullAddress,
     title,
     encodedTitle,
     prefixes,

src/type.ts

@@ -45,8 +45,11 @@ export type GetAppsResponse = {
 };
 
 export interface ShowLocationProps {
-  latitude: number | string;
-  longitude: number | string;
+  latitude?: number | string;
+  longitude?: number | string;
+  /** optionally you can enter a full address that will be queried against the map app's API and return the initial results if not the actual matched result. */
+  /** latitude and longitude will be ignored if the address field is set */
+  address?: string | null;
   sourceLatitude?: number | null;
   sourceLongitude?: number | null;
   appleIgnoreLatLon?: boolean;