Merge pull request #309 from metehandemir/appsBlackList

Author: tschoffelen

README.md

@@ -258,6 +258,7 @@ showLocation({
   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)
+  appsBlackList: ['uber'], // optionally you can set which apps NOT 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
@@ -312,6 +313,7 @@ const Demo = () => {
         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)
         appsWhiteList: ['google-maps'], // optionally you can set which apps to show (default: will show all supported apps installed on device)
+        appsBlackList: ['uber'], // optionally you can set which apps NOT to show (default: will show all supported apps installed on device)
       });
       setAvailableApps(result);
     })();

example/App.tsx

@@ -38,6 +38,7 @@ export default function App() {
           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)
           appsWhiteList: ['google-maps'], // optionally you can set which apps to show (default: will show all supported apps installed on device)
+          appsBlackList: ['uber'], // optionally you can set which apps NOT to show (default: will show all supported apps installed on device)
         });
         setAvailableApps(apps);
       } catch (error) {

src/components/popup/Popup.tsx

@@ -67,6 +67,11 @@ export const Popup: React.FC<PopupProps> = ({
           options.appsWhiteList?.includes(appName),
         );
       }
+      if (options.appsBlackList && options.appsBlackList.length) {
+        appsData = appsData.filter(
+          (appName) => !options.appsBlackList?.includes(appName),
+        );
+      }
       setApps(appsData);
       setIsLoading(false);
     };
@@ -76,6 +81,7 @@ export const Popup: React.FC<PopupProps> = ({
     options.alwaysIncludeGoogle,
     options.appTitles,
     options.appsWhiteList,
+    options.appsBlackList,
     options.naverCallerName,
   ]);
 

src/index.ts

@@ -38,6 +38,7 @@ export const showLocation = async ({
   dialogMessage: customDialogMessage,
   cancelText: customCancelText,
   appsWhiteList: customAppsWhiteList,
+  appsBlackList: customAppsBlackList,
   appTitles,
   naverCallerName,
   directionsMode,
@@ -103,13 +104,18 @@ export const showLocation = async ({
     customAppsWhiteList && customAppsWhiteList.length
       ? customAppsWhiteList
       : null;
+  const appsBlackList =
+    customAppsBlackList && customAppsBlackList.length
+      ? customAppsBlackList
+      : null;
 
   if (!app) {
     app = await askAppChoice({
       dialogTitle,
       dialogMessage,
       cancelText,
       appsWhiteList,
+      appsBlackList,
       prefixes,
       appTitles: generateTitles(appTitles),
     });
@@ -143,6 +149,7 @@ export const showLocation = async ({
 export async function getApps({
   alwaysIncludeGoogle,
   appsWhiteList,
+  appsBlackList,
   appTitles,
   naverCallerName,
   ...rest
@@ -156,13 +163,18 @@ export async function getApps({
     apps = apps.filter((appName) => appsWhiteList!.includes(appName));
   }
 
+  if (appsBlackList && appsBlackList.length) {
+    apps = apps.filter((appName) => !appsBlackList!.includes(appName));
+  }
+
   const titles = generateTitles({...appTitles});
   async function open(app: MapId) {
     return showLocation({
       ...rest,
       app,
       alwaysIncludeGoogle,
       appsWhiteList,
+      appsBlackList,
       appTitles,
       naverCallerName,
     });

src/type.ts

@@ -62,6 +62,7 @@ export interface ShowLocationProps {
   dialogMessage?: string | null;
   cancelText?: string | null;
   appsWhiteList?: string[] | null;
+  appsBlackList?: string[] | null;
   appTitles?: Partial<Record<MapId, string>>;
   naverCallerName?: string;
   directionsMode?: DirectionMode;

src/utils.ts

@@ -63,13 +63,15 @@ export const askAppChoice = ({
   dialogMessage,
   cancelText,
   appsWhiteList,
+  appsBlackList,
   prefixes,
   appTitles,
 }: {
   dialogTitle: string | null | undefined;
   dialogMessage: string | null | undefined;
   cancelText: string | null | undefined;
   appsWhiteList: string[] | null | undefined;
+  appsBlackList: string[] | null | undefined;
   prefixes: Record<string, string>;
   appTitles: Record<string, string> | null | undefined;
 }): Promise<MapId | null> => {
@@ -82,6 +84,12 @@ export const askAppChoice = ({
       );
     }
 
+    if (appsBlackList && appsBlackList.length) {
+      availableApps = availableApps.filter(
+        (appName) => !appsBlackList.includes(appName),
+      );
+    }
+
     if (availableApps.length < 2) {
       return resolve(availableApps[0] || null);
     }