@mailbutler/cordova-plugin-browsertab
v0.2.0
Published
In-app browser tabs for Android and iOS
Downloads
45
Readme
cordova-plugin-browsertab
Cordova plugin to open URLs in browser tabs with access to cookies (iOS, Android)
Platforms
- iOS (SFSafariViewController, SFAuthenticationSession since iOS 11)
- Android (Chrome Custom Tabs support since Chrome 45)
Usage
To open a URL in an in-app browser tab:
cordova.plugins.browsertab.openUrl(url, options, onSuccess, onError);
Your Cordova WebView continues to run Javascript. So you can close the tab later:
WARNING!!! On Android this method doesn't work. User should close this window manually or you can do it in JS open app by navigate to <scheme of app>://
cordova.plugins.browsertab.close();
You can also open a URL in the system browser:
cordova.plugins.browsertab.openUrlInBrowser(url, options, onSuccess, onError);
In this case, your WebView will not continue to run Javascript until you switch back to the app.
oAuth
Typically you would use this plugin for authentication flows, to grab oAuth tokens. In this case, you will have to supply the scheme
option to be used in iOS 11:
cordova.plugins.browsertab.openUrl(url, {scheme: "myapp://"}, onSuccess, onError);
On iOS 11 the user will have an additional dialog before the flow proceeds, telling the user your app wants to authenticate with a certain website.
Note that the oAuth flows such as facebook login will only agree to redirect you to a web url that begins with http://
or https://
. That means a successful login will still leave the user looking at the browser tab. Thus, you should redirect them to your website, which should then use location.href = "myapp://something?parameters=here";
to send a message back to your Cordova app. Alternatively, you can set up Universal Links on iOS and App Links on Android to make this step more seamless (and possibly more future-proof if custom URL schemes ever go away).
In any case, you will need a plugin such as this one to run Javascript on handleOpenURL
. This returns control to your WebView and you can now call close()
on the previously opened browser tab.
Building
Install Cordova if you haven't already:
npm install -g cordova
Then from the root directory:
cd demo
cordova platform add ios
cordova run ios
cordova platform add android
cordova run android
Development
During development if you want to make changes to the plugin you need to force a rebuild and add the plugin from source, like so (from the demo directory):
cordova plugin remove cordova-plugin-browsertab
cordova plugin add ../plugin
To refresh the platform build:
cordova platform remove ios
cordova platform add ios
To set breakpoints, etc, open the project in the code editor:
cordova platform add ios
open platforms/ios/BrowserTabDemo.xcworkspace