This version of the documentation is outdated! Click here for the latest released version.

window.open

Opens a URL in a new [InAppBrowser](inappbrowser.html) instance, the current browser instance, or the system browser.

var ref = window.open(url, target, options);

ref: Reference to the [InAppBrowser](inappbrowser.html) 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 the InAppBrowser.
- _blank: Opens in the InAppBrowser.
- _system: Opens in the system's web browser.
options: Options for the [InAppBrowser](inappbrowser.html). 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 ——————--
- closebuttoncaption - set to a string that will be the caption for the "Done" button.
- hidden - set to 'yes' to create the browser and load the page, but not show it. The load event will fire 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
iOS only ——--
- closebuttoncaption - set to a string that will be the caption for the "Done" button. Note that you will have to localize this value yourself.
- hidden - set to 'yes' to create the browser and load the page, but not show it. The load event will fire when loading is complete. Omit or set to 'no' (default) to have the browser open and load normally.
- 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 or no to prevent HTML5 audio or video from autoplaying (defaults to no).
- allowInlineMediaPlayback: Set to yes or no to allow inline 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).

Supported Platforms

Android
BlackBerry
iOS
Windows Phone 7 and 8

Quick Example

var ref = window.open('http://apache.org', '_blank', 'location=yes');
var ref2 = window.open(encodeURI('http://ja.m.wikipedia.org/wiki/ハングル'), '_blank', 'location=yes');

Full Example

<!DOCTYPE html>
<html>
  <head>
    <title>window.open Example</title>

    <script type="text/javascript" charset="utf-8" src="cordova.js"></script>
    <script type="text/javascript" charset="utf-8">

    // Wait for device API libraries to load
    //
    document.addEventListener("deviceready", onDeviceReady, false);

    // device APIs are available
    //
    function onDeviceReady() {
        // external url
        var ref = window.open(encodeURI('http://apache.org'), '_blank', 'location=yes');
        // relative document
        ref = window.open('next.html', '_self');
    }

    </script>
  </head>
  <body>
  </body>
</html>