avioli / capacitor-inappbrowser

Capacitor plugin in app browser with urlChangeEvent

@capgo/inappbrowser

Check out: Capgo — Instant updates for capacitor

Capacitor plugin in app browser with urlChangeEvent

Install

npm install @capgo/inappbrowser
npx cap sync

Usage

import { InAppBrowser } from '@capgo/inappbrowser'

InAppBrowser.open("YOUR_URL");

API

• open(...)
• clearCookies()
• close()
• openWebView(...)
• setUrl(...)
• addListener('urlChangeEvent', ...)
• addListener('closeEvent', ...)
• addListener('confirmBtnClicked', ...)
• removeAllListeners()
• Interfaces
• Type Aliases
• Enums

open(...)

open(options: OpenOptions) => any

Open url in a new window fullscreen

Param	Type
options	OpenOptions

Returns: any

Since: 0.1.0

---

clearCookies()

clearCookies() => any

Clear all cookies

Returns: any

Since: 0.5.0

---

close()

close() => any

Returns: any

---

openWebView(...)

openWebView(options: OpenWebViewOptions) => any

Open url in a new webview with toolbars

Param	Type
options	OpenWebViewOptions

Returns: any

Since: 0.1.0

---

setUrl(...)

setUrl(options: { url: string; }) => any

Param	Type
options	{ url: string; }

Returns: any

---

addListener('urlChangeEvent', ...)

addListener(eventName: "urlChangeEvent", listenerFunc: UrlChangeListener) => Promise<PluginListenerHandle> & PluginListenerHandle

Listen for url change

Param	Type
eventName	'urlChangeEvent'
listenerFunc	UrlChangeListener

Returns: any

Since: 0.0.1

---

addListener('closeEvent', ...)

addListener(eventName: "closeEvent", listenerFunc: UrlChangeListener) => Promise<PluginListenerHandle> & PluginListenerHandle

Listen for close click

Param	Type
eventName	'closeEvent'
listenerFunc	UrlChangeListener

Returns: any

Since: 0.4.0

---

addListener('confirmBtnClicked', ...)

addListener(eventName: "confirmBtnClicked", listenerFunc: ConfirmBtnListener) => Promise<PluginListenerHandle> & PluginListenerHandle

Will be triggered when user clicks on confirm button when disclaimer is required, works only on iOS

Param	Type
eventName	'confirmBtnClicked'
listenerFunc	ConfirmBtnListener

Returns: any

Since: 0.0.1

---

removeAllListeners()

removeAllListeners() => any

Remove all listeners for this plugin.

Returns: any

Since: 1.0.0

---

Interfaces

OpenOptions

Prop	Type	Description	Since
url	string	Target URL to load.	0.1.0
headers	Headers	Headers to send with the request.	0.1.0
credentials	Credentials	Credentials to send with the request and all subsequent request for the same host.	1.1.0
isPresentAfterPageLoad	boolean	if true, the browser will be presented after the page is loaded, if false, the browser will be presented immediately.	0.1.0
preventDeeplink	boolean

Headers

Credentials

Prop	Type
username	string
password	string

OpenWebViewOptions

Prop	Type	Description	Default	Since
url	string	Target URL to load.		0.1.0
headers	Headers	Headers to send with the request.		0.1.0
credentials	Credentials	Credentials to send with the request and all subsequent request for the same host.		1.1.0
shareDisclaimer	DisclaimerOptions	share options		0.1.0
toolbarType	ToolBarType	Toolbar type	ToolBarType.DEFAULT	0.1.0
shareSubject	string	Share subject		0.1.0
title	string	Title of the browser	'New Window'	0.1.0
backgroundColor	BackgroundColor	Background color of the browser, only on IOS	BackgroundColor.BLACK	0.1.0
isPresentAfterPageLoad	boolean	Open url in a new window fullscreen isPresentAfterPageLoad: if true, the browser will be presented after the page is loaded, if false, the browser will be presented immediately.	false	0.1.0

DisclaimerOptions

Prop	Type
title	string
message	string
confirmBtn	string
cancelBtn	string

UrlEvent

Prop	Type	Description	Since
url	string	Emit when the url changes	0.0.1

PluginListenerHandle

Prop	Type
remove	() => any

BtnEvent

Prop	Type	Description	Since
url	string	Emit when a button is clicked.	0.0.1

Type Aliases

UrlChangeListener

(state: UrlEvent): void

ConfirmBtnListener

(state: BtnEvent): void

Enums

ToolBarType

Members	Value
ACTIVITY	"activity"
NAVIGATION	"navigation"
BLANK	"blank"
DEFAULT	""

BackgroundColor

Members	Value
WHITE	"white"
BLACK	"black"

Credits

• WKWebViewController - for iOS
• CapBrowser - For the base in capacitor v2