@capgo/inappbrowser 0.4.2 → 0.4.6

package/README.md

@@ -23,6 +23,7 @@ npx cap sync
 * [`addListener('urlChangeEvent', ...)`](#addlistenerurlchangeevent)
 * [`addListener('closeEvent', ...)`](#addlistenercloseevent)
 * [`addListener('confirmBtnClicked', ...)`](#addlistenerconfirmbtnclicked)
+* [`removeAllListeners()`](#removealllisteners)
 * [Interfaces](#interfaces)
 * [Type Aliases](#type-aliases)
 * [Enums](#enums)
@@ -38,12 +39,16 @@ npx cap sync
 open(options: OpenOptions) => any
 ```
 
+Open url in a new window fullscreen
+
 | Param         | Type                                                |
 | ------------- | --------------------------------------------------- |
 | **`options`** | <code><a href="#openoptions">OpenOptions</a></code> |
 
 **Returns:** <code>any</code>
 
+**Since:** 0.1.0
+
 --------------------
 
 
@@ -64,12 +69,16 @@ close() => any
 openWebView(options: OpenWebViewOptions) => any
 ```
 
+Open url in a new webview with toolbars
+
 | Param         | Type                                                              |
 | ------------- | ----------------------------------------------------------------- |
 | **`options`** | <code><a href="#openwebviewoptions">OpenWebViewOptions</a></code> |
 
 **Returns:** <code>any</code>
 
+**Since:** 0.1.0
+
 --------------------
 
 
@@ -91,7 +100,7 @@ setUrl(options: { url: string; }) => any
 ### addListener('urlChangeEvent', ...)
 
 ```typescript
-addListener(eventName: 'urlChangeEvent', listenerFunc: UrlChangeListener) => Promise<PluginListenerHandle> & PluginListenerHandle
+addListener(eventName: "urlChangeEvent", listenerFunc: UrlChangeListener) => Promise<PluginListenerHandle> & PluginListenerHandle
 ```
 
 Listen for url change
@@ -111,7 +120,7 @@ Listen for url change
 ### addListener('closeEvent', ...)
 
 ```typescript
-addListener(eventName: 'closeEvent', listenerFunc: UrlChangeListener) => Promise<PluginListenerHandle> & PluginListenerHandle
+addListener(eventName: "closeEvent", listenerFunc: UrlChangeListener) => Promise<PluginListenerHandle> & PluginListenerHandle
 ```
 
 Listen for close click
@@ -131,7 +140,7 @@ Listen for close click
 ### addListener('confirmBtnClicked', ...)
 
 ```typescript
-addListener(eventName: 'confirmBtnClicked', listenerFunc: ConfirmBtnListener) => Promise<PluginListenerHandle> & PluginListenerHandle
+addListener(eventName: "confirmBtnClicked", listenerFunc: ConfirmBtnListener) => Promise<PluginListenerHandle> & PluginListenerHandle
 ```
 
 Will be triggered when user clicks on confirm button when disclaimer is required, works only on iOS
@@ -148,16 +157,31 @@ Will be triggered when user clicks on confirm button when disclaimer is required
 --------------------
 
 
+### removeAllListeners()
+
+```typescript
+removeAllListeners() => any
+```
+
+Remove all listeners for this plugin.
+
+**Returns:** <code>any</code>
+
+**Since:** 1.0.0
+
+--------------------
+
+
 ### Interfaces
 
 
 #### OpenOptions
 
-| Prop                         | Type                                        |
-| ---------------------------- | ------------------------------------------- |
-| **`url`**                    | <code>string</code>                         |
-| **`headers`**                | <code><a href="#headers">Headers</a></code> |
-| **`isPresentAfterPageLoad`** | <code>boolean</code>                        |
+| Prop                         | Type                                        | Description                                                                                                           | Since |
+| ---------------------------- | ------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | ----- |
+| **`url`**                    | <code>string</code>                         | Target URL to load.                                                                                                   | 0.1.0 |
+| **`headers`**                | <code><a href="#headers">Headers</a></code> | <a href="#headers">Headers</a> to send with the request.                                                              | 0.1.0 |
+| **`isPresentAfterPageLoad`** | <code>boolean</code>                        | if true, the browser will be presented after the page is loaded, if false, the browser will be presented immediately. | 0.1.0 |
 
 
 #### Headers
@@ -165,16 +189,16 @@ Will be triggered when user clicks on confirm button when disclaimer is required
 
 #### OpenWebViewOptions
 
-| Prop                         | Type                                                            |
-| ---------------------------- | --------------------------------------------------------------- |
-| **`url`**                    | <code>string</code>                                             |
-| **`headers`**                | <code><a href="#headers">Headers</a></code>                     |
-| **`shareDisclaimer`**        | <code><a href="#disclaimeroptions">DisclaimerOptions</a></code> |
-| **`toolbarType`**            | <code><a href="#toolbartype">ToolBarType</a></code>             |
-| **`shareSubject`**           | <code>string</code>                                             |
-| **`title`**                  | <code>string</code>                                             |
-| **`backgroundColor`**        | <code><a href="#backgroundcolor">BackgroundColor</a></code>     |
-| **`isPresentAfterPageLoad`** | <code>boolean</code>                                            |
+| Prop                         | Type                                                            | Description                                                                                                                                                                       | Default                            | Since |
+| ---------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------- | ----- |
+| **`url`**                    | <code>string</code>                                             | Target URL to load.                                                                                                                                                               |                                    | 0.1.0 |
+| **`headers`**                | <code><a href="#headers">Headers</a></code>                     | <a href="#headers">Headers</a> to send with the request.                                                                                                                          |                                    | 0.1.0 |
+| **`shareDisclaimer`**        | <code><a href="#disclaimeroptions">DisclaimerOptions</a></code> | share options                                                                                                                                                                     |                                    | 0.1.0 |
+| **`toolbarType`**            | <code><a href="#toolbartype">ToolBarType</a></code>             | Toolbar type                                                                                                                                                                      | <code>ToolBarType.DEFAULT</code>   | 0.1.0 |
+| **`shareSubject`**           | <code>string</code>                                             | Share subject                                                                                                                                                                     |                                    | 0.1.0 |
+| **`title`**                  | <code>string</code>                                             | Title of the browser                                                                                                                                                              | <code>'New Window'</code>          | 0.1.0 |
+| **`backgroundColor`**        | <code><a href="#backgroundcolor">BackgroundColor</a></code>     | Background color of the browser, only on IOS                                                                                                                                      | <code>BackgroundColor.BLACK</code> | 0.1.0 |
+| **`isPresentAfterPageLoad`** | <code>boolean</code>                                            | Open url in a new window fullscreen isPresentAfterPageLoad: if true, the browser will be presented after the page is loaded, if false, the browser will be presented immediately. | <code>false</code>                 | 0.1.0 |
 
 
 #### DisclaimerOptions
@@ -228,18 +252,18 @@ Will be triggered when user clicks on confirm button when disclaimer is required
 
 | Members          | Value                     |
 | ---------------- | ------------------------- |
-| **`ACTIVITY`**   | <code>'activity'</code>   |
-| **`NAVIGATION`** | <code>'navigation'</code> |
-| **`BLANK`**      | <code>'blank'</code>      |
-| **`DEFAULT`**    | <code>''</code>           |
+| **`ACTIVITY`**   | <code>"activity"</code>   |
+| **`NAVIGATION`** | <code>"navigation"</code> |
+| **`BLANK`**      | <code>"blank"</code>      |
+| **`DEFAULT`**    | <code>""</code>           |
 
 
 #### BackgroundColor
 
 | Members     | Value                |
 | ----------- | -------------------- |
-| **`WHITE`** | <code>'white'</code> |
-| **`BLACK`** | <code>'black'</code> |
+| **`WHITE`** | <code>"white"</code> |
+| **`BLACK`** | <code>"black"</code> |
 
 </docgen-api>
 

package/android/src/main/java/ee/forgr/capacitor_inappbrowser/InAppBrowserPlugin.java

@@ -21,161 +21,189 @@ import java.util.Iterator;
 @CapacitorPlugin(name = "InAppBrowser")
 public class InAppBrowserPlugin extends Plugin {
 
-    public static final String CUSTOM_TAB_PACKAGE_NAME = "com.android.chrome"; // Change when in stable
-    private CustomTabsClient customTabsClient;
-    private CustomTabsSession currentSession;
-    private WebViewDialog webViewDialog = null;
+  public static final String CUSTOM_TAB_PACKAGE_NAME = "com.android.chrome"; // Change when in stable
+  private CustomTabsClient customTabsClient;
+  private CustomTabsSession currentSession;
+  private WebViewDialog webViewDialog = null;
+
+  CustomTabsServiceConnection connection = new CustomTabsServiceConnection() {
+    @Override
+    public void onCustomTabsServiceConnected(
+      ComponentName name,
+      CustomTabsClient client
+    ) {
+      customTabsClient = client;
+      client.warmup(0);
+    }
+
+    @Override
+    public void onServiceDisconnected(ComponentName name) {}
+  };
 
-    CustomTabsServiceConnection connection = new CustomTabsServiceConnection() {
+  @PluginMethod
+  public void setUrl(PluginCall call) {
+    String url = call.getString("url");
+    if (url == null || TextUtils.isEmpty(url)) {
+      call.reject("Invalid URL");
+    }
+    getActivity()
+      .runOnUiThread(
+        new Runnable() {
+          @Override
+          public void run() {
+            webViewDialog.setUrl(url);
+          }
+        }
+      );
+    call.resolve();
+  }
+
+  @PluginMethod
+  public void open(PluginCall call) {
+    String url = call.getString("url");
+    if (url == null || TextUtils.isEmpty(url)) {
+      call.reject("Invalid URL");
+    }
+    CustomTabsIntent.Builder builder = new CustomTabsIntent.Builder(
+      getCustomTabsSession()
+    );
+    CustomTabsIntent tabsIntent = builder.build();
+    tabsIntent.intent.putExtra(
+      Intent.EXTRA_REFERRER,
+      Uri.parse(
+        Intent.URI_ANDROID_APP_SCHEME + "//" + getContext().getPackageName()
+      )
+    );
+    tabsIntent.intent.putExtra(
+      android.provider.Browser.EXTRA_HEADERS,
+      this.getHeaders(call)
+    );
+    tabsIntent.launchUrl(getContext(), Uri.parse(url));
+
+    call.resolve();
+  }
+
+  @PluginMethod
+  public void openWebView(PluginCall call) {
+    String url = call.getString("url");
+    if (url == null || TextUtils.isEmpty(url)) {
+      call.reject("Invalid URL");
+    }
+    final Options options = new Options();
+    options.setUrl(url);
+    options.setHeaders(call.getObject("headers"));
+    options.setTitle(call.getString("title", "New Window"));
+    options.setShareDisclaimer(call.getObject("shareDisclaimer", null));
+    options.setShareSubject(call.getString("shareSubject", null));
+    options.setToolbarType(call.getString("toolbarType", ""));
+    options.setPresentAfterPageLoad(
+      call.getBoolean("isPresentAfterPageLoad", false)
+    );
+    options.setPluginCall(call);
+    options.setCallbacks(
+      new WebViewCallbacks() {
         @Override
-        public void onCustomTabsServiceConnected(ComponentName name, CustomTabsClient client) {
-            customTabsClient = client;
-            client.warmup(0);
+        public void urlChangeEvent(String url) {
+          notifyListeners("urlChangeEvent", new JSObject().put("url", url));
         }
 
         @Override
-        public void onServiceDisconnected(ComponentName name) {}
-    };
-
-    @PluginMethod
-    public void setUrl(PluginCall call) {
-        String url = call.getString("url");
-        if (url == null || TextUtils.isEmpty(url)) {
-            call.reject("Invalid URL");
+        public void closeEvent(String url) {
+          notifyListeners("closeEvent", new JSObject().put("url", url));
         }
-        getActivity()
-            .runOnUiThread(
-                new Runnable() {
-                    @Override
-                    public void run() {
-                        webViewDialog.setUrl(url);
-                    }
-                }
-            );
-        call.resolve();
-    }
 
-    @PluginMethod
-    public void open(PluginCall call) {
-        String url = call.getString("url");
-        if (url == null || TextUtils.isEmpty(url)) {
-            call.reject("Invalid URL");
+        @Override
+        public void pageLoaded() {
+          notifyListeners("browserPageLoaded", new JSObject());
         }
-        CustomTabsIntent.Builder builder = new CustomTabsIntent.Builder(getCustomTabsSession());
-        CustomTabsIntent tabsIntent = builder.build();
-        tabsIntent.intent.putExtra(Intent.EXTRA_REFERRER, Uri.parse(Intent.URI_ANDROID_APP_SCHEME + "//" + getContext().getPackageName()));
-        tabsIntent.intent.putExtra(android.provider.Browser.EXTRA_HEADERS, this.getHeaders(call));
-        tabsIntent.launchUrl(getContext(), Uri.parse(url));
-
-        call.resolve();
-    }
 
-    @PluginMethod
-    public void openWebView(PluginCall call) {
-        String url = call.getString("url");
-        if (url == null || TextUtils.isEmpty(url)) {
-            call.reject("Invalid URL");
+        @Override
+        public void pageLoadError() {
+          notifyListeners("pageLoadError", new JSObject());
         }
-        final Options options = new Options();
-        options.setUrl(url);
-        options.setHeaders(call.getObject("headers"));
-        options.setTitle(call.getString("title", "New Window"));
-        options.setShareDisclaimer(call.getObject("shareDisclaimer", null));
-        options.setShareSubject(call.getString("shareSubject", null));
-        options.setToolbarType(call.getString("toolbarType", ""));
-        options.setPresentAfterPageLoad(call.getBoolean("isPresentAfterPageLoad", false));
-        options.setPluginCall(call);
-        options.setCallbacks(
-            new WebViewCallbacks() {
-                @Override
-                public void urlChangeEvent(String url) {
-                    notifyListeners("urlChangeEvent", new JSObject().put("url", url));
-                }
-                @Override
-                public void closeEvent(String url) {
-                    notifyListeners("closeEvent", new JSObject().put("url", url));
-                }
-
-                @Override
-                public void pageLoaded() {
-                    notifyListeners("browserPageLoaded", new JSObject());
-                }
-
-                @Override
-                public void pageLoadError() {
-                    notifyListeners("pageLoadError", new JSObject());
-                }
-            }
-        );
-        getActivity()
-            .runOnUiThread(
-                new Runnable() {
-                    @Override
-                    public void run() {
-                        webViewDialog = new WebViewDialog(getContext(), android.R.style.Theme_NoTitleBar, options);
-                        webViewDialog.presentWebView();
-                    }
-                }
-            );
-    }
-
-    @PluginMethod
-    public void close(PluginCall call) {
-        if (webViewDialog != null) {
-            webViewDialog.dismiss();
-            webViewDialog = null;
-        } else {
-            Intent intent = new Intent(getContext(), getBridge().getActivity().getClass());
-            intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TOP);
-            getContext().startActivity(intent);
+      }
+    );
+    getActivity()
+      .runOnUiThread(
+        new Runnable() {
+          @Override
+          public void run() {
+            webViewDialog =
+              new WebViewDialog(
+                getContext(),
+                android.R.style.Theme_NoTitleBar,
+                options
+              );
+            webViewDialog.presentWebView();
+          }
         }
-        call.resolve();
+      );
+  }
+
+  @PluginMethod
+  public void close(PluginCall call) {
+    if (webViewDialog != null) {
+      webViewDialog.dismiss();
+      webViewDialog = null;
+    } else {
+      Intent intent = new Intent(
+        getContext(),
+        getBridge().getActivity().getClass()
+      );
+      intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TOP);
+      getContext().startActivity(intent);
     }
-
-    private Bundle getHeaders(PluginCall pluginCall) {
-        JSObject headersProvided = pluginCall.getObject("headers");
-        Bundle headers = new Bundle();
-        if (headersProvided != null) {
-            Iterator<String> keys = headersProvided.keys();
-            while (keys.hasNext()) {
-                String key = keys.next();
-                headers.putString(key, headersProvided.getString(key));
-            }
-        }
-        return headers;
+    call.resolve();
+  }
+
+  private Bundle getHeaders(PluginCall pluginCall) {
+    JSObject headersProvided = pluginCall.getObject("headers");
+    Bundle headers = new Bundle();
+    if (headersProvided != null) {
+      Iterator<String> keys = headersProvided.keys();
+      while (keys.hasNext()) {
+        String key = keys.next();
+        headers.putString(key, headersProvided.getString(key));
+      }
     }
-
-    protected void handleOnResume() {
-        boolean ok = CustomTabsClient.bindCustomTabsService(getContext(), CUSTOM_TAB_PACKAGE_NAME, connection);
-        if (!ok) {
-            Log.e(getLogTag(), "Error binding to custom tabs service");
-        }
+    return headers;
+  }
+
+  protected void handleOnResume() {
+    boolean ok = CustomTabsClient.bindCustomTabsService(
+      getContext(),
+      CUSTOM_TAB_PACKAGE_NAME,
+      connection
+    );
+    if (!ok) {
+      Log.e(getLogTag(), "Error binding to custom tabs service");
     }
+  }
 
-    protected void handleOnPause() {
-        getContext().unbindService(connection);
-    }
+  protected void handleOnPause() {
+    getContext().unbindService(connection);
+  }
 
-    public CustomTabsSession getCustomTabsSession() {
-        if (customTabsClient == null) {
-            return null;
-        }
+  public CustomTabsSession getCustomTabsSession() {
+    if (customTabsClient == null) {
+      return null;
+    }
 
-        if (currentSession == null) {
-            currentSession =
-                customTabsClient.newSession(
-                    new CustomTabsCallback() {
-                        @Override
-                        public void onNavigationEvent(int navigationEvent, Bundle extras) {
-                            switch (navigationEvent) {
-                                case NAVIGATION_FINISHED:
-                                    notifyListeners("browserPageLoaded", new JSObject());
-                                    break;
-                            }
-                        }
-                    }
-                );
-        }
-        return currentSession;
+    if (currentSession == null) {
+      currentSession =
+        customTabsClient.newSession(
+          new CustomTabsCallback() {
+            @Override
+            public void onNavigationEvent(int navigationEvent, Bundle extras) {
+              switch (navigationEvent) {
+                case NAVIGATION_FINISHED:
+                  notifyListeners("browserPageLoaded", new JSObject());
+                  break;
+              }
+            }
+          }
+        );
     }
+    return currentSession;
+  }
 }

package/android/src/main/java/ee/forgr/capacitor_inappbrowser/Options.java

@@ -5,85 +5,85 @@ import com.getcapacitor.PluginCall;
 
 public class Options {
 
-    private String title;
-    private String url;
-    private JSObject headers;
-    private String toolbarType;
-    private JSObject shareDisclaimer;
-    private String shareSubject;
-    private boolean isPresentAfterPageLoad;
-    private WebViewCallbacks callbacks;
-    private PluginCall pluginCall;
-
-    public PluginCall getPluginCall() {
-        return pluginCall;
-    }
-
-    public void setPluginCall(PluginCall pluginCall) {
-        this.pluginCall = pluginCall;
-    }
-
-    public String getTitle() {
-        return title;
-    }
-
-    public void setTitle(String title) {
-        this.title = title;
-    }
-
-    public String getUrl() {
-        return url;
-    }
-
-    public void setUrl(String url) {
-        this.url = url;
-    }
-
-    public JSObject getHeaders() {
-        return headers;
-    }
-
-    public void setHeaders(JSObject headers) {
-        this.headers = headers;
-    }
-
-    public String getToolbarType() {
-        return toolbarType;
-    }
-
-    public void setToolbarType(String toolbarType) {
-        this.toolbarType = toolbarType;
-    }
-
-    public JSObject getShareDisclaimer() {
-        return shareDisclaimer;
-    }
-
-    public void setShareDisclaimer(JSObject shareDisclaimer) {
-        this.shareDisclaimer = shareDisclaimer;
-    }
-
-    public String getShareSubject() {
-        return shareSubject;
-    }
-
-    public void setShareSubject(String shareSubject) {
-        this.shareSubject = shareSubject;
-    }
-
-    public boolean isPresentAfterPageLoad() {
-        return isPresentAfterPageLoad;
-    }
-
-    public void setPresentAfterPageLoad(boolean presentAfterPageLoad) {
-        isPresentAfterPageLoad = presentAfterPageLoad;
-    }
-
-    public WebViewCallbacks getCallbacks() {
-        return callbacks;
-    }
-
-    public void setCallbacks(WebViewCallbacks callbacks) {
-        this.callbacks = callbacks;
-    }
+  private String title;
+  private String url;
+  private JSObject headers;
+  private String toolbarType;
+  private JSObject shareDisclaimer;
+  private String shareSubject;
+  private boolean isPresentAfterPageLoad;
+  private WebViewCallbacks callbacks;
+  private PluginCall pluginCall;
+
+  public PluginCall getPluginCall() {
+    return pluginCall;
+  }
+
+  public void setPluginCall(PluginCall pluginCall) {
+    this.pluginCall = pluginCall;
+  }
+
+  public String getTitle() {
+    return title;
+  }
+
+  public void setTitle(String title) {
+    this.title = title;
+  }
+
+  public String getUrl() {
+    return url;
+  }
+
+  public void setUrl(String url) {
+    this.url = url;
+  }
+
+  public JSObject getHeaders() {
+    return headers;
+  }
+
+  public void setHeaders(JSObject headers) {
+    this.headers = headers;
+  }
+
+  public String getToolbarType() {
+    return toolbarType;
+  }
+
+  public void setToolbarType(String toolbarType) {
+    this.toolbarType = toolbarType;
+  }
+
+  public JSObject getShareDisclaimer() {
+    return shareDisclaimer;
+  }
+
+  public void setShareDisclaimer(JSObject shareDisclaimer) {
+    this.shareDisclaimer = shareDisclaimer;
+  }
+
+  public String getShareSubject() {
+    return shareSubject;
+  }
+
+  public void setShareSubject(String shareSubject) {
+    this.shareSubject = shareSubject;
+  }
+
+  public boolean isPresentAfterPageLoad() {
+    return isPresentAfterPageLoad;
+  }
+
+  public void setPresentAfterPageLoad(boolean presentAfterPageLoad) {
+    isPresentAfterPageLoad = presentAfterPageLoad;
+  }
+
+  public WebViewCallbacks getCallbacks() {
+    return callbacks;
+  }
+
+  public void setCallbacks(WebViewCallbacks callbacks) {
+    this.callbacks = callbacks;
+  }
 }

package/android/src/main/java/ee/forgr/capacitor_inappbrowser/WebViewCallbacks.java

@@ -1,11 +1,11 @@
 package ee.forgr.capacitor_inappbrowser;
 
 public interface WebViewCallbacks {
-    public void urlChangeEvent(String url);
+  public void urlChangeEvent(String url);
 
-    public void closeEvent(String url);
+  public void closeEvent(String url);
 
-    public void pageLoaded();
+  public void pageLoaded();
 
-    public void pageLoadError();
+  public void pageLoadError();
 }