Using web browser view in Ionic (inAppBrowser)
This plugin provides a web browser view that displays when calling
cordova.InAppBrowser.open()
.var ref = cordova.InAppBrowser.open('http://apache.org', '_blank', 'location=yes');
The
cordova.InAppBrowser.open()
function is defined to be a drop-in replacement for the window.open()
function. Existing window.open()
calls can use the InAppBrowser window, by replacing window.open:window.open = cordova.InAppBrowser.open;
The InAppBrowser window behaves like a standard web browser, and can't access Cordova APIs. For this reason, the InAppBrowser is recommended if you need to load third-party (untrusted) content, instead of loading that into the main Cordova webview. The InAppBrowser is not subject to the whitelist, nor is opening links in the system browser.
The InAppBrowser provides by default its own GUI controls for the user (back, forward, done).
For backwards compatibility, this plugin also hooks
window.open
. However, the plugin-installed hook ofwindow.open
can have unintended side effects (especially if this plugin is included only as a dependency of another plugin). The hook of window.open
will be removed in a future major release. Until the hook is removed from the plugin, apps can manually restore the default behaviour:delete window.open // Reverts the call back to it's prototype's default
Although
window.open
is in the global scope, InAppBrowser is not available until after the deviceready
event.document.addEventListener("deviceready", onDeviceReady, false);
function onDeviceReady() {
console.log("window.open works well");
}
Report issues with this plugin on the Apache Cordova issue tracker
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. (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 theInAppBrowser
._blank
: Opens in theInAppBrowser
._system
: Opens in the system's web browser.
- options: Options for the
InAppBrowser
. Optional, defaulting to:location=yes
. (String)Theoptions
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
orno
to turn theInAppBrowser
'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 tono
(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 tono
to hide them. Default value isyes
. - hardwareback: set to
yes
to use the hardware back button to navigate backwards through theInAppBrowser
's history. If there is no previous page, theInAppBrowser
will close. The default value isyes
, so you must set it tono
if you want the back button to simply close the InAppBrowser. - mediaPlaybackRequiresUserAction: Set to
yes
to prevent HTML5 audio or video from autoplaying (defaults tono
).
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
orno
(default isno
). 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 tono
(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
orno
to turn the toolbar on or off for the InAppBrowser (defaults toyes
) - enableViewportScale: Set to
yes
orno
to prevent viewport scaling through a meta tag (defaults tono
). - mediaPlaybackRequiresUserAction: Set to
yes
to prevent HTML5 audio or video from autoplaying (defaults tono
). - allowInlineMediaPlayback: Set to
yes
orno
to allow in-line HTML5 media playback, displaying within the browser window rather than a device-specific playback interface. The HTML'svideo
element must also include thewebkit-playsinline
attribute (defaults tono
) - keyboardDisplayRequiresUserAction: Set to
yes
orno
to open the keyboard when form elements receive focus via JavaScript'sfocus()
call (defaults toyes
). - suppressesIncrementalRendering: Set to
yes
orno
to wait until all new view content is received before being rendered (defaults tono
). - presentationstyle: Set to
pagesheet
,formsheet
orfullscreen
to set the presentation style (defaults tofullscreen
). - transitionstyle: Set to
fliphorizontal
,crossdissolve
orcoververtical
to set the transition style(defaults tocoververtical
). - toolbarposition: Set to
top
orbottom
(default isbottom
). 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 tono
(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=nois also specified, there will be no control presented to user to close IAB window.
- location: Set to
Supported Platforms
- Amazon Fire OS
- Android
- BlackBerry 10
- Firefox OS
- iOS
- Windows 8 and 8.1
- Windows Phone 7 and 8
- Browser
Example
var ref = cordova.InAppBrowser.open('http://apache.org', '_blank', 'location=yes');
var ref2 = cordova.InAppBrowser.open(encodeURI('http://ja.m.wikipedia.org/wiki/ハングル'), '_blank', 'location=yes');
0 comments