0

Inappbrowser – Apache Cordova

Provides a web browser view. It could be used to open images, access web pages, and open PDF files.

Installation

$cordovaInAppBrowser.open

Opens a URL in a new InAppBrowser instance, the current browser instance, or the system browser.

  • 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).

    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.

InAppBrowser

The object returned from a call to $cordovaInAppBrowser.open when the target is set to '_blank'.

Methods

$cordovaInAppBrowserProvider.setDefaultOptions(options)
Param Type Detail
options Object Set global, default options for all inAppBrowsers
open(URL, target, options)
Param Type Detail
URL String Configuration object for setting default values
target String The target in which to load the URL (_self, _blank, _system)
options Object Optionally override default options
close()

Closes the InAppBrowser window.

$rootScope.$on('$cordovaInAppBrowser:loadstart', function(e, event));

Listen for the loadstart event, called when the In App Browser starts loading a page (only after open() is called).

$rootScope.$on('$cordovaInAppBrowser:loadstop', function(e, event));

Listen for the loadstop event, which fires after the Browser has finished loading (only after open() is called).

$rootScope.$on('$cordovaInAppBrowser:loaderror', function(e, event));

Listen for the loaderror event, which fires when the In App Browser encounters an error when loading a URL (only after open() is called).

$rootScope.$on('$cordovaInAppBrowser:exit', function(e, event));

Listen for the exit event, which fires when the InAppBrowser window is closed (only after open() is called).

Example

Set Default Options

Open a new browser

 

Prakash S

Prakash S

I would like to introduce myself as a Software professional opting for the career in software industry. I'm Prakash S, a MCA graduate and trained as industry level practice for Software technology. Basically I am a PHP Developer but now days exploring more in HTML5, CSS, AngularJS and jQuery libraries.