cordova-plugin-inappbrowser
https://cordova.apache.org/docs/en/latest/reference/cordova-plugin-inappbrowser/
Installation
cordova plugin add cordova-plugin-inappbrowser
If you want all page loads in your app to go through the InAppBrowser, you can simply hook window.open during initialization. For example:
document.addEventListener("deviceready", onDeviceReady, false);
function onDeviceReady() {
window.open = cordova.InAppBrowser.open;
}
cordova.InAppBrowser.open
Opens a URL in a new InAppBrowser instance, the current browser instance, or the system browser.
var ref = cordova.InAppBrowser.open(url, target, options);
ref: Reference to the InAppBrowser window when the target is set to '_blank'. (InAppBrowser)
url: The URL to load (String). Call encodeURI() on this if the URL contains Unicode characters.
target: The target in which to load the URL, an optional parameter that defaults to _self. (String)
_self: Opens in the Cordova WebView if the URL is in the white list, otherwise it opens in the InAppBrowser._blank: Opens in the InAppBrowser._system: Opens in the system's web browser.
options: Options for the InAppBrowser. Optional, defaulting to: location=yes. (String)
The options string must not contain any blank space, and each feature's name/value pairs must be separated by a comma. Feature names are case insensitive. All platforms support the value below:
- location: Set to
yes or no to turn the InAppBrowser's location bar on or off.
Android only:
- hidden: set to
yes to create the browser and load the page, but not show it. The loadstop event fires when loading is complete. Omit or set to no (default) to have the browser open and load normally. - clearcache: set to
yes to have the browser's cookie cache cleared before the new window is opened - clearsessioncache: set to
yes to have the session cookie cache cleared before the new window is opened - zoom: set to
yes to show Android browser's zoom controls, set to no to hide them. Default value is yes. - hardwareback: set to
yes to use the hardware back button to navigate backwards through the InAppBrowser's history. If there is no previous page, the InAppBrowser will close. The default value is yes, so you must set it to no if you want the back button to simply close the InAppBrowser. - mediaPlaybackRequiresUserAction: Set to
yes to prevent HTML5 audio or video from autoplaying (defaults to no). - shouldPauseOnSuspend: Set to
yes to make InAppBrowser WebView to pause/resume with the app to stop background audio (this may be required to avoid Google Play issues like described in CB-11013). - useWideViewPort: Sets whether the WebView should enable support for the "viewport" HTML meta tag or should use a wide viewport. When the value of the setting is
no, the layout width is always set to the width of the WebView control in device-independent (CSS) pixels. When the value is yes and the page contains the viewport meta tag, the value of the width specified in the tag is used. If the page does not contain the tag or does not provide a width, then a wide viewport will be used. (defaults to yes).
iOS only:
- closebuttoncaption: set to a string to use as the Done button's caption. Note that you need to localize this value yourself.
- disallowoverscroll: Set to
yes or no (default is no). Turns on/off the UIWebViewBounce property. - hidden: set to
yes to create the browser and load the page, but not show it. The loadstop event fires when loading is complete. Omit or set to no (default) to have the browser open and load normally. - clearcache: set to
yes to have the browser's cookie cache cleared before the new window is opened - clearsessioncache: set to
yes to have the session cookie cache cleared before the new window is opened - toolbar: set to
yes or no to turn the toolbar on or off for the InAppBrowser (defaults to yes) - enableViewportScale: Set to
yes or no to prevent viewport scaling through a meta tag (defaults to no). - mediaPlaybackRequiresUserAction: Set to
yes to prevent HTML5 audio or video from autoplaying (defaults to no). - allowInlineMediaPlayback: Set to
yes or no to allow in-line HTML5 media playback, displaying within the browser window rather than a device-specific playback interface. The HTML's video element must also include the webkit-playsinline attribute (defaults to no) - keyboardDisplayRequiresUserAction: Set to
yes or no to open the keyboard when form elements receive focus via JavaScript's focus() call (defaults to yes). - suppressesIncrementalRendering: Set to
yes or no to wait until all new view content is received before being rendered (defaults to no). - presentationstyle: Set to
pagesheet, formsheet or fullscreen to set the presentation style (defaults to fullscreen). - transitionstyle: Set to
fliphorizontal, crossdissolve or coververtical to set the transition style (defaults to coververtical). - toolbarposition: Set to
top or bottom (default is bottom). Causes the toolbar to be at the top or bottom of the window.
Windows only:
- hidden: set to
yes to create the browser and load the page, but not show it. The loadstop event fires when loading is complete. Omit or set to no (default) to have the browser open and load normally. - fullscreen: set to
yes to create the browser control without a border around it. Please note that if location=no is also specified, there will be no control presented to user to close IAB window. - hardwareback: works the same way as on Android platform.
Supported Platforms
- Amazon Fire OS
- Android
- BlackBerry 10
- Firefox OS
- iOS
- OSX
- Windows 8 and 8.1
- Windows Phone 7 and 8
- Browser
.
