| --- |
| license: Licensed to the Apache Software Foundation (ASF) under one |
| or more contributor license agreements. See the NOTICE file |
| distributed with this work for additional information |
| regarding copyright ownership. The ASF licenses this file |
| to you under the Apache License, Version 2.0 (the |
| "License"); you may not use this file except in compliance |
| with the License. You may obtain a copy of the License at |
| |
| http://www.apache.org/licenses/LICENSE-2.0 |
| |
| Unless required by applicable law or agreed to in writing, |
| software distributed under the License is distributed on an |
| "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| KIND, either express or implied. See the License for the |
| specific language governing permissions and limitations |
| under the License. |
| --- |
| |
| window.open |
| =========== |
| |
| Opens a URL in a new InAppBrowser instance, the current browser instance, or the system browser. |
| |
| var ref = window.open(url, target, options); |
| |
| - __ref:__ reference to the InAppBrowser window (`InAppBrowser`) |
| - __url:__ the URL to load (`String`). Call encodeURI() on this if you have Unicode characters in your URL. |
| - __target:__ the target to load the URL in (`String`) (Optional, Default: "_self") |
| |
| _self - opens in the Cordova WebView if url is in the white-list, else it opens in the InAppBrowser |
| _blank - always open in the InAppBrowser |
| _system - always open in the system web browser |
| |
| |
| - __options:__ options for the InAppBrowser (`String`) (Optional, Default: "location=yes") |
| |
| The options string must not contain any blank space, each feature name and value must be separated by a comma. Feature names are case insensitive. Only the value below is supported on all platforms: |
| |
| - __location__ - set to 'yes' or 'no' to turn the location bar on or off for the InAppBrowser (defaults to 'yes') |
| |
| iOS and Android only |
| -------------------- |
| - __closebuttoncaption__ - set to a string that will be the caption for the "Done" button. Note that if you set this for iOS, you will have to localize this value yourself. |
| |
| iOS only |
| -------- |
| - __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 not allow autoplayed HTML5 video (defaults to 'no') |
| - __allowInlineMediaPlayback__ - set to 'yes' or 'no' to allow inline HTML5 media playback, also, the video element in the HTML document must also include the webkit-playsinline attribute (defaults to 'no') |
| - __keyboardDisplayRequiresUserAction__ - set to 'yes' or 'no' to open the keyboard when form elements get focus via the JavaScript focus() call (defaults to 'yes') |
| - __suppressesIncrementalRendering__ - set to 'yes' or 'no' to wait until all new view content has been received before it is rendered (defaults to 'no') |
| - __presentationstyle__ - set to 'pagesheet', 'formsheet' or 'fullscreen' to set the [presentation style](http://developer.apple.com/library/ios/documentation/UIKit/Reference/UIViewController_Class/Reference/Reference.html#//apple_ref/occ/instp/UIViewController/modalPresentationStyle) (defaults to 'fullscreen') |
| - __transitionstyle__ - set to 'fliphorizontal', 'crossdissolve' or 'coververtical' to set the [transition style](http://developer.apple.com/library/ios/#documentation/UIKit/Reference/UIViewController_Class/Reference/Reference.html#//apple_ref/occ/instp/UIViewController/modalTransitionStyle) (defaults to 'coververtical') |
| |
| Supported Platforms |
| ------------------- |
| |
| - Android |
| - iOS |
| - BlackBerry 10 |
| - Windows Phone 7 + 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-x.x.x.js"></script> |
| <script type="text/javascript" charset="utf-8"> |
| |
| // Wait for Cordova to load |
| // |
| document.addEventListener("deviceready", onDeviceReady, false); |
| |
| // Cordova is ready |
| // |
| 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> |
| |