Merge pull request #58 from ionic-team/development

andredestro · web-flow · commit 943419ff434e · 2025-04-15T17:17:29.000+01:00
feat(android,ios): add onBrowserPageNavigationCompleted event
diff --git a/CapacitorInappbrowser.podspec b/CapacitorInappbrowser.podspec
@@ -12,7 +12,7 @@ Pod::Spec.new do |s|
   s.source = { :git => package['repository']['url'], :tag => s.version.to_s }
   s.source_files = 'ios/Sources/InAppBrowserPlugin/*.{swift,h,m,c,cc,mm,cpp}'
   s.ios.deployment_target  = '14.0'
-  s.dependency 'OSInAppBrowserLib', spec='~> 1.0'
+  s.dependency 'OSInAppBrowserLib', spec='~> 2.0'
   s.dependency 'Capacitor'
   s.swift_version = '5.1'
 end
diff --git a/README.md b/README.md
@@ -64,6 +64,10 @@ await InAppBrowser.addListener('browserClosed', () => {
     console.log("browser was closed.");
 });
 
+await InAppBrowser.addListener('browserPageNavigationCompleted', (data) => {
+    console.log("browser page navigation was completed. " + data.url);
+});
+
 await InAppBrowser.addListener('browserPageLoaded', () => {
     console.log("browser was loaded.");
 });
@@ -84,6 +88,7 @@ InAppBrowser.removeAllListeners();
 * [`openInExternalBrowser(...)`](#openinexternalbrowser)
 * [`close()`](#close)
 * [`addListener('browserClosed' | 'browserPageLoaded', ...)`](#addlistenerbrowserclosed--browserpageloaded-)
+* [`addListener('browserPageNavigationCompleted', ...)`](#addlistenerbrowserpagenavigationcompleted-)
 * [`removeAllListeners()`](#removealllisteners)
 * [Interfaces](#interfaces)
 * [Enums](#enums)
@@ -167,6 +172,24 @@ Adds a listener for the specified browser event.
 --------------------
 
 
+### addListener('browserPageNavigationCompleted', ...)
+
+```typescript
+addListener(eventName: 'browserPageNavigationCompleted', listenerFunc: (data: BrowserPageNavigationCompletedEventData) => void) => Promise<PluginListenerHandle>
+```
+
+Adds a listener for the specified browser event.
+
+| Param              | Type                                                                                                                           | Description                                                                    |
+| ------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ |
+| **`eventName`**    | <code>'browserPageNavigationCompleted'</code>                                                                                  | The name of the browser event to listen for: 'browserPageNavigationCompleted'. |
+| **`listenerFunc`** | <code>(data: <a href="#browserpagenavigationcompletedeventdata">BrowserPageNavigationCompletedEventData</a>) =&gt; void</code> | The function to be called when the event occurs.                               |
+
+**Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt;</code>
+
+--------------------
+
+
 ### removeAllListeners()
 
 ```typescript
@@ -293,6 +316,15 @@ Defines the options for opening a URL in the external browser and used by the ot
 | **`remove`** | <code>() =&gt; Promise&lt;void&gt;</code> |
 
 
+#### BrowserPageNavigationCompletedEventData
+
+Defines the data for the 'browserPageNavigationCompleted' event.
+
+| Prop      | Type                | Description                          |
+| --------- | ------------------- | ------------------------------------ |
+| **`url`** | <code>string</code> | The URL of the page that was loaded. |
+
+
 ### Enums
 
 
diff --git a/android/build.gradle b/android/build.gradle
@@ -58,7 +58,7 @@ repositories {
 dependencies {
     // implementation fileTree(dir: 'libs', include: ['*.jar'])
     implementation project(':capacitor-android')
-    implementation "io.ionic.libs:ioninappbrowser-android:1.2.1"
+    implementation "io.ionic.libs:ioninappbrowser-android:1.3.0"
     implementation 'androidx.browser:browser:1.8.0'
     implementation "androidx.constraintlayout:constraintlayout:2.2.0"
     implementation "androidx.appcompat:appcompat:$androidxAppCompatVersion"
diff --git a/android/src/main/java/com/capacitorjs/osinappbrowser/InAppBrowserPlugin.kt b/android/src/main/java/com/capacitorjs/osinappbrowser/InAppBrowserPlugin.kt
@@ -32,52 +32,22 @@ class InAppBrowserPlugin : Plugin() {
 
     @PluginMethod
     fun openInExternalBrowser(call: PluginCall) {
-        val url = call.getString("url")
-        if (url.isNullOrEmpty()) {
-            sendErrorResult(call, OSInAppBrowserError.InputArgumentsIssue(OSInAppBrowserTarget.EXTERNAL_BROWSER))
-            return
-        }
-
-        if (!isSchemeValid(url)) {
-            sendErrorResult(call, OSInAppBrowserError.InvalidURL)
-            return
-        }
-
-        try {
+        handleBrowserCall(call, OSInAppBrowserTarget.EXTERNAL_BROWSER) { url ->
             val externalBrowserRouter = OSIABExternalBrowserRouterAdapter(context)
-
             engine?.openExternalBrowser(externalBrowserRouter, url) { success ->
-                if (success) {
-                    call.resolve()
-                } else {
-                    sendErrorResult(call, OSInAppBrowserError.OpenFailed(url, OSInAppBrowserTarget.EXTERNAL_BROWSER))
-                }
+                handleBrowserResult(call, success, url, OSInAppBrowserTarget.EXTERNAL_BROWSER)
             }
-        } catch (e: Exception) {
-            sendErrorResult(call, OSInAppBrowserError.OpenFailed(url, OSInAppBrowserTarget.EXTERNAL_BROWSER))
         }
     }
 
     @PluginMethod
     fun openInSystemBrowser(call: PluginCall) {
-        val url = call.getString("url")
-        val options = call.getObject("options")
-
-        if (url.isNullOrEmpty() || options == null) {
-            sendErrorResult(call, OSInAppBrowserError.InputArgumentsIssue(OSInAppBrowserTarget.SYSTEM_BROWSER))
-            return
-        }
-
-        if (!isSchemeValid(url)) {
-            sendErrorResult(call, OSInAppBrowserError.InvalidURL)
-            return
-        }
-
-        try {
+        handleBrowserCall(call, OSInAppBrowserTarget.SYSTEM_BROWSER) { url ->
+            val options = call.getObject("options")
+                ?: return@handleBrowserCall sendErrorResult(call, OSInAppBrowserError.InputArgumentsIssue(OSInAppBrowserTarget.SYSTEM_BROWSER))
             // Try closing active router before continuing to open
             close {
                 val customTabsOptions = buildCustomTabsOptions(options)
-
                 val customTabsRouter = OSIABCustomTabsRouterAdapter(
                     context = context,
                     lifecycleScope = activity.lifecycleScope,
@@ -90,41 +60,21 @@ class InAppBrowserPlugin : Plugin() {
                         notifyListeners(OSIABEventType.BROWSER_FINISHED.value, null)
                     }
                 )
-
                 engine?.openCustomTabs(customTabsRouter, url) { success ->
-                    if (success) {
-                        activeRouter = customTabsRouter
-                        call.resolve()
-                    } else {
-                        sendErrorResult(call, OSInAppBrowserError.OpenFailed(url, OSInAppBrowserTarget.SYSTEM_BROWSER))
-                    }
+                    if (success) activeRouter = customTabsRouter
+                    handleBrowserResult(call, success, url, OSInAppBrowserTarget.SYSTEM_BROWSER)
                 }
             }
-        } catch (e: Exception) {
-            sendErrorResult(call, OSInAppBrowserError.OpenFailed(url, OSInAppBrowserTarget.SYSTEM_BROWSER))
         }
     }
 
     @PluginMethod
     fun openInWebView(call: PluginCall) {
-        val url = call.getString("url")
-        val options = call.getObject("options")
-
-        if (url.isNullOrEmpty() || options == null) {
-            sendErrorResult(call, OSInAppBrowserError.InputArgumentsIssue(OSInAppBrowserTarget.WEB_VIEW))
-            return
-        }
-
-        if (!isSchemeValid(url)) {
-            sendErrorResult(call, OSInAppBrowserError.InvalidURL)
-            return
-        }
-
-        try {
-            // Try closing active router before continuing to open
+        handleBrowserCall(call, OSInAppBrowserTarget.WEB_VIEW) { url ->
+            val options = call.getObject("options")
+                ?: return@handleBrowserCall sendErrorResult(call, OSInAppBrowserError.InputArgumentsIssue(OSInAppBrowserTarget.WEB_VIEW))
             close {
                 val webViewOptions = buildWebViewOptions(options)
-
                 val webViewRouter = OSIABWebViewRouterAdapter(
                     context = context,
                     lifecycleScope = activity.lifecycleScope,
@@ -135,22 +85,20 @@ class InAppBrowserPlugin : Plugin() {
                     },
                     onBrowserFinished = {
                         notifyListeners(OSIABEventType.BROWSER_FINISHED.value, null)
+                    },
+                    onBrowserPageNavigationCompleted = {
+                        notifyListeners(
+                            OSIABEventType.BROWSER_PAGE_NAVIGATION_COMPLETED.value,
+                            JSObject().put("url", it)
+                        )
                     }
                 )
-
                 engine?.openWebView(webViewRouter, url) { success ->
-                    if (success) {
-                        activeRouter = webViewRouter
-                        call.resolve()
-                    } else {
-                        sendErrorResult(call, OSInAppBrowserError.OpenFailed(url, OSInAppBrowserTarget.WEB_VIEW))
-                    }
+                    if (success) activeRouter = webViewRouter
+                    handleBrowserResult(call, success, url, OSInAppBrowserTarget.WEB_VIEW)
                 }
             }
-        } catch (e: Exception) {
-            sendErrorResult(call, OSInAppBrowserError.OpenFailed(url, OSInAppBrowserTarget.WEB_VIEW))
         }
-
     }
 
     @PluginMethod
@@ -175,43 +123,54 @@ class InAppBrowserPlugin : Plugin() {
         } ?: callback(false)
     }
 
+    private fun handleBrowserCall(call: PluginCall, target: OSInAppBrowserTarget, action: (String) -> Unit) {
+        val url = call.getString("url")
+        if (url.isNullOrEmpty()) {
+            sendErrorResult(call, OSInAppBrowserError.InputArgumentsIssue(target))
+            return
+        }
+        if (!isSchemeValid(url)) {
+            sendErrorResult(call, OSInAppBrowserError.InvalidURL)
+            return
+        }
+        try {
+            action(url)
+        } catch (e: Exception) {
+            sendErrorResult(call, OSInAppBrowserError.OpenFailed(url, target))
+        }
+    }
+
+    private fun handleBrowserResult(call: PluginCall, success: Boolean, url: String, target: OSInAppBrowserTarget) {
+        if (success) {
+            call.resolve()
+        } else {
+            sendErrorResult(call, OSInAppBrowserError.OpenFailed(url, target))
+        }
+    }
+
     /**
      * Parses options that come in a JSObject to create a 'OSIABWebViewOptions' object.
      * @param options The options to open the URL in a WebView.
      */
     private fun buildWebViewOptions(options: JSObject): OSIABWebViewOptions {
         return options.let {
-            val showURL = it.getBoolean("showURL", true) ?: true
-            val showToolbar = it.getBoolean("showToolbar", true) ?: true
-            val clearCache = it.getBoolean("clearCache", true) ?: true
-            val clearSessionCache = it.getBoolean("clearSessionCache", true) ?: true
-            val mediaPlaybackRequiresUserAction = it.getBoolean("mediaPlaybackRequiresUserAction", false) ?: false
-            val closeButtonText = it.getString("closeButtonText") ?: "Close"
-            val toolbarPosition = it.getInteger("toolbarPosition")?.let { ordinal ->
-                OSIABToolbarPosition.entries[ordinal]
-            } ?: OSIABToolbarPosition.TOP
-            val leftToRight = it.getBoolean("leftToRight", false) ?: false
-            val showNavigationButtons = it.getBoolean("showNavigationButtons", false) ?: false
-            val customWebViewAgent = it.getString("customWebViewUserAgent", null) ?: null
             val androidOptions = it.getJSObject("android")
-            val allowZoom = androidOptions?.getBoolean("allowZoom", true) ?: true
-            val hardwareBack = androidOptions?.getBoolean("hardwareBack", true) ?: true
-            val pauseMedia = androidOptions?.getBoolean("pauseMedia", true) ?: true
-            
             OSIABWebViewOptions(
-                showURL,
-                showToolbar,
-                clearCache,
-                clearSessionCache,
-                mediaPlaybackRequiresUserAction,
-                closeButtonText,
-                toolbarPosition,
-                leftToRight,
-                showNavigationButtons,
-                allowZoom,
-                hardwareBack,
-                pauseMedia,
-                customWebViewAgent
+                showURL = it.getBoolean("showURL", true) ?: true,
+                showToolbar = it.getBoolean("showToolbar", true) ?: true,
+                clearCache = it.getBoolean("clearCache", true) ?: true,
+                clearSessionCache = it.getBoolean("clearSessionCache", true) ?: true,
+                mediaPlaybackRequiresUserAction = it.getBoolean("mediaPlaybackRequiresUserAction", false) ?: false,
+                closeButtonText = it.getString("closeButtonText") ?: "Close",
+                toolbarPosition = it.getInteger("toolbarPosition")?.let { ordinal ->
+                    OSIABToolbarPosition.entries[ordinal]
+                } ?: OSIABToolbarPosition.TOP,
+                leftToRight = it.getBoolean("leftToRight", false) ?: false,
+                showNavigationButtons = it.getBoolean("showNavigationButtons", false) ?: false,
+                allowZoom = androidOptions?.getBoolean("allowZoom", true) ?: true,
+                hardwareBack = androidOptions?.getBoolean("hardwareBack", true) ?: true,
+                pauseMedia = androidOptions?.getBoolean("pauseMedia", true) ?: true,
+                customUserAgent = it.getString("customWebViewUserAgent", null)
             )
         }
     }
@@ -222,38 +181,21 @@ class InAppBrowserPlugin : Plugin() {
      */
     private fun buildCustomTabsOptions(options: JSObject): OSIABCustomTabsOptions {
         val optionsJson = options.getJSObject("android")
-
-        return optionsJson.let {
-            val showTitle = it?.getBoolean("showTitle", true) ?: true
-            val hideToolbarOnScroll = it?.getBoolean("hideToolbarOnScroll", false) ?: false
-            val viewStyle = it?.getInteger("viewStyle")?.let { ordinal ->
-                OSIABViewStyle.entries[ordinal]
-            } ?: OSIABViewStyle.FULL_SCREEN
-
-            val bottomSheetOptions = it?.getJSObject("bottomSheetOptions")?.let { json ->
-                val height = json.getInteger("height", 1) ?: 1
-                val isFixed = json.getBoolean("isFixed", false) ?: false
-
-                OSIABBottomSheet(height, isFixed)
-            }
-
-            val startAnimation = it?.getInteger("startAnimation")?.let { ordinal ->
-                OSIABAnimation.entries[ordinal]
-            } ?: OSIABAnimation.FADE_IN
-
-            val exitAnimation = it?.getInteger("exitAnimation")?.let { ordinal ->
-                OSIABAnimation.entries[ordinal]
-            } ?: OSIABAnimation.FADE_OUT
-
-            OSIABCustomTabsOptions(
-                showTitle = showTitle,
-                hideToolbarOnScroll = hideToolbarOnScroll,
-                viewStyle = viewStyle,
-                bottomSheetOptions = bottomSheetOptions,
-                startAnimation = startAnimation,
-                exitAnimation = exitAnimation
-            )
-        }
+        return OSIABCustomTabsOptions(
+            showTitle = optionsJson?.getBoolean("showTitle", true) ?: true,
+            hideToolbarOnScroll = optionsJson?.getBoolean("hideToolbarOnScroll", false) ?: false,
+            viewStyle = optionsJson?.getInteger("viewStyle")?.let { OSIABViewStyle.entries[it] }
+                ?: OSIABViewStyle.FULL_SCREEN,
+            bottomSheetOptions = optionsJson?.getJSObject("bottomSheetOptions")?.let {
+                OSIABBottomSheet(
+                    height = it.getInteger("height", 1) ?: 1,
+                    isFixed = it.getBoolean("isFixed", false) ?: false
+                )
+            },
+            startAnimation = optionsJson?.getInteger("startAnimation")?.let { OSIABAnimation.entries[it] }
+                ?: OSIABAnimation.FADE_IN,
+            exitAnimation = optionsJson?.getInteger("exitAnimation")?.let { OSIABAnimation.entries[it] } ?: OSIABAnimation.FADE_OUT
+        )
     }
 
     /**
@@ -272,11 +214,10 @@ class InAppBrowserPlugin : Plugin() {
     private fun sendErrorResult(call: PluginCall, error: OSInAppBrowserError) {
         call.reject(error.message, error.code)
     }
-
-
 }
 
 enum class OSIABEventType(val value: String) {
     BROWSER_FINISHED("browserClosed"),
-    BROWSER_PAGE_LOADED("browserPageLoaded")
+    BROWSER_PAGE_LOADED("browserPageLoaded"),
+    BROWSER_PAGE_NAVIGATION_COMPLETED("browserPageNavigationCompleted")
 }
diff --git a/example-app/src/pages/Home.tsx b/example-app/src/pages/Home.tsx
@@ -1,10 +1,10 @@
 import { IonButton, IonContent, IonHeader, IonInput, IonPage, IonTitle, IonToolbar } from '@ionic/react';
-import { InAppBrowser, DefaultSystemBrowserOptions, DefaultWebViewOptions, DefaultAndroidWebViewOptions, DismissStyle, iOSViewStyle, iOSAnimation, ToolbarPosition, AndroidViewStyle, AndroidAnimation } from '@capacitor/inappbrowser';
+import { InAppBrowser, DefaultSystemBrowserOptions, DefaultWebViewOptions, DefaultAndroidWebViewOptions, DismissStyle, iOSViewStyle, iOSAnimation, ToolbarPosition, AndroidViewStyle, AndroidAnimation, BrowserPageNavigationCompletedEventData } from '@capacitor/inappbrowser';
 import './Home.css';
 
 const Home: React.FC = () => {
 
-  const test = () => {
+  const openInExternalBrowser = () => {
     InAppBrowser.openInExternalBrowser({
       url: "https://www.google.com"
     });
@@ -153,6 +153,10 @@ const Home: React.FC = () => {
     console.log("browser was loaded.");
   });
 
+  InAppBrowser.addListener('browserPageNavigationCompleted', (data: BrowserPageNavigationCompletedEventData) => {
+    console.log("browser page navigation was completed. " + data.url);
+  });
+
   return (
     <IonPage>
       <IonHeader>
@@ -167,7 +171,7 @@ const Home: React.FC = () => {
           </IonToolbar>
         </IonHeader>
         <div>
-          <IonButton onClick={test}>TEST</IonButton>
+          <IonButton onClick={openInExternalBrowser}>External Browser</IonButton>
           <IonButton onClick={openInSystemBrowserWithDefaults}>System Browser with Defaults</IonButton>
           <IonButton onClick={openInSystemBrowserWithCustomValues}>System Browser with Custom Values</IonButton>
           <IonButton onClick={openInWebViewWithDefaults}>Web View with Defaults</IonButton>
diff --git a/ios/Sources/InAppBrowserPlugin/InAppBrowserPlugin.swift b/ios/Sources/InAppBrowserPlugin/InAppBrowserPlugin.swift
diff --git a/src/definitions.ts b/src/definitions.ts
