polleverywhere/cordova-plugin-inappbrowser

Name: cordova-plugin-inappbrowser

Owner: Poll Everywhere

Description: Mirror of Apache Cordova Plugin inappbrowser

Forked from: apache/cordova-plugin-inappbrowser

Created: 2017-09-30 00:06:41.0

Updated: 2018-03-02 02:35:07.0

Pushed: 2018-03-02 02:35:00.0

Homepage: null

Size: 1089

Language: JavaScript

GitHub Committers

UserMost Recent Commit# Commits

Other Committers

UserEmailMost Recent Commit# Commits

README

title: Inappbrowser

description: Open an in-app browser window.

|AppVeyor|Travis CI| |:-:|:-:| |Build status|Build Status|

cordova-plugin-inappbrowser

You can show helpful articles, videos, and web resources inside of your app. Users can view web pages without leaving your app.

To get a few ideas, check out the sample at the bottom of this page or go straight to the reference content.

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 of window.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 its 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

Reference
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);
Supported Platforms
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');
OSX Quirks

At the moment the only supported target in OSX is _system.

_blank and _self targets are not yet implemented and are ignored silently. Pull requests and patches to get these to work are greatly appreciated.

Browser Quirks
InAppBrowser

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

Methods
InAppBrowser.addEventListener

Adds a listener for an event from the InAppBrowser. (Only available when the target is set to '_blank')

ref.addEventListener(eventname, callback);
Example
inAppBrowserRef;

tion showHelp(url) {

var target = "_blank";

var options = "location=yes,hidden=yes";

inAppBrowserRef = cordova.InAppBrowser.open(url, target, options);

inAppBrowserRef.addEventListener('loadstart', loadStartCallBack);

inAppBrowserRef.addEventListener('loadstop', loadStopCallBack);

inAppBrowserRef.addEventListener('loaderror', loadErrorCallBack);



tion loadStartCallBack() {

$('#status-message').text("loading please wait ...");



tion loadStopCallBack() {

if (inAppBrowserRef != undefined) {

    inAppBrowserRef.insertCSS({ code: "body{font-size: 25px;" });

    $('#status-message').text("");

    inAppBrowserRef.show();
}



tion loadErrorCallBack(params) {

$('#status-message').text("");

var scriptErrorMesssage =
   "alert('Sorry we cannot open that page. Message from the server is : "
   + params.message + "');"

inAppBrowserRef.executeScript({ code: scriptErrorMesssage }, executeScriptCallBack);

inAppBrowserRef.close();

inAppBrowserRef = undefined;



tion executeScriptCallBack(params) {

if (params[0] == null) {

    $('#status-message').text(
       "Sorry we couldn't open that page. Message from the server is : '"
       + params.message + "'");
}
InAppBrowserEvent Properties
Supported Platforms
Browser Quirks

loadstart and loaderror events are not being fired.

Quick Example
var ref = cordova.InAppBrowser.open('http://apache.org', '_blank', 'location=yes');
ref.addEventListener('loadstart', function(event) { alert(event.url); });
InAppBrowser.removeEventListener

Removes a listener for an event from the InAppBrowser. (Only available when the target is set to '_blank')

ref.removeEventListener(eventname, callback);
Supported Platforms
Quick Example
var ref = cordova.InAppBrowser.open('http://apache.org', '_blank', 'location=yes');
var myCallback = function(event) { alert(event.url); }
ref.addEventListener('loadstart', myCallback);
ref.removeEventListener('loadstart', myCallback);
InAppBrowser.close

Closes the InAppBrowser window.

ref.close();
Supported Platforms
Quick Example
var ref = cordova.InAppBrowser.open('http://apache.org', '_blank', 'location=yes');
ref.close();
InAppBrowser.show

Displays an InAppBrowser window that was opened hidden. Calling this has no effect if the InAppBrowser was already visible.

ref.show();
Supported Platforms
Quick Example
var ref = cordova.InAppBrowser.open('http://apache.org', '_blank', 'hidden=yes');
// some time later...
ref.show();
InAppBrowser.hide

Hides the InAppBrowser window. Calling this has no effect if the InAppBrowser was already hidden.

ref.hide();
Supported Platforms
Quick Example
var ref = cordova.InAppBrowser.open('http://apache.org', '_blank');
// some time later...
ref.hide();
InAppBrowser.executeScript

Injects JavaScript code into the InAppBrowser window. (Only available when the target is set to '_blank')

ref.executeScript(details, callback);
Supported Platforms
Quick Example
var ref = cordova.InAppBrowser.open('http://apache.org', '_blank', 'location=yes');
ref.addEventListener('loadstop', function() {
    ref.executeScript({file: "myscript.js"});
});
Browser Quirks
Windows Quirks

Due to MSDN docs the invoked script can return only string values, otherwise the parameter, passed to callback will be [null].

InAppBrowser.insertCSS

Injects CSS into the InAppBrowser window. (Only available when the target is set to '_blank')

ref.insertCSS(details, callback);
Supported Platforms
Quick Example
var ref = cordova.InAppBrowser.open('http://apache.org', '_blank', 'location=yes');
ref.addEventListener('loadstop', function() {
    ref.insertCSS({file: "mystyles.css"});
});

Sample: Show help pages with an InAppBrowser

You can use this plugin to show helpful documentation pages within your app. Users can view online help documents and then close them without leaving the app.

Here's a few snippets that show how you do this.

Give users a way to ask for help

There's lots of ways to do this in your app. A drop down list is a simple way to do that.

ect id="help-select">
<option value="default">Need help?</option>
<option value="article">Show me a helpful article</option>
<option value="video">Show me a helpful video</option>
<option value="search">Search for other topics</option>
lect>

Gather the users choice in the onDeviceReady function of the page and then send an appropriate URL to a helper function in some shared library file. Our helper function is named showHelp() and we'll write that function next.

help-select').on('change', function (e) {

var url;

switch (this.value) {

    case "article":
        url = "https://cordova.apache.org/docs/en/latest/"
                    + "reference/cordova-plugin-inappbrowser/index.html";
        break;

    case "video":
        url = "https://youtu.be/F-GlVrTaeH0";
        break;

    case "search":
        url = "https://www.google.com/#q=inAppBrowser+plugin";
        break;
}

showHelp(url);
Load a help page

We'll use the open function to load the help page. We're setting the hidden property to yes so that we can show the browser only after the page content has loaded. That way, users don't see a blank browser while they wait for content to appear. When the loadstop event is raised, we'll know when the content has loaded. We'll handle that event shortly.

tion showHelp(url) {

var target = "_blank";

var options = "location=yes,hidden=yes";

inAppBrowserRef = cordova.InAppBrowser.open(url, target, options);

inAppBrowserRef.addEventListener('loadstart', loadStartCallBack);

inAppBrowserRef.addEventListener('loadstop', loadStopCallBack);

inAppBrowserRef.addEventListener('loaderror', loadErrorCallBack);
Let users know that you're getting their page ready

Because the browser doesn't immediately appear, we can use the loadstart event to show a status message, progress bar, or other indicator. This assures users that content is on the way.

tion loadStartCallBack() {

$('#status-message').text("loading please wait ...");
Show the help page

When the loadstopcallback event is raised, we know that the content has loaded and we can make the browser visible. This sort of trick can create the impression of better performance. The truth is that whether you show the browser before content loads or not, the load times are exactly the same.

tion loadStopCallBack() {

if (inAppBrowserRef != undefined) {

    inAppBrowserRef.insertCSS({ code: "body{font-size: 25px;" });

    $('#status-message').text("");

    inAppBrowserRef.show();
}

You might have noticed the call to the insertCSS function. This serves no particular purpose in our scenario. But it gives you an idea of why you might use it. In this case, we're just making sure that the font size of your pages have a certain size. You can use this function to insert any CSS style elements. You can even point to a CSS file in your project.

Handle page errors

Sometimes a page no longer exists, a script error occurs, or a user lacks permission to view the resource. How or if you handle that situation is completely up to you and your design. You can let the browser show that message or you can present it in another way.

We'll try to show that error in a message box. We can do that by injecting a script that calls the alert function. That said, this won't work in browsers on Windows devices so we'll have to look at the parameter of the executeScript callback function to see if our attempt worked. If it didn't work out for us, we'll just show the error message in a <div> on the page.

tion loadErrorCallBack(params) {

$('#status-message').text("");

var scriptErrorMesssage =
   "alert('Sorry we cannot open that page. Message from the server is : "
   + params.message + "');"

inAppBrowserRef.executeScript({ code: scriptErrorMesssage }, executeScriptCallBack);

inAppBrowserRef.close();

inAppBrowserRef = undefined;



tion executeScriptCallBack(params) {

if (params[0] == null) {

    $('#status-message').text(
       "Sorry we couldn't open that page. Message from the server is : '"
       + params.message + "'");
}
More Usage Info
Local Urls ( source is in the app package )
iab = cordova.InAppBrowser;

open('local-url.html');                  // loads in the Cordova WebView
open('local-url.html', '_self');         // loads in the Cordova WebView
open('local-url.html', '_system');       // Security error: system browser, but url will not load (iOS)
open('local-url.html', '_blank');        // loads in the InAppBrowser
open('local-url.html', 'random_string'); // loads in the InAppBrowser
open('local-url.html', 'random_string', 'location=no'); // loads in the InAppBrowser, no location bar
Whitelisted Content
iab = cordova.InAppBrowser;

open('http://whitelisted-url.com');                  // loads in the Cordova WebView
open('http://whitelisted-url.com', '_self');         // loads in the Cordova WebView
open('http://whitelisted-url.com', '_system');       // loads in the system browser
open('http://whitelisted-url.com', '_blank');        // loads in the InAppBrowser
open('http://whitelisted-url.com', 'random_string'); // loads in the InAppBrowser

open('http://whitelisted-url.com', 'random_string', 'location=no'); // loads in the InAppBrowser, no location bar
Urls that are not white-listed
iab = cordova.InAppBrowser;

open('http://url-that-fails-whitelist.com');                  // loads in the InAppBrowser
open('http://url-that-fails-whitelist.com', '_self');         // loads in the InAppBrowser
open('http://url-that-fails-whitelist.com', '_system');       // loads in the system browser
open('http://url-that-fails-whitelist.com', '_blank');        // loads in the InAppBrowser
open('http://url-that-fails-whitelist.com', 'random_string'); // loads in the InAppBrowser
open('http://url-that-fails-whitelist.com', 'random_string', 'location=no'); // loads in the InAppBrowser, no location bar
This work is supported by the National Institutes of Health's National Center for Advancing Translational Sciences, Grant Number U24TR002306. This work is solely the responsibility of the creators and does not necessarily represent the official views of the National Institutes of Health.