@ionic-native/in-app-browser

  • Version 5.33.1
  • Published
  • 89.7 kB
  • 1 dependency
  • MIT license

Install

npm i @ionic-native/in-app-browser
yarn add @ionic-native/in-app-browser
pnpm add @ionic-native/in-app-browser

Overview

Ionic Native - Native plugins for ionic apps

Index

Variables

variable InAppBrowser

const InAppBrowser: InAppBrowserOriginal;

    Classes

    class InAppBrowserObject

    class InAppBrowserObject {}

    constructor

    constructor(
    url: string,
    target?: string,
    options?: string | InAppBrowserOptions
    );
    • Opens a URL in a new InAppBrowser instance, the current browser instance, or the system browser.

      Parameter url

      The URL to load.

      Parameter target

      The target in which to load the URL, an optional parameter that defaults to _self. _self: Opens in the 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.

      Parameter options

      Options for the InAppBrowser. Optional, defaulting to: location=yes. 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.

    method close

    close: () => void;
    • Closes the InAppBrowser window.

    method executeScript

    executeScript: (script: { file?: string; code?: string }) => Promise<any>;
    • Injects JavaScript code into the InAppBrowser window.

      Parameter script

      Details of the script to run, specifying either a file or code key.

      Returns

      {Promise}

    method hide

    hide: () => void;
    • Hides an InAppBrowser window that is currently shown. Calling this has no effect if the InAppBrowser was already hidden.

    method insertCSS

    insertCSS: (css: { file?: string; code?: string }) => Promise<any>;
    • Injects CSS into the InAppBrowser window.

      Parameter css

      Details of the script to run, specifying either a file or code key.

      Returns

      {Promise}

    method on

    on: (event: InAppBrowserEventType) => any;
    • A method that allows you to listen to events happening in the browser.

      Parameter event

      Name of the event

      Returns

      {Observable} Returns back an observable that will listen to the event on subscribe, and will stop listening to the event on unsubscribe.

    method show

    show: () => void;
    • Displays an InAppBrowser window that was opened hidden. Calling this has no effect if the InAppBrowser was already visible.

    class InAppBrowserOriginal

    class InAppBrowserOriginal extends IonicNativePlugin {}
    • In App Browser inappbrowser Launches in app Browser

      import { InAppBrowser } from '@ionic-native/in-app-browser/ngx';
      constructor(private iab: InAppBrowser) { }
      ...
      const browser = this.iab.create('https://ionicframework.com/');
      browser.executeScript(...);
      browser.insertCSS(...);
      browser.on('loadstop').subscribe(event => {
      browser.insertCSS({ code: "body{color: red;" });
      });
      browser.close();

      InAppBrowserObject InAppBrowserEvent InAppBrowserOptions

    method create

    create: (
    url: string,
    target?: string,
    options?: string | InAppBrowserOptions
    ) => InAppBrowserObject;
    • Opens a URL in a new InAppBrowser instance, the current browser instance, or the system browser.

      Parameter url

      The URL to load.

      Parameter target

      The target in which to load the URL, an optional parameter that defaults to _self.

      Parameter options

      Options for the InAppBrowser. Optional, defaulting to: location=yes. 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.

      Returns

      {InAppBrowserObject}

    Interfaces

    interface InAppBrowserEvent

    interface InAppBrowserEvent extends Event {}

      property code

      code: number;
      • the error code, only in the case of loaderror.

      property data

      data: any;
      • the postMessage data, only in the case of message.

      property message

      message: string;
      • the error message, only in the case of loaderror.

      property type

      type: string;
      • the event name

      property url

      url: string;
      • the URL that was loaded.

      interface InAppBrowserOptions

      interface InAppBrowserOptions {}

        property allowInlineMediaPlayback

        allowInlineMediaPlayback?: 'yes' | 'no';
        • (iOS Only) 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)

        property beforeload

        beforeload?: 'yes' | 'get' | 'post';
        • set to enable the beforeload event to modify which pages are actually loaded in the browser. Accepted values are get to intercept only GET requests, post to intercept on POST requests or yes to intercept both GET & POST requests. Note that POST requests are not currently supported and will be ignored (if you set beforeload=post it will raise an error).

        property clearcache

        clearcache?: 'yes' | 'no';
        • Set to yes to have the browser's cookie cache cleared before the new window is opened.

        property cleardata

        cleardata?: 'yes' | 'no';
        • set to yes to have the browser's entire local storage cleared (cookies, HTML5 local storage, IndexedDB, etc.) before the new window is opened

        property clearsessioncache

        clearsessioncache?: 'yes' | 'no';
        • Set to yes to have the session cookie cache cleared before the new window is opened. For WKWebView, requires iOS 11+ on target device.

        property closebuttoncaption

        closebuttoncaption?: string;
        • (Android) Set to a string to use as the close button's caption instead of a X. Note that you need to localize this value yourself. (iOS) Set to a string to use as the Done button's caption. Note that you need to localize this value yourself.

        property closebuttoncolor

        closebuttoncolor?: string;
        • (Android) Set to a valid hex color string, for example: #00ff00, and it will change the close button color from default, regardless of being a text or default X. Only has effect if user has location set to yes. (iOS) Set as a valid hex color string, for example: #00ff00, to change from the default Done button's color. Only applicable if toolbar is not disabled.

        property disallowoverscroll

        disallowoverscroll?: 'yes' | 'no';
        • (iOS Only) Set to yes or no (default is no). Turns on/off the UIWebViewBounce property.

        property enableViewportScale

        enableViewportScale?: 'yes' | 'no';
        • (iOS Only) Set to yes or no to prevent viewport scaling through a meta tag (defaults to no).

        property footer

        footer?: 'yes' | 'no';
        • (Android Only) Set to yes to show a close button in the footer similar to the iOS Done button. The close button will appear the same as for the header hence use closebuttoncaption and closebuttoncolor to set its properties

        property footercolor

        footercolor?: string;
        • (Android Only) Set to a valid hex color string, for example #00ff00 or #CC00ff00 (#aarrggbb), and it will change the footer color from default. Only has effect if user has footer set to yes

        property fullscreen

        fullscreen?: 'yes' | 'no';
        • (Windows only) 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.

        property hardwareback

        hardwareback?: 'yes' | 'no';
        • (Android & Windows Only) 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.

        property hidden

        hidden?: 'yes' | 'no';
        • 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.

        property hidenavigationbuttons

        hidenavigationbuttons?: 'yes' | 'no';
        • (Android) Set to yes to hide the navigation buttons on the location toolbar, only has effect if user has location set to yes. The default value is no. (iOS) Set to yes or no to turn the toolbar navigation buttons on or off (defaults to no). Only applicable if toolbar is not disabled.

        property hidespinner

        hidespinner?: 'yes' | 'no';
        • (iOS Only) Set to yes or no to change the visibility of the loading indicator (defaults to no).

        property hideurlbar

        hideurlbar?: 'yes' | 'no';
        • (Android) Set to yes to hide the url bar on the location toolbar, only has effect if user has location set to yes. The default value is no.

        property keyboardDisplayRequiresUserAction

        keyboardDisplayRequiresUserAction?: 'yes' | 'no';
        • (iOS Only) Set to yes or no to open the keyboard when form elements receive focus via JavaScript's focus() call (defaults to yes).

        property lefttoright

        lefttoright?: 'yes' | 'no';
        • (Android) Set to yes to swap positions of the navigation buttons and the close button. Specifically, navigation buttons go to the left and close button to the right. (iOS) Set to yes to swap positions of the navigation buttons and the close button. Specifically, close button goes to the right and navigation buttons to the left.

        property location

        location?: 'yes' | 'no';
        • Set to yes or no to turn the InAppBrowser's location bar on or off.

        property mediaPlaybackRequiresUserAction

        mediaPlaybackRequiresUserAction?: 'yes' | 'no';
        • Set to yes to prevent HTML5 audio or video from autoplaying (defaults to no).

        property navigationbuttoncolor

        navigationbuttoncolor?: string;
        • (Android) Set to a valid hex color string, for example: #00ff00, and it will change the color of both navigation buttons from default. Only has effect if user has location set to yes and not hidenavigationbuttons set to yes. (iOS) Set as a valid hex color string, for example: #00ff00, to change from the default color. Only applicable if navigation buttons are visible.

        property presentationstyle

        presentationstyle?: 'pagesheet' | 'formsheet' | 'fullscreen';
        • (iOS Only) Set to pagesheet, formsheet or fullscreen to set the presentation style (defaults to fullscreen).

        property shouldPauseOnSuspend

        shouldPauseOnSuspend?: 'yes' | 'no';
        • (Android Only) 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)

        property suppressesIncrementalRendering

        suppressesIncrementalRendering?: 'yes' | 'no';
        • (iOS Only) Set to yes or no to wait until all new view content is received before being rendered (defaults to no).

        property toolbar

        toolbar?: 'yes' | 'no';
        • (iOS Only) Set to yes or no to turn the toolbar on or off for the InAppBrowser (defaults to yes)

        property toolbarcolor

        toolbarcolor?: string;
        • (Android) Set to a valid hex color string, for example: #00ff00, and it will change the color the toolbar from default. Only has effect if user has location set to yes. (iOS) Set as a valid hex color string, for example: #00ff00, to change from the default color of the toolbar. Only applicable if toolbar is not disabled.

        property toolbarposition

        toolbarposition?: 'top' | 'bottom';
        • (iOS Only) Set to top or bottom (default is bottom). Causes the toolbar to be at the top or bottom of the window.

        property toolbartranslucent

        toolbartranslucent?: 'yes' | 'no';
        • (iOS Only) Set to yes or no to make the toolbar translucent(semi-transparent) (defaults to yes). Only applicable if toolbar is not disabled.

        property transitionstyle

        transitionstyle?: 'fliphorizontal' | 'crossdissolve' | 'coververtical';
        • (iOS Only) Set to fliphorizontal, crossdissolve or coververtical to set the transition style (defaults to coververtical).

        property useWideViewPort

        useWideViewPort?: 'yes' | 'no';
        • (Android Only) Sets whether the WebView should enable support for the "viewport" HTML meta tag or should use a wide viewport. When the value of the setting is no, the layout width is always set to the width of the WebView control in device-independent (CSS) pixels. When the value is yes and the page contains the viewport meta tag, the value of the width specified in the tag is used. If the page does not contain the tag or does not provide a width, then a wide viewport will be used. (defaults to yes).

        property usewkwebview

        usewkwebview?: 'yes' | 'no';
        • (iOS Only) Set to yes to use WKWebView engine for the InappBrowser. Omit or set to no (default) to use UIWebView.

        property zoom

        zoom?: 'yes' | 'no';
        • (Android Only) Set to yes to show Android browser's zoom controls, set to no to hide them. Default value is yes.

        index signature

        [key: string]: any;

        Type Aliases

        type InAppBrowserEventType

        type InAppBrowserEventType =
        | 'loadstart'
        | 'loadstop'
        | 'loaderror'
        | 'exit'
        | 'beforeload'
        | 'message'
        | 'customscheme';

          Package Files (1)

          Dependencies (1)

          Dev Dependencies (0)

          No dev dependencies.

          Peer Dependencies (2)

          Badge

          To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

          You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@ionic-native/in-app-browser.

          • Markdown
            [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@ionic-native/in-app-browser)
          • HTML
            <a href="https://www.jsdocs.io/package/@ionic-native/in-app-browser"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>