@sakhnovict/inappbrowser NPM

@capgo/inappbrowser

Install

npm install @capgo/inappbrowser
npx cap sync

Usage

import { InAppBrowser } from '@capgo/inappbrowser'

InAppBrowser.open("YOUR_URL");

API

open(...)

open(options: OpenOptions) => Promise<any>

Open url in a new window fullscreen

Param	Type
`options`	OpenOptions

Returns: Promise<any>

Since: 0.1.0

clearCookies()

clearCookies() => Promise<any>

Clear all cookies

Returns: Promise<any>

Since: 0.5.0

close()

close() => Promise<any>

Returns: Promise<any>

openWebViewWithHTML(...)

openWebViewWithHTML(options: OpenWebViewOptionsWithHtmlString) => Promise<any>

Open webview with given html string.

Param	Type	Description
`options`	OpenWebViewOptionsWithHtmlString	WebView options

Returns: Promise<any>

openWebView(...)

openWebView(options: OpenWebViewOptionsWithUrl) => Promise<any>

Open url in a new webview with toolbars

Param	Type
`options`	OpenWebViewOptionsWithUrl

Returns: Promise<any>

Since: 0.1.0

setUrl(...)

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

Param	Type
`options`	{ url: string; }

Returns: Promise<any>

addListener('urlChangeEvent', ...)

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

Listen for url change, only for openWebView

Param	Type
`eventName`	'urlChangeEvent'
`listenerFunc`	UrlChangeListener

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

Since: 0.0.1

addListener('closeEvent', ...)

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

Listen for close click only for openWebView

Param	Type
`eventName`	'closeEvent'
`listenerFunc`	UrlChangeListener

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

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: Promise<PluginListenerHandle> & PluginListenerHandle

Since: 0.0.1

removeAllListeners()

removeAllListeners() => Promise<void>

Remove all listeners for this plugin.

Since: 1.0.0

reload()

reload() => Promise<any>

Reload the current web page.

Returns: Promise<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
`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

OpenWebViewBaseOptions

Prop	Type	Description	Default	Since
`headers`	Headers	Headers to send with the request.		0.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
`showReloadButton`	boolean	Shows a reload button that reloads the web page	false	1.0.15
`closeModal`	boolean	CloseModal: if true a confirm will be displayed when user clicks on close button, if false the browser will be closed immediately.	false	1.1.0
`closeModalTitle`	string	CloseModalTitle: title of the confirm when user clicks on close button, only on IOS	'Close'	1.1.0
`closeModalDescription`	string	CloseModalDescription: description of the confirm when user clicks on close button, only on IOS	'Are you sure you want to close this window?'	1.1.0
`closeModalOk`	string	CloseModalOk: text of the confirm button when user clicks on close button, only on IOS	'Close'	1.1.0
`closeModalCancel`	string	CloseModalCancel: text of the cancel button when user clicks on close button, only on IOS	'Cancel'	1.1.0
`visibleTitle`	boolean	visibleTitle: if true the website title would be shown else shown empty	true	1.2.5
`toolbarColor`	string	toolbarColor: color of the toolbar in hex format	'#ffffff''	1.2.5
`showArrow`	boolean	showArrow: if true an arrow would be shown instead of cross for closing the window	false	1.2.5

DisclaimerOptions

Prop	Type
`title`	string
`message`	string
`confirmBtn`	string
`cancelBtn`	string

PluginListenerHandle

Prop	Type
`remove`	() => Promise<void>

UrlEvent

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

BtnEvent

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

Type Aliases

OpenWebViewOptionsWithHtmlString

OpenWebViewBaseOptions & { /** HTML string to load as an alternative to url. / htmlString: string; }

OpenWebViewOptionsWithUrl

OpenWebViewBaseOptions & { /** Target URL to load. @since 0.1.0 */ url: string; }

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

capacitor plugin browser native

@everything-registry/sub-chunk-802

4 months ago

5 months ago

5 months ago

5 months ago

5 months ago

7 months ago

7 months ago

7 months ago

7 months ago